Add new hook ArticlePrepareTextForEdit, called when preparing text to be saved.
[lhc/web/wiklou.git] / includes / Article.php
1 <?php
2 /**
3 * File for articles
4 * @file
5 */
6
7 /**
8 * Class representing a MediaWiki article and history.
9 *
10 * See design.txt for an overview.
11 * Note: edit user interface and cache support functions have been
12 * moved to separate EditPage and HTMLFileCache classes.
13 *
14 * @internal documentation reviewed 15 Mar 2010
15 */
16 class Article {
17 /**@{{
18 * @private
19 */
20 var $mComment = ''; // !<
21 var $mContent; // !<
22 var $mContentLoaded = false; // !<
23 var $mCounter = -1; // !< Not loaded
24 var $mDataLoaded = false; // !<
25 var $mForUpdate = false; // !<
26 var $mGoodAdjustment = 0; // !<
27 var $mIsRedirect = false; // !<
28 var $mLatest = false; // !<
29 var $mMinorEdit; // !<
30 var $mOldId; // !<
31 var $mPreparedEdit = false; // !< Title object if set
32 var $mRedirectedFrom = null; // !< Title object if set
33 var $mRedirectTarget = null; // !< Title object if set
34 var $mRedirectUrl = false; // !<
35 var $mRevIdFetched = 0; // !<
36 var $mRevision = null; // !< Revision object if set
37 var $mTimestamp = ''; // !<
38 var $mTitle; // !< Title object
39 var $mTotalAdjustment = 0; // !<
40 var $mTouched = '19700101000000'; // !<
41 var $mUser = -1; // !< Not loaded
42 var $mUserText = ''; // !< username from Revision if set
43 var $mParserOptions; // !< ParserOptions object for $wgUser articles
44 var $mParserOutput; // !< ParserCache object if set
45 /**@}}*/
46
47 /**
48 * Constructor and clear the article
49 * @param $title Reference to a Title object.
50 * @param $oldId Integer revision ID, null to fetch from request, zero for current
51 */
52 public function __construct( Title $title, $oldId = null ) {
53 // FIXME: does the reference play any role here?
54 $this->mTitle =& $title;
55 $this->mOldId = $oldId;
56 }
57
58 /**
59 * Constructor from an page id
60 * @param $id Int article ID to load
61 */
62 public static function newFromID( $id ) {
63 $t = Title::newFromID( $id );
64 # FIXME: doesn't inherit right
65 return $t == null ? null : new self( $t );
66 # return $t == null ? null : new static( $t ); // PHP 5.3
67 }
68
69 /**
70 * Tell the page view functions that this view was redirected
71 * from another page on the wiki.
72 * @param $from Title object.
73 */
74 public function setRedirectedFrom( Title $from ) {
75 $this->mRedirectedFrom = $from;
76 }
77
78 /**
79 * If this page is a redirect, get its target
80 *
81 * The target will be fetched from the redirect table if possible.
82 * If this page doesn't have an entry there, call insertRedirect()
83 * @return mixed Title object, or null if this page is not a redirect
84 */
85 public function getRedirectTarget() {
86 if ( !$this->mTitle->isRedirect() ) {
87 return null;
88 }
89
90 if ( $this->mRedirectTarget !== null ) {
91 return $this->mRedirectTarget;
92 }
93
94 # Query the redirect table
95 $dbr = wfGetDB( DB_SLAVE );
96 $row = $dbr->selectRow( 'redirect',
97 array( 'rd_namespace', 'rd_title', 'rd_fragment', 'rd_interwiki' ),
98 array( 'rd_from' => $this->getID() ),
99 __METHOD__
100 );
101
102 // rd_fragment and rd_interwiki were added later, populate them if empty
103 if ( $row && !is_null( $row->rd_fragment ) && !is_null( $row->rd_interwiki ) ) {
104 return $this->mRedirectTarget = Title::makeTitle(
105 $row->rd_namespace, $row->rd_title,
106 $row->rd_fragment, $row->rd_interwiki );
107 }
108
109 # This page doesn't have an entry in the redirect table
110 return $this->mRedirectTarget = $this->insertRedirect();
111 }
112
113 /**
114 * Insert an entry for this page into the redirect table.
115 *
116 * Don't call this function directly unless you know what you're doing.
117 * @return Title object or null if not a redirect
118 */
119 public function insertRedirect() {
120 // recurse through to only get the final target
121 $retval = Title::newFromRedirectRecurse( $this->getRawText() );
122 if ( !$retval ) {
123 return null;
124 }
125 $this->insertRedirectEntry( $retval );
126 return $retval;
127 }
128
129 /**
130 * Insert or update the redirect table entry for this page to indicate
131 * it redirects to $rt .
132 * @param $rt Title redirect target
133 */
134 public function insertRedirectEntry( $rt ) {
135 $dbw = wfGetDB( DB_MASTER );
136 $dbw->replace( 'redirect', array( 'rd_from' ),
137 array(
138 'rd_from' => $this->getID(),
139 'rd_namespace' => $rt->getNamespace(),
140 'rd_title' => $rt->getDBkey(),
141 'rd_fragment' => $rt->getFragment(),
142 'rd_interwiki' => $rt->getInterwiki(),
143 ),
144 __METHOD__
145 );
146 }
147
148 /**
149 * Get the Title object or URL this page redirects to
150 *
151 * @return mixed false, Title of in-wiki target, or string with URL
152 */
153 public function followRedirect() {
154 return $this->getRedirectURL( $this->getRedirectTarget() );
155 }
156
157 /**
158 * Get the Title object this text redirects to
159 *
160 * @param $text string article content containing redirect info
161 * @return mixed false, Title of in-wiki target, or string with URL
162 * @deprecated @since 1.17
163 */
164 public function followRedirectText( $text ) {
165 // recurse through to only get the final target
166 return $this->getRedirectURL( Title::newFromRedirectRecurse( $text ) );
167 }
168
169 /**
170 * Get the Title object or URL to use for a redirect. We use Title
171 * objects for same-wiki, non-special redirects and URLs for everything
172 * else.
173 * @param $rt Title Redirect target
174 * @return mixed false, Title object of local target, or string with URL
175 */
176 public function getRedirectURL( $rt ) {
177 if ( $rt ) {
178 if ( $rt->getInterwiki() != '' ) {
179 if ( $rt->isLocal() ) {
180 // Offsite wikis need an HTTP redirect.
181 //
182 // This can be hard to reverse and may produce loops,
183 // so they may be disabled in the site configuration.
184 $source = $this->mTitle->getFullURL( 'redirect=no' );
185 return $rt->getFullURL( 'rdfrom=' . urlencode( $source ) );
186 }
187 } else {
188 if ( $rt->getNamespace() == NS_SPECIAL ) {
189 // Gotta handle redirects to special pages differently:
190 // Fill the HTTP response "Location" header and ignore
191 // the rest of the page we're on.
192 //
193 // This can be hard to reverse, so they may be disabled.
194 if ( $rt->isSpecial( 'Userlogout' ) ) {
195 // rolleyes
196 } else {
197 return $rt->getFullURL();
198 }
199 }
200
201 return $rt;
202 }
203 }
204
205 // No or invalid redirect
206 return false;
207 }
208
209 /**
210 * Get the title object of the article
211 * @return Title object of this page
212 */
213 public function getTitle() {
214 return $this->mTitle;
215 }
216
217 /**
218 * Clear the object
219 * FIXME: shouldn't this be public?
220 * @private
221 */
222 public function clear() {
223 $this->mDataLoaded = false;
224 $this->mContentLoaded = false;
225
226 $this->mUser = $this->mCounter = -1; # Not loaded
227 $this->mRedirectedFrom = null; # Title object if set
228 $this->mRedirectTarget = null; # Title object if set
229 $this->mUserText =
230 $this->mTimestamp = $this->mComment = '';
231 $this->mGoodAdjustment = $this->mTotalAdjustment = 0;
232 $this->mTouched = '19700101000000';
233 $this->mForUpdate = false;
234 $this->mIsRedirect = false;
235 $this->mRevIdFetched = 0;
236 $this->mRedirectUrl = false;
237 $this->mLatest = false;
238 $this->mPreparedEdit = false;
239 }
240
241 /**
242 * Note that getContent/loadContent do not follow redirects anymore.
243 * If you need to fetch redirectable content easily, try
244 * the shortcut in Article::followRedirect()
245 *
246 * This function has side effects! Do not use this function if you
247 * only want the real revision text if any.
248 *
249 * @return Return the text of this revision
250 */
251 public function getContent() {
252 global $wgUser, $wgContLang, $wgMessageCache;
253
254 wfProfileIn( __METHOD__ );
255
256 if ( $this->getID() === 0 ) {
257 # If this is a MediaWiki:x message, then load the messages
258 # and return the message value for x.
259 if ( $this->mTitle->getNamespace() == NS_MEDIAWIKI ) {
260 # If this is a system message, get the default text.
261 list( $message, $lang ) = $wgMessageCache->figureMessage( $wgContLang->lcfirst( $this->mTitle->getText() ) );
262 $text = wfMsgGetKey( $message, false, $lang, false );
263
264 if ( wfEmptyMsg( $message, $text ) )
265 $text = '';
266 } else {
267 $text = wfMsgExt( $wgUser->isLoggedIn() ? 'noarticletext' : 'noarticletextanon', 'parsemag' );
268 }
269 wfProfileOut( __METHOD__ );
270
271 return $text;
272 } else {
273 $this->loadContent();
274 wfProfileOut( __METHOD__ );
275
276 return $this->mContent;
277 }
278 }
279
280 /**
281 * Get the text of the current revision. No side-effects...
282 *
283 * @return Return the text of the current revision
284 */
285 public function getRawText() {
286 // Check process cache for current revision
287 if ( $this->mContentLoaded && $this->mOldId == 0 ) {
288 return $this->mContent;
289 }
290
291 $rev = Revision::newFromTitle( $this->mTitle );
292 $text = $rev ? $rev->getRawText() : false;
293
294 return $text;
295 }
296
297 /**
298 * This function returns the text of a section, specified by a number ($section).
299 * A section is text under a heading like == Heading == or \<h1\>Heading\</h1\>, or
300 * the first section before any such heading (section 0).
301 *
302 * If a section contains subsections, these are also returned.
303 *
304 * @param $text String: text to look in
305 * @param $section Integer: section number
306 * @return string text of the requested section
307 * @deprecated
308 */
309 public function getSection( $text, $section ) {
310 global $wgParser;
311 return $wgParser->getSection( $text, $section );
312 }
313
314 /**
315 * Get the text that needs to be saved in order to undo all revisions
316 * between $undo and $undoafter. Revisions must belong to the same page,
317 * must exist and must not be deleted
318 * @param $undo Revision
319 * @param $undoafter Revision Must be an earlier revision than $undo
320 * @return mixed string on success, false on failure
321 */
322 public function getUndoText( Revision $undo, Revision $undoafter = null ) {
323 $currentRev = Revision::newFromTitle( $this->mTitle );
324 if ( !$currentRev ) {
325 return false; // no page
326 }
327 $undo_text = $undo->getText();
328 $undoafter_text = $undoafter->getText();
329 $cur_text = $currentRev->getText();
330
331 if ( $cur_text == $undo_text ) {
332 # No use doing a merge if it's just a straight revert.
333 return $undoafter_text;
334 }
335
336 $undone_text = '';
337
338 if ( !wfMerge( $undo_text, $undoafter_text, $cur_text, $undone_text ) ) {
339 return false;
340 }
341
342 return $undone_text;
343 }
344
345 /**
346 * @return int The oldid of the article that is to be shown, 0 for the
347 * current revision
348 */
349 public function getOldID() {
350 if ( is_null( $this->mOldId ) ) {
351 $this->mOldId = $this->getOldIDFromRequest();
352 }
353
354 return $this->mOldId;
355 }
356
357 /**
358 * Sets $this->mRedirectUrl to a correct URL if the query parameters are incorrect
359 *
360 * @return int The old id for the request
361 */
362 public function getOldIDFromRequest() {
363 global $wgRequest;
364
365 $this->mRedirectUrl = false;
366
367 $oldid = $wgRequest->getVal( 'oldid' );
368
369 if ( isset( $oldid ) ) {
370 $oldid = intval( $oldid );
371 if ( $wgRequest->getVal( 'direction' ) == 'next' ) {
372 $nextid = $this->mTitle->getNextRevisionID( $oldid );
373 if ( $nextid ) {
374 $oldid = $nextid;
375 } else {
376 $this->mRedirectUrl = $this->mTitle->getFullURL( 'redirect=no' );
377 }
378 } elseif ( $wgRequest->getVal( 'direction' ) == 'prev' ) {
379 $previd = $this->mTitle->getPreviousRevisionID( $oldid );
380 if ( $previd ) {
381 $oldid = $previd;
382 }
383 }
384 }
385
386 if ( !$oldid ) {
387 $oldid = 0;
388 }
389
390 return $oldid;
391 }
392
393 /**
394 * Load the revision (including text) into this object
395 */
396 function loadContent() {
397 if ( $this->mContentLoaded ) {
398 return;
399 }
400
401 wfProfileIn( __METHOD__ );
402
403 $this->fetchContent( $this->getOldID() );
404
405 wfProfileOut( __METHOD__ );
406 }
407
408 /**
409 * Fetch a page record with the given conditions
410 * @param $dbr Database object
411 * @param $conditions Array
412 * @return mixed Database result resource, or false on failure
413 */
414 protected function pageData( $dbr, $conditions ) {
415 $fields = array(
416 'page_id',
417 'page_namespace',
418 'page_title',
419 'page_restrictions',
420 'page_counter',
421 'page_is_redirect',
422 'page_is_new',
423 'page_random',
424 'page_touched',
425 'page_latest',
426 'page_len',
427 );
428
429 wfRunHooks( 'ArticlePageDataBefore', array( &$this, &$fields ) );
430
431 $row = $dbr->selectRow( 'page', $fields, $conditions, __METHOD__ );
432
433 wfRunHooks( 'ArticlePageDataAfter', array( &$this, &$row ) );
434
435 return $row;
436 }
437
438 /**
439 * Fetch a page record matching the Title object's namespace and title
440 * using a sanitized title string
441 *
442 * @param $dbr Database object
443 * @param $title Title object
444 * @return mixed Database result resource, or false on failure
445 */
446 public function pageDataFromTitle( $dbr, $title ) {
447 return $this->pageData( $dbr, array(
448 'page_namespace' => $title->getNamespace(),
449 'page_title' => $title->getDBkey() ) );
450 }
451
452 /**
453 * Fetch a page record matching the requested ID
454 *
455 * @param $dbr Database
456 * @param $id Integer
457 */
458 protected function pageDataFromId( $dbr, $id ) {
459 return $this->pageData( $dbr, array( 'page_id' => $id ) );
460 }
461
462 /**
463 * Set the general counter, title etc data loaded from
464 * some source.
465 *
466 * @param $data Database row object or "fromdb"
467 */
468 public function loadPageData( $data = 'fromdb' ) {
469 if ( $data === 'fromdb' ) {
470 $dbr = wfGetDB( DB_SLAVE );
471 $data = $this->pageDataFromTitle( $dbr, $this->mTitle );
472 }
473
474 $lc = LinkCache::singleton();
475
476 if ( $data ) {
477 $lc->addGoodLinkObj( $data->page_id, $this->mTitle, $data->page_len, $data->page_is_redirect, $data->page_latest );
478
479 $this->mTitle->mArticleID = intval( $data->page_id );
480
481 # Old-fashioned restrictions
482 $this->mTitle->loadRestrictions( $data->page_restrictions );
483
484 $this->mCounter = intval( $data->page_counter );
485 $this->mTouched = wfTimestamp( TS_MW, $data->page_touched );
486 $this->mIsRedirect = intval( $data->page_is_redirect );
487 $this->mLatest = intval( $data->page_latest );
488 } else {
489 $lc->addBadLinkObj( $this->mTitle );
490 $this->mTitle->mArticleID = 0;
491 }
492
493 $this->mDataLoaded = true;
494 }
495
496 /**
497 * Get text of an article from database
498 * Does *NOT* follow redirects.
499 *
500 * @param $oldid Int: 0 for whatever the latest revision is
501 * @return mixed string containing article contents, or false if null
502 */
503 function fetchContent( $oldid = 0 ) {
504 if ( $this->mContentLoaded ) {
505 return $this->mContent;
506 }
507
508 # Pre-fill content with error message so that if something
509 # fails we'll have something telling us what we intended.
510 $t = $this->mTitle->getPrefixedText();
511 $d = $oldid ? wfMsgExt( 'missingarticle-rev', array( 'escape' ), $oldid ) : '';
512 $this->mContent = wfMsgNoTrans( 'missing-article', $t, $d ) ;
513
514 if ( $oldid ) {
515 $revision = Revision::newFromId( $oldid );
516 if ( $revision === null ) {
517 wfDebug( __METHOD__ . " failed to retrieve specified revision, id $oldid\n" );
518 return false;
519 }
520
521 if ( !$this->mDataLoaded || $this->getID() != $revision->getPage() ) {
522 $data = $this->pageDataFromId( wfGetDB( DB_SLAVE ), $revision->getPage() );
523
524 if ( !$data ) {
525 wfDebug( __METHOD__ . " failed to get page data linked to revision id $oldid\n" );
526 return false;
527 }
528
529 $this->mTitle = Title::makeTitle( $data->page_namespace, $data->page_title );
530 $this->loadPageData( $data );
531 }
532 } else {
533 if ( !$this->mDataLoaded ) {
534 $this->loadPageData();
535 }
536
537 if ( $this->mLatest === false ) {
538 wfDebug( __METHOD__ . " failed to find page data for title " . $this->mTitle->getPrefixedText() . "\n" );
539 return false;
540 }
541
542 $revision = Revision::newFromId( $this->mLatest );
543 if ( $revision === null ) {
544 wfDebug( __METHOD__ . " failed to retrieve current page, rev_id {$this->mLatest}\n" );
545 return false;
546 }
547 }
548
549 // FIXME: Horrible, horrible! This content-loading interface just plain sucks.
550 // We should instead work with the Revision object when we need it...
551 $this->mContent = $revision->getText( Revision::FOR_THIS_USER ); // Loads if user is allowed
552
553 if ( $revision->getId() == $this->mLatest ) {
554 $this->setLastEdit( $revision );
555 }
556
557 $this->mRevIdFetched = $revision->getId();
558 $this->mContentLoaded = true;
559 $this->mRevision =& $revision;
560
561 wfRunHooks( 'ArticleAfterFetchContent', array( &$this, &$this->mContent ) );
562
563 return $this->mContent;
564 }
565
566 /**
567 * Read/write accessor to select FOR UPDATE
568 *
569 * @param $x Mixed: FIXME
570 * @return mixed value of $x, or value stored in Article::mForUpdate
571 */
572 public function forUpdate( $x = null ) {
573 return wfSetVar( $this->mForUpdate, $x );
574 }
575
576 /**
577 * Get options for all SELECT statements
578 *
579 * @param $options Array: an optional options array which'll be appended to
580 * the default
581 * @return Array: options
582 */
583 protected function getSelectOptions( $options = '' ) {
584 if ( $this->mForUpdate ) {
585 if ( is_array( $options ) ) {
586 $options[] = 'FOR UPDATE';
587 } else {
588 $options = 'FOR UPDATE';
589 }
590 }
591
592 return $options;
593 }
594
595 /**
596 * @return int Page ID
597 */
598 public function getID() {
599 return $this->mTitle->getArticleID();
600 }
601
602 /**
603 * @return bool Whether or not the page exists in the database
604 */
605 public function exists() {
606 return $this->getId() > 0;
607 }
608
609 /**
610 * Check if this page is something we're going to be showing
611 * some sort of sensible content for. If we return false, page
612 * views (plain action=view) will return an HTTP 404 response,
613 * so spiders and robots can know they're following a bad link.
614 *
615 * @return bool
616 */
617 public function hasViewableContent() {
618 return $this->exists() || $this->mTitle->isAlwaysKnown();
619 }
620
621 /**
622 * @return int The view count for the page
623 */
624 public function getCount() {
625 if ( -1 == $this->mCounter ) {
626 $id = $this->getID();
627
628 if ( $id == 0 ) {
629 $this->mCounter = 0;
630 } else {
631 $dbr = wfGetDB( DB_SLAVE );
632 $this->mCounter = $dbr->selectField( 'page',
633 'page_counter',
634 array( 'page_id' => $id ),
635 __METHOD__,
636 $this->getSelectOptions()
637 );
638 }
639 }
640
641 return $this->mCounter;
642 }
643
644 /**
645 * Determine whether a page would be suitable for being counted as an
646 * article in the site_stats table based on the title & its content
647 *
648 * @param $text String: text to analyze
649 * @return bool
650 */
651 public function isCountable( $text ) {
652 global $wgUseCommaCount;
653
654 $token = $wgUseCommaCount ? ',' : '[[';
655
656 return $this->mTitle->isContentPage() && !$this->isRedirect( $text ) && in_string( $token, $text );
657 }
658
659 /**
660 * Tests if the article text represents a redirect
661 *
662 * @param $text mixed string containing article contents, or boolean
663 * @return bool
664 */
665 public function isRedirect( $text = false ) {
666 if ( $text === false ) {
667 if ( !$this->mDataLoaded ) {
668 $this->loadPageData();
669 }
670
671 return (bool)$this->mIsRedirect;
672 } else {
673 return Title::newFromRedirect( $text ) !== null;
674 }
675 }
676
677 /**
678 * Returns true if the currently-referenced revision is the current edit
679 * to this page (and it exists).
680 * @return bool
681 */
682 public function isCurrent() {
683 # If no oldid, this is the current version.
684 if ( $this->getOldID() == 0 ) {
685 return true;
686 }
687
688 return $this->exists() && $this->mRevision && $this->mRevision->isCurrent();
689 }
690
691 /**
692 * Loads everything except the text
693 * This isn't necessary for all uses, so it's only done if needed.
694 */
695 protected function loadLastEdit() {
696 if ( -1 != $this->mUser ) {
697 return;
698 }
699
700 # New or non-existent articles have no user information
701 $id = $this->getID();
702 if ( 0 == $id ) {
703 return;
704 }
705
706 $revision = Revision::loadFromPageId( wfGetDB( DB_MASTER ), $id );
707 if ( !is_null( $revision ) ) {
708 $this->setLastEdit( $revision );
709 }
710 }
711
712 /**
713 * Set the latest revision
714 */
715 protected function setLastEdit( Revision $revision ) {
716 $this->mLastRevision = $revision;
717 $this->mUser = $revision->getUser();
718 $this->mUserText = $revision->getUserText();
719 $this->mTimestamp = $revision->getTimestamp();
720 $this->mComment = $revision->getComment();
721 $this->mMinorEdit = $revision->isMinor();
722 }
723
724 /**
725 * @return string GMT timestamp of last article revision
726 */
727 public function getTimestamp() {
728 // Check if the field has been filled by ParserCache::get()
729 if ( !$this->mTimestamp ) {
730 $this->loadLastEdit();
731 }
732
733 return wfTimestamp( TS_MW, $this->mTimestamp );
734 }
735
736 /**
737 * @return int user ID for the user that made the last article revision
738 */
739 public function getUser() {
740 $this->loadLastEdit();
741 return $this->mUser;
742 }
743
744 /**
745 * @return string username of the user that made the last article revision
746 */
747 public function getUserText() {
748 $this->loadLastEdit();
749 return $this->mUserText;
750 }
751
752 /**
753 * @return string Comment stored for the last article revision
754 */
755 public function getComment() {
756 $this->loadLastEdit();
757 return $this->mComment;
758 }
759
760 /**
761 * Returns true if last revision was marked as "minor edit"
762 *
763 * @return boolean Minor edit indicator for the last article revision.
764 */
765 public function getMinorEdit() {
766 $this->loadLastEdit();
767 return $this->mMinorEdit;
768 }
769
770 /**
771 * Use this to fetch the rev ID used on page views
772 *
773 * @return int revision ID of last article revision
774 */
775 public function getRevIdFetched() {
776 if ( $this->mRevIdFetched ) {
777 return $this->mRevIdFetched;
778 } else {
779 return $this->getLatest();
780 }
781 }
782
783 /**
784 * FIXME: this does what?
785 * @param $limit Integer: default 0.
786 * @param $offset Integer: default 0.
787 * @return UserArrayFromResult object with User objects of article contributors for requested range
788 */
789 public function getContributors( $limit = 0, $offset = 0 ) {
790 # FIXME: this is expensive; cache this info somewhere.
791
792 $dbr = wfGetDB( DB_SLAVE );
793 $revTable = $dbr->tableName( 'revision' );
794 $userTable = $dbr->tableName( 'user' );
795
796 $pageId = $this->getId();
797
798 $user = $this->getUser();
799
800 if ( $user ) {
801 $excludeCond = "AND rev_user != $user";
802 } else {
803 $userText = $dbr->addQuotes( $this->getUserText() );
804 $excludeCond = "AND rev_user_text != $userText";
805 }
806
807 $deletedBit = $dbr->bitAnd( 'rev_deleted', Revision::DELETED_USER ); // username hidden?
808
809 $sql = "SELECT {$userTable}.*, rev_user_text as user_name, MAX(rev_timestamp) as timestamp
810 FROM $revTable LEFT JOIN $userTable ON rev_user = user_id
811 WHERE rev_page = $pageId
812 $excludeCond
813 AND $deletedBit = 0
814 GROUP BY rev_user, rev_user_text
815 ORDER BY timestamp DESC";
816
817 if ( $limit > 0 ) {
818 $sql = $dbr->limitResult( $sql, $limit, $offset );
819 }
820
821 $sql .= ' ' . $this->getSelectOptions();
822 $res = $dbr->query( $sql, __METHOD__ );
823
824 return new UserArrayFromResult( $res );
825 }
826
827 /**
828 * This is the default action of the index.php entry point: just view the
829 * page of the given title.
830 */
831 public function view() {
832 global $wgUser, $wgOut, $wgRequest, $wgParser;
833 global $wgUseFileCache, $wgUseETag;
834
835 wfProfileIn( __METHOD__ );
836
837 # Get variables from query string
838 $oldid = $this->getOldID();
839 $parserCache = ParserCache::singleton();
840
841 $parserOptions = $this->getParserOptions();
842 # Render printable version, use printable version cache
843 if ( $wgOut->isPrintable() ) {
844 $parserOptions->setIsPrintable( true );
845 $parserOptions->setEditSection( false );
846 } else if ( $wgUseETag && !$this->mTitle->quickUserCan( 'edit' ) ) {
847 $parserOptions->setEditSection( false );
848 }
849
850 # Try client and file cache
851 if ( $oldid === 0 && $this->checkTouched() ) {
852 if ( $wgUseETag ) {
853 $wgOut->setETag( $parserCache->getETag( $this, $parserOptions ) );
854 }
855
856 # Is it client cached?
857 if ( $wgOut->checkLastModified( $this->getTouched() ) ) {
858 wfDebug( __METHOD__ . ": done 304\n" );
859 wfProfileOut( __METHOD__ );
860
861 return;
862 # Try file cache
863 } else if ( $wgUseFileCache && $this->tryFileCache() ) {
864 wfDebug( __METHOD__ . ": done file cache\n" );
865 # tell wgOut that output is taken care of
866 $wgOut->disable();
867 $this->viewUpdates();
868 wfProfileOut( __METHOD__ );
869
870 return;
871 }
872 }
873
874 # getOldID may want us to redirect somewhere else
875 if ( $this->mRedirectUrl ) {
876 $wgOut->redirect( $this->mRedirectUrl );
877 wfDebug( __METHOD__ . ": redirecting due to oldid\n" );
878 wfProfileOut( __METHOD__ );
879
880 return;
881 }
882
883 $wgOut->setArticleFlag( true );
884 # Set page title (may be overridden by DISPLAYTITLE)
885 $wgOut->setPageTitle( $this->mTitle->getPrefixedText() );
886
887 # If we got diff in the query, we want to see a diff page instead of the article.
888 if ( $wgRequest->getCheck( 'diff' ) ) {
889 wfDebug( __METHOD__ . ": showing diff page\n" );
890 $this->showDiffPage();
891 wfProfileOut( __METHOD__ );
892
893 return;
894 }
895
896 # Allow frames by default
897 $wgOut->allowClickjacking();
898
899 if ( !$wgUseETag && !$this->mTitle->quickUserCan( 'edit' ) ) {
900 $parserOptions->setEditSection( false );
901 }
902
903 # Should the parser cache be used?
904 $useParserCache = $this->useParserCache( $oldid );
905 wfDebug( 'Article::view using parser cache: ' . ( $useParserCache ? 'yes' : 'no' ) . "\n" );
906 if ( $wgUser->getStubThreshold() ) {
907 wfIncrStats( 'pcache_miss_stub' );
908 }
909
910 $wasRedirected = $this->showRedirectedFromHeader();
911 $this->showNamespaceHeader();
912
913 # Iterate through the possible ways of constructing the output text.
914 # Keep going until $outputDone is set, or we run out of things to do.
915 $pass = 0;
916 $outputDone = false;
917 $this->mParserOutput = false;
918
919 while ( !$outputDone && ++$pass ) {
920 switch( $pass ) {
921 case 1:
922 wfRunHooks( 'ArticleViewHeader', array( &$this, &$outputDone, &$useParserCache ) );
923 break;
924 case 2:
925 # Try the parser cache
926 if ( $useParserCache ) {
927 $this->mParserOutput = $parserCache->get( $this, $parserOptions );
928
929 if ( $this->mParserOutput !== false ) {
930 wfDebug( __METHOD__ . ": showing parser cache contents\n" );
931 $wgOut->addParserOutput( $this->mParserOutput );
932 # Ensure that UI elements requiring revision ID have
933 # the correct version information.
934 $wgOut->setRevisionId( $this->mLatest );
935 $outputDone = true;
936 }
937 }
938 break;
939 case 3:
940 $text = $this->getContent();
941 if ( $text === false || $this->getID() == 0 ) {
942 wfDebug( __METHOD__ . ": showing missing article\n" );
943 $this->showMissingArticle();
944 wfProfileOut( __METHOD__ );
945 return;
946 }
947
948 # Another whitelist check in case oldid is altering the title
949 if ( !$this->mTitle->userCanRead() ) {
950 wfDebug( __METHOD__ . ": denied on secondary read check\n" );
951 $wgOut->loginToUse();
952 $wgOut->output();
953 $wgOut->disable();
954 wfProfileOut( __METHOD__ );
955 return;
956 }
957
958 # Are we looking at an old revision
959 if ( $oldid && !is_null( $this->mRevision ) ) {
960 $this->setOldSubtitle( $oldid );
961
962 if ( !$this->showDeletedRevisionHeader() ) {
963 wfDebug( __METHOD__ . ": cannot view deleted revision\n" );
964 wfProfileOut( __METHOD__ );
965 return;
966 }
967
968 # If this "old" version is the current, then try the parser cache...
969 if ( $oldid === $this->getLatest() && $this->useParserCache( false ) ) {
970 $this->mParserOutput = $parserCache->get( $this, $parserOptions );
971 if ( $this->mParserOutput ) {
972 wfDebug( __METHOD__ . ": showing parser cache for current rev permalink\n" );
973 $wgOut->addParserOutput( $this->mParserOutput );
974 $wgOut->setRevisionId( $this->mLatest );
975 $outputDone = true;
976 break;
977 }
978 }
979 }
980
981 # Ensure that UI elements requiring revision ID have
982 # the correct version information.
983 $wgOut->setRevisionId( $this->getRevIdFetched() );
984
985 # Pages containing custom CSS or JavaScript get special treatment
986 if ( $this->mTitle->isCssOrJsPage() || $this->mTitle->isCssJsSubpage() ) {
987 wfDebug( __METHOD__ . ": showing CSS/JS source\n" );
988 $this->showCssOrJsPage();
989 $outputDone = true;
990 } else {
991 $rt = Title::newFromRedirectArray( $text );
992 if ( $rt ) {
993 wfDebug( __METHOD__ . ": showing redirect=no page\n" );
994 # Viewing a redirect page (e.g. with parameter redirect=no)
995 # Don't append the subtitle if this was an old revision
996 $wgOut->addHTML( $this->viewRedirect( $rt, !$wasRedirected && $this->isCurrent() ) );
997 # Parse just to get categories, displaytitle, etc.
998 $this->mParserOutput = $wgParser->parse( $text, $this->mTitle, $parserOptions );
999 $wgOut->addParserOutputNoText( $this->mParserOutput );
1000 $outputDone = true;
1001 }
1002 }
1003 break;
1004 case 4:
1005 # Run the parse, protected by a pool counter
1006 wfDebug( __METHOD__ . ": doing uncached parse\n" );
1007
1008 $key = $parserCache->getKey( $this, $parserOptions );
1009 $poolArticleView = new PoolWorkArticleView( $this, $key, $useParserCache, $parserOptions );
1010
1011 if ( !$poolArticleView->execute() ) {
1012 # Connection or timeout error
1013 wfProfileOut( __METHOD__ );
1014 return;
1015 } else {
1016 $outputDone = true;
1017 }
1018 break;
1019 # Should be unreachable, but just in case...
1020 default:
1021 break 2;
1022 }
1023 }
1024
1025 # Adjust the title if it was set by displaytitle, -{T|}- or language conversion
1026 if ( $this->mParserOutput ) {
1027 $titleText = $this->mParserOutput->getTitleText();
1028
1029 if ( strval( $titleText ) !== '' ) {
1030 $wgOut->setPageTitle( $titleText );
1031 }
1032 }
1033
1034 # For the main page, overwrite the <title> element with the con-
1035 # tents of 'pagetitle-view-mainpage' instead of the default (if
1036 # that's not empty).
1037 # This message always exists because it is in the i18n files
1038 if ( $this->mTitle->equals( Title::newMainPage() )
1039 && ( $m = wfMsgForContent( 'pagetitle-view-mainpage' ) ) !== '' )
1040 {
1041 $wgOut->setHTMLTitle( $m );
1042 }
1043
1044 # Now that we've filled $this->mParserOutput, we know whether
1045 # there are any __NOINDEX__ tags on the page
1046 $policy = $this->getRobotPolicy( 'view' );
1047 $wgOut->setIndexPolicy( $policy['index'] );
1048 $wgOut->setFollowPolicy( $policy['follow'] );
1049
1050 $this->showViewFooter();
1051 $this->viewUpdates();
1052 wfProfileOut( __METHOD__ );
1053 }
1054
1055 /**
1056 * Show a diff page according to current request variables. For use within
1057 * Article::view() only, other callers should use the DifferenceEngine class.
1058 */
1059 public function showDiffPage() {
1060 global $wgRequest, $wgUser;
1061
1062 $diff = $wgRequest->getVal( 'diff' );
1063 $rcid = $wgRequest->getVal( 'rcid' );
1064 $diffOnly = $wgRequest->getBool( 'diffonly', $wgUser->getOption( 'diffonly' ) );
1065 $purge = $wgRequest->getVal( 'action' ) == 'purge';
1066 $unhide = $wgRequest->getInt( 'unhide' ) == 1;
1067 $oldid = $this->getOldID();
1068
1069 $de = new DifferenceEngine( $this->mTitle, $oldid, $diff, $rcid, $purge, $unhide );
1070 // DifferenceEngine directly fetched the revision:
1071 $this->mRevIdFetched = $de->mNewid;
1072 $de->showDiffPage( $diffOnly );
1073
1074 // Needed to get the page's current revision
1075 $this->loadPageData();
1076 if ( $diff == 0 || $diff == $this->mLatest ) {
1077 # Run view updates for current revision only
1078 $this->viewUpdates();
1079 }
1080 }
1081
1082 /**
1083 * Show a page view for a page formatted as CSS or JavaScript. To be called by
1084 * Article::view() only.
1085 *
1086 * This is hooked by SyntaxHighlight_GeSHi to do syntax highlighting of these
1087 * page views.
1088 */
1089 protected function showCssOrJsPage() {
1090 global $wgOut;
1091
1092 $wgOut->wrapWikiMsg( "<div id='mw-clearyourcache'>\n$1\n</div>", 'clearyourcache' );
1093
1094 // Give hooks a chance to customise the output
1095 if ( wfRunHooks( 'ShowRawCssJs', array( $this->mContent, $this->mTitle, $wgOut ) ) ) {
1096 // Wrap the whole lot in a <pre> and don't parse
1097 $m = array();
1098 preg_match( '!\.(css|js)$!u', $this->mTitle->getText(), $m );
1099 $wgOut->addHTML( "<pre class=\"mw-code mw-{$m[1]}\" dir=\"ltr\">\n" );
1100 $wgOut->addHTML( htmlspecialchars( $this->mContent ) );
1101 $wgOut->addHTML( "\n</pre>\n" );
1102 }
1103 }
1104
1105 /**
1106 * Get the robot policy to be used for the current view
1107 * @param $action String the action= GET parameter
1108 * @return Array the policy that should be set
1109 * TODO: actions other than 'view'
1110 */
1111 public function getRobotPolicy( $action ) {
1112 global $wgOut, $wgArticleRobotPolicies, $wgNamespaceRobotPolicies;
1113 global $wgDefaultRobotPolicy, $wgRequest;
1114
1115 $ns = $this->mTitle->getNamespace();
1116
1117 if ( $ns == NS_USER || $ns == NS_USER_TALK ) {
1118 # Don't index user and user talk pages for blocked users (bug 11443)
1119 if ( !$this->mTitle->isSubpage() ) {
1120 $block = new Block();
1121 if ( $block->load( $this->mTitle->getText() ) ) {
1122 return array(
1123 'index' => 'noindex',
1124 'follow' => 'nofollow'
1125 );
1126 }
1127 }
1128 }
1129
1130 if ( $this->getID() === 0 || $this->getOldID() ) {
1131 # Non-articles (special pages etc), and old revisions
1132 return array(
1133 'index' => 'noindex',
1134 'follow' => 'nofollow'
1135 );
1136 } elseif ( $wgOut->isPrintable() ) {
1137 # Discourage indexing of printable versions, but encourage following
1138 return array(
1139 'index' => 'noindex',
1140 'follow' => 'follow'
1141 );
1142 } elseif ( $wgRequest->getInt( 'curid' ) ) {
1143 # For ?curid=x urls, disallow indexing
1144 return array(
1145 'index' => 'noindex',
1146 'follow' => 'follow'
1147 );
1148 }
1149
1150 # Otherwise, construct the policy based on the various config variables.
1151 $policy = self::formatRobotPolicy( $wgDefaultRobotPolicy );
1152
1153 if ( isset( $wgNamespaceRobotPolicies[$ns] ) ) {
1154 # Honour customised robot policies for this namespace
1155 $policy = array_merge(
1156 $policy,
1157 self::formatRobotPolicy( $wgNamespaceRobotPolicies[$ns] )
1158 );
1159 }
1160 if ( $this->mTitle->canUseNoindex() && is_object( $this->mParserOutput ) && $this->mParserOutput->getIndexPolicy() ) {
1161 # __INDEX__ and __NOINDEX__ magic words, if allowed. Incorporates
1162 # a final sanity check that we have really got the parser output.
1163 $policy = array_merge(
1164 $policy,
1165 array( 'index' => $this->mParserOutput->getIndexPolicy() )
1166 );
1167 }
1168
1169 if ( isset( $wgArticleRobotPolicies[$this->mTitle->getPrefixedText()] ) ) {
1170 # (bug 14900) site config can override user-defined __INDEX__ or __NOINDEX__
1171 $policy = array_merge(
1172 $policy,
1173 self::formatRobotPolicy( $wgArticleRobotPolicies[$this->mTitle->getPrefixedText()] )
1174 );
1175 }
1176
1177 return $policy;
1178 }
1179
1180 /**
1181 * Converts a String robot policy into an associative array, to allow
1182 * merging of several policies using array_merge().
1183 * @param $policy Mixed, returns empty array on null/false/'', transparent
1184 * to already-converted arrays, converts String.
1185 * @return Array: 'index' => <indexpolicy>, 'follow' => <followpolicy>
1186 */
1187 public static function formatRobotPolicy( $policy ) {
1188 if ( is_array( $policy ) ) {
1189 return $policy;
1190 } elseif ( !$policy ) {
1191 return array();
1192 }
1193
1194 $policy = explode( ',', $policy );
1195 $policy = array_map( 'trim', $policy );
1196
1197 $arr = array();
1198 foreach ( $policy as $var ) {
1199 if ( in_array( $var, array( 'index', 'noindex' ) ) ) {
1200 $arr['index'] = $var;
1201 } elseif ( in_array( $var, array( 'follow', 'nofollow' ) ) ) {
1202 $arr['follow'] = $var;
1203 }
1204 }
1205
1206 return $arr;
1207 }
1208
1209 /**
1210 * If this request is a redirect view, send "redirected from" subtitle to
1211 * $wgOut. Returns true if the header was needed, false if this is not a
1212 * redirect view. Handles both local and remote redirects.
1213 *
1214 * @return boolean
1215 */
1216 public function showRedirectedFromHeader() {
1217 global $wgOut, $wgUser, $wgRequest, $wgRedirectSources;
1218
1219 $rdfrom = $wgRequest->getVal( 'rdfrom' );
1220 $sk = $wgUser->getSkin();
1221
1222 if ( isset( $this->mRedirectedFrom ) ) {
1223 // This is an internally redirected page view.
1224 // We'll need a backlink to the source page for navigation.
1225 if ( wfRunHooks( 'ArticleViewRedirect', array( &$this ) ) ) {
1226 $redir = $sk->link(
1227 $this->mRedirectedFrom,
1228 null,
1229 array(),
1230 array( 'redirect' => 'no' ),
1231 array( 'known', 'noclasses' )
1232 );
1233
1234 $s = wfMsgExt( 'redirectedfrom', array( 'parseinline', 'replaceafter' ), $redir );
1235 $wgOut->setSubtitle( $s );
1236
1237 // Set the fragment if one was specified in the redirect
1238 if ( strval( $this->mTitle->getFragment() ) != '' ) {
1239 $fragment = Xml::escapeJsString( $this->mTitle->getFragmentForURL() );
1240 $wgOut->addInlineScript( "redirectToFragment(\"$fragment\");" );
1241 }
1242
1243 // Add a <link rel="canonical"> tag
1244 $wgOut->addLink( array( 'rel' => 'canonical',
1245 'href' => $this->mTitle->getLocalURL() )
1246 );
1247
1248 return true;
1249 }
1250 } elseif ( $rdfrom ) {
1251 // This is an externally redirected view, from some other wiki.
1252 // If it was reported from a trusted site, supply a backlink.
1253 if ( $wgRedirectSources && preg_match( $wgRedirectSources, $rdfrom ) ) {
1254 $redir = $sk->makeExternalLink( $rdfrom, $rdfrom );
1255 $s = wfMsgExt( 'redirectedfrom', array( 'parseinline', 'replaceafter' ), $redir );
1256 $wgOut->setSubtitle( $s );
1257
1258 return true;
1259 }
1260 }
1261
1262 return false;
1263 }
1264
1265 /**
1266 * Show a header specific to the namespace currently being viewed, like
1267 * [[MediaWiki:Talkpagetext]]. For Article::view().
1268 */
1269 public function showNamespaceHeader() {
1270 global $wgOut;
1271
1272 if ( $this->mTitle->isTalkPage() ) {
1273 if ( !wfMessage( 'talkpageheader' )->isDisabled() ) {
1274 $wgOut->wrapWikiMsg( "<div class=\"mw-talkpageheader\">\n$1\n</div>", array( 'talkpageheader' ) );
1275 }
1276 }
1277 }
1278
1279 /**
1280 * Show the footer section of an ordinary page view
1281 */
1282 public function showViewFooter() {
1283 global $wgOut, $wgUseTrackbacks;
1284
1285 # check if we're displaying a [[User talk:x.x.x.x]] anonymous talk page
1286 if ( $this->mTitle->getNamespace() == NS_USER_TALK && IP::isValid( $this->mTitle->getText() ) ) {
1287 $wgOut->addWikiMsg( 'anontalkpagetext' );
1288 }
1289
1290 # If we have been passed an &rcid= parameter, we want to give the user a
1291 # chance to mark this new article as patrolled.
1292 $this->showPatrolFooter();
1293
1294 # Trackbacks
1295 if ( $wgUseTrackbacks ) {
1296 $this->addTrackbacks();
1297 }
1298
1299 wfRunHooks( 'ArticleViewFooter', array( $this ) );
1300
1301 }
1302
1303 /**
1304 * If patrol is possible, output a patrol UI box. This is called from the
1305 * footer section of ordinary page views. If patrol is not possible or not
1306 * desired, does nothing.
1307 */
1308 public function showPatrolFooter() {
1309 global $wgOut, $wgRequest, $wgUser;
1310
1311 $rcid = $wgRequest->getVal( 'rcid' );
1312
1313 if ( !$rcid || !$this->mTitle->quickUserCan( 'patrol' ) ) {
1314 return;
1315 }
1316
1317 $sk = $wgUser->getSkin();
1318 $token = $wgUser->editToken( $rcid );
1319 $wgOut->preventClickjacking();
1320
1321 $wgOut->addHTML(
1322 "<div class='patrollink'>" .
1323 wfMsgHtml(
1324 'markaspatrolledlink',
1325 $sk->link(
1326 $this->mTitle,
1327 wfMsgHtml( 'markaspatrolledtext' ),
1328 array(),
1329 array(
1330 'action' => 'markpatrolled',
1331 'rcid' => $rcid,
1332 'token' => $token,
1333 ),
1334 array( 'known', 'noclasses' )
1335 )
1336 ) .
1337 '</div>'
1338 );
1339 }
1340
1341 /**
1342 * Show the error text for a missing article. For articles in the MediaWiki
1343 * namespace, show the default message text. To be called from Article::view().
1344 */
1345 public function showMissingArticle() {
1346 global $wgOut, $wgRequest, $wgUser;
1347
1348 # Show info in user (talk) namespace. Does the user exist? Is he blocked?
1349 if ( $this->mTitle->getNamespace() == NS_USER || $this->mTitle->getNamespace() == NS_USER_TALK ) {
1350 $parts = explode( '/', $this->mTitle->getText() );
1351 $rootPart = $parts[0];
1352 $user = User::newFromName( $rootPart, false /* allow IP users*/ );
1353 $ip = User::isIP( $rootPart );
1354
1355 if ( !$user->isLoggedIn() && !$ip ) { # User does not exist
1356 $wgOut->wrapWikiMsg( "<div class=\"mw-userpage-userdoesnotexist error\">\n\$1\n</div>",
1357 array( 'userpage-userdoesnotexist-view', $rootPart ) );
1358 } else if ( $user->isBlocked() ) { # Show log extract if the user is currently blocked
1359 LogEventsList::showLogExtract(
1360 $wgOut,
1361 'block',
1362 $user->getUserPage()->getPrefixedText(),
1363 '',
1364 array(
1365 'lim' => 1,
1366 'showIfEmpty' => false,
1367 'msgKey' => array(
1368 'blocked-notice-logextract',
1369 $user->getName() # Support GENDER in notice
1370 )
1371 )
1372 );
1373 }
1374 }
1375
1376 wfRunHooks( 'ShowMissingArticle', array( $this ) );
1377
1378 # Show delete and move logs
1379 LogEventsList::showLogExtract( $wgOut, array( 'delete', 'move' ), $this->mTitle->getPrefixedText(), '',
1380 array( 'lim' => 10,
1381 'conds' => array( "log_action != 'revision'" ),
1382 'showIfEmpty' => false,
1383 'msgKey' => array( 'moveddeleted-notice' ) )
1384 );
1385
1386 # Show error message
1387 $oldid = $this->getOldID();
1388 if ( $oldid ) {
1389 $text = wfMsgNoTrans( 'missing-article',
1390 $this->mTitle->getPrefixedText(),
1391 wfMsgNoTrans( 'missingarticle-rev', $oldid ) );
1392 } elseif ( $this->mTitle->getNamespace() === NS_MEDIAWIKI ) {
1393 // Use the default message text
1394 $text = $this->getContent();
1395 } else {
1396 $createErrors = $this->mTitle->getUserPermissionsErrors( 'create', $wgUser );
1397 $editErrors = $this->mTitle->getUserPermissionsErrors( 'edit', $wgUser );
1398 $errors = array_merge( $createErrors, $editErrors );
1399
1400 if ( !count( $errors ) ) {
1401 $text = wfMsgNoTrans( 'noarticletext' );
1402 } else {
1403 $text = wfMsgNoTrans( 'noarticletext-nopermission' );
1404 }
1405 }
1406 $text = "<div class='noarticletext'>\n$text\n</div>";
1407
1408 if ( !$this->hasViewableContent() ) {
1409 // If there's no backing content, send a 404 Not Found
1410 // for better machine handling of broken links.
1411 $wgRequest->response()->header( "HTTP/1.x 404 Not Found" );
1412 }
1413
1414 $wgOut->addWikiText( $text );
1415 }
1416
1417 /**
1418 * If the revision requested for view is deleted, check permissions.
1419 * Send either an error message or a warning header to $wgOut.
1420 *
1421 * @return boolean true if the view is allowed, false if not.
1422 */
1423 public function showDeletedRevisionHeader() {
1424 global $wgOut, $wgRequest;
1425
1426 if ( !$this->mRevision->isDeleted( Revision::DELETED_TEXT ) ) {
1427 // Not deleted
1428 return true;
1429 }
1430
1431 // If the user is not allowed to see it...
1432 if ( !$this->mRevision->userCan( Revision::DELETED_TEXT ) ) {
1433 $wgOut->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
1434 'rev-deleted-text-permission' );
1435
1436 return false;
1437 // If the user needs to confirm that they want to see it...
1438 } else if ( $wgRequest->getInt( 'unhide' ) != 1 ) {
1439 # Give explanation and add a link to view the revision...
1440 $oldid = intval( $this->getOldID() );
1441 $link = $this->mTitle->getFullUrl( "oldid={$oldid}&unhide=1" );
1442 $msg = $this->mRevision->isDeleted( Revision::DELETED_RESTRICTED ) ?
1443 'rev-suppressed-text-unhide' : 'rev-deleted-text-unhide';
1444 $wgOut->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
1445 array( $msg, $link ) );
1446
1447 return false;
1448 // We are allowed to see...
1449 } else {
1450 $msg = $this->mRevision->isDeleted( Revision::DELETED_RESTRICTED ) ?
1451 'rev-suppressed-text-view' : 'rev-deleted-text-view';
1452 $wgOut->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1\n</div>\n", $msg );
1453
1454 return true;
1455 }
1456 }
1457
1458 /**
1459 * Should the parser cache be used?
1460 *
1461 * @return boolean
1462 */
1463 public function useParserCache( $oldid ) {
1464 global $wgUser, $wgEnableParserCache;
1465
1466 return $wgEnableParserCache
1467 && $wgUser->getStubThreshold() == 0
1468 && $this->exists()
1469 && empty( $oldid )
1470 && !$this->mTitle->isCssOrJsPage()
1471 && !$this->mTitle->isCssJsSubpage();
1472 }
1473
1474 /**
1475 * Execute the uncached parse for action=view
1476 */
1477 public function doViewParse() {
1478 global $wgOut;
1479
1480 $oldid = $this->getOldID();
1481 $parserOptions = $this->getParserOptions();
1482
1483 # Render printable version, use printable version cache
1484 $parserOptions->setIsPrintable( $wgOut->isPrintable() );
1485
1486 # Don't show section-edit links on old revisions... this way lies madness.
1487 if ( !$this->isCurrent() || $wgOut->isPrintable() || !$this->mTitle->quickUserCan( 'edit' ) ) {
1488 $parserOptions->setEditSection( false );
1489 }
1490
1491 $useParserCache = $this->useParserCache( $oldid );
1492 $this->outputWikiText( $this->getContent(), $useParserCache, $parserOptions );
1493
1494 return true;
1495 }
1496
1497 /**
1498 * Try to fetch an expired entry from the parser cache. If it is present,
1499 * output it and return true. If it is not present, output nothing and
1500 * return false. This is used as a callback function for
1501 * PoolCounter::executeProtected().
1502 *
1503 * @return boolean
1504 */
1505 public function tryDirtyCache() {
1506 global $wgOut;
1507 $parserCache = ParserCache::singleton();
1508 $options = $this->getParserOptions();
1509
1510 if ( $wgOut->isPrintable() ) {
1511 $options->setIsPrintable( true );
1512 $options->setEditSection( false );
1513 }
1514
1515 $output = $parserCache->getDirty( $this, $options );
1516
1517 if ( $output ) {
1518 wfDebug( __METHOD__ . ": sending dirty output\n" );
1519 wfDebugLog( 'dirty', "dirty output " . $parserCache->getKey( $this, $options ) . "\n" );
1520 $wgOut->setSquidMaxage( 0 );
1521 $this->mParserOutput = $output;
1522 $wgOut->addParserOutput( $output );
1523 $wgOut->addHTML( "<!-- parser cache is expired, sending anyway due to pool overload-->\n" );
1524
1525 return true;
1526 } else {
1527 wfDebugLog( 'dirty', "dirty missing\n" );
1528 wfDebug( __METHOD__ . ": no dirty cache\n" );
1529
1530 return false;
1531 }
1532 }
1533
1534 /**
1535 * View redirect
1536 *
1537 * @param $target Title|Array of destination(s) to redirect
1538 * @param $appendSubtitle Boolean [optional]
1539 * @param $forceKnown Boolean: should the image be shown as a bluelink regardless of existence?
1540 * @return string containing HMTL with redirect link
1541 */
1542 public function viewRedirect( $target, $appendSubtitle = true, $forceKnown = false ) {
1543 global $wgOut, $wgContLang, $wgStylePath, $wgUser;
1544
1545 if ( !is_array( $target ) ) {
1546 $target = array( $target );
1547 }
1548
1549 $imageDir = $wgContLang->getDir();
1550
1551 if ( $appendSubtitle ) {
1552 $wgOut->appendSubtitle( wfMsgHtml( 'redirectpagesub' ) );
1553 }
1554
1555 $sk = $wgUser->getSkin();
1556 // the loop prepends the arrow image before the link, so the first case needs to be outside
1557 $title = array_shift( $target );
1558
1559 if ( $forceKnown ) {
1560 $link = $sk->linkKnown( $title, htmlspecialchars( $title->getFullText() ) );
1561 } else {
1562 $link = $sk->link( $title, htmlspecialchars( $title->getFullText() ) );
1563 }
1564
1565 $nextRedirect = $wgStylePath . '/common/images/nextredirect' . $imageDir . '.png';
1566 $alt = $wgContLang->isRTL() ? '←' : '→';
1567 // Automatically append redirect=no to each link, since most of them are redirect pages themselves.
1568 // FIXME: where this happens?
1569 foreach ( $target as $rt ) {
1570 $link .= Html::element( 'img', array( 'src' => $nextRedirect, 'alt' => $alt ) );
1571 if ( $forceKnown ) {
1572 $link .= $sk->linkKnown( $rt, htmlspecialchars( $rt->getFullText() ) );
1573 } else {
1574 $link .= $sk->link( $rt, htmlspecialchars( $rt->getFullText() ) );
1575 }
1576 }
1577
1578 $imageUrl = $wgStylePath . '/common/images/redirect' . $imageDir . '.png';
1579 return '<div class="redirectMsg">' .
1580 Html::element( 'img', array( 'src' => $imageUrl, 'alt' => '#REDIRECT' ) ) .
1581 '<span class="redirectText">' . $link . '</span></div>';
1582 }
1583
1584 /**
1585 * Builds trackback links for article display if $wgUseTrackbacks is set to true
1586 */
1587 public function addTrackbacks() {
1588 global $wgOut, $wgUser;
1589
1590 $dbr = wfGetDB( DB_SLAVE );
1591 $tbs = $dbr->select( 'trackbacks',
1592 array( 'tb_id', 'tb_title', 'tb_url', 'tb_ex', 'tb_name' ),
1593 array( 'tb_page' => $this->getID() )
1594 );
1595
1596 if ( !$dbr->numRows( $tbs ) ) {
1597 return;
1598 }
1599
1600 $wgOut->preventClickjacking();
1601
1602 $tbtext = "";
1603 foreach ( $tbs as $o ) {
1604 $rmvtxt = "";
1605
1606 if ( $wgUser->isAllowed( 'trackback' ) ) {
1607 $delurl = $this->mTitle->getFullURL( "action=deletetrackback&tbid=" .
1608 $o->tb_id . "&token=" . urlencode( $wgUser->editToken() ) );
1609 $rmvtxt = wfMsg( 'trackbackremove', htmlspecialchars( $delurl ) );
1610 }
1611
1612 $tbtext .= "\n";
1613 $tbtext .= wfMsgNoTrans( strlen( $o->tb_ex ) ? 'trackbackexcerpt' : 'trackback',
1614 $o->tb_title,
1615 $o->tb_url,
1616 $o->tb_ex,
1617 $o->tb_name,
1618 $rmvtxt );
1619 }
1620
1621 $wgOut->wrapWikiMsg( "<div id='mw_trackbacks'>\n$1\n</div>\n", array( 'trackbackbox', $tbtext ) );
1622 }
1623
1624 /**
1625 * Removes trackback record for current article from trackbacks table
1626 */
1627 public function deletetrackback() {
1628 global $wgUser, $wgRequest, $wgOut;
1629
1630 if ( !$wgUser->matchEditToken( $wgRequest->getVal( 'token' ) ) ) {
1631 $wgOut->addWikiMsg( 'sessionfailure' );
1632
1633 return;
1634 }
1635
1636 $permission_errors = $this->mTitle->getUserPermissionsErrors( 'delete', $wgUser );
1637
1638 if ( count( $permission_errors ) ) {
1639 $wgOut->showPermissionsErrorPage( $permission_errors );
1640
1641 return;
1642 }
1643
1644 $db = wfGetDB( DB_MASTER );
1645 $db->delete( 'trackbacks', array( 'tb_id' => $wgRequest->getInt( 'tbid' ) ) );
1646
1647 $wgOut->addWikiMsg( 'trackbackdeleteok' );
1648 $this->mTitle->invalidateCache();
1649 }
1650
1651 /**
1652 * Handle action=render
1653 */
1654
1655 public function render() {
1656 global $wgOut;
1657
1658 $wgOut->setArticleBodyOnly( true );
1659 $this->view();
1660 }
1661
1662 /**
1663 * Handle action=purge
1664 */
1665 public function purge() {
1666 global $wgUser, $wgRequest, $wgOut;
1667
1668 if ( $wgUser->isAllowed( 'purge' ) || $wgRequest->wasPosted() ) {
1669 //FIXME: shouldn't this be in doPurge()?
1670 if ( wfRunHooks( 'ArticlePurge', array( &$this ) ) ) {
1671 $this->doPurge();
1672 $this->view();
1673 }
1674 } else {
1675 $formParams = array(
1676 'method' => 'post',
1677 'action' => $wgRequest->getRequestURL(),
1678 );
1679
1680 $wgOut->addWikiMsg( 'confirm-purge-top' );
1681
1682 $form = Html::openElement( 'form', $formParams );
1683 $form .= Xml::submitButton( wfMsg( 'confirm_purge_button' ) );
1684 $form .= Html::closeElement( 'form' );
1685
1686 $wgOut->addHTML( $form );
1687 $wgOut->addWikiMsg( 'confirm-purge-bottom' );
1688
1689 $wgOut->setPageTitle( $this->mTitle->getPrefixedText() );
1690 $wgOut->setRobotPolicy( 'noindex,nofollow' );
1691 }
1692 }
1693
1694 /**
1695 * Perform the actions of a page purging
1696 */
1697 public function doPurge() {
1698 global $wgUseSquid;
1699
1700 // Invalidate the cache
1701 $this->mTitle->invalidateCache();
1702 $this->clear();
1703
1704 if ( $wgUseSquid ) {
1705 // Commit the transaction before the purge is sent
1706 $dbw = wfGetDB( DB_MASTER );
1707 $dbw->commit();
1708
1709 // Send purge
1710 $update = SquidUpdate::newSimplePurge( $this->mTitle );
1711 $update->doUpdate();
1712 }
1713
1714 if ( $this->mTitle->getNamespace() == NS_MEDIAWIKI ) {
1715 global $wgMessageCache;
1716
1717 if ( $this->getID() == 0 ) {
1718 $text = false;
1719 } else {
1720 $text = $this->getRawText();
1721 }
1722
1723 $wgMessageCache->replace( $this->mTitle->getDBkey(), $text );
1724 }
1725 }
1726
1727 /**
1728 * Insert a new empty page record for this article.
1729 * This *must* be followed up by creating a revision
1730 * and running $this->updateRevisionOn( ... );
1731 * or else the record will be left in a funky state.
1732 * Best if all done inside a transaction.
1733 *
1734 * @param $dbw Database
1735 * @return int The newly created page_id key, or false if the title already existed
1736 * @private
1737 */
1738 public function insertOn( $dbw ) {
1739 wfProfileIn( __METHOD__ );
1740
1741 $page_id = $dbw->nextSequenceValue( 'page_page_id_seq' );
1742 $dbw->insert( 'page', array(
1743 'page_id' => $page_id,
1744 'page_namespace' => $this->mTitle->getNamespace(),
1745 'page_title' => $this->mTitle->getDBkey(),
1746 'page_counter' => 0,
1747 'page_restrictions' => '',
1748 'page_is_redirect' => 0, # Will set this shortly...
1749 'page_is_new' => 1,
1750 'page_random' => wfRandom(),
1751 'page_touched' => $dbw->timestamp(),
1752 'page_latest' => 0, # Fill this in shortly...
1753 'page_len' => 0, # Fill this in shortly...
1754 ), __METHOD__, 'IGNORE' );
1755
1756 $affected = $dbw->affectedRows();
1757
1758 if ( $affected ) {
1759 $newid = $dbw->insertId();
1760 $this->mTitle->resetArticleId( $newid );
1761 }
1762 wfProfileOut( __METHOD__ );
1763
1764 return $affected ? $newid : false;
1765 }
1766
1767 /**
1768 * Update the page record to point to a newly saved revision.
1769 *
1770 * @param $dbw DatabaseBase: object
1771 * @param $revision Revision: For ID number, and text used to set
1772 length and redirect status fields
1773 * @param $lastRevision Integer: if given, will not overwrite the page field
1774 * when different from the currently set value.
1775 * Giving 0 indicates the new page flag should be set
1776 * on.
1777 * @param $lastRevIsRedirect Boolean: if given, will optimize adding and
1778 * removing rows in redirect table.
1779 * @param $setNewFlag Boolean: Set to true if a page flag should be set
1780 * Needed when $lastRevision has to be set to sth. !=0
1781 * @return bool true on success, false on failure
1782 * @private
1783 */
1784 public function updateRevisionOn( &$dbw, $revision, $lastRevision = null, $lastRevIsRedirect = null, $setNewFlag = false ) {
1785 wfProfileIn( __METHOD__ );
1786
1787 $text = $revision->getText();
1788 $rt = Title::newFromRedirectRecurse( $text );
1789
1790 $conditions = array( 'page_id' => $this->getId() );
1791
1792 if ( !is_null( $lastRevision ) ) {
1793 # An extra check against threads stepping on each other
1794 $conditions['page_latest'] = $lastRevision;
1795 }
1796
1797 if ( !$setNewFlag ) {
1798 $setNewFlag = ( $lastRevision === 0 );
1799 }
1800
1801 $dbw->update( 'page',
1802 array( /* SET */
1803 'page_latest' => $revision->getId(),
1804 'page_touched' => $dbw->timestamp(),
1805 'page_is_new' => $setNewFlag,
1806 'page_is_redirect' => $rt !== null ? 1 : 0,
1807 'page_len' => strlen( $text ),
1808 ),
1809 $conditions,
1810 __METHOD__ );
1811
1812 $result = $dbw->affectedRows() != 0;
1813 if ( $result ) {
1814 $this->updateRedirectOn( $dbw, $rt, $lastRevIsRedirect );
1815 }
1816
1817 wfProfileOut( __METHOD__ );
1818 return $result;
1819 }
1820
1821 /**
1822 * Add row to the redirect table if this is a redirect, remove otherwise.
1823 *
1824 * @param $dbw Database
1825 * @param $redirectTitle Title object pointing to the redirect target,
1826 * or NULL if this is not a redirect
1827 * @param $lastRevIsRedirect If given, will optimize adding and
1828 * removing rows in redirect table.
1829 * @return bool true on success, false on failure
1830 * @private
1831 */
1832 public function updateRedirectOn( &$dbw, $redirectTitle, $lastRevIsRedirect = null ) {
1833 // Always update redirects (target link might have changed)
1834 // Update/Insert if we don't know if the last revision was a redirect or not
1835 // Delete if changing from redirect to non-redirect
1836 $isRedirect = !is_null( $redirectTitle );
1837
1838 if ( $isRedirect || is_null( $lastRevIsRedirect ) || $lastRevIsRedirect !== $isRedirect ) {
1839 wfProfileIn( __METHOD__ );
1840 if ( $isRedirect ) {
1841 $this->insertRedirectEntry( $redirectTitle );
1842 } else {
1843 // This is not a redirect, remove row from redirect table
1844 $where = array( 'rd_from' => $this->getId() );
1845 $dbw->delete( 'redirect', $where, __METHOD__ );
1846 }
1847
1848 if ( $this->getTitle()->getNamespace() == NS_FILE ) {
1849 RepoGroup::singleton()->getLocalRepo()->invalidateImageRedirect( $this->getTitle() );
1850 }
1851 wfProfileOut( __METHOD__ );
1852
1853 return ( $dbw->affectedRows() != 0 );
1854 }
1855
1856 return true;
1857 }
1858
1859 /**
1860 * If the given revision is newer than the currently set page_latest,
1861 * update the page record. Otherwise, do nothing.
1862 *
1863 * @param $dbw Database object
1864 * @param $revision Revision object
1865 * @return mixed
1866 */
1867 public function updateIfNewerOn( &$dbw, $revision ) {
1868 wfProfileIn( __METHOD__ );
1869
1870 $row = $dbw->selectRow(
1871 array( 'revision', 'page' ),
1872 array( 'rev_id', 'rev_timestamp', 'page_is_redirect' ),
1873 array(
1874 'page_id' => $this->getId(),
1875 'page_latest=rev_id' ),
1876 __METHOD__ );
1877
1878 if ( $row ) {
1879 if ( wfTimestamp( TS_MW, $row->rev_timestamp ) >= $revision->getTimestamp() ) {
1880 wfProfileOut( __METHOD__ );
1881 return false;
1882 }
1883 $prev = $row->rev_id;
1884 $lastRevIsRedirect = (bool)$row->page_is_redirect;
1885 } else {
1886 # No or missing previous revision; mark the page as new
1887 $prev = 0;
1888 $lastRevIsRedirect = null;
1889 }
1890
1891 $ret = $this->updateRevisionOn( $dbw, $revision, $prev, $lastRevIsRedirect );
1892
1893 wfProfileOut( __METHOD__ );
1894 return $ret;
1895 }
1896
1897 /**
1898 * @param $section empty/null/false or a section number (0, 1, 2, T1, T2...)
1899 * @param $text String: new text of the section
1900 * @param $summary String: new section's subject, only if $section is 'new'
1901 * @param $edittime String: revision timestamp or null to use the current revision
1902 * @return string Complete article text, or null if error
1903 */
1904 public function replaceSection( $section, $text, $summary = '', $edittime = null ) {
1905 wfProfileIn( __METHOD__ );
1906
1907 if ( strval( $section ) == '' ) {
1908 // Whole-page edit; let the whole text through
1909 } else {
1910 if ( is_null( $edittime ) ) {
1911 $rev = Revision::newFromTitle( $this->mTitle );
1912 } else {
1913 $dbw = wfGetDB( DB_MASTER );
1914 $rev = Revision::loadFromTimestamp( $dbw, $this->mTitle, $edittime );
1915 }
1916
1917 if ( !$rev ) {
1918 wfDebug( "Article::replaceSection asked for bogus section (page: " .
1919 $this->getId() . "; section: $section; edittime: $edittime)\n" );
1920 return null;
1921 }
1922
1923 $oldtext = $rev->getText();
1924
1925 if ( $section == 'new' ) {
1926 # Inserting a new section
1927 $subject = $summary ? wfMsgForContent( 'newsectionheaderdefaultlevel', $summary ) . "\n\n" : '';
1928 $text = strlen( trim( $oldtext ) ) > 0
1929 ? "{$oldtext}\n\n{$subject}{$text}"
1930 : "{$subject}{$text}";
1931 } else {
1932 # Replacing an existing section; roll out the big guns
1933 global $wgParser;
1934
1935 $text = $wgParser->replaceSection( $oldtext, $section, $text );
1936 }
1937 }
1938
1939 wfProfileOut( __METHOD__ );
1940 return $text;
1941 }
1942
1943 /**
1944 * @deprecated @since 1.7 use Article::doEdit()
1945 */
1946 function insertNewArticle( $text, $summary, $isminor, $watchthis, $suppressRC = false, $comment = false, $bot = false ) {
1947 wfDeprecated( __METHOD__ );
1948
1949 $flags = EDIT_NEW | EDIT_DEFER_UPDATES | EDIT_AUTOSUMMARY |
1950 ( $isminor ? EDIT_MINOR : 0 ) |
1951 ( $suppressRC ? EDIT_SUPPRESS_RC : 0 ) |
1952 ( $bot ? EDIT_FORCE_BOT : 0 );
1953
1954 # If this is a comment, add the summary as headline
1955 if ( $comment && $summary != "" ) {
1956 $text = wfMsgForContent( 'newsectionheaderdefaultlevel', $summary ) . "\n\n" . $text;
1957 }
1958 $this->doEdit( $text, $summary, $flags );
1959
1960 $dbw = wfGetDB( DB_MASTER );
1961 if ( $watchthis ) {
1962 if ( !$this->mTitle->userIsWatching() ) {
1963 $dbw->begin();
1964 $this->doWatch();
1965 $dbw->commit();
1966 }
1967 } else {
1968 if ( $this->mTitle->userIsWatching() ) {
1969 $dbw->begin();
1970 $this->doUnwatch();
1971 $dbw->commit();
1972 }
1973 }
1974 $this->doRedirect( $this->isRedirect( $text ) );
1975 }
1976
1977 /**
1978 * @deprecated @since 1.7 use Article::doEdit()
1979 */
1980 function updateArticle( $text, $summary, $minor, $watchthis, $forceBot = false, $sectionanchor = '' ) {
1981 wfDeprecated( __METHOD__ );
1982
1983 $flags = EDIT_UPDATE | EDIT_DEFER_UPDATES | EDIT_AUTOSUMMARY |
1984 ( $minor ? EDIT_MINOR : 0 ) |
1985 ( $forceBot ? EDIT_FORCE_BOT : 0 );
1986
1987 $status = $this->doEdit( $text, $summary, $flags );
1988
1989 if ( !$status->isOK() ) {
1990 return false;
1991 }
1992
1993 $dbw = wfGetDB( DB_MASTER );
1994 if ( $watchthis ) {
1995 if ( !$this->mTitle->userIsWatching() ) {
1996 $dbw->begin();
1997 $this->doWatch();
1998 $dbw->commit();
1999 }
2000 } else {
2001 if ( $this->mTitle->userIsWatching() ) {
2002 $dbw->begin();
2003 $this->doUnwatch();
2004 $dbw->commit();
2005 }
2006 }
2007
2008 $extraQuery = ''; // Give extensions a chance to modify URL query on update
2009 wfRunHooks( 'ArticleUpdateBeforeRedirect', array( $this, &$sectionanchor, &$extraQuery ) );
2010
2011 $this->doRedirect( $this->isRedirect( $text ), $sectionanchor, $extraQuery );
2012 return true;
2013 }
2014
2015 /**
2016 * Check flags and add EDIT_NEW or EDIT_UPDATE to them as needed.
2017 * @param $flags Int
2018 * @return Int updated $flags
2019 */
2020 function checkFlags( $flags ) {
2021 if ( !( $flags & EDIT_NEW ) && !( $flags & EDIT_UPDATE ) ) {
2022 if ( $this->mTitle->getArticleID() ) {
2023 $flags |= EDIT_UPDATE;
2024 } else {
2025 $flags |= EDIT_NEW;
2026 }
2027 }
2028
2029 return $flags;
2030 }
2031
2032 /**
2033 * Article::doEdit()
2034 *
2035 * Change an existing article or create a new article. Updates RC and all necessary caches,
2036 * optionally via the deferred update array.
2037 *
2038 * $wgUser must be set before calling this function.
2039 *
2040 * @param $text String: new text
2041 * @param $summary String: edit summary
2042 * @param $flags Integer bitfield:
2043 * EDIT_NEW
2044 * Article is known or assumed to be non-existent, create a new one
2045 * EDIT_UPDATE
2046 * Article is known or assumed to be pre-existing, update it
2047 * EDIT_MINOR
2048 * Mark this edit minor, if the user is allowed to do so
2049 * EDIT_SUPPRESS_RC
2050 * Do not log the change in recentchanges
2051 * EDIT_FORCE_BOT
2052 * Mark the edit a "bot" edit regardless of user rights
2053 * EDIT_DEFER_UPDATES
2054 * Defer some of the updates until the end of index.php
2055 * EDIT_AUTOSUMMARY
2056 * Fill in blank summaries with generated text where possible
2057 *
2058 * If neither EDIT_NEW nor EDIT_UPDATE is specified, the status of the article will be detected.
2059 * If EDIT_UPDATE is specified and the article doesn't exist, the function will an
2060 * edit-gone-missing error. If EDIT_NEW is specified and the article does exist, an
2061 * edit-already-exists error will be returned. These two conditions are also possible with
2062 * auto-detection due to MediaWiki's performance-optimised locking strategy.
2063 *
2064 * @param $baseRevId the revision ID this edit was based off, if any
2065 * @param $user User (optional), $wgUser will be used if not passed
2066 *
2067 * @return Status object. Possible errors:
2068 * edit-hook-aborted: The ArticleSave hook aborted the edit but didn't set the fatal flag of $status
2069 * edit-gone-missing: In update mode, but the article didn't exist
2070 * edit-conflict: In update mode, the article changed unexpectedly
2071 * edit-no-change: Warning that the text was the same as before
2072 * edit-already-exists: In creation mode, but the article already exists
2073 *
2074 * Extensions may define additional errors.
2075 *
2076 * $return->value will contain an associative array with members as follows:
2077 * new: Boolean indicating if the function attempted to create a new article
2078 * revision: The revision object for the inserted revision, or null
2079 *
2080 * Compatibility note: this function previously returned a boolean value indicating success/failure
2081 */
2082 public function doEdit( $text, $summary, $flags = 0, $baseRevId = false, $user = null ) {
2083 global $wgUser, $wgDBtransactions, $wgUseAutomaticEditSummaries;
2084
2085 # Low-level sanity check
2086 if ( $this->mTitle->getText() === '' ) {
2087 throw new MWException( 'Something is trying to edit an article with an empty title' );
2088 }
2089
2090 wfProfileIn( __METHOD__ );
2091
2092 $user = is_null( $user ) ? $wgUser : $user;
2093 $status = Status::newGood( array() );
2094
2095 # Load $this->mTitle->getArticleID() and $this->mLatest if it's not already
2096 $this->loadPageData();
2097
2098 $flags = $this->checkFlags( $flags );
2099
2100 if ( !wfRunHooks( 'ArticleSave', array( &$this, &$user, &$text, &$summary,
2101 $flags & EDIT_MINOR, null, null, &$flags, &$status ) ) )
2102 {
2103 wfDebug( __METHOD__ . ": ArticleSave hook aborted save!\n" );
2104 wfProfileOut( __METHOD__ );
2105
2106 if ( $status->isOK() ) {
2107 $status->fatal( 'edit-hook-aborted' );
2108 }
2109
2110 return $status;
2111 }
2112
2113 # Silently ignore EDIT_MINOR if not allowed
2114 $isminor = ( $flags & EDIT_MINOR ) && $user->isAllowed( 'minoredit' );
2115 $bot = $flags & EDIT_FORCE_BOT;
2116
2117 $oldtext = $this->getRawText(); // current revision
2118 $oldsize = strlen( $oldtext );
2119
2120 # Provide autosummaries if one is not provided and autosummaries are enabled.
2121 if ( $wgUseAutomaticEditSummaries && $flags & EDIT_AUTOSUMMARY && $summary == '' ) {
2122 $summary = $this->getAutosummary( $oldtext, $text, $flags );
2123 }
2124
2125 $editInfo = $this->prepareTextForEdit( $text, null, $user );
2126 $text = $editInfo->pst;
2127 $newsize = strlen( $text );
2128
2129 $dbw = wfGetDB( DB_MASTER );
2130 $now = wfTimestampNow();
2131 $this->mTimestamp = $now;
2132
2133 if ( $flags & EDIT_UPDATE ) {
2134 # Update article, but only if changed.
2135 $status->value['new'] = false;
2136
2137 # Make sure the revision is either completely inserted or not inserted at all
2138 if ( !$wgDBtransactions ) {
2139 $userAbort = ignore_user_abort( true );
2140 }
2141
2142 $changed = ( strcmp( $text, $oldtext ) != 0 );
2143
2144 if ( $changed ) {
2145 $this->mGoodAdjustment = (int)$this->isCountable( $text )
2146 - (int)$this->isCountable( $oldtext );
2147 $this->mTotalAdjustment = 0;
2148
2149 if ( !$this->mLatest ) {
2150 # Article gone missing
2151 wfDebug( __METHOD__ . ": EDIT_UPDATE specified but article doesn't exist\n" );
2152 $status->fatal( 'edit-gone-missing' );
2153
2154 wfProfileOut( __METHOD__ );
2155 return $status;
2156 }
2157
2158 $revision = new Revision( array(
2159 'page' => $this->getId(),
2160 'comment' => $summary,
2161 'minor_edit' => $isminor,
2162 'text' => $text,
2163 'parent_id' => $this->mLatest,
2164 'user' => $user->getId(),
2165 'user_text' => $user->getName(),
2166 'timestamp' => $now
2167 ) );
2168
2169 $dbw->begin();
2170 $revisionId = $revision->insertOn( $dbw );
2171
2172 # Update page
2173 #
2174 # Note that we use $this->mLatest instead of fetching a value from the master DB
2175 # during the course of this function. This makes sure that EditPage can detect
2176 # edit conflicts reliably, either by $ok here, or by $article->getTimestamp()
2177 # before this function is called. A previous function used a separate query, this
2178 # creates a window where concurrent edits can cause an ignored edit conflict.
2179 $ok = $this->updateRevisionOn( $dbw, $revision, $this->mLatest );
2180
2181 if ( !$ok ) {
2182 /* Belated edit conflict! Run away!! */
2183 $status->fatal( 'edit-conflict' );
2184
2185 # Delete the invalid revision if the DB is not transactional
2186 if ( !$wgDBtransactions ) {
2187 $dbw->delete( 'revision', array( 'rev_id' => $revisionId ), __METHOD__ );
2188 }
2189
2190 $revisionId = 0;
2191 $dbw->rollback();
2192 } else {
2193 global $wgUseRCPatrol;
2194 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $revision, $baseRevId, $user ) );
2195 # Update recentchanges
2196 if ( !( $flags & EDIT_SUPPRESS_RC ) ) {
2197 # Mark as patrolled if the user can do so
2198 $patrolled = $wgUseRCPatrol && !count(
2199 $this->mTitle->getUserPermissionsErrors( 'autopatrol', $user ) );
2200 # Add RC row to the DB
2201 $rc = RecentChange::notifyEdit( $now, $this->mTitle, $isminor, $user, $summary,
2202 $this->mLatest, $this->getTimestamp(), $bot, '', $oldsize, $newsize,
2203 $revisionId, $patrolled
2204 );
2205
2206 # Log auto-patrolled edits
2207 if ( $patrolled ) {
2208 PatrolLog::record( $rc, true );
2209 }
2210 }
2211 $user->incEditCount();
2212 $dbw->commit();
2213 }
2214 } else {
2215 $status->warning( 'edit-no-change' );
2216 $revision = null;
2217 // Keep the same revision ID, but do some updates on it
2218 $revisionId = $this->getLatest();
2219 // Update page_touched, this is usually implicit in the page update
2220 // Other cache updates are done in onArticleEdit()
2221 $this->mTitle->invalidateCache();
2222 }
2223
2224 if ( !$wgDBtransactions ) {
2225 ignore_user_abort( $userAbort );
2226 }
2227
2228 // Now that ignore_user_abort is restored, we can respond to fatal errors
2229 if ( !$status->isOK() ) {
2230 wfProfileOut( __METHOD__ );
2231 return $status;
2232 }
2233
2234 # Invalidate cache of this article and all pages using this article
2235 # as a template. Partly deferred.
2236 Article::onArticleEdit( $this->mTitle );
2237 # Update links tables, site stats, etc.
2238 $this->editUpdates( $text, $summary, $isminor, $now, $revisionId, $changed, $user );
2239 } else {
2240 # Create new article
2241 $status->value['new'] = true;
2242
2243 # Set statistics members
2244 # We work out if it's countable after PST to avoid counter drift
2245 # when articles are created with {{subst:}}
2246 $this->mGoodAdjustment = (int)$this->isCountable( $text );
2247 $this->mTotalAdjustment = 1;
2248
2249 $dbw->begin();
2250
2251 # Add the page record; stake our claim on this title!
2252 # This will return false if the article already exists
2253 $newid = $this->insertOn( $dbw );
2254
2255 if ( $newid === false ) {
2256 $dbw->rollback();
2257 $status->fatal( 'edit-already-exists' );
2258
2259 wfProfileOut( __METHOD__ );
2260 return $status;
2261 }
2262
2263 # Save the revision text...
2264 $revision = new Revision( array(
2265 'page' => $newid,
2266 'comment' => $summary,
2267 'minor_edit' => $isminor,
2268 'text' => $text,
2269 'user' => $user->getId(),
2270 'user_text' => $user->getName(),
2271 'timestamp' => $now
2272 ) );
2273 $revisionId = $revision->insertOn( $dbw );
2274
2275 $this->mTitle->resetArticleID( $newid );
2276
2277 # Update the page record with revision data
2278 $this->updateRevisionOn( $dbw, $revision, 0 );
2279
2280 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $revision, false, $user ) );
2281
2282 # Update recentchanges
2283 if ( !( $flags & EDIT_SUPPRESS_RC ) ) {
2284 global $wgUseRCPatrol, $wgUseNPPatrol;
2285
2286 # Mark as patrolled if the user can do so
2287 $patrolled = ( $wgUseRCPatrol || $wgUseNPPatrol ) && !count(
2288 $this->mTitle->getUserPermissionsErrors( 'autopatrol', $user ) );
2289 # Add RC row to the DB
2290 $rc = RecentChange::notifyNew( $now, $this->mTitle, $isminor, $user, $summary, $bot,
2291 '', strlen( $text ), $revisionId, $patrolled );
2292
2293 # Log auto-patrolled edits
2294 if ( $patrolled ) {
2295 PatrolLog::record( $rc, true );
2296 }
2297 }
2298 $user->incEditCount();
2299 $dbw->commit();
2300
2301 # Update links, etc.
2302 $this->editUpdates( $text, $summary, $isminor, $now, $revisionId, true, $user );
2303
2304 # Clear caches
2305 Article::onArticleCreate( $this->mTitle );
2306
2307 wfRunHooks( 'ArticleInsertComplete', array( &$this, &$user, $text, $summary,
2308 $flags & EDIT_MINOR, null, null, &$flags, $revision ) );
2309 }
2310
2311 # Do updates right now unless deferral was requested
2312 if ( !( $flags & EDIT_DEFER_UPDATES ) ) {
2313 wfDoUpdates();
2314 }
2315
2316 // Return the new revision (or null) to the caller
2317 $status->value['revision'] = $revision;
2318
2319 wfRunHooks( 'ArticleSaveComplete', array( &$this, &$user, $text, $summary,
2320 $flags & EDIT_MINOR, null, null, &$flags, $revision, &$status, $baseRevId ) );
2321
2322 wfProfileOut( __METHOD__ );
2323 return $status;
2324 }
2325
2326 /**
2327 * Output a redirect back to the article.
2328 * This is typically used after an edit.
2329 *
2330 * @param $noRedir Boolean: add redirect=no
2331 * @param $sectionAnchor String: section to redirect to, including "#"
2332 * @param $extraQuery String: extra query params
2333 */
2334 public function doRedirect( $noRedir = false, $sectionAnchor = '', $extraQuery = '' ) {
2335 global $wgOut;
2336
2337 if ( $noRedir ) {
2338 $query = 'redirect=no';
2339 if ( $extraQuery )
2340 $query .= "&$extraQuery";
2341 } else {
2342 $query = $extraQuery;
2343 }
2344
2345 $wgOut->redirect( $this->mTitle->getFullURL( $query ) . $sectionAnchor );
2346 }
2347
2348 /**
2349 * Mark this particular edit/page as patrolled
2350 */
2351 public function markpatrolled() {
2352 global $wgOut, $wgUser, $wgRequest;
2353
2354 $wgOut->setRobotPolicy( 'noindex,nofollow' );
2355
2356 # If we haven't been given an rc_id value, we can't do anything
2357 $rcid = (int) $wgRequest->getVal( 'rcid' );
2358
2359 if ( !$wgUser->matchEditToken( $wgRequest->getVal( 'token' ), $rcid ) ) {
2360 $wgOut->showErrorPage( 'sessionfailure-title', 'sessionfailure' );
2361 return;
2362 }
2363
2364 $rc = RecentChange::newFromId( $rcid );
2365
2366 if ( is_null( $rc ) ) {
2367 $wgOut->showErrorPage( 'markedaspatrollederror', 'markedaspatrollederrortext' );
2368 return;
2369 }
2370
2371 # It would be nice to see where the user had actually come from, but for now just guess
2372 $returnto = $rc->getAttribute( 'rc_type' ) == RC_NEW ? 'Newpages' : 'Recentchanges';
2373 $return = SpecialPage::getTitleFor( $returnto );
2374
2375 $errors = $rc->doMarkPatrolled();
2376
2377 if ( in_array( array( 'rcpatroldisabled' ), $errors ) ) {
2378 $wgOut->showErrorPage( 'rcpatroldisabled', 'rcpatroldisabledtext' );
2379
2380 return;
2381 }
2382
2383 if ( in_array( array( 'hookaborted' ), $errors ) ) {
2384 // The hook itself has handled any output
2385 return;
2386 }
2387
2388 if ( in_array( array( 'markedaspatrollederror-noautopatrol' ), $errors ) ) {
2389 $wgOut->setPageTitle( wfMsg( 'markedaspatrollederror' ) );
2390 $wgOut->addWikiMsg( 'markedaspatrollederror-noautopatrol' );
2391 $wgOut->returnToMain( false, $return );
2392
2393 return;
2394 }
2395
2396 if ( !empty( $errors ) ) {
2397 $wgOut->showPermissionsErrorPage( $errors );
2398
2399 return;
2400 }
2401
2402 # Inform the user
2403 $wgOut->setPageTitle( wfMsg( 'markedaspatrolled' ) );
2404 $wgOut->addWikiMsg( 'markedaspatrolledtext', $rc->getTitle()->getPrefixedText() );
2405 $wgOut->returnToMain( false, $return );
2406 }
2407
2408 /**
2409 * User-interface handler for the "watch" action
2410 */
2411 public function watch() {
2412 global $wgUser, $wgOut;
2413
2414 if ( $wgUser->isAnon() ) {
2415 $wgOut->showErrorPage( 'watchnologin', 'watchnologintext' );
2416 return;
2417 }
2418
2419 if ( wfReadOnly() ) {
2420 $wgOut->readOnlyPage();
2421 return;
2422 }
2423
2424 if ( $this->doWatch() ) {
2425 $wgOut->setPagetitle( wfMsg( 'addedwatch' ) );
2426 $wgOut->setRobotPolicy( 'noindex,nofollow' );
2427 $wgOut->addWikiMsg( 'addedwatchtext', $this->mTitle->getPrefixedText() );
2428 }
2429
2430 $wgOut->returnToMain( true, $this->mTitle->getPrefixedText() );
2431 }
2432
2433 /**
2434 * Add this page to $wgUser's watchlist
2435 * @return bool true on successful watch operation
2436 */
2437 public function doWatch() {
2438 global $wgUser;
2439
2440 if ( $wgUser->isAnon() ) {
2441 return false;
2442 }
2443
2444 if ( wfRunHooks( 'WatchArticle', array( &$wgUser, &$this ) ) ) {
2445 $wgUser->addWatch( $this->mTitle );
2446 return wfRunHooks( 'WatchArticleComplete', array( &$wgUser, &$this ) );
2447 }
2448
2449 return false;
2450 }
2451
2452 /**
2453 * User interface handler for the "unwatch" action.
2454 */
2455 public function unwatch() {
2456 global $wgUser, $wgOut;
2457
2458 if ( $wgUser->isAnon() ) {
2459 $wgOut->showErrorPage( 'watchnologin', 'watchnologintext' );
2460 return;
2461 }
2462
2463 if ( wfReadOnly() ) {
2464 $wgOut->readOnlyPage();
2465 return;
2466 }
2467
2468 if ( $this->doUnwatch() ) {
2469 $wgOut->setPagetitle( wfMsg( 'removedwatch' ) );
2470 $wgOut->setRobotPolicy( 'noindex,nofollow' );
2471 $wgOut->addWikiMsg( 'removedwatchtext', $this->mTitle->getPrefixedText() );
2472 }
2473
2474 $wgOut->returnToMain( true, $this->mTitle->getPrefixedText() );
2475 }
2476
2477 /**
2478 * Stop watching a page
2479 * @return bool true on successful unwatch
2480 */
2481 public function doUnwatch() {
2482 global $wgUser;
2483
2484 if ( $wgUser->isAnon() ) {
2485 return false;
2486 }
2487
2488 if ( wfRunHooks( 'UnwatchArticle', array( &$wgUser, &$this ) ) ) {
2489 $wgUser->removeWatch( $this->mTitle );
2490 return wfRunHooks( 'UnwatchArticleComplete', array( &$wgUser, &$this ) );
2491 }
2492
2493 return false;
2494 }
2495
2496 /**
2497 * action=protect handler
2498 */
2499 public function protect() {
2500 $form = new ProtectionForm( $this );
2501 $form->execute();
2502 }
2503
2504 /**
2505 * action=unprotect handler (alias)
2506 */
2507 public function unprotect() {
2508 $this->protect();
2509 }
2510
2511 /**
2512 * Update the article's restriction field, and leave a log entry.
2513 *
2514 * @param $limit Array: set of restriction keys
2515 * @param $reason String
2516 * @param &$cascade Integer. Set to false if cascading protection isn't allowed.
2517 * @param $expiry Array: per restriction type expiration
2518 * @return bool true on success
2519 */
2520 public function updateRestrictions( $limit = array(), $reason = '', &$cascade = 0, $expiry = array() ) {
2521 global $wgUser, $wgContLang;
2522
2523 $restrictionTypes = $this->mTitle->getRestrictionTypes();
2524
2525 $id = $this->mTitle->getArticleID();
2526
2527 if ( $id <= 0 ) {
2528 wfDebug( "updateRestrictions failed: article id $id <= 0\n" );
2529 return false;
2530 }
2531
2532 if ( wfReadOnly() ) {
2533 wfDebug( "updateRestrictions failed: read-only\n" );
2534 return false;
2535 }
2536
2537 if ( !$this->mTitle->userCan( 'protect' ) ) {
2538 wfDebug( "updateRestrictions failed: insufficient permissions\n" );
2539 return false;
2540 }
2541
2542 if ( !$cascade ) {
2543 $cascade = false;
2544 }
2545
2546 // Take this opportunity to purge out expired restrictions
2547 Title::purgeExpiredRestrictions();
2548
2549 # FIXME: Same limitations as described in ProtectionForm.php (line 37);
2550 # we expect a single selection, but the schema allows otherwise.
2551 $current = array();
2552 $updated = Article::flattenRestrictions( $limit );
2553 $changed = false;
2554
2555 foreach ( $restrictionTypes as $action ) {
2556 if ( isset( $expiry[$action] ) ) {
2557 # Get current restrictions on $action
2558 $aLimits = $this->mTitle->getRestrictions( $action );
2559 $current[$action] = implode( '', $aLimits );
2560 # Are any actual restrictions being dealt with here?
2561 $aRChanged = count( $aLimits ) || !empty( $limit[$action] );
2562
2563 # If something changed, we need to log it. Checking $aRChanged
2564 # assures that "unprotecting" a page that is not protected does
2565 # not log just because the expiry was "changed".
2566 if ( $aRChanged && $this->mTitle->mRestrictionsExpiry[$action] != $expiry[$action] ) {
2567 $changed = true;
2568 }
2569 }
2570 }
2571
2572 $current = Article::flattenRestrictions( $current );
2573
2574 $changed = ( $changed || $current != $updated );
2575 $changed = $changed || ( $updated && $this->mTitle->areRestrictionsCascading() != $cascade );
2576 $protect = ( $updated != '' );
2577
2578 # If nothing's changed, do nothing
2579 if ( $changed ) {
2580 if ( wfRunHooks( 'ArticleProtect', array( &$this, &$wgUser, $limit, $reason ) ) ) {
2581 $dbw = wfGetDB( DB_MASTER );
2582
2583 # Prepare a null revision to be added to the history
2584 $modified = $current != '' && $protect;
2585
2586 if ( $protect ) {
2587 $comment_type = $modified ? 'modifiedarticleprotection' : 'protectedarticle';
2588 } else {
2589 $comment_type = 'unprotectedarticle';
2590 }
2591
2592 $comment = $wgContLang->ucfirst( wfMsgForContent( $comment_type, $this->mTitle->getPrefixedText() ) );
2593
2594 # Only restrictions with the 'protect' right can cascade...
2595 # Otherwise, people who cannot normally protect can "protect" pages via transclusion
2596 $editrestriction = isset( $limit['edit'] ) ? array( $limit['edit'] ) : $this->mTitle->getRestrictions( 'edit' );
2597
2598 # The schema allows multiple restrictions
2599 if ( !in_array( 'protect', $editrestriction ) && !in_array( 'sysop', $editrestriction ) ) {
2600 $cascade = false;
2601 }
2602
2603 $cascade_description = '';
2604
2605 if ( $cascade ) {
2606 $cascade_description = ' [' . wfMsgForContent( 'protect-summary-cascade' ) . ']';
2607 }
2608
2609 if ( $reason ) {
2610 $comment .= ": $reason";
2611 }
2612
2613 $editComment = $comment;
2614 $encodedExpiry = array();
2615 $protect_description = '';
2616 foreach ( $limit as $action => $restrictions ) {
2617 if ( !isset( $expiry[$action] ) )
2618 $expiry[$action] = Block::infinity();
2619
2620 $encodedExpiry[$action] = Block::encodeExpiry( $expiry[$action], $dbw );
2621 if ( $restrictions != '' ) {
2622 $protect_description .= "[$action=$restrictions] (";
2623 if ( $encodedExpiry[$action] != 'infinity' ) {
2624 $protect_description .= wfMsgForContent( 'protect-expiring',
2625 $wgContLang->timeanddate( $expiry[$action], false, false ) ,
2626 $wgContLang->date( $expiry[$action], false, false ) ,
2627 $wgContLang->time( $expiry[$action], false, false ) );
2628 } else {
2629 $protect_description .= wfMsgForContent( 'protect-expiry-indefinite' );
2630 }
2631
2632 $protect_description .= ') ';
2633 }
2634 }
2635 $protect_description = trim( $protect_description );
2636
2637 if ( $protect_description && $protect ) {
2638 $editComment .= " ($protect_description)";
2639 }
2640
2641 if ( $cascade ) {
2642 $editComment .= "$cascade_description";
2643 }
2644
2645 # Update restrictions table
2646 foreach ( $limit as $action => $restrictions ) {
2647 if ( $restrictions != '' ) {
2648 $dbw->replace( 'page_restrictions', array( array( 'pr_page', 'pr_type' ) ),
2649 array( 'pr_page' => $id,
2650 'pr_type' => $action,
2651 'pr_level' => $restrictions,
2652 'pr_cascade' => ( $cascade && $action == 'edit' ) ? 1 : 0,
2653 'pr_expiry' => $encodedExpiry[$action]
2654 ),
2655 __METHOD__
2656 );
2657 } else {
2658 $dbw->delete( 'page_restrictions', array( 'pr_page' => $id,
2659 'pr_type' => $action ), __METHOD__ );
2660 }
2661 }
2662
2663 # Insert a null revision
2664 $nullRevision = Revision::newNullRevision( $dbw, $id, $editComment, true );
2665 $nullRevId = $nullRevision->insertOn( $dbw );
2666
2667 $latest = $this->getLatest();
2668 # Update page record
2669 $dbw->update( 'page',
2670 array( /* SET */
2671 'page_touched' => $dbw->timestamp(),
2672 'page_restrictions' => '',
2673 'page_latest' => $nullRevId
2674 ), array( /* WHERE */
2675 'page_id' => $id
2676 ), 'Article::protect'
2677 );
2678
2679 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $nullRevision, $latest, $wgUser ) );
2680 wfRunHooks( 'ArticleProtectComplete', array( &$this, &$wgUser, $limit, $reason ) );
2681
2682 # Update the protection log
2683 $log = new LogPage( 'protect' );
2684 if ( $protect ) {
2685 $params = array( $protect_description, $cascade ? 'cascade' : '' );
2686 $log->addEntry( $modified ? 'modify' : 'protect', $this->mTitle, trim( $reason ), $params );
2687 } else {
2688 $log->addEntry( 'unprotect', $this->mTitle, $reason );
2689 }
2690 } # End hook
2691 } # End "changed" check
2692
2693 return true;
2694 }
2695
2696 /**
2697 * Take an array of page restrictions and flatten it to a string
2698 * suitable for insertion into the page_restrictions field.
2699 * @param $limit Array
2700 * @return String
2701 */
2702 protected static function flattenRestrictions( $limit ) {
2703 if ( !is_array( $limit ) ) {
2704 throw new MWException( 'Article::flattenRestrictions given non-array restriction set' );
2705 }
2706
2707 $bits = array();
2708 ksort( $limit );
2709
2710 foreach ( $limit as $action => $restrictions ) {
2711 if ( $restrictions != '' ) {
2712 $bits[] = "$action=$restrictions";
2713 }
2714 }
2715
2716 return implode( ':', $bits );
2717 }
2718
2719 /**
2720 * Auto-generates a deletion reason
2721 *
2722 * @param &$hasHistory Boolean: whether the page has a history
2723 * @return mixed String containing deletion reason or empty string, or boolean false
2724 * if no revision occurred
2725 */
2726 public function generateReason( &$hasHistory ) {
2727 global $wgContLang;
2728
2729 $dbw = wfGetDB( DB_MASTER );
2730 // Get the last revision
2731 $rev = Revision::newFromTitle( $this->mTitle );
2732
2733 if ( is_null( $rev ) ) {
2734 return false;
2735 }
2736
2737 // Get the article's contents
2738 $contents = $rev->getText();
2739 $blank = false;
2740
2741 // If the page is blank, use the text from the previous revision,
2742 // which can only be blank if there's a move/import/protect dummy revision involved
2743 if ( $contents == '' ) {
2744 $prev = $rev->getPrevious();
2745
2746 if ( $prev ) {
2747 $contents = $prev->getText();
2748 $blank = true;
2749 }
2750 }
2751
2752 // Find out if there was only one contributor
2753 // Only scan the last 20 revisions
2754 $res = $dbw->select( 'revision', 'rev_user_text',
2755 array( 'rev_page' => $this->getID(), $dbw->bitAnd( 'rev_deleted', Revision::DELETED_USER ) . ' = 0' ),
2756 __METHOD__,
2757 array( 'LIMIT' => 20 )
2758 );
2759
2760 if ( $res === false ) {
2761 // This page has no revisions, which is very weird
2762 return false;
2763 }
2764
2765 $hasHistory = ( $res->numRows() > 1 );
2766 $row = $dbw->fetchObject( $res );
2767
2768 if ( $row ) { // $row is false if the only contributor is hidden
2769 $onlyAuthor = $row->rev_user_text;
2770 // Try to find a second contributor
2771 foreach ( $res as $row ) {
2772 if ( $row->rev_user_text != $onlyAuthor ) { // Bug 22999
2773 $onlyAuthor = false;
2774 break;
2775 }
2776 }
2777 } else {
2778 $onlyAuthor = false;
2779 }
2780
2781 // Generate the summary with a '$1' placeholder
2782 if ( $blank ) {
2783 // The current revision is blank and the one before is also
2784 // blank. It's just not our lucky day
2785 $reason = wfMsgForContent( 'exbeforeblank', '$1' );
2786 } else {
2787 if ( $onlyAuthor ) {
2788 $reason = wfMsgForContent( 'excontentauthor', '$1', $onlyAuthor );
2789 } else {
2790 $reason = wfMsgForContent( 'excontent', '$1' );
2791 }
2792 }
2793
2794 if ( $reason == '-' ) {
2795 // Allow these UI messages to be blanked out cleanly
2796 return '';
2797 }
2798
2799 // Replace newlines with spaces to prevent uglyness
2800 $contents = preg_replace( "/[\n\r]/", ' ', $contents );
2801 // Calculate the maximum amount of chars to get
2802 // Max content length = max comment length - length of the comment (excl. $1) - '...'
2803 $maxLength = 255 - ( strlen( $reason ) - 2 ) - 3;
2804 $contents = $wgContLang->truncate( $contents, $maxLength );
2805 // Remove possible unfinished links
2806 $contents = preg_replace( '/\[\[([^\]]*)\]?$/', '$1', $contents );
2807 // Now replace the '$1' placeholder
2808 $reason = str_replace( '$1', $contents, $reason );
2809
2810 return $reason;
2811 }
2812
2813
2814 /*
2815 * UI entry point for page deletion
2816 */
2817 public function delete() {
2818 global $wgUser, $wgOut, $wgRequest;
2819
2820 $confirm = $wgRequest->wasPosted() &&
2821 $wgUser->matchEditToken( $wgRequest->getVal( 'wpEditToken' ) );
2822
2823 $this->DeleteReasonList = $wgRequest->getText( 'wpDeleteReasonList', 'other' );
2824 $this->DeleteReason = $wgRequest->getText( 'wpReason' );
2825
2826 $reason = $this->DeleteReasonList;
2827
2828 if ( $reason != 'other' && $this->DeleteReason != '' ) {
2829 // Entry from drop down menu + additional comment
2830 $reason .= wfMsgForContent( 'colon-separator' ) . $this->DeleteReason;
2831 } elseif ( $reason == 'other' ) {
2832 $reason = $this->DeleteReason;
2833 }
2834
2835 # Flag to hide all contents of the archived revisions
2836 $suppress = $wgRequest->getVal( 'wpSuppress' ) && $wgUser->isAllowed( 'suppressrevision' );
2837
2838 # This code desperately needs to be totally rewritten
2839
2840 # Read-only check...
2841 if ( wfReadOnly() ) {
2842 $wgOut->readOnlyPage();
2843
2844 return;
2845 }
2846
2847 # Check permissions
2848 $permission_errors = $this->mTitle->getUserPermissionsErrors( 'delete', $wgUser );
2849
2850 if ( count( $permission_errors ) > 0 ) {
2851 $wgOut->showPermissionsErrorPage( $permission_errors );
2852
2853 return;
2854 }
2855
2856 $wgOut->setPagetitle( wfMsg( 'delete-confirm', $this->mTitle->getPrefixedText() ) );
2857
2858 # Better double-check that it hasn't been deleted yet!
2859 $dbw = wfGetDB( DB_MASTER );
2860 $conds = $this->mTitle->pageCond();
2861 $latest = $dbw->selectField( 'page', 'page_latest', $conds, __METHOD__ );
2862 if ( $latest === false ) {
2863 $wgOut->showFatalError(
2864 Html::rawElement(
2865 'div',
2866 array( 'class' => 'error mw-error-cannotdelete' ),
2867 wfMsgExt( 'cannotdelete', array( 'parse' ), $this->mTitle->getPrefixedText() )
2868 )
2869 );
2870 $wgOut->addHTML( Xml::element( 'h2', null, LogPage::logName( 'delete' ) ) );
2871 LogEventsList::showLogExtract(
2872 $wgOut,
2873 'delete',
2874 $this->mTitle->getPrefixedText()
2875 );
2876
2877 return;
2878 }
2879
2880 # Hack for big sites
2881 $bigHistory = $this->isBigDeletion();
2882 if ( $bigHistory && !$this->mTitle->userCan( 'bigdelete' ) ) {
2883 global $wgLang, $wgDeleteRevisionsLimit;
2884
2885 $wgOut->wrapWikiMsg( "<div class='error'>\n$1\n</div>\n",
2886 array( 'delete-toobig', $wgLang->formatNum( $wgDeleteRevisionsLimit ) ) );
2887
2888 return;
2889 }
2890
2891 if ( $confirm ) {
2892 $this->doDelete( $reason, $suppress );
2893
2894 if ( $wgRequest->getCheck( 'wpWatch' ) && $wgUser->isLoggedIn() ) {
2895 $this->doWatch();
2896 } elseif ( $this->mTitle->userIsWatching() ) {
2897 $this->doUnwatch();
2898 }
2899
2900 return;
2901 }
2902
2903 // Generate deletion reason
2904 $hasHistory = false;
2905 if ( !$reason ) {
2906 $reason = $this->generateReason( $hasHistory );
2907 }
2908
2909 // If the page has a history, insert a warning
2910 if ( $hasHistory && !$confirm ) {
2911 global $wgLang;
2912
2913 $skin = $wgUser->getSkin();
2914 $revisions = $this->estimateRevisionCount();
2915 //FIXME: lego
2916 $wgOut->addHTML( '<strong class="mw-delete-warning-revisions">' .
2917 wfMsgExt( 'historywarning', array( 'parseinline' ), $wgLang->formatNum( $revisions ) ) .
2918 wfMsgHtml( 'word-separator' ) . $skin->historyLink() .
2919 '</strong>'
2920 );
2921
2922 if ( $bigHistory ) {
2923 global $wgDeleteRevisionsLimit;
2924 $wgOut->wrapWikiMsg( "<div class='error'>\n$1\n</div>\n",
2925 array( 'delete-warning-toobig', $wgLang->formatNum( $wgDeleteRevisionsLimit ) ) );
2926 }
2927 }
2928
2929 return $this->confirmDelete( $reason );
2930 }
2931
2932 /**
2933 * @return bool whether or not the page surpasses $wgDeleteRevisionsLimit revisions
2934 */
2935 public function isBigDeletion() {
2936 global $wgDeleteRevisionsLimit;
2937
2938 if ( $wgDeleteRevisionsLimit ) {
2939 $revCount = $this->estimateRevisionCount();
2940
2941 return $revCount > $wgDeleteRevisionsLimit;
2942 }
2943
2944 return false;
2945 }
2946
2947 /**
2948 * @return int approximate revision count
2949 */
2950 public function estimateRevisionCount() {
2951 $dbr = wfGetDB( DB_SLAVE );
2952
2953 // For an exact count...
2954 // return $dbr->selectField( 'revision', 'COUNT(*)',
2955 // array( 'rev_page' => $this->getId() ), __METHOD__ );
2956 return $dbr->estimateRowCount( 'revision', '*',
2957 array( 'rev_page' => $this->getId() ), __METHOD__ );
2958 }
2959
2960 /**
2961 * Get the last N authors
2962 * @param $num Integer: number of revisions to get
2963 * @param $revLatest String: the latest rev_id, selected from the master (optional)
2964 * @return array Array of authors, duplicates not removed
2965 */
2966 public function getLastNAuthors( $num, $revLatest = 0 ) {
2967 wfProfileIn( __METHOD__ );
2968 // First try the slave
2969 // If that doesn't have the latest revision, try the master
2970 $continue = 2;
2971 $db = wfGetDB( DB_SLAVE );
2972
2973 do {
2974 $res = $db->select( array( 'page', 'revision' ),
2975 array( 'rev_id', 'rev_user_text' ),
2976 array(
2977 'page_namespace' => $this->mTitle->getNamespace(),
2978 'page_title' => $this->mTitle->getDBkey(),
2979 'rev_page = page_id'
2980 ), __METHOD__, $this->getSelectOptions( array(
2981 'ORDER BY' => 'rev_timestamp DESC',
2982 'LIMIT' => $num
2983 ) )
2984 );
2985
2986 if ( !$res ) {
2987 wfProfileOut( __METHOD__ );
2988 return array();
2989 }
2990
2991 $row = $db->fetchObject( $res );
2992
2993 if ( $continue == 2 && $revLatest && $row->rev_id != $revLatest ) {
2994 $db = wfGetDB( DB_MASTER );
2995 $continue--;
2996 } else {
2997 $continue = 0;
2998 }
2999 } while ( $continue );
3000
3001 $authors = array( $row->rev_user_text );
3002
3003 foreach ( $res as $row ) {
3004 $authors[] = $row->rev_user_text;
3005 }
3006
3007 wfProfileOut( __METHOD__ );
3008 return $authors;
3009 }
3010
3011 /**
3012 * Output deletion confirmation dialog
3013 * FIXME: Move to another file?
3014 * @param $reason String: prefilled reason
3015 */
3016 public function confirmDelete( $reason ) {
3017 global $wgOut, $wgUser;
3018
3019 wfDebug( "Article::confirmDelete\n" );
3020
3021 $deleteBackLink = $wgUser->getSkin()->linkKnown( $this->mTitle );
3022 $wgOut->setSubtitle( wfMsgHtml( 'delete-backlink', $deleteBackLink ) );
3023 $wgOut->setRobotPolicy( 'noindex,nofollow' );
3024 $wgOut->addWikiMsg( 'confirmdeletetext' );
3025
3026 wfRunHooks( 'ArticleConfirmDelete', array( $this, $wgOut, &$reason ) );
3027
3028 if ( $wgUser->isAllowed( 'suppressrevision' ) ) {
3029 $suppress = "<tr id=\"wpDeleteSuppressRow\">
3030 <td></td>
3031 <td class='mw-input'><strong>" .
3032 Xml::checkLabel( wfMsg( 'revdelete-suppress' ),
3033 'wpSuppress', 'wpSuppress', false, array( 'tabindex' => '4' ) ) .
3034 "</strong></td>
3035 </tr>";
3036 } else {
3037 $suppress = '';
3038 }
3039 $checkWatch = $wgUser->getBoolOption( 'watchdeletion' ) || $this->mTitle->userIsWatching();
3040
3041 $form = Xml::openElement( 'form', array( 'method' => 'post',
3042 'action' => $this->mTitle->getLocalURL( 'action=delete' ), 'id' => 'deleteconfirm' ) ) .
3043 Xml::openElement( 'fieldset', array( 'id' => 'mw-delete-table' ) ) .
3044 Xml::tags( 'legend', null, wfMsgExt( 'delete-legend', array( 'parsemag', 'escapenoentities' ) ) ) .
3045 Xml::openElement( 'table', array( 'id' => 'mw-deleteconfirm-table' ) ) .
3046 "<tr id=\"wpDeleteReasonListRow\">
3047 <td class='mw-label'>" .
3048 Xml::label( wfMsg( 'deletecomment' ), 'wpDeleteReasonList' ) .
3049 "</td>
3050 <td class='mw-input'>" .
3051 Xml::listDropDown( 'wpDeleteReasonList',
3052 wfMsgForContent( 'deletereason-dropdown' ),
3053 wfMsgForContent( 'deletereasonotherlist' ), '', 'wpReasonDropDown', 1 ) .
3054 "</td>
3055 </tr>
3056 <tr id=\"wpDeleteReasonRow\">
3057 <td class='mw-label'>" .
3058 Xml::label( wfMsg( 'deleteotherreason' ), 'wpReason' ) .
3059 "</td>
3060 <td class='mw-input'>" .
3061 Html::input( 'wpReason', $reason, 'text', array(
3062 'size' => '60',
3063 'maxlength' => '255',
3064 'tabindex' => '2',
3065 'id' => 'wpReason',
3066 'autofocus'
3067 ) ) .
3068 "</td>
3069 </tr>";
3070
3071 # Disallow watching if user is not logged in
3072 if ( $wgUser->isLoggedIn() ) {
3073 $form .= "
3074 <tr>
3075 <td></td>
3076 <td class='mw-input'>" .
3077 Xml::checkLabel( wfMsg( 'watchthis' ),
3078 'wpWatch', 'wpWatch', $checkWatch, array( 'tabindex' => '3' ) ) .
3079 "</td>
3080 </tr>";
3081 }
3082
3083 $form .= "
3084 $suppress
3085 <tr>
3086 <td></td>
3087 <td class='mw-submit'>" .
3088 Xml::submitButton( wfMsg( 'deletepage' ),
3089 array( 'name' => 'wpConfirmB', 'id' => 'wpConfirmB', 'tabindex' => '5' ) ) .
3090 "</td>
3091 </tr>" .
3092 Xml::closeElement( 'table' ) .
3093 Xml::closeElement( 'fieldset' ) .
3094 Html::hidden( 'wpEditToken', $wgUser->editToken() ) .
3095 Xml::closeElement( 'form' );
3096
3097 if ( $wgUser->isAllowed( 'editinterface' ) ) {
3098 $skin = $wgUser->getSkin();
3099 $title = Title::makeTitle( NS_MEDIAWIKI, 'Deletereason-dropdown' );
3100 $link = $skin->link(
3101 $title,
3102 wfMsgHtml( 'delete-edit-reasonlist' ),
3103 array(),
3104 array( 'action' => 'edit' )
3105 );
3106 $form .= '<p class="mw-delete-editreasons">' . $link . '</p>';
3107 }
3108
3109 $wgOut->addHTML( $form );
3110 $wgOut->addHTML( Xml::element( 'h2', null, LogPage::logName( 'delete' ) ) );
3111 LogEventsList::showLogExtract( $wgOut, 'delete',
3112 $this->mTitle->getPrefixedText()
3113 );
3114 }
3115
3116 /**
3117 * Perform a deletion and output success or failure messages
3118 */
3119 public function doDelete( $reason, $suppress = false ) {
3120 global $wgOut, $wgUser;
3121
3122 $id = $this->mTitle->getArticleID( Title::GAID_FOR_UPDATE );
3123
3124 $error = '';
3125 if ( wfRunHooks( 'ArticleDelete', array( &$this, &$wgUser, &$reason, &$error ) ) ) {
3126 if ( $this->doDeleteArticle( $reason, $suppress, $id ) ) {
3127 $deleted = $this->mTitle->getPrefixedText();
3128
3129 $wgOut->setPagetitle( wfMsg( 'actioncomplete' ) );
3130 $wgOut->setRobotPolicy( 'noindex,nofollow' );
3131
3132 $loglink = '[[Special:Log/delete|' . wfMsgNoTrans( 'deletionlog' ) . ']]';
3133
3134 $wgOut->addWikiMsg( 'deletedtext', $deleted, $loglink );
3135 $wgOut->returnToMain( false );
3136 wfRunHooks( 'ArticleDeleteComplete', array( &$this, &$wgUser, $reason, $id ) );
3137 }
3138 } else {
3139 if ( $error == '' ) {
3140 $wgOut->showFatalError(
3141 Html::rawElement(
3142 'div',
3143 array( 'class' => 'error mw-error-cannotdelete' ),
3144 wfMsgExt( 'cannotdelete', array( 'parse' ), $this->mTitle->getPrefixedText() )
3145 )
3146 );
3147
3148 $wgOut->addHTML( Xml::element( 'h2', null, LogPage::logName( 'delete' ) ) );
3149
3150 LogEventsList::showLogExtract(
3151 $wgOut,
3152 'delete',
3153 $this->mTitle->getPrefixedText()
3154 );
3155 } else {
3156 $wgOut->showFatalError( $error );
3157 }
3158 }
3159 }
3160
3161 /**
3162 * Back-end article deletion
3163 * Deletes the article with database consistency, writes logs, purges caches
3164 *
3165 * @param $reason string delete reason for deletion log
3166 * @param suppress bitfield
3167 * Revision::DELETED_TEXT
3168 * Revision::DELETED_COMMENT
3169 * Revision::DELETED_USER
3170 * Revision::DELETED_RESTRICTED
3171 * @param $id int article ID
3172 * @param $commit boolean defaults to true, triggers transaction end
3173 * @return boolean true if successful
3174 */
3175 public function doDeleteArticle( $reason, $suppress = false, $id = 0, $commit = true ) {
3176 global $wgDeferredUpdateList, $wgUseTrackbacks;
3177
3178 wfDebug( __METHOD__ . "\n" );
3179
3180 $dbw = wfGetDB( DB_MASTER );
3181 $t = $this->mTitle->getDBkey();
3182 $id = $id ? $id : $this->mTitle->getArticleID( Title::GAID_FOR_UPDATE );
3183
3184 if ( $t === '' || $id == 0 ) {
3185 return false;
3186 }
3187
3188 $u = new SiteStatsUpdate( 0, 1, - (int)$this->isCountable( $this->getRawText() ), -1 );
3189 array_push( $wgDeferredUpdateList, $u );
3190
3191 // Bitfields to further suppress the content
3192 if ( $suppress ) {
3193 $bitfield = 0;
3194 // This should be 15...
3195 $bitfield |= Revision::DELETED_TEXT;
3196 $bitfield |= Revision::DELETED_COMMENT;
3197 $bitfield |= Revision::DELETED_USER;
3198 $bitfield |= Revision::DELETED_RESTRICTED;
3199 } else {
3200 $bitfield = 'rev_deleted';
3201 }
3202
3203 $dbw->begin();
3204 // For now, shunt the revision data into the archive table.
3205 // Text is *not* removed from the text table; bulk storage
3206 // is left intact to avoid breaking block-compression or
3207 // immutable storage schemes.
3208 //
3209 // For backwards compatibility, note that some older archive
3210 // table entries will have ar_text and ar_flags fields still.
3211 //
3212 // In the future, we may keep revisions and mark them with
3213 // the rev_deleted field, which is reserved for this purpose.
3214 $dbw->insertSelect( 'archive', array( 'page', 'revision' ),
3215 array(
3216 'ar_namespace' => 'page_namespace',
3217 'ar_title' => 'page_title',
3218 'ar_comment' => 'rev_comment',
3219 'ar_user' => 'rev_user',
3220 'ar_user_text' => 'rev_user_text',
3221 'ar_timestamp' => 'rev_timestamp',
3222 'ar_minor_edit' => 'rev_minor_edit',
3223 'ar_rev_id' => 'rev_id',
3224 'ar_text_id' => 'rev_text_id',
3225 'ar_text' => '\'\'', // Be explicit to appease
3226 'ar_flags' => '\'\'', // MySQL's "strict mode"...
3227 'ar_len' => 'rev_len',
3228 'ar_page_id' => 'page_id',
3229 'ar_deleted' => $bitfield
3230 ), array(
3231 'page_id' => $id,
3232 'page_id = rev_page'
3233 ), __METHOD__
3234 );
3235
3236 # Delete restrictions for it
3237 $dbw->delete( 'page_restrictions', array ( 'pr_page' => $id ), __METHOD__ );
3238
3239 # Now that it's safely backed up, delete it
3240 $dbw->delete( 'page', array( 'page_id' => $id ), __METHOD__ );
3241 $ok = ( $dbw->affectedRows() > 0 ); // getArticleId() uses slave, could be laggy
3242
3243 if ( !$ok ) {
3244 $dbw->rollback();
3245 return false;
3246 }
3247
3248 # Fix category table counts
3249 $cats = array();
3250 $res = $dbw->select( 'categorylinks', 'cl_to', array( 'cl_from' => $id ), __METHOD__ );
3251
3252 foreach ( $res as $row ) {
3253 $cats [] = $row->cl_to;
3254 }
3255
3256 $this->updateCategoryCounts( array(), $cats );
3257
3258 # If using cascading deletes, we can skip some explicit deletes
3259 if ( !$dbw->cascadingDeletes() ) {
3260 $dbw->delete( 'revision', array( 'rev_page' => $id ), __METHOD__ );
3261
3262 if ( $wgUseTrackbacks )
3263 $dbw->delete( 'trackbacks', array( 'tb_page' => $id ), __METHOD__ );
3264
3265 # Delete outgoing links
3266 $dbw->delete( 'pagelinks', array( 'pl_from' => $id ) );
3267 $dbw->delete( 'imagelinks', array( 'il_from' => $id ) );
3268 $dbw->delete( 'categorylinks', array( 'cl_from' => $id ) );
3269 $dbw->delete( 'templatelinks', array( 'tl_from' => $id ) );
3270 $dbw->delete( 'externallinks', array( 'el_from' => $id ) );
3271 $dbw->delete( 'langlinks', array( 'll_from' => $id ) );
3272 $dbw->delete( 'redirect', array( 'rd_from' => $id ) );
3273 }
3274
3275 # If using cleanup triggers, we can skip some manual deletes
3276 if ( !$dbw->cleanupTriggers() ) {
3277 # Clean up recentchanges entries...
3278 $dbw->delete( 'recentchanges',
3279 array( 'rc_type != ' . RC_LOG,
3280 'rc_namespace' => $this->mTitle->getNamespace(),
3281 'rc_title' => $this->mTitle->getDBkey() ),
3282 __METHOD__ );
3283 $dbw->delete( 'recentchanges',
3284 array( 'rc_type != ' . RC_LOG, 'rc_cur_id' => $id ),
3285 __METHOD__ );
3286 }
3287
3288 # Clear caches
3289 Article::onArticleDelete( $this->mTitle );
3290
3291 # Clear the cached article id so the interface doesn't act like we exist
3292 $this->mTitle->resetArticleID( 0 );
3293
3294 # Log the deletion, if the page was suppressed, log it at Oversight instead
3295 $logtype = $suppress ? 'suppress' : 'delete';
3296 $log = new LogPage( $logtype );
3297
3298 # Make sure logging got through
3299 $log->addEntry( 'delete', $this->mTitle, $reason, array() );
3300
3301 if ( $commit ) {
3302 $dbw->commit();
3303 }
3304
3305 return true;
3306 }
3307
3308 /**
3309 * Roll back the most recent consecutive set of edits to a page
3310 * from the same user; fails if there are no eligible edits to
3311 * roll back to, e.g. user is the sole contributor. This function
3312 * performs permissions checks on $wgUser, then calls commitRollback()
3313 * to do the dirty work
3314 *
3315 * @param $fromP String: Name of the user whose edits to rollback.
3316 * @param $summary String: Custom summary. Set to default summary if empty.
3317 * @param $token String: Rollback token.
3318 * @param $bot Boolean: If true, mark all reverted edits as bot.
3319 *
3320 * @param $resultDetails Array: contains result-specific array of additional values
3321 * 'alreadyrolled' : 'current' (rev)
3322 * success : 'summary' (str), 'current' (rev), 'target' (rev)
3323 *
3324 * @return array of errors, each error formatted as
3325 * array(messagekey, param1, param2, ...).
3326 * On success, the array is empty. This array can also be passed to
3327 * OutputPage::showPermissionsErrorPage().
3328 */
3329 public function doRollback( $fromP, $summary, $token, $bot, &$resultDetails ) {
3330 global $wgUser;
3331
3332 $resultDetails = null;
3333
3334 # Check permissions
3335 $editErrors = $this->mTitle->getUserPermissionsErrors( 'edit', $wgUser );
3336 $rollbackErrors = $this->mTitle->getUserPermissionsErrors( 'rollback', $wgUser );
3337 $errors = array_merge( $editErrors, wfArrayDiff2( $rollbackErrors, $editErrors ) );
3338
3339 if ( !$wgUser->matchEditToken( $token, array( $this->mTitle->getPrefixedText(), $fromP ) ) ) {
3340 $errors[] = array( 'sessionfailure' );
3341 }
3342
3343 if ( $wgUser->pingLimiter( 'rollback' ) || $wgUser->pingLimiter() ) {
3344 $errors[] = array( 'actionthrottledtext' );
3345 }
3346
3347 # If there were errors, bail out now
3348 if ( !empty( $errors ) ) {
3349 return $errors;
3350 }
3351
3352 return $this->commitRollback( $fromP, $summary, $bot, $resultDetails );
3353 }
3354
3355 /**
3356 * Backend implementation of doRollback(), please refer there for parameter
3357 * and return value documentation
3358 *
3359 * NOTE: This function does NOT check ANY permissions, it just commits the
3360 * rollback to the DB Therefore, you should only call this function direct-
3361 * ly if you want to use custom permissions checks. If you don't, use
3362 * doRollback() instead.
3363 */
3364 public function commitRollback( $fromP, $summary, $bot, &$resultDetails ) {
3365 global $wgUseRCPatrol, $wgUser, $wgLang;
3366
3367 $dbw = wfGetDB( DB_MASTER );
3368
3369 if ( wfReadOnly() ) {
3370 return array( array( 'readonlytext' ) );
3371 }
3372
3373 # Get the last editor
3374 $current = Revision::newFromTitle( $this->mTitle );
3375 if ( is_null( $current ) ) {
3376 # Something wrong... no page?
3377 return array( array( 'notanarticle' ) );
3378 }
3379
3380 $from = str_replace( '_', ' ', $fromP );
3381 # User name given should match up with the top revision.
3382 # If the user was deleted then $from should be empty.
3383 if ( $from != $current->getUserText() ) {
3384 $resultDetails = array( 'current' => $current );
3385 return array( array( 'alreadyrolled',
3386 htmlspecialchars( $this->mTitle->getPrefixedText() ),
3387 htmlspecialchars( $fromP ),
3388 htmlspecialchars( $current->getUserText() )
3389 ) );
3390 }
3391
3392 # Get the last edit not by this guy...
3393 # Note: these may not be public values
3394 $user = intval( $current->getRawUser() );
3395 $user_text = $dbw->addQuotes( $current->getRawUserText() );
3396 $s = $dbw->selectRow( 'revision',
3397 array( 'rev_id', 'rev_timestamp', 'rev_deleted' ),
3398 array( 'rev_page' => $current->getPage(),
3399 "rev_user != {$user} OR rev_user_text != {$user_text}"
3400 ), __METHOD__,
3401 array( 'USE INDEX' => 'page_timestamp',
3402 'ORDER BY' => 'rev_timestamp DESC' )
3403 );
3404 if ( $s === false ) {
3405 # No one else ever edited this page
3406 return array( array( 'cantrollback' ) );
3407 } else if ( $s->rev_deleted & Revision::DELETED_TEXT || $s->rev_deleted & Revision::DELETED_USER ) {
3408 # Only admins can see this text
3409 return array( array( 'notvisiblerev' ) );
3410 }
3411
3412 $set = array();
3413 if ( $bot && $wgUser->isAllowed( 'markbotedits' ) ) {
3414 # Mark all reverted edits as bot
3415 $set['rc_bot'] = 1;
3416 }
3417
3418 if ( $wgUseRCPatrol ) {
3419 # Mark all reverted edits as patrolled
3420 $set['rc_patrolled'] = 1;
3421 }
3422
3423 if ( count( $set ) ) {
3424 $dbw->update( 'recentchanges', $set,
3425 array( /* WHERE */
3426 'rc_cur_id' => $current->getPage(),
3427 'rc_user_text' => $current->getUserText(),
3428 "rc_timestamp > '{$s->rev_timestamp}'",
3429 ), __METHOD__
3430 );
3431 }
3432
3433 # Generate the edit summary if necessary
3434 $target = Revision::newFromId( $s->rev_id );
3435 if ( empty( $summary ) ) {
3436 if ( $from == '' ) { // no public user name
3437 $summary = wfMsgForContent( 'revertpage-nouser' );
3438 } else {
3439 $summary = wfMsgForContent( 'revertpage' );
3440 }
3441 }
3442
3443 # Allow the custom summary to use the same args as the default message
3444 $args = array(
3445 $target->getUserText(), $from, $s->rev_id,
3446 $wgLang->timeanddate( wfTimestamp( TS_MW, $s->rev_timestamp ), true ),
3447 $current->getId(), $wgLang->timeanddate( $current->getTimestamp() )
3448 );
3449 $summary = wfMsgReplaceArgs( $summary, $args );
3450
3451 # Save
3452 $flags = EDIT_UPDATE;
3453
3454 if ( $wgUser->isAllowed( 'minoredit' ) ) {
3455 $flags |= EDIT_MINOR;
3456 }
3457
3458 if ( $bot && ( $wgUser->isAllowed( 'markbotedits' ) || $wgUser->isAllowed( 'bot' ) ) ) {
3459 $flags |= EDIT_FORCE_BOT;
3460 }
3461
3462 # Actually store the edit
3463 $status = $this->doEdit( $target->getText(), $summary, $flags, $target->getId() );
3464 if ( !empty( $status->value['revision'] ) ) {
3465 $revId = $status->value['revision']->getId();
3466 } else {
3467 $revId = false;
3468 }
3469
3470 wfRunHooks( 'ArticleRollbackComplete', array( $this, $wgUser, $target, $current ) );
3471
3472 $resultDetails = array(
3473 'summary' => $summary,
3474 'current' => $current,
3475 'target' => $target,
3476 'newid' => $revId
3477 );
3478
3479 return array();
3480 }
3481
3482 /**
3483 * User interface for rollback operations
3484 */
3485 public function rollback() {
3486 global $wgUser, $wgOut, $wgRequest;
3487
3488 $details = null;
3489
3490 $result = $this->doRollback(
3491 $wgRequest->getVal( 'from' ),
3492 $wgRequest->getText( 'summary' ),
3493 $wgRequest->getVal( 'token' ),
3494 $wgRequest->getBool( 'bot' ),
3495 $details
3496 );
3497
3498 if ( in_array( array( 'actionthrottledtext' ), $result ) ) {
3499 $wgOut->rateLimited();
3500 return;
3501 }
3502
3503 if ( isset( $result[0][0] ) && ( $result[0][0] == 'alreadyrolled' || $result[0][0] == 'cantrollback' ) ) {
3504 $wgOut->setPageTitle( wfMsg( 'rollbackfailed' ) );
3505 $errArray = $result[0];
3506 $errMsg = array_shift( $errArray );
3507 $wgOut->addWikiMsgArray( $errMsg, $errArray );
3508
3509 if ( isset( $details['current'] ) ) {
3510 $current = $details['current'];
3511
3512 if ( $current->getComment() != '' ) {
3513 $wgOut->addWikiMsgArray( 'editcomment', array(
3514 $wgUser->getSkin()->formatComment( $current->getComment() ) ), array( 'replaceafter' ) );
3515 }
3516 }
3517
3518 return;
3519 }
3520
3521 # Display permissions errors before read-only message -- there's no
3522 # point in misleading the user into thinking the inability to rollback
3523 # is only temporary.
3524 if ( !empty( $result ) && $result !== array( array( 'readonlytext' ) ) ) {
3525 # array_diff is completely broken for arrays of arrays, sigh.
3526 # Remove any 'readonlytext' error manually.
3527 $out = array();
3528 foreach ( $result as $error ) {
3529 if ( $error != array( 'readonlytext' ) ) {
3530 $out [] = $error;
3531 }
3532 }
3533 $wgOut->showPermissionsErrorPage( $out );
3534
3535 return;
3536 }
3537
3538 if ( $result == array( array( 'readonlytext' ) ) ) {
3539 $wgOut->readOnlyPage();
3540
3541 return;
3542 }
3543
3544 $current = $details['current'];
3545 $target = $details['target'];
3546 $newId = $details['newid'];
3547 $wgOut->setPageTitle( wfMsg( 'actioncomplete' ) );
3548 $wgOut->setRobotPolicy( 'noindex,nofollow' );
3549
3550 if ( $current->getUserText() === '' ) {
3551 $old = wfMsg( 'rev-deleted-user' );
3552 } else {
3553 $old = $wgUser->getSkin()->userLink( $current->getUser(), $current->getUserText() )
3554 . $wgUser->getSkin()->userToolLinks( $current->getUser(), $current->getUserText() );
3555 }
3556
3557 $new = $wgUser->getSkin()->userLink( $target->getUser(), $target->getUserText() )
3558 . $wgUser->getSkin()->userToolLinks( $target->getUser(), $target->getUserText() );
3559 $wgOut->addHTML( wfMsgExt( 'rollback-success', array( 'parse', 'replaceafter' ), $old, $new ) );
3560 $wgOut->returnToMain( false, $this->mTitle );
3561
3562 if ( !$wgRequest->getBool( 'hidediff', false ) && !$wgUser->getBoolOption( 'norollbackdiff', false ) ) {
3563 $de = new DifferenceEngine( $this->mTitle, $current->getId(), $newId, false, true );
3564 $de->showDiff( '', '' );
3565 }
3566 }
3567
3568 /**
3569 * Do standard deferred updates after page view
3570 */
3571 public function viewUpdates() {
3572 global $wgDeferredUpdateList, $wgDisableCounters, $wgUser;
3573 if ( wfReadOnly() ) {
3574 return;
3575 }
3576
3577 # Don't update page view counters on views from bot users (bug 14044)
3578 if ( !$wgDisableCounters && !$wgUser->isAllowed( 'bot' ) && $this->getID() ) {
3579 $wgDeferredUpdateList[] = new ViewCountUpdate( $this->getID() );
3580 $wgDeferredUpdateList[] = new SiteStatsUpdate( 1, 0, 0 );
3581 }
3582
3583 # Update newtalk / watchlist notification status
3584 $wgUser->clearNotification( $this->mTitle );
3585 }
3586
3587 /**
3588 * Prepare text which is about to be saved.
3589 * Returns a stdclass with source, pst and output members
3590 */
3591 public function prepareTextForEdit( $text, $revid = null, User $user = null ) {
3592 if ( $this->mPreparedEdit && $this->mPreparedEdit->newText == $text && $this->mPreparedEdit->revid == $revid ) {
3593 // Already prepared
3594 return $this->mPreparedEdit;
3595 }
3596
3597 global $wgParser;
3598
3599 if( $user === null ) {
3600 global $wgUser;
3601 $user = $wgUser;
3602 }
3603 $popts = ParserOptions::newFromUser( $user );
3604 wfRunHooks( 'ArticlePrepareTextForEdit', array( $this, $popts ) );
3605
3606 $edit = (object)array();
3607 $edit->revid = $revid;
3608 $edit->newText = $text;
3609 $edit->pst = $this->preSaveTransform( $text, $user, $popts );
3610 $edit->popts = $this->getParserOptions( true );
3611 $edit->output = $wgParser->parse( $edit->pst, $this->mTitle, $edit->popts, true, true, $revid );
3612 $edit->oldText = $this->getRawText();
3613
3614 $this->mPreparedEdit = $edit;
3615
3616 return $edit;
3617 }
3618
3619 /**
3620 * Do standard deferred updates after page edit.
3621 * Update links tables, site stats, search index and message cache.
3622 * Purges pages that include this page if the text was changed here.
3623 * Every 100th edit, prune the recent changes table.
3624 *
3625 * @private
3626 * @param $text String: New text of the article
3627 * @param $summary String: Edit summary
3628 * @param $minoredit Boolean: Minor edit
3629 * @param $timestamp_of_pagechange String timestamp associated with the page change
3630 * @param $newid Integer: rev_id value of the new revision
3631 * @param $changed Boolean: Whether or not the content actually changed
3632 * @param $user User object: User doing the edit
3633 */
3634 public function editUpdates( $text, $summary, $minoredit, $timestamp_of_pagechange, $newid, $changed = true, User $user = null ) {
3635 global $wgDeferredUpdateList, $wgMessageCache, $wgUser, $wgEnableParserCache;
3636
3637 wfProfileIn( __METHOD__ );
3638
3639 # Parse the text
3640 # Be careful not to double-PST: $text is usually already PST-ed once
3641 if ( !$this->mPreparedEdit || $this->mPreparedEdit->output->getFlag( 'vary-revision' ) ) {
3642 wfDebug( __METHOD__ . ": No prepared edit or vary-revision is set...\n" );
3643 $editInfo = $this->prepareTextForEdit( $text, $newid, $user );
3644 } else {
3645 wfDebug( __METHOD__ . ": No vary-revision, using prepared edit...\n" );
3646 $editInfo = $this->mPreparedEdit;
3647 }
3648
3649 # Save it to the parser cache
3650 if ( $wgEnableParserCache ) {
3651 $parserCache = ParserCache::singleton();
3652 $parserCache->save( $editInfo->output, $this, $editInfo->popts );
3653 }
3654
3655 # Update the links tables
3656 $u = new LinksUpdate( $this->mTitle, $editInfo->output );
3657 $u->doUpdate();
3658
3659 wfRunHooks( 'ArticleEditUpdates', array( &$this, &$editInfo, $changed ) );
3660
3661 if ( wfRunHooks( 'ArticleEditUpdatesDeleteFromRecentchanges', array( &$this ) ) ) {
3662 if ( 0 == mt_rand( 0, 99 ) ) {
3663 // Flush old entries from the `recentchanges` table; we do this on
3664 // random requests so as to avoid an increase in writes for no good reason
3665 global $wgRCMaxAge;
3666
3667 $dbw = wfGetDB( DB_MASTER );
3668 $cutoff = $dbw->timestamp( time() - $wgRCMaxAge );
3669 $recentchanges = $dbw->tableName( 'recentchanges' );
3670 $sql = "DELETE FROM $recentchanges WHERE rc_timestamp < '{$cutoff}'";
3671
3672 $dbw->query( $sql );
3673 }
3674 }
3675
3676 $id = $this->getID();
3677 $title = $this->mTitle->getPrefixedDBkey();
3678 $shortTitle = $this->mTitle->getDBkey();
3679
3680 if ( 0 == $id ) {
3681 wfProfileOut( __METHOD__ );
3682 return;
3683 }
3684
3685 $u = new SiteStatsUpdate( 0, 1, $this->mGoodAdjustment, $this->mTotalAdjustment );
3686 array_push( $wgDeferredUpdateList, $u );
3687 $u = new SearchUpdate( $id, $title, $text );
3688 array_push( $wgDeferredUpdateList, $u );
3689
3690 # If this is another user's talk page, update newtalk
3691 # Don't do this if $changed = false otherwise some idiot can null-edit a
3692 # load of user talk pages and piss people off, nor if it's a minor edit
3693 # by a properly-flagged bot.
3694 if ( $this->mTitle->getNamespace() == NS_USER_TALK && $shortTitle != $wgUser->getTitleKey() && $changed
3695 && !( $minoredit && $wgUser->isAllowed( 'nominornewtalk' ) )
3696 ) {
3697 if ( wfRunHooks( 'ArticleEditUpdateNewTalk', array( &$this ) ) ) {
3698 $other = User::newFromName( $shortTitle, false );
3699 if ( !$other ) {
3700 wfDebug( __METHOD__ . ": invalid username\n" );
3701 } elseif ( User::isIP( $shortTitle ) ) {
3702 // An anonymous user
3703 $other->setNewtalk( true );
3704 } elseif ( $other->isLoggedIn() ) {
3705 $other->setNewtalk( true );
3706 } else {
3707 wfDebug( __METHOD__ . ": don't need to notify a nonexistent user\n" );
3708 }
3709 }
3710 }
3711
3712 if ( $this->mTitle->getNamespace() == NS_MEDIAWIKI ) {
3713 $wgMessageCache->replace( $shortTitle, $text );
3714 }
3715
3716 wfProfileOut( __METHOD__ );
3717 }
3718
3719 /**
3720 * Perform article updates on a special page creation.
3721 *
3722 * @param $rev Revision object
3723 *
3724 * @todo This is a shitty interface function. Kill it and replace the
3725 * other shitty functions like editUpdates and such so it's not needed
3726 * anymore.
3727 */
3728 public function createUpdates( $rev ) {
3729 $this->mGoodAdjustment = $this->isCountable( $rev->getText() );
3730 $this->mTotalAdjustment = 1;
3731 $this->editUpdates( $rev->getText(), $rev->getComment(),
3732 $rev->isMinor(), wfTimestamp(), $rev->getId(), true );
3733 }
3734
3735 /**
3736 * Generate the navigation links when browsing through an article revisions
3737 * It shows the information as:
3738 * Revision as of \<date\>; view current revision
3739 * \<- Previous version | Next Version -\>
3740 *
3741 * @param $oldid String: revision ID of this article revision
3742 */
3743 public function setOldSubtitle( $oldid = 0 ) {
3744 global $wgLang, $wgOut, $wgUser, $wgRequest;
3745
3746 if ( !wfRunHooks( 'DisplayOldSubtitle', array( &$this, &$oldid ) ) ) {
3747 return;
3748 }
3749
3750 $unhide = $wgRequest->getInt( 'unhide' ) == 1;
3751
3752 # Cascade unhide param in links for easy deletion browsing
3753 $extraParams = array();
3754 if ( $wgRequest->getVal( 'unhide' ) ) {
3755 $extraParams['unhide'] = 1;
3756 }
3757
3758 $revision = Revision::newFromId( $oldid );
3759
3760 $current = ( $oldid == $this->mLatest );
3761 $td = $wgLang->timeanddate( $this->mTimestamp, true );
3762 $tddate = $wgLang->date( $this->mTimestamp, true );
3763 $tdtime = $wgLang->time( $this->mTimestamp, true );
3764 $sk = $wgUser->getSkin();
3765 $lnk = $current
3766 ? wfMsgHtml( 'currentrevisionlink' )
3767 : $sk->link(
3768 $this->mTitle,
3769 wfMsgHtml( 'currentrevisionlink' ),
3770 array(),
3771 $extraParams,
3772 array( 'known', 'noclasses' )
3773 );
3774 $curdiff = $current
3775 ? wfMsgHtml( 'diff' )
3776 : $sk->link(
3777 $this->mTitle,
3778 wfMsgHtml( 'diff' ),
3779 array(),
3780 array(
3781 'diff' => 'cur',
3782 'oldid' => $oldid
3783 ) + $extraParams,
3784 array( 'known', 'noclasses' )
3785 );
3786 $prev = $this->mTitle->getPreviousRevisionID( $oldid ) ;
3787 $prevlink = $prev
3788 ? $sk->link(
3789 $this->mTitle,
3790 wfMsgHtml( 'previousrevision' ),
3791 array(),
3792 array(
3793 'direction' => 'prev',
3794 'oldid' => $oldid
3795 ) + $extraParams,
3796 array( 'known', 'noclasses' )
3797 )
3798 : wfMsgHtml( 'previousrevision' );
3799 $prevdiff = $prev
3800 ? $sk->link(
3801 $this->mTitle,
3802 wfMsgHtml( 'diff' ),
3803 array(),
3804 array(
3805 'diff' => 'prev',
3806 'oldid' => $oldid
3807 ) + $extraParams,
3808 array( 'known', 'noclasses' )
3809 )
3810 : wfMsgHtml( 'diff' );
3811 $nextlink = $current
3812 ? wfMsgHtml( 'nextrevision' )
3813 : $sk->link(
3814 $this->mTitle,
3815 wfMsgHtml( 'nextrevision' ),
3816 array(),
3817 array(
3818 'direction' => 'next',
3819 'oldid' => $oldid
3820 ) + $extraParams,
3821 array( 'known', 'noclasses' )
3822 );
3823 $nextdiff = $current
3824 ? wfMsgHtml( 'diff' )
3825 : $sk->link(
3826 $this->mTitle,
3827 wfMsgHtml( 'diff' ),
3828 array(),
3829 array(
3830 'diff' => 'next',
3831 'oldid' => $oldid
3832 ) + $extraParams,
3833 array( 'known', 'noclasses' )
3834 );
3835
3836 $cdel = '';
3837
3838 // User can delete revisions or view deleted revisions...
3839 $canHide = $wgUser->isAllowed( 'deleterevision' );
3840 if ( $canHide || ( $revision->getVisibility() && $wgUser->isAllowed( 'deletedhistory' ) ) ) {
3841 if ( !$revision->userCan( Revision::DELETED_RESTRICTED ) ) {
3842 $cdel = $sk->revDeleteLinkDisabled( $canHide ); // rev was hidden from Sysops
3843 } else {
3844 $query = array(
3845 'type' => 'revision',
3846 'target' => $this->mTitle->getPrefixedDbkey(),
3847 'ids' => $oldid
3848 );
3849 $cdel = $sk->revDeleteLink( $query, $revision->isDeleted( File::DELETED_RESTRICTED ), $canHide );
3850 }
3851 $cdel .= ' ';
3852 }
3853
3854 # Show user links if allowed to see them. If hidden, then show them only if requested...
3855 $userlinks = $sk->revUserTools( $revision, !$unhide );
3856
3857 $infomsg = $current && !wfMessage( 'revision-info-current' )->isDisabled()
3858 ? 'revision-info-current'
3859 : 'revision-info';
3860
3861 $r = "\n\t\t\t\t<div id=\"mw-{$infomsg}\">" .
3862 wfMsgExt(
3863 $infomsg,
3864 array( 'parseinline', 'replaceafter' ),
3865 $td,
3866 $userlinks,
3867 $revision->getID(),
3868 $tddate,
3869 $tdtime,
3870 $revision->getUser()
3871 ) .
3872 "</div>\n" .
3873 "\n\t\t\t\t<div id=\"mw-revision-nav\">" . $cdel . wfMsgExt( 'revision-nav', array( 'escapenoentities', 'parsemag', 'replaceafter' ),
3874 $prevdiff, $prevlink, $lnk, $curdiff, $nextlink, $nextdiff ) . "</div>\n\t\t\t";
3875
3876 $wgOut->setSubtitle( $r );
3877 }
3878
3879 /**
3880 * This function is called right before saving the wikitext,
3881 * so we can do things like signatures and links-in-context.
3882 *
3883 * @param $text String article contents
3884 * @param $user User object: user doing the edit, $wgUser will be used if
3885 * null is given
3886 * @param $popts ParserOptions object: parser options, default options for
3887 * the user loaded if null given
3888 * @return string article contents with altered wikitext markup (signatures
3889 * converted, {{subst:}}, templates, etc.)
3890 */
3891 public function preSaveTransform( $text, User $user = null, ParserOptions $popts = null ) {
3892 global $wgParser;
3893
3894 if ( $user === null ) {
3895 global $wgUser;
3896 $user = $wgUser;
3897 }
3898
3899 if ( $popts === null ) {
3900 $popts = ParserOptions::newFromUser( $user );
3901 }
3902
3903 return $wgParser->preSaveTransform( $text, $this->mTitle, $user, $popts );
3904 }
3905
3906 /* Caching functions */
3907
3908 /**
3909 * checkLastModified returns true if it has taken care of all
3910 * output to the client that is necessary for this request.
3911 * (that is, it has sent a cached version of the page)
3912 *
3913 * @return boolean true if cached version send, false otherwise
3914 */
3915 protected function tryFileCache() {
3916 static $called = false;
3917
3918 if ( $called ) {
3919 wfDebug( "Article::tryFileCache(): called twice!?\n" );
3920 return false;
3921 }
3922
3923 $called = true;
3924 if ( $this->isFileCacheable() ) {
3925 $cache = new HTMLFileCache( $this->mTitle );
3926 if ( $cache->isFileCacheGood( $this->mTouched ) ) {
3927 wfDebug( "Article::tryFileCache(): about to load file\n" );
3928 $cache->loadFromFileCache();
3929 return true;
3930 } else {
3931 wfDebug( "Article::tryFileCache(): starting buffer\n" );
3932 ob_start( array( &$cache, 'saveToFileCache' ) );
3933 }
3934 } else {
3935 wfDebug( "Article::tryFileCache(): not cacheable\n" );
3936 }
3937
3938 return false;
3939 }
3940
3941 /**
3942 * Check if the page can be cached
3943 * @return bool
3944 */
3945 public function isFileCacheable() {
3946 $cacheable = false;
3947
3948 if ( HTMLFileCache::useFileCache() ) {
3949 $cacheable = $this->getID() && !$this->mRedirectedFrom && !$this->mTitle->isRedirect();
3950 // Extension may have reason to disable file caching on some pages.
3951 if ( $cacheable ) {
3952 $cacheable = wfRunHooks( 'IsFileCacheable', array( &$this ) );
3953 }
3954 }
3955
3956 return $cacheable;
3957 }
3958
3959 /**
3960 * Loads page_touched and returns a value indicating if it should be used
3961 * @return boolean true if not a redirect
3962 */
3963 public function checkTouched() {
3964 if ( !$this->mDataLoaded ) {
3965 $this->loadPageData();
3966 }
3967
3968 return !$this->mIsRedirect;
3969 }
3970
3971 /**
3972 * Get the page_touched field
3973 * @return string containing GMT timestamp
3974 */
3975 public function getTouched() {
3976 if ( !$this->mDataLoaded ) {
3977 $this->loadPageData();
3978 }
3979
3980 return $this->mTouched;
3981 }
3982
3983 /**
3984 * Get the page_latest field
3985 * @return integer rev_id of current revision
3986 */
3987 public function getLatest() {
3988 if ( !$this->mDataLoaded ) {
3989 $this->loadPageData();
3990 }
3991
3992 return (int)$this->mLatest;
3993 }
3994
3995 /**
3996 * Edit an article without doing all that other stuff
3997 * The article must already exist; link tables etc
3998 * are not updated, caches are not flushed.
3999 *
4000 * @param $text String: text submitted
4001 * @param $comment String: comment submitted
4002 * @param $minor Boolean: whereas it's a minor modification
4003 */
4004 public function quickEdit( $text, $comment = '', $minor = 0 ) {
4005 wfProfileIn( __METHOD__ );
4006
4007 $dbw = wfGetDB( DB_MASTER );
4008 $revision = new Revision( array(
4009 'page' => $this->getId(),
4010 'text' => $text,
4011 'comment' => $comment,
4012 'minor_edit' => $minor ? 1 : 0,
4013 ) );
4014 $revision->insertOn( $dbw );
4015 $this->updateRevisionOn( $dbw, $revision );
4016
4017 global $wgUser;
4018 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $revision, false, $wgUser ) );
4019
4020 wfProfileOut( __METHOD__ );
4021 }
4022
4023 /**
4024 * The onArticle*() functions are supposed to be a kind of hooks
4025 * which should be called whenever any of the specified actions
4026 * are done.
4027 *
4028 * This is a good place to put code to clear caches, for instance.
4029 *
4030 * This is called on page move and undelete, as well as edit
4031 *
4032 * @param $title Title object
4033 */
4034 public static function onArticleCreate( $title ) {
4035 # Update existence markers on article/talk tabs...
4036 if ( $title->isTalkPage() ) {
4037 $other = $title->getSubjectPage();
4038 } else {
4039 $other = $title->getTalkPage();
4040 }
4041
4042 $other->invalidateCache();
4043 $other->purgeSquid();
4044
4045 $title->touchLinks();
4046 $title->purgeSquid();
4047 $title->deleteTitleProtection();
4048 }
4049
4050 /**
4051 * Clears caches when article is deleted
4052 */
4053 public static function onArticleDelete( $title ) {
4054 global $wgMessageCache;
4055
4056 # Update existence markers on article/talk tabs...
4057 if ( $title->isTalkPage() ) {
4058 $other = $title->getSubjectPage();
4059 } else {
4060 $other = $title->getTalkPage();
4061 }
4062
4063 $other->invalidateCache();
4064 $other->purgeSquid();
4065
4066 $title->touchLinks();
4067 $title->purgeSquid();
4068
4069 # File cache
4070 HTMLFileCache::clearFileCache( $title );
4071
4072 # Messages
4073 if ( $title->getNamespace() == NS_MEDIAWIKI ) {
4074 $wgMessageCache->replace( $title->getDBkey(), false );
4075 }
4076
4077 # Images
4078 if ( $title->getNamespace() == NS_FILE ) {
4079 $update = new HTMLCacheUpdate( $title, 'imagelinks' );
4080 $update->doUpdate();
4081 }
4082
4083 # User talk pages
4084 if ( $title->getNamespace() == NS_USER_TALK ) {
4085 $user = User::newFromName( $title->getText(), false );
4086 $user->setNewtalk( false );
4087 }
4088
4089 # Image redirects
4090 RepoGroup::singleton()->getLocalRepo()->invalidateImageRedirect( $title );
4091 }
4092
4093 /**
4094 * Purge caches on page update etc
4095 *
4096 * @param $title Title object
4097 * @todo: verify that $title is always a Title object (and never false or null), add Title hint to parameter $title
4098 */
4099 public static function onArticleEdit( $title ) {
4100 global $wgDeferredUpdateList;
4101
4102 // Invalidate caches of articles which include this page
4103 $wgDeferredUpdateList[] = new HTMLCacheUpdate( $title, 'templatelinks' );
4104
4105 // Invalidate the caches of all pages which redirect here
4106 $wgDeferredUpdateList[] = new HTMLCacheUpdate( $title, 'redirect' );
4107
4108 # Purge squid for this page only
4109 $title->purgeSquid();
4110
4111 # Clear file cache for this page only
4112 HTMLFileCache::clearFileCache( $title );
4113 }
4114
4115 /**#@-*/
4116
4117 /**
4118 * Overriden by ImagePage class, only present here to avoid a fatal error
4119 * Called for ?action=revert
4120 */
4121 public function revert() {
4122 global $wgOut;
4123 $wgOut->showErrorPage( 'nosuchaction', 'nosuchactiontext' );
4124 }
4125
4126 /**
4127 * Info about this page
4128 * Called for ?action=info when $wgAllowPageInfo is on.
4129 */
4130 public function info() {
4131 global $wgLang, $wgOut, $wgAllowPageInfo, $wgUser;
4132
4133 if ( !$wgAllowPageInfo ) {
4134 $wgOut->showErrorPage( 'nosuchaction', 'nosuchactiontext' );
4135 return;
4136 }
4137
4138 $page = $this->mTitle->getSubjectPage();
4139
4140 $wgOut->setPagetitle( $page->getPrefixedText() );
4141 $wgOut->setPageTitleActionText( wfMsg( 'info_short' ) );
4142 $wgOut->setSubtitle( wfMsgHtml( 'infosubtitle' ) );
4143
4144 if ( !$this->mTitle->exists() ) {
4145 $wgOut->addHTML( '<div class="noarticletext">' );
4146 if ( $this->mTitle->getNamespace() == NS_MEDIAWIKI ) {
4147 // This doesn't quite make sense; the user is asking for
4148 // information about the _page_, not the message... -- RC
4149 $wgOut->addHTML( htmlspecialchars( wfMsgWeirdKey( $this->mTitle->getText() ) ) );
4150 } else {
4151 $msg = $wgUser->isLoggedIn()
4152 ? 'noarticletext'
4153 : 'noarticletextanon';
4154 $wgOut->addHTML( wfMsgExt( $msg, 'parse' ) );
4155 }
4156
4157 $wgOut->addHTML( '</div>' );
4158 } else {
4159 $dbr = wfGetDB( DB_SLAVE );
4160 $wl_clause = array(
4161 'wl_title' => $page->getDBkey(),
4162 'wl_namespace' => $page->getNamespace() );
4163 $numwatchers = $dbr->selectField(
4164 'watchlist',
4165 'COUNT(*)',
4166 $wl_clause,
4167 __METHOD__,
4168 $this->getSelectOptions() );
4169
4170 $pageInfo = $this->pageCountInfo( $page );
4171 $talkInfo = $this->pageCountInfo( $page->getTalkPage() );
4172
4173
4174 //FIXME: unescaped messages
4175 $wgOut->addHTML( "<ul><li>" . wfMsg( "numwatchers", $wgLang->formatNum( $numwatchers ) ) . '</li>' );
4176 $wgOut->addHTML( "<li>" . wfMsg( 'numedits', $wgLang->formatNum( $pageInfo['edits'] ) ) . '</li>' );
4177
4178 if ( $talkInfo ) {
4179 $wgOut->addHTML( '<li>' . wfMsg( "numtalkedits", $wgLang->formatNum( $talkInfo['edits'] ) ) . '</li>' );
4180 }
4181
4182 $wgOut->addHTML( '<li>' . wfMsg( "numauthors", $wgLang->formatNum( $pageInfo['authors'] ) ) . '</li>' );
4183
4184 if ( $talkInfo ) {
4185 $wgOut->addHTML( '<li>' . wfMsg( 'numtalkauthors', $wgLang->formatNum( $talkInfo['authors'] ) ) . '</li>' );
4186 }
4187
4188 $wgOut->addHTML( '</ul>' );
4189 }
4190 }
4191
4192 /**
4193 * Return the total number of edits and number of unique editors
4194 * on a given page. If page does not exist, returns false.
4195 *
4196 * @param $title Title object
4197 * @return mixed array or boolean false
4198 */
4199 public function pageCountInfo( $title ) {
4200 $id = $title->getArticleId();
4201
4202 if ( $id == 0 ) {
4203 return false;
4204 }
4205
4206 $dbr = wfGetDB( DB_SLAVE );
4207 $rev_clause = array( 'rev_page' => $id );
4208 $edits = $dbr->selectField(
4209 'revision',
4210 'COUNT(rev_page)',
4211 $rev_clause,
4212 __METHOD__,
4213 $this->getSelectOptions()
4214 );
4215 $authors = $dbr->selectField(
4216 'revision',
4217 'COUNT(DISTINCT rev_user_text)',
4218 $rev_clause,
4219 __METHOD__,
4220 $this->getSelectOptions()
4221 );
4222
4223 return array( 'edits' => $edits, 'authors' => $authors );
4224 }
4225
4226 /**
4227 * Return a list of templates used by this article.
4228 * Uses the templatelinks table
4229 *
4230 * @return Array of Title objects
4231 */
4232 public function getUsedTemplates() {
4233 $result = array();
4234 $id = $this->mTitle->getArticleID();
4235
4236 if ( $id == 0 ) {
4237 return array();
4238 }
4239
4240 $dbr = wfGetDB( DB_SLAVE );
4241 $res = $dbr->select( array( 'templatelinks' ),
4242 array( 'tl_namespace', 'tl_title' ),
4243 array( 'tl_from' => $id ),
4244 __METHOD__ );
4245
4246 if ( $res !== false ) {
4247 foreach ( $res as $row ) {
4248 $result[] = Title::makeTitle( $row->tl_namespace, $row->tl_title );
4249 }
4250 }
4251
4252 return $result;
4253 }
4254
4255 /**
4256 * Returns a list of hidden categories this page is a member of.
4257 * Uses the page_props and categorylinks tables.
4258 *
4259 * @return Array of Title objects
4260 */
4261 public function getHiddenCategories() {
4262 $result = array();
4263 $id = $this->mTitle->getArticleID();
4264
4265 if ( $id == 0 ) {
4266 return array();
4267 }
4268
4269 $dbr = wfGetDB( DB_SLAVE );
4270 $res = $dbr->select( array( 'categorylinks', 'page_props', 'page' ),
4271 array( 'cl_to' ),
4272 array( 'cl_from' => $id, 'pp_page=page_id', 'pp_propname' => 'hiddencat',
4273 'page_namespace' => NS_CATEGORY, 'page_title=cl_to' ),
4274 __METHOD__ );
4275
4276 if ( $res !== false ) {
4277 foreach ( $res as $row ) {
4278 $result[] = Title::makeTitle( NS_CATEGORY, $row->cl_to );
4279 }
4280 }
4281
4282 return $result;
4283 }
4284
4285 /**
4286 * Return an applicable autosummary if one exists for the given edit.
4287 * @param $oldtext String: the previous text of the page.
4288 * @param $newtext String: The submitted text of the page.
4289 * @param $flags Int bitmask: a bitmask of flags submitted for the edit.
4290 * @return string An appropriate autosummary, or an empty string.
4291 */
4292 public static function getAutosummary( $oldtext, $newtext, $flags ) {
4293 global $wgContLang;
4294
4295 # Decide what kind of autosummary is needed.
4296
4297 # Redirect autosummaries
4298 $ot = Title::newFromRedirect( $oldtext );
4299 $rt = Title::newFromRedirect( $newtext );
4300
4301 if ( is_object( $rt ) && ( !is_object( $ot ) || !$rt->equals( $ot ) || $ot->getFragment() != $rt->getFragment() ) ) {
4302 return wfMsgForContent( 'autoredircomment', $rt->getFullText() );
4303 }
4304
4305 # New page autosummaries
4306 if ( $flags & EDIT_NEW && strlen( $newtext ) ) {
4307 # If they're making a new article, give its text, truncated, in the summary.
4308
4309 $truncatedtext = $wgContLang->truncate(
4310 str_replace( "\n", ' ', $newtext ),
4311 max( 0, 200 - strlen( wfMsgForContent( 'autosumm-new' ) ) ) );
4312
4313 return wfMsgForContent( 'autosumm-new', $truncatedtext );
4314 }
4315
4316 # Blanking autosummaries
4317 if ( $oldtext != '' && $newtext == '' ) {
4318 return wfMsgForContent( 'autosumm-blank' );
4319 } elseif ( strlen( $oldtext ) > 10 * strlen( $newtext ) && strlen( $newtext ) < 500 ) {
4320 # Removing more than 90% of the article
4321
4322 $truncatedtext = $wgContLang->truncate(
4323 $newtext,
4324 max( 0, 200 - strlen( wfMsgForContent( 'autosumm-replace' ) ) ) );
4325
4326 return wfMsgForContent( 'autosumm-replace', $truncatedtext );
4327 }
4328
4329 # If we reach this point, there's no applicable autosummary for our case, so our
4330 # autosummary is empty.
4331 return '';
4332 }
4333
4334 /**
4335 * Add the primary page-view wikitext to the output buffer
4336 * Saves the text into the parser cache if possible.
4337 * Updates templatelinks if it is out of date.
4338 *
4339 * @param $text String
4340 * @param $cache Boolean
4341 * @param $parserOptions mixed ParserOptions object, or boolean false
4342 */
4343 public function outputWikiText( $text, $cache = true, $parserOptions = false ) {
4344 global $wgOut;
4345
4346 $this->mParserOutput = $this->getOutputFromWikitext( $text, $cache, $parserOptions );
4347 $wgOut->addParserOutput( $this->mParserOutput );
4348 }
4349
4350 /**
4351 * This does all the heavy lifting for outputWikitext, except it returns the parser
4352 * output instead of sending it straight to $wgOut. Makes things nice and simple for,
4353 * say, embedding thread pages within a discussion system (LiquidThreads)
4354 *
4355 * @param $text string
4356 * @param $cache boolean
4357 * @param $parserOptions parsing options, defaults to false
4358 * @return string containing parsed output
4359 */
4360 public function getOutputFromWikitext( $text, $cache = true, $parserOptions = false ) {
4361 global $wgParser, $wgEnableParserCache, $wgUseFileCache;
4362
4363 if ( !$parserOptions ) {
4364 $parserOptions = $this->getParserOptions();
4365 }
4366
4367 $time = - wfTime();
4368 $this->mParserOutput = $wgParser->parse( $text, $this->mTitle,
4369 $parserOptions, true, true, $this->getRevIdFetched() );
4370 $time += wfTime();
4371
4372 # Timing hack
4373 if ( $time > 3 ) {
4374 wfDebugLog( 'slow-parse', sprintf( "%-5.2f %s", $time,
4375 $this->mTitle->getPrefixedDBkey() ) );
4376 }
4377
4378 if ( $wgEnableParserCache && $cache && $this->mParserOutput->isCacheable() ) {
4379 $parserCache = ParserCache::singleton();
4380 $parserCache->save( $this->mParserOutput, $this, $parserOptions );
4381 }
4382
4383 // Make sure file cache is not used on uncacheable content.
4384 // Output that has magic words in it can still use the parser cache
4385 // (if enabled), though it will generally expire sooner.
4386 if ( !$this->mParserOutput->isCacheable() || $this->mParserOutput->containsOldMagic() ) {
4387 $wgUseFileCache = false;
4388 }
4389
4390 $this->doCascadeProtectionUpdates( $this->mParserOutput );
4391
4392 return $this->mParserOutput;
4393 }
4394
4395 /**
4396 * Get parser options suitable for rendering the primary article wikitext
4397 * @param $canonical boolean Determines that the generated must not depend on user preferences (see bug 14404)
4398 * @return mixed ParserOptions object or boolean false
4399 */
4400 public function getParserOptions( $canonical = false ) {
4401 global $wgUser, $wgLanguageCode;
4402
4403 if ( !$this->mParserOptions || $canonical ) {
4404 $user = !$canonical ? $wgUser : new User;
4405 $parserOptions = new ParserOptions( $user );
4406 $parserOptions->setTidy( true );
4407 $parserOptions->enableLimitReport();
4408
4409 if ( $canonical ) {
4410 $parserOptions->setUserLang( $wgLanguageCode ); # Must be set explicitely
4411 return $parserOptions;
4412 }
4413 $this->mParserOptions = $parserOptions;
4414 }
4415
4416 // Clone to allow modifications of the return value without affecting
4417 // the cache
4418 return clone $this->mParserOptions;
4419 }
4420
4421 /**
4422 * Updates cascading protections
4423 *
4424 * @param $parserOutput mixed ParserOptions object, or boolean false
4425 **/
4426 protected function doCascadeProtectionUpdates( $parserOutput ) {
4427 if ( !$this->isCurrent() || wfReadOnly() || !$this->mTitle->areRestrictionsCascading() ) {
4428 return;
4429 }
4430
4431 // templatelinks table may have become out of sync,
4432 // especially if using variable-based transclusions.
4433 // For paranoia, check if things have changed and if
4434 // so apply updates to the database. This will ensure
4435 // that cascaded protections apply as soon as the changes
4436 // are visible.
4437
4438 # Get templates from templatelinks
4439 $id = $this->mTitle->getArticleID();
4440
4441 $tlTemplates = array();
4442
4443 $dbr = wfGetDB( DB_SLAVE );
4444 $res = $dbr->select( array( 'templatelinks' ),
4445 array( 'tl_namespace', 'tl_title' ),
4446 array( 'tl_from' => $id ),
4447 __METHOD__
4448 );
4449
4450 foreach ( $res as $row ) {
4451 $tlTemplates["{$row->tl_namespace}:{$row->tl_title}"] = true;
4452 }
4453
4454 # Get templates from parser output.
4455 $poTemplates = array();
4456 foreach ( $parserOutput->getTemplates() as $ns => $templates ) {
4457 foreach ( $templates as $dbk => $id ) {
4458 $poTemplates["$ns:$dbk"] = true;
4459 }
4460 }
4461
4462 # Get the diff
4463 $templates_diff = array_diff_key( $poTemplates, $tlTemplates );
4464
4465 if ( count( $templates_diff ) > 0 ) {
4466 # Whee, link updates time.
4467 $u = new LinksUpdate( $this->mTitle, $parserOutput, false );
4468 $u->doUpdate();
4469 }
4470 }
4471
4472 /**
4473 * Update all the appropriate counts in the category table, given that
4474 * we've added the categories $added and deleted the categories $deleted.
4475 *
4476 * @param $added array The names of categories that were added
4477 * @param $deleted array The names of categories that were deleted
4478 */
4479 public function updateCategoryCounts( $added, $deleted ) {
4480 $ns = $this->mTitle->getNamespace();
4481 $dbw = wfGetDB( DB_MASTER );
4482
4483 # First make sure the rows exist. If one of the "deleted" ones didn't
4484 # exist, we might legitimately not create it, but it's simpler to just
4485 # create it and then give it a negative value, since the value is bogus
4486 # anyway.
4487 #
4488 # Sometimes I wish we had INSERT ... ON DUPLICATE KEY UPDATE.
4489 $insertCats = array_merge( $added, $deleted );
4490 if ( !$insertCats ) {
4491 # Okay, nothing to do
4492 return;
4493 }
4494
4495 $insertRows = array();
4496
4497 foreach ( $insertCats as $cat ) {
4498 $insertRows[] = array(
4499 'cat_id' => $dbw->nextSequenceValue( 'category_cat_id_seq' ),
4500 'cat_title' => $cat
4501 );
4502 }
4503 $dbw->insert( 'category', $insertRows, __METHOD__, 'IGNORE' );
4504
4505 $addFields = array( 'cat_pages = cat_pages + 1' );
4506 $removeFields = array( 'cat_pages = cat_pages - 1' );
4507
4508 if ( $ns == NS_CATEGORY ) {
4509 $addFields[] = 'cat_subcats = cat_subcats + 1';
4510 $removeFields[] = 'cat_subcats = cat_subcats - 1';
4511 } elseif ( $ns == NS_FILE ) {
4512 $addFields[] = 'cat_files = cat_files + 1';
4513 $removeFields[] = 'cat_files = cat_files - 1';
4514 }
4515
4516 if ( $added ) {
4517 $dbw->update(
4518 'category',
4519 $addFields,
4520 array( 'cat_title' => $added ),
4521 __METHOD__
4522 );
4523 }
4524
4525 if ( $deleted ) {
4526 $dbw->update(
4527 'category',
4528 $removeFields,
4529 array( 'cat_title' => $deleted ),
4530 __METHOD__
4531 );
4532 }
4533 }
4534
4535 /**
4536 * Lightweight method to get the parser output for a page, checking the parser cache
4537 * and so on. Doesn't consider most of the stuff that Article::view is forced to
4538 * consider, so it's not appropriate to use there.
4539 *
4540 * @since 1.16 (r52326) for LiquidThreads
4541 *
4542 * @param $oldid mixed integer Revision ID or null
4543 * @return ParserOutput
4544 */
4545 public function getParserOutput( $oldid = null ) {
4546 global $wgEnableParserCache, $wgUser;
4547
4548 // Should the parser cache be used?
4549 $useParserCache = $wgEnableParserCache &&
4550 $wgUser->getStubThreshold() == 0 &&
4551 $this->exists() &&
4552 $oldid === null;
4553
4554 wfDebug( __METHOD__ . ': using parser cache: ' . ( $useParserCache ? 'yes' : 'no' ) . "\n" );
4555
4556 if ( $wgUser->getStubThreshold() ) {
4557 wfIncrStats( 'pcache_miss_stub' );
4558 }
4559
4560 $parserOutput = false;
4561 if ( $useParserCache ) {
4562 $parserOutput = ParserCache::singleton()->get( $this, $this->getParserOptions() );
4563 }
4564
4565 if ( $parserOutput === false ) {
4566 // Cache miss; parse and output it.
4567 $rev = Revision::newFromTitle( $this->getTitle(), $oldid );
4568
4569 return $this->getOutputFromWikitext( $rev->getText(), $useParserCache );
4570 } else {
4571 return $parserOutput;
4572 }
4573 }
4574
4575 }
4576
4577 class PoolWorkArticleView extends PoolCounterWork {
4578 private $mArticle;
4579
4580 function __construct( $article, $key, $useParserCache, $parserOptions ) {
4581 parent::__construct( 'ArticleView', $key );
4582 $this->mArticle = $article;
4583 $this->cacheable = $useParserCache;
4584 $this->parserOptions = $parserOptions;
4585 }
4586
4587 function doWork() {
4588 return $this->mArticle->doViewParse();
4589 }
4590
4591 function getCachedWork() {
4592 global $wgOut;
4593
4594 $parserCache = ParserCache::singleton();
4595 $this->mArticle->mParserOutput = $parserCache->get( $this->mArticle, $this->parserOptions );
4596
4597 if ( $this->mArticle->mParserOutput !== false ) {
4598 wfDebug( __METHOD__ . ": showing contents parsed by someone else\n" );
4599 $wgOut->addParserOutput( $this->mArticle->mParserOutput );
4600 # Ensure that UI elements requiring revision ID have
4601 # the correct version information.
4602 $wgOut->setRevisionId( $this->mArticle->getLatest() );
4603 return true;
4604 }
4605 return false;
4606 }
4607
4608 function fallback() {
4609 return $this->mArticle->tryDirtyCache();
4610 }
4611
4612 function error( $status ) {
4613 global $wgOut;
4614
4615 $wgOut->clearHTML(); // for release() errors
4616 $wgOut->enableClientCache( false );
4617 $wgOut->setRobotPolicy( 'noindex,nofollow' );
4618
4619 $errortext = $status->getWikiText( false, 'view-pool-error' );
4620 $wgOut->addWikiText( '<div class="errorbox">' . $errortext . '</div>' );
4621
4622 return false;
4623 }
4624 }