* (bug 30711) WikiPage::replaceSection() now always the current text when adding...
[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 * @return bool whether or not the page surpasses $wgDeleteRevisionsLimit revisions
1564 */
1565 public function isBigDeletion() {
1566 global $wgDeleteRevisionsLimit;
1567
1568 if ( $wgDeleteRevisionsLimit ) {
1569 $revCount = $this->estimateRevisionCount();
1570
1571 return $revCount > $wgDeleteRevisionsLimit;
1572 }
1573
1574 return false;
1575 }
1576
1577 /**
1578 * @return int approximate revision count
1579 */
1580 public function estimateRevisionCount() {
1581 $dbr = wfGetDB( DB_SLAVE );
1582 return $dbr->estimateRowCount( 'revision', '*',
1583 array( 'rev_page' => $this->getId() ), __METHOD__ );
1584 }
1585
1586 /**
1587 * Get the last N authors
1588 * @param $num Integer: number of revisions to get
1589 * @param $revLatest String: the latest rev_id, selected from the master (optional)
1590 * @return array Array of authors, duplicates not removed
1591 */
1592 public function getLastNAuthors( $num, $revLatest = 0 ) {
1593 wfProfileIn( __METHOD__ );
1594 // First try the slave
1595 // If that doesn't have the latest revision, try the master
1596 $continue = 2;
1597 $db = wfGetDB( DB_SLAVE );
1598
1599 do {
1600 $res = $db->select( array( 'page', 'revision' ),
1601 array( 'rev_id', 'rev_user_text' ),
1602 array(
1603 'page_namespace' => $this->mTitle->getNamespace(),
1604 'page_title' => $this->mTitle->getDBkey(),
1605 'rev_page = page_id'
1606 ), __METHOD__,
1607 array(
1608 'ORDER BY' => 'rev_timestamp DESC',
1609 'LIMIT' => $num
1610 )
1611 );
1612
1613 if ( !$res ) {
1614 wfProfileOut( __METHOD__ );
1615 return array();
1616 }
1617
1618 $row = $db->fetchObject( $res );
1619
1620 if ( $continue == 2 && $revLatest && $row->rev_id != $revLatest ) {
1621 $db = wfGetDB( DB_MASTER );
1622 $continue--;
1623 } else {
1624 $continue = 0;
1625 }
1626 } while ( $continue );
1627
1628 $authors = array( $row->rev_user_text );
1629
1630 foreach ( $res as $row ) {
1631 $authors[] = $row->rev_user_text;
1632 }
1633
1634 wfProfileOut( __METHOD__ );
1635 return $authors;
1636 }
1637
1638 /**
1639 * Back-end article deletion
1640 * Deletes the article with database consistency, writes logs, purges caches
1641 *
1642 * @param $reason string delete reason for deletion log
1643 * @param $suppress bitfield
1644 * Revision::DELETED_TEXT
1645 * Revision::DELETED_COMMENT
1646 * Revision::DELETED_USER
1647 * Revision::DELETED_RESTRICTED
1648 * @param $id int article ID
1649 * @param $commit boolean defaults to true, triggers transaction end
1650 * @param &$errors Array of errors to append to
1651 * @param $user User The relevant user
1652 * @return boolean true if successful
1653 */
1654 public function doDeleteArticle(
1655 $reason, $suppress = false, $id = 0, $commit = true, &$error = '', User $user = null
1656 ) {
1657 global $wgUser;
1658 $user = is_null( $user ) ? $wgUser : $user;
1659
1660 wfDebug( __METHOD__ . "\n" );
1661
1662 if ( ! wfRunHooks( 'ArticleDelete', array( &$this, &$user, &$reason, &$error ) ) ) {
1663 return false;
1664 }
1665 $dbw = wfGetDB( DB_MASTER );
1666 $t = $this->mTitle->getDBkey();
1667 $id = $id ? $id : $this->mTitle->getArticleID( Title::GAID_FOR_UPDATE );
1668
1669 if ( $t === '' || $id == 0 ) {
1670 return false;
1671 }
1672
1673 DeferredUpdates::addUpdate(
1674 new SiteStatsUpdate( 0, 1, - (int)$this->isCountable(), -1 )
1675 );
1676
1677 // Bitfields to further suppress the content
1678 if ( $suppress ) {
1679 $bitfield = 0;
1680 // This should be 15...
1681 $bitfield |= Revision::DELETED_TEXT;
1682 $bitfield |= Revision::DELETED_COMMENT;
1683 $bitfield |= Revision::DELETED_USER;
1684 $bitfield |= Revision::DELETED_RESTRICTED;
1685 } else {
1686 $bitfield = 'rev_deleted';
1687 }
1688
1689 $dbw->begin();
1690 // For now, shunt the revision data into the archive table.
1691 // Text is *not* removed from the text table; bulk storage
1692 // is left intact to avoid breaking block-compression or
1693 // immutable storage schemes.
1694 //
1695 // For backwards compatibility, note that some older archive
1696 // table entries will have ar_text and ar_flags fields still.
1697 //
1698 // In the future, we may keep revisions and mark them with
1699 // the rev_deleted field, which is reserved for this purpose.
1700 $dbw->insertSelect( 'archive', array( 'page', 'revision' ),
1701 array(
1702 'ar_namespace' => 'page_namespace',
1703 'ar_title' => 'page_title',
1704 'ar_comment' => 'rev_comment',
1705 'ar_user' => 'rev_user',
1706 'ar_user_text' => 'rev_user_text',
1707 'ar_timestamp' => 'rev_timestamp',
1708 'ar_minor_edit' => 'rev_minor_edit',
1709 'ar_rev_id' => 'rev_id',
1710 'ar_parent_id' => 'rev_parent_id',
1711 'ar_text_id' => 'rev_text_id',
1712 'ar_text' => '\'\'', // Be explicit to appease
1713 'ar_flags' => '\'\'', // MySQL's "strict mode"...
1714 'ar_len' => 'rev_len',
1715 'ar_page_id' => 'page_id',
1716 'ar_deleted' => $bitfield,
1717 'ar_sha1' => 'rev_sha1'
1718 ), array(
1719 'page_id' => $id,
1720 'page_id = rev_page'
1721 ), __METHOD__
1722 );
1723
1724 # Delete restrictions for it
1725 $dbw->delete( 'page_restrictions', array ( 'pr_page' => $id ), __METHOD__ );
1726
1727 # Now that it's safely backed up, delete it
1728 $dbw->delete( 'page', array( 'page_id' => $id ), __METHOD__ );
1729 $ok = ( $dbw->affectedRows() > 0 ); // getArticleId() uses slave, could be laggy
1730
1731 if ( !$ok ) {
1732 $dbw->rollback();
1733 return false;
1734 }
1735
1736 # Fix category table counts
1737 $cats = array();
1738 $res = $dbw->select( 'categorylinks', 'cl_to', array( 'cl_from' => $id ), __METHOD__ );
1739
1740 foreach ( $res as $row ) {
1741 $cats [] = $row->cl_to;
1742 }
1743
1744 $this->updateCategoryCounts( array(), $cats );
1745
1746 # If using cascading deletes, we can skip some explicit deletes
1747 if ( !$dbw->cascadingDeletes() ) {
1748 $dbw->delete( 'revision', array( 'rev_page' => $id ), __METHOD__ );
1749
1750 # Delete outgoing links
1751 $dbw->delete( 'pagelinks', array( 'pl_from' => $id ), __METHOD__ );
1752 $dbw->delete( 'imagelinks', array( 'il_from' => $id ), __METHOD__ );
1753 $dbw->delete( 'categorylinks', array( 'cl_from' => $id ), __METHOD__ );
1754 $dbw->delete( 'templatelinks', array( 'tl_from' => $id ), __METHOD__ );
1755 $dbw->delete( 'externallinks', array( 'el_from' => $id ), __METHOD__ );
1756 $dbw->delete( 'langlinks', array( 'll_from' => $id ), __METHOD__ );
1757 $dbw->delete( 'iwlinks', array( 'iwl_from' => $id ), __METHOD__ );
1758 $dbw->delete( 'redirect', array( 'rd_from' => $id ), __METHOD__ );
1759 $dbw->delete( 'page_props', array( 'pp_page' => $id ), __METHOD__ );
1760 }
1761
1762 # If using cleanup triggers, we can skip some manual deletes
1763 if ( !$dbw->cleanupTriggers() ) {
1764 # Clean up recentchanges entries...
1765 $dbw->delete( 'recentchanges',
1766 array( 'rc_type != ' . RC_LOG,
1767 'rc_namespace' => $this->mTitle->getNamespace(),
1768 'rc_title' => $this->mTitle->getDBkey() ),
1769 __METHOD__ );
1770 $dbw->delete( 'recentchanges',
1771 array( 'rc_type != ' . RC_LOG, 'rc_cur_id' => $id ),
1772 __METHOD__ );
1773 }
1774
1775 # Clear caches
1776 self::onArticleDelete( $this->mTitle );
1777
1778 # Clear the cached article id so the interface doesn't act like we exist
1779 $this->mTitle->resetArticleID( 0 );
1780
1781 # Log the deletion, if the page was suppressed, log it at Oversight instead
1782 $logtype = $suppress ? 'suppress' : 'delete';
1783
1784 $logEntry = new ManualLogEntry( $logtype, 'delete' );
1785 $logEntry->setPerformer( $user );
1786 $logEntry->setTarget( $this->mTitle );
1787 $logEntry->setComment( $reason );
1788 $logid = $logEntry->insert();
1789 $logEntry->publish( $logid );
1790
1791 if ( $commit ) {
1792 $dbw->commit();
1793 }
1794
1795 wfRunHooks( 'ArticleDeleteComplete', array( &$this, &$user, $reason, $id ) );
1796 return true;
1797 }
1798
1799 /**
1800 * Roll back the most recent consecutive set of edits to a page
1801 * from the same user; fails if there are no eligible edits to
1802 * roll back to, e.g. user is the sole contributor. This function
1803 * performs permissions checks on $user, then calls commitRollback()
1804 * to do the dirty work
1805 *
1806 * @todo: seperate the business/permission stuff out from backend code
1807 *
1808 * @param $fromP String: Name of the user whose edits to rollback.
1809 * @param $summary String: Custom summary. Set to default summary if empty.
1810 * @param $token String: Rollback token.
1811 * @param $bot Boolean: If true, mark all reverted edits as bot.
1812 *
1813 * @param $resultDetails Array: contains result-specific array of additional values
1814 * 'alreadyrolled' : 'current' (rev)
1815 * success : 'summary' (str), 'current' (rev), 'target' (rev)
1816 *
1817 * @param $user User The user performing the rollback
1818 * @return array of errors, each error formatted as
1819 * array(messagekey, param1, param2, ...).
1820 * On success, the array is empty. This array can also be passed to
1821 * OutputPage::showPermissionsErrorPage().
1822 */
1823 public function doRollback(
1824 $fromP, $summary, $token, $bot, &$resultDetails, User $user
1825 ) {
1826 $resultDetails = null;
1827
1828 # Check permissions
1829 $editErrors = $this->mTitle->getUserPermissionsErrors( 'edit', $user );
1830 $rollbackErrors = $this->mTitle->getUserPermissionsErrors( 'rollback', $user );
1831 $errors = array_merge( $editErrors, wfArrayDiff2( $rollbackErrors, $editErrors ) );
1832
1833 if ( !$user->matchEditToken( $token, array( $this->mTitle->getPrefixedText(), $fromP ) ) ) {
1834 $errors[] = array( 'sessionfailure' );
1835 }
1836
1837 if ( $user->pingLimiter( 'rollback' ) || $user->pingLimiter() ) {
1838 $errors[] = array( 'actionthrottledtext' );
1839 }
1840
1841 # If there were errors, bail out now
1842 if ( !empty( $errors ) ) {
1843 return $errors;
1844 }
1845
1846 return $this->commitRollback( $fromP, $summary, $bot, $resultDetails, $user );
1847 }
1848
1849 /**
1850 * Backend implementation of doRollback(), please refer there for parameter
1851 * and return value documentation
1852 *
1853 * NOTE: This function does NOT check ANY permissions, it just commits the
1854 * rollback to the DB. Therefore, you should only call this function direct-
1855 * ly if you want to use custom permissions checks. If you don't, use
1856 * doRollback() instead.
1857 * @param $fromP String: Name of the user whose edits to rollback.
1858 * @param $summary String: Custom summary. Set to default summary if empty.
1859 * @param $bot Boolean: If true, mark all reverted edits as bot.
1860 *
1861 * @param $resultDetails Array: contains result-specific array of additional values
1862 * @param $guser User The user performing the rollback
1863 */
1864 public function commitRollback( $fromP, $summary, $bot, &$resultDetails, User $guser ) {
1865 global $wgUseRCPatrol, $wgContLang;
1866
1867 $dbw = wfGetDB( DB_MASTER );
1868
1869 if ( wfReadOnly() ) {
1870 return array( array( 'readonlytext' ) );
1871 }
1872
1873 # Get the last editor
1874 $current = Revision::newFromTitle( $this->mTitle );
1875 if ( is_null( $current ) ) {
1876 # Something wrong... no page?
1877 return array( array( 'notanarticle' ) );
1878 }
1879
1880 $from = str_replace( '_', ' ', $fromP );
1881 # User name given should match up with the top revision.
1882 # If the user was deleted then $from should be empty.
1883 if ( $from != $current->getUserText() ) {
1884 $resultDetails = array( 'current' => $current );
1885 return array( array( 'alreadyrolled',
1886 htmlspecialchars( $this->mTitle->getPrefixedText() ),
1887 htmlspecialchars( $fromP ),
1888 htmlspecialchars( $current->getUserText() )
1889 ) );
1890 }
1891
1892 # Get the last edit not by this guy...
1893 # Note: these may not be public values
1894 $user = intval( $current->getRawUser() );
1895 $user_text = $dbw->addQuotes( $current->getRawUserText() );
1896 $s = $dbw->selectRow( 'revision',
1897 array( 'rev_id', 'rev_timestamp', 'rev_deleted' ),
1898 array( 'rev_page' => $current->getPage(),
1899 "rev_user != {$user} OR rev_user_text != {$user_text}"
1900 ), __METHOD__,
1901 array( 'USE INDEX' => 'page_timestamp',
1902 'ORDER BY' => 'rev_timestamp DESC' )
1903 );
1904 if ( $s === false ) {
1905 # No one else ever edited this page
1906 return array( array( 'cantrollback' ) );
1907 } elseif ( $s->rev_deleted & Revision::DELETED_TEXT || $s->rev_deleted & Revision::DELETED_USER ) {
1908 # Only admins can see this text
1909 return array( array( 'notvisiblerev' ) );
1910 }
1911
1912 $set = array();
1913 if ( $bot && $guser->isAllowed( 'markbotedits' ) ) {
1914 # Mark all reverted edits as bot
1915 $set['rc_bot'] = 1;
1916 }
1917
1918 if ( $wgUseRCPatrol ) {
1919 # Mark all reverted edits as patrolled
1920 $set['rc_patrolled'] = 1;
1921 }
1922
1923 if ( count( $set ) ) {
1924 $dbw->update( 'recentchanges', $set,
1925 array( /* WHERE */
1926 'rc_cur_id' => $current->getPage(),
1927 'rc_user_text' => $current->getUserText(),
1928 "rc_timestamp > '{$s->rev_timestamp}'",
1929 ), __METHOD__
1930 );
1931 }
1932
1933 # Generate the edit summary if necessary
1934 $target = Revision::newFromId( $s->rev_id );
1935 if ( empty( $summary ) ) {
1936 if ( $from == '' ) { // no public user name
1937 $summary = wfMsgForContent( 'revertpage-nouser' );
1938 } else {
1939 $summary = wfMsgForContent( 'revertpage' );
1940 }
1941 }
1942
1943 # Allow the custom summary to use the same args as the default message
1944 $args = array(
1945 $target->getUserText(), $from, $s->rev_id,
1946 $wgContLang->timeanddate( wfTimestamp( TS_MW, $s->rev_timestamp ) ),
1947 $current->getId(), $wgContLang->timeanddate( $current->getTimestamp() )
1948 );
1949 $summary = wfMsgReplaceArgs( $summary, $args );
1950
1951 # Save
1952 $flags = EDIT_UPDATE;
1953
1954 if ( $guser->isAllowed( 'minoredit' ) ) {
1955 $flags |= EDIT_MINOR;
1956 }
1957
1958 if ( $bot && ( $guser->isAllowedAny( 'markbotedits', 'bot' ) ) ) {
1959 $flags |= EDIT_FORCE_BOT;
1960 }
1961
1962 # Actually store the edit
1963 $status = $this->doEdit( $target->getText(), $summary, $flags, $target->getId() );
1964 if ( !empty( $status->value['revision'] ) ) {
1965 $revId = $status->value['revision']->getId();
1966 } else {
1967 $revId = false;
1968 }
1969
1970 wfRunHooks( 'ArticleRollbackComplete', array( $this, $guser, $target, $current ) );
1971
1972 $resultDetails = array(
1973 'summary' => $summary,
1974 'current' => $current,
1975 'target' => $target,
1976 'newid' => $revId
1977 );
1978
1979 return array();
1980 }
1981
1982 /**
1983 * Do standard deferred updates after page view
1984 * @param $user User The relevant user
1985 */
1986 public function doViewUpdates( User $user ) {
1987 global $wgDisableCounters;
1988 if ( wfReadOnly() ) {
1989 return;
1990 }
1991
1992 # Don't update page view counters on views from bot users (bug 14044)
1993 if ( !$wgDisableCounters && !$user->isAllowed( 'bot' ) && $this->mTitle->exists() ) {
1994 DeferredUpdates::addUpdate( new ViewCountUpdate( $this->getId() ) );
1995 DeferredUpdates::addUpdate( new SiteStatsUpdate( 1, 0, 0 ) );
1996 }
1997
1998 # Update newtalk / watchlist notification status
1999 $user->clearNotification( $this->mTitle );
2000 }
2001
2002 /**
2003 * Prepare text which is about to be saved.
2004 * Returns a stdclass with source, pst and output members
2005 */
2006 public function prepareTextForEdit( $text, $revid = null, User $user = null ) {
2007 global $wgParser, $wgContLang, $wgUser;
2008 $user = is_null( $user ) ? $wgUser : $user;
2009 // @TODO fixme: check $user->getId() here???
2010 if ( $this->mPreparedEdit
2011 && $this->mPreparedEdit->newText == $text
2012 && $this->mPreparedEdit->revid == $revid
2013 ) {
2014 // Already prepared
2015 return $this->mPreparedEdit;
2016 }
2017
2018 $popts = ParserOptions::newFromUserAndLang( $user, $wgContLang );
2019 wfRunHooks( 'ArticlePrepareTextForEdit', array( $this, $popts ) );
2020
2021 $edit = (object)array();
2022 $edit->revid = $revid;
2023 $edit->newText = $text;
2024 $edit->pst = $wgParser->preSaveTransform( $text, $this->mTitle, $user, $popts );
2025 $edit->popts = $this->makeParserOptions( 'canonical' );
2026
2027 // Bug 32858: For a CSS/JS page, put a blank parser output into the
2028 // prepared edit, so that links etc. won't be registered in the
2029 // database. We could have set $edit->output to false or something if
2030 // we thought of this bug earlier, but now that would break the
2031 // interface with AbuseFilter etc.
2032 if ( $this->mTitle->isCssOrJsPage() || $this->getTitle()->isCssJsSubpage() ) {
2033 $input = '';
2034 } else {
2035 $input = $edit->pst;
2036 }
2037 $edit->output = $wgParser->parse( $input, $this->mTitle, $edit->popts, true, true, $revid );
2038 $edit->oldText = $this->getRawText();
2039
2040 $this->mPreparedEdit = $edit;
2041
2042 return $edit;
2043 }
2044
2045 /**
2046 * Do standard deferred updates after page edit.
2047 * Update links tables, site stats, search index and message cache.
2048 * Purges pages that include this page if the text was changed here.
2049 * Every 100th edit, prune the recent changes table.
2050 *
2051 * @private
2052 * @param $revision Revision object
2053 * @param $user User object that did the revision
2054 * @param $options Array of options, following indexes are used:
2055 * - changed: boolean, whether the revision changed the content (default true)
2056 * - created: boolean, whether the revision created the page (default false)
2057 * - oldcountable: boolean or null (default null):
2058 * - boolean: whether the page was counted as an article before that
2059 * revision, only used in changed is true and created is false
2060 * - null: don't change the article count
2061 */
2062 public function doEditUpdates( Revision $revision, User $user, array $options = array() ) {
2063 global $wgEnableParserCache;
2064
2065 wfProfileIn( __METHOD__ );
2066
2067 $options += array( 'changed' => true, 'created' => false, 'oldcountable' => null );
2068 $text = $revision->getText();
2069
2070 # Parse the text
2071 # Be careful not to double-PST: $text is usually already PST-ed once
2072 if ( !$this->mPreparedEdit || $this->mPreparedEdit->output->getFlag( 'vary-revision' ) ) {
2073 wfDebug( __METHOD__ . ": No prepared edit or vary-revision is set...\n" );
2074 $editInfo = $this->prepareTextForEdit( $text, $revision->getId(), $user );
2075 } else {
2076 wfDebug( __METHOD__ . ": No vary-revision, using prepared edit...\n" );
2077 $editInfo = $this->mPreparedEdit;
2078 }
2079
2080 # Save it to the parser cache
2081 if ( $wgEnableParserCache ) {
2082 $parserCache = ParserCache::singleton();
2083 $parserCache->save( $editInfo->output, $this, $editInfo->popts );
2084 }
2085
2086 # Update the links tables
2087 $u = new LinksUpdate( $this->mTitle, $editInfo->output );
2088 $u->doUpdate();
2089
2090 wfRunHooks( 'ArticleEditUpdates', array( &$this, &$editInfo, $options['changed'] ) );
2091
2092 if ( wfRunHooks( 'ArticleEditUpdatesDeleteFromRecentchanges', array( &$this ) ) ) {
2093 if ( 0 == mt_rand( 0, 99 ) ) {
2094 // Flush old entries from the `recentchanges` table; we do this on
2095 // random requests so as to avoid an increase in writes for no good reason
2096 global $wgRCMaxAge;
2097
2098 $dbw = wfGetDB( DB_MASTER );
2099 $cutoff = $dbw->timestamp( time() - $wgRCMaxAge );
2100 $dbw->delete(
2101 'recentchanges',
2102 array( "rc_timestamp < '$cutoff'" ),
2103 __METHOD__
2104 );
2105 }
2106 }
2107
2108 if ( !$this->mTitle->exists() ) {
2109 wfProfileOut( __METHOD__ );
2110 return;
2111 }
2112
2113 $id = $this->getId();
2114 $title = $this->mTitle->getPrefixedDBkey();
2115 $shortTitle = $this->mTitle->getDBkey();
2116
2117 if ( !$options['changed'] ) {
2118 $good = 0;
2119 $total = 0;
2120 } elseif ( $options['created'] ) {
2121 $good = (int)$this->isCountable( $editInfo );
2122 $total = 1;
2123 } elseif ( $options['oldcountable'] !== null ) {
2124 $good = (int)$this->isCountable( $editInfo ) - (int)$options['oldcountable'];
2125 $total = 0;
2126 } else {
2127 $good = 0;
2128 $total = 0;
2129 }
2130
2131 DeferredUpdates::addUpdate( new SiteStatsUpdate( 0, 1, $good, $total ) );
2132 DeferredUpdates::addUpdate( new SearchUpdate( $id, $title, $text ) );
2133
2134 # If this is another user's talk page, update newtalk.
2135 # Don't do this if $options['changed'] = false (null-edits) nor if
2136 # it's a minor edit and the user doesn't want notifications for those.
2137 if ( $options['changed']
2138 && $this->mTitle->getNamespace() == NS_USER_TALK
2139 && $shortTitle != $user->getTitleKey()
2140 && !( $revision->isMinor() && $user->isAllowed( 'nominornewtalk' ) )
2141 ) {
2142 if ( wfRunHooks( 'ArticleEditUpdateNewTalk', array( &$this ) ) ) {
2143 $other = User::newFromName( $shortTitle, false );
2144 if ( !$other ) {
2145 wfDebug( __METHOD__ . ": invalid username\n" );
2146 } elseif ( User::isIP( $shortTitle ) ) {
2147 // An anonymous user
2148 $other->setNewtalk( true );
2149 } elseif ( $other->isLoggedIn() ) {
2150 $other->setNewtalk( true );
2151 } else {
2152 wfDebug( __METHOD__ . ": don't need to notify a nonexistent user\n" );
2153 }
2154 }
2155 }
2156
2157 if ( $this->mTitle->getNamespace() == NS_MEDIAWIKI ) {
2158 MessageCache::singleton()->replace( $shortTitle, $text );
2159 }
2160
2161 if( $options['created'] ) {
2162 self::onArticleCreate( $this->mTitle );
2163 } else {
2164 self::onArticleEdit( $this->mTitle );
2165 }
2166
2167 wfProfileOut( __METHOD__ );
2168 }
2169
2170 /**
2171 * Perform article updates on a special page creation.
2172 *
2173 * @param $rev Revision object
2174 *
2175 * @todo This is a shitty interface function. Kill it and replace the
2176 * other shitty functions like doEditUpdates and such so it's not needed
2177 * anymore.
2178 * @deprecated since 1.18, use doEditUpdates()
2179 */
2180 public function createUpdates( $rev ) {
2181 wfDeprecated( __METHOD__, '1.18' );
2182 global $wgUser;
2183 $this->doEditUpdates( $rev, $wgUser, array( 'created' => true ) );
2184 }
2185
2186 /**
2187 * This function is called right before saving the wikitext,
2188 * so we can do things like signatures and links-in-context.
2189 *
2190 * @deprecated in 1.19; use Parser::preSaveTransform() instead
2191 * @param $text String article contents
2192 * @param $user User object: user doing the edit
2193 * @param $popts ParserOptions object: parser options, default options for
2194 * the user loaded if null given
2195 * @return string article contents with altered wikitext markup (signatures
2196 * converted, {{subst:}}, templates, etc.)
2197 */
2198 public function preSaveTransform( $text, User $user = null, ParserOptions $popts = null ) {
2199 global $wgParser, $wgUser;
2200
2201 wfDeprecated( __METHOD__, '1.19' );
2202
2203 $user = is_null( $user ) ? $wgUser : $user;
2204
2205 if ( $popts === null ) {
2206 $popts = ParserOptions::newFromUser( $user );
2207 }
2208
2209 return $wgParser->preSaveTransform( $text, $this->mTitle, $user, $popts );
2210 }
2211
2212 /**
2213 * Loads page_touched and returns a value indicating if it should be used
2214 * @return boolean true if not a redirect
2215 */
2216 public function checkTouched() {
2217 if ( !$this->mDataLoaded ) {
2218 $this->loadPageData();
2219 }
2220 return !$this->mIsRedirect;
2221 }
2222
2223 /**
2224 * Get the page_touched field
2225 * @return string containing GMT timestamp
2226 */
2227 public function getTouched() {
2228 if ( !$this->mDataLoaded ) {
2229 $this->loadPageData();
2230 }
2231 return $this->mTouched;
2232 }
2233
2234 /**
2235 * Get the page_latest field
2236 * @return integer rev_id of current revision
2237 */
2238 public function getLatest() {
2239 if ( !$this->mDataLoaded ) {
2240 $this->loadPageData();
2241 }
2242 return (int)$this->mLatest;
2243 }
2244
2245 /**
2246 * Edit an article without doing all that other stuff
2247 * The article must already exist; link tables etc
2248 * are not updated, caches are not flushed.
2249 *
2250 * @param $text String: text submitted
2251 * @param $user User The relevant user
2252 * @param $comment String: comment submitted
2253 * @param $minor Boolean: whereas it's a minor modification
2254 */
2255 public function doQuickEdit( $text, User $user, $comment = '', $minor = 0 ) {
2256 wfProfileIn( __METHOD__ );
2257
2258 $dbw = wfGetDB( DB_MASTER );
2259 $revision = new Revision( array(
2260 'page' => $this->getId(),
2261 'text' => $text,
2262 'comment' => $comment,
2263 'minor_edit' => $minor ? 1 : 0,
2264 ) );
2265 $revision->insertOn( $dbw );
2266 $this->updateRevisionOn( $dbw, $revision );
2267
2268 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $revision, false, $user ) );
2269
2270 wfProfileOut( __METHOD__ );
2271 }
2272
2273 /**
2274 * The onArticle*() functions are supposed to be a kind of hooks
2275 * which should be called whenever any of the specified actions
2276 * are done.
2277 *
2278 * This is a good place to put code to clear caches, for instance.
2279 *
2280 * This is called on page move and undelete, as well as edit
2281 *
2282 * @param $title Title object
2283 */
2284 public static function onArticleCreate( $title ) {
2285 # Update existence markers on article/talk tabs...
2286 if ( $title->isTalkPage() ) {
2287 $other = $title->getSubjectPage();
2288 } else {
2289 $other = $title->getTalkPage();
2290 }
2291
2292 $other->invalidateCache();
2293 $other->purgeSquid();
2294
2295 $title->touchLinks();
2296 $title->purgeSquid();
2297 $title->deleteTitleProtection();
2298 }
2299
2300 /**
2301 * Clears caches when article is deleted
2302 *
2303 * @param $title Title
2304 */
2305 public static function onArticleDelete( $title ) {
2306 # Update existence markers on article/talk tabs...
2307 if ( $title->isTalkPage() ) {
2308 $other = $title->getSubjectPage();
2309 } else {
2310 $other = $title->getTalkPage();
2311 }
2312
2313 $other->invalidateCache();
2314 $other->purgeSquid();
2315
2316 $title->touchLinks();
2317 $title->purgeSquid();
2318
2319 # File cache
2320 HTMLFileCache::clearFileCache( $title );
2321
2322 # Messages
2323 if ( $title->getNamespace() == NS_MEDIAWIKI ) {
2324 MessageCache::singleton()->replace( $title->getDBkey(), false );
2325 }
2326
2327 # Images
2328 if ( $title->getNamespace() == NS_FILE ) {
2329 $update = new HTMLCacheUpdate( $title, 'imagelinks' );
2330 $update->doUpdate();
2331 }
2332
2333 # User talk pages
2334 if ( $title->getNamespace() == NS_USER_TALK ) {
2335 $user = User::newFromName( $title->getText(), false );
2336 if ( $user ) {
2337 $user->setNewtalk( false );
2338 }
2339 }
2340
2341 # Image redirects
2342 RepoGroup::singleton()->getLocalRepo()->invalidateImageRedirect( $title );
2343 }
2344
2345 /**
2346 * Purge caches on page update etc
2347 *
2348 * @param $title Title object
2349 * @todo: verify that $title is always a Title object (and never false or null), add Title hint to parameter $title
2350 */
2351 public static function onArticleEdit( $title ) {
2352 // Invalidate caches of articles which include this page
2353 DeferredUpdates::addHTMLCacheUpdate( $title, 'templatelinks' );
2354
2355
2356 // Invalidate the caches of all pages which redirect here
2357 DeferredUpdates::addHTMLCacheUpdate( $title, 'redirect' );
2358
2359 # Purge squid for this page only
2360 $title->purgeSquid();
2361
2362 # Clear file cache for this page only
2363 HTMLFileCache::clearFileCache( $title );
2364 }
2365
2366 /**#@-*/
2367
2368 /**
2369 * Return a list of templates used by this article.
2370 * Uses the templatelinks table
2371 *
2372 * @return Array of Title objects
2373 */
2374 public function getUsedTemplates() {
2375 $result = array();
2376 $id = $this->mTitle->getArticleID();
2377
2378 if ( $id == 0 ) {
2379 return array();
2380 }
2381
2382 $dbr = wfGetDB( DB_SLAVE );
2383 $res = $dbr->select( array( 'templatelinks' ),
2384 array( 'tl_namespace', 'tl_title' ),
2385 array( 'tl_from' => $id ),
2386 __METHOD__ );
2387
2388 if ( $res !== false ) {
2389 foreach ( $res as $row ) {
2390 $result[] = Title::makeTitle( $row->tl_namespace, $row->tl_title );
2391 }
2392 }
2393
2394 return $result;
2395 }
2396
2397 /**
2398 * Returns a list of hidden categories this page is a member of.
2399 * Uses the page_props and categorylinks tables.
2400 *
2401 * @return Array of Title objects
2402 */
2403 public function getHiddenCategories() {
2404 $result = array();
2405 $id = $this->mTitle->getArticleID();
2406
2407 if ( $id == 0 ) {
2408 return array();
2409 }
2410
2411 $dbr = wfGetDB( DB_SLAVE );
2412 $res = $dbr->select( array( 'categorylinks', 'page_props', 'page' ),
2413 array( 'cl_to' ),
2414 array( 'cl_from' => $id, 'pp_page=page_id', 'pp_propname' => 'hiddencat',
2415 'page_namespace' => NS_CATEGORY, 'page_title=cl_to' ),
2416 __METHOD__ );
2417
2418 if ( $res !== false ) {
2419 foreach ( $res as $row ) {
2420 $result[] = Title::makeTitle( NS_CATEGORY, $row->cl_to );
2421 }
2422 }
2423
2424 return $result;
2425 }
2426
2427 /**
2428 * Return an applicable autosummary if one exists for the given edit.
2429 * @param $oldtext String: the previous text of the page.
2430 * @param $newtext String: The submitted text of the page.
2431 * @param $flags Int bitmask: a bitmask of flags submitted for the edit.
2432 * @return string An appropriate autosummary, or an empty string.
2433 */
2434 public static function getAutosummary( $oldtext, $newtext, $flags ) {
2435 global $wgContLang;
2436
2437 # Decide what kind of autosummary is needed.
2438
2439 # Redirect autosummaries
2440 $ot = Title::newFromRedirect( $oldtext );
2441 $rt = Title::newFromRedirect( $newtext );
2442
2443 if ( is_object( $rt ) && ( !is_object( $ot ) || !$rt->equals( $ot ) || $ot->getFragment() != $rt->getFragment() ) ) {
2444 $truncatedtext = $wgContLang->truncate(
2445 str_replace( "\n", ' ', $newtext ),
2446 max( 0, 250
2447 - strlen( wfMsgForContent( 'autoredircomment' ) )
2448 - strlen( $rt->getFullText() )
2449 ) );
2450 return wfMsgForContent( 'autoredircomment', $rt->getFullText(), $truncatedtext );
2451 }
2452
2453 # New page autosummaries
2454 if ( $flags & EDIT_NEW && strlen( $newtext ) ) {
2455 # If they're making a new article, give its text, truncated, in the summary.
2456
2457 $truncatedtext = $wgContLang->truncate(
2458 str_replace( "\n", ' ', $newtext ),
2459 max( 0, 200 - strlen( wfMsgForContent( 'autosumm-new' ) ) ) );
2460
2461 return wfMsgForContent( 'autosumm-new', $truncatedtext );
2462 }
2463
2464 # Blanking autosummaries
2465 if ( $oldtext != '' && $newtext == '' ) {
2466 return wfMsgForContent( 'autosumm-blank' );
2467 } elseif ( strlen( $oldtext ) > 10 * strlen( $newtext ) && strlen( $newtext ) < 500 ) {
2468 # Removing more than 90% of the article
2469
2470 $truncatedtext = $wgContLang->truncate(
2471 $newtext,
2472 max( 0, 200 - strlen( wfMsgForContent( 'autosumm-replace' ) ) ) );
2473
2474 return wfMsgForContent( 'autosumm-replace', $truncatedtext );
2475 }
2476
2477 # If we reach this point, there's no applicable autosummary for our case, so our
2478 # autosummary is empty.
2479 return '';
2480 }
2481
2482 /**
2483 * Auto-generates a deletion reason
2484 *
2485 * @param &$hasHistory Boolean: whether the page has a history
2486 * @return mixed String containing deletion reason or empty string, or boolean false
2487 * if no revision occurred
2488 */
2489 public function getAutoDeleteReason( &$hasHistory ) {
2490 global $wgContLang;
2491
2492 $dbw = wfGetDB( DB_MASTER );
2493 // Get the last revision
2494 $rev = Revision::newFromTitle( $this->getTitle() );
2495
2496 if ( is_null( $rev ) ) {
2497 return false;
2498 }
2499
2500 // Get the article's contents
2501 $contents = $rev->getText();
2502 $blank = false;
2503
2504 // If the page is blank, use the text from the previous revision,
2505 // which can only be blank if there's a move/import/protect dummy revision involved
2506 if ( $contents == '' ) {
2507 $prev = $rev->getPrevious();
2508
2509 if ( $prev ) {
2510 $contents = $prev->getText();
2511 $blank = true;
2512 }
2513 }
2514
2515 // Find out if there was only one contributor
2516 // Only scan the last 20 revisions
2517 $res = $dbw->select( 'revision', 'rev_user_text',
2518 array( 'rev_page' => $this->getID(), $dbw->bitAnd( 'rev_deleted', Revision::DELETED_USER ) . ' = 0' ),
2519 __METHOD__,
2520 array( 'LIMIT' => 20 )
2521 );
2522
2523 if ( $res === false ) {
2524 // This page has no revisions, which is very weird
2525 return false;
2526 }
2527
2528 $hasHistory = ( $res->numRows() > 1 );
2529 $row = $dbw->fetchObject( $res );
2530
2531 if ( $row ) { // $row is false if the only contributor is hidden
2532 $onlyAuthor = $row->rev_user_text;
2533 // Try to find a second contributor
2534 foreach ( $res as $row ) {
2535 if ( $row->rev_user_text != $onlyAuthor ) { // Bug 22999
2536 $onlyAuthor = false;
2537 break;
2538 }
2539 }
2540 } else {
2541 $onlyAuthor = false;
2542 }
2543
2544 // Generate the summary with a '$1' placeholder
2545 if ( $blank ) {
2546 // The current revision is blank and the one before is also
2547 // blank. It's just not our lucky day
2548 $reason = wfMsgForContent( 'exbeforeblank', '$1' );
2549 } else {
2550 if ( $onlyAuthor ) {
2551 $reason = wfMsgForContent( 'excontentauthor', '$1', $onlyAuthor );
2552 } else {
2553 $reason = wfMsgForContent( 'excontent', '$1' );
2554 }
2555 }
2556
2557 if ( $reason == '-' ) {
2558 // Allow these UI messages to be blanked out cleanly
2559 return '';
2560 }
2561
2562 // Replace newlines with spaces to prevent uglyness
2563 $contents = preg_replace( "/[\n\r]/", ' ', $contents );
2564 // Calculate the maximum amount of chars to get
2565 // Max content length = max comment length - length of the comment (excl. $1)
2566 $maxLength = 255 - ( strlen( $reason ) - 2 );
2567 $contents = $wgContLang->truncate( $contents, $maxLength );
2568 // Remove possible unfinished links
2569 $contents = preg_replace( '/\[\[([^\]]*)\]?$/', '$1', $contents );
2570 // Now replace the '$1' placeholder
2571 $reason = str_replace( '$1', $contents, $reason );
2572
2573 return $reason;
2574 }
2575
2576 /**
2577 * Get parser options suitable for rendering the primary article wikitext
2578 * @param User|string $user User object or 'canonical'
2579 * @return ParserOptions
2580 */
2581 public function makeParserOptions( $user ) {
2582 global $wgContLang;
2583 if ( $user instanceof User ) { // settings per user (even anons)
2584 $options = ParserOptions::newFromUser( $user );
2585 } else { // canonical settings
2586 $options = ParserOptions::newFromUserAndLang( new User, $wgContLang );
2587 }
2588 $options->enableLimitReport(); // show inclusion/loop reports
2589 $options->setTidy( true ); // fix bad HTML
2590 return $options;
2591 }
2592
2593 /**
2594 * Update all the appropriate counts in the category table, given that
2595 * we've added the categories $added and deleted the categories $deleted.
2596 *
2597 * @param $added array The names of categories that were added
2598 * @param $deleted array The names of categories that were deleted
2599 */
2600 public function updateCategoryCounts( $added, $deleted ) {
2601 $ns = $this->mTitle->getNamespace();
2602 $dbw = wfGetDB( DB_MASTER );
2603
2604 # First make sure the rows exist. If one of the "deleted" ones didn't
2605 # exist, we might legitimately not create it, but it's simpler to just
2606 # create it and then give it a negative value, since the value is bogus
2607 # anyway.
2608 #
2609 # Sometimes I wish we had INSERT ... ON DUPLICATE KEY UPDATE.
2610 $insertCats = array_merge( $added, $deleted );
2611 if ( !$insertCats ) {
2612 # Okay, nothing to do
2613 return;
2614 }
2615
2616 $insertRows = array();
2617
2618 foreach ( $insertCats as $cat ) {
2619 $insertRows[] = array(
2620 'cat_id' => $dbw->nextSequenceValue( 'category_cat_id_seq' ),
2621 'cat_title' => $cat
2622 );
2623 }
2624 $dbw->insert( 'category', $insertRows, __METHOD__, 'IGNORE' );
2625
2626 $addFields = array( 'cat_pages = cat_pages + 1' );
2627 $removeFields = array( 'cat_pages = cat_pages - 1' );
2628
2629 if ( $ns == NS_CATEGORY ) {
2630 $addFields[] = 'cat_subcats = cat_subcats + 1';
2631 $removeFields[] = 'cat_subcats = cat_subcats - 1';
2632 } elseif ( $ns == NS_FILE ) {
2633 $addFields[] = 'cat_files = cat_files + 1';
2634 $removeFields[] = 'cat_files = cat_files - 1';
2635 }
2636
2637 if ( $added ) {
2638 $dbw->update(
2639 'category',
2640 $addFields,
2641 array( 'cat_title' => $added ),
2642 __METHOD__
2643 );
2644 }
2645
2646 if ( $deleted ) {
2647 $dbw->update(
2648 'category',
2649 $removeFields,
2650 array( 'cat_title' => $deleted ),
2651 __METHOD__
2652 );
2653 }
2654 }
2655
2656 /**
2657 * Updates cascading protections
2658 *
2659 * @param $parserOutput ParserOutput object for the current version
2660 */
2661 public function doCascadeProtectionUpdates( ParserOutput $parserOutput ) {
2662 if ( wfReadOnly() || !$this->mTitle->areRestrictionsCascading() ) {
2663 return;
2664 }
2665
2666 // templatelinks table may have become out of sync,
2667 // especially if using variable-based transclusions.
2668 // For paranoia, check if things have changed and if
2669 // so apply updates to the database. This will ensure
2670 // that cascaded protections apply as soon as the changes
2671 // are visible.
2672
2673 # Get templates from templatelinks
2674 $id = $this->mTitle->getArticleID();
2675
2676 $tlTemplates = array();
2677
2678 $dbr = wfGetDB( DB_SLAVE );
2679 $res = $dbr->select( array( 'templatelinks' ),
2680 array( 'tl_namespace', 'tl_title' ),
2681 array( 'tl_from' => $id ),
2682 __METHOD__
2683 );
2684
2685 foreach ( $res as $row ) {
2686 $tlTemplates["{$row->tl_namespace}:{$row->tl_title}"] = true;
2687 }
2688
2689 # Get templates from parser output.
2690 $poTemplates = array();
2691 foreach ( $parserOutput->getTemplates() as $ns => $templates ) {
2692 foreach ( $templates as $dbk => $id ) {
2693 $poTemplates["$ns:$dbk"] = true;
2694 }
2695 }
2696
2697 # Get the diff
2698 $templates_diff = array_diff_key( $poTemplates, $tlTemplates );
2699
2700 if ( count( $templates_diff ) > 0 ) {
2701 # Whee, link updates time.
2702 $u = new LinksUpdate( $this->mTitle, $parserOutput, false );
2703 $u->doUpdate();
2704 }
2705 }
2706
2707 /**
2708 * Update the article's restriction field, and leave a log entry.
2709 *
2710 * @deprecated since 1.19
2711 * @param $limit Array: set of restriction keys
2712 * @param $reason String
2713 * @param &$cascade Integer. Set to false if cascading protection isn't allowed.
2714 * @param $expiry Array: per restriction type expiration
2715 * @param $user User The user updating the restrictions
2716 * @return bool true on success
2717 */
2718 public function updateRestrictions(
2719 $limit = array(), $reason = '', &$cascade = 0, $expiry = array(), User $user = null
2720 ) {
2721 global $wgUser;
2722
2723 $user = is_null( $user ) ? $wgUser : $user;
2724
2725 return $this->doUpdateRestrictions( $limit, $expiry, $cascade, $reason, $user )->isOK();
2726 }
2727
2728 /**
2729 * @deprecated since 1.18
2730 */
2731 public function quickEdit( $text, $comment = '', $minor = 0 ) {
2732 wfDeprecated( __METHOD__, '1.18' );
2733 global $wgUser;
2734 return $this->doQuickEdit( $text, $wgUser, $comment, $minor );
2735 }
2736
2737 /**
2738 * @deprecated since 1.18
2739 */
2740 public function viewUpdates() {
2741 wfDeprecated( __METHOD__, '1.18' );
2742 global $wgUser;
2743 return $this->doViewUpdates( $wgUser );
2744 }
2745
2746 /**
2747 * @deprecated since 1.18
2748 */
2749 public function useParserCache( $oldid ) {
2750 wfDeprecated( __METHOD__, '1.18' );
2751 global $wgUser;
2752 return $this->isParserCacheUsed( ParserOptions::newFromUser( $wgUser ), $oldid );
2753 }
2754 }
2755
2756 class PoolWorkArticleView extends PoolCounterWork {
2757
2758 /**
2759 * @var Page
2760 */
2761 private $page;
2762
2763 /**
2764 * @var string
2765 */
2766 private $cacheKey;
2767
2768 /**
2769 * @var integer
2770 */
2771 private $revid;
2772
2773 /**
2774 * @var ParserOptions
2775 */
2776 private $parserOptions;
2777
2778 /**
2779 * @var string|null
2780 */
2781 private $text;
2782
2783 /**
2784 * @var ParserOutput|false
2785 */
2786 private $parserOutput = false;
2787
2788 /**
2789 * @var bool
2790 */
2791 private $isDirty = false;
2792
2793 /**
2794 * @var Status|false
2795 */
2796 private $error = false;
2797
2798 /**
2799 * Constructor
2800 *
2801 * @param $page Page
2802 * @param $revid Integer: ID of the revision being parsed
2803 * @param $useParserCache Boolean: whether to use the parser cache
2804 * @param $parserOptions parserOptions to use for the parse operation
2805 * @param $text String: text to parse or null to load it
2806 */
2807 function __construct( Page $page, ParserOptions $parserOptions, $revid, $useParserCache, $text = null ) {
2808 $this->page = $page;
2809 $this->revid = $revid;
2810 $this->cacheable = $useParserCache;
2811 $this->parserOptions = $parserOptions;
2812 $this->text = $text;
2813 $this->cacheKey = ParserCache::singleton()->getKey( $page, $parserOptions );
2814 parent::__construct( 'ArticleView', $this->cacheKey . ':revid:' . $revid );
2815 }
2816
2817 /**
2818 * Get the ParserOutput from this object, or false in case of failure
2819 *
2820 * @return ParserOutput
2821 */
2822 public function getParserOutput() {
2823 return $this->parserOutput;
2824 }
2825
2826 /**
2827 * Get whether the ParserOutput is a dirty one (i.e. expired)
2828 *
2829 * @return bool
2830 */
2831 public function getIsDirty() {
2832 return $this->isDirty;
2833 }
2834
2835 /**
2836 * Get a Status object in case of error or false otherwise
2837 *
2838 * @return Status|false
2839 */
2840 public function getError() {
2841 return $this->error;
2842 }
2843
2844 /**
2845 * @return bool
2846 */
2847 function doWork() {
2848 global $wgParser, $wgUseFileCache;
2849
2850 $isCurrent = $this->revid === $this->page->getLatest();
2851
2852 if ( $this->text !== null ) {
2853 $text = $this->text;
2854 } elseif ( $isCurrent ) {
2855 $text = $this->page->getRawText();
2856 } else {
2857 $rev = Revision::newFromTitle( $this->page->getTitle(), $this->revid );
2858 if ( $rev === null ) {
2859 return false;
2860 }
2861 $text = $rev->getText();
2862 }
2863
2864 $time = - wfTime();
2865 $this->parserOutput = $wgParser->parse( $text, $this->page->getTitle(),
2866 $this->parserOptions, true, true, $this->revid );
2867 $time += wfTime();
2868
2869 # Timing hack
2870 if ( $time > 3 ) {
2871 wfDebugLog( 'slow-parse', sprintf( "%-5.2f %s", $time,
2872 $this->page->getTitle()->getPrefixedDBkey() ) );
2873 }
2874
2875 if ( $this->cacheable && $this->parserOutput->isCacheable() ) {
2876 ParserCache::singleton()->save( $this->parserOutput, $this->page, $this->parserOptions );
2877 }
2878
2879 // Make sure file cache is not used on uncacheable content.
2880 // Output that has magic words in it can still use the parser cache
2881 // (if enabled), though it will generally expire sooner.
2882 if ( !$this->parserOutput->isCacheable() || $this->parserOutput->containsOldMagic() ) {
2883 $wgUseFileCache = false;
2884 }
2885
2886 if ( $isCurrent ) {
2887 $this->page->doCascadeProtectionUpdates( $this->parserOutput );
2888 }
2889
2890 return true;
2891 }
2892
2893 /**
2894 * @return bool
2895 */
2896 function getCachedWork() {
2897 $this->parserOutput = ParserCache::singleton()->get( $this->page, $this->parserOptions );
2898
2899 if ( $this->parserOutput === false ) {
2900 wfDebug( __METHOD__ . ": parser cache miss\n" );
2901 return false;
2902 } else {
2903 wfDebug( __METHOD__ . ": parser cache hit\n" );
2904 return true;
2905 }
2906 }
2907
2908 /**
2909 * @return bool
2910 */
2911 function fallback() {
2912 $this->parserOutput = ParserCache::singleton()->getDirty( $this->page, $this->parserOptions );
2913
2914 if ( $this->parserOutput === false ) {
2915 wfDebugLog( 'dirty', "dirty missing\n" );
2916 wfDebug( __METHOD__ . ": no dirty cache\n" );
2917 return false;
2918 } else {
2919 wfDebug( __METHOD__ . ": sending dirty output\n" );
2920 wfDebugLog( 'dirty', "dirty output {$this->cacheKey}\n" );
2921 $this->isDirty = true;
2922 return true;
2923 }
2924 }
2925
2926 /**
2927 * @param $status Status
2928 */
2929 function error( $status ) {
2930 $this->error = $status;
2931 return false;
2932 }
2933 }