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