a99058da31a2215bf94d96f659fd7239f32e71b9
[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 WikiPage::setTimestamp()
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->isWikitextPage();
720 }
721
722 /**
723 * Perform the actions of a page purging
724 */
725 public function doPurge() {
726 global $wgUseSquid;
727
728 if( !wfRunHooks( 'ArticlePurge', array( &$this ) ) ){
729 return false;
730 }
731
732 // Invalidate the cache
733 $this->mTitle->invalidateCache();
734 $this->clear();
735
736 if ( $wgUseSquid ) {
737 // Commit the transaction before the purge is sent
738 $dbw = wfGetDB( DB_MASTER );
739 $dbw->commit();
740
741 // Send purge
742 $update = SquidUpdate::newSimplePurge( $this->mTitle );
743 $update->doUpdate();
744 }
745
746 if ( $this->mTitle->getNamespace() == NS_MEDIAWIKI ) {
747 if ( $this->getId() == 0 ) {
748 $text = false;
749 } else {
750 $text = $this->getRawText();
751 }
752
753 MessageCache::singleton()->replace( $this->mTitle->getDBkey(), $text );
754 }
755 }
756
757 /**
758 * Insert a new empty page record for this article.
759 * This *must* be followed up by creating a revision
760 * and running $this->updateRevisionOn( ... );
761 * or else the record will be left in a funky state.
762 * Best if all done inside a transaction.
763 *
764 * @param $dbw DatabaseBase
765 * @return int The newly created page_id key, or false if the title already existed
766 * @private
767 */
768 public function insertOn( $dbw ) {
769 wfProfileIn( __METHOD__ );
770
771 $page_id = $dbw->nextSequenceValue( 'page_page_id_seq' );
772 $dbw->insert( 'page', array(
773 'page_id' => $page_id,
774 'page_namespace' => $this->mTitle->getNamespace(),
775 'page_title' => $this->mTitle->getDBkey(),
776 'page_counter' => 0,
777 'page_restrictions' => '',
778 'page_is_redirect' => 0, # Will set this shortly...
779 'page_is_new' => 1,
780 'page_random' => wfRandom(),
781 'page_touched' => $dbw->timestamp(),
782 'page_latest' => 0, # Fill this in shortly...
783 'page_len' => 0, # Fill this in shortly...
784 ), __METHOD__, 'IGNORE' );
785
786 $affected = $dbw->affectedRows();
787
788 if ( $affected ) {
789 $newid = $dbw->insertId();
790 $this->mTitle->resetArticleID( $newid );
791 }
792 wfProfileOut( __METHOD__ );
793
794 return $affected ? $newid : false;
795 }
796
797 /**
798 * Update the page record to point to a newly saved revision.
799 *
800 * @param $dbw DatabaseBase: object
801 * @param $revision Revision: For ID number, and text used to set
802 * length and redirect status fields
803 * @param $lastRevision Integer: if given, will not overwrite the page field
804 * when different from the currently set value.
805 * Giving 0 indicates the new page flag should be set
806 * on.
807 * @param $lastRevIsRedirect Boolean: if given, will optimize adding and
808 * removing rows in redirect table.
809 * @return bool true on success, false on failure
810 * @private
811 */
812 public function updateRevisionOn( $dbw, $revision, $lastRevision = null, $lastRevIsRedirect = null ) {
813 wfProfileIn( __METHOD__ );
814
815 $text = $revision->getText();
816 $rt = Title::newFromRedirectRecurse( $text );
817
818 $conditions = array( 'page_id' => $this->getId() );
819
820 if ( !is_null( $lastRevision ) ) {
821 # An extra check against threads stepping on each other
822 $conditions['page_latest'] = $lastRevision;
823 }
824
825 $now = wfTimestampNow();
826 $dbw->update( 'page',
827 array( /* SET */
828 'page_latest' => $revision->getId(),
829 'page_touched' => $dbw->timestamp( $now ),
830 'page_is_new' => ( $lastRevision === 0 ) ? 1 : 0,
831 'page_is_redirect' => $rt !== null ? 1 : 0,
832 'page_len' => strlen( $text ),
833 ),
834 $conditions,
835 __METHOD__ );
836
837 $result = $dbw->affectedRows() != 0;
838 if ( $result ) {
839 $this->updateRedirectOn( $dbw, $rt, $lastRevIsRedirect );
840 $this->setCachedLastEditTime( $now );
841 }
842
843 wfProfileOut( __METHOD__ );
844 return $result;
845 }
846
847 /**
848 * Get the cached timestamp for the last time the page changed.
849 * This is only used to help handle slave lag by comparing to page_touched.
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 * This is only used to help handle slave lag by comparing to page_touched.
861 * @param $timestamp string
862 * @return void
863 */
864 public function setCachedLastEditTime( $timestamp ) {
865 global $wgMemc;
866 $key = wfMemcKey( 'page-lastedit', md5( $this->mTitle->getPrefixedDBkey() ) );
867 $wgMemc->set( $key, wfTimestamp( TS_MW, $timestamp ), 60*15 );
868 }
869
870 /**
871 * Add row to the redirect table if this is a redirect, remove otherwise.
872 *
873 * @param $dbw DatabaseBase
874 * @param $redirectTitle Title object pointing to the redirect target,
875 * or NULL if this is not a redirect
876 * @param $lastRevIsRedirect If given, will optimize adding and
877 * removing rows in redirect table.
878 * @return bool true on success, false on failure
879 * @private
880 */
881 public function updateRedirectOn( $dbw, $redirectTitle, $lastRevIsRedirect = null ) {
882 // Always update redirects (target link might have changed)
883 // Update/Insert if we don't know if the last revision was a redirect or not
884 // Delete if changing from redirect to non-redirect
885 $isRedirect = !is_null( $redirectTitle );
886
887 if ( !$isRedirect && !is_null( $lastRevIsRedirect ) && $lastRevIsRedirect === $isRedirect ) {
888 return true;
889 }
890
891 wfProfileIn( __METHOD__ );
892 if ( $isRedirect ) {
893 $this->insertRedirectEntry( $redirectTitle );
894 } else {
895 // This is not a redirect, remove row from redirect table
896 $where = array( 'rd_from' => $this->getId() );
897 $dbw->delete( 'redirect', $where, __METHOD__ );
898 }
899
900 if ( $this->getTitle()->getNamespace() == NS_FILE ) {
901 RepoGroup::singleton()->getLocalRepo()->invalidateImageRedirect( $this->getTitle() );
902 }
903 wfProfileOut( __METHOD__ );
904
905 return ( $dbw->affectedRows() != 0 );
906 }
907
908 /**
909 * If the given revision is newer than the currently set page_latest,
910 * update the page record. Otherwise, do nothing.
911 *
912 * @param $dbw Database object
913 * @param $revision Revision object
914 * @return mixed
915 */
916 public function updateIfNewerOn( $dbw, $revision ) {
917 wfProfileIn( __METHOD__ );
918
919 $row = $dbw->selectRow(
920 array( 'revision', 'page' ),
921 array( 'rev_id', 'rev_timestamp', 'page_is_redirect' ),
922 array(
923 'page_id' => $this->getId(),
924 'page_latest=rev_id' ),
925 __METHOD__ );
926
927 if ( $row ) {
928 if ( wfTimestamp( TS_MW, $row->rev_timestamp ) >= $revision->getTimestamp() ) {
929 wfProfileOut( __METHOD__ );
930 return false;
931 }
932 $prev = $row->rev_id;
933 $lastRevIsRedirect = (bool)$row->page_is_redirect;
934 } else {
935 # No or missing previous revision; mark the page as new
936 $prev = 0;
937 $lastRevIsRedirect = null;
938 }
939
940 $ret = $this->updateRevisionOn( $dbw, $revision, $prev, $lastRevIsRedirect );
941
942 wfProfileOut( __METHOD__ );
943 return $ret;
944 }
945
946 /**
947 * @param $section empty/null/false or a section number (0, 1, 2, T1, T2...)
948 * @param $text String: new text of the section
949 * @param $summary String: new section's subject, only if $section is 'new'
950 * @param $edittime String: revision timestamp or null to use the current revision
951 * @return string Complete article text, or null if error
952 */
953 public function replaceSection( $section, $text, $summary = '', $edittime = null ) {
954 wfProfileIn( __METHOD__ );
955
956 if ( strval( $section ) == '' ) {
957 // Whole-page edit; let the whole text through
958 } else {
959 if ( is_null( $edittime ) ) {
960 $rev = Revision::newFromTitle( $this->mTitle );
961 } else {
962 $dbw = wfGetDB( DB_MASTER );
963 $rev = Revision::loadFromTimestamp( $dbw, $this->mTitle, $edittime );
964 }
965
966 if ( !$rev ) {
967 wfDebug( "WikiPage::replaceSection asked for bogus section (page: " .
968 $this->getId() . "; section: $section; edittime: $edittime)\n" );
969 wfProfileOut( __METHOD__ );
970 return null;
971 }
972
973 $oldtext = $rev->getText();
974
975 if ( $section == 'new' ) {
976 # Inserting a new section
977 $subject = $summary ? wfMsgForContent( 'newsectionheaderdefaultlevel', $summary ) . "\n\n" : '';
978 $text = strlen( trim( $oldtext ) ) > 0
979 ? "{$oldtext}\n\n{$subject}{$text}"
980 : "{$subject}{$text}";
981 } else {
982 # Replacing an existing section; roll out the big guns
983 global $wgParser;
984
985 $text = $wgParser->replaceSection( $oldtext, $section, $text );
986 }
987 }
988
989 wfProfileOut( __METHOD__ );
990 return $text;
991 }
992
993 /**
994 * Check flags and add EDIT_NEW or EDIT_UPDATE to them as needed.
995 * @param $flags Int
996 * @return Int updated $flags
997 */
998 function checkFlags( $flags ) {
999 if ( !( $flags & EDIT_NEW ) && !( $flags & EDIT_UPDATE ) ) {
1000 if ( $this->mTitle->getArticleID() ) {
1001 $flags |= EDIT_UPDATE;
1002 } else {
1003 $flags |= EDIT_NEW;
1004 }
1005 }
1006
1007 return $flags;
1008 }
1009
1010 /**
1011 * Change an existing article or create a new article. Updates RC and all necessary caches,
1012 * optionally via the deferred update array.
1013 *
1014 * @param $text String: new text
1015 * @param $summary String: edit summary
1016 * @param $flags Integer bitfield:
1017 * EDIT_NEW
1018 * Article is known or assumed to be non-existent, create a new one
1019 * EDIT_UPDATE
1020 * Article is known or assumed to be pre-existing, update it
1021 * EDIT_MINOR
1022 * Mark this edit minor, if the user is allowed to do so
1023 * EDIT_SUPPRESS_RC
1024 * Do not log the change in recentchanges
1025 * EDIT_FORCE_BOT
1026 * Mark the edit a "bot" edit regardless of user rights
1027 * EDIT_DEFER_UPDATES
1028 * Defer some of the updates until the end of index.php
1029 * EDIT_AUTOSUMMARY
1030 * Fill in blank summaries with generated text where possible
1031 *
1032 * If neither EDIT_NEW nor EDIT_UPDATE is specified, the status of the article will be detected.
1033 * If EDIT_UPDATE is specified and the article doesn't exist, the function will return an
1034 * edit-gone-missing error. If EDIT_NEW is specified and the article does exist, an
1035 * edit-already-exists error will be returned. These two conditions are also possible with
1036 * auto-detection due to MediaWiki's performance-optimised locking strategy.
1037 *
1038 * @param $baseRevId the revision ID this edit was based off, if any
1039 * @param $user User the user doing the edit
1040 *
1041 * @return Status object. Possible errors:
1042 * edit-hook-aborted: The ArticleSave hook aborted the edit but didn't set the fatal flag of $status
1043 * edit-gone-missing: In update mode, but the article didn't exist
1044 * edit-conflict: In update mode, the article changed unexpectedly
1045 * edit-no-change: Warning that the text was the same as before
1046 * edit-already-exists: In creation mode, but the article already exists
1047 *
1048 * Extensions may define additional errors.
1049 *
1050 * $return->value will contain an associative array with members as follows:
1051 * new: Boolean indicating if the function attempted to create a new article
1052 * revision: The revision object for the inserted revision, or null
1053 *
1054 * Compatibility note: this function previously returned a boolean value indicating success/failure
1055 */
1056 public function doEdit( $text, $summary, $flags = 0, $baseRevId = false, $user = null ) {
1057 global $wgUser, $wgDBtransactions, $wgUseAutomaticEditSummaries;
1058
1059 # Low-level sanity check
1060 if ( $this->mTitle->getText() === '' ) {
1061 throw new MWException( 'Something is trying to edit an article with an empty title' );
1062 }
1063
1064 wfProfileIn( __METHOD__ );
1065
1066 $user = is_null( $user ) ? $wgUser : $user;
1067 $status = Status::newGood( array() );
1068
1069 # Load $this->mTitle->getArticleID() and $this->mLatest if it's not already
1070 $this->loadPageData();
1071
1072 $flags = $this->checkFlags( $flags );
1073
1074 if ( !wfRunHooks( 'ArticleSave', array( &$this, &$user, &$text, &$summary,
1075 $flags & EDIT_MINOR, null, null, &$flags, &$status ) ) )
1076 {
1077 wfDebug( __METHOD__ . ": ArticleSave hook aborted save!\n" );
1078
1079 if ( $status->isOK() ) {
1080 $status->fatal( 'edit-hook-aborted' );
1081 }
1082
1083 wfProfileOut( __METHOD__ );
1084 return $status;
1085 }
1086
1087 # Silently ignore EDIT_MINOR if not allowed
1088 $isminor = ( $flags & EDIT_MINOR ) && $user->isAllowed( 'minoredit' );
1089 $bot = $flags & EDIT_FORCE_BOT;
1090
1091 $oldtext = $this->getRawText(); // current revision
1092 $oldsize = strlen( $oldtext );
1093 $oldcountable = $this->isCountable();
1094
1095 # Provide autosummaries if one is not provided and autosummaries are enabled.
1096 if ( $wgUseAutomaticEditSummaries && $flags & EDIT_AUTOSUMMARY && $summary == '' ) {
1097 $summary = self::getAutosummary( $oldtext, $text, $flags );
1098 }
1099
1100 $editInfo = $this->prepareTextForEdit( $text, null, $user );
1101 $text = $editInfo->pst;
1102 $newsize = strlen( $text );
1103
1104 $dbw = wfGetDB( DB_MASTER );
1105 $now = wfTimestampNow();
1106 $this->mTimestamp = $now;
1107
1108 if ( $flags & EDIT_UPDATE ) {
1109 # Update article, but only if changed.
1110 $status->value['new'] = false;
1111
1112 # Make sure the revision is either completely inserted or not inserted at all
1113 if ( !$wgDBtransactions ) {
1114 $userAbort = ignore_user_abort( true );
1115 }
1116
1117 $revision = new Revision( array(
1118 'page' => $this->getId(),
1119 'comment' => $summary,
1120 'minor_edit' => $isminor,
1121 'text' => $text,
1122 'parent_id' => $this->mLatest,
1123 'user' => $user->getId(),
1124 'user_text' => $user->getName(),
1125 'timestamp' => $now
1126 ) );
1127
1128 $changed = ( strcmp( $text, $oldtext ) != 0 );
1129
1130 if ( $changed ) {
1131 if ( !$this->mLatest ) {
1132 # Article gone missing
1133 wfDebug( __METHOD__ . ": EDIT_UPDATE specified but article doesn't exist\n" );
1134 $status->fatal( 'edit-gone-missing' );
1135
1136 wfProfileOut( __METHOD__ );
1137 return $status;
1138 }
1139
1140 $dbw->begin();
1141 $revisionId = $revision->insertOn( $dbw );
1142
1143 # Update page
1144 #
1145 # Note that we use $this->mLatest instead of fetching a value from the master DB
1146 # during the course of this function. This makes sure that EditPage can detect
1147 # edit conflicts reliably, either by $ok here, or by $article->getTimestamp()
1148 # before this function is called. A previous function used a separate query, this
1149 # creates a window where concurrent edits can cause an ignored edit conflict.
1150 $ok = $this->updateRevisionOn( $dbw, $revision, $this->mLatest );
1151
1152 if ( !$ok ) {
1153 /* Belated edit conflict! Run away!! */
1154 $status->fatal( 'edit-conflict' );
1155
1156 # Delete the invalid revision if the DB is not transactional
1157 if ( !$wgDBtransactions ) {
1158 $dbw->delete( 'revision', array( 'rev_id' => $revisionId ), __METHOD__ );
1159 }
1160
1161 $revisionId = 0;
1162 $dbw->rollback();
1163 } else {
1164 global $wgUseRCPatrol;
1165 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $revision, $baseRevId, $user ) );
1166 # Update recentchanges
1167 if ( !( $flags & EDIT_SUPPRESS_RC ) ) {
1168 # Mark as patrolled if the user can do so
1169 $patrolled = $wgUseRCPatrol && !count(
1170 $this->mTitle->getUserPermissionsErrors( 'autopatrol', $user ) );
1171 # Add RC row to the DB
1172 $rc = RecentChange::notifyEdit( $now, $this->mTitle, $isminor, $user, $summary,
1173 $this->mLatest, $this->getTimestamp(), $bot, '', $oldsize, $newsize,
1174 $revisionId, $patrolled
1175 );
1176
1177 # Log auto-patrolled edits
1178 if ( $patrolled ) {
1179 PatrolLog::record( $rc, true );
1180 }
1181 }
1182 $user->incEditCount();
1183 $dbw->commit();
1184 }
1185 }
1186
1187 if ( !$wgDBtransactions ) {
1188 ignore_user_abort( $userAbort );
1189 }
1190
1191 // Now that ignore_user_abort is restored, we can respond to fatal errors
1192 if ( !$status->isOK() ) {
1193 wfProfileOut( __METHOD__ );
1194 return $status;
1195 }
1196
1197 # Update links tables, site stats, etc.
1198 $this->doEditUpdates( $revision, $user, array( 'changed' => $changed,
1199 'oldcountable' => $oldcountable ) );
1200
1201 if ( !$changed ) {
1202 $status->warning( 'edit-no-change' );
1203 $revision = null;
1204 // Keep the same revision ID, but do some updates on it
1205 $revisionId = $this->getLatest();
1206 // Update page_touched, this is usually implicit in the page update
1207 // Other cache updates are done in onArticleEdit()
1208 $this->mTitle->invalidateCache();
1209 }
1210 } else {
1211 # Create new article
1212 $status->value['new'] = true;
1213
1214 $dbw->begin();
1215
1216 # Add the page record; stake our claim on this title!
1217 # This will return false if the article already exists
1218 $newid = $this->insertOn( $dbw );
1219
1220 if ( $newid === false ) {
1221 $dbw->rollback();
1222 $status->fatal( 'edit-already-exists' );
1223
1224 wfProfileOut( __METHOD__ );
1225 return $status;
1226 }
1227
1228 # Save the revision text...
1229 $revision = new Revision( array(
1230 'page' => $newid,
1231 'comment' => $summary,
1232 'minor_edit' => $isminor,
1233 'text' => $text,
1234 'user' => $user->getId(),
1235 'user_text' => $user->getName(),
1236 'timestamp' => $now
1237 ) );
1238 $revisionId = $revision->insertOn( $dbw );
1239
1240 $this->mTitle->resetArticleID( $newid );
1241 # Update the LinkCache. Resetting the Title ArticleID means it will rely on having that already cached
1242 # @todo FIXME?
1243 LinkCache::singleton()->addGoodLinkObj( $newid, $this->mTitle, strlen( $text ), (bool)Title::newFromRedirect( $text ), $revisionId );
1244
1245 # Update the page record with revision data
1246 $this->updateRevisionOn( $dbw, $revision, 0 );
1247
1248 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $revision, false, $user ) );
1249
1250 # Update recentchanges
1251 if ( !( $flags & EDIT_SUPPRESS_RC ) ) {
1252 global $wgUseRCPatrol, $wgUseNPPatrol;
1253
1254 # Mark as patrolled if the user can do so
1255 $patrolled = ( $wgUseRCPatrol || $wgUseNPPatrol ) && !count(
1256 $this->mTitle->getUserPermissionsErrors( 'autopatrol', $user ) );
1257 # Add RC row to the DB
1258 $rc = RecentChange::notifyNew( $now, $this->mTitle, $isminor, $user, $summary, $bot,
1259 '', strlen( $text ), $revisionId, $patrolled );
1260
1261 # Log auto-patrolled edits
1262 if ( $patrolled ) {
1263 PatrolLog::record( $rc, true );
1264 }
1265 }
1266 $user->incEditCount();
1267 $dbw->commit();
1268
1269 # Update links, etc.
1270 $this->doEditUpdates( $revision, $user, array( 'created' => true ) );
1271
1272 wfRunHooks( 'ArticleInsertComplete', array( &$this, &$user, $text, $summary,
1273 $flags & EDIT_MINOR, null, null, &$flags, $revision ) );
1274 }
1275
1276 # Do updates right now unless deferral was requested
1277 if ( !( $flags & EDIT_DEFER_UPDATES ) ) {
1278 DeferredUpdates::doUpdates();
1279 }
1280
1281 // Return the new revision (or null) to the caller
1282 $status->value['revision'] = $revision;
1283
1284 wfRunHooks( 'ArticleSaveComplete', array( &$this, &$user, $text, $summary,
1285 $flags & EDIT_MINOR, null, null, &$flags, $revision, &$status, $baseRevId ) );
1286
1287 # Promote user to any groups they meet the criteria for
1288 $user->addAutopromoteOnceGroups( 'onEdit' );
1289
1290 wfProfileOut( __METHOD__ );
1291 return $status;
1292 }
1293
1294 /**
1295 * Update the article's restriction field, and leave a log entry.
1296 *
1297 * @param $limit Array: set of restriction keys
1298 * @param $reason String
1299 * @param &$cascade Integer. Set to false if cascading protection isn't allowed.
1300 * @param $expiry Array: per restriction type expiration
1301 * @param $user User The user updating the restrictions
1302 * @return bool true on success
1303 */
1304 public function updateRestrictions(
1305 $limit = array(), $reason = '', &$cascade = 0, $expiry = array(), User $user = null
1306 ) {
1307 global $wgUser, $wgContLang;
1308 $user = is_null( $user ) ? $wgUser : $user;
1309
1310 $restrictionTypes = $this->mTitle->getRestrictionTypes();
1311
1312 $id = $this->mTitle->getArticleID();
1313
1314 if ( $id <= 0 ) {
1315 wfDebug( "updateRestrictions failed: article id $id <= 0\n" );
1316 return false;
1317 }
1318
1319 if ( wfReadOnly() ) {
1320 wfDebug( "updateRestrictions failed: read-only\n" );
1321 return false;
1322 }
1323
1324 if ( count( $this->mTitle->getUserPermissionsErrors( 'protect', $user ) ) ) {
1325 wfDebug( "updateRestrictions failed: insufficient permissions\n" );
1326 return false;
1327 }
1328
1329 if ( !$cascade ) {
1330 $cascade = false;
1331 }
1332
1333 // Take this opportunity to purge out expired restrictions
1334 Title::purgeExpiredRestrictions();
1335
1336 # @todo FIXME: Same limitations as described in ProtectionForm.php (line 37);
1337 # we expect a single selection, but the schema allows otherwise.
1338 $current = array();
1339 $updated = self::flattenRestrictions( $limit );
1340 $changed = false;
1341
1342 foreach ( $restrictionTypes as $action ) {
1343 if ( isset( $expiry[$action] ) ) {
1344 # Get current restrictions on $action
1345 $aLimits = $this->mTitle->getRestrictions( $action );
1346 $current[$action] = implode( '', $aLimits );
1347 # Are any actual restrictions being dealt with here?
1348 $aRChanged = count( $aLimits ) || !empty( $limit[$action] );
1349
1350 # If something changed, we need to log it. Checking $aRChanged
1351 # assures that "unprotecting" a page that is not protected does
1352 # not log just because the expiry was "changed".
1353 if ( $aRChanged &&
1354 $this->mTitle->getRestrictionExpiry( $action ) != $expiry[$action] )
1355 {
1356 $changed = true;
1357 }
1358 }
1359 }
1360
1361 $current = self::flattenRestrictions( $current );
1362
1363 $changed = ( $changed || $current != $updated );
1364 $changed = $changed || ( $updated && $this->mTitle->areRestrictionsCascading() != $cascade );
1365 $protect = ( $updated != '' );
1366
1367 # If nothing's changed, do nothing
1368 if ( $changed ) {
1369 if ( wfRunHooks( 'ArticleProtect', array( &$this, &$user, $limit, $reason ) ) ) {
1370 $dbw = wfGetDB( DB_MASTER );
1371
1372 # Prepare a null revision to be added to the history
1373 $modified = $current != '' && $protect;
1374
1375 if ( $protect ) {
1376 $comment_type = $modified ? 'modifiedarticleprotection' : 'protectedarticle';
1377 } else {
1378 $comment_type = 'unprotectedarticle';
1379 }
1380
1381 $comment = $wgContLang->ucfirst( wfMsgForContent( $comment_type, $this->mTitle->getPrefixedText() ) );
1382
1383 # Only restrictions with the 'protect' right can cascade...
1384 # Otherwise, people who cannot normally protect can "protect" pages via transclusion
1385 $editrestriction = isset( $limit['edit'] ) ? array( $limit['edit'] ) : $this->mTitle->getRestrictions( 'edit' );
1386
1387 # The schema allows multiple restrictions
1388 if ( !in_array( 'protect', $editrestriction ) && !in_array( 'sysop', $editrestriction ) ) {
1389 $cascade = false;
1390 }
1391
1392 $cascade_description = '';
1393
1394 if ( $cascade ) {
1395 $cascade_description = ' [' . wfMsgForContent( 'protect-summary-cascade' ) . ']';
1396 }
1397
1398 if ( $reason ) {
1399 $comment .= ": $reason";
1400 }
1401
1402 $editComment = $comment;
1403 $encodedExpiry = array();
1404 $protect_description = '';
1405 foreach ( $limit as $action => $restrictions ) {
1406 if ( !isset( $expiry[$action] ) )
1407 $expiry[$action] = $dbw->getInfinity();
1408
1409 $encodedExpiry[$action] = $dbw->encodeExpiry( $expiry[$action] );
1410 if ( $restrictions != '' ) {
1411 $protect_description .= $wgContLang->getDirMark() . "[$action=$restrictions] (";
1412 if ( $encodedExpiry[$action] != 'infinity' ) {
1413 $protect_description .= wfMsgForContent( 'protect-expiring',
1414 $wgContLang->timeanddate( $expiry[$action], false, false ) ,
1415 $wgContLang->date( $expiry[$action], false, false ) ,
1416 $wgContLang->time( $expiry[$action], false, false ) );
1417 } else {
1418 $protect_description .= wfMsgForContent( 'protect-expiry-indefinite' );
1419 }
1420
1421 $protect_description .= ') ';
1422 }
1423 }
1424 $protect_description = trim( $protect_description );
1425
1426 if ( $protect_description && $protect ) {
1427 $editComment .= " ($protect_description)";
1428 }
1429
1430 if ( $cascade ) {
1431 $editComment .= "$cascade_description";
1432 }
1433
1434 # Update restrictions table
1435 foreach ( $limit as $action => $restrictions ) {
1436 if ( $restrictions != '' ) {
1437 $dbw->replace( 'page_restrictions', array( array( 'pr_page', 'pr_type' ) ),
1438 array( 'pr_page' => $id,
1439 'pr_type' => $action,
1440 'pr_level' => $restrictions,
1441 'pr_cascade' => ( $cascade && $action == 'edit' ) ? 1 : 0,
1442 'pr_expiry' => $encodedExpiry[$action]
1443 ),
1444 __METHOD__
1445 );
1446 } else {
1447 $dbw->delete( 'page_restrictions', array( 'pr_page' => $id,
1448 'pr_type' => $action ), __METHOD__ );
1449 }
1450 }
1451
1452 # Insert a null revision
1453 $nullRevision = Revision::newNullRevision( $dbw, $id, $editComment, true );
1454 $nullRevId = $nullRevision->insertOn( $dbw );
1455
1456 $latest = $this->getLatest();
1457 # Update page record
1458 $dbw->update( 'page',
1459 array( /* SET */
1460 'page_touched' => $dbw->timestamp(),
1461 'page_restrictions' => '',
1462 'page_latest' => $nullRevId
1463 ), array( /* WHERE */
1464 'page_id' => $id
1465 ), __METHOD__
1466 );
1467
1468 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $nullRevision, $latest, $user ) );
1469 wfRunHooks( 'ArticleProtectComplete', array( &$this, &$user, $limit, $reason ) );
1470
1471 # Update the protection log
1472 $log = new LogPage( 'protect' );
1473 if ( $protect ) {
1474 $params = array( $protect_description, $cascade ? 'cascade' : '' );
1475 $log->addEntry( $modified ? 'modify' : 'protect', $this->mTitle, trim( $reason ), $params );
1476 } else {
1477 $log->addEntry( 'unprotect', $this->mTitle, $reason );
1478 }
1479 } # End hook
1480 } # End "changed" check
1481
1482 return true;
1483 }
1484
1485 /**
1486 * Take an array of page restrictions and flatten it to a string
1487 * suitable for insertion into the page_restrictions field.
1488 * @param $limit Array
1489 * @return String
1490 */
1491 protected static function flattenRestrictions( $limit ) {
1492 if ( !is_array( $limit ) ) {
1493 throw new MWException( 'WikiPage::flattenRestrictions given non-array restriction set' );
1494 }
1495
1496 $bits = array();
1497 ksort( $limit );
1498
1499 foreach ( $limit as $action => $restrictions ) {
1500 if ( $restrictions != '' ) {
1501 $bits[] = "$action=$restrictions";
1502 }
1503 }
1504
1505 return implode( ':', $bits );
1506 }
1507
1508 /**
1509 * @return bool whether or not the page surpasses $wgDeleteRevisionsLimit revisions
1510 */
1511 public function isBigDeletion() {
1512 global $wgDeleteRevisionsLimit;
1513
1514 if ( $wgDeleteRevisionsLimit ) {
1515 $revCount = $this->estimateRevisionCount();
1516
1517 return $revCount > $wgDeleteRevisionsLimit;
1518 }
1519
1520 return false;
1521 }
1522
1523 /**
1524 * @return int approximate revision count
1525 */
1526 public function estimateRevisionCount() {
1527 $dbr = wfGetDB( DB_SLAVE );
1528
1529 // For an exact count...
1530 // return $dbr->selectField( 'revision', 'COUNT(*)',
1531 // array( 'rev_page' => $this->getId() ), __METHOD__ );
1532 return $dbr->estimateRowCount( 'revision', '*',
1533 array( 'rev_page' => $this->getId() ), __METHOD__ );
1534 }
1535
1536 /**
1537 * Get the last N authors
1538 * @param $num Integer: number of revisions to get
1539 * @param $revLatest String: the latest rev_id, selected from the master (optional)
1540 * @return array Array of authors, duplicates not removed
1541 */
1542 public function getLastNAuthors( $num, $revLatest = 0 ) {
1543 wfProfileIn( __METHOD__ );
1544 // First try the slave
1545 // If that doesn't have the latest revision, try the master
1546 $continue = 2;
1547 $db = wfGetDB( DB_SLAVE );
1548
1549 do {
1550 $res = $db->select( array( 'page', 'revision' ),
1551 array( 'rev_id', 'rev_user_text' ),
1552 array(
1553 'page_namespace' => $this->mTitle->getNamespace(),
1554 'page_title' => $this->mTitle->getDBkey(),
1555 'rev_page = page_id'
1556 ), __METHOD__,
1557 array(
1558 'ORDER BY' => 'rev_timestamp DESC',
1559 'LIMIT' => $num
1560 )
1561 );
1562
1563 if ( !$res ) {
1564 wfProfileOut( __METHOD__ );
1565 return array();
1566 }
1567
1568 $row = $db->fetchObject( $res );
1569
1570 if ( $continue == 2 && $revLatest && $row->rev_id != $revLatest ) {
1571 $db = wfGetDB( DB_MASTER );
1572 $continue--;
1573 } else {
1574 $continue = 0;
1575 }
1576 } while ( $continue );
1577
1578 $authors = array( $row->rev_user_text );
1579
1580 foreach ( $res as $row ) {
1581 $authors[] = $row->rev_user_text;
1582 }
1583
1584 wfProfileOut( __METHOD__ );
1585 return $authors;
1586 }
1587
1588 /**
1589 * Back-end article deletion
1590 * Deletes the article with database consistency, writes logs, purges caches
1591 *
1592 * @param $reason string delete reason for deletion log
1593 * @param suppress bitfield
1594 * Revision::DELETED_TEXT
1595 * Revision::DELETED_COMMENT
1596 * Revision::DELETED_USER
1597 * Revision::DELETED_RESTRICTED
1598 * @param $id int article ID
1599 * @param $commit boolean defaults to true, triggers transaction end
1600 * @param &$errors Array of errors to append to
1601 * @param $user User The relevant user
1602 * @return boolean true if successful
1603 */
1604 public function doDeleteArticle(
1605 $reason, $suppress = false, $id = 0, $commit = true, &$error = '', User $user = null
1606 ) {
1607 global $wgUseTrackbacks, $wgEnableInterwikiTemplatesTracking, $wgGlobalDatabase, $wgUser;
1608 $user = is_null( $user ) ? $wgUser : $user;
1609
1610 wfDebug( __METHOD__ . "\n" );
1611
1612 if ( ! wfRunHooks( 'ArticleDelete', array( &$this, &$user, &$reason, &$error ) ) ) {
1613 return false;
1614 }
1615 $dbw = wfGetDB( DB_MASTER );
1616 $t = $this->mTitle->getDBkey();
1617 $id = $id ? $id : $this->mTitle->getArticleID( Title::GAID_FOR_UPDATE );
1618
1619 if ( $t === '' || $id == 0 ) {
1620 return false;
1621 }
1622
1623 DeferredUpdates::addUpdate(
1624 new SiteStatsUpdate( 0, 1, - (int)$this->isCountable(), -1 )
1625 );
1626
1627 // Bitfields to further suppress the content
1628 if ( $suppress ) {
1629 $bitfield = 0;
1630 // This should be 15...
1631 $bitfield |= Revision::DELETED_TEXT;
1632 $bitfield |= Revision::DELETED_COMMENT;
1633 $bitfield |= Revision::DELETED_USER;
1634 $bitfield |= Revision::DELETED_RESTRICTED;
1635 } else {
1636 $bitfield = 'rev_deleted';
1637 }
1638
1639 $dbw->begin();
1640 // For now, shunt the revision data into the archive table.
1641 // Text is *not* removed from the text table; bulk storage
1642 // is left intact to avoid breaking block-compression or
1643 // immutable storage schemes.
1644 //
1645 // For backwards compatibility, note that some older archive
1646 // table entries will have ar_text and ar_flags fields still.
1647 //
1648 // In the future, we may keep revisions and mark them with
1649 // the rev_deleted field, which is reserved for this purpose.
1650 $dbw->insertSelect( 'archive', array( 'page', 'revision' ),
1651 array(
1652 'ar_namespace' => 'page_namespace',
1653 'ar_title' => 'page_title',
1654 'ar_comment' => 'rev_comment',
1655 'ar_user' => 'rev_user',
1656 'ar_user_text' => 'rev_user_text',
1657 'ar_timestamp' => 'rev_timestamp',
1658 'ar_minor_edit' => 'rev_minor_edit',
1659 'ar_rev_id' => 'rev_id',
1660 'ar_parent_id' => 'rev_parent_id',
1661 'ar_text_id' => 'rev_text_id',
1662 'ar_text' => '\'\'', // Be explicit to appease
1663 'ar_flags' => '\'\'', // MySQL's "strict mode"...
1664 'ar_len' => 'rev_len',
1665 'ar_page_id' => 'page_id',
1666 'ar_deleted' => $bitfield
1667 ), array(
1668 'page_id' => $id,
1669 'page_id = rev_page'
1670 ), __METHOD__
1671 );
1672
1673 # Delete restrictions for it
1674 $dbw->delete( 'page_restrictions', array ( 'pr_page' => $id ), __METHOD__ );
1675
1676 # Now that it's safely backed up, delete it
1677 $dbw->delete( 'page', array( 'page_id' => $id ), __METHOD__ );
1678 $ok = ( $dbw->affectedRows() > 0 ); // getArticleId() uses slave, could be laggy
1679
1680 if ( !$ok ) {
1681 $dbw->rollback();
1682 return false;
1683 }
1684
1685 # Fix category table counts
1686 $cats = array();
1687 $res = $dbw->select( 'categorylinks', 'cl_to', array( 'cl_from' => $id ), __METHOD__ );
1688
1689 foreach ( $res as $row ) {
1690 $cats [] = $row->cl_to;
1691 }
1692
1693 $this->updateCategoryCounts( array(), $cats );
1694
1695 # If using cascading deletes, we can skip some explicit deletes
1696 if ( !$dbw->cascadingDeletes() ) {
1697 $dbw->delete( 'revision', array( 'rev_page' => $id ), __METHOD__ );
1698
1699 if ( $wgUseTrackbacks ) {
1700 $dbw->delete( 'trackbacks', array( 'tb_page' => $id ), __METHOD__ );
1701 }
1702
1703 # Delete outgoing links
1704 $dbw->delete( 'pagelinks', array( 'pl_from' => $id ), __METHOD__ );
1705 $dbw->delete( 'imagelinks', array( 'il_from' => $id ), __METHOD__ );
1706 $dbw->delete( 'categorylinks', array( 'cl_from' => $id ), __METHOD__ );
1707 $dbw->delete( 'templatelinks', array( 'tl_from' => $id ), __METHOD__ );
1708 $dbw->delete( 'externallinks', array( 'el_from' => $id ), __METHOD__ );
1709 $dbw->delete( 'langlinks', array( 'll_from' => $id ), __METHOD__ );
1710 $dbw->delete( 'iwlinks', array( 'iwl_from' => $id ), __METHOD__ );
1711 $dbw->delete( 'redirect', array( 'rd_from' => $id ), __METHOD__ );
1712 $dbw->delete( 'page_props', array( 'pp_page' => $id ), __METHOD__ );
1713
1714 if ( $wgEnableInterwikiTemplatesTracking && $wgGlobalDatabase ) {
1715 $dbw2 = wfGetDB( DB_MASTER, array(), $wgGlobalDatabase );
1716 $dbw2->delete( 'globaltemplatelinks',
1717 array( 'gtl_from_wiki' => wfGetID(),
1718 'gtl_from_page' => $id )
1719 );
1720 }
1721 }
1722
1723 # If using cleanup triggers, we can skip some manual deletes
1724 if ( !$dbw->cleanupTriggers() ) {
1725 # Clean up recentchanges entries...
1726 $dbw->delete( 'recentchanges',
1727 array( 'rc_type != ' . RC_LOG,
1728 'rc_namespace' => $this->mTitle->getNamespace(),
1729 'rc_title' => $this->mTitle->getDBkey() ),
1730 __METHOD__ );
1731 $dbw->delete( 'recentchanges',
1732 array( 'rc_type != ' . RC_LOG, 'rc_cur_id' => $id ),
1733 __METHOD__ );
1734 }
1735
1736 # Clear caches
1737 self::onArticleDelete( $this->mTitle );
1738
1739 # Clear the cached article id so the interface doesn't act like we exist
1740 $this->mTitle->resetArticleID( 0 );
1741
1742 # Log the deletion, if the page was suppressed, log it at Oversight instead
1743 $logtype = $suppress ? 'suppress' : 'delete';
1744
1745 $logEntry = new ManualLogEntry( $logtype, 'delete' );
1746 $logEntry->setPerformer( $user );
1747 $logEntry->setTarget( $this->mTitle );
1748 $logEntry->setComment( $reason );
1749 $logid = $logEntry->insert();
1750 $logEntry->publish( $logid );
1751
1752 if ( $commit ) {
1753 $dbw->commit();
1754 }
1755
1756 wfRunHooks( 'ArticleDeleteComplete', array( &$this, &$user, $reason, $id ) );
1757 return true;
1758 }
1759
1760 /**
1761 * Roll back the most recent consecutive set of edits to a page
1762 * from the same user; fails if there are no eligible edits to
1763 * roll back to, e.g. user is the sole contributor. This function
1764 * performs permissions checks on $user, then calls commitRollback()
1765 * to do the dirty work
1766 *
1767 * @param $fromP String: Name of the user whose edits to rollback.
1768 * @param $summary String: Custom summary. Set to default summary if empty.
1769 * @param $token String: Rollback token.
1770 * @param $bot Boolean: If true, mark all reverted edits as bot.
1771 *
1772 * @param $resultDetails Array: contains result-specific array of additional values
1773 * 'alreadyrolled' : 'current' (rev)
1774 * success : 'summary' (str), 'current' (rev), 'target' (rev)
1775 *
1776 * @param $user User The user performing the rollback
1777 * @return array of errors, each error formatted as
1778 * array(messagekey, param1, param2, ...).
1779 * On success, the array is empty. This array can also be passed to
1780 * OutputPage::showPermissionsErrorPage().
1781 */
1782 public function doRollback(
1783 $fromP, $summary, $token, $bot, &$resultDetails, User $user
1784 ) {
1785 $resultDetails = null;
1786
1787 # Check permissions
1788 $editErrors = $this->mTitle->getUserPermissionsErrors( 'edit', $user );
1789 $rollbackErrors = $this->mTitle->getUserPermissionsErrors( 'rollback', $user );
1790 $errors = array_merge( $editErrors, wfArrayDiff2( $rollbackErrors, $editErrors ) );
1791
1792 if ( !$user->matchEditToken( $token, array( $this->mTitle->getPrefixedText(), $fromP ) ) ) {
1793 $errors[] = array( 'sessionfailure' );
1794 }
1795
1796 if ( $user->pingLimiter( 'rollback' ) || $user->pingLimiter() ) {
1797 $errors[] = array( 'actionthrottledtext' );
1798 }
1799
1800 # If there were errors, bail out now
1801 if ( !empty( $errors ) ) {
1802 return $errors;
1803 }
1804
1805 return $this->commitRollback( $fromP, $summary, $bot, $resultDetails, $user );
1806 }
1807
1808 /**
1809 * Backend implementation of doRollback(), please refer there for parameter
1810 * and return value documentation
1811 *
1812 * NOTE: This function does NOT check ANY permissions, it just commits the
1813 * rollback to the DB. Therefore, you should only call this function direct-
1814 * ly if you want to use custom permissions checks. If you don't, use
1815 * doRollback() instead.
1816 * @param $fromP String: Name of the user whose edits to rollback.
1817 * @param $summary String: Custom summary. Set to default summary if empty.
1818 * @param $bot Boolean: If true, mark all reverted edits as bot.
1819 *
1820 * @param $resultDetails Array: contains result-specific array of additional values
1821 * @param $guser User The user performing the rollback
1822 */
1823 public function commitRollback( $fromP, $summary, $bot, &$resultDetails, User $guser ) {
1824 global $wgUseRCPatrol, $wgContLang;
1825
1826 $dbw = wfGetDB( DB_MASTER );
1827
1828 if ( wfReadOnly() ) {
1829 return array( array( 'readonlytext' ) );
1830 }
1831
1832 # Get the last editor
1833 $current = Revision::newFromTitle( $this->mTitle );
1834 if ( is_null( $current ) ) {
1835 # Something wrong... no page?
1836 return array( array( 'notanarticle' ) );
1837 }
1838
1839 $from = str_replace( '_', ' ', $fromP );
1840 # User name given should match up with the top revision.
1841 # If the user was deleted then $from should be empty.
1842 if ( $from != $current->getUserText() ) {
1843 $resultDetails = array( 'current' => $current );
1844 return array( array( 'alreadyrolled',
1845 htmlspecialchars( $this->mTitle->getPrefixedText() ),
1846 htmlspecialchars( $fromP ),
1847 htmlspecialchars( $current->getUserText() )
1848 ) );
1849 }
1850
1851 # Get the last edit not by this guy...
1852 # Note: these may not be public values
1853 $user = intval( $current->getRawUser() );
1854 $user_text = $dbw->addQuotes( $current->getRawUserText() );
1855 $s = $dbw->selectRow( 'revision',
1856 array( 'rev_id', 'rev_timestamp', 'rev_deleted' ),
1857 array( 'rev_page' => $current->getPage(),
1858 "rev_user != {$user} OR rev_user_text != {$user_text}"
1859 ), __METHOD__,
1860 array( 'USE INDEX' => 'page_timestamp',
1861 'ORDER BY' => 'rev_timestamp DESC' )
1862 );
1863 if ( $s === false ) {
1864 # No one else ever edited this page
1865 return array( array( 'cantrollback' ) );
1866 } elseif ( $s->rev_deleted & Revision::DELETED_TEXT || $s->rev_deleted & Revision::DELETED_USER ) {
1867 # Only admins can see this text
1868 return array( array( 'notvisiblerev' ) );
1869 }
1870
1871 $set = array();
1872 if ( $bot && $guser->isAllowed( 'markbotedits' ) ) {
1873 # Mark all reverted edits as bot
1874 $set['rc_bot'] = 1;
1875 }
1876
1877 if ( $wgUseRCPatrol ) {
1878 # Mark all reverted edits as patrolled
1879 $set['rc_patrolled'] = 1;
1880 }
1881
1882 if ( count( $set ) ) {
1883 $dbw->update( 'recentchanges', $set,
1884 array( /* WHERE */
1885 'rc_cur_id' => $current->getPage(),
1886 'rc_user_text' => $current->getUserText(),
1887 "rc_timestamp > '{$s->rev_timestamp}'",
1888 ), __METHOD__
1889 );
1890 }
1891
1892 # Generate the edit summary if necessary
1893 $target = Revision::newFromId( $s->rev_id );
1894 if ( empty( $summary ) ) {
1895 if ( $from == '' ) { // no public user name
1896 $summary = wfMsgForContent( 'revertpage-nouser' );
1897 } else {
1898 $summary = wfMsgForContent( 'revertpage' );
1899 }
1900 }
1901
1902 # Allow the custom summary to use the same args as the default message
1903 $args = array(
1904 $target->getUserText(), $from, $s->rev_id,
1905 $wgContLang->timeanddate( wfTimestamp( TS_MW, $s->rev_timestamp ) ),
1906 $current->getId(), $wgContLang->timeanddate( $current->getTimestamp() )
1907 );
1908 $summary = wfMsgReplaceArgs( $summary, $args );
1909
1910 # Save
1911 $flags = EDIT_UPDATE;
1912
1913 if ( $guser->isAllowed( 'minoredit' ) ) {
1914 $flags |= EDIT_MINOR;
1915 }
1916
1917 if ( $bot && ( $guser->isAllowedAny( 'markbotedits', 'bot' ) ) ) {
1918 $flags |= EDIT_FORCE_BOT;
1919 }
1920
1921 # Actually store the edit
1922 $status = $this->doEdit( $target->getText(), $summary, $flags, $target->getId() );
1923 if ( !empty( $status->value['revision'] ) ) {
1924 $revId = $status->value['revision']->getId();
1925 } else {
1926 $revId = false;
1927 }
1928
1929 wfRunHooks( 'ArticleRollbackComplete', array( $this, $guser, $target, $current ) );
1930
1931 $resultDetails = array(
1932 'summary' => $summary,
1933 'current' => $current,
1934 'target' => $target,
1935 'newid' => $revId
1936 );
1937
1938 return array();
1939 }
1940
1941 /**
1942 * Do standard deferred updates after page view
1943 * @param $user User The relevant user
1944 */
1945 public function doViewUpdates( User $user ) {
1946 global $wgDisableCounters;
1947 if ( wfReadOnly() ) {
1948 return;
1949 }
1950
1951 # Don't update page view counters on views from bot users (bug 14044)
1952 if ( !$wgDisableCounters && !$user->isAllowed( 'bot' ) && $this->getId() ) {
1953 DeferredUpdates::addUpdate( new ViewCountUpdate( $this->getId() ) );
1954 DeferredUpdates::addUpdate( new SiteStatsUpdate( 1, 0, 0 ) );
1955 }
1956
1957 # Update newtalk / watchlist notification status
1958 $user->clearNotification( $this->mTitle );
1959 }
1960
1961 /**
1962 * Prepare text which is about to be saved.
1963 * Returns a stdclass with source, pst and output members
1964 */
1965 public function prepareTextForEdit( $text, $revid = null, User $user = null ) {
1966 global $wgParser, $wgUser;
1967 $user = is_null( $user ) ? $wgUser : $user;
1968 // @TODO fixme: check $user->getId() here???
1969 if ( $this->mPreparedEdit
1970 && $this->mPreparedEdit->newText == $text
1971 && $this->mPreparedEdit->revid == $revid
1972 ) {
1973 // Already prepared
1974 return $this->mPreparedEdit;
1975 }
1976
1977 $popts = ParserOptions::newFromUser( $user );
1978 wfRunHooks( 'ArticlePrepareTextForEdit', array( $this, $popts ) );
1979
1980 $edit = (object)array();
1981 $edit->revid = $revid;
1982 $edit->newText = $text;
1983 $edit->pst = $this->preSaveTransform( $text, $user, $popts );
1984 $edit->popts = $this->getParserOptions( true );
1985 $edit->output = $wgParser->parse( $edit->pst, $this->mTitle, $edit->popts, true, true, $revid );
1986 $edit->oldText = $this->getRawText();
1987
1988 $this->mPreparedEdit = $edit;
1989
1990 return $edit;
1991 }
1992
1993 /**
1994 * Do standard deferred updates after page edit.
1995 * Update links tables, site stats, search index and message cache.
1996 * Purges pages that include this page if the text was changed here.
1997 * Every 100th edit, prune the recent changes table.
1998 *
1999 * @private
2000 * @param $revision Revision object
2001 * @param $user User object that did the revision
2002 * @param $options Array of options, following indexes are used:
2003 * - changed: boolean, whether the revision changed the content (default true)
2004 * - created: boolean, whether the revision created the page (default false)
2005 * - oldcountable: boolean or null (default null):
2006 * - boolean: whether the page was counted as an article before that
2007 * revision, only used in changed is true and created is false
2008 * - null: don't change the article count
2009 */
2010 public function doEditUpdates( Revision $revision, User $user, array $options = array() ) {
2011 global $wgEnableParserCache;
2012
2013 wfProfileIn( __METHOD__ );
2014
2015 $options += array( 'changed' => true, 'created' => false, 'oldcountable' => null );
2016 $text = $revision->getText();
2017
2018 # Parse the text
2019 # Be careful not to double-PST: $text is usually already PST-ed once
2020 if ( !$this->mPreparedEdit || $this->mPreparedEdit->output->getFlag( 'vary-revision' ) ) {
2021 wfDebug( __METHOD__ . ": No prepared edit or vary-revision is set...\n" );
2022 $editInfo = $this->prepareTextForEdit( $text, $revision->getId(), $user );
2023 } else {
2024 wfDebug( __METHOD__ . ": No vary-revision, using prepared edit...\n" );
2025 $editInfo = $this->mPreparedEdit;
2026 }
2027
2028 # Save it to the parser cache
2029 if ( $wgEnableParserCache ) {
2030 $parserCache = ParserCache::singleton();
2031 $parserCache->save( $editInfo->output, $this, $editInfo->popts );
2032 }
2033
2034 # Update the links tables
2035 $u = new LinksUpdate( $this->mTitle, $editInfo->output );
2036 $u->doUpdate();
2037
2038 wfRunHooks( 'ArticleEditUpdates', array( &$this, &$editInfo, $options['changed'] ) );
2039
2040 if ( wfRunHooks( 'ArticleEditUpdatesDeleteFromRecentchanges', array( &$this ) ) ) {
2041 if ( 0 == mt_rand( 0, 99 ) ) {
2042 // Flush old entries from the `recentchanges` table; we do this on
2043 // random requests so as to avoid an increase in writes for no good reason
2044 global $wgRCMaxAge;
2045
2046 $dbw = wfGetDB( DB_MASTER );
2047 $cutoff = $dbw->timestamp( time() - $wgRCMaxAge );
2048 $dbw->delete(
2049 'recentchanges',
2050 array( "rc_timestamp < '$cutoff'" ),
2051 __METHOD__
2052 );
2053 }
2054 }
2055
2056 $id = $this->getId();
2057 $title = $this->mTitle->getPrefixedDBkey();
2058 $shortTitle = $this->mTitle->getDBkey();
2059
2060 if ( 0 == $id ) {
2061 wfProfileOut( __METHOD__ );
2062 return;
2063 }
2064
2065 if ( !$options['changed'] ) {
2066 $good = 0;
2067 $total = 0;
2068 } elseif ( $options['created'] ) {
2069 $good = (int)$this->isCountable( $editInfo );
2070 $total = 1;
2071 } elseif ( $options['oldcountable'] !== null ) {
2072 $good = (int)$this->isCountable( $editInfo ) - (int)$options['oldcountable'];
2073 $total = 0;
2074 } else {
2075 $good = 0;
2076 $total = 0;
2077 }
2078
2079 DeferredUpdates::addUpdate( new SiteStatsUpdate( 0, 1, $good, $total ) );
2080 DeferredUpdates::addUpdate( new SearchUpdate( $id, $title, $text ) );
2081
2082 # If this is another user's talk page, update newtalk.
2083 # Don't do this if $options['changed'] = false (null-edits) nor if
2084 # it's a minor edit and the user doesn't want notifications for those.
2085 if ( $options['changed']
2086 && $this->mTitle->getNamespace() == NS_USER_TALK
2087 && $shortTitle != $user->getTitleKey()
2088 && !( $revision->isMinor() && $user->isAllowed( 'nominornewtalk' ) )
2089 ) {
2090 if ( wfRunHooks( 'ArticleEditUpdateNewTalk', array( &$this ) ) ) {
2091 $other = User::newFromName( $shortTitle, false );
2092 if ( !$other ) {
2093 wfDebug( __METHOD__ . ": invalid username\n" );
2094 } elseif ( User::isIP( $shortTitle ) ) {
2095 // An anonymous user
2096 $other->setNewtalk( true );
2097 } elseif ( $other->isLoggedIn() ) {
2098 $other->setNewtalk( true );
2099 } else {
2100 wfDebug( __METHOD__ . ": don't need to notify a nonexistent user\n" );
2101 }
2102 }
2103 }
2104
2105 if ( $this->mTitle->getNamespace() == NS_MEDIAWIKI ) {
2106 MessageCache::singleton()->replace( $shortTitle, $text );
2107 }
2108
2109 if( $options['created'] ) {
2110 self::onArticleCreate( $this->mTitle );
2111 } else {
2112 self::onArticleEdit( $this->mTitle );
2113 }
2114
2115 wfProfileOut( __METHOD__ );
2116 }
2117
2118 /**
2119 * Perform article updates on a special page creation.
2120 *
2121 * @param $rev Revision object
2122 *
2123 * @todo This is a shitty interface function. Kill it and replace the
2124 * other shitty functions like doEditUpdates and such so it's not needed
2125 * anymore.
2126 * @deprecated since 1.18, use doEditUpdates()
2127 */
2128 public function createUpdates( $rev ) {
2129 global $wgUser;
2130 $this->doEditUpdates( $rev, $wgUser, array( 'created' => true ) );
2131 }
2132
2133 /**
2134 * This function is called right before saving the wikitext,
2135 * so we can do things like signatures and links-in-context.
2136 *
2137 * @param $text String article contents
2138 * @param $user User object: user doing the edit
2139 * @param $popts ParserOptions object: parser options, default options for
2140 * the user loaded if null given
2141 * @return string article contents with altered wikitext markup (signatures
2142 * converted, {{subst:}}, templates, etc.)
2143 */
2144 public function preSaveTransform( $text, User $user = null, ParserOptions $popts = null ) {
2145 global $wgParser, $wgUser;
2146 $user = is_null( $user ) ? $wgUser : $user;
2147
2148 if ( $popts === null ) {
2149 $popts = ParserOptions::newFromUser( $user );
2150 }
2151
2152 return $wgParser->preSaveTransform( $text, $this->mTitle, $user, $popts );
2153 }
2154
2155 /**
2156 * Loads page_touched and returns a value indicating if it should be used
2157 * @return boolean true if not a redirect
2158 */
2159 public function checkTouched() {
2160 if ( !$this->mDataLoaded ) {
2161 $this->loadPageData();
2162 }
2163 return !$this->mIsRedirect;
2164 }
2165
2166 /**
2167 * Get the page_touched field
2168 * @return string containing GMT timestamp
2169 */
2170 public function getTouched() {
2171 if ( !$this->mDataLoaded ) {
2172 $this->loadPageData();
2173 }
2174 return $this->mTouched;
2175 }
2176
2177 /**
2178 * Get the page_latest field
2179 * @return integer rev_id of current revision
2180 */
2181 public function getLatest() {
2182 if ( !$this->mDataLoaded ) {
2183 $this->loadPageData();
2184 }
2185 return (int)$this->mLatest;
2186 }
2187
2188 /**
2189 * Edit an article without doing all that other stuff
2190 * The article must already exist; link tables etc
2191 * are not updated, caches are not flushed.
2192 *
2193 * @param $text String: text submitted
2194 * @param $user User The relevant user
2195 * @param $comment String: comment submitted
2196 * @param $minor Boolean: whereas it's a minor modification
2197 */
2198 public function doQuickEdit( $text, User $user, $comment = '', $minor = 0 ) {
2199 wfProfileIn( __METHOD__ );
2200
2201 $dbw = wfGetDB( DB_MASTER );
2202 $revision = new Revision( array(
2203 'page' => $this->getId(),
2204 'text' => $text,
2205 'comment' => $comment,
2206 'minor_edit' => $minor ? 1 : 0,
2207 ) );
2208 $revision->insertOn( $dbw );
2209 $this->updateRevisionOn( $dbw, $revision );
2210
2211 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $revision, false, $user ) );
2212
2213 wfProfileOut( __METHOD__ );
2214 }
2215
2216 /**
2217 * The onArticle*() functions are supposed to be a kind of hooks
2218 * which should be called whenever any of the specified actions
2219 * are done.
2220 *
2221 * This is a good place to put code to clear caches, for instance.
2222 *
2223 * This is called on page move and undelete, as well as edit
2224 *
2225 * @param $title Title object
2226 */
2227 public static function onArticleCreate( $title ) {
2228 # Update existence markers on article/talk tabs...
2229 if ( $title->isTalkPage() ) {
2230 $other = $title->getSubjectPage();
2231 } else {
2232 $other = $title->getTalkPage();
2233 }
2234
2235 $other->invalidateCache();
2236 $other->purgeSquid();
2237
2238 $title->touchLinks();
2239 $title->purgeSquid();
2240 $title->deleteTitleProtection();
2241
2242 # Invalidate caches of distant articles which transclude this page
2243 DeferredUpdates::addHTMLCacheUpdate( $title, 'globaltemplatelinks' );
2244 }
2245
2246 /**
2247 * Clears caches when article is deleted
2248 *
2249 * @param $title Title
2250 */
2251 public static function onArticleDelete( $title ) {
2252 # Update existence markers on article/talk tabs...
2253 if ( $title->isTalkPage() ) {
2254 $other = $title->getSubjectPage();
2255 } else {
2256 $other = $title->getTalkPage();
2257 }
2258
2259 $other->invalidateCache();
2260 $other->purgeSquid();
2261
2262 $title->touchLinks();
2263 $title->purgeSquid();
2264
2265 # File cache
2266 HTMLFileCache::clearFileCache( $title );
2267
2268 # Messages
2269 if ( $title->getNamespace() == NS_MEDIAWIKI ) {
2270 MessageCache::singleton()->replace( $title->getDBkey(), false );
2271 }
2272
2273 # Images
2274 if ( $title->getNamespace() == NS_FILE ) {
2275 $update = new HTMLCacheUpdate( $title, 'imagelinks' );
2276 $update->doUpdate();
2277 }
2278
2279 # User talk pages
2280 if ( $title->getNamespace() == NS_USER_TALK ) {
2281 $user = User::newFromName( $title->getText(), false );
2282 $user->setNewtalk( false );
2283 }
2284
2285 # Image redirects
2286 RepoGroup::singleton()->getLocalRepo()->invalidateImageRedirect( $title );
2287
2288 # Invalidate caches of distant articles which transclude this page
2289 DeferredUpdates::addHTMLCacheUpdate( $title, 'globaltemplatelinks' );
2290 }
2291
2292 /**
2293 * Purge caches on page update etc
2294 *
2295 * @param $title Title object
2296 * @todo: verify that $title is always a Title object (and never false or null), add Title hint to parameter $title
2297 */
2298 public static function onArticleEdit( $title ) {
2299 // Invalidate caches of articles which include this page
2300 DeferredUpdates::addHTMLCacheUpdate( $title, 'templatelinks' );
2301
2302 // Invalidate caches of distant articles which transclude this page
2303 DeferredUpdates::addHTMLCacheUpdate( $title, 'globaltemplatelinks' );
2304
2305 // Invalidate the caches of all pages which redirect here
2306 DeferredUpdates::addHTMLCacheUpdate( $title, 'redirect' );
2307
2308 # Purge squid for this page only
2309 $title->purgeSquid();
2310
2311 # Clear file cache for this page only
2312 HTMLFileCache::clearFileCache( $title );
2313 }
2314
2315 /**#@-*/
2316
2317 /**
2318 * Return a list of templates used by this article.
2319 * Uses the templatelinks table
2320 *
2321 * @return Array of Title objects
2322 */
2323 public function getUsedTemplates() {
2324 $result = array();
2325 $id = $this->mTitle->getArticleID();
2326
2327 if ( $id == 0 ) {
2328 return array();
2329 }
2330
2331 $dbr = wfGetDB( DB_SLAVE );
2332 $res = $dbr->select( array( 'templatelinks' ),
2333 array( 'tl_namespace', 'tl_title' ),
2334 array( 'tl_from' => $id ),
2335 __METHOD__ );
2336
2337 if ( $res !== false ) {
2338 foreach ( $res as $row ) {
2339 $result[] = Title::makeTitle( $row->tl_namespace, $row->tl_title );
2340 }
2341 }
2342
2343 return $result;
2344 }
2345
2346 /**
2347 * Return a list of distant templates used by this article.
2348 * Uses the globaltemplatelinks table
2349 *
2350 * @return Array of Title objects
2351 */
2352 public function getUsedDistantTemplates() {
2353 global $wgGlobalDatabase;
2354
2355 $result = array();
2356
2357 if ( $wgGlobalDatabase ) {
2358 $id = $this->mTitle->getArticleID();
2359
2360 if ( $id == 0 ) {
2361 return array();
2362 }
2363
2364 $dbr = wfGetDB( DB_SLAVE, array(), $wgGlobalDatabase );
2365 $res = $dbr->select( 'globaltemplatelinks',
2366 array( 'gtl_to_prefix', 'gtl_to_namespace', 'gtl_to_title' ),
2367 array( 'gtl_from_wiki' => wfWikiID( ), 'gtl_from_page' => $id ),
2368 __METHOD__ );
2369
2370 if ( $res !== false ) {
2371 foreach ( $res as $row ) {
2372 $result[] = Title::makeTitle( $row->gtl_to_namespace, $row->gtl_to_title, null, $row->gtl_to_prefix );
2373 }
2374 }
2375 }
2376
2377 return $result;
2378 }
2379
2380 /**
2381 * Returns a list of hidden categories this page is a member of.
2382 * Uses the page_props and categorylinks tables.
2383 *
2384 * @return Array of Title objects
2385 */
2386 public function getHiddenCategories() {
2387 $result = array();
2388 $id = $this->mTitle->getArticleID();
2389
2390 if ( $id == 0 ) {
2391 return array();
2392 }
2393
2394 $dbr = wfGetDB( DB_SLAVE );
2395 $res = $dbr->select( array( 'categorylinks', 'page_props', 'page' ),
2396 array( 'cl_to' ),
2397 array( 'cl_from' => $id, 'pp_page=page_id', 'pp_propname' => 'hiddencat',
2398 'page_namespace' => NS_CATEGORY, 'page_title=cl_to' ),
2399 __METHOD__ );
2400
2401 if ( $res !== false ) {
2402 foreach ( $res as $row ) {
2403 $result[] = Title::makeTitle( NS_CATEGORY, $row->cl_to );
2404 }
2405 }
2406
2407 return $result;
2408 }
2409
2410 /**
2411 * Return an applicable autosummary if one exists for the given edit.
2412 * @param $oldtext String: the previous text of the page.
2413 * @param $newtext String: The submitted text of the page.
2414 * @param $flags Int bitmask: a bitmask of flags submitted for the edit.
2415 * @return string An appropriate autosummary, or an empty string.
2416 */
2417 public static function getAutosummary( $oldtext, $newtext, $flags ) {
2418 global $wgContLang;
2419
2420 # Decide what kind of autosummary is needed.
2421
2422 # Redirect autosummaries
2423 $ot = Title::newFromRedirect( $oldtext );
2424 $rt = Title::newFromRedirect( $newtext );
2425
2426 if ( is_object( $rt ) && ( !is_object( $ot ) || !$rt->equals( $ot ) || $ot->getFragment() != $rt->getFragment() ) ) {
2427 $truncatedtext = $wgContLang->truncate(
2428 str_replace( "\n", ' ', $newtext ),
2429 max( 0, 250
2430 - strlen( wfMsgForContent( 'autoredircomment' ) )
2431 - strlen( $rt->getFullText() )
2432 ) );
2433 return wfMsgForContent( 'autoredircomment', $rt->getFullText(), $truncatedtext );
2434 }
2435
2436 # New page autosummaries
2437 if ( $flags & EDIT_NEW && strlen( $newtext ) ) {
2438 # If they're making a new article, give its text, truncated, in the summary.
2439
2440 $truncatedtext = $wgContLang->truncate(
2441 str_replace( "\n", ' ', $newtext ),
2442 max( 0, 200 - strlen( wfMsgForContent( 'autosumm-new' ) ) ) );
2443
2444 return wfMsgForContent( 'autosumm-new', $truncatedtext );
2445 }
2446
2447 # Blanking autosummaries
2448 if ( $oldtext != '' && $newtext == '' ) {
2449 return wfMsgForContent( 'autosumm-blank' );
2450 } elseif ( strlen( $oldtext ) > 10 * strlen( $newtext ) && strlen( $newtext ) < 500 ) {
2451 # Removing more than 90% of the article
2452
2453 $truncatedtext = $wgContLang->truncate(
2454 $newtext,
2455 max( 0, 200 - strlen( wfMsgForContent( 'autosumm-replace' ) ) ) );
2456
2457 return wfMsgForContent( 'autosumm-replace', $truncatedtext );
2458 }
2459
2460 # If we reach this point, there's no applicable autosummary for our case, so our
2461 # autosummary is empty.
2462 return '';
2463 }
2464
2465 /**
2466 * Auto-generates a deletion reason
2467 *
2468 * @param &$hasHistory Boolean: whether the page has a history
2469 * @return mixed String containing deletion reason or empty string, or boolean false
2470 * if no revision occurred
2471 */
2472 public function getAutoDeleteReason( &$hasHistory ) {
2473 global $wgContLang;
2474
2475 $dbw = wfGetDB( DB_MASTER );
2476 // Get the last revision
2477 $rev = Revision::newFromTitle( $this->getTitle() );
2478
2479 if ( is_null( $rev ) ) {
2480 return false;
2481 }
2482
2483 // Get the article's contents
2484 $contents = $rev->getText();
2485 $blank = false;
2486
2487 // If the page is blank, use the text from the previous revision,
2488 // which can only be blank if there's a move/import/protect dummy revision involved
2489 if ( $contents == '' ) {
2490 $prev = $rev->getPrevious();
2491
2492 if ( $prev ) {
2493 $contents = $prev->getText();
2494 $blank = true;
2495 }
2496 }
2497
2498 // Find out if there was only one contributor
2499 // Only scan the last 20 revisions
2500 $res = $dbw->select( 'revision', 'rev_user_text',
2501 array( 'rev_page' => $this->getID(), $dbw->bitAnd( 'rev_deleted', Revision::DELETED_USER ) . ' = 0' ),
2502 __METHOD__,
2503 array( 'LIMIT' => 20 )
2504 );
2505
2506 if ( $res === false ) {
2507 // This page has no revisions, which is very weird
2508 return false;
2509 }
2510
2511 $hasHistory = ( $res->numRows() > 1 );
2512 $row = $dbw->fetchObject( $res );
2513
2514 if ( $row ) { // $row is false if the only contributor is hidden
2515 $onlyAuthor = $row->rev_user_text;
2516 // Try to find a second contributor
2517 foreach ( $res as $row ) {
2518 if ( $row->rev_user_text != $onlyAuthor ) { // Bug 22999
2519 $onlyAuthor = false;
2520 break;
2521 }
2522 }
2523 } else {
2524 $onlyAuthor = false;
2525 }
2526
2527 // Generate the summary with a '$1' placeholder
2528 if ( $blank ) {
2529 // The current revision is blank and the one before is also
2530 // blank. It's just not our lucky day
2531 $reason = wfMsgForContent( 'exbeforeblank', '$1' );
2532 } else {
2533 if ( $onlyAuthor ) {
2534 $reason = wfMsgForContent( 'excontentauthor', '$1', $onlyAuthor );
2535 } else {
2536 $reason = wfMsgForContent( 'excontent', '$1' );
2537 }
2538 }
2539
2540 if ( $reason == '-' ) {
2541 // Allow these UI messages to be blanked out cleanly
2542 return '';
2543 }
2544
2545 // Replace newlines with spaces to prevent uglyness
2546 $contents = preg_replace( "/[\n\r]/", ' ', $contents );
2547 // Calculate the maximum amount of chars to get
2548 // Max content length = max comment length - length of the comment (excl. $1)
2549 $maxLength = 255 - ( strlen( $reason ) - 2 );
2550 $contents = $wgContLang->truncate( $contents, $maxLength );
2551 // Remove possible unfinished links
2552 $contents = preg_replace( '/\[\[([^\]]*)\]?$/', '$1', $contents );
2553 // Now replace the '$1' placeholder
2554 $reason = str_replace( '$1', $contents, $reason );
2555
2556 return $reason;
2557 }
2558
2559 /**
2560 * Get parser options suitable for rendering the primary article wikitext
2561 * @param $canonical boolean Determines that the generated options must not depend on user preferences (see bug 14404)
2562 * @return mixed ParserOptions object or boolean false
2563 */
2564 public function getParserOptions( $canonical = false ) {
2565 global $wgUser;
2566
2567 if ( !$this->mParserOptions || $canonical ) {
2568 $user = !$canonical ? $wgUser : new User;
2569 $parserOptions = new ParserOptions( $user );
2570 $parserOptions->setTidy( true );
2571 $parserOptions->enableLimitReport();
2572
2573 if ( $canonical ) {
2574 $parserOptions->setUserLang( $this->mTitle->getPageLanguage() ); # Must be set explicitely
2575 return $parserOptions;
2576 }
2577 $this->mParserOptions = $parserOptions;
2578 }
2579 // Clone to allow modifications of the return value without affecting cache
2580 return clone $this->mParserOptions;
2581 }
2582
2583 /**
2584 * Get parser options suitable for rendering the primary article wikitext
2585 * @param User $user
2586 * @return ParserOptions
2587 */
2588 public function makeParserOptions( User $user ) {
2589 $options = ParserOptions::newFromUser( $user );
2590 $options->enableLimitReport(); // show inclusion/loop reports
2591 $options->setTidy( true ); // fix bad HTML
2592 return $options;
2593 }
2594
2595 /**
2596 * Update all the appropriate counts in the category table, given that
2597 * we've added the categories $added and deleted the categories $deleted.
2598 *
2599 * @param $added array The names of categories that were added
2600 * @param $deleted array The names of categories that were deleted
2601 */
2602 public function updateCategoryCounts( $added, $deleted ) {
2603 $ns = $this->mTitle->getNamespace();
2604 $dbw = wfGetDB( DB_MASTER );
2605
2606 # First make sure the rows exist. If one of the "deleted" ones didn't
2607 # exist, we might legitimately not create it, but it's simpler to just
2608 # create it and then give it a negative value, since the value is bogus
2609 # anyway.
2610 #
2611 # Sometimes I wish we had INSERT ... ON DUPLICATE KEY UPDATE.
2612 $insertCats = array_merge( $added, $deleted );
2613 if ( !$insertCats ) {
2614 # Okay, nothing to do
2615 return;
2616 }
2617
2618 $insertRows = array();
2619
2620 foreach ( $insertCats as $cat ) {
2621 $insertRows[] = array(
2622 'cat_id' => $dbw->nextSequenceValue( 'category_cat_id_seq' ),
2623 'cat_title' => $cat
2624 );
2625 }
2626 $dbw->insert( 'category', $insertRows, __METHOD__, 'IGNORE' );
2627
2628 $addFields = array( 'cat_pages = cat_pages + 1' );
2629 $removeFields = array( 'cat_pages = cat_pages - 1' );
2630
2631 if ( $ns == NS_CATEGORY ) {
2632 $addFields[] = 'cat_subcats = cat_subcats + 1';
2633 $removeFields[] = 'cat_subcats = cat_subcats - 1';
2634 } elseif ( $ns == NS_FILE ) {
2635 $addFields[] = 'cat_files = cat_files + 1';
2636 $removeFields[] = 'cat_files = cat_files - 1';
2637 }
2638
2639 if ( $added ) {
2640 $dbw->update(
2641 'category',
2642 $addFields,
2643 array( 'cat_title' => $added ),
2644 __METHOD__
2645 );
2646 }
2647
2648 if ( $deleted ) {
2649 $dbw->update(
2650 'category',
2651 $removeFields,
2652 array( 'cat_title' => $deleted ),
2653 __METHOD__
2654 );
2655 }
2656 }
2657
2658 /**
2659 * Updates cascading protections
2660 *
2661 * @param $parserOutput ParserOutput object for the current version
2662 **/
2663 public function doCascadeProtectionUpdates( ParserOutput $parserOutput ) {
2664 if ( wfReadOnly() || !$this->mTitle->areRestrictionsCascading() ) {
2665 return;
2666 }
2667
2668 // templatelinks table may have become out of sync,
2669 // especially if using variable-based transclusions.
2670 // For paranoia, check if things have changed and if
2671 // so apply updates to the database. This will ensure
2672 // that cascaded protections apply as soon as the changes
2673 // are visible.
2674
2675 # Get templates from templatelinks
2676 $id = $this->mTitle->getArticleID();
2677
2678 $tlTemplates = array();
2679
2680 $dbr = wfGetDB( DB_SLAVE );
2681 $res = $dbr->select( array( 'templatelinks' ),
2682 array( 'tl_namespace', 'tl_title' ),
2683 array( 'tl_from' => $id ),
2684 __METHOD__
2685 );
2686
2687 foreach ( $res as $row ) {
2688 $tlTemplates["{$row->tl_namespace}:{$row->tl_title}"] = true;
2689 }
2690
2691 # Get templates from parser output.
2692 $poTemplates = array();
2693 foreach ( $parserOutput->getTemplates() as $ns => $templates ) {
2694 foreach ( $templates as $dbk => $id ) {
2695 $poTemplates["$ns:$dbk"] = true;
2696 }
2697 }
2698
2699 # Get the diff
2700 $templates_diff = array_diff_key( $poTemplates, $tlTemplates );
2701
2702 if ( count( $templates_diff ) > 0 ) {
2703 # Whee, link updates time.
2704 $u = new LinksUpdate( $this->mTitle, $parserOutput, false );
2705 $u->doUpdate();
2706 }
2707 }
2708
2709 /*
2710 * @deprecated since 1.18
2711 */
2712 public function quickEdit( $text, $comment = '', $minor = 0 ) {
2713 global $wgUser;
2714 return $this->doQuickEdit( $text, $wgUser, $comment, $minor );
2715 }
2716
2717 /*
2718 * @deprecated since 1.18
2719 */
2720 public function viewUpdates() {
2721 global $wgUser;
2722 return $this->doViewUpdates( $wgUser );
2723 }
2724
2725 /*
2726 * @deprecated since 1.18
2727 */
2728 public function useParserCache( $oldid ) {
2729 global $wgUser;
2730 return $this->isParserCacheUsed( $wgUser, $oldid );
2731 }
2732 }