* Integrate $wgDeleteRevisionsLimit in Title::getUserPermissionsErrors() (only if...
[lhc/web/wiklou.git] / includes / WikiPage.php
1 <?php
2 /**
3 * Abstract class for type hinting (accepts WikiPage, Article, ImagePage, CategoryPage)
4 */
5 abstract class Page {}
6
7 /**
8 * Class representing a MediaWiki article and history.
9 *
10 * Some fields are public only for backwards-compatibility. Use accessors.
11 * In the past, this class was part of Article.php and everything was public.
12 *
13 * @internal documentation reviewed 15 Mar 2010
14 */
15 class WikiPage extends Page {
16 /**
17 * @var Title
18 */
19 public $mTitle = null;
20
21 /**@{{
22 * @protected
23 */
24 public $mDataLoaded = false; // !< Boolean
25 public $mIsRedirect = false; // !< Boolean
26 public $mLatest = false; // !< Integer (false means "not loaded")
27 public $mPreparedEdit = false; // !< Array
28
29 /**
30 * @var Title
31 */
32 protected $mRedirectTarget = null;
33
34 /**
35 * @var Revision
36 */
37 protected $mLastRevision = null;
38
39 protected $mTimestamp = ''; // !< String
40 protected $mTouched = '19700101000000'; // !< String
41 /**@}}*/
42
43 /**
44 * Constructor and clear the article
45 * @param $title Title Reference to a Title object.
46 */
47 public function __construct( Title $title ) {
48 $this->mTitle = $title;
49 }
50
51 /**
52 * Create a WikiPage object of the appropriate class for the given title.
53 *
54 * @param $title Title
55 * @return WikiPage object of the appropriate type
56 */
57 public static function factory( Title $title ) {
58 $ns = $title->getNamespace();
59
60 if ( $ns == NS_MEDIA ) {
61 throw new MWException( "NS_MEDIA is a virtual namespace; use NS_FILE." );
62 } elseif ( $ns < 0 ) {
63 throw new MWException( "Invalid or virtual namespace $ns given." );
64 }
65
66 switch ( $ns ) {
67 case NS_FILE:
68 $page = new WikiFilePage( $title );
69 break;
70 case NS_CATEGORY:
71 $page = new WikiCategoryPage( $title );
72 break;
73 default:
74 $page = new WikiPage( $title );
75 }
76
77 return $page;
78 }
79
80 /**
81 * Constructor from a page id
82 *
83 * @param $id Int article ID to load
84 *
85 * @return WikiPage
86 */
87 public static function newFromID( $id ) {
88 $t = Title::newFromID( $id );
89 if ( $t ) {
90 return self::factory( $t );
91 }
92 return null;
93 }
94
95 /**
96 * Returns overrides for action handlers.
97 * Classes listed here will be used instead of the default one when
98 * (and only when) $wgActions[$action] === true. This allows subclasses
99 * to override the default behavior.
100 *
101 * @todo: move this UI stuff somewhere else
102 *
103 * @return Array
104 */
105 public function getActionOverrides() {
106 return array();
107 }
108
109 /**
110 * If this page is a redirect, get its target
111 *
112 * The target will be fetched from the redirect table if possible.
113 * If this page doesn't have an entry there, call insertRedirect()
114 * @return Title|mixed object, or null if this page is not a redirect
115 */
116 public function getRedirectTarget() {
117 if ( !$this->mTitle->isRedirect() ) {
118 return null;
119 }
120
121 if ( $this->mRedirectTarget !== null ) {
122 return $this->mRedirectTarget;
123 }
124
125 # Query the redirect table
126 $dbr = wfGetDB( DB_SLAVE );
127 $row = $dbr->selectRow( 'redirect',
128 array( 'rd_namespace', 'rd_title', 'rd_fragment', 'rd_interwiki' ),
129 array( 'rd_from' => $this->getId() ),
130 __METHOD__
131 );
132
133 // rd_fragment and rd_interwiki were added later, populate them if empty
134 if ( $row && !is_null( $row->rd_fragment ) && !is_null( $row->rd_interwiki ) ) {
135 return $this->mRedirectTarget = Title::makeTitle(
136 $row->rd_namespace, $row->rd_title,
137 $row->rd_fragment, $row->rd_interwiki );
138 }
139
140 # This page doesn't have an entry in the redirect table
141 return $this->mRedirectTarget = $this->insertRedirect();
142 }
143
144 /**
145 * Insert an entry for this page into the redirect table.
146 *
147 * Don't call this function directly unless you know what you're doing.
148 * @return Title object or null if not a redirect
149 */
150 public function insertRedirect() {
151 // recurse through to only get the final target
152 $retval = Title::newFromRedirectRecurse( $this->getRawText() );
153 if ( !$retval ) {
154 return null;
155 }
156 $this->insertRedirectEntry( $retval );
157 return $retval;
158 }
159
160 /**
161 * Insert or update the redirect table entry for this page to indicate
162 * it redirects to $rt .
163 * @param $rt Title redirect target
164 */
165 public function insertRedirectEntry( $rt ) {
166 $dbw = wfGetDB( DB_MASTER );
167 $dbw->replace( 'redirect', array( 'rd_from' ),
168 array(
169 'rd_from' => $this->getId(),
170 'rd_namespace' => $rt->getNamespace(),
171 'rd_title' => $rt->getDBkey(),
172 'rd_fragment' => $rt->getFragment(),
173 'rd_interwiki' => $rt->getInterwiki(),
174 ),
175 __METHOD__
176 );
177 }
178
179 /**
180 * Get the Title object or URL this page redirects to
181 *
182 * @return mixed false, Title of in-wiki target, or string with URL
183 */
184 public function followRedirect() {
185 return $this->getRedirectURL( $this->getRedirectTarget() );
186 }
187
188 /**
189 * Get the Title object or URL to use for a redirect. We use Title
190 * objects for same-wiki, non-special redirects and URLs for everything
191 * else.
192 * @param $rt Title Redirect target
193 * @return mixed false, Title object of local target, or string with URL
194 */
195 public function getRedirectURL( $rt ) {
196 if ( $rt ) {
197 if ( $rt->getInterwiki() != '' ) {
198 if ( $rt->isLocal() ) {
199 // Offsite wikis need an HTTP redirect.
200 //
201 // This can be hard to reverse and may produce loops,
202 // so they may be disabled in the site configuration.
203 $source = $this->mTitle->getFullURL( 'redirect=no' );
204 return $rt->getFullURL( 'rdfrom=' . urlencode( $source ) );
205 }
206 } else {
207 if ( $rt->isSpecialPage() ) {
208 // Gotta handle redirects to special pages differently:
209 // Fill the HTTP response "Location" header and ignore
210 // the rest of the page we're on.
211 //
212 // This can be hard to reverse, so they may be disabled.
213 if ( $rt->isSpecial( 'Userlogout' ) ) {
214 // rolleyes
215 } else {
216 return $rt->getFullURL();
217 }
218 }
219
220 return $rt;
221 }
222 }
223
224 // No or invalid redirect
225 return false;
226 }
227
228 /**
229 * Get the title object of the article
230 * @return Title object of this page
231 */
232 public function getTitle() {
233 return $this->mTitle;
234 }
235
236 /**
237 * Clear the object
238 */
239 public function clear() {
240 $this->mDataLoaded = false;
241
242 $this->mRedirectTarget = null; # Title object if set
243 $this->mLastRevision = null; # Latest revision
244 $this->mTimestamp = '';
245 $this->mTouched = '19700101000000';
246 $this->mIsRedirect = false;
247 $this->mLatest = false;
248 $this->mPreparedEdit = false;
249 }
250
251 /**
252 * Get the text that needs to be saved in order to undo all revisions
253 * between $undo and $undoafter. Revisions must belong to the same page,
254 * must exist and must not be deleted
255 * @param $undo Revision
256 * @param $undoafter Revision Must be an earlier revision than $undo
257 * @return mixed string on success, false on failure
258 */
259 public function getUndoText( Revision $undo, Revision $undoafter = null ) {
260 $cur_text = $this->getRawText();
261 if ( $cur_text === false ) {
262 return false; // no page
263 }
264 $undo_text = $undo->getText();
265 $undoafter_text = $undoafter->getText();
266
267 if ( $cur_text == $undo_text ) {
268 # No use doing a merge if it's just a straight revert.
269 return $undoafter_text;
270 }
271
272 $undone_text = '';
273
274 if ( !wfMerge( $undo_text, $undoafter_text, $cur_text, $undone_text ) ) {
275 return false;
276 }
277
278 return $undone_text;
279 }
280
281 /**
282 * Return the list of revision fields that should be selected to create
283 * a new page.
284 *
285 * @return array
286 */
287 public static function selectFields() {
288 return array(
289 'page_id',
290 'page_namespace',
291 'page_title',
292 'page_restrictions',
293 'page_counter',
294 'page_is_redirect',
295 'page_is_new',
296 'page_random',
297 'page_touched',
298 'page_latest',
299 'page_len',
300 );
301 }
302
303 /**
304 * Fetch a page record with the given conditions
305 * @param $dbr DatabaseBase object
306 * @param $conditions Array
307 * @return mixed Database result resource, or false on failure
308 */
309 protected function pageData( $dbr, $conditions ) {
310 $fields = self::selectFields();
311
312 wfRunHooks( 'ArticlePageDataBefore', array( &$this, &$fields ) );
313
314 $row = $dbr->selectRow( 'page', $fields, $conditions, __METHOD__ );
315
316 wfRunHooks( 'ArticlePageDataAfter', array( &$this, &$row ) );
317
318 return $row;
319 }
320
321 /**
322 * Fetch a page record matching the Title object's namespace and title
323 * using a sanitized title string
324 *
325 * @param $dbr DatabaseBase object
326 * @param $title Title object
327 * @return mixed Database result resource, or false on failure
328 */
329 public function pageDataFromTitle( $dbr, $title ) {
330 return $this->pageData( $dbr, array(
331 'page_namespace' => $title->getNamespace(),
332 'page_title' => $title->getDBkey() ) );
333 }
334
335 /**
336 * Fetch a page record matching the requested ID
337 *
338 * @param $dbr DatabaseBase
339 * @param $id Integer
340 * @return mixed Database result resource, or false on failure
341 */
342 public function pageDataFromId( $dbr, $id ) {
343 return $this->pageData( $dbr, array( 'page_id' => $id ) );
344 }
345
346 /**
347 * Set the general counter, title etc data loaded from
348 * some source.
349 *
350 * @param $data Object|String One of the following:
351 * A DB query result object or...
352 * "fromdb" to get from a slave DB or...
353 * "fromdbmaster" to get from the master DB
354 * @return void
355 */
356 public function loadPageData( $data = 'fromdb' ) {
357 if ( $data === 'fromdbmaster' ) {
358 $data = $this->pageDataFromTitle( wfGetDB( DB_MASTER ), $this->mTitle );
359 } elseif ( $data === 'fromdb' ) { // slave
360 $data = $this->pageDataFromTitle( wfGetDB( DB_SLAVE ), $this->mTitle );
361 # Use a "last rev inserted" timestamp key to dimish the issue of slave lag.
362 # Note that DB also stores the master position in the session and checks it.
363 $touched = $this->getCachedLastEditTime();
364 if ( $touched ) { // key set
365 if ( !$data || $touched > wfTimestamp( TS_MW, $data->page_touched ) ) {
366 $data = $this->pageDataFromTitle( wfGetDB( DB_MASTER ), $this->mTitle );
367 }
368 }
369 }
370
371 $lc = LinkCache::singleton();
372
373 if ( $data ) {
374 $lc->addGoodLinkObjFromRow( $this->mTitle, $data );
375
376 $this->mTitle->loadFromRow( $data );
377
378 # Old-fashioned restrictions
379 $this->mTitle->loadRestrictions( $data->page_restrictions );
380
381 $this->mTouched = wfTimestamp( TS_MW, $data->page_touched );
382 $this->mIsRedirect = intval( $data->page_is_redirect );
383 $this->mLatest = intval( $data->page_latest );
384 } else {
385 $lc->addBadLinkObj( $this->mTitle );
386
387 $this->mTitle->loadFromRow( false );
388 }
389
390 $this->mDataLoaded = true;
391 }
392
393 /**
394 * @return int Page ID
395 */
396 public function getId() {
397 return $this->mTitle->getArticleID();
398 }
399
400 /**
401 * @return bool Whether or not the page exists in the database
402 */
403 public function exists() {
404 return $this->mTitle->exists();
405 }
406
407 /**
408 * Check if this page is something we're going to be showing
409 * some sort of sensible content for. If we return false, page
410 * views (plain action=view) will return an HTTP 404 response,
411 * so spiders and robots can know they're following a bad link.
412 *
413 * @return bool
414 */
415 public function hasViewableContent() {
416 return $this->mTitle->exists() || $this->mTitle->isAlwaysKnown();
417 }
418
419 /**
420 * Get the number of views of this page
421 *
422 * @return int The view count for the page
423 */
424 public function getCount() {
425 return $this->mTitle->getCount();
426 }
427
428 /**
429 * Determine whether a page would be suitable for being counted as an
430 * article in the site_stats table based on the title & its content
431 *
432 * @param $editInfo Object or false: object returned by prepareTextForEdit(),
433 * if false, the current database state will be used
434 * @return Boolean
435 */
436 public function isCountable( $editInfo = false ) {
437 global $wgArticleCountMethod;
438
439 if ( !$this->mTitle->isContentPage() ) {
440 return false;
441 }
442
443 $text = $editInfo ? $editInfo->pst : false;
444
445 if ( $this->isRedirect( $text ) ) {
446 return false;
447 }
448
449 switch ( $wgArticleCountMethod ) {
450 case 'any':
451 return true;
452 case 'comma':
453 if ( $text === false ) {
454 $text = $this->getRawText();
455 }
456 return strpos( $text, ',' ) !== false;
457 case 'link':
458 if ( $editInfo ) {
459 // ParserOutput::getLinks() is a 2D array of page links, so
460 // to be really correct we would need to recurse in the array
461 // but the main array should only have items in it if there are
462 // links.
463 return (bool)count( $editInfo->output->getLinks() );
464 } else {
465 return (bool)wfGetDB( DB_SLAVE )->selectField( 'pagelinks', 1,
466 array( 'pl_from' => $this->getId() ), __METHOD__ );
467 }
468 }
469 }
470
471 /**
472 * Tests if the article text represents a redirect
473 *
474 * @param $text mixed string containing article contents, or boolean
475 * @return bool
476 */
477 public function isRedirect( $text = false ) {
478 if ( $text === false ) {
479 if ( !$this->mDataLoaded ) {
480 $this->loadPageData();
481 }
482
483 return (bool)$this->mIsRedirect;
484 } else {
485 return Title::newFromRedirect( $text ) !== null;
486 }
487 }
488
489 /**
490 * Loads everything except the text
491 * This isn't necessary for all uses, so it's only done if needed.
492 */
493 protected function loadLastEdit() {
494 if ( $this->mLastRevision !== null ) {
495 return; // already loaded
496 }
497
498 $latest = $this->getLatest();
499 if ( !$latest ) {
500 return; // page doesn't exist or is missing page_latest info
501 }
502
503 $revision = Revision::newFromPageId( $this->getId(), $latest );
504 if ( $revision ) { // sanity
505 $this->setLastEdit( $revision );
506 }
507 }
508
509 /**
510 * Set the latest revision
511 */
512 protected function setLastEdit( Revision $revision ) {
513 $this->mLastRevision = $revision;
514 $this->mTimestamp = $revision->getTimestamp();
515 }
516
517 /**
518 * Get the latest revision
519 * @return Revision|null
520 */
521 public function getRevision() {
522 $this->loadLastEdit();
523 if ( $this->mLastRevision ) {
524 return $this->mLastRevision;
525 }
526 return null;
527 }
528
529 /**
530 * Get the text of the current revision. No side-effects...
531 *
532 * @param $audience Integer: one of:
533 * Revision::FOR_PUBLIC to be displayed to all users
534 * Revision::FOR_THIS_USER to be displayed to $wgUser
535 * Revision::RAW get the text regardless of permissions
536 * @return String|false The text of the current revision
537 */
538 public function getText( $audience = Revision::FOR_PUBLIC ) {
539 $this->loadLastEdit();
540 if ( $this->mLastRevision ) {
541 return $this->mLastRevision->getText( $audience );
542 }
543 return false;
544 }
545
546 /**
547 * Get the text of the current revision. No side-effects...
548 *
549 * @return String|false The text of the current revision
550 */
551 public function getRawText() {
552 $this->loadLastEdit();
553 if ( $this->mLastRevision ) {
554 return $this->mLastRevision->getRawText();
555 }
556 return false;
557 }
558
559 /**
560 * @return string MW timestamp of last article revision
561 */
562 public function getTimestamp() {
563 // Check if the field has been filled by WikiPage::setTimestamp()
564 if ( !$this->mTimestamp ) {
565 $this->loadLastEdit();
566 }
567 return wfTimestamp( TS_MW, $this->mTimestamp );
568 }
569
570 /**
571 * Set the page timestamp (use only to avoid DB queries)
572 * @param $ts string MW timestamp of last article revision
573 * @return void
574 */
575 public function setTimestamp( $ts ) {
576 $this->mTimestamp = wfTimestamp( TS_MW, $ts );
577 }
578
579 /**
580 * @param $audience Integer: one of:
581 * Revision::FOR_PUBLIC to be displayed to all users
582 * Revision::FOR_THIS_USER to be displayed to $wgUser
583 * Revision::RAW get the text regardless of permissions
584 * @return int user ID for the user that made the last article revision
585 */
586 public function getUser( $audience = Revision::FOR_PUBLIC ) {
587 $this->loadLastEdit();
588 if ( $this->mLastRevision ) {
589 return $this->mLastRevision->getUser( $audience );
590 } else {
591 return -1;
592 }
593 }
594
595 /**
596 * @param $audience Integer: one of:
597 * Revision::FOR_PUBLIC to be displayed to all users
598 * Revision::FOR_THIS_USER to be displayed to $wgUser
599 * Revision::RAW get the text regardless of permissions
600 * @return string username of the user that made the last article revision
601 */
602 public function getUserText( $audience = Revision::FOR_PUBLIC ) {
603 $this->loadLastEdit();
604 if ( $this->mLastRevision ) {
605 return $this->mLastRevision->getUserText( $audience );
606 } else {
607 return '';
608 }
609 }
610
611 /**
612 * @param $audience Integer: one of:
613 * Revision::FOR_PUBLIC to be displayed to all users
614 * Revision::FOR_THIS_USER to be displayed to $wgUser
615 * Revision::RAW get the text regardless of permissions
616 * @return string Comment stored for the last article revision
617 */
618 public function getComment( $audience = Revision::FOR_PUBLIC ) {
619 $this->loadLastEdit();
620 if ( $this->mLastRevision ) {
621 return $this->mLastRevision->getComment( $audience );
622 } else {
623 return '';
624 }
625 }
626
627 /**
628 * Returns true if last revision was marked as "minor edit"
629 *
630 * @return boolean Minor edit indicator for the last article revision.
631 */
632 public function getMinorEdit() {
633 $this->loadLastEdit();
634 if ( $this->mLastRevision ) {
635 return $this->mLastRevision->isMinor();
636 } else {
637 return false;
638 }
639 }
640
641 /**
642 * Get a list of users who have edited this article, not including the user who made
643 * the most recent revision, which you can get from $article->getUser() if you want it
644 * @return UserArrayFromResult
645 */
646 public function getContributors() {
647 # @todo FIXME: This is expensive; cache this info somewhere.
648
649 $dbr = wfGetDB( DB_SLAVE );
650
651 if ( $dbr->implicitGroupby() ) {
652 $realNameField = 'user_real_name';
653 } else {
654 $realNameField = 'MIN(user_real_name) AS user_real_name';
655 }
656
657 $tables = array( 'revision', 'user' );
658
659 $fields = array(
660 'rev_user as user_id',
661 'rev_user_text AS user_name',
662 $realNameField,
663 'MAX(rev_timestamp) AS timestamp',
664 );
665
666 $conds = array( 'rev_page' => $this->getId() );
667
668 // The user who made the top revision gets credited as "this page was last edited by
669 // John, based on contributions by Tom, Dick and Harry", so don't include them twice.
670 $user = $this->getUser();
671 if ( $user ) {
672 $conds[] = "rev_user != $user";
673 } else {
674 $conds[] = "rev_user_text != {$dbr->addQuotes( $this->getUserText() )}";
675 }
676
677 $conds[] = "{$dbr->bitAnd( 'rev_deleted', Revision::DELETED_USER )} = 0"; // username hidden?
678
679 $jconds = array(
680 'user' => array( 'LEFT JOIN', 'rev_user = user_id' ),
681 );
682
683 $options = array(
684 'GROUP BY' => array( 'rev_user', 'rev_user_text' ),
685 'ORDER BY' => 'timestamp DESC',
686 );
687
688 $res = $dbr->select( $tables, $fields, $conds, __METHOD__, $options, $jconds );
689 return new UserArrayFromResult( $res );
690 }
691
692 /**
693 * Should the parser cache be used?
694 *
695 * @param $parserOptions ParserOptions to check
696 * @param $oldid int
697 * @return boolean
698 */
699 public function isParserCacheUsed( ParserOptions $parserOptions, $oldid ) {
700 global $wgEnableParserCache;
701
702 return $wgEnableParserCache
703 && $parserOptions->getStubThreshold() == 0
704 && $this->mTitle->exists()
705 && ( $oldid === null || $oldid === 0 || $oldid === $this->getLatest() )
706 && $this->mTitle->isWikitextPage();
707 }
708
709 /**
710 * Get a ParserOutput for the given ParserOptions and revision ID.
711 * The parser cache will be used if possible.
712 *
713 * @since 1.19
714 * @param $parserOptions ParserOptions to use for the parse operation
715 * @param $oldid Revision ID to get the text from, passing null or 0 will
716 * get the current revision (default value)
717 * @return ParserOutput or false if the revision was not found
718 */
719 public function getParserOutput( ParserOptions $parserOptions, $oldid = null ) {
720 wfProfileIn( __METHOD__ );
721
722 $useParserCache = $this->isParserCacheUsed( $parserOptions, $oldid );
723 wfDebug( __METHOD__ . ': using parser cache: ' . ( $useParserCache ? 'yes' : 'no' ) . "\n" );
724 if ( $parserOptions->getStubThreshold() ) {
725 wfIncrStats( 'pcache_miss_stub' );
726 }
727
728 if ( $useParserCache ) {
729 $parserOutput = ParserCache::singleton()->get( $this, $parserOptions );
730 if ( $parserOutput !== false ) {
731 wfProfileOut( __METHOD__ );
732 return $parserOutput;
733 }
734 }
735
736 if ( $oldid === null || $oldid === 0 ) {
737 $oldid = $this->getLatest();
738 }
739
740 $pool = new PoolWorkArticleView( $this, $parserOptions, $oldid, $useParserCache );
741 $pool->execute();
742
743 wfProfileOut( __METHOD__ );
744
745 return $pool->getParserOutput();
746 }
747
748 /**
749 * Perform the actions of a page purging
750 */
751 public function doPurge() {
752 global $wgUseSquid;
753
754 if( !wfRunHooks( 'ArticlePurge', array( &$this ) ) ){
755 return false;
756 }
757
758 // Invalidate the cache
759 $this->mTitle->invalidateCache();
760 $this->clear();
761
762 if ( $wgUseSquid ) {
763 // Commit the transaction before the purge is sent
764 $dbw = wfGetDB( DB_MASTER );
765 $dbw->commit();
766
767 // Send purge
768 $update = SquidUpdate::newSimplePurge( $this->mTitle );
769 $update->doUpdate();
770 }
771
772 if ( $this->mTitle->getNamespace() == NS_MEDIAWIKI ) {
773 if ( $this->mTitle->exists() ) {
774 $text = $this->getRawText();
775 } else {
776 $text = false;
777 }
778
779 MessageCache::singleton()->replace( $this->mTitle->getDBkey(), $text );
780 }
781 return true;
782 }
783
784 /**
785 * Insert a new empty page record for this article.
786 * This *must* be followed up by creating a revision
787 * and running $this->updateRevisionOn( ... );
788 * or else the record will be left in a funky state.
789 * Best if all done inside a transaction.
790 *
791 * @param $dbw DatabaseBase
792 * @return int The newly created page_id key, or false if the title already existed
793 */
794 public function insertOn( $dbw ) {
795 wfProfileIn( __METHOD__ );
796
797 $page_id = $dbw->nextSequenceValue( 'page_page_id_seq' );
798 $dbw->insert( 'page', array(
799 'page_id' => $page_id,
800 'page_namespace' => $this->mTitle->getNamespace(),
801 'page_title' => $this->mTitle->getDBkey(),
802 'page_counter' => 0,
803 'page_restrictions' => '',
804 'page_is_redirect' => 0, # Will set this shortly...
805 'page_is_new' => 1,
806 'page_random' => wfRandom(),
807 'page_touched' => $dbw->timestamp(),
808 'page_latest' => 0, # Fill this in shortly...
809 'page_len' => 0, # Fill this in shortly...
810 ), __METHOD__, 'IGNORE' );
811
812 $affected = $dbw->affectedRows();
813
814 if ( $affected ) {
815 $newid = $dbw->insertId();
816 $this->mTitle->resetArticleID( $newid );
817 }
818 wfProfileOut( __METHOD__ );
819
820 return $affected ? $newid : false;
821 }
822
823 /**
824 * Update the page record to point to a newly saved revision.
825 *
826 * @param $dbw DatabaseBase: object
827 * @param $revision Revision: For ID number, and text used to set
828 * length and redirect status fields
829 * @param $lastRevision Integer: if given, will not overwrite the page field
830 * when different from the currently set value.
831 * Giving 0 indicates the new page flag should be set
832 * on.
833 * @param $lastRevIsRedirect Boolean: if given, will optimize adding and
834 * removing rows in redirect table.
835 * @return bool true on success, false on failure
836 * @private
837 */
838 public function updateRevisionOn( $dbw, $revision, $lastRevision = null, $lastRevIsRedirect = null ) {
839 wfProfileIn( __METHOD__ );
840
841 $text = $revision->getText();
842 $len = strlen( $text );
843 $rt = Title::newFromRedirectRecurse( $text );
844
845 $conditions = array( 'page_id' => $this->getId() );
846
847 if ( !is_null( $lastRevision ) ) {
848 # An extra check against threads stepping on each other
849 $conditions['page_latest'] = $lastRevision;
850 }
851
852 $now = wfTimestampNow();
853 $dbw->update( 'page',
854 array( /* SET */
855 'page_latest' => $revision->getId(),
856 'page_touched' => $dbw->timestamp( $now ),
857 'page_is_new' => ( $lastRevision === 0 ) ? 1 : 0,
858 'page_is_redirect' => $rt !== null ? 1 : 0,
859 'page_len' => $len,
860 ),
861 $conditions,
862 __METHOD__ );
863
864 $result = $dbw->affectedRows() != 0;
865 if ( $result ) {
866 $this->updateRedirectOn( $dbw, $rt, $lastRevIsRedirect );
867 $this->setLastEdit( $revision );
868 $this->setCachedLastEditTime( $now );
869 $this->mLatest = $revision->getId();
870 $this->mIsRedirect = (bool)$rt;
871 # Update the LinkCache.
872 LinkCache::singleton()->addGoodLinkObj( $this->getId(), $this->mTitle, $len, $this->mIsRedirect, $this->mLatest );
873 }
874
875 wfProfileOut( __METHOD__ );
876 return $result;
877 }
878
879 /**
880 * Get the cached timestamp for the last time the page changed.
881 * This is only used to help handle slave lag by comparing to page_touched.
882 * @return string MW timestamp
883 */
884 protected function getCachedLastEditTime() {
885 global $wgMemc;
886 $key = wfMemcKey( 'page-lastedit', md5( $this->mTitle->getPrefixedDBkey() ) );
887 return $wgMemc->get( $key );
888 }
889
890 /**
891 * Set the cached timestamp for the last time the page changed.
892 * This is only used to help handle slave lag by comparing to page_touched.
893 * @param $timestamp string
894 * @return void
895 */
896 public function setCachedLastEditTime( $timestamp ) {
897 global $wgMemc;
898 $key = wfMemcKey( 'page-lastedit', md5( $this->mTitle->getPrefixedDBkey() ) );
899 $wgMemc->set( $key, wfTimestamp( TS_MW, $timestamp ), 60*15 );
900 }
901
902 /**
903 * Add row to the redirect table if this is a redirect, remove otherwise.
904 *
905 * @param $dbw DatabaseBase
906 * @param $redirectTitle Title object pointing to the redirect target,
907 * or NULL if this is not a redirect
908 * @param $lastRevIsRedirect If given, will optimize adding and
909 * removing rows in redirect table.
910 * @return bool true on success, false on failure
911 * @private
912 */
913 public function updateRedirectOn( $dbw, $redirectTitle, $lastRevIsRedirect = null ) {
914 // Always update redirects (target link might have changed)
915 // Update/Insert if we don't know if the last revision was a redirect or not
916 // Delete if changing from redirect to non-redirect
917 $isRedirect = !is_null( $redirectTitle );
918
919 if ( !$isRedirect && !is_null( $lastRevIsRedirect ) && $lastRevIsRedirect === $isRedirect ) {
920 return true;
921 }
922
923 wfProfileIn( __METHOD__ );
924 if ( $isRedirect ) {
925 $this->insertRedirectEntry( $redirectTitle );
926 } else {
927 // This is not a redirect, remove row from redirect table
928 $where = array( 'rd_from' => $this->getId() );
929 $dbw->delete( 'redirect', $where, __METHOD__ );
930 }
931
932 if ( $this->getTitle()->getNamespace() == NS_FILE ) {
933 RepoGroup::singleton()->getLocalRepo()->invalidateImageRedirect( $this->getTitle() );
934 }
935 wfProfileOut( __METHOD__ );
936
937 return ( $dbw->affectedRows() != 0 );
938 }
939
940 /**
941 * If the given revision is newer than the currently set page_latest,
942 * update the page record. Otherwise, do nothing.
943 *
944 * @param $dbw Database object
945 * @param $revision Revision object
946 * @return mixed
947 */
948 public function updateIfNewerOn( $dbw, $revision ) {
949 wfProfileIn( __METHOD__ );
950
951 $row = $dbw->selectRow(
952 array( 'revision', 'page' ),
953 array( 'rev_id', 'rev_timestamp', 'page_is_redirect' ),
954 array(
955 'page_id' => $this->getId(),
956 'page_latest=rev_id' ),
957 __METHOD__ );
958
959 if ( $row ) {
960 if ( wfTimestamp( TS_MW, $row->rev_timestamp ) >= $revision->getTimestamp() ) {
961 wfProfileOut( __METHOD__ );
962 return false;
963 }
964 $prev = $row->rev_id;
965 $lastRevIsRedirect = (bool)$row->page_is_redirect;
966 } else {
967 # No or missing previous revision; mark the page as new
968 $prev = 0;
969 $lastRevIsRedirect = null;
970 }
971
972 $ret = $this->updateRevisionOn( $dbw, $revision, $prev, $lastRevIsRedirect );
973
974 wfProfileOut( __METHOD__ );
975 return $ret;
976 }
977
978 /**
979 * @param $section empty/null/false or a section number (0, 1, 2, T1, T2...)
980 * @param $text String: new text of the section
981 * @param $sectionTitle String: new section's subject, only if $section is 'new'
982 * @param $edittime String: revision timestamp or null to use the current revision
983 * @return string Complete article text, or null if error
984 */
985 public function replaceSection( $section, $text, $sectionTitle = '', $edittime = null ) {
986 wfProfileIn( __METHOD__ );
987
988 if ( strval( $section ) == '' ) {
989 // Whole-page edit; let the whole text through
990 } else {
991 // Bug 30711: always use current version when adding a new section
992 if ( is_null( $edittime ) || $section == 'new' ) {
993 $oldtext = $this->getRawText();
994 if ( $oldtext === false ) {
995 wfDebug( __METHOD__ . ": no page text\n" );
996 return null;
997 }
998 } else {
999 $dbw = wfGetDB( DB_MASTER );
1000 $rev = Revision::loadFromTimestamp( $dbw, $this->mTitle, $edittime );
1001
1002 if ( !$rev ) {
1003 wfDebug( "WikiPage::replaceSection asked for bogus section (page: " .
1004 $this->getId() . "; section: $section; edittime: $edittime)\n" );
1005 wfProfileOut( __METHOD__ );
1006 return null;
1007 }
1008
1009 $oldtext = $rev->getText();
1010 }
1011
1012 if ( $section == 'new' ) {
1013 # Inserting a new section
1014 $subject = $sectionTitle ? wfMsgForContent( 'newsectionheaderdefaultlevel', $sectionTitle ) . "\n\n" : '';
1015 if ( wfRunHooks( 'PlaceNewSection', array( $this, $oldtext, $subject, &$text ) ) ) {
1016 $text = strlen( trim( $oldtext ) ) > 0
1017 ? "{$oldtext}\n\n{$subject}{$text}"
1018 : "{$subject}{$text}";
1019 }
1020 } else {
1021 # Replacing an existing section; roll out the big guns
1022 global $wgParser;
1023
1024 $text = $wgParser->replaceSection( $oldtext, $section, $text );
1025 }
1026 }
1027
1028 wfProfileOut( __METHOD__ );
1029 return $text;
1030 }
1031
1032 /**
1033 * Check flags and add EDIT_NEW or EDIT_UPDATE to them as needed.
1034 * @param $flags Int
1035 * @return Int updated $flags
1036 */
1037 function checkFlags( $flags ) {
1038 if ( !( $flags & EDIT_NEW ) && !( $flags & EDIT_UPDATE ) ) {
1039 if ( $this->mTitle->getArticleID() ) {
1040 $flags |= EDIT_UPDATE;
1041 } else {
1042 $flags |= EDIT_NEW;
1043 }
1044 }
1045
1046 return $flags;
1047 }
1048
1049 /**
1050 * Change an existing article or create a new article. Updates RC and all necessary caches,
1051 * optionally via the deferred update array.
1052 *
1053 * @param $text String: new text
1054 * @param $summary String: edit summary
1055 * @param $flags Integer bitfield:
1056 * EDIT_NEW
1057 * Article is known or assumed to be non-existent, create a new one
1058 * EDIT_UPDATE
1059 * Article is known or assumed to be pre-existing, update it
1060 * EDIT_MINOR
1061 * Mark this edit minor, if the user is allowed to do so
1062 * EDIT_SUPPRESS_RC
1063 * Do not log the change in recentchanges
1064 * EDIT_FORCE_BOT
1065 * Mark the edit a "bot" edit regardless of user rights
1066 * EDIT_DEFER_UPDATES
1067 * Defer some of the updates until the end of index.php
1068 * EDIT_AUTOSUMMARY
1069 * Fill in blank summaries with generated text where possible
1070 *
1071 * If neither EDIT_NEW nor EDIT_UPDATE is specified, the status of the article will be detected.
1072 * If EDIT_UPDATE is specified and the article doesn't exist, the function will return an
1073 * edit-gone-missing error. If EDIT_NEW is specified and the article does exist, an
1074 * edit-already-exists error will be returned. These two conditions are also possible with
1075 * auto-detection due to MediaWiki's performance-optimised locking strategy.
1076 *
1077 * @param $baseRevId the revision ID this edit was based off, if any
1078 * @param $user User the user doing the edit
1079 *
1080 * @return Status object. Possible errors:
1081 * edit-hook-aborted: The ArticleSave hook aborted the edit but didn't set the fatal flag of $status
1082 * edit-gone-missing: In update mode, but the article didn't exist
1083 * edit-conflict: In update mode, the article changed unexpectedly
1084 * edit-no-change: Warning that the text was the same as before
1085 * edit-already-exists: In creation mode, but the article already exists
1086 *
1087 * Extensions may define additional errors.
1088 *
1089 * $return->value will contain an associative array with members as follows:
1090 * new: Boolean indicating if the function attempted to create a new article
1091 * revision: The revision object for the inserted revision, or null
1092 *
1093 * Compatibility note: this function previously returned a boolean value indicating success/failure
1094 */
1095 public function doEdit( $text, $summary, $flags = 0, $baseRevId = false, $user = null ) {
1096 global $wgUser, $wgDBtransactions, $wgUseAutomaticEditSummaries;
1097
1098 # Low-level sanity check
1099 if ( $this->mTitle->getText() === '' ) {
1100 throw new MWException( 'Something is trying to edit an article with an empty title' );
1101 }
1102
1103 wfProfileIn( __METHOD__ );
1104
1105 $user = is_null( $user ) ? $wgUser : $user;
1106 $status = Status::newGood( array() );
1107
1108 # Load $this->mTitle->getArticleID() and $this->mLatest if it's not already
1109 $this->loadPageData( 'fromdbmaster' );
1110
1111 $flags = $this->checkFlags( $flags );
1112
1113 if ( !wfRunHooks( 'ArticleSave', array( &$this, &$user, &$text, &$summary,
1114 $flags & EDIT_MINOR, null, null, &$flags, &$status ) ) )
1115 {
1116 wfDebug( __METHOD__ . ": ArticleSave hook aborted save!\n" );
1117
1118 if ( $status->isOK() ) {
1119 $status->fatal( 'edit-hook-aborted' );
1120 }
1121
1122 wfProfileOut( __METHOD__ );
1123 return $status;
1124 }
1125
1126 # Silently ignore EDIT_MINOR if not allowed
1127 $isminor = ( $flags & EDIT_MINOR ) && $user->isAllowed( 'minoredit' );
1128 $bot = $flags & EDIT_FORCE_BOT;
1129
1130 $oldtext = $this->getRawText(); // current revision
1131 $oldsize = strlen( $oldtext );
1132 $oldid = $this->getLatest();
1133 $oldIsRedirect = $this->isRedirect();
1134 $oldcountable = $this->isCountable();
1135
1136 # Provide autosummaries if one is not provided and autosummaries are enabled.
1137 if ( $wgUseAutomaticEditSummaries && $flags & EDIT_AUTOSUMMARY && $summary == '' ) {
1138 $summary = self::getAutosummary( $oldtext, $text, $flags );
1139 }
1140
1141 $editInfo = $this->prepareTextForEdit( $text, null, $user );
1142 $text = $editInfo->pst;
1143 $newsize = strlen( $text );
1144
1145 $dbw = wfGetDB( DB_MASTER );
1146 $now = wfTimestampNow();
1147 $this->mTimestamp = $now;
1148
1149 if ( $flags & EDIT_UPDATE ) {
1150 # Update article, but only if changed.
1151 $status->value['new'] = false;
1152
1153 # Make sure the revision is either completely inserted or not inserted at all
1154 if ( !$wgDBtransactions ) {
1155 $userAbort = ignore_user_abort( true );
1156 }
1157
1158 $revision = new Revision( array(
1159 'page' => $this->getId(),
1160 'comment' => $summary,
1161 'minor_edit' => $isminor,
1162 'text' => $text,
1163 'parent_id' => $oldid,
1164 'user' => $user->getId(),
1165 'user_text' => $user->getName(),
1166 'timestamp' => $now
1167 ) );
1168
1169 $changed = ( strcmp( $text, $oldtext ) != 0 );
1170
1171 if ( $changed ) {
1172 if ( !$this->mLatest ) {
1173 # Article gone missing
1174 wfDebug( __METHOD__ . ": EDIT_UPDATE specified but article doesn't exist\n" );
1175 $status->fatal( 'edit-gone-missing' );
1176
1177 wfProfileOut( __METHOD__ );
1178 return $status;
1179 }
1180
1181 $dbw->begin();
1182 $revisionId = $revision->insertOn( $dbw );
1183
1184 # Update page
1185 #
1186 # Note that we use $this->mLatest instead of fetching a value from the master DB
1187 # during the course of this function. This makes sure that EditPage can detect
1188 # edit conflicts reliably, either by $ok here, or by $article->getTimestamp()
1189 # before this function is called. A previous function used a separate query, this
1190 # creates a window where concurrent edits can cause an ignored edit conflict.
1191 $ok = $this->updateRevisionOn( $dbw, $revision, $oldid, $oldIsRedirect );
1192
1193 if ( !$ok ) {
1194 /* Belated edit conflict! Run away!! */
1195 $status->fatal( 'edit-conflict' );
1196
1197 # Delete the invalid revision if the DB is not transactional
1198 if ( !$wgDBtransactions ) {
1199 $dbw->delete( 'revision', array( 'rev_id' => $revisionId ), __METHOD__ );
1200 }
1201
1202 $revisionId = 0;
1203 $dbw->rollback();
1204 } else {
1205 global $wgUseRCPatrol;
1206 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $revision, $baseRevId, $user ) );
1207 # Update recentchanges
1208 if ( !( $flags & EDIT_SUPPRESS_RC ) ) {
1209 # Mark as patrolled if the user can do so
1210 $patrolled = $wgUseRCPatrol && !count(
1211 $this->mTitle->getUserPermissionsErrors( 'autopatrol', $user ) );
1212 # Add RC row to the DB
1213 $rc = RecentChange::notifyEdit( $now, $this->mTitle, $isminor, $user, $summary,
1214 $oldid, $this->getTimestamp(), $bot, '', $oldsize, $newsize,
1215 $revisionId, $patrolled
1216 );
1217
1218 # Log auto-patrolled edits
1219 if ( $patrolled ) {
1220 PatrolLog::record( $rc, true );
1221 }
1222 }
1223 $user->incEditCount();
1224 $dbw->commit();
1225 }
1226 }
1227
1228 if ( !$wgDBtransactions ) {
1229 ignore_user_abort( $userAbort );
1230 }
1231
1232 // Now that ignore_user_abort is restored, we can respond to fatal errors
1233 if ( !$status->isOK() ) {
1234 wfProfileOut( __METHOD__ );
1235 return $status;
1236 }
1237
1238 # Update links tables, site stats, etc.
1239 $this->doEditUpdates( $revision, $user, array( 'changed' => $changed,
1240 'oldcountable' => $oldcountable ) );
1241
1242 if ( !$changed ) {
1243 $status->warning( 'edit-no-change' );
1244 $revision = null;
1245 // Keep the same revision ID, but do some updates on it
1246 $revisionId = $this->getLatest();
1247 // Update page_touched, this is usually implicit in the page update
1248 // Other cache updates are done in onArticleEdit()
1249 $this->mTitle->invalidateCache();
1250 }
1251 } else {
1252 # Create new article
1253 $status->value['new'] = true;
1254
1255 $dbw->begin();
1256
1257 # Add the page record; stake our claim on this title!
1258 # This will return false if the article already exists
1259 $newid = $this->insertOn( $dbw );
1260
1261 if ( $newid === false ) {
1262 $dbw->rollback();
1263 $status->fatal( 'edit-already-exists' );
1264
1265 wfProfileOut( __METHOD__ );
1266 return $status;
1267 }
1268
1269 # Save the revision text...
1270 $revision = new Revision( array(
1271 'page' => $newid,
1272 'comment' => $summary,
1273 'minor_edit' => $isminor,
1274 'text' => $text,
1275 'user' => $user->getId(),
1276 'user_text' => $user->getName(),
1277 'timestamp' => $now
1278 ) );
1279 $revisionId = $revision->insertOn( $dbw );
1280
1281 # Update the page record with revision data
1282 $this->updateRevisionOn( $dbw, $revision, 0 );
1283
1284 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $revision, false, $user ) );
1285
1286 # Update recentchanges
1287 if ( !( $flags & EDIT_SUPPRESS_RC ) ) {
1288 global $wgUseRCPatrol, $wgUseNPPatrol;
1289
1290 # Mark as patrolled if the user can do so
1291 $patrolled = ( $wgUseRCPatrol || $wgUseNPPatrol ) && !count(
1292 $this->mTitle->getUserPermissionsErrors( 'autopatrol', $user ) );
1293 # Add RC row to the DB
1294 $rc = RecentChange::notifyNew( $now, $this->mTitle, $isminor, $user, $summary, $bot,
1295 '', strlen( $text ), $revisionId, $patrolled );
1296
1297 # Log auto-patrolled edits
1298 if ( $patrolled ) {
1299 PatrolLog::record( $rc, true );
1300 }
1301 }
1302 $user->incEditCount();
1303 $dbw->commit();
1304
1305 # Update links, etc.
1306 $this->doEditUpdates( $revision, $user, array( 'created' => true ) );
1307
1308 wfRunHooks( 'ArticleInsertComplete', array( &$this, &$user, $text, $summary,
1309 $flags & EDIT_MINOR, null, null, &$flags, $revision ) );
1310 }
1311
1312 # Do updates right now unless deferral was requested
1313 if ( !( $flags & EDIT_DEFER_UPDATES ) ) {
1314 DeferredUpdates::doUpdates();
1315 }
1316
1317 // Return the new revision (or null) to the caller
1318 $status->value['revision'] = $revision;
1319
1320 wfRunHooks( 'ArticleSaveComplete', array( &$this, &$user, $text, $summary,
1321 $flags & EDIT_MINOR, null, null, &$flags, $revision, &$status, $baseRevId ) );
1322
1323 # Promote user to any groups they meet the criteria for
1324 $user->addAutopromoteOnceGroups( 'onEdit' );
1325
1326 wfProfileOut( __METHOD__ );
1327 return $status;
1328 }
1329
1330 /**
1331 * Update the article's restriction field, and leave a log entry.
1332 * This works for protection both existing and non-existing pages.
1333 *
1334 * @param $limit Array: set of restriction keys
1335 * @param $reason String
1336 * @param &$cascade Integer. Set to false if cascading protection isn't allowed.
1337 * @param $expiry Array: per restriction type expiration
1338 * @param $user User The user updating the restrictions
1339 * @return bool true on success
1340 */
1341 public function doUpdateRestrictions( array $limit, array $expiry, &$cascade, $reason, User $user ) {
1342 global $wgContLang;
1343
1344 if ( wfReadOnly() ) {
1345 return Status::newFatal( 'readonlytext', wfReadOnlyReason() );
1346 }
1347
1348 $restrictionTypes = $this->mTitle->getRestrictionTypes();
1349
1350 $id = $this->mTitle->getArticleID();
1351
1352 if ( !$cascade ) {
1353 $cascade = false;
1354 }
1355
1356 // Take this opportunity to purge out expired restrictions
1357 Title::purgeExpiredRestrictions();
1358
1359 # @todo FIXME: Same limitations as described in ProtectionForm.php (line 37);
1360 # we expect a single selection, but the schema allows otherwise.
1361 $isProtected = false;
1362 $protect = false;
1363 $changed = false;
1364
1365 $dbw = wfGetDB( DB_MASTER );
1366
1367 foreach ( $restrictionTypes as $action ) {
1368 if ( !isset( $expiry[$action] ) ) {
1369 $expiry[$action] = $dbw->getInfinity();
1370 }
1371 if ( !isset( $limit[$action] ) ) {
1372 $limit[$action] = '';
1373 } elseif ( $limit[$action] != '' ) {
1374 $protect = true;
1375 }
1376
1377 # Get current restrictions on $action
1378 $current = implode( '', $this->mTitle->getRestrictions( $action ) );
1379 if ( $current != '' ) {
1380 $isProtected = true;
1381 }
1382
1383 if ( $limit[$action] != $current ) {
1384 $changed = true;
1385 } elseif ( $limit[$action] != '' ) {
1386 # Only check expiry change if the action is actually being
1387 # protected, since expiry does nothing on an not-protected
1388 # action.
1389 if ( $this->mTitle->getRestrictionExpiry( $action ) != $expiry[$action] ) {
1390 $changed = true;
1391 }
1392 }
1393 }
1394
1395 if ( !$changed && $protect && $this->mTitle->areRestrictionsCascading() != $cascade ) {
1396 $changed = true;
1397 }
1398
1399 # If nothing's changed, do nothing
1400 if ( !$changed ) {
1401 return Status::newGood();
1402 }
1403
1404 if ( !$protect ) { # No protection at all means unprotection
1405 $revCommentMsg = 'unprotectedarticle';
1406 $logAction = 'unprotect';
1407 } elseif ( $isProtected ) {
1408 $revCommentMsg = 'modifiedarticleprotection';
1409 $logAction = 'modify';
1410 } else {
1411 $revCommentMsg = 'protectedarticle';
1412 $logAction = 'protect';
1413 }
1414
1415 $encodedExpiry = array();
1416 $protectDescription = '';
1417 foreach ( $limit as $action => $restrictions ) {
1418 $encodedExpiry[$action] = $dbw->encodeExpiry( $expiry[$action] );
1419 if ( $restrictions != '' ) {
1420 $protectDescription .= $wgContLang->getDirMark() . "[$action=$restrictions] (";
1421 if ( $encodedExpiry[$action] != 'infinity' ) {
1422 $protectDescription .= wfMsgForContent( 'protect-expiring',
1423 $wgContLang->timeanddate( $expiry[$action], false, false ) ,
1424 $wgContLang->date( $expiry[$action], false, false ) ,
1425 $wgContLang->time( $expiry[$action], false, false ) );
1426 } else {
1427 $protectDescription .= wfMsgForContent( 'protect-expiry-indefinite' );
1428 }
1429
1430 $protectDescription .= ') ';
1431 }
1432 }
1433 $protectDescription = trim( $protectDescription );
1434
1435 if ( $id ) { # Protection of existing page
1436 if ( !wfRunHooks( 'ArticleProtect', array( &$this, &$user, $limit, $reason ) ) ) {
1437 return Status::newGood();
1438 }
1439
1440 # Only restrictions with the 'protect' right can cascade...
1441 # Otherwise, people who cannot normally protect can "protect" pages via transclusion
1442 $editrestriction = isset( $limit['edit'] ) ? array( $limit['edit'] ) : $this->mTitle->getRestrictions( 'edit' );
1443
1444 # The schema allows multiple restrictions
1445 if ( !in_array( 'protect', $editrestriction ) && !in_array( 'sysop', $editrestriction ) ) {
1446 $cascade = false;
1447 }
1448
1449 # Update restrictions table
1450 foreach ( $limit as $action => $restrictions ) {
1451 if ( $restrictions != '' ) {
1452 $dbw->replace( 'page_restrictions', array( array( 'pr_page', 'pr_type' ) ),
1453 array( 'pr_page' => $id,
1454 'pr_type' => $action,
1455 'pr_level' => $restrictions,
1456 'pr_cascade' => ( $cascade && $action == 'edit' ) ? 1 : 0,
1457 'pr_expiry' => $encodedExpiry[$action]
1458 ),
1459 __METHOD__
1460 );
1461 } else {
1462 $dbw->delete( 'page_restrictions', array( 'pr_page' => $id,
1463 'pr_type' => $action ), __METHOD__ );
1464 }
1465 }
1466
1467 # Prepare a null revision to be added to the history
1468 $editComment = $wgContLang->ucfirst( wfMsgForContent( $revCommentMsg, $this->mTitle->getPrefixedText() ) );
1469 if ( $reason ) {
1470 $editComment .= ": $reason";
1471 }
1472 if ( $protectDescription ) {
1473 $editComment .= " ($protectDescription)";
1474 }
1475 if ( $cascade ) {
1476 $editComment .= ' [' . wfMsgForContent( 'protect-summary-cascade' ) . ']';
1477 }
1478
1479 # Insert a null revision
1480 $nullRevision = Revision::newNullRevision( $dbw, $id, $editComment, true );
1481 $nullRevId = $nullRevision->insertOn( $dbw );
1482
1483 $latest = $this->getLatest();
1484 # Update page record
1485 $dbw->update( 'page',
1486 array( /* SET */
1487 'page_touched' => $dbw->timestamp(),
1488 'page_restrictions' => '',
1489 'page_latest' => $nullRevId
1490 ), array( /* WHERE */
1491 'page_id' => $id
1492 ), __METHOD__
1493 );
1494
1495 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $nullRevision, $latest, $user ) );
1496 wfRunHooks( 'ArticleProtectComplete', array( &$this, &$user, $limit, $reason ) );
1497 } else { # Protection of non-existing page (also known as "title protection")
1498 # Cascade protection is meaningless in this case
1499 $cascade = false;
1500
1501 if ( $limit['create'] != '' ) {
1502 $dbw->replace( 'protected_titles',
1503 array( array( 'pt_namespace', 'pt_title' ) ),
1504 array(
1505 'pt_namespace' => $this->mTitle->getNamespace(),
1506 'pt_title' => $this->mTitle->getDBkey(),
1507 'pt_create_perm' => $limit['create'],
1508 'pt_timestamp' => $dbw->encodeExpiry( wfTimestampNow() ),
1509 'pt_expiry' => $encodedExpiry['create'],
1510 'pt_user' => $user->getId(),
1511 'pt_reason' => $reason,
1512 ), __METHOD__
1513 );
1514 } else {
1515 $dbw->delete( 'protected_titles',
1516 array(
1517 'pt_namespace' => $this->mTitle->getNamespace(),
1518 'pt_title' => $this->mTitle->getDBkey()
1519 ), __METHOD__
1520 );
1521 }
1522 }
1523
1524 $this->mTitle->flushRestrictions();
1525
1526 if ( $logAction == 'unprotect' ) {
1527 $logParams = array();
1528 } else {
1529 $logParams = array( $protectDescription, $cascade ? 'cascade' : '' );
1530 }
1531
1532 # Update the protection log
1533 $log = new LogPage( 'protect' );
1534 $log->addEntry( $logAction, $this->mTitle, trim( $reason ), $logParams, $user );
1535
1536 return Status::newGood();
1537 }
1538
1539 /**
1540 * Take an array of page restrictions and flatten it to a string
1541 * suitable for insertion into the page_restrictions field.
1542 * @param $limit Array
1543 * @return String
1544 */
1545 protected static function flattenRestrictions( $limit ) {
1546 if ( !is_array( $limit ) ) {
1547 throw new MWException( 'WikiPage::flattenRestrictions given non-array restriction set' );
1548 }
1549
1550 $bits = array();
1551 ksort( $limit );
1552
1553 foreach ( $limit as $action => $restrictions ) {
1554 if ( $restrictions != '' ) {
1555 $bits[] = "$action=$restrictions";
1556 }
1557 }
1558
1559 return implode( ':', $bits );
1560 }
1561
1562 /**
1563 * Check whether the number of revisions of this page surpasses $wgDeleteRevisionsLimit
1564 *
1565 * @deprecated in 1.19; use Title::isBigDeletion() instead.
1566 * @return bool
1567 */
1568 public function isBigDeletion() {
1569 wfDeprecated( __METHOD__, '1.19' );
1570 return $this->mTitle->isBigDeletion();
1571 }
1572
1573 /**
1574 * Get the approximate revision count of this page.
1575 *
1576 * @deprecated in 1.19; use Title::estimateRevisionCount() instead.
1577 * @return int
1578 */
1579 public function estimateRevisionCount() {
1580 wfDeprecated( __METHOD__, '1.19' );
1581 return $this->mTitle->estimateRevisionCount();
1582 }
1583
1584 /**
1585 * Get the last N authors
1586 * @param $num Integer: number of revisions to get
1587 * @param $revLatest String: the latest rev_id, selected from the master (optional)
1588 * @return array Array of authors, duplicates not removed
1589 */
1590 public function getLastNAuthors( $num, $revLatest = 0 ) {
1591 wfProfileIn( __METHOD__ );
1592 // First try the slave
1593 // If that doesn't have the latest revision, try the master
1594 $continue = 2;
1595 $db = wfGetDB( DB_SLAVE );
1596
1597 do {
1598 $res = $db->select( array( 'page', 'revision' ),
1599 array( 'rev_id', 'rev_user_text' ),
1600 array(
1601 'page_namespace' => $this->mTitle->getNamespace(),
1602 'page_title' => $this->mTitle->getDBkey(),
1603 'rev_page = page_id'
1604 ), __METHOD__,
1605 array(
1606 'ORDER BY' => 'rev_timestamp DESC',
1607 'LIMIT' => $num
1608 )
1609 );
1610
1611 if ( !$res ) {
1612 wfProfileOut( __METHOD__ );
1613 return array();
1614 }
1615
1616 $row = $db->fetchObject( $res );
1617
1618 if ( $continue == 2 && $revLatest && $row->rev_id != $revLatest ) {
1619 $db = wfGetDB( DB_MASTER );
1620 $continue--;
1621 } else {
1622 $continue = 0;
1623 }
1624 } while ( $continue );
1625
1626 $authors = array( $row->rev_user_text );
1627
1628 foreach ( $res as $row ) {
1629 $authors[] = $row->rev_user_text;
1630 }
1631
1632 wfProfileOut( __METHOD__ );
1633 return $authors;
1634 }
1635
1636 /**
1637 * Back-end article deletion
1638 * Deletes the article with database consistency, writes logs, purges caches
1639 *
1640 * @param $reason string delete reason for deletion log
1641 * @param $suppress bitfield
1642 * Revision::DELETED_TEXT
1643 * Revision::DELETED_COMMENT
1644 * Revision::DELETED_USER
1645 * Revision::DELETED_RESTRICTED
1646 * @param $id int article ID
1647 * @param $commit boolean defaults to true, triggers transaction end
1648 * @param &$errors Array of errors to append to
1649 * @param $user User The relevant user
1650 * @return boolean true if successful
1651 */
1652 public function doDeleteArticle(
1653 $reason, $suppress = false, $id = 0, $commit = true, &$error = '', User $user = null
1654 ) {
1655 global $wgUser;
1656 $user = is_null( $user ) ? $wgUser : $user;
1657
1658 wfDebug( __METHOD__ . "\n" );
1659
1660 if ( ! wfRunHooks( 'ArticleDelete', array( &$this, &$user, &$reason, &$error ) ) ) {
1661 return false;
1662 }
1663 $dbw = wfGetDB( DB_MASTER );
1664 $t = $this->mTitle->getDBkey();
1665 $id = $id ? $id : $this->mTitle->getArticleID( Title::GAID_FOR_UPDATE );
1666
1667 if ( $t === '' || $id == 0 ) {
1668 return false;
1669 }
1670
1671 DeferredUpdates::addUpdate(
1672 new SiteStatsUpdate( 0, 1, - (int)$this->isCountable(), -1 )
1673 );
1674
1675 // Bitfields to further suppress the content
1676 if ( $suppress ) {
1677 $bitfield = 0;
1678 // This should be 15...
1679 $bitfield |= Revision::DELETED_TEXT;
1680 $bitfield |= Revision::DELETED_COMMENT;
1681 $bitfield |= Revision::DELETED_USER;
1682 $bitfield |= Revision::DELETED_RESTRICTED;
1683 } else {
1684 $bitfield = 'rev_deleted';
1685 }
1686
1687 $dbw->begin();
1688 // For now, shunt the revision data into the archive table.
1689 // Text is *not* removed from the text table; bulk storage
1690 // is left intact to avoid breaking block-compression or
1691 // immutable storage schemes.
1692 //
1693 // For backwards compatibility, note that some older archive
1694 // table entries will have ar_text and ar_flags fields still.
1695 //
1696 // In the future, we may keep revisions and mark them with
1697 // the rev_deleted field, which is reserved for this purpose.
1698 $dbw->insertSelect( 'archive', array( 'page', 'revision' ),
1699 array(
1700 'ar_namespace' => 'page_namespace',
1701 'ar_title' => 'page_title',
1702 'ar_comment' => 'rev_comment',
1703 'ar_user' => 'rev_user',
1704 'ar_user_text' => 'rev_user_text',
1705 'ar_timestamp' => 'rev_timestamp',
1706 'ar_minor_edit' => 'rev_minor_edit',
1707 'ar_rev_id' => 'rev_id',
1708 'ar_parent_id' => 'rev_parent_id',
1709 'ar_text_id' => 'rev_text_id',
1710 'ar_text' => '\'\'', // Be explicit to appease
1711 'ar_flags' => '\'\'', // MySQL's "strict mode"...
1712 'ar_len' => 'rev_len',
1713 'ar_page_id' => 'page_id',
1714 'ar_deleted' => $bitfield,
1715 'ar_sha1' => 'rev_sha1'
1716 ), array(
1717 'page_id' => $id,
1718 'page_id = rev_page'
1719 ), __METHOD__
1720 );
1721
1722 # Delete restrictions for it
1723 $dbw->delete( 'page_restrictions', array ( 'pr_page' => $id ), __METHOD__ );
1724
1725 # Now that it's safely backed up, delete it
1726 $dbw->delete( 'page', array( 'page_id' => $id ), __METHOD__ );
1727 $ok = ( $dbw->affectedRows() > 0 ); // getArticleId() uses slave, could be laggy
1728
1729 if ( !$ok ) {
1730 $dbw->rollback();
1731 return false;
1732 }
1733
1734 # Fix category table counts
1735 $cats = array();
1736 $res = $dbw->select( 'categorylinks', 'cl_to', array( 'cl_from' => $id ), __METHOD__ );
1737
1738 foreach ( $res as $row ) {
1739 $cats [] = $row->cl_to;
1740 }
1741
1742 $this->updateCategoryCounts( array(), $cats );
1743
1744 # If using cascading deletes, we can skip some explicit deletes
1745 if ( !$dbw->cascadingDeletes() ) {
1746 $dbw->delete( 'revision', array( 'rev_page' => $id ), __METHOD__ );
1747
1748 # Delete outgoing links
1749 $dbw->delete( 'pagelinks', array( 'pl_from' => $id ), __METHOD__ );
1750 $dbw->delete( 'imagelinks', array( 'il_from' => $id ), __METHOD__ );
1751 $dbw->delete( 'categorylinks', array( 'cl_from' => $id ), __METHOD__ );
1752 $dbw->delete( 'templatelinks', array( 'tl_from' => $id ), __METHOD__ );
1753 $dbw->delete( 'externallinks', array( 'el_from' => $id ), __METHOD__ );
1754 $dbw->delete( 'langlinks', array( 'll_from' => $id ), __METHOD__ );
1755 $dbw->delete( 'iwlinks', array( 'iwl_from' => $id ), __METHOD__ );
1756 $dbw->delete( 'redirect', array( 'rd_from' => $id ), __METHOD__ );
1757 $dbw->delete( 'page_props', array( 'pp_page' => $id ), __METHOD__ );
1758 }
1759
1760 # If using cleanup triggers, we can skip some manual deletes
1761 if ( !$dbw->cleanupTriggers() ) {
1762 # Clean up recentchanges entries...
1763 $dbw->delete( 'recentchanges',
1764 array( 'rc_type != ' . RC_LOG,
1765 'rc_namespace' => $this->mTitle->getNamespace(),
1766 'rc_title' => $this->mTitle->getDBkey() ),
1767 __METHOD__ );
1768 $dbw->delete( 'recentchanges',
1769 array( 'rc_type != ' . RC_LOG, 'rc_cur_id' => $id ),
1770 __METHOD__ );
1771 }
1772
1773 # Clear caches
1774 self::onArticleDelete( $this->mTitle );
1775
1776 # Clear the cached article id so the interface doesn't act like we exist
1777 $this->mTitle->resetArticleID( 0 );
1778
1779 # Log the deletion, if the page was suppressed, log it at Oversight instead
1780 $logtype = $suppress ? 'suppress' : 'delete';
1781
1782 $logEntry = new ManualLogEntry( $logtype, 'delete' );
1783 $logEntry->setPerformer( $user );
1784 $logEntry->setTarget( $this->mTitle );
1785 $logEntry->setComment( $reason );
1786 $logid = $logEntry->insert();
1787 $logEntry->publish( $logid );
1788
1789 if ( $commit ) {
1790 $dbw->commit();
1791 }
1792
1793 wfRunHooks( 'ArticleDeleteComplete', array( &$this, &$user, $reason, $id ) );
1794 return true;
1795 }
1796
1797 /**
1798 * Roll back the most recent consecutive set of edits to a page
1799 * from the same user; fails if there are no eligible edits to
1800 * roll back to, e.g. user is the sole contributor. This function
1801 * performs permissions checks on $user, then calls commitRollback()
1802 * to do the dirty work
1803 *
1804 * @todo: seperate the business/permission stuff out from backend code
1805 *
1806 * @param $fromP String: Name of the user whose edits to rollback.
1807 * @param $summary String: Custom summary. Set to default summary if empty.
1808 * @param $token String: Rollback token.
1809 * @param $bot Boolean: If true, mark all reverted edits as bot.
1810 *
1811 * @param $resultDetails Array: contains result-specific array of additional values
1812 * 'alreadyrolled' : 'current' (rev)
1813 * success : 'summary' (str), 'current' (rev), 'target' (rev)
1814 *
1815 * @param $user User The user performing the rollback
1816 * @return array of errors, each error formatted as
1817 * array(messagekey, param1, param2, ...).
1818 * On success, the array is empty. This array can also be passed to
1819 * OutputPage::showPermissionsErrorPage().
1820 */
1821 public function doRollback(
1822 $fromP, $summary, $token, $bot, &$resultDetails, User $user
1823 ) {
1824 $resultDetails = null;
1825
1826 # Check permissions
1827 $editErrors = $this->mTitle->getUserPermissionsErrors( 'edit', $user );
1828 $rollbackErrors = $this->mTitle->getUserPermissionsErrors( 'rollback', $user );
1829 $errors = array_merge( $editErrors, wfArrayDiff2( $rollbackErrors, $editErrors ) );
1830
1831 if ( !$user->matchEditToken( $token, array( $this->mTitle->getPrefixedText(), $fromP ) ) ) {
1832 $errors[] = array( 'sessionfailure' );
1833 }
1834
1835 if ( $user->pingLimiter( 'rollback' ) || $user->pingLimiter() ) {
1836 $errors[] = array( 'actionthrottledtext' );
1837 }
1838
1839 # If there were errors, bail out now
1840 if ( !empty( $errors ) ) {
1841 return $errors;
1842 }
1843
1844 return $this->commitRollback( $fromP, $summary, $bot, $resultDetails, $user );
1845 }
1846
1847 /**
1848 * Backend implementation of doRollback(), please refer there for parameter
1849 * and return value documentation
1850 *
1851 * NOTE: This function does NOT check ANY permissions, it just commits the
1852 * rollback to the DB. Therefore, you should only call this function direct-
1853 * ly if you want to use custom permissions checks. If you don't, use
1854 * doRollback() instead.
1855 * @param $fromP String: Name of the user whose edits to rollback.
1856 * @param $summary String: Custom summary. Set to default summary if empty.
1857 * @param $bot Boolean: If true, mark all reverted edits as bot.
1858 *
1859 * @param $resultDetails Array: contains result-specific array of additional values
1860 * @param $guser User The user performing the rollback
1861 */
1862 public function commitRollback( $fromP, $summary, $bot, &$resultDetails, User $guser ) {
1863 global $wgUseRCPatrol, $wgContLang;
1864
1865 $dbw = wfGetDB( DB_MASTER );
1866
1867 if ( wfReadOnly() ) {
1868 return array( array( 'readonlytext' ) );
1869 }
1870
1871 # Get the last editor
1872 $current = Revision::newFromTitle( $this->mTitle );
1873 if ( is_null( $current ) ) {
1874 # Something wrong... no page?
1875 return array( array( 'notanarticle' ) );
1876 }
1877
1878 $from = str_replace( '_', ' ', $fromP );
1879 # User name given should match up with the top revision.
1880 # If the user was deleted then $from should be empty.
1881 if ( $from != $current->getUserText() ) {
1882 $resultDetails = array( 'current' => $current );
1883 return array( array( 'alreadyrolled',
1884 htmlspecialchars( $this->mTitle->getPrefixedText() ),
1885 htmlspecialchars( $fromP ),
1886 htmlspecialchars( $current->getUserText() )
1887 ) );
1888 }
1889
1890 # Get the last edit not by this guy...
1891 # Note: these may not be public values
1892 $user = intval( $current->getRawUser() );
1893 $user_text = $dbw->addQuotes( $current->getRawUserText() );
1894 $s = $dbw->selectRow( 'revision',
1895 array( 'rev_id', 'rev_timestamp', 'rev_deleted' ),
1896 array( 'rev_page' => $current->getPage(),
1897 "rev_user != {$user} OR rev_user_text != {$user_text}"
1898 ), __METHOD__,
1899 array( 'USE INDEX' => 'page_timestamp',
1900 'ORDER BY' => 'rev_timestamp DESC' )
1901 );
1902 if ( $s === false ) {
1903 # No one else ever edited this page
1904 return array( array( 'cantrollback' ) );
1905 } elseif ( $s->rev_deleted & Revision::DELETED_TEXT || $s->rev_deleted & Revision::DELETED_USER ) {
1906 # Only admins can see this text
1907 return array( array( 'notvisiblerev' ) );
1908 }
1909
1910 $set = array();
1911 if ( $bot && $guser->isAllowed( 'markbotedits' ) ) {
1912 # Mark all reverted edits as bot
1913 $set['rc_bot'] = 1;
1914 }
1915
1916 if ( $wgUseRCPatrol ) {
1917 # Mark all reverted edits as patrolled
1918 $set['rc_patrolled'] = 1;
1919 }
1920
1921 if ( count( $set ) ) {
1922 $dbw->update( 'recentchanges', $set,
1923 array( /* WHERE */
1924 'rc_cur_id' => $current->getPage(),
1925 'rc_user_text' => $current->getUserText(),
1926 "rc_timestamp > '{$s->rev_timestamp}'",
1927 ), __METHOD__
1928 );
1929 }
1930
1931 # Generate the edit summary if necessary
1932 $target = Revision::newFromId( $s->rev_id );
1933 if ( empty( $summary ) ) {
1934 if ( $from == '' ) { // no public user name
1935 $summary = wfMsgForContent( 'revertpage-nouser' );
1936 } else {
1937 $summary = wfMsgForContent( 'revertpage' );
1938 }
1939 }
1940
1941 # Allow the custom summary to use the same args as the default message
1942 $args = array(
1943 $target->getUserText(), $from, $s->rev_id,
1944 $wgContLang->timeanddate( wfTimestamp( TS_MW, $s->rev_timestamp ) ),
1945 $current->getId(), $wgContLang->timeanddate( $current->getTimestamp() )
1946 );
1947 $summary = wfMsgReplaceArgs( $summary, $args );
1948
1949 # Save
1950 $flags = EDIT_UPDATE;
1951
1952 if ( $guser->isAllowed( 'minoredit' ) ) {
1953 $flags |= EDIT_MINOR;
1954 }
1955
1956 if ( $bot && ( $guser->isAllowedAny( 'markbotedits', 'bot' ) ) ) {
1957 $flags |= EDIT_FORCE_BOT;
1958 }
1959
1960 # Actually store the edit
1961 $status = $this->doEdit( $target->getText(), $summary, $flags, $target->getId() );
1962 if ( !empty( $status->value['revision'] ) ) {
1963 $revId = $status->value['revision']->getId();
1964 } else {
1965 $revId = false;
1966 }
1967
1968 wfRunHooks( 'ArticleRollbackComplete', array( $this, $guser, $target, $current ) );
1969
1970 $resultDetails = array(
1971 'summary' => $summary,
1972 'current' => $current,
1973 'target' => $target,
1974 'newid' => $revId
1975 );
1976
1977 return array();
1978 }
1979
1980 /**
1981 * Do standard deferred updates after page view
1982 * @param $user User The relevant user
1983 */
1984 public function doViewUpdates( User $user ) {
1985 global $wgDisableCounters;
1986 if ( wfReadOnly() ) {
1987 return;
1988 }
1989
1990 # Don't update page view counters on views from bot users (bug 14044)
1991 if ( !$wgDisableCounters && !$user->isAllowed( 'bot' ) && $this->mTitle->exists() ) {
1992 DeferredUpdates::addUpdate( new ViewCountUpdate( $this->getId() ) );
1993 DeferredUpdates::addUpdate( new SiteStatsUpdate( 1, 0, 0 ) );
1994 }
1995
1996 # Update newtalk / watchlist notification status
1997 $user->clearNotification( $this->mTitle );
1998 }
1999
2000 /**
2001 * Prepare text which is about to be saved.
2002 * Returns a stdclass with source, pst and output members
2003 */
2004 public function prepareTextForEdit( $text, $revid = null, User $user = null ) {
2005 global $wgParser, $wgContLang, $wgUser;
2006 $user = is_null( $user ) ? $wgUser : $user;
2007 // @TODO fixme: check $user->getId() here???
2008 if ( $this->mPreparedEdit
2009 && $this->mPreparedEdit->newText == $text
2010 && $this->mPreparedEdit->revid == $revid
2011 ) {
2012 // Already prepared
2013 return $this->mPreparedEdit;
2014 }
2015
2016 $popts = ParserOptions::newFromUserAndLang( $user, $wgContLang );
2017 wfRunHooks( 'ArticlePrepareTextForEdit', array( $this, $popts ) );
2018
2019 $edit = (object)array();
2020 $edit->revid = $revid;
2021 $edit->newText = $text;
2022 $edit->pst = $wgParser->preSaveTransform( $text, $this->mTitle, $user, $popts );
2023 $edit->popts = $this->makeParserOptions( 'canonical' );
2024
2025 // Bug 32858: For a CSS/JS page, put a blank parser output into the
2026 // prepared edit, so that links etc. won't be registered in the
2027 // database. We could have set $edit->output to false or something if
2028 // we thought of this bug earlier, but now that would break the
2029 // interface with AbuseFilter etc.
2030 if ( $this->mTitle->isCssOrJsPage() || $this->getTitle()->isCssJsSubpage() ) {
2031 $input = '';
2032 } else {
2033 $input = $edit->pst;
2034 }
2035 $edit->output = $wgParser->parse( $input, $this->mTitle, $edit->popts, true, true, $revid );
2036 $edit->oldText = $this->getRawText();
2037
2038 $this->mPreparedEdit = $edit;
2039
2040 return $edit;
2041 }
2042
2043 /**
2044 * Do standard deferred updates after page edit.
2045 * Update links tables, site stats, search index and message cache.
2046 * Purges pages that include this page if the text was changed here.
2047 * Every 100th edit, prune the recent changes table.
2048 *
2049 * @private
2050 * @param $revision Revision object
2051 * @param $user User object that did the revision
2052 * @param $options Array of options, following indexes are used:
2053 * - changed: boolean, whether the revision changed the content (default true)
2054 * - created: boolean, whether the revision created the page (default false)
2055 * - oldcountable: boolean or null (default null):
2056 * - boolean: whether the page was counted as an article before that
2057 * revision, only used in changed is true and created is false
2058 * - null: don't change the article count
2059 */
2060 public function doEditUpdates( Revision $revision, User $user, array $options = array() ) {
2061 global $wgEnableParserCache;
2062
2063 wfProfileIn( __METHOD__ );
2064
2065 $options += array( 'changed' => true, 'created' => false, 'oldcountable' => null );
2066 $text = $revision->getText();
2067
2068 # Parse the text
2069 # Be careful not to double-PST: $text is usually already PST-ed once
2070 if ( !$this->mPreparedEdit || $this->mPreparedEdit->output->getFlag( 'vary-revision' ) ) {
2071 wfDebug( __METHOD__ . ": No prepared edit or vary-revision is set...\n" );
2072 $editInfo = $this->prepareTextForEdit( $text, $revision->getId(), $user );
2073 } else {
2074 wfDebug( __METHOD__ . ": No vary-revision, using prepared edit...\n" );
2075 $editInfo = $this->mPreparedEdit;
2076 }
2077
2078 # Save it to the parser cache
2079 if ( $wgEnableParserCache ) {
2080 $parserCache = ParserCache::singleton();
2081 $parserCache->save( $editInfo->output, $this, $editInfo->popts );
2082 }
2083
2084 # Update the links tables
2085 $u = new LinksUpdate( $this->mTitle, $editInfo->output );
2086 $u->doUpdate();
2087
2088 wfRunHooks( 'ArticleEditUpdates', array( &$this, &$editInfo, $options['changed'] ) );
2089
2090 if ( wfRunHooks( 'ArticleEditUpdatesDeleteFromRecentchanges', array( &$this ) ) ) {
2091 if ( 0 == mt_rand( 0, 99 ) ) {
2092 // Flush old entries from the `recentchanges` table; we do this on
2093 // random requests so as to avoid an increase in writes for no good reason
2094 global $wgRCMaxAge;
2095
2096 $dbw = wfGetDB( DB_MASTER );
2097 $cutoff = $dbw->timestamp( time() - $wgRCMaxAge );
2098 $dbw->delete(
2099 'recentchanges',
2100 array( "rc_timestamp < '$cutoff'" ),
2101 __METHOD__
2102 );
2103 }
2104 }
2105
2106 if ( !$this->mTitle->exists() ) {
2107 wfProfileOut( __METHOD__ );
2108 return;
2109 }
2110
2111 $id = $this->getId();
2112 $title = $this->mTitle->getPrefixedDBkey();
2113 $shortTitle = $this->mTitle->getDBkey();
2114
2115 if ( !$options['changed'] ) {
2116 $good = 0;
2117 $total = 0;
2118 } elseif ( $options['created'] ) {
2119 $good = (int)$this->isCountable( $editInfo );
2120 $total = 1;
2121 } elseif ( $options['oldcountable'] !== null ) {
2122 $good = (int)$this->isCountable( $editInfo ) - (int)$options['oldcountable'];
2123 $total = 0;
2124 } else {
2125 $good = 0;
2126 $total = 0;
2127 }
2128
2129 DeferredUpdates::addUpdate( new SiteStatsUpdate( 0, 1, $good, $total ) );
2130 DeferredUpdates::addUpdate( new SearchUpdate( $id, $title, $text ) );
2131
2132 # If this is another user's talk page, update newtalk.
2133 # Don't do this if $options['changed'] = false (null-edits) nor if
2134 # it's a minor edit and the user doesn't want notifications for those.
2135 if ( $options['changed']
2136 && $this->mTitle->getNamespace() == NS_USER_TALK
2137 && $shortTitle != $user->getTitleKey()
2138 && !( $revision->isMinor() && $user->isAllowed( 'nominornewtalk' ) )
2139 ) {
2140 if ( wfRunHooks( 'ArticleEditUpdateNewTalk', array( &$this ) ) ) {
2141 $other = User::newFromName( $shortTitle, false );
2142 if ( !$other ) {
2143 wfDebug( __METHOD__ . ": invalid username\n" );
2144 } elseif ( User::isIP( $shortTitle ) ) {
2145 // An anonymous user
2146 $other->setNewtalk( true );
2147 } elseif ( $other->isLoggedIn() ) {
2148 $other->setNewtalk( true );
2149 } else {
2150 wfDebug( __METHOD__ . ": don't need to notify a nonexistent user\n" );
2151 }
2152 }
2153 }
2154
2155 if ( $this->mTitle->getNamespace() == NS_MEDIAWIKI ) {
2156 MessageCache::singleton()->replace( $shortTitle, $text );
2157 }
2158
2159 if( $options['created'] ) {
2160 self::onArticleCreate( $this->mTitle );
2161 } else {
2162 self::onArticleEdit( $this->mTitle );
2163 }
2164
2165 wfProfileOut( __METHOD__ );
2166 }
2167
2168 /**
2169 * Perform article updates on a special page creation.
2170 *
2171 * @param $rev Revision object
2172 *
2173 * @todo This is a shitty interface function. Kill it and replace the
2174 * other shitty functions like doEditUpdates and such so it's not needed
2175 * anymore.
2176 * @deprecated since 1.18, use doEditUpdates()
2177 */
2178 public function createUpdates( $rev ) {
2179 wfDeprecated( __METHOD__, '1.18' );
2180 global $wgUser;
2181 $this->doEditUpdates( $rev, $wgUser, array( 'created' => true ) );
2182 }
2183
2184 /**
2185 * This function is called right before saving the wikitext,
2186 * so we can do things like signatures and links-in-context.
2187 *
2188 * @deprecated in 1.19; use Parser::preSaveTransform() instead
2189 * @param $text String article contents
2190 * @param $user User object: user doing the edit
2191 * @param $popts ParserOptions object: parser options, default options for
2192 * the user loaded if null given
2193 * @return string article contents with altered wikitext markup (signatures
2194 * converted, {{subst:}}, templates, etc.)
2195 */
2196 public function preSaveTransform( $text, User $user = null, ParserOptions $popts = null ) {
2197 global $wgParser, $wgUser;
2198
2199 wfDeprecated( __METHOD__, '1.19' );
2200
2201 $user = is_null( $user ) ? $wgUser : $user;
2202
2203 if ( $popts === null ) {
2204 $popts = ParserOptions::newFromUser( $user );
2205 }
2206
2207 return $wgParser->preSaveTransform( $text, $this->mTitle, $user, $popts );
2208 }
2209
2210 /**
2211 * Loads page_touched and returns a value indicating if it should be used
2212 * @return boolean true if not a redirect
2213 */
2214 public function checkTouched() {
2215 if ( !$this->mDataLoaded ) {
2216 $this->loadPageData();
2217 }
2218 return !$this->mIsRedirect;
2219 }
2220
2221 /**
2222 * Get the page_touched field
2223 * @return string containing GMT timestamp
2224 */
2225 public function getTouched() {
2226 if ( !$this->mDataLoaded ) {
2227 $this->loadPageData();
2228 }
2229 return $this->mTouched;
2230 }
2231
2232 /**
2233 * Get the page_latest field
2234 * @return integer rev_id of current revision
2235 */
2236 public function getLatest() {
2237 if ( !$this->mDataLoaded ) {
2238 $this->loadPageData();
2239 }
2240 return (int)$this->mLatest;
2241 }
2242
2243 /**
2244 * Edit an article without doing all that other stuff
2245 * The article must already exist; link tables etc
2246 * are not updated, caches are not flushed.
2247 *
2248 * @param $text String: text submitted
2249 * @param $user User The relevant user
2250 * @param $comment String: comment submitted
2251 * @param $minor Boolean: whereas it's a minor modification
2252 */
2253 public function doQuickEdit( $text, User $user, $comment = '', $minor = 0 ) {
2254 wfProfileIn( __METHOD__ );
2255
2256 $dbw = wfGetDB( DB_MASTER );
2257 $revision = new Revision( array(
2258 'page' => $this->getId(),
2259 'text' => $text,
2260 'comment' => $comment,
2261 'minor_edit' => $minor ? 1 : 0,
2262 ) );
2263 $revision->insertOn( $dbw );
2264 $this->updateRevisionOn( $dbw, $revision );
2265
2266 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $revision, false, $user ) );
2267
2268 wfProfileOut( __METHOD__ );
2269 }
2270
2271 /**
2272 * The onArticle*() functions are supposed to be a kind of hooks
2273 * which should be called whenever any of the specified actions
2274 * are done.
2275 *
2276 * This is a good place to put code to clear caches, for instance.
2277 *
2278 * This is called on page move and undelete, as well as edit
2279 *
2280 * @param $title Title object
2281 */
2282 public static function onArticleCreate( $title ) {
2283 # Update existence markers on article/talk tabs...
2284 if ( $title->isTalkPage() ) {
2285 $other = $title->getSubjectPage();
2286 } else {
2287 $other = $title->getTalkPage();
2288 }
2289
2290 $other->invalidateCache();
2291 $other->purgeSquid();
2292
2293 $title->touchLinks();
2294 $title->purgeSquid();
2295 $title->deleteTitleProtection();
2296 }
2297
2298 /**
2299 * Clears caches when article is deleted
2300 *
2301 * @param $title Title
2302 */
2303 public static function onArticleDelete( $title ) {
2304 # Update existence markers on article/talk tabs...
2305 if ( $title->isTalkPage() ) {
2306 $other = $title->getSubjectPage();
2307 } else {
2308 $other = $title->getTalkPage();
2309 }
2310
2311 $other->invalidateCache();
2312 $other->purgeSquid();
2313
2314 $title->touchLinks();
2315 $title->purgeSquid();
2316
2317 # File cache
2318 HTMLFileCache::clearFileCache( $title );
2319
2320 # Messages
2321 if ( $title->getNamespace() == NS_MEDIAWIKI ) {
2322 MessageCache::singleton()->replace( $title->getDBkey(), false );
2323 }
2324
2325 # Images
2326 if ( $title->getNamespace() == NS_FILE ) {
2327 $update = new HTMLCacheUpdate( $title, 'imagelinks' );
2328 $update->doUpdate();
2329 }
2330
2331 # User talk pages
2332 if ( $title->getNamespace() == NS_USER_TALK ) {
2333 $user = User::newFromName( $title->getText(), false );
2334 if ( $user ) {
2335 $user->setNewtalk( false );
2336 }
2337 }
2338
2339 # Image redirects
2340 RepoGroup::singleton()->getLocalRepo()->invalidateImageRedirect( $title );
2341 }
2342
2343 /**
2344 * Purge caches on page update etc
2345 *
2346 * @param $title Title object
2347 * @todo: verify that $title is always a Title object (and never false or null), add Title hint to parameter $title
2348 */
2349 public static function onArticleEdit( $title ) {
2350 // Invalidate caches of articles which include this page
2351 DeferredUpdates::addHTMLCacheUpdate( $title, 'templatelinks' );
2352
2353
2354 // Invalidate the caches of all pages which redirect here
2355 DeferredUpdates::addHTMLCacheUpdate( $title, 'redirect' );
2356
2357 # Purge squid for this page only
2358 $title->purgeSquid();
2359
2360 # Clear file cache for this page only
2361 HTMLFileCache::clearFileCache( $title );
2362 }
2363
2364 /**#@-*/
2365
2366 /**
2367 * Return a list of templates used by this article.
2368 * Uses the templatelinks table
2369 *
2370 * @return Array of Title objects
2371 */
2372 public function getUsedTemplates() {
2373 $result = array();
2374 $id = $this->mTitle->getArticleID();
2375
2376 if ( $id == 0 ) {
2377 return array();
2378 }
2379
2380 $dbr = wfGetDB( DB_SLAVE );
2381 $res = $dbr->select( array( 'templatelinks' ),
2382 array( 'tl_namespace', 'tl_title' ),
2383 array( 'tl_from' => $id ),
2384 __METHOD__ );
2385
2386 if ( $res !== false ) {
2387 foreach ( $res as $row ) {
2388 $result[] = Title::makeTitle( $row->tl_namespace, $row->tl_title );
2389 }
2390 }
2391
2392 return $result;
2393 }
2394
2395 /**
2396 * Returns a list of hidden categories this page is a member of.
2397 * Uses the page_props and categorylinks tables.
2398 *
2399 * @return Array of Title objects
2400 */
2401 public function getHiddenCategories() {
2402 $result = array();
2403 $id = $this->mTitle->getArticleID();
2404
2405 if ( $id == 0 ) {
2406 return array();
2407 }
2408
2409 $dbr = wfGetDB( DB_SLAVE );
2410 $res = $dbr->select( array( 'categorylinks', 'page_props', 'page' ),
2411 array( 'cl_to' ),
2412 array( 'cl_from' => $id, 'pp_page=page_id', 'pp_propname' => 'hiddencat',
2413 'page_namespace' => NS_CATEGORY, 'page_title=cl_to' ),
2414 __METHOD__ );
2415
2416 if ( $res !== false ) {
2417 foreach ( $res as $row ) {
2418 $result[] = Title::makeTitle( NS_CATEGORY, $row->cl_to );
2419 }
2420 }
2421
2422 return $result;
2423 }
2424
2425 /**
2426 * Return an applicable autosummary if one exists for the given edit.
2427 * @param $oldtext String: the previous text of the page.
2428 * @param $newtext String: The submitted text of the page.
2429 * @param $flags Int bitmask: a bitmask of flags submitted for the edit.
2430 * @return string An appropriate autosummary, or an empty string.
2431 */
2432 public static function getAutosummary( $oldtext, $newtext, $flags ) {
2433 global $wgContLang;
2434
2435 # Decide what kind of autosummary is needed.
2436
2437 # Redirect autosummaries
2438 $ot = Title::newFromRedirect( $oldtext );
2439 $rt = Title::newFromRedirect( $newtext );
2440
2441 if ( is_object( $rt ) && ( !is_object( $ot ) || !$rt->equals( $ot ) || $ot->getFragment() != $rt->getFragment() ) ) {
2442 $truncatedtext = $wgContLang->truncate(
2443 str_replace( "\n", ' ', $newtext ),
2444 max( 0, 250
2445 - strlen( wfMsgForContent( 'autoredircomment' ) )
2446 - strlen( $rt->getFullText() )
2447 ) );
2448 return wfMsgForContent( 'autoredircomment', $rt->getFullText(), $truncatedtext );
2449 }
2450
2451 # New page autosummaries
2452 if ( $flags & EDIT_NEW && strlen( $newtext ) ) {
2453 # If they're making a new article, give its text, truncated, in the summary.
2454
2455 $truncatedtext = $wgContLang->truncate(
2456 str_replace( "\n", ' ', $newtext ),
2457 max( 0, 200 - strlen( wfMsgForContent( 'autosumm-new' ) ) ) );
2458
2459 return wfMsgForContent( 'autosumm-new', $truncatedtext );
2460 }
2461
2462 # Blanking autosummaries
2463 if ( $oldtext != '' && $newtext == '' ) {
2464 return wfMsgForContent( 'autosumm-blank' );
2465 } elseif ( strlen( $oldtext ) > 10 * strlen( $newtext ) && strlen( $newtext ) < 500 ) {
2466 # Removing more than 90% of the article
2467
2468 $truncatedtext = $wgContLang->truncate(
2469 $newtext,
2470 max( 0, 200 - strlen( wfMsgForContent( 'autosumm-replace' ) ) ) );
2471
2472 return wfMsgForContent( 'autosumm-replace', $truncatedtext );
2473 }
2474
2475 # If we reach this point, there's no applicable autosummary for our case, so our
2476 # autosummary is empty.
2477 return '';
2478 }
2479
2480 /**
2481 * Auto-generates a deletion reason
2482 *
2483 * @param &$hasHistory Boolean: whether the page has a history
2484 * @return mixed String containing deletion reason or empty string, or boolean false
2485 * if no revision occurred
2486 */
2487 public function getAutoDeleteReason( &$hasHistory ) {
2488 global $wgContLang;
2489
2490 $dbw = wfGetDB( DB_MASTER );
2491 // Get the last revision
2492 $rev = Revision::newFromTitle( $this->getTitle() );
2493
2494 if ( is_null( $rev ) ) {
2495 return false;
2496 }
2497
2498 // Get the article's contents
2499 $contents = $rev->getText();
2500 $blank = false;
2501
2502 // If the page is blank, use the text from the previous revision,
2503 // which can only be blank if there's a move/import/protect dummy revision involved
2504 if ( $contents == '' ) {
2505 $prev = $rev->getPrevious();
2506
2507 if ( $prev ) {
2508 $contents = $prev->getText();
2509 $blank = true;
2510 }
2511 }
2512
2513 // Find out if there was only one contributor
2514 // Only scan the last 20 revisions
2515 $res = $dbw->select( 'revision', 'rev_user_text',
2516 array( 'rev_page' => $this->getID(), $dbw->bitAnd( 'rev_deleted', Revision::DELETED_USER ) . ' = 0' ),
2517 __METHOD__,
2518 array( 'LIMIT' => 20 )
2519 );
2520
2521 if ( $res === false ) {
2522 // This page has no revisions, which is very weird
2523 return false;
2524 }
2525
2526 $hasHistory = ( $res->numRows() > 1 );
2527 $row = $dbw->fetchObject( $res );
2528
2529 if ( $row ) { // $row is false if the only contributor is hidden
2530 $onlyAuthor = $row->rev_user_text;
2531 // Try to find a second contributor
2532 foreach ( $res as $row ) {
2533 if ( $row->rev_user_text != $onlyAuthor ) { // Bug 22999
2534 $onlyAuthor = false;
2535 break;
2536 }
2537 }
2538 } else {
2539 $onlyAuthor = false;
2540 }
2541
2542 // Generate the summary with a '$1' placeholder
2543 if ( $blank ) {
2544 // The current revision is blank and the one before is also
2545 // blank. It's just not our lucky day
2546 $reason = wfMsgForContent( 'exbeforeblank', '$1' );
2547 } else {
2548 if ( $onlyAuthor ) {
2549 $reason = wfMsgForContent( 'excontentauthor', '$1', $onlyAuthor );
2550 } else {
2551 $reason = wfMsgForContent( 'excontent', '$1' );
2552 }
2553 }
2554
2555 if ( $reason == '-' ) {
2556 // Allow these UI messages to be blanked out cleanly
2557 return '';
2558 }
2559
2560 // Replace newlines with spaces to prevent uglyness
2561 $contents = preg_replace( "/[\n\r]/", ' ', $contents );
2562 // Calculate the maximum amount of chars to get
2563 // Max content length = max comment length - length of the comment (excl. $1)
2564 $maxLength = 255 - ( strlen( $reason ) - 2 );
2565 $contents = $wgContLang->truncate( $contents, $maxLength );
2566 // Remove possible unfinished links
2567 $contents = preg_replace( '/\[\[([^\]]*)\]?$/', '$1', $contents );
2568 // Now replace the '$1' placeholder
2569 $reason = str_replace( '$1', $contents, $reason );
2570
2571 return $reason;
2572 }
2573
2574 /**
2575 * Get parser options suitable for rendering the primary article wikitext
2576 * @param User|string $user User object or 'canonical'
2577 * @return ParserOptions
2578 */
2579 public function makeParserOptions( $user ) {
2580 global $wgContLang;
2581 if ( $user instanceof User ) { // settings per user (even anons)
2582 $options = ParserOptions::newFromUser( $user );
2583 } else { // canonical settings
2584 $options = ParserOptions::newFromUserAndLang( new User, $wgContLang );
2585 }
2586 $options->enableLimitReport(); // show inclusion/loop reports
2587 $options->setTidy( true ); // fix bad HTML
2588 return $options;
2589 }
2590
2591 /**
2592 * Update all the appropriate counts in the category table, given that
2593 * we've added the categories $added and deleted the categories $deleted.
2594 *
2595 * @param $added array The names of categories that were added
2596 * @param $deleted array The names of categories that were deleted
2597 */
2598 public function updateCategoryCounts( $added, $deleted ) {
2599 $ns = $this->mTitle->getNamespace();
2600 $dbw = wfGetDB( DB_MASTER );
2601
2602 # First make sure the rows exist. If one of the "deleted" ones didn't
2603 # exist, we might legitimately not create it, but it's simpler to just
2604 # create it and then give it a negative value, since the value is bogus
2605 # anyway.
2606 #
2607 # Sometimes I wish we had INSERT ... ON DUPLICATE KEY UPDATE.
2608 $insertCats = array_merge( $added, $deleted );
2609 if ( !$insertCats ) {
2610 # Okay, nothing to do
2611 return;
2612 }
2613
2614 $insertRows = array();
2615
2616 foreach ( $insertCats as $cat ) {
2617 $insertRows[] = array(
2618 'cat_id' => $dbw->nextSequenceValue( 'category_cat_id_seq' ),
2619 'cat_title' => $cat
2620 );
2621 }
2622 $dbw->insert( 'category', $insertRows, __METHOD__, 'IGNORE' );
2623
2624 $addFields = array( 'cat_pages = cat_pages + 1' );
2625 $removeFields = array( 'cat_pages = cat_pages - 1' );
2626
2627 if ( $ns == NS_CATEGORY ) {
2628 $addFields[] = 'cat_subcats = cat_subcats + 1';
2629 $removeFields[] = 'cat_subcats = cat_subcats - 1';
2630 } elseif ( $ns == NS_FILE ) {
2631 $addFields[] = 'cat_files = cat_files + 1';
2632 $removeFields[] = 'cat_files = cat_files - 1';
2633 }
2634
2635 if ( $added ) {
2636 $dbw->update(
2637 'category',
2638 $addFields,
2639 array( 'cat_title' => $added ),
2640 __METHOD__
2641 );
2642 }
2643
2644 if ( $deleted ) {
2645 $dbw->update(
2646 'category',
2647 $removeFields,
2648 array( 'cat_title' => $deleted ),
2649 __METHOD__
2650 );
2651 }
2652 }
2653
2654 /**
2655 * Updates cascading protections
2656 *
2657 * @param $parserOutput ParserOutput object for the current version
2658 */
2659 public function doCascadeProtectionUpdates( ParserOutput $parserOutput ) {
2660 if ( wfReadOnly() || !$this->mTitle->areRestrictionsCascading() ) {
2661 return;
2662 }
2663
2664 // templatelinks table may have become out of sync,
2665 // especially if using variable-based transclusions.
2666 // For paranoia, check if things have changed and if
2667 // so apply updates to the database. This will ensure
2668 // that cascaded protections apply as soon as the changes
2669 // are visible.
2670
2671 # Get templates from templatelinks
2672 $id = $this->mTitle->getArticleID();
2673
2674 $tlTemplates = array();
2675
2676 $dbr = wfGetDB( DB_SLAVE );
2677 $res = $dbr->select( array( 'templatelinks' ),
2678 array( 'tl_namespace', 'tl_title' ),
2679 array( 'tl_from' => $id ),
2680 __METHOD__
2681 );
2682
2683 foreach ( $res as $row ) {
2684 $tlTemplates["{$row->tl_namespace}:{$row->tl_title}"] = true;
2685 }
2686
2687 # Get templates from parser output.
2688 $poTemplates = array();
2689 foreach ( $parserOutput->getTemplates() as $ns => $templates ) {
2690 foreach ( $templates as $dbk => $id ) {
2691 $poTemplates["$ns:$dbk"] = true;
2692 }
2693 }
2694
2695 # Get the diff
2696 $templates_diff = array_diff_key( $poTemplates, $tlTemplates );
2697
2698 if ( count( $templates_diff ) > 0 ) {
2699 # Whee, link updates time.
2700 $u = new LinksUpdate( $this->mTitle, $parserOutput, false );
2701 $u->doUpdate();
2702 }
2703 }
2704
2705 /**
2706 * Update the article's restriction field, and leave a log entry.
2707 *
2708 * @deprecated since 1.19
2709 * @param $limit Array: set of restriction keys
2710 * @param $reason String
2711 * @param &$cascade Integer. Set to false if cascading protection isn't allowed.
2712 * @param $expiry Array: per restriction type expiration
2713 * @param $user User The user updating the restrictions
2714 * @return bool true on success
2715 */
2716 public function updateRestrictions(
2717 $limit = array(), $reason = '', &$cascade = 0, $expiry = array(), User $user = null
2718 ) {
2719 global $wgUser;
2720
2721 $user = is_null( $user ) ? $wgUser : $user;
2722
2723 return $this->doUpdateRestrictions( $limit, $expiry, $cascade, $reason, $user )->isOK();
2724 }
2725
2726 /**
2727 * @deprecated since 1.18
2728 */
2729 public function quickEdit( $text, $comment = '', $minor = 0 ) {
2730 wfDeprecated( __METHOD__, '1.18' );
2731 global $wgUser;
2732 return $this->doQuickEdit( $text, $wgUser, $comment, $minor );
2733 }
2734
2735 /**
2736 * @deprecated since 1.18
2737 */
2738 public function viewUpdates() {
2739 wfDeprecated( __METHOD__, '1.18' );
2740 global $wgUser;
2741 return $this->doViewUpdates( $wgUser );
2742 }
2743
2744 /**
2745 * @deprecated since 1.18
2746 */
2747 public function useParserCache( $oldid ) {
2748 wfDeprecated( __METHOD__, '1.18' );
2749 global $wgUser;
2750 return $this->isParserCacheUsed( ParserOptions::newFromUser( $wgUser ), $oldid );
2751 }
2752 }
2753
2754 class PoolWorkArticleView extends PoolCounterWork {
2755
2756 /**
2757 * @var Page
2758 */
2759 private $page;
2760
2761 /**
2762 * @var string
2763 */
2764 private $cacheKey;
2765
2766 /**
2767 * @var integer
2768 */
2769 private $revid;
2770
2771 /**
2772 * @var ParserOptions
2773 */
2774 private $parserOptions;
2775
2776 /**
2777 * @var string|null
2778 */
2779 private $text;
2780
2781 /**
2782 * @var ParserOutput|false
2783 */
2784 private $parserOutput = false;
2785
2786 /**
2787 * @var bool
2788 */
2789 private $isDirty = false;
2790
2791 /**
2792 * @var Status|false
2793 */
2794 private $error = false;
2795
2796 /**
2797 * Constructor
2798 *
2799 * @param $page Page
2800 * @param $revid Integer: ID of the revision being parsed
2801 * @param $useParserCache Boolean: whether to use the parser cache
2802 * @param $parserOptions parserOptions to use for the parse operation
2803 * @param $text String: text to parse or null to load it
2804 */
2805 function __construct( Page $page, ParserOptions $parserOptions, $revid, $useParserCache, $text = null ) {
2806 $this->page = $page;
2807 $this->revid = $revid;
2808 $this->cacheable = $useParserCache;
2809 $this->parserOptions = $parserOptions;
2810 $this->text = $text;
2811 $this->cacheKey = ParserCache::singleton()->getKey( $page, $parserOptions );
2812 parent::__construct( 'ArticleView', $this->cacheKey . ':revid:' . $revid );
2813 }
2814
2815 /**
2816 * Get the ParserOutput from this object, or false in case of failure
2817 *
2818 * @return ParserOutput
2819 */
2820 public function getParserOutput() {
2821 return $this->parserOutput;
2822 }
2823
2824 /**
2825 * Get whether the ParserOutput is a dirty one (i.e. expired)
2826 *
2827 * @return bool
2828 */
2829 public function getIsDirty() {
2830 return $this->isDirty;
2831 }
2832
2833 /**
2834 * Get a Status object in case of error or false otherwise
2835 *
2836 * @return Status|false
2837 */
2838 public function getError() {
2839 return $this->error;
2840 }
2841
2842 /**
2843 * @return bool
2844 */
2845 function doWork() {
2846 global $wgParser, $wgUseFileCache;
2847
2848 $isCurrent = $this->revid === $this->page->getLatest();
2849
2850 if ( $this->text !== null ) {
2851 $text = $this->text;
2852 } elseif ( $isCurrent ) {
2853 $text = $this->page->getRawText();
2854 } else {
2855 $rev = Revision::newFromTitle( $this->page->getTitle(), $this->revid );
2856 if ( $rev === null ) {
2857 return false;
2858 }
2859 $text = $rev->getText();
2860 }
2861
2862 $time = - wfTime();
2863 $this->parserOutput = $wgParser->parse( $text, $this->page->getTitle(),
2864 $this->parserOptions, true, true, $this->revid );
2865 $time += wfTime();
2866
2867 # Timing hack
2868 if ( $time > 3 ) {
2869 wfDebugLog( 'slow-parse', sprintf( "%-5.2f %s", $time,
2870 $this->page->getTitle()->getPrefixedDBkey() ) );
2871 }
2872
2873 if ( $this->cacheable && $this->parserOutput->isCacheable() ) {
2874 ParserCache::singleton()->save( $this->parserOutput, $this->page, $this->parserOptions );
2875 }
2876
2877 // Make sure file cache is not used on uncacheable content.
2878 // Output that has magic words in it can still use the parser cache
2879 // (if enabled), though it will generally expire sooner.
2880 if ( !$this->parserOutput->isCacheable() || $this->parserOutput->containsOldMagic() ) {
2881 $wgUseFileCache = false;
2882 }
2883
2884 if ( $isCurrent ) {
2885 $this->page->doCascadeProtectionUpdates( $this->parserOutput );
2886 }
2887
2888 return true;
2889 }
2890
2891 /**
2892 * @return bool
2893 */
2894 function getCachedWork() {
2895 $this->parserOutput = ParserCache::singleton()->get( $this->page, $this->parserOptions );
2896
2897 if ( $this->parserOutput === false ) {
2898 wfDebug( __METHOD__ . ": parser cache miss\n" );
2899 return false;
2900 } else {
2901 wfDebug( __METHOD__ . ": parser cache hit\n" );
2902 return true;
2903 }
2904 }
2905
2906 /**
2907 * @return bool
2908 */
2909 function fallback() {
2910 $this->parserOutput = ParserCache::singleton()->getDirty( $this->page, $this->parserOptions );
2911
2912 if ( $this->parserOutput === false ) {
2913 wfDebugLog( 'dirty', "dirty missing\n" );
2914 wfDebug( __METHOD__ . ": no dirty cache\n" );
2915 return false;
2916 } else {
2917 wfDebug( __METHOD__ . ": sending dirty output\n" );
2918 wfDebugLog( 'dirty', "dirty output {$this->cacheKey}\n" );
2919 $this->isDirty = true;
2920 return true;
2921 }
2922 }
2923
2924 /**
2925 * @param $status Status
2926 */
2927 function error( $status ) {
2928 $this->error = $status;
2929 return false;
2930 }
2931 }