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