Spaces to tabs
[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 $msg = wfMsgNoTrans( 'talkpageheader' );
1274 if ( $msg !== '-' && !wfEmptyMsg( 'talkpageheader', $msg ) ) {
1275 $wgOut->wrapWikiMsg( "<div class=\"mw-talkpageheader\">\n$1\n</div>", array( 'talkpageheader' ) );
1276 }
1277 }
1278 }
1279
1280 /**
1281 * Show the footer section of an ordinary page view
1282 */
1283 public function showViewFooter() {
1284 global $wgOut, $wgUseTrackbacks;
1285
1286 # check if we're displaying a [[User talk:x.x.x.x]] anonymous talk page
1287 if ( $this->mTitle->getNamespace() == NS_USER_TALK && IP::isValid( $this->mTitle->getText() ) ) {
1288 $wgOut->addWikiMsg( 'anontalkpagetext' );
1289 }
1290
1291 # If we have been passed an &rcid= parameter, we want to give the user a
1292 # chance to mark this new article as patrolled.
1293 $this->showPatrolFooter();
1294
1295 # Trackbacks
1296 if ( $wgUseTrackbacks ) {
1297 $this->addTrackbacks();
1298 }
1299 }
1300
1301 /**
1302 * If patrol is possible, output a patrol UI box. This is called from the
1303 * footer section of ordinary page views. If patrol is not possible or not
1304 * desired, does nothing.
1305 */
1306 public function showPatrolFooter() {
1307 global $wgOut, $wgRequest, $wgUser;
1308
1309 $rcid = $wgRequest->getVal( 'rcid' );
1310
1311 if ( !$rcid || !$this->mTitle->quickUserCan( 'patrol' ) ) {
1312 return;
1313 }
1314
1315 $sk = $wgUser->getSkin();
1316 $token = $wgUser->editToken( $rcid );
1317 $wgOut->preventClickjacking();
1318
1319 $wgOut->addHTML(
1320 "<div class='patrollink'>" .
1321 wfMsgHtml(
1322 'markaspatrolledlink',
1323 $sk->link(
1324 $this->mTitle,
1325 wfMsgHtml( 'markaspatrolledtext' ),
1326 array(),
1327 array(
1328 'action' => 'markpatrolled',
1329 'rcid' => $rcid,
1330 'token' => $token,
1331 ),
1332 array( 'known', 'noclasses' )
1333 )
1334 ) .
1335 '</div>'
1336 );
1337 }
1338
1339 /**
1340 * Show the error text for a missing article. For articles in the MediaWiki
1341 * namespace, show the default message text. To be called from Article::view().
1342 */
1343 public function showMissingArticle() {
1344 global $wgOut, $wgRequest, $wgUser;
1345
1346 # Show info in user (talk) namespace. Does the user exist? Is he blocked?
1347 if ( $this->mTitle->getNamespace() == NS_USER || $this->mTitle->getNamespace() == NS_USER_TALK ) {
1348 $parts = explode( '/', $this->mTitle->getText() );
1349 $rootPart = $parts[0];
1350 $user = User::newFromName( $rootPart, false /* allow IP users*/ );
1351 $ip = User::isIP( $rootPart );
1352
1353 if ( !$user->isLoggedIn() && !$ip ) { # User does not exist
1354 $wgOut->wrapWikiMsg( "<div class=\"mw-userpage-userdoesnotexist error\">\n\$1\n</div>",
1355 array( 'userpage-userdoesnotexist-view', $rootPart ) );
1356 } else if ( $user->isBlocked() ) { # Show log extract if the user is currently blocked
1357 LogEventsList::showLogExtract(
1358 $wgOut,
1359 'block',
1360 $user->getUserPage()->getPrefixedText(),
1361 '',
1362 array(
1363 'lim' => 1,
1364 'showIfEmpty' => false,
1365 'msgKey' => array(
1366 'blocked-notice-logextract',
1367 $user->getName() # Support GENDER in notice
1368 )
1369 )
1370 );
1371 }
1372 }
1373
1374 wfRunHooks( 'ShowMissingArticle', array( $this ) );
1375
1376 # Show delete and move logs
1377 LogEventsList::showLogExtract( $wgOut, array( 'delete', 'move' ), $this->mTitle->getPrefixedText(), '',
1378 array( 'lim' => 10,
1379 'conds' => array( "log_action != 'revision'" ),
1380 'showIfEmpty' => false,
1381 'msgKey' => array( 'moveddeleted-notice' ) )
1382 );
1383
1384 # Show error message
1385 $oldid = $this->getOldID();
1386 if ( $oldid ) {
1387 $text = wfMsgNoTrans( 'missing-article',
1388 $this->mTitle->getPrefixedText(),
1389 wfMsgNoTrans( 'missingarticle-rev', $oldid ) );
1390 } elseif ( $this->mTitle->getNamespace() === NS_MEDIAWIKI ) {
1391 // Use the default message text
1392 $text = $this->getContent();
1393 } else {
1394 $createErrors = $this->mTitle->getUserPermissionsErrors( 'create', $wgUser );
1395 $editErrors = $this->mTitle->getUserPermissionsErrors( 'edit', $wgUser );
1396 $errors = array_merge( $createErrors, $editErrors );
1397
1398 if ( !count( $errors ) ) {
1399 $text = wfMsgNoTrans( 'noarticletext' );
1400 } else {
1401 $text = wfMsgNoTrans( 'noarticletext-nopermission' );
1402 }
1403 }
1404 $text = "<div class='noarticletext'>\n$text\n</div>";
1405
1406 if ( !$this->hasViewableContent() ) {
1407 // If there's no backing content, send a 404 Not Found
1408 // for better machine handling of broken links.
1409 $wgRequest->response()->header( "HTTP/1.x 404 Not Found" );
1410 }
1411
1412 $wgOut->addWikiText( $text );
1413 }
1414
1415 /**
1416 * If the revision requested for view is deleted, check permissions.
1417 * Send either an error message or a warning header to $wgOut.
1418 *
1419 * @return boolean true if the view is allowed, false if not.
1420 */
1421 public function showDeletedRevisionHeader() {
1422 global $wgOut, $wgRequest;
1423
1424 if ( !$this->mRevision->isDeleted( Revision::DELETED_TEXT ) ) {
1425 // Not deleted
1426 return true;
1427 }
1428
1429 // If the user is not allowed to see it...
1430 if ( !$this->mRevision->userCan( Revision::DELETED_TEXT ) ) {
1431 $wgOut->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
1432 'rev-deleted-text-permission' );
1433
1434 return false;
1435 // If the user needs to confirm that they want to see it...
1436 } else if ( $wgRequest->getInt( 'unhide' ) != 1 ) {
1437 # Give explanation and add a link to view the revision...
1438 $oldid = intval( $this->getOldID() );
1439 $link = $this->mTitle->getFullUrl( "oldid={$oldid}&unhide=1" );
1440 $msg = $this->mRevision->isDeleted( Revision::DELETED_RESTRICTED ) ?
1441 'rev-suppressed-text-unhide' : 'rev-deleted-text-unhide';
1442 $wgOut->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
1443 array( $msg, $link ) );
1444
1445 return false;
1446 // We are allowed to see...
1447 } else {
1448 $msg = $this->mRevision->isDeleted( Revision::DELETED_RESTRICTED ) ?
1449 'rev-suppressed-text-view' : 'rev-deleted-text-view';
1450 $wgOut->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1\n</div>\n", $msg );
1451
1452 return true;
1453 }
1454 }
1455
1456 /**
1457 * Should the parser cache be used?
1458 *
1459 * @return boolean
1460 */
1461 public function useParserCache( $oldid ) {
1462 global $wgUser, $wgEnableParserCache;
1463
1464 return $wgEnableParserCache
1465 && $wgUser->getStubThreshold() == 0
1466 && $this->exists()
1467 && empty( $oldid )
1468 && !$this->mTitle->isCssOrJsPage()
1469 && !$this->mTitle->isCssJsSubpage();
1470 }
1471
1472 /**
1473 * Execute the uncached parse for action=view
1474 */
1475 public function doViewParse() {
1476 global $wgOut;
1477
1478 $oldid = $this->getOldID();
1479 $parserOptions = $this->getParserOptions();
1480
1481 # Render printable version, use printable version cache
1482 $parserOptions->setIsPrintable( $wgOut->isPrintable() );
1483
1484 # Don't show section-edit links on old revisions... this way lies madness.
1485 if ( !$this->isCurrent() || $wgOut->isPrintable() || !$this->mTitle->quickUserCan( 'edit' ) ) {
1486 $parserOptions->setEditSection( false );
1487 }
1488
1489 $useParserCache = $this->useParserCache( $oldid );
1490 $this->outputWikiText( $this->getContent(), $useParserCache, $parserOptions );
1491
1492 return true;
1493 }
1494
1495 /**
1496 * Try to fetch an expired entry from the parser cache. If it is present,
1497 * output it and return true. If it is not present, output nothing and
1498 * return false. This is used as a callback function for
1499 * PoolCounter::executeProtected().
1500 *
1501 * @return boolean
1502 */
1503 public function tryDirtyCache() {
1504 global $wgOut;
1505 $parserCache = ParserCache::singleton();
1506 $options = $this->getParserOptions();
1507
1508 if ( $wgOut->isPrintable() ) {
1509 $options->setIsPrintable( true );
1510 $options->setEditSection( false );
1511 }
1512
1513 $output = $parserCache->getDirty( $this, $options );
1514
1515 if ( $output ) {
1516 wfDebug( __METHOD__ . ": sending dirty output\n" );
1517 wfDebugLog( 'dirty', "dirty output " . $parserCache->getKey( $this, $options ) . "\n" );
1518 $wgOut->setSquidMaxage( 0 );
1519 $this->mParserOutput = $output;
1520 $wgOut->addParserOutput( $output );
1521 $wgOut->addHTML( "<!-- parser cache is expired, sending anyway due to pool overload-->\n" );
1522
1523 return true;
1524 } else {
1525 wfDebugLog( 'dirty', "dirty missing\n" );
1526 wfDebug( __METHOD__ . ": no dirty cache\n" );
1527
1528 return false;
1529 }
1530 }
1531
1532 /**
1533 * View redirect
1534 *
1535 * @param $target Title|Array of destination(s) to redirect
1536 * @param $appendSubtitle Boolean [optional]
1537 * @param $forceKnown Boolean: should the image be shown as a bluelink regardless of existence?
1538 * @return string containing HMTL with redirect link
1539 */
1540 public function viewRedirect( $target, $appendSubtitle = true, $forceKnown = false ) {
1541 global $wgOut, $wgContLang, $wgStylePath, $wgUser;
1542
1543 if ( !is_array( $target ) ) {
1544 $target = array( $target );
1545 }
1546
1547 $imageDir = $wgContLang->getDir();
1548
1549 if ( $appendSubtitle ) {
1550 $wgOut->appendSubtitle( wfMsgHtml( 'redirectpagesub' ) );
1551 }
1552
1553 $sk = $wgUser->getSkin();
1554 // the loop prepends the arrow image before the link, so the first case needs to be outside
1555 $title = array_shift( $target );
1556
1557 if ( $forceKnown ) {
1558 $link = $sk->linkKnown( $title, htmlspecialchars( $title->getFullText() ) );
1559 } else {
1560 $link = $sk->link( $title, htmlspecialchars( $title->getFullText() ) );
1561 }
1562
1563 $nextRedirect = $wgStylePath . '/common/images/nextredirect' . $imageDir . '.png';
1564 $alt = $wgContLang->isRTL() ? '←' : '→';
1565 // Automatically append redirect=no to each link, since most of them are redirect pages themselves.
1566 // FIXME: where this happens?
1567 foreach ( $target as $rt ) {
1568 $link .= Html::element( 'img', array( 'src' => $nextRedirect, 'alt' => $alt ) );
1569 if ( $forceKnown ) {
1570 $link .= $sk->linkKnown( $rt, htmlspecialchars( $rt->getFullText() ) );
1571 } else {
1572 $link .= $sk->link( $rt, htmlspecialchars( $rt->getFullText() ) );
1573 }
1574 }
1575
1576 $imageUrl = $wgStylePath . '/common/images/redirect' . $imageDir . '.png';
1577 return '<div class="redirectMsg">' .
1578 Html::element( 'img', array( 'src' => $imageUrl, 'alt' => '#REDIRECT' ) ) .
1579 '<span class="redirectText">' . $link . '</span></div>';
1580 }
1581
1582 /**
1583 * Builds trackback links for article display if $wgUseTrackbacks is set to true
1584 */
1585 public function addTrackbacks() {
1586 global $wgOut, $wgUser;
1587
1588 $dbr = wfGetDB( DB_SLAVE );
1589 $tbs = $dbr->select( 'trackbacks',
1590 array( 'tb_id', 'tb_title', 'tb_url', 'tb_ex', 'tb_name' ),
1591 array( 'tb_page' => $this->getID() )
1592 );
1593
1594 if ( !$dbr->numRows( $tbs ) ) {
1595 return;
1596 }
1597
1598 $wgOut->preventClickjacking();
1599
1600 $tbtext = "";
1601 foreach ( $tbs as $o ) {
1602 $rmvtxt = "";
1603
1604 if ( $wgUser->isAllowed( 'trackback' ) ) {
1605 $delurl = $this->mTitle->getFullURL( "action=deletetrackback&tbid=" .
1606 $o->tb_id . "&token=" . urlencode( $wgUser->editToken() ) );
1607 $rmvtxt = wfMsg( 'trackbackremove', htmlspecialchars( $delurl ) );
1608 }
1609
1610 $tbtext .= "\n";
1611 $tbtext .= wfMsgNoTrans( strlen( $o->tb_ex ) ? 'trackbackexcerpt' : 'trackback',
1612 $o->tb_title,
1613 $o->tb_url,
1614 $o->tb_ex,
1615 $o->tb_name,
1616 $rmvtxt );
1617 }
1618
1619 $wgOut->wrapWikiMsg( "<div id='mw_trackbacks'>\n$1\n</div>\n", array( 'trackbackbox', $tbtext ) );
1620 }
1621
1622 /**
1623 * Removes trackback record for current article from trackbacks table
1624 */
1625 public function deletetrackback() {
1626 global $wgUser, $wgRequest, $wgOut;
1627
1628 if ( !$wgUser->matchEditToken( $wgRequest->getVal( 'token' ) ) ) {
1629 $wgOut->addWikiMsg( 'sessionfailure' );
1630
1631 return;
1632 }
1633
1634 $permission_errors = $this->mTitle->getUserPermissionsErrors( 'delete', $wgUser );
1635
1636 if ( count( $permission_errors ) ) {
1637 $wgOut->showPermissionsErrorPage( $permission_errors );
1638
1639 return;
1640 }
1641
1642 $db = wfGetDB( DB_MASTER );
1643 $db->delete( 'trackbacks', array( 'tb_id' => $wgRequest->getInt( 'tbid' ) ) );
1644
1645 $wgOut->addWikiMsg( 'trackbackdeleteok' );
1646 $this->mTitle->invalidateCache();
1647 }
1648
1649 /**
1650 * Handle action=render
1651 */
1652
1653 public function render() {
1654 global $wgOut;
1655
1656 $wgOut->setArticleBodyOnly( true );
1657 $this->view();
1658 }
1659
1660 /**
1661 * Handle action=purge
1662 */
1663 public function purge() {
1664 global $wgUser, $wgRequest, $wgOut;
1665
1666 if ( $wgUser->isAllowed( 'purge' ) || $wgRequest->wasPosted() ) {
1667 //FIXME: shouldn't this be in doPurge()?
1668 if ( wfRunHooks( 'ArticlePurge', array( &$this ) ) ) {
1669 $this->doPurge();
1670 $this->view();
1671 }
1672 } else {
1673 $formParams = array(
1674 'method' => 'post',
1675 'action' => $wgRequest->getRequestURL(),
1676 );
1677
1678 $wgOut->addWikiMsg( 'confirm-purge-top' );
1679
1680 $form = Html::openElement( 'form', $formParams );
1681 $form .= Xml::submitButton( wfMsg( 'confirm_purge_button' ) );
1682 $form .= Html::closeElement( 'form' );
1683
1684 $wgOut->addHTML( $form );
1685 $wgOut->addWikiMsg( 'confirm-purge-bottom' );
1686
1687 $wgOut->setPageTitle( $this->mTitle->getPrefixedText() );
1688 $wgOut->setRobotPolicy( 'noindex,nofollow' );
1689 }
1690 }
1691
1692 /**
1693 * Perform the actions of a page purging
1694 */
1695 public function doPurge() {
1696 global $wgUseSquid;
1697
1698 // Invalidate the cache
1699 $this->mTitle->invalidateCache();
1700 $this->clear();
1701
1702 if ( $wgUseSquid ) {
1703 // Commit the transaction before the purge is sent
1704 $dbw = wfGetDB( DB_MASTER );
1705 $dbw->commit();
1706
1707 // Send purge
1708 $update = SquidUpdate::newSimplePurge( $this->mTitle );
1709 $update->doUpdate();
1710 }
1711
1712 if ( $this->mTitle->getNamespace() == NS_MEDIAWIKI ) {
1713 global $wgMessageCache;
1714
1715 if ( $this->getID() == 0 ) {
1716 $text = false;
1717 } else {
1718 $text = $this->getRawText();
1719 }
1720
1721 $wgMessageCache->replace( $this->mTitle->getDBkey(), $text );
1722 }
1723 }
1724
1725 /**
1726 * Insert a new empty page record for this article.
1727 * This *must* be followed up by creating a revision
1728 * and running $this->updateRevisionOn( ... );
1729 * or else the record will be left in a funky state.
1730 * Best if all done inside a transaction.
1731 *
1732 * @param $dbw Database
1733 * @return int The newly created page_id key, or false if the title already existed
1734 * @private
1735 */
1736 public function insertOn( $dbw ) {
1737 wfProfileIn( __METHOD__ );
1738
1739 $page_id = $dbw->nextSequenceValue( 'page_page_id_seq' );
1740 $dbw->insert( 'page', array(
1741 'page_id' => $page_id,
1742 'page_namespace' => $this->mTitle->getNamespace(),
1743 'page_title' => $this->mTitle->getDBkey(),
1744 'page_counter' => 0,
1745 'page_restrictions' => '',
1746 'page_is_redirect' => 0, # Will set this shortly...
1747 'page_is_new' => 1,
1748 'page_random' => wfRandom(),
1749 'page_touched' => $dbw->timestamp(),
1750 'page_latest' => 0, # Fill this in shortly...
1751 'page_len' => 0, # Fill this in shortly...
1752 ), __METHOD__, 'IGNORE' );
1753
1754 $affected = $dbw->affectedRows();
1755
1756 if ( $affected ) {
1757 $newid = $dbw->insertId();
1758 $this->mTitle->resetArticleId( $newid );
1759 }
1760 wfProfileOut( __METHOD__ );
1761
1762 return $affected ? $newid : false;
1763 }
1764
1765 /**
1766 * Update the page record to point to a newly saved revision.
1767 *
1768 * @param $dbw DatabaseBase: object
1769 * @param $revision Revision: For ID number, and text used to set
1770 length and redirect status fields
1771 * @param $lastRevision Integer: if given, will not overwrite the page field
1772 * when different from the currently set value.
1773 * Giving 0 indicates the new page flag should be set
1774 * on.
1775 * @param $lastRevIsRedirect Boolean: if given, will optimize adding and
1776 * removing rows in redirect table.
1777 * @param $setNewFlag Boolean: Set to true if a page flag should be set
1778 * Needed when $lastRevision has to be set to sth. !=0
1779 * @return bool true on success, false on failure
1780 * @private
1781 */
1782 public function updateRevisionOn( &$dbw, $revision, $lastRevision = null, $lastRevIsRedirect = null, $setNewFlag = false ) {
1783 wfProfileIn( __METHOD__ );
1784
1785 $text = $revision->getText();
1786 $rt = Title::newFromRedirectRecurse( $text );
1787
1788 $conditions = array( 'page_id' => $this->getId() );
1789
1790 if ( !is_null( $lastRevision ) ) {
1791 # An extra check against threads stepping on each other
1792 $conditions['page_latest'] = $lastRevision;
1793 }
1794
1795 if ( !$setNewFlag ) {
1796 $setNewFlag = ( $lastRevision === 0 );
1797 }
1798
1799 $dbw->update( 'page',
1800 array( /* SET */
1801 'page_latest' => $revision->getId(),
1802 'page_touched' => $dbw->timestamp(),
1803 'page_is_new' => $setNewFlag,
1804 'page_is_redirect' => $rt !== null ? 1 : 0,
1805 'page_len' => strlen( $text ),
1806 ),
1807 $conditions,
1808 __METHOD__ );
1809
1810 $result = $dbw->affectedRows() != 0;
1811 if ( $result ) {
1812 $this->updateRedirectOn( $dbw, $rt, $lastRevIsRedirect );
1813 }
1814
1815 wfProfileOut( __METHOD__ );
1816 return $result;
1817 }
1818
1819 /**
1820 * Add row to the redirect table if this is a redirect, remove otherwise.
1821 *
1822 * @param $dbw Database
1823 * @param $redirectTitle Title object pointing to the redirect target,
1824 * or NULL if this is not a redirect
1825 * @param $lastRevIsRedirect If given, will optimize adding and
1826 * removing rows in redirect table.
1827 * @return bool true on success, false on failure
1828 * @private
1829 */
1830 public function updateRedirectOn( &$dbw, $redirectTitle, $lastRevIsRedirect = null ) {
1831 // Always update redirects (target link might have changed)
1832 // Update/Insert if we don't know if the last revision was a redirect or not
1833 // Delete if changing from redirect to non-redirect
1834 $isRedirect = !is_null( $redirectTitle );
1835
1836 if ( $isRedirect || is_null( $lastRevIsRedirect ) || $lastRevIsRedirect !== $isRedirect ) {
1837 wfProfileIn( __METHOD__ );
1838 if ( $isRedirect ) {
1839 $this->insertRedirectEntry( $redirectTitle );
1840 } else {
1841 // This is not a redirect, remove row from redirect table
1842 $where = array( 'rd_from' => $this->getId() );
1843 $dbw->delete( 'redirect', $where, __METHOD__ );
1844 }
1845
1846 if ( $this->getTitle()->getNamespace() == NS_FILE ) {
1847 RepoGroup::singleton()->getLocalRepo()->invalidateImageRedirect( $this->getTitle() );
1848 }
1849 wfProfileOut( __METHOD__ );
1850
1851 return ( $dbw->affectedRows() != 0 );
1852 }
1853
1854 return true;
1855 }
1856
1857 /**
1858 * If the given revision is newer than the currently set page_latest,
1859 * update the page record. Otherwise, do nothing.
1860 *
1861 * @param $dbw Database object
1862 * @param $revision Revision object
1863 * @return mixed
1864 */
1865 public function updateIfNewerOn( &$dbw, $revision ) {
1866 wfProfileIn( __METHOD__ );
1867
1868 $row = $dbw->selectRow(
1869 array( 'revision', 'page' ),
1870 array( 'rev_id', 'rev_timestamp', 'page_is_redirect' ),
1871 array(
1872 'page_id' => $this->getId(),
1873 'page_latest=rev_id' ),
1874 __METHOD__ );
1875
1876 if ( $row ) {
1877 if ( wfTimestamp( TS_MW, $row->rev_timestamp ) >= $revision->getTimestamp() ) {
1878 wfProfileOut( __METHOD__ );
1879 return false;
1880 }
1881 $prev = $row->rev_id;
1882 $lastRevIsRedirect = (bool)$row->page_is_redirect;
1883 } else {
1884 # No or missing previous revision; mark the page as new
1885 $prev = 0;
1886 $lastRevIsRedirect = null;
1887 }
1888
1889 $ret = $this->updateRevisionOn( $dbw, $revision, $prev, $lastRevIsRedirect );
1890
1891 wfProfileOut( __METHOD__ );
1892 return $ret;
1893 }
1894
1895 /**
1896 * @param $section empty/null/false or a section number (0, 1, 2, T1, T2...)
1897 * @param $text String: new text of the section
1898 * @param $summary String: new section's subject, only if $section is 'new'
1899 * @param $edittime String: revision timestamp or null to use the current revision
1900 * @return string Complete article text, or null if error
1901 */
1902 public function replaceSection( $section, $text, $summary = '', $edittime = null ) {
1903 wfProfileIn( __METHOD__ );
1904
1905 if ( strval( $section ) == '' ) {
1906 // Whole-page edit; let the whole text through
1907 } else {
1908 if ( is_null( $edittime ) ) {
1909 $rev = Revision::newFromTitle( $this->mTitle );
1910 } else {
1911 $dbw = wfGetDB( DB_MASTER );
1912 $rev = Revision::loadFromTimestamp( $dbw, $this->mTitle, $edittime );
1913 }
1914
1915 if ( !$rev ) {
1916 wfDebug( "Article::replaceSection asked for bogus section (page: " .
1917 $this->getId() . "; section: $section; edittime: $edittime)\n" );
1918 return null;
1919 }
1920
1921 $oldtext = $rev->getText();
1922
1923 if ( $section == 'new' ) {
1924 # Inserting a new section
1925 $subject = $summary ? wfMsgForContent( 'newsectionheaderdefaultlevel', $summary ) . "\n\n" : '';
1926 $text = strlen( trim( $oldtext ) ) > 0
1927 ? "{$oldtext}\n\n{$subject}{$text}"
1928 : "{$subject}{$text}";
1929 } else {
1930 # Replacing an existing section; roll out the big guns
1931 global $wgParser;
1932
1933 $text = $wgParser->replaceSection( $oldtext, $section, $text );
1934 }
1935 }
1936
1937 wfProfileOut( __METHOD__ );
1938 return $text;
1939 }
1940
1941 /**
1942 * This function is not deprecated until somebody fixes the core not to use
1943 * it. Nevertheless, use Article::doEdit() instead.
1944 * @deprecated @since 1.7
1945 */
1946 function insertNewArticle( $text, $summary, $isminor, $watchthis, $suppressRC = false, $comment = false, $bot = false ) {
1947 $flags = EDIT_NEW | EDIT_DEFER_UPDATES | EDIT_AUTOSUMMARY |
1948 ( $isminor ? EDIT_MINOR : 0 ) |
1949 ( $suppressRC ? EDIT_SUPPRESS_RC : 0 ) |
1950 ( $bot ? EDIT_FORCE_BOT : 0 );
1951
1952 # If this is a comment, add the summary as headline
1953 if ( $comment && $summary != "" ) {
1954 $text = wfMsgForContent( 'newsectionheaderdefaultlevel', $summary ) . "\n\n" . $text;
1955 }
1956 $this->doEdit( $text, $summary, $flags );
1957
1958 $dbw = wfGetDB( DB_MASTER );
1959 if ( $watchthis ) {
1960 if ( !$this->mTitle->userIsWatching() ) {
1961 $dbw->begin();
1962 $this->doWatch();
1963 $dbw->commit();
1964 }
1965 } else {
1966 if ( $this->mTitle->userIsWatching() ) {
1967 $dbw->begin();
1968 $this->doUnwatch();
1969 $dbw->commit();
1970 }
1971 }
1972 $this->doRedirect( $this->isRedirect( $text ) );
1973 }
1974
1975 /**
1976 * @deprecated @since 1.7 use Article::doEdit()
1977 */
1978 function updateArticle( $text, $summary, $minor, $watchthis, $forceBot = false, $sectionanchor = '' ) {
1979 $flags = EDIT_UPDATE | EDIT_DEFER_UPDATES | EDIT_AUTOSUMMARY |
1980 ( $minor ? EDIT_MINOR : 0 ) |
1981 ( $forceBot ? EDIT_FORCE_BOT : 0 );
1982
1983 $status = $this->doEdit( $text, $summary, $flags );
1984
1985 if ( !$status->isOK() ) {
1986 return false;
1987 }
1988
1989 $dbw = wfGetDB( DB_MASTER );
1990 if ( $watchthis ) {
1991 if ( !$this->mTitle->userIsWatching() ) {
1992 $dbw->begin();
1993 $this->doWatch();
1994 $dbw->commit();
1995 }
1996 } else {
1997 if ( $this->mTitle->userIsWatching() ) {
1998 $dbw->begin();
1999 $this->doUnwatch();
2000 $dbw->commit();
2001 }
2002 }
2003
2004 $extraQuery = ''; // Give extensions a chance to modify URL query on update
2005 wfRunHooks( 'ArticleUpdateBeforeRedirect', array( $this, &$sectionanchor, &$extraQuery ) );
2006
2007 $this->doRedirect( $this->isRedirect( $text ), $sectionanchor, $extraQuery );
2008 return true;
2009 }
2010
2011 /**
2012 * Check flags and add EDIT_NEW or EDIT_UPDATE to them as needed.
2013 * @param $flags Int
2014 * @return Int updated $flags
2015 */
2016 function checkFlags( $flags ) {
2017 if ( !( $flags & EDIT_NEW ) && !( $flags & EDIT_UPDATE ) ) {
2018 if ( $this->mTitle->getArticleID() ) {
2019 $flags |= EDIT_UPDATE;
2020 } else {
2021 $flags |= EDIT_NEW;
2022 }
2023 }
2024
2025 return $flags;
2026 }
2027
2028 /**
2029 * Article::doEdit()
2030 *
2031 * Change an existing article or create a new article. Updates RC and all necessary caches,
2032 * optionally via the deferred update array.
2033 *
2034 * $wgUser must be set before calling this function.
2035 *
2036 * @param $text String: new text
2037 * @param $summary String: edit summary
2038 * @param $flags Integer bitfield:
2039 * EDIT_NEW
2040 * Article is known or assumed to be non-existent, create a new one
2041 * EDIT_UPDATE
2042 * Article is known or assumed to be pre-existing, update it
2043 * EDIT_MINOR
2044 * Mark this edit minor, if the user is allowed to do so
2045 * EDIT_SUPPRESS_RC
2046 * Do not log the change in recentchanges
2047 * EDIT_FORCE_BOT
2048 * Mark the edit a "bot" edit regardless of user rights
2049 * EDIT_DEFER_UPDATES
2050 * Defer some of the updates until the end of index.php
2051 * EDIT_AUTOSUMMARY
2052 * Fill in blank summaries with generated text where possible
2053 *
2054 * If neither EDIT_NEW nor EDIT_UPDATE is specified, the status of the article will be detected.
2055 * If EDIT_UPDATE is specified and the article doesn't exist, the function will an
2056 * edit-gone-missing error. If EDIT_NEW is specified and the article does exist, an
2057 * edit-already-exists error will be returned. These two conditions are also possible with
2058 * auto-detection due to MediaWiki's performance-optimised locking strategy.
2059 *
2060 * @param $baseRevId the revision ID this edit was based off, if any
2061 * @param $user User (optional), $wgUser will be used if not passed
2062 *
2063 * @return Status object. Possible errors:
2064 * edit-hook-aborted: The ArticleSave hook aborted the edit but didn't set the fatal flag of $status
2065 * edit-gone-missing: In update mode, but the article didn't exist
2066 * edit-conflict: In update mode, the article changed unexpectedly
2067 * edit-no-change: Warning that the text was the same as before
2068 * edit-already-exists: In creation mode, but the article already exists
2069 *
2070 * Extensions may define additional errors.
2071 *
2072 * $return->value will contain an associative array with members as follows:
2073 * new: Boolean indicating if the function attempted to create a new article
2074 * revision: The revision object for the inserted revision, or null
2075 *
2076 * Compatibility note: this function previously returned a boolean value indicating success/failure
2077 */
2078 public function doEdit( $text, $summary, $flags = 0, $baseRevId = false, $user = null ) {
2079 global $wgUser, $wgDBtransactions, $wgUseAutomaticEditSummaries;
2080
2081 # Low-level sanity check
2082 if ( $this->mTitle->getText() === '' ) {
2083 throw new MWException( 'Something is trying to edit an article with an empty title' );
2084 }
2085
2086 wfProfileIn( __METHOD__ );
2087
2088 $user = is_null( $user ) ? $wgUser : $user;
2089 $status = Status::newGood( array() );
2090
2091 # Load $this->mTitle->getArticleID() and $this->mLatest if it's not already
2092 $this->loadPageData();
2093
2094 $flags = $this->checkFlags( $flags );
2095
2096 if ( !wfRunHooks( 'ArticleSave', array( &$this, &$user, &$text, &$summary,
2097 $flags & EDIT_MINOR, null, null, &$flags, &$status ) ) )
2098 {
2099 wfDebug( __METHOD__ . ": ArticleSave hook aborted save!\n" );
2100 wfProfileOut( __METHOD__ );
2101
2102 if ( $status->isOK() ) {
2103 $status->fatal( 'edit-hook-aborted' );
2104 }
2105
2106 return $status;
2107 }
2108
2109 # Silently ignore EDIT_MINOR if not allowed
2110 $isminor = ( $flags & EDIT_MINOR ) && $user->isAllowed( 'minoredit' );
2111 $bot = $flags & EDIT_FORCE_BOT;
2112
2113 $oldtext = $this->getRawText(); // current revision
2114 $oldsize = strlen( $oldtext );
2115
2116 # Provide autosummaries if one is not provided and autosummaries are enabled.
2117 if ( $wgUseAutomaticEditSummaries && $flags & EDIT_AUTOSUMMARY && $summary == '' ) {
2118 $summary = $this->getAutosummary( $oldtext, $text, $flags );
2119 }
2120
2121 $editInfo = $this->prepareTextForEdit( $text, null, $user );
2122 $text = $editInfo->pst;
2123 $newsize = strlen( $text );
2124
2125 $dbw = wfGetDB( DB_MASTER );
2126 $now = wfTimestampNow();
2127 $this->mTimestamp = $now;
2128
2129 if ( $flags & EDIT_UPDATE ) {
2130 # Update article, but only if changed.
2131 $status->value['new'] = false;
2132
2133 # Make sure the revision is either completely inserted or not inserted at all
2134 if ( !$wgDBtransactions ) {
2135 $userAbort = ignore_user_abort( true );
2136 }
2137
2138 $changed = ( strcmp( $text, $oldtext ) != 0 );
2139
2140 if ( $changed ) {
2141 $this->mGoodAdjustment = (int)$this->isCountable( $text )
2142 - (int)$this->isCountable( $oldtext );
2143 $this->mTotalAdjustment = 0;
2144
2145 if ( !$this->mLatest ) {
2146 # Article gone missing
2147 wfDebug( __METHOD__ . ": EDIT_UPDATE specified but article doesn't exist\n" );
2148 $status->fatal( 'edit-gone-missing' );
2149
2150 wfProfileOut( __METHOD__ );
2151 return $status;
2152 }
2153
2154 $revision = new Revision( array(
2155 'page' => $this->getId(),
2156 'comment' => $summary,
2157 'minor_edit' => $isminor,
2158 'text' => $text,
2159 'parent_id' => $this->mLatest,
2160 'user' => $user->getId(),
2161 'user_text' => $user->getName(),
2162 'timestamp' => $now
2163 ) );
2164
2165 $dbw->begin();
2166 $revisionId = $revision->insertOn( $dbw );
2167
2168 # Update page
2169 #
2170 # Note that we use $this->mLatest instead of fetching a value from the master DB
2171 # during the course of this function. This makes sure that EditPage can detect
2172 # edit conflicts reliably, either by $ok here, or by $article->getTimestamp()
2173 # before this function is called. A previous function used a separate query, this
2174 # creates a window where concurrent edits can cause an ignored edit conflict.
2175 $ok = $this->updateRevisionOn( $dbw, $revision, $this->mLatest );
2176
2177 if ( !$ok ) {
2178 /* Belated edit conflict! Run away!! */
2179 $status->fatal( 'edit-conflict' );
2180
2181 # Delete the invalid revision if the DB is not transactional
2182 if ( !$wgDBtransactions ) {
2183 $dbw->delete( 'revision', array( 'rev_id' => $revisionId ), __METHOD__ );
2184 }
2185
2186 $revisionId = 0;
2187 $dbw->rollback();
2188 } else {
2189 global $wgUseRCPatrol;
2190 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $revision, $baseRevId, $user ) );
2191 # Update recentchanges
2192 if ( !( $flags & EDIT_SUPPRESS_RC ) ) {
2193 # Mark as patrolled if the user can do so
2194 $patrolled = $wgUseRCPatrol && !count(
2195 $this->mTitle->getUserPermissionsErrors( 'autopatrol', $user ) );
2196 # Add RC row to the DB
2197 $rc = RecentChange::notifyEdit( $now, $this->mTitle, $isminor, $user, $summary,
2198 $this->mLatest, $this->getTimestamp(), $bot, '', $oldsize, $newsize,
2199 $revisionId, $patrolled
2200 );
2201
2202 # Log auto-patrolled edits
2203 if ( $patrolled ) {
2204 PatrolLog::record( $rc, true );
2205 }
2206 }
2207 $user->incEditCount();
2208 $dbw->commit();
2209 }
2210 } else {
2211 $status->warning( 'edit-no-change' );
2212 $revision = null;
2213 // Keep the same revision ID, but do some updates on it
2214 $revisionId = $this->getLatest();
2215 // Update page_touched, this is usually implicit in the page update
2216 // Other cache updates are done in onArticleEdit()
2217 $this->mTitle->invalidateCache();
2218 }
2219
2220 if ( !$wgDBtransactions ) {
2221 ignore_user_abort( $userAbort );
2222 }
2223
2224 // Now that ignore_user_abort is restored, we can respond to fatal errors
2225 if ( !$status->isOK() ) {
2226 wfProfileOut( __METHOD__ );
2227 return $status;
2228 }
2229
2230 # Invalidate cache of this article and all pages using this article
2231 # as a template. Partly deferred.
2232 Article::onArticleEdit( $this->mTitle );
2233 # Update links tables, site stats, etc.
2234 $this->editUpdates( $text, $summary, $isminor, $now, $revisionId, $changed, $user );
2235 } else {
2236 # Create new article
2237 $status->value['new'] = true;
2238
2239 # Set statistics members
2240 # We work out if it's countable after PST to avoid counter drift
2241 # when articles are created with {{subst:}}
2242 $this->mGoodAdjustment = (int)$this->isCountable( $text );
2243 $this->mTotalAdjustment = 1;
2244
2245 $dbw->begin();
2246
2247 # Add the page record; stake our claim on this title!
2248 # This will return false if the article already exists
2249 $newid = $this->insertOn( $dbw );
2250
2251 if ( $newid === false ) {
2252 $dbw->rollback();
2253 $status->fatal( 'edit-already-exists' );
2254
2255 wfProfileOut( __METHOD__ );
2256 return $status;
2257 }
2258
2259 # Save the revision text...
2260 $revision = new Revision( array(
2261 'page' => $newid,
2262 'comment' => $summary,
2263 'minor_edit' => $isminor,
2264 'text' => $text,
2265 'user' => $user->getId(),
2266 'user_text' => $user->getName(),
2267 'timestamp' => $now
2268 ) );
2269 $revisionId = $revision->insertOn( $dbw );
2270
2271 $this->mTitle->resetArticleID( $newid );
2272
2273 # Update the page record with revision data
2274 $this->updateRevisionOn( $dbw, $revision, 0 );
2275
2276 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $revision, false, $user ) );
2277
2278 # Update recentchanges
2279 if ( !( $flags & EDIT_SUPPRESS_RC ) ) {
2280 global $wgUseRCPatrol, $wgUseNPPatrol;
2281
2282 # Mark as patrolled if the user can do so
2283 $patrolled = ( $wgUseRCPatrol || $wgUseNPPatrol ) && !count(
2284 $this->mTitle->getUserPermissionsErrors( 'autopatrol', $user ) );
2285 # Add RC row to the DB
2286 $rc = RecentChange::notifyNew( $now, $this->mTitle, $isminor, $user, $summary, $bot,
2287 '', strlen( $text ), $revisionId, $patrolled );
2288
2289 # Log auto-patrolled edits
2290 if ( $patrolled ) {
2291 PatrolLog::record( $rc, true );
2292 }
2293 }
2294 $user->incEditCount();
2295 $dbw->commit();
2296
2297 # Update links, etc.
2298 $this->editUpdates( $text, $summary, $isminor, $now, $revisionId, true, $user );
2299
2300 # Clear caches
2301 Article::onArticleCreate( $this->mTitle );
2302
2303 wfRunHooks( 'ArticleInsertComplete', array( &$this, &$user, $text, $summary,
2304 $flags & EDIT_MINOR, null, null, &$flags, $revision ) );
2305 }
2306
2307 # Do updates right now unless deferral was requested
2308 if ( !( $flags & EDIT_DEFER_UPDATES ) ) {
2309 wfDoUpdates();
2310 }
2311
2312 // Return the new revision (or null) to the caller
2313 $status->value['revision'] = $revision;
2314
2315 wfRunHooks( 'ArticleSaveComplete', array( &$this, &$user, $text, $summary,
2316 $flags & EDIT_MINOR, null, null, &$flags, $revision, &$status, $baseRevId ) );
2317
2318 wfProfileOut( __METHOD__ );
2319 return $status;
2320 }
2321
2322 /**
2323 * Output a redirect back to the article.
2324 * This is typically used after an edit.
2325 *
2326 * @param $noRedir Boolean: add redirect=no
2327 * @param $sectionAnchor String: section to redirect to, including "#"
2328 * @param $extraQuery String: extra query params
2329 */
2330 public function doRedirect( $noRedir = false, $sectionAnchor = '', $extraQuery = '' ) {
2331 global $wgOut;
2332
2333 if ( $noRedir ) {
2334 $query = 'redirect=no';
2335 if ( $extraQuery )
2336 $query .= "&$extraQuery";
2337 } else {
2338 $query = $extraQuery;
2339 }
2340
2341 $wgOut->redirect( $this->mTitle->getFullURL( $query ) . $sectionAnchor );
2342 }
2343
2344 /**
2345 * Mark this particular edit/page as patrolled
2346 */
2347 public function markpatrolled() {
2348 global $wgOut, $wgUser, $wgRequest;
2349
2350 $wgOut->setRobotPolicy( 'noindex,nofollow' );
2351
2352 # If we haven't been given an rc_id value, we can't do anything
2353 $rcid = (int) $wgRequest->getVal( 'rcid' );
2354
2355 if ( !$wgUser->matchEditToken( $wgRequest->getVal( 'token' ), $rcid ) ) {
2356 $wgOut->showErrorPage( 'sessionfailure-title', 'sessionfailure' );
2357 return;
2358 }
2359
2360 $rc = RecentChange::newFromId( $rcid );
2361
2362 if ( is_null( $rc ) ) {
2363 $wgOut->showErrorPage( 'markedaspatrollederror', 'markedaspatrollederrortext' );
2364 return;
2365 }
2366
2367 # It would be nice to see where the user had actually come from, but for now just guess
2368 $returnto = $rc->getAttribute( 'rc_type' ) == RC_NEW ? 'Newpages' : 'Recentchanges';
2369 $return = SpecialPage::getTitleFor( $returnto );
2370
2371 $errors = $rc->doMarkPatrolled();
2372
2373 if ( in_array( array( 'rcpatroldisabled' ), $errors ) ) {
2374 $wgOut->showErrorPage( 'rcpatroldisabled', 'rcpatroldisabledtext' );
2375
2376 return;
2377 }
2378
2379 if ( in_array( array( 'hookaborted' ), $errors ) ) {
2380 // The hook itself has handled any output
2381 return;
2382 }
2383
2384 if ( in_array( array( 'markedaspatrollederror-noautopatrol' ), $errors ) ) {
2385 $wgOut->setPageTitle( wfMsg( 'markedaspatrollederror' ) );
2386 $wgOut->addWikiMsg( 'markedaspatrollederror-noautopatrol' );
2387 $wgOut->returnToMain( false, $return );
2388
2389 return;
2390 }
2391
2392 if ( !empty( $errors ) ) {
2393 $wgOut->showPermissionsErrorPage( $errors );
2394
2395 return;
2396 }
2397
2398 # Inform the user
2399 $wgOut->setPageTitle( wfMsg( 'markedaspatrolled' ) );
2400 $wgOut->addWikiMsg( 'markedaspatrolledtext', $rc->getTitle()->getPrefixedText() );
2401 $wgOut->returnToMain( false, $return );
2402 }
2403
2404 /**
2405 * User-interface handler for the "watch" action
2406 */
2407 public function watch() {
2408 global $wgUser, $wgOut;
2409
2410 if ( $wgUser->isAnon() ) {
2411 $wgOut->showErrorPage( 'watchnologin', 'watchnologintext' );
2412 return;
2413 }
2414
2415 if ( wfReadOnly() ) {
2416 $wgOut->readOnlyPage();
2417 return;
2418 }
2419
2420 if ( $this->doWatch() ) {
2421 $wgOut->setPagetitle( wfMsg( 'addedwatch' ) );
2422 $wgOut->setRobotPolicy( 'noindex,nofollow' );
2423 $wgOut->addWikiMsg( 'addedwatchtext', $this->mTitle->getPrefixedText() );
2424 }
2425
2426 $wgOut->returnToMain( true, $this->mTitle->getPrefixedText() );
2427 }
2428
2429 /**
2430 * Add this page to $wgUser's watchlist
2431 * @return bool true on successful watch operation
2432 */
2433 public function doWatch() {
2434 global $wgUser;
2435
2436 if ( $wgUser->isAnon() ) {
2437 return false;
2438 }
2439
2440 if ( wfRunHooks( 'WatchArticle', array( &$wgUser, &$this ) ) ) {
2441 $wgUser->addWatch( $this->mTitle );
2442 return wfRunHooks( 'WatchArticleComplete', array( &$wgUser, &$this ) );
2443 }
2444
2445 return false;
2446 }
2447
2448 /**
2449 * User interface handler for the "unwatch" action.
2450 */
2451 public function unwatch() {
2452 global $wgUser, $wgOut;
2453
2454 if ( $wgUser->isAnon() ) {
2455 $wgOut->showErrorPage( 'watchnologin', 'watchnologintext' );
2456 return;
2457 }
2458
2459 if ( wfReadOnly() ) {
2460 $wgOut->readOnlyPage();
2461 return;
2462 }
2463
2464 if ( $this->doUnwatch() ) {
2465 $wgOut->setPagetitle( wfMsg( 'removedwatch' ) );
2466 $wgOut->setRobotPolicy( 'noindex,nofollow' );
2467 $wgOut->addWikiMsg( 'removedwatchtext', $this->mTitle->getPrefixedText() );
2468 }
2469
2470 $wgOut->returnToMain( true, $this->mTitle->getPrefixedText() );
2471 }
2472
2473 /**
2474 * Stop watching a page
2475 * @return bool true on successful unwatch
2476 */
2477 public function doUnwatch() {
2478 global $wgUser;
2479
2480 if ( $wgUser->isAnon() ) {
2481 return false;
2482 }
2483
2484 if ( wfRunHooks( 'UnwatchArticle', array( &$wgUser, &$this ) ) ) {
2485 $wgUser->removeWatch( $this->mTitle );
2486 return wfRunHooks( 'UnwatchArticleComplete', array( &$wgUser, &$this ) );
2487 }
2488
2489 return false;
2490 }
2491
2492 /**
2493 * action=protect handler
2494 */
2495 public function protect() {
2496 $form = new ProtectionForm( $this );
2497 $form->execute();
2498 }
2499
2500 /**
2501 * action=unprotect handler (alias)
2502 */
2503 public function unprotect() {
2504 $this->protect();
2505 }
2506
2507 /**
2508 * Update the article's restriction field, and leave a log entry.
2509 *
2510 * @param $limit Array: set of restriction keys
2511 * @param $reason String
2512 * @param &$cascade Integer. Set to false if cascading protection isn't allowed.
2513 * @param $expiry Array: per restriction type expiration
2514 * @return bool true on success
2515 */
2516 public function updateRestrictions( $limit = array(), $reason = '', &$cascade = 0, $expiry = array() ) {
2517 global $wgUser, $wgContLang;
2518
2519 $restrictionTypes = $this->mTitle->getRestrictionTypes();
2520
2521 $id = $this->mTitle->getArticleID();
2522
2523 if ( $id <= 0 ) {
2524 wfDebug( "updateRestrictions failed: article id $id <= 0\n" );
2525 return false;
2526 }
2527
2528 if ( wfReadOnly() ) {
2529 wfDebug( "updateRestrictions failed: read-only\n" );
2530 return false;
2531 }
2532
2533 if ( !$this->mTitle->userCan( 'protect' ) ) {
2534 wfDebug( "updateRestrictions failed: insufficient permissions\n" );
2535 return false;
2536 }
2537
2538 if ( !$cascade ) {
2539 $cascade = false;
2540 }
2541
2542 // Take this opportunity to purge out expired restrictions
2543 Title::purgeExpiredRestrictions();
2544
2545 # FIXME: Same limitations as described in ProtectionForm.php (line 37);
2546 # we expect a single selection, but the schema allows otherwise.
2547 $current = array();
2548 $updated = Article::flattenRestrictions( $limit );
2549 $changed = false;
2550
2551 foreach ( $restrictionTypes as $action ) {
2552 if ( isset( $expiry[$action] ) ) {
2553 # Get current restrictions on $action
2554 $aLimits = $this->mTitle->getRestrictions( $action );
2555 $current[$action] = implode( '', $aLimits );
2556 # Are any actual restrictions being dealt with here?
2557 $aRChanged = count( $aLimits ) || !empty( $limit[$action] );
2558
2559 # If something changed, we need to log it. Checking $aRChanged
2560 # assures that "unprotecting" a page that is not protected does
2561 # not log just because the expiry was "changed".
2562 if ( $aRChanged && $this->mTitle->mRestrictionsExpiry[$action] != $expiry[$action] ) {
2563 $changed = true;
2564 }
2565 }
2566 }
2567
2568 $current = Article::flattenRestrictions( $current );
2569
2570 $changed = ( $changed || $current != $updated );
2571 $changed = $changed || ( $updated && $this->mTitle->areRestrictionsCascading() != $cascade );
2572 $protect = ( $updated != '' );
2573
2574 # If nothing's changed, do nothing
2575 if ( $changed ) {
2576 if ( wfRunHooks( 'ArticleProtect', array( &$this, &$wgUser, $limit, $reason ) ) ) {
2577 $dbw = wfGetDB( DB_MASTER );
2578
2579 # Prepare a null revision to be added to the history
2580 $modified = $current != '' && $protect;
2581
2582 if ( $protect ) {
2583 $comment_type = $modified ? 'modifiedarticleprotection' : 'protectedarticle';
2584 } else {
2585 $comment_type = 'unprotectedarticle';
2586 }
2587
2588 $comment = $wgContLang->ucfirst( wfMsgForContent( $comment_type, $this->mTitle->getPrefixedText() ) );
2589
2590 # Only restrictions with the 'protect' right can cascade...
2591 # Otherwise, people who cannot normally protect can "protect" pages via transclusion
2592 $editrestriction = isset( $limit['edit'] ) ? array( $limit['edit'] ) : $this->mTitle->getRestrictions( 'edit' );
2593
2594 # The schema allows multiple restrictions
2595 if ( !in_array( 'protect', $editrestriction ) && !in_array( 'sysop', $editrestriction ) ) {
2596 $cascade = false;
2597 }
2598
2599 $cascade_description = '';
2600
2601 if ( $cascade ) {
2602 $cascade_description = ' [' . wfMsgForContent( 'protect-summary-cascade' ) . ']';
2603 }
2604
2605 if ( $reason ) {
2606 $comment .= ": $reason";
2607 }
2608
2609 $editComment = $comment;
2610 $encodedExpiry = array();
2611 $protect_description = '';
2612 foreach ( $limit as $action => $restrictions ) {
2613 if ( !isset( $expiry[$action] ) )
2614 $expiry[$action] = Block::infinity();
2615
2616 $encodedExpiry[$action] = Block::encodeExpiry( $expiry[$action], $dbw );
2617 if ( $restrictions != '' ) {
2618 $protect_description .= "[$action=$restrictions] (";
2619 if ( $encodedExpiry[$action] != 'infinity' ) {
2620 $protect_description .= wfMsgForContent( 'protect-expiring',
2621 $wgContLang->timeanddate( $expiry[$action], false, false ) ,
2622 $wgContLang->date( $expiry[$action], false, false ) ,
2623 $wgContLang->time( $expiry[$action], false, false ) );
2624 } else {
2625 $protect_description .= wfMsgForContent( 'protect-expiry-indefinite' );
2626 }
2627
2628 $protect_description .= ') ';
2629 }
2630 }
2631 $protect_description = trim( $protect_description );
2632
2633 if ( $protect_description && $protect ) {
2634 $editComment .= " ($protect_description)";
2635 }
2636
2637 if ( $cascade ) {
2638 $editComment .= "$cascade_description";
2639 }
2640
2641 # Update restrictions table
2642 foreach ( $limit as $action => $restrictions ) {
2643 if ( $restrictions != '' ) {
2644 $dbw->replace( 'page_restrictions', array( array( 'pr_page', 'pr_type' ) ),
2645 array( 'pr_page' => $id,
2646 'pr_type' => $action,
2647 'pr_level' => $restrictions,
2648 'pr_cascade' => ( $cascade && $action == 'edit' ) ? 1 : 0,
2649 'pr_expiry' => $encodedExpiry[$action]
2650 ),
2651 __METHOD__
2652 );
2653 } else {
2654 $dbw->delete( 'page_restrictions', array( 'pr_page' => $id,
2655 'pr_type' => $action ), __METHOD__ );
2656 }
2657 }
2658
2659 # Insert a null revision
2660 $nullRevision = Revision::newNullRevision( $dbw, $id, $editComment, true );
2661 $nullRevId = $nullRevision->insertOn( $dbw );
2662
2663 $latest = $this->getLatest();
2664 # Update page record
2665 $dbw->update( 'page',
2666 array( /* SET */
2667 'page_touched' => $dbw->timestamp(),
2668 'page_restrictions' => '',
2669 'page_latest' => $nullRevId
2670 ), array( /* WHERE */
2671 'page_id' => $id
2672 ), 'Article::protect'
2673 );
2674
2675 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $nullRevision, $latest, $wgUser ) );
2676 wfRunHooks( 'ArticleProtectComplete', array( &$this, &$wgUser, $limit, $reason ) );
2677
2678 # Update the protection log
2679 $log = new LogPage( 'protect' );
2680 if ( $protect ) {
2681 $params = array( $protect_description, $cascade ? 'cascade' : '' );
2682 $log->addEntry( $modified ? 'modify' : 'protect', $this->mTitle, trim( $reason ), $params );
2683 } else {
2684 $log->addEntry( 'unprotect', $this->mTitle, $reason );
2685 }
2686 } # End hook
2687 } # End "changed" check
2688
2689 return true;
2690 }
2691
2692 /**
2693 * Take an array of page restrictions and flatten it to a string
2694 * suitable for insertion into the page_restrictions field.
2695 * @param $limit Array
2696 * @return String
2697 */
2698 protected static function flattenRestrictions( $limit ) {
2699 if ( !is_array( $limit ) ) {
2700 throw new MWException( 'Article::flattenRestrictions given non-array restriction set' );
2701 }
2702
2703 $bits = array();
2704 ksort( $limit );
2705
2706 foreach ( $limit as $action => $restrictions ) {
2707 if ( $restrictions != '' ) {
2708 $bits[] = "$action=$restrictions";
2709 }
2710 }
2711
2712 return implode( ':', $bits );
2713 }
2714
2715 /**
2716 * Auto-generates a deletion reason
2717 *
2718 * @param &$hasHistory Boolean: whether the page has a history
2719 * @return mixed String containing deletion reason or empty string, or boolean false
2720 * if no revision occurred
2721 */
2722 public function generateReason( &$hasHistory ) {
2723 global $wgContLang;
2724
2725 $dbw = wfGetDB( DB_MASTER );
2726 // Get the last revision
2727 $rev = Revision::newFromTitle( $this->mTitle );
2728
2729 if ( is_null( $rev ) ) {
2730 return false;
2731 }
2732
2733 // Get the article's contents
2734 $contents = $rev->getText();
2735 $blank = false;
2736
2737 // If the page is blank, use the text from the previous revision,
2738 // which can only be blank if there's a move/import/protect dummy revision involved
2739 if ( $contents == '' ) {
2740 $prev = $rev->getPrevious();
2741
2742 if ( $prev ) {
2743 $contents = $prev->getText();
2744 $blank = true;
2745 }
2746 }
2747
2748 // Find out if there was only one contributor
2749 // Only scan the last 20 revisions
2750 $res = $dbw->select( 'revision', 'rev_user_text',
2751 array( 'rev_page' => $this->getID(), $dbw->bitAnd( 'rev_deleted', Revision::DELETED_USER ) . ' = 0' ),
2752 __METHOD__,
2753 array( 'LIMIT' => 20 )
2754 );
2755
2756 if ( $res === false ) {
2757 // This page has no revisions, which is very weird
2758 return false;
2759 }
2760
2761 $hasHistory = ( $res->numRows() > 1 );
2762 $row = $dbw->fetchObject( $res );
2763
2764 if ( $row ) { // $row is false if the only contributor is hidden
2765 $onlyAuthor = $row->rev_user_text;
2766 // Try to find a second contributor
2767 foreach ( $res as $row ) {
2768 if ( $row->rev_user_text != $onlyAuthor ) { // Bug 22999
2769 $onlyAuthor = false;
2770 break;
2771 }
2772 }
2773 } else {
2774 $onlyAuthor = false;
2775 }
2776
2777 // Generate the summary with a '$1' placeholder
2778 if ( $blank ) {
2779 // The current revision is blank and the one before is also
2780 // blank. It's just not our lucky day
2781 $reason = wfMsgForContent( 'exbeforeblank', '$1' );
2782 } else {
2783 if ( $onlyAuthor ) {
2784 $reason = wfMsgForContent( 'excontentauthor', '$1', $onlyAuthor );
2785 } else {
2786 $reason = wfMsgForContent( 'excontent', '$1' );
2787 }
2788 }
2789
2790 if ( $reason == '-' ) {
2791 // Allow these UI messages to be blanked out cleanly
2792 return '';
2793 }
2794
2795 // Replace newlines with spaces to prevent uglyness
2796 $contents = preg_replace( "/[\n\r]/", ' ', $contents );
2797 // Calculate the maximum amount of chars to get
2798 // Max content length = max comment length - length of the comment (excl. $1) - '...'
2799 $maxLength = 255 - ( strlen( $reason ) - 2 ) - 3;
2800 $contents = $wgContLang->truncate( $contents, $maxLength );
2801 // Remove possible unfinished links
2802 $contents = preg_replace( '/\[\[([^\]]*)\]?$/', '$1', $contents );
2803 // Now replace the '$1' placeholder
2804 $reason = str_replace( '$1', $contents, $reason );
2805
2806 return $reason;
2807 }
2808
2809
2810 /*
2811 * UI entry point for page deletion
2812 */
2813 public function delete() {
2814 global $wgUser, $wgOut, $wgRequest;
2815
2816 $confirm = $wgRequest->wasPosted() &&
2817 $wgUser->matchEditToken( $wgRequest->getVal( 'wpEditToken' ) );
2818
2819 $this->DeleteReasonList = $wgRequest->getText( 'wpDeleteReasonList', 'other' );
2820 $this->DeleteReason = $wgRequest->getText( 'wpReason' );
2821
2822 $reason = $this->DeleteReasonList;
2823
2824 if ( $reason != 'other' && $this->DeleteReason != '' ) {
2825 // Entry from drop down menu + additional comment
2826 $reason .= wfMsgForContent( 'colon-separator' ) . $this->DeleteReason;
2827 } elseif ( $reason == 'other' ) {
2828 $reason = $this->DeleteReason;
2829 }
2830
2831 # Flag to hide all contents of the archived revisions
2832 $suppress = $wgRequest->getVal( 'wpSuppress' ) && $wgUser->isAllowed( 'suppressrevision' );
2833
2834 # This code desperately needs to be totally rewritten
2835
2836 # Read-only check...
2837 if ( wfReadOnly() ) {
2838 $wgOut->readOnlyPage();
2839
2840 return;
2841 }
2842
2843 # Check permissions
2844 $permission_errors = $this->mTitle->getUserPermissionsErrors( 'delete', $wgUser );
2845
2846 if ( count( $permission_errors ) > 0 ) {
2847 $wgOut->showPermissionsErrorPage( $permission_errors );
2848
2849 return;
2850 }
2851
2852 $wgOut->setPagetitle( wfMsg( 'delete-confirm', $this->mTitle->getPrefixedText() ) );
2853
2854 # Better double-check that it hasn't been deleted yet!
2855 $dbw = wfGetDB( DB_MASTER );
2856 $conds = $this->mTitle->pageCond();
2857 $latest = $dbw->selectField( 'page', 'page_latest', $conds, __METHOD__ );
2858 if ( $latest === false ) {
2859 $wgOut->showFatalError(
2860 Html::rawElement(
2861 'div',
2862 array( 'class' => 'error mw-error-cannotdelete' ),
2863 wfMsgExt( 'cannotdelete', array( 'parse' ), $this->mTitle->getPrefixedText() )
2864 )
2865 );
2866 $wgOut->addHTML( Xml::element( 'h2', null, LogPage::logName( 'delete' ) ) );
2867 LogEventsList::showLogExtract(
2868 $wgOut,
2869 'delete',
2870 $this->mTitle->getPrefixedText()
2871 );
2872
2873 return;
2874 }
2875
2876 # Hack for big sites
2877 $bigHistory = $this->isBigDeletion();
2878 if ( $bigHistory && !$this->mTitle->userCan( 'bigdelete' ) ) {
2879 global $wgLang, $wgDeleteRevisionsLimit;
2880
2881 $wgOut->wrapWikiMsg( "<div class='error'>\n$1\n</div>\n",
2882 array( 'delete-toobig', $wgLang->formatNum( $wgDeleteRevisionsLimit ) ) );
2883
2884 return;
2885 }
2886
2887 if ( $confirm ) {
2888 $this->doDelete( $reason, $suppress );
2889
2890 if ( $wgRequest->getCheck( 'wpWatch' ) && $wgUser->isLoggedIn() ) {
2891 $this->doWatch();
2892 } elseif ( $this->mTitle->userIsWatching() ) {
2893 $this->doUnwatch();
2894 }
2895
2896 return;
2897 }
2898
2899 // Generate deletion reason
2900 $hasHistory = false;
2901 if ( !$reason ) {
2902 $reason = $this->generateReason( $hasHistory );
2903 }
2904
2905 // If the page has a history, insert a warning
2906 if ( $hasHistory && !$confirm ) {
2907 global $wgLang;
2908
2909 $skin = $wgUser->getSkin();
2910 $revisions = $this->estimateRevisionCount();
2911 //FIXME: lego
2912 $wgOut->addHTML( '<strong class="mw-delete-warning-revisions">' .
2913 wfMsgExt( 'historywarning', array( 'parseinline' ), $wgLang->formatNum( $revisions ) ) .
2914 wfMsgHtml( 'word-separator' ) . $skin->historyLink() .
2915 '</strong>'
2916 );
2917
2918 if ( $bigHistory ) {
2919 global $wgDeleteRevisionsLimit;
2920 $wgOut->wrapWikiMsg( "<div class='error'>\n$1\n</div>\n",
2921 array( 'delete-warning-toobig', $wgLang->formatNum( $wgDeleteRevisionsLimit ) ) );
2922 }
2923 }
2924
2925 return $this->confirmDelete( $reason );
2926 }
2927
2928 /**
2929 * @return bool whether or not the page surpasses $wgDeleteRevisionsLimit revisions
2930 */
2931 public function isBigDeletion() {
2932 global $wgDeleteRevisionsLimit;
2933
2934 if ( $wgDeleteRevisionsLimit ) {
2935 $revCount = $this->estimateRevisionCount();
2936
2937 return $revCount > $wgDeleteRevisionsLimit;
2938 }
2939
2940 return false;
2941 }
2942
2943 /**
2944 * @return int approximate revision count
2945 */
2946 public function estimateRevisionCount() {
2947 $dbr = wfGetDB( DB_SLAVE );
2948
2949 // For an exact count...
2950 // return $dbr->selectField( 'revision', 'COUNT(*)',
2951 // array( 'rev_page' => $this->getId() ), __METHOD__ );
2952 return $dbr->estimateRowCount( 'revision', '*',
2953 array( 'rev_page' => $this->getId() ), __METHOD__ );
2954 }
2955
2956 /**
2957 * Get the last N authors
2958 * @param $num Integer: number of revisions to get
2959 * @param $revLatest String: the latest rev_id, selected from the master (optional)
2960 * @return array Array of authors, duplicates not removed
2961 */
2962 public function getLastNAuthors( $num, $revLatest = 0 ) {
2963 wfProfileIn( __METHOD__ );
2964 // First try the slave
2965 // If that doesn't have the latest revision, try the master
2966 $continue = 2;
2967 $db = wfGetDB( DB_SLAVE );
2968
2969 do {
2970 $res = $db->select( array( 'page', 'revision' ),
2971 array( 'rev_id', 'rev_user_text' ),
2972 array(
2973 'page_namespace' => $this->mTitle->getNamespace(),
2974 'page_title' => $this->mTitle->getDBkey(),
2975 'rev_page = page_id'
2976 ), __METHOD__, $this->getSelectOptions( array(
2977 'ORDER BY' => 'rev_timestamp DESC',
2978 'LIMIT' => $num
2979 ) )
2980 );
2981
2982 if ( !$res ) {
2983 wfProfileOut( __METHOD__ );
2984 return array();
2985 }
2986
2987 $row = $db->fetchObject( $res );
2988
2989 if ( $continue == 2 && $revLatest && $row->rev_id != $revLatest ) {
2990 $db = wfGetDB( DB_MASTER );
2991 $continue--;
2992 } else {
2993 $continue = 0;
2994 }
2995 } while ( $continue );
2996
2997 $authors = array( $row->rev_user_text );
2998
2999 foreach ( $res as $row ) {
3000 $authors[] = $row->rev_user_text;
3001 }
3002
3003 wfProfileOut( __METHOD__ );
3004 return $authors;
3005 }
3006
3007 /**
3008 * Output deletion confirmation dialog
3009 * FIXME: Move to another file?
3010 * @param $reason String: prefilled reason
3011 */
3012 public function confirmDelete( $reason ) {
3013 global $wgOut, $wgUser;
3014
3015 wfDebug( "Article::confirmDelete\n" );
3016
3017 $deleteBackLink = $wgUser->getSkin()->linkKnown( $this->mTitle );
3018 $wgOut->setSubtitle( wfMsgHtml( 'delete-backlink', $deleteBackLink ) );
3019 $wgOut->setRobotPolicy( 'noindex,nofollow' );
3020 $wgOut->addWikiMsg( 'confirmdeletetext' );
3021
3022 wfRunHooks( 'ArticleConfirmDelete', array( $this, $wgOut, &$reason ) );
3023
3024 if ( $wgUser->isAllowed( 'suppressrevision' ) ) {
3025 $suppress = "<tr id=\"wpDeleteSuppressRow\">
3026 <td></td>
3027 <td class='mw-input'><strong>" .
3028 Xml::checkLabel( wfMsg( 'revdelete-suppress' ),
3029 'wpSuppress', 'wpSuppress', false, array( 'tabindex' => '4' ) ) .
3030 "</strong></td>
3031 </tr>";
3032 } else {
3033 $suppress = '';
3034 }
3035 $checkWatch = $wgUser->getBoolOption( 'watchdeletion' ) || $this->mTitle->userIsWatching();
3036
3037 $form = Xml::openElement( 'form', array( 'method' => 'post',
3038 'action' => $this->mTitle->getLocalURL( 'action=delete' ), 'id' => 'deleteconfirm' ) ) .
3039 Xml::openElement( 'fieldset', array( 'id' => 'mw-delete-table' ) ) .
3040 Xml::tags( 'legend', null, wfMsgExt( 'delete-legend', array( 'parsemag', 'escapenoentities' ) ) ) .
3041 Xml::openElement( 'table', array( 'id' => 'mw-deleteconfirm-table' ) ) .
3042 "<tr id=\"wpDeleteReasonListRow\">
3043 <td class='mw-label'>" .
3044 Xml::label( wfMsg( 'deletecomment' ), 'wpDeleteReasonList' ) .
3045 "</td>
3046 <td class='mw-input'>" .
3047 Xml::listDropDown( 'wpDeleteReasonList',
3048 wfMsgForContent( 'deletereason-dropdown' ),
3049 wfMsgForContent( 'deletereasonotherlist' ), '', 'wpReasonDropDown', 1 ) .
3050 "</td>
3051 </tr>
3052 <tr id=\"wpDeleteReasonRow\">
3053 <td class='mw-label'>" .
3054 Xml::label( wfMsg( 'deleteotherreason' ), 'wpReason' ) .
3055 "</td>
3056 <td class='mw-input'>" .
3057 Html::input( 'wpReason', $reason, 'text', array(
3058 'size' => '60',
3059 'maxlength' => '255',
3060 'tabindex' => '2',
3061 'id' => 'wpReason',
3062 'autofocus'
3063 ) ) .
3064 "</td>
3065 </tr>";
3066
3067 # Disallow watching if user is not logged in
3068 if ( $wgUser->isLoggedIn() ) {
3069 $form .= "
3070 <tr>
3071 <td></td>
3072 <td class='mw-input'>" .
3073 Xml::checkLabel( wfMsg( 'watchthis' ),
3074 'wpWatch', 'wpWatch', $checkWatch, array( 'tabindex' => '3' ) ) .
3075 "</td>
3076 </tr>";
3077 }
3078
3079 $form .= "
3080 $suppress
3081 <tr>
3082 <td></td>
3083 <td class='mw-submit'>" .
3084 Xml::submitButton( wfMsg( 'deletepage' ),
3085 array( 'name' => 'wpConfirmB', 'id' => 'wpConfirmB', 'tabindex' => '5' ) ) .
3086 "</td>
3087 </tr>" .
3088 Xml::closeElement( 'table' ) .
3089 Xml::closeElement( 'fieldset' ) .
3090 Html::hidden( 'wpEditToken', $wgUser->editToken() ) .
3091 Xml::closeElement( 'form' );
3092
3093 if ( $wgUser->isAllowed( 'editinterface' ) ) {
3094 $skin = $wgUser->getSkin();
3095 $title = Title::makeTitle( NS_MEDIAWIKI, 'Deletereason-dropdown' );
3096 $link = $skin->link(
3097 $title,
3098 wfMsgHtml( 'delete-edit-reasonlist' ),
3099 array(),
3100 array( 'action' => 'edit' )
3101 );
3102 $form .= '<p class="mw-delete-editreasons">' . $link . '</p>';
3103 }
3104
3105 $wgOut->addHTML( $form );
3106 $wgOut->addHTML( Xml::element( 'h2', null, LogPage::logName( 'delete' ) ) );
3107 LogEventsList::showLogExtract( $wgOut, 'delete',
3108 $this->mTitle->getPrefixedText()
3109 );
3110 }
3111
3112 /**
3113 * Perform a deletion and output success or failure messages
3114 */
3115 public function doDelete( $reason, $suppress = false ) {
3116 global $wgOut, $wgUser;
3117
3118 $id = $this->mTitle->getArticleID( Title::GAID_FOR_UPDATE );
3119
3120 $error = '';
3121 if ( wfRunHooks( 'ArticleDelete', array( &$this, &$wgUser, &$reason, &$error ) ) ) {
3122 if ( $this->doDeleteArticle( $reason, $suppress, $id ) ) {
3123 $deleted = $this->mTitle->getPrefixedText();
3124
3125 $wgOut->setPagetitle( wfMsg( 'actioncomplete' ) );
3126 $wgOut->setRobotPolicy( 'noindex,nofollow' );
3127
3128 $loglink = '[[Special:Log/delete|' . wfMsgNoTrans( 'deletionlog' ) . ']]';
3129
3130 $wgOut->addWikiMsg( 'deletedtext', $deleted, $loglink );
3131 $wgOut->returnToMain( false );
3132 wfRunHooks( 'ArticleDeleteComplete', array( &$this, &$wgUser, $reason, $id ) );
3133 }
3134 } else {
3135 if ( $error == '' ) {
3136 $wgOut->showFatalError(
3137 Html::rawElement(
3138 'div',
3139 array( 'class' => 'error mw-error-cannotdelete' ),
3140 wfMsgExt( 'cannotdelete', array( 'parse' ), $this->mTitle->getPrefixedText() )
3141 )
3142 );
3143
3144 $wgOut->addHTML( Xml::element( 'h2', null, LogPage::logName( 'delete' ) ) );
3145
3146 LogEventsList::showLogExtract(
3147 $wgOut,
3148 'delete',
3149 $this->mTitle->getPrefixedText()
3150 );
3151 } else {
3152 $wgOut->showFatalError( $error );
3153 }
3154 }
3155 }
3156
3157 /**
3158 * Back-end article deletion
3159 * Deletes the article with database consistency, writes logs, purges caches
3160 *
3161 * @param $reason string delete reason for deletion log
3162 * @param suppress bitfield
3163 * Revision::DELETED_TEXT
3164 * Revision::DELETED_COMMENT
3165 * Revision::DELETED_USER
3166 * Revision::DELETED_RESTRICTED
3167 * @param $id int article ID
3168 * @param $commit boolean defaults to true, triggers transaction end
3169 * @return boolean true if successful
3170 */
3171 public function doDeleteArticle( $reason, $suppress = false, $id = 0, $commit = true ) {
3172 global $wgDeferredUpdateList, $wgUseTrackbacks;
3173
3174 wfDebug( __METHOD__ . "\n" );
3175
3176 $dbw = wfGetDB( DB_MASTER );
3177 $t = $this->mTitle->getDBkey();
3178 $id = $id ? $id : $this->mTitle->getArticleID( Title::GAID_FOR_UPDATE );
3179
3180 if ( $t === '' || $id == 0 ) {
3181 return false;
3182 }
3183
3184 $u = new SiteStatsUpdate( 0, 1, - (int)$this->isCountable( $this->getRawText() ), -1 );
3185 array_push( $wgDeferredUpdateList, $u );
3186
3187 // Bitfields to further suppress the content
3188 if ( $suppress ) {
3189 $bitfield = 0;
3190 // This should be 15...
3191 $bitfield |= Revision::DELETED_TEXT;
3192 $bitfield |= Revision::DELETED_COMMENT;
3193 $bitfield |= Revision::DELETED_USER;
3194 $bitfield |= Revision::DELETED_RESTRICTED;
3195 } else {
3196 $bitfield = 'rev_deleted';
3197 }
3198
3199 $dbw->begin();
3200 // For now, shunt the revision data into the archive table.
3201 // Text is *not* removed from the text table; bulk storage
3202 // is left intact to avoid breaking block-compression or
3203 // immutable storage schemes.
3204 //
3205 // For backwards compatibility, note that some older archive
3206 // table entries will have ar_text and ar_flags fields still.
3207 //
3208 // In the future, we may keep revisions and mark them with
3209 // the rev_deleted field, which is reserved for this purpose.
3210 $dbw->insertSelect( 'archive', array( 'page', 'revision' ),
3211 array(
3212 'ar_namespace' => 'page_namespace',
3213 'ar_title' => 'page_title',
3214 'ar_comment' => 'rev_comment',
3215 'ar_user' => 'rev_user',
3216 'ar_user_text' => 'rev_user_text',
3217 'ar_timestamp' => 'rev_timestamp',
3218 'ar_minor_edit' => 'rev_minor_edit',
3219 'ar_rev_id' => 'rev_id',
3220 'ar_text_id' => 'rev_text_id',
3221 'ar_text' => '\'\'', // Be explicit to appease
3222 'ar_flags' => '\'\'', // MySQL's "strict mode"...
3223 'ar_len' => 'rev_len',
3224 'ar_page_id' => 'page_id',
3225 'ar_deleted' => $bitfield
3226 ), array(
3227 'page_id' => $id,
3228 'page_id = rev_page'
3229 ), __METHOD__
3230 );
3231
3232 # Delete restrictions for it
3233 $dbw->delete( 'page_restrictions', array ( 'pr_page' => $id ), __METHOD__ );
3234
3235 # Now that it's safely backed up, delete it
3236 $dbw->delete( 'page', array( 'page_id' => $id ), __METHOD__ );
3237 $ok = ( $dbw->affectedRows() > 0 ); // getArticleId() uses slave, could be laggy
3238
3239 if ( !$ok ) {
3240 $dbw->rollback();
3241 return false;
3242 }
3243
3244 # Fix category table counts
3245 $cats = array();
3246 $res = $dbw->select( 'categorylinks', 'cl_to', array( 'cl_from' => $id ), __METHOD__ );
3247
3248 foreach ( $res as $row ) {
3249 $cats [] = $row->cl_to;
3250 }
3251
3252 $this->updateCategoryCounts( array(), $cats );
3253
3254 # If using cascading deletes, we can skip some explicit deletes
3255 if ( !$dbw->cascadingDeletes() ) {
3256 $dbw->delete( 'revision', array( 'rev_page' => $id ), __METHOD__ );
3257
3258 if ( $wgUseTrackbacks )
3259 $dbw->delete( 'trackbacks', array( 'tb_page' => $id ), __METHOD__ );
3260
3261 # Delete outgoing links
3262 $dbw->delete( 'pagelinks', array( 'pl_from' => $id ) );
3263 $dbw->delete( 'imagelinks', array( 'il_from' => $id ) );
3264 $dbw->delete( 'categorylinks', array( 'cl_from' => $id ) );
3265 $dbw->delete( 'templatelinks', array( 'tl_from' => $id ) );
3266 $dbw->delete( 'externallinks', array( 'el_from' => $id ) );
3267 $dbw->delete( 'langlinks', array( 'll_from' => $id ) );
3268 $dbw->delete( 'redirect', array( 'rd_from' => $id ) );
3269 }
3270
3271 # If using cleanup triggers, we can skip some manual deletes
3272 if ( !$dbw->cleanupTriggers() ) {
3273 # Clean up recentchanges entries...
3274 $dbw->delete( 'recentchanges',
3275 array( 'rc_type != ' . RC_LOG,
3276 'rc_namespace' => $this->mTitle->getNamespace(),
3277 'rc_title' => $this->mTitle->getDBkey() ),
3278 __METHOD__ );
3279 $dbw->delete( 'recentchanges',
3280 array( 'rc_type != ' . RC_LOG, 'rc_cur_id' => $id ),
3281 __METHOD__ );
3282 }
3283
3284 # Clear caches
3285 Article::onArticleDelete( $this->mTitle );
3286
3287 # Clear the cached article id so the interface doesn't act like we exist
3288 $this->mTitle->resetArticleID( 0 );
3289
3290 # Log the deletion, if the page was suppressed, log it at Oversight instead
3291 $logtype = $suppress ? 'suppress' : 'delete';
3292 $log = new LogPage( $logtype );
3293
3294 # Make sure logging got through
3295 $log->addEntry( 'delete', $this->mTitle, $reason, array() );
3296
3297 if ( $commit ) {
3298 $dbw->commit();
3299 }
3300
3301 return true;
3302 }
3303
3304 /**
3305 * Roll back the most recent consecutive set of edits to a page
3306 * from the same user; fails if there are no eligible edits to
3307 * roll back to, e.g. user is the sole contributor. This function
3308 * performs permissions checks on $wgUser, then calls commitRollback()
3309 * to do the dirty work
3310 *
3311 * @param $fromP String: Name of the user whose edits to rollback.
3312 * @param $summary String: Custom summary. Set to default summary if empty.
3313 * @param $token String: Rollback token.
3314 * @param $bot Boolean: If true, mark all reverted edits as bot.
3315 *
3316 * @param $resultDetails Array: contains result-specific array of additional values
3317 * 'alreadyrolled' : 'current' (rev)
3318 * success : 'summary' (str), 'current' (rev), 'target' (rev)
3319 *
3320 * @return array of errors, each error formatted as
3321 * array(messagekey, param1, param2, ...).
3322 * On success, the array is empty. This array can also be passed to
3323 * OutputPage::showPermissionsErrorPage().
3324 */
3325 public function doRollback( $fromP, $summary, $token, $bot, &$resultDetails ) {
3326 global $wgUser;
3327
3328 $resultDetails = null;
3329
3330 # Check permissions
3331 $editErrors = $this->mTitle->getUserPermissionsErrors( 'edit', $wgUser );
3332 $rollbackErrors = $this->mTitle->getUserPermissionsErrors( 'rollback', $wgUser );
3333 $errors = array_merge( $editErrors, wfArrayDiff2( $rollbackErrors, $editErrors ) );
3334
3335 if ( !$wgUser->matchEditToken( $token, array( $this->mTitle->getPrefixedText(), $fromP ) ) ) {
3336 $errors[] = array( 'sessionfailure' );
3337 }
3338
3339 if ( $wgUser->pingLimiter( 'rollback' ) || $wgUser->pingLimiter() ) {
3340 $errors[] = array( 'actionthrottledtext' );
3341 }
3342
3343 # If there were errors, bail out now
3344 if ( !empty( $errors ) ) {
3345 return $errors;
3346 }
3347
3348 return $this->commitRollback( $fromP, $summary, $bot, $resultDetails );
3349 }
3350
3351 /**
3352 * Backend implementation of doRollback(), please refer there for parameter
3353 * and return value documentation
3354 *
3355 * NOTE: This function does NOT check ANY permissions, it just commits the
3356 * rollback to the DB Therefore, you should only call this function direct-
3357 * ly if you want to use custom permissions checks. If you don't, use
3358 * doRollback() instead.
3359 */
3360 public function commitRollback( $fromP, $summary, $bot, &$resultDetails ) {
3361 global $wgUseRCPatrol, $wgUser, $wgLang;
3362
3363 $dbw = wfGetDB( DB_MASTER );
3364
3365 if ( wfReadOnly() ) {
3366 return array( array( 'readonlytext' ) );
3367 }
3368
3369 # Get the last editor
3370 $current = Revision::newFromTitle( $this->mTitle );
3371 if ( is_null( $current ) ) {
3372 # Something wrong... no page?
3373 return array( array( 'notanarticle' ) );
3374 }
3375
3376 $from = str_replace( '_', ' ', $fromP );
3377 # User name given should match up with the top revision.
3378 # If the user was deleted then $from should be empty.
3379 if ( $from != $current->getUserText() ) {
3380 $resultDetails = array( 'current' => $current );
3381 return array( array( 'alreadyrolled',
3382 htmlspecialchars( $this->mTitle->getPrefixedText() ),
3383 htmlspecialchars( $fromP ),
3384 htmlspecialchars( $current->getUserText() )
3385 ) );
3386 }
3387
3388 # Get the last edit not by this guy...
3389 # Note: these may not be public values
3390 $user = intval( $current->getRawUser() );
3391 $user_text = $dbw->addQuotes( $current->getRawUserText() );
3392 $s = $dbw->selectRow( 'revision',
3393 array( 'rev_id', 'rev_timestamp', 'rev_deleted' ),
3394 array( 'rev_page' => $current->getPage(),
3395 "rev_user != {$user} OR rev_user_text != {$user_text}"
3396 ), __METHOD__,
3397 array( 'USE INDEX' => 'page_timestamp',
3398 'ORDER BY' => 'rev_timestamp DESC' )
3399 );
3400 if ( $s === false ) {
3401 # No one else ever edited this page
3402 return array( array( 'cantrollback' ) );
3403 } else if ( $s->rev_deleted & Revision::DELETED_TEXT || $s->rev_deleted & Revision::DELETED_USER ) {
3404 # Only admins can see this text
3405 return array( array( 'notvisiblerev' ) );
3406 }
3407
3408 $set = array();
3409 if ( $bot && $wgUser->isAllowed( 'markbotedits' ) ) {
3410 # Mark all reverted edits as bot
3411 $set['rc_bot'] = 1;
3412 }
3413
3414 if ( $wgUseRCPatrol ) {
3415 # Mark all reverted edits as patrolled
3416 $set['rc_patrolled'] = 1;
3417 }
3418
3419 if ( count( $set ) ) {
3420 $dbw->update( 'recentchanges', $set,
3421 array( /* WHERE */
3422 'rc_cur_id' => $current->getPage(),
3423 'rc_user_text' => $current->getUserText(),
3424 "rc_timestamp > '{$s->rev_timestamp}'",
3425 ), __METHOD__
3426 );
3427 }
3428
3429 # Generate the edit summary if necessary
3430 $target = Revision::newFromId( $s->rev_id );
3431 if ( empty( $summary ) ) {
3432 if ( $from == '' ) { // no public user name
3433 $summary = wfMsgForContent( 'revertpage-nouser' );
3434 } else {
3435 $summary = wfMsgForContent( 'revertpage' );
3436 }
3437 }
3438
3439 # Allow the custom summary to use the same args as the default message
3440 $args = array(
3441 $target->getUserText(), $from, $s->rev_id,
3442 $wgLang->timeanddate( wfTimestamp( TS_MW, $s->rev_timestamp ), true ),
3443 $current->getId(), $wgLang->timeanddate( $current->getTimestamp() )
3444 );
3445 $summary = wfMsgReplaceArgs( $summary, $args );
3446
3447 # Save
3448 $flags = EDIT_UPDATE;
3449
3450 if ( $wgUser->isAllowed( 'minoredit' ) ) {
3451 $flags |= EDIT_MINOR;
3452 }
3453
3454 if ( $bot && ( $wgUser->isAllowed( 'markbotedits' ) || $wgUser->isAllowed( 'bot' ) ) ) {
3455 $flags |= EDIT_FORCE_BOT;
3456 }
3457
3458 # Actually store the edit
3459 $status = $this->doEdit( $target->getText(), $summary, $flags, $target->getId() );
3460 if ( !empty( $status->value['revision'] ) ) {
3461 $revId = $status->value['revision']->getId();
3462 } else {
3463 $revId = false;
3464 }
3465
3466 wfRunHooks( 'ArticleRollbackComplete', array( $this, $wgUser, $target, $current ) );
3467
3468 $resultDetails = array(
3469 'summary' => $summary,
3470 'current' => $current,
3471 'target' => $target,
3472 'newid' => $revId
3473 );
3474
3475 return array();
3476 }
3477
3478 /**
3479 * User interface for rollback operations
3480 */
3481 public function rollback() {
3482 global $wgUser, $wgOut, $wgRequest;
3483
3484 $details = null;
3485
3486 $result = $this->doRollback(
3487 $wgRequest->getVal( 'from' ),
3488 $wgRequest->getText( 'summary' ),
3489 $wgRequest->getVal( 'token' ),
3490 $wgRequest->getBool( 'bot' ),
3491 $details
3492 );
3493
3494 if ( in_array( array( 'actionthrottledtext' ), $result ) ) {
3495 $wgOut->rateLimited();
3496 return;
3497 }
3498
3499 if ( isset( $result[0][0] ) && ( $result[0][0] == 'alreadyrolled' || $result[0][0] == 'cantrollback' ) ) {
3500 $wgOut->setPageTitle( wfMsg( 'rollbackfailed' ) );
3501 $errArray = $result[0];
3502 $errMsg = array_shift( $errArray );
3503 $wgOut->addWikiMsgArray( $errMsg, $errArray );
3504
3505 if ( isset( $details['current'] ) ) {
3506 $current = $details['current'];
3507
3508 if ( $current->getComment() != '' ) {
3509 $wgOut->addWikiMsgArray( 'editcomment', array(
3510 $wgUser->getSkin()->formatComment( $current->getComment() ) ), array( 'replaceafter' ) );
3511 }
3512 }
3513
3514 return;
3515 }
3516
3517 # Display permissions errors before read-only message -- there's no
3518 # point in misleading the user into thinking the inability to rollback
3519 # is only temporary.
3520 if ( !empty( $result ) && $result !== array( array( 'readonlytext' ) ) ) {
3521 # array_diff is completely broken for arrays of arrays, sigh.
3522 # Remove any 'readonlytext' error manually.
3523 $out = array();
3524 foreach ( $result as $error ) {
3525 if ( $error != array( 'readonlytext' ) ) {
3526 $out [] = $error;
3527 }
3528 }
3529 $wgOut->showPermissionsErrorPage( $out );
3530
3531 return;
3532 }
3533
3534 if ( $result == array( array( 'readonlytext' ) ) ) {
3535 $wgOut->readOnlyPage();
3536
3537 return;
3538 }
3539
3540 $current = $details['current'];
3541 $target = $details['target'];
3542 $newId = $details['newid'];
3543 $wgOut->setPageTitle( wfMsg( 'actioncomplete' ) );
3544 $wgOut->setRobotPolicy( 'noindex,nofollow' );
3545
3546 if ( $current->getUserText() === '' ) {
3547 $old = wfMsg( 'rev-deleted-user' );
3548 } else {
3549 $old = $wgUser->getSkin()->userLink( $current->getUser(), $current->getUserText() )
3550 . $wgUser->getSkin()->userToolLinks( $current->getUser(), $current->getUserText() );
3551 }
3552
3553 $new = $wgUser->getSkin()->userLink( $target->getUser(), $target->getUserText() )
3554 . $wgUser->getSkin()->userToolLinks( $target->getUser(), $target->getUserText() );
3555 $wgOut->addHTML( wfMsgExt( 'rollback-success', array( 'parse', 'replaceafter' ), $old, $new ) );
3556 $wgOut->returnToMain( false, $this->mTitle );
3557
3558 if ( !$wgRequest->getBool( 'hidediff', false ) && !$wgUser->getBoolOption( 'norollbackdiff', false ) ) {
3559 $de = new DifferenceEngine( $this->mTitle, $current->getId(), $newId, false, true );
3560 $de->showDiff( '', '' );
3561 }
3562 }
3563
3564 /**
3565 * Do standard deferred updates after page view
3566 */
3567 public function viewUpdates() {
3568 global $wgDeferredUpdateList, $wgDisableCounters, $wgUser;
3569 if ( wfReadOnly() ) {
3570 return;
3571 }
3572
3573 # Don't update page view counters on views from bot users (bug 14044)
3574 if ( !$wgDisableCounters && !$wgUser->isAllowed( 'bot' ) && $this->getID() ) {
3575 $wgDeferredUpdateList[] = new ViewCountUpdate( $this->getID() );
3576 $wgDeferredUpdateList[] = new SiteStatsUpdate( 1, 0, 0 );
3577 }
3578
3579 # Update newtalk / watchlist notification status
3580 $wgUser->clearNotification( $this->mTitle );
3581 }
3582
3583 /**
3584 * Prepare text which is about to be saved.
3585 * Returns a stdclass with source, pst and output members
3586 */
3587 public function prepareTextForEdit( $text, $revid = null, User $user = null ) {
3588 if ( $this->mPreparedEdit && $this->mPreparedEdit->newText == $text && $this->mPreparedEdit->revid == $revid ) {
3589 // Already prepared
3590 return $this->mPreparedEdit;
3591 }
3592
3593 global $wgParser;
3594
3595 $edit = (object)array();
3596 $edit->revid = $revid;
3597 $edit->newText = $text;
3598 $edit->pst = $this->preSaveTransform( $text, $user );
3599 $edit->popts = $this->getParserOptions( true );
3600 $edit->output = $wgParser->parse( $edit->pst, $this->mTitle, $edit->popts, true, true, $revid );
3601 $edit->oldText = $this->getRawText();
3602
3603 $this->mPreparedEdit = $edit;
3604
3605 return $edit;
3606 }
3607
3608 /**
3609 * Do standard deferred updates after page edit.
3610 * Update links tables, site stats, search index and message cache.
3611 * Purges pages that include this page if the text was changed here.
3612 * Every 100th edit, prune the recent changes table.
3613 *
3614 * @private
3615 * @param $text String: New text of the article
3616 * @param $summary String: Edit summary
3617 * @param $minoredit Boolean: Minor edit
3618 * @param $timestamp_of_pagechange String timestamp associated with the page change
3619 * @param $newid Integer: rev_id value of the new revision
3620 * @param $changed Boolean: Whether or not the content actually changed
3621 * @param $user User object: User doing the edit
3622 */
3623 public function editUpdates( $text, $summary, $minoredit, $timestamp_of_pagechange, $newid, $changed = true, User $user = null ) {
3624 global $wgDeferredUpdateList, $wgMessageCache, $wgUser, $wgEnableParserCache;
3625
3626 wfProfileIn( __METHOD__ );
3627
3628 # Parse the text
3629 # Be careful not to double-PST: $text is usually already PST-ed once
3630 if ( !$this->mPreparedEdit || $this->mPreparedEdit->output->getFlag( 'vary-revision' ) ) {
3631 wfDebug( __METHOD__ . ": No prepared edit or vary-revision is set...\n" );
3632 $editInfo = $this->prepareTextForEdit( $text, $newid, $user );
3633 } else {
3634 wfDebug( __METHOD__ . ": No vary-revision, using prepared edit...\n" );
3635 $editInfo = $this->mPreparedEdit;
3636 }
3637
3638 # Save it to the parser cache
3639 if ( $wgEnableParserCache ) {
3640 $parserCache = ParserCache::singleton();
3641 $parserCache->save( $editInfo->output, $this, $editInfo->popts );
3642 }
3643
3644 # Update the links tables
3645 $u = new LinksUpdate( $this->mTitle, $editInfo->output );
3646 $u->doUpdate();
3647
3648 wfRunHooks( 'ArticleEditUpdates', array( &$this, &$editInfo, $changed ) );
3649
3650 if ( wfRunHooks( 'ArticleEditUpdatesDeleteFromRecentchanges', array( &$this ) ) ) {
3651 if ( 0 == mt_rand( 0, 99 ) ) {
3652 // Flush old entries from the `recentchanges` table; we do this on
3653 // random requests so as to avoid an increase in writes for no good reason
3654 global $wgRCMaxAge;
3655
3656 $dbw = wfGetDB( DB_MASTER );
3657 $cutoff = $dbw->timestamp( time() - $wgRCMaxAge );
3658 $recentchanges = $dbw->tableName( 'recentchanges' );
3659 $sql = "DELETE FROM $recentchanges WHERE rc_timestamp < '{$cutoff}'";
3660
3661 $dbw->query( $sql );
3662 }
3663 }
3664
3665 $id = $this->getID();
3666 $title = $this->mTitle->getPrefixedDBkey();
3667 $shortTitle = $this->mTitle->getDBkey();
3668
3669 if ( 0 == $id ) {
3670 wfProfileOut( __METHOD__ );
3671 return;
3672 }
3673
3674 $u = new SiteStatsUpdate( 0, 1, $this->mGoodAdjustment, $this->mTotalAdjustment );
3675 array_push( $wgDeferredUpdateList, $u );
3676 $u = new SearchUpdate( $id, $title, $text );
3677 array_push( $wgDeferredUpdateList, $u );
3678
3679 # If this is another user's talk page, update newtalk
3680 # Don't do this if $changed = false otherwise some idiot can null-edit a
3681 # load of user talk pages and piss people off, nor if it's a minor edit
3682 # by a properly-flagged bot.
3683 if ( $this->mTitle->getNamespace() == NS_USER_TALK && $shortTitle != $wgUser->getTitleKey() && $changed
3684 && !( $minoredit && $wgUser->isAllowed( 'nominornewtalk' ) )
3685 ) {
3686 if ( wfRunHooks( 'ArticleEditUpdateNewTalk', array( &$this ) ) ) {
3687 $other = User::newFromName( $shortTitle, false );
3688 if ( !$other ) {
3689 wfDebug( __METHOD__ . ": invalid username\n" );
3690 } elseif ( User::isIP( $shortTitle ) ) {
3691 // An anonymous user
3692 $other->setNewtalk( true );
3693 } elseif ( $other->isLoggedIn() ) {
3694 $other->setNewtalk( true );
3695 } else {
3696 wfDebug( __METHOD__ . ": don't need to notify a nonexistent user\n" );
3697 }
3698 }
3699 }
3700
3701 if ( $this->mTitle->getNamespace() == NS_MEDIAWIKI ) {
3702 $wgMessageCache->replace( $shortTitle, $text );
3703 }
3704
3705 wfProfileOut( __METHOD__ );
3706 }
3707
3708 /**
3709 * Perform article updates on a special page creation.
3710 *
3711 * @param $rev Revision object
3712 *
3713 * @todo This is a shitty interface function. Kill it and replace the
3714 * other shitty functions like editUpdates and such so it's not needed
3715 * anymore.
3716 */
3717 public function createUpdates( $rev ) {
3718 $this->mGoodAdjustment = $this->isCountable( $rev->getText() );
3719 $this->mTotalAdjustment = 1;
3720 $this->editUpdates( $rev->getText(), $rev->getComment(),
3721 $rev->isMinor(), wfTimestamp(), $rev->getId(), true );
3722 }
3723
3724 /**
3725 * Generate the navigation links when browsing through an article revisions
3726 * It shows the information as:
3727 * Revision as of \<date\>; view current revision
3728 * \<- Previous version | Next Version -\>
3729 *
3730 * @param $oldid String: revision ID of this article revision
3731 */
3732 public function setOldSubtitle( $oldid = 0 ) {
3733 global $wgLang, $wgOut, $wgUser, $wgRequest;
3734
3735 if ( !wfRunHooks( 'DisplayOldSubtitle', array( &$this, &$oldid ) ) ) {
3736 return;
3737 }
3738
3739 $unhide = $wgRequest->getInt( 'unhide' ) == 1;
3740
3741 # Cascade unhide param in links for easy deletion browsing
3742 $extraParams = array();
3743 if ( $wgRequest->getVal( 'unhide' ) ) {
3744 $extraParams['unhide'] = 1;
3745 }
3746
3747 $revision = Revision::newFromId( $oldid );
3748
3749 $current = ( $oldid == $this->mLatest );
3750 $td = $wgLang->timeanddate( $this->mTimestamp, true );
3751 $tddate = $wgLang->date( $this->mTimestamp, true );
3752 $tdtime = $wgLang->time( $this->mTimestamp, true );
3753 $sk = $wgUser->getSkin();
3754 $lnk = $current
3755 ? wfMsgHtml( 'currentrevisionlink' )
3756 : $sk->link(
3757 $this->mTitle,
3758 wfMsgHtml( 'currentrevisionlink' ),
3759 array(),
3760 $extraParams,
3761 array( 'known', 'noclasses' )
3762 );
3763 $curdiff = $current
3764 ? wfMsgHtml( 'diff' )
3765 : $sk->link(
3766 $this->mTitle,
3767 wfMsgHtml( 'diff' ),
3768 array(),
3769 array(
3770 'diff' => 'cur',
3771 'oldid' => $oldid
3772 ) + $extraParams,
3773 array( 'known', 'noclasses' )
3774 );
3775 $prev = $this->mTitle->getPreviousRevisionID( $oldid ) ;
3776 $prevlink = $prev
3777 ? $sk->link(
3778 $this->mTitle,
3779 wfMsgHtml( 'previousrevision' ),
3780 array(),
3781 array(
3782 'direction' => 'prev',
3783 'oldid' => $oldid
3784 ) + $extraParams,
3785 array( 'known', 'noclasses' )
3786 )
3787 : wfMsgHtml( 'previousrevision' );
3788 $prevdiff = $prev
3789 ? $sk->link(
3790 $this->mTitle,
3791 wfMsgHtml( 'diff' ),
3792 array(),
3793 array(
3794 'diff' => 'prev',
3795 'oldid' => $oldid
3796 ) + $extraParams,
3797 array( 'known', 'noclasses' )
3798 )
3799 : wfMsgHtml( 'diff' );
3800 $nextlink = $current
3801 ? wfMsgHtml( 'nextrevision' )
3802 : $sk->link(
3803 $this->mTitle,
3804 wfMsgHtml( 'nextrevision' ),
3805 array(),
3806 array(
3807 'direction' => 'next',
3808 'oldid' => $oldid
3809 ) + $extraParams,
3810 array( 'known', 'noclasses' )
3811 );
3812 $nextdiff = $current
3813 ? wfMsgHtml( 'diff' )
3814 : $sk->link(
3815 $this->mTitle,
3816 wfMsgHtml( 'diff' ),
3817 array(),
3818 array(
3819 'diff' => 'next',
3820 'oldid' => $oldid
3821 ) + $extraParams,
3822 array( 'known', 'noclasses' )
3823 );
3824
3825 $cdel = '';
3826
3827 // User can delete revisions or view deleted revisions...
3828 $canHide = $wgUser->isAllowed( 'deleterevision' );
3829 if ( $canHide || ( $revision->getVisibility() && $wgUser->isAllowed( 'deletedhistory' ) ) ) {
3830 if ( !$revision->userCan( Revision::DELETED_RESTRICTED ) ) {
3831 $cdel = $sk->revDeleteLinkDisabled( $canHide ); // rev was hidden from Sysops
3832 } else {
3833 $query = array(
3834 'type' => 'revision',
3835 'target' => $this->mTitle->getPrefixedDbkey(),
3836 'ids' => $oldid
3837 );
3838 $cdel = $sk->revDeleteLink( $query, $revision->isDeleted( File::DELETED_RESTRICTED ), $canHide );
3839 }
3840 $cdel .= ' ';
3841 }
3842
3843 # Show user links if allowed to see them. If hidden, then show them only if requested...
3844 $userlinks = $sk->revUserTools( $revision, !$unhide );
3845
3846 $m = wfMsg( 'revision-info-current' );
3847 $infomsg = $current && !wfEmptyMsg( 'revision-info-current', $m ) && $m != '-'
3848 ? 'revision-info-current'
3849 : 'revision-info';
3850
3851 $r = "\n\t\t\t\t<div id=\"mw-{$infomsg}\">" .
3852 wfMsgExt(
3853 $infomsg,
3854 array( 'parseinline', 'replaceafter' ),
3855 $td,
3856 $userlinks,
3857 $revision->getID(),
3858 $tddate,
3859 $tdtime,
3860 $revision->getUser()
3861 ) .
3862 "</div>\n" .
3863 "\n\t\t\t\t<div id=\"mw-revision-nav\">" . $cdel . wfMsgExt( 'revision-nav', array( 'escapenoentities', 'parsemag', 'replaceafter' ),
3864 $prevdiff, $prevlink, $lnk, $curdiff, $nextlink, $nextdiff ) . "</div>\n\t\t\t";
3865
3866 $wgOut->setSubtitle( $r );
3867 }
3868
3869 /**
3870 * This function is called right before saving the wikitext,
3871 * so we can do things like signatures and links-in-context.
3872 *
3873 * @param $text String article contents
3874 * @param $user User object: user doing the edit, $wgUser will be used if
3875 * null is given
3876 * @return string article contents with altered wikitext markup (signatures
3877 * converted, {{subst:}}, templates, etc.)
3878 */
3879 public function preSaveTransform( $text, User $user = null ) {
3880 global $wgParser;
3881
3882 if ( $user === null ) {
3883 global $wgUser;
3884 $user = $wgUser;
3885 }
3886
3887 return $wgParser->preSaveTransform( $text, $this->mTitle, $user, ParserOptions::newFromUser( $user ) );
3888 }
3889
3890 /* Caching functions */
3891
3892 /**
3893 * checkLastModified returns true if it has taken care of all
3894 * output to the client that is necessary for this request.
3895 * (that is, it has sent a cached version of the page)
3896 *
3897 * @return boolean true if cached version send, false otherwise
3898 */
3899 protected function tryFileCache() {
3900 static $called = false;
3901
3902 if ( $called ) {
3903 wfDebug( "Article::tryFileCache(): called twice!?\n" );
3904 return false;
3905 }
3906
3907 $called = true;
3908 if ( $this->isFileCacheable() ) {
3909 $cache = new HTMLFileCache( $this->mTitle );
3910 if ( $cache->isFileCacheGood( $this->mTouched ) ) {
3911 wfDebug( "Article::tryFileCache(): about to load file\n" );
3912 $cache->loadFromFileCache();
3913 return true;
3914 } else {
3915 wfDebug( "Article::tryFileCache(): starting buffer\n" );
3916 ob_start( array( &$cache, 'saveToFileCache' ) );
3917 }
3918 } else {
3919 wfDebug( "Article::tryFileCache(): not cacheable\n" );
3920 }
3921
3922 return false;
3923 }
3924
3925 /**
3926 * Check if the page can be cached
3927 * @return bool
3928 */
3929 public function isFileCacheable() {
3930 $cacheable = false;
3931
3932 if ( HTMLFileCache::useFileCache() ) {
3933 $cacheable = $this->getID() && !$this->mRedirectedFrom && !$this->mTitle->isRedirect();
3934 // Extension may have reason to disable file caching on some pages.
3935 if ( $cacheable ) {
3936 $cacheable = wfRunHooks( 'IsFileCacheable', array( &$this ) );
3937 }
3938 }
3939
3940 return $cacheable;
3941 }
3942
3943 /**
3944 * Loads page_touched and returns a value indicating if it should be used
3945 * @return boolean true if not a redirect
3946 */
3947 public function checkTouched() {
3948 if ( !$this->mDataLoaded ) {
3949 $this->loadPageData();
3950 }
3951
3952 return !$this->mIsRedirect;
3953 }
3954
3955 /**
3956 * Get the page_touched field
3957 * @return string containing GMT timestamp
3958 */
3959 public function getTouched() {
3960 if ( !$this->mDataLoaded ) {
3961 $this->loadPageData();
3962 }
3963
3964 return $this->mTouched;
3965 }
3966
3967 /**
3968 * Get the page_latest field
3969 * @return integer rev_id of current revision
3970 */
3971 public function getLatest() {
3972 if ( !$this->mDataLoaded ) {
3973 $this->loadPageData();
3974 }
3975
3976 return (int)$this->mLatest;
3977 }
3978
3979 /**
3980 * Edit an article without doing all that other stuff
3981 * The article must already exist; link tables etc
3982 * are not updated, caches are not flushed.
3983 *
3984 * @param $text String: text submitted
3985 * @param $comment String: comment submitted
3986 * @param $minor Boolean: whereas it's a minor modification
3987 */
3988 public function quickEdit( $text, $comment = '', $minor = 0 ) {
3989 wfProfileIn( __METHOD__ );
3990
3991 $dbw = wfGetDB( DB_MASTER );
3992 $revision = new Revision( array(
3993 'page' => $this->getId(),
3994 'text' => $text,
3995 'comment' => $comment,
3996 'minor_edit' => $minor ? 1 : 0,
3997 ) );
3998 $revision->insertOn( $dbw );
3999 $this->updateRevisionOn( $dbw, $revision );
4000
4001 global $wgUser;
4002 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $revision, false, $wgUser ) );
4003
4004 wfProfileOut( __METHOD__ );
4005 }
4006
4007 /**
4008 * The onArticle*() functions are supposed to be a kind of hooks
4009 * which should be called whenever any of the specified actions
4010 * are done.
4011 *
4012 * This is a good place to put code to clear caches, for instance.
4013 *
4014 * This is called on page move and undelete, as well as edit
4015 *
4016 * @param $title Title object
4017 */
4018 public static function onArticleCreate( $title ) {
4019 # Update existence markers on article/talk tabs...
4020 if ( $title->isTalkPage() ) {
4021 $other = $title->getSubjectPage();
4022 } else {
4023 $other = $title->getTalkPage();
4024 }
4025
4026 $other->invalidateCache();
4027 $other->purgeSquid();
4028
4029 $title->touchLinks();
4030 $title->purgeSquid();
4031 $title->deleteTitleProtection();
4032 }
4033
4034 /**
4035 * Clears caches when article is deleted
4036 */
4037 public static function onArticleDelete( $title ) {
4038 global $wgMessageCache;
4039
4040 # Update existence markers on article/talk tabs...
4041 if ( $title->isTalkPage() ) {
4042 $other = $title->getSubjectPage();
4043 } else {
4044 $other = $title->getTalkPage();
4045 }
4046
4047 $other->invalidateCache();
4048 $other->purgeSquid();
4049
4050 $title->touchLinks();
4051 $title->purgeSquid();
4052
4053 # File cache
4054 HTMLFileCache::clearFileCache( $title );
4055
4056 # Messages
4057 if ( $title->getNamespace() == NS_MEDIAWIKI ) {
4058 $wgMessageCache->replace( $title->getDBkey(), false );
4059 }
4060
4061 # Images
4062 if ( $title->getNamespace() == NS_FILE ) {
4063 $update = new HTMLCacheUpdate( $title, 'imagelinks' );
4064 $update->doUpdate();
4065 }
4066
4067 # User talk pages
4068 if ( $title->getNamespace() == NS_USER_TALK ) {
4069 $user = User::newFromName( $title->getText(), false );
4070 $user->setNewtalk( false );
4071 }
4072
4073 # Image redirects
4074 RepoGroup::singleton()->getLocalRepo()->invalidateImageRedirect( $title );
4075 }
4076
4077 /**
4078 * Purge caches on page update etc
4079 *
4080 * @param $title Title object
4081 * @todo: verify that $title is always a Title object (and never false or null), add Title hint to parameter $title
4082 */
4083 public static function onArticleEdit( $title ) {
4084 global $wgDeferredUpdateList;
4085
4086 // Invalidate caches of articles which include this page
4087 $wgDeferredUpdateList[] = new HTMLCacheUpdate( $title, 'templatelinks' );
4088
4089 // Invalidate the caches of all pages which redirect here
4090 $wgDeferredUpdateList[] = new HTMLCacheUpdate( $title, 'redirect' );
4091
4092 # Purge squid for this page only
4093 $title->purgeSquid();
4094
4095 # Clear file cache for this page only
4096 HTMLFileCache::clearFileCache( $title );
4097 }
4098
4099 /**#@-*/
4100
4101 /**
4102 * Overriden by ImagePage class, only present here to avoid a fatal error
4103 * Called for ?action=revert
4104 */
4105 public function revert() {
4106 global $wgOut;
4107 $wgOut->showErrorPage( 'nosuchaction', 'nosuchactiontext' );
4108 }
4109
4110 /**
4111 * Info about this page
4112 * Called for ?action=info when $wgAllowPageInfo is on.
4113 */
4114 public function info() {
4115 global $wgLang, $wgOut, $wgAllowPageInfo, $wgUser;
4116
4117 if ( !$wgAllowPageInfo ) {
4118 $wgOut->showErrorPage( 'nosuchaction', 'nosuchactiontext' );
4119 return;
4120 }
4121
4122 $page = $this->mTitle->getSubjectPage();
4123
4124 $wgOut->setPagetitle( $page->getPrefixedText() );
4125 $wgOut->setPageTitleActionText( wfMsg( 'info_short' ) );
4126 $wgOut->setSubtitle( wfMsgHtml( 'infosubtitle' ) );
4127
4128 if ( !$this->mTitle->exists() ) {
4129 $wgOut->addHTML( '<div class="noarticletext">' );
4130 if ( $this->mTitle->getNamespace() == NS_MEDIAWIKI ) {
4131 // This doesn't quite make sense; the user is asking for
4132 // information about the _page_, not the message... -- RC
4133 $wgOut->addHTML( htmlspecialchars( wfMsgWeirdKey( $this->mTitle->getText() ) ) );
4134 } else {
4135 $msg = $wgUser->isLoggedIn()
4136 ? 'noarticletext'
4137 : 'noarticletextanon';
4138 $wgOut->addHTML( wfMsgExt( $msg, 'parse' ) );
4139 }
4140
4141 $wgOut->addHTML( '</div>' );
4142 } else {
4143 $dbr = wfGetDB( DB_SLAVE );
4144 $wl_clause = array(
4145 'wl_title' => $page->getDBkey(),
4146 'wl_namespace' => $page->getNamespace() );
4147 $numwatchers = $dbr->selectField(
4148 'watchlist',
4149 'COUNT(*)',
4150 $wl_clause,
4151 __METHOD__,
4152 $this->getSelectOptions() );
4153
4154 $pageInfo = $this->pageCountInfo( $page );
4155 $talkInfo = $this->pageCountInfo( $page->getTalkPage() );
4156
4157
4158 //FIXME: unescaped messages
4159 $wgOut->addHTML( "<ul><li>" . wfMsg( "numwatchers", $wgLang->formatNum( $numwatchers ) ) . '</li>' );
4160 $wgOut->addHTML( "<li>" . wfMsg( 'numedits', $wgLang->formatNum( $pageInfo['edits'] ) ) . '</li>' );
4161
4162 if ( $talkInfo ) {
4163 $wgOut->addHTML( '<li>' . wfMsg( "numtalkedits", $wgLang->formatNum( $talkInfo['edits'] ) ) . '</li>' );
4164 }
4165
4166 $wgOut->addHTML( '<li>' . wfMsg( "numauthors", $wgLang->formatNum( $pageInfo['authors'] ) ) . '</li>' );
4167
4168 if ( $talkInfo ) {
4169 $wgOut->addHTML( '<li>' . wfMsg( 'numtalkauthors', $wgLang->formatNum( $talkInfo['authors'] ) ) . '</li>' );
4170 }
4171
4172 $wgOut->addHTML( '</ul>' );
4173 }
4174 }
4175
4176 /**
4177 * Return the total number of edits and number of unique editors
4178 * on a given page. If page does not exist, returns false.
4179 *
4180 * @param $title Title object
4181 * @return mixed array or boolean false
4182 */
4183 public function pageCountInfo( $title ) {
4184 $id = $title->getArticleId();
4185
4186 if ( $id == 0 ) {
4187 return false;
4188 }
4189
4190 $dbr = wfGetDB( DB_SLAVE );
4191 $rev_clause = array( 'rev_page' => $id );
4192 $edits = $dbr->selectField(
4193 'revision',
4194 'COUNT(rev_page)',
4195 $rev_clause,
4196 __METHOD__,
4197 $this->getSelectOptions()
4198 );
4199 $authors = $dbr->selectField(
4200 'revision',
4201 'COUNT(DISTINCT rev_user_text)',
4202 $rev_clause,
4203 __METHOD__,
4204 $this->getSelectOptions()
4205 );
4206
4207 return array( 'edits' => $edits, 'authors' => $authors );
4208 }
4209
4210 /**
4211 * Return a list of templates used by this article.
4212 * Uses the templatelinks table
4213 *
4214 * @return Array of Title objects
4215 */
4216 public function getUsedTemplates() {
4217 $result = array();
4218 $id = $this->mTitle->getArticleID();
4219
4220 if ( $id == 0 ) {
4221 return array();
4222 }
4223
4224 $dbr = wfGetDB( DB_SLAVE );
4225 $res = $dbr->select( array( 'templatelinks' ),
4226 array( 'tl_namespace', 'tl_title' ),
4227 array( 'tl_from' => $id ),
4228 __METHOD__ );
4229
4230 if ( $res !== false ) {
4231 foreach ( $res as $row ) {
4232 $result[] = Title::makeTitle( $row->tl_namespace, $row->tl_title );
4233 }
4234 }
4235
4236 return $result;
4237 }
4238
4239 /**
4240 * Returns a list of hidden categories this page is a member of.
4241 * Uses the page_props and categorylinks tables.
4242 *
4243 * @return Array of Title objects
4244 */
4245 public function getHiddenCategories() {
4246 $result = array();
4247 $id = $this->mTitle->getArticleID();
4248
4249 if ( $id == 0 ) {
4250 return array();
4251 }
4252
4253 $dbr = wfGetDB( DB_SLAVE );
4254 $res = $dbr->select( array( 'categorylinks', 'page_props', 'page' ),
4255 array( 'cl_to' ),
4256 array( 'cl_from' => $id, 'pp_page=page_id', 'pp_propname' => 'hiddencat',
4257 'page_namespace' => NS_CATEGORY, 'page_title=cl_to' ),
4258 __METHOD__ );
4259
4260 if ( $res !== false ) {
4261 foreach ( $res as $row ) {
4262 $result[] = Title::makeTitle( NS_CATEGORY, $row->cl_to );
4263 }
4264 }
4265
4266 return $result;
4267 }
4268
4269 /**
4270 * Return an applicable autosummary if one exists for the given edit.
4271 * @param $oldtext String: the previous text of the page.
4272 * @param $newtext String: The submitted text of the page.
4273 * @param $flags Int bitmask: a bitmask of flags submitted for the edit.
4274 * @return string An appropriate autosummary, or an empty string.
4275 */
4276 public static function getAutosummary( $oldtext, $newtext, $flags ) {
4277 global $wgContLang;
4278
4279 # Decide what kind of autosummary is needed.
4280
4281 # Redirect autosummaries
4282 $ot = Title::newFromRedirect( $oldtext );
4283 $rt = Title::newFromRedirect( $newtext );
4284
4285 if ( is_object( $rt ) && ( !is_object( $ot ) || !$rt->equals( $ot ) || $ot->getFragment() != $rt->getFragment() ) ) {
4286 return wfMsgForContent( 'autoredircomment', $rt->getFullText() );
4287 }
4288
4289 # New page autosummaries
4290 if ( $flags & EDIT_NEW && strlen( $newtext ) ) {
4291 # If they're making a new article, give its text, truncated, in the summary.
4292
4293 $truncatedtext = $wgContLang->truncate(
4294 str_replace( "\n", ' ', $newtext ),
4295 max( 0, 200 - strlen( wfMsgForContent( 'autosumm-new' ) ) ) );
4296
4297 return wfMsgForContent( 'autosumm-new', $truncatedtext );
4298 }
4299
4300 # Blanking autosummaries
4301 if ( $oldtext != '' && $newtext == '' ) {
4302 return wfMsgForContent( 'autosumm-blank' );
4303 } elseif ( strlen( $oldtext ) > 10 * strlen( $newtext ) && strlen( $newtext ) < 500 ) {
4304 # Removing more than 90% of the article
4305
4306 $truncatedtext = $wgContLang->truncate(
4307 $newtext,
4308 max( 0, 200 - strlen( wfMsgForContent( 'autosumm-replace' ) ) ) );
4309
4310 return wfMsgForContent( 'autosumm-replace', $truncatedtext );
4311 }
4312
4313 # If we reach this point, there's no applicable autosummary for our case, so our
4314 # autosummary is empty.
4315 return '';
4316 }
4317
4318 /**
4319 * Add the primary page-view wikitext to the output buffer
4320 * Saves the text into the parser cache if possible.
4321 * Updates templatelinks if it is out of date.
4322 *
4323 * @param $text String
4324 * @param $cache Boolean
4325 * @param $parserOptions mixed ParserOptions object, or boolean false
4326 */
4327 public function outputWikiText( $text, $cache = true, $parserOptions = false ) {
4328 global $wgOut;
4329
4330 $this->mParserOutput = $this->getOutputFromWikitext( $text, $cache, $parserOptions );
4331 $wgOut->addParserOutput( $this->mParserOutput );
4332 }
4333
4334 /**
4335 * This does all the heavy lifting for outputWikitext, except it returns the parser
4336 * output instead of sending it straight to $wgOut. Makes things nice and simple for,
4337 * say, embedding thread pages within a discussion system (LiquidThreads)
4338 *
4339 * @param $text string
4340 * @param $cache boolean
4341 * @param $parserOptions parsing options, defaults to false
4342 * @return string containing parsed output
4343 */
4344 public function getOutputFromWikitext( $text, $cache = true, $parserOptions = false ) {
4345 global $wgParser, $wgEnableParserCache, $wgUseFileCache;
4346
4347 if ( !$parserOptions ) {
4348 $parserOptions = $this->getParserOptions();
4349 }
4350
4351 $time = - wfTime();
4352 $this->mParserOutput = $wgParser->parse( $text, $this->mTitle,
4353 $parserOptions, true, true, $this->getRevIdFetched() );
4354 $time += wfTime();
4355
4356 # Timing hack
4357 if ( $time > 3 ) {
4358 wfDebugLog( 'slow-parse', sprintf( "%-5.2f %s", $time,
4359 $this->mTitle->getPrefixedDBkey() ) );
4360 }
4361
4362 if ( $wgEnableParserCache && $cache && $this->mParserOutput->isCacheable() ) {
4363 $parserCache = ParserCache::singleton();
4364 $parserCache->save( $this->mParserOutput, $this, $parserOptions );
4365 }
4366
4367 // Make sure file cache is not used on uncacheable content.
4368 // Output that has magic words in it can still use the parser cache
4369 // (if enabled), though it will generally expire sooner.
4370 if ( !$this->mParserOutput->isCacheable() || $this->mParserOutput->containsOldMagic() ) {
4371 $wgUseFileCache = false;
4372 }
4373
4374 $this->doCascadeProtectionUpdates( $this->mParserOutput );
4375
4376 return $this->mParserOutput;
4377 }
4378
4379 /**
4380 * Get parser options suitable for rendering the primary article wikitext
4381 * @param $canonical boolean Determines that the generated must not depend on user preferences (see bug 14404)
4382 * @return mixed ParserOptions object or boolean false
4383 */
4384 public function getParserOptions( $canonical = false ) {
4385 global $wgUser, $wgLanguageCode;
4386
4387 if ( !$this->mParserOptions || $canonical ) {
4388 $user = !$canonical ? $wgUser : new User;
4389 $parserOptions = new ParserOptions( $user );
4390 $parserOptions->setTidy( true );
4391 $parserOptions->enableLimitReport();
4392
4393 if ( $canonical ) {
4394 $parserOptions->setUserLang( $wgLanguageCode ); # Must be set explicitely
4395 return $parserOptions;
4396 }
4397 $this->mParserOptions = $parserOptions;
4398 }
4399
4400 // Clone to allow modifications of the return value without affecting
4401 // the cache
4402 return clone $this->mParserOptions;
4403 }
4404
4405 /**
4406 * Updates cascading protections
4407 *
4408 * @param $parserOutput mixed ParserOptions object, or boolean false
4409 **/
4410 protected function doCascadeProtectionUpdates( $parserOutput ) {
4411 if ( !$this->isCurrent() || wfReadOnly() || !$this->mTitle->areRestrictionsCascading() ) {
4412 return;
4413 }
4414
4415 // templatelinks table may have become out of sync,
4416 // especially if using variable-based transclusions.
4417 // For paranoia, check if things have changed and if
4418 // so apply updates to the database. This will ensure
4419 // that cascaded protections apply as soon as the changes
4420 // are visible.
4421
4422 # Get templates from templatelinks
4423 $id = $this->mTitle->getArticleID();
4424
4425 $tlTemplates = array();
4426
4427 $dbr = wfGetDB( DB_SLAVE );
4428 $res = $dbr->select( array( 'templatelinks' ),
4429 array( 'tl_namespace', 'tl_title' ),
4430 array( 'tl_from' => $id ),
4431 __METHOD__
4432 );
4433
4434 foreach ( $res as $row ) {
4435 $tlTemplates["{$row->tl_namespace}:{$row->tl_title}"] = true;
4436 }
4437
4438 # Get templates from parser output.
4439 $poTemplates = array();
4440 foreach ( $parserOutput->getTemplates() as $ns => $templates ) {
4441 foreach ( $templates as $dbk => $id ) {
4442 $poTemplates["$ns:$dbk"] = true;
4443 }
4444 }
4445
4446 # Get the diff
4447 $templates_diff = array_diff_key( $poTemplates, $tlTemplates );
4448
4449 if ( count( $templates_diff ) > 0 ) {
4450 # Whee, link updates time.
4451 $u = new LinksUpdate( $this->mTitle, $parserOutput, false );
4452 $u->doUpdate();
4453 }
4454 }
4455
4456 /**
4457 * Update all the appropriate counts in the category table, given that
4458 * we've added the categories $added and deleted the categories $deleted.
4459 *
4460 * @param $added array The names of categories that were added
4461 * @param $deleted array The names of categories that were deleted
4462 */
4463 public function updateCategoryCounts( $added, $deleted ) {
4464 $ns = $this->mTitle->getNamespace();
4465 $dbw = wfGetDB( DB_MASTER );
4466
4467 # First make sure the rows exist. If one of the "deleted" ones didn't
4468 # exist, we might legitimately not create it, but it's simpler to just
4469 # create it and then give it a negative value, since the value is bogus
4470 # anyway.
4471 #
4472 # Sometimes I wish we had INSERT ... ON DUPLICATE KEY UPDATE.
4473 $insertCats = array_merge( $added, $deleted );
4474 if ( !$insertCats ) {
4475 # Okay, nothing to do
4476 return;
4477 }
4478
4479 $insertRows = array();
4480
4481 foreach ( $insertCats as $cat ) {
4482 $insertRows[] = array(
4483 'cat_id' => $dbw->nextSequenceValue( 'category_cat_id_seq' ),
4484 'cat_title' => $cat
4485 );
4486 }
4487 $dbw->insert( 'category', $insertRows, __METHOD__, 'IGNORE' );
4488
4489 $addFields = array( 'cat_pages = cat_pages + 1' );
4490 $removeFields = array( 'cat_pages = cat_pages - 1' );
4491
4492 if ( $ns == NS_CATEGORY ) {
4493 $addFields[] = 'cat_subcats = cat_subcats + 1';
4494 $removeFields[] = 'cat_subcats = cat_subcats - 1';
4495 } elseif ( $ns == NS_FILE ) {
4496 $addFields[] = 'cat_files = cat_files + 1';
4497 $removeFields[] = 'cat_files = cat_files - 1';
4498 }
4499
4500 if ( $added ) {
4501 $dbw->update(
4502 'category',
4503 $addFields,
4504 array( 'cat_title' => $added ),
4505 __METHOD__
4506 );
4507 }
4508
4509 if ( $deleted ) {
4510 $dbw->update(
4511 'category',
4512 $removeFields,
4513 array( 'cat_title' => $deleted ),
4514 __METHOD__
4515 );
4516 }
4517 }
4518
4519 /**
4520 * Lightweight method to get the parser output for a page, checking the parser cache
4521 * and so on. Doesn't consider most of the stuff that Article::view is forced to
4522 * consider, so it's not appropriate to use there.
4523 *
4524 * @since 1.16 (r52326) for LiquidThreads
4525 *
4526 * @param $oldid mixed integer Revision ID or null
4527 * @return ParserOutput
4528 */
4529 public function getParserOutput( $oldid = null ) {
4530 global $wgEnableParserCache, $wgUser;
4531
4532 // Should the parser cache be used?
4533 $useParserCache = $wgEnableParserCache &&
4534 $wgUser->getStubThreshold() == 0 &&
4535 $this->exists() &&
4536 $oldid === null;
4537
4538 wfDebug( __METHOD__ . ': using parser cache: ' . ( $useParserCache ? 'yes' : 'no' ) . "\n" );
4539
4540 if ( $wgUser->getStubThreshold() ) {
4541 wfIncrStats( 'pcache_miss_stub' );
4542 }
4543
4544 $parserOutput = false;
4545 if ( $useParserCache ) {
4546 $parserOutput = ParserCache::singleton()->get( $this, $this->getParserOptions() );
4547 }
4548
4549 if ( $parserOutput === false ) {
4550 // Cache miss; parse and output it.
4551 $rev = Revision::newFromTitle( $this->getTitle(), $oldid );
4552
4553 return $this->getOutputFromWikitext( $rev->getText(), $useParserCache );
4554 } else {
4555 return $parserOutput;
4556 }
4557 }
4558
4559 }
4560
4561 class PoolWorkArticleView extends PoolCounterWork {
4562 private $mArticle;
4563
4564 function __construct( $article, $key, $useParserCache, $parserOptions ) {
4565 parent::__construct( 'ArticleView', $key );
4566 $this->mArticle = $article;
4567 $this->cacheable = $useParserCache;
4568 $this->parserOptions = $parserOptions;
4569 }
4570
4571 function doWork() {
4572 return $this->mArticle->doViewParse();
4573 }
4574
4575 function getCachedWork() {
4576 global $wgOut;
4577
4578 $parserCache = ParserCache::singleton();
4579 $this->mArticle->mParserOutput = $parserCache->get( $this->mArticle, $this->parserOptions );
4580
4581 if ( $this->mArticle->mParserOutput !== false ) {
4582 wfDebug( __METHOD__ . ": showing contents parsed by someone else\n" );
4583 $wgOut->addParserOutput( $this->mArticle->mParserOutput );
4584 # Ensure that UI elements requiring revision ID have
4585 # the correct version information.
4586 $wgOut->setRevisionId( $this->mArticle->getLatest() );
4587 return true;
4588 }
4589 return false;
4590 }
4591
4592 function fallback() {
4593 return $this->mArticle->tryDirtyCache();
4594 }
4595
4596 function error( $status ) {
4597 global $wgOut;
4598
4599 $wgOut->clearHTML(); // for release() errors
4600 $wgOut->enableClientCache( false );
4601 $wgOut->setRobotPolicy( 'noindex,nofollow' );
4602
4603 $errortext = $status->getWikiText( false, 'view-pool-error' );
4604 $wgOut->addWikiText( '<div class="errorbox">' . $errortext . '</div>' );
4605
4606 return false;
4607 }
4608 }