Merge "Avoid DB_MASTER in replaceSectionAtRev()"
[lhc/web/wiklou.git] / includes / page / WikiPage.php
1 <?php
2 /**
3 * Base representation for a MediaWiki page.
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
19 *
20 * @file
21 */
22
23 /**
24 * Abstract class for type hinting (accepts WikiPage, Article, ImagePage, CategoryPage)
25 */
26 interface Page {
27 }
28
29 /**
30 * Class representing a MediaWiki article and history.
31 *
32 * Some fields are public only for backwards-compatibility. Use accessors.
33 * In the past, this class was part of Article.php and everything was public.
34 */
35 class WikiPage implements Page, IDBAccessObject {
36 // Constants for $mDataLoadedFrom and related
37
38 /**
39 * @var Title
40 */
41 public $mTitle = null;
42
43 /**@{{
44 * @protected
45 */
46 public $mDataLoaded = false; // !< Boolean
47 public $mIsRedirect = false; // !< Boolean
48 public $mLatest = false; // !< Integer (false means "not loaded")
49 /**@}}*/
50
51 /** @var stdClass Map of cache fields (text, parser output, ect) for a proposed/new edit */
52 public $mPreparedEdit = false;
53
54 /**
55 * @var int
56 */
57 protected $mId = null;
58
59 /**
60 * @var int One of the READ_* constants
61 */
62 protected $mDataLoadedFrom = self::READ_NONE;
63
64 /**
65 * @var Title
66 */
67 protected $mRedirectTarget = null;
68
69 /**
70 * @var Revision
71 */
72 protected $mLastRevision = null;
73
74 /**
75 * @var string Timestamp of the current revision or empty string if not loaded
76 */
77 protected $mTimestamp = '';
78
79 /**
80 * @var string
81 */
82 protected $mTouched = '19700101000000';
83
84 /**
85 * @var string
86 */
87 protected $mLinksUpdated = '19700101000000';
88
89 /**
90 * Constructor and clear the article
91 * @param Title $title Reference to a Title object.
92 */
93 public function __construct( Title $title ) {
94 $this->mTitle = $title;
95 }
96
97 /**
98 * Create a WikiPage object of the appropriate class for the given title.
99 *
100 * @param Title $title
101 *
102 * @throws MWException
103 * @return WikiPage Object of the appropriate type
104 */
105 public static function factory( Title $title ) {
106 $ns = $title->getNamespace();
107
108 if ( $ns == NS_MEDIA ) {
109 throw new MWException( "NS_MEDIA is a virtual namespace; use NS_FILE." );
110 } elseif ( $ns < 0 ) {
111 throw new MWException( "Invalid or virtual namespace $ns given." );
112 }
113
114 switch ( $ns ) {
115 case NS_FILE:
116 $page = new WikiFilePage( $title );
117 break;
118 case NS_CATEGORY:
119 $page = new WikiCategoryPage( $title );
120 break;
121 default:
122 $page = new WikiPage( $title );
123 }
124
125 return $page;
126 }
127
128 /**
129 * Constructor from a page id
130 *
131 * @param int $id Article ID to load
132 * @param string|int $from One of the following values:
133 * - "fromdb" or WikiPage::READ_NORMAL to select from a slave database
134 * - "fromdbmaster" or WikiPage::READ_LATEST to select from the master database
135 *
136 * @return WikiPage|null
137 */
138 public static function newFromID( $id, $from = 'fromdb' ) {
139 // page id's are never 0 or negative, see bug 61166
140 if ( $id < 1 ) {
141 return null;
142 }
143
144 $from = self::convertSelectType( $from );
145 $db = wfGetDB( $from === self::READ_LATEST ? DB_MASTER : DB_SLAVE );
146 $row = $db->selectRow( 'page', self::selectFields(), array( 'page_id' => $id ), __METHOD__ );
147 if ( !$row ) {
148 return null;
149 }
150 return self::newFromRow( $row, $from );
151 }
152
153 /**
154 * Constructor from a database row
155 *
156 * @since 1.20
157 * @param object $row Database row containing at least fields returned by selectFields().
158 * @param string|int $from Source of $data:
159 * - "fromdb" or WikiPage::READ_NORMAL: from a slave DB
160 * - "fromdbmaster" or WikiPage::READ_LATEST: from the master DB
161 * - "forupdate" or WikiPage::READ_LOCKING: from the master DB using SELECT FOR UPDATE
162 * @return WikiPage
163 */
164 public static function newFromRow( $row, $from = 'fromdb' ) {
165 $page = self::factory( Title::newFromRow( $row ) );
166 $page->loadFromRow( $row, $from );
167 return $page;
168 }
169
170 /**
171 * Convert 'fromdb', 'fromdbmaster' and 'forupdate' to READ_* constants.
172 *
173 * @param object|string|int $type
174 * @return mixed
175 */
176 private static function convertSelectType( $type ) {
177 switch ( $type ) {
178 case 'fromdb':
179 return self::READ_NORMAL;
180 case 'fromdbmaster':
181 return self::READ_LATEST;
182 case 'forupdate':
183 return self::READ_LOCKING;
184 default:
185 // It may already be an integer or whatever else
186 return $type;
187 }
188 }
189
190 /**
191 * Returns overrides for action handlers.
192 * Classes listed here will be used instead of the default one when
193 * (and only when) $wgActions[$action] === true. This allows subclasses
194 * to override the default behavior.
195 *
196 * @todo Move this UI stuff somewhere else
197 *
198 * @return array
199 */
200 public function getActionOverrides() {
201 $content_handler = $this->getContentHandler();
202 return $content_handler->getActionOverrides();
203 }
204
205 /**
206 * Returns the ContentHandler instance to be used to deal with the content of this WikiPage.
207 *
208 * Shorthand for ContentHandler::getForModelID( $this->getContentModel() );
209 *
210 * @return ContentHandler
211 *
212 * @since 1.21
213 */
214 public function getContentHandler() {
215 return ContentHandler::getForModelID( $this->getContentModel() );
216 }
217
218 /**
219 * Get the title object of the article
220 * @return Title Title object of this page
221 */
222 public function getTitle() {
223 return $this->mTitle;
224 }
225
226 /**
227 * Clear the object
228 * @return void
229 */
230 public function clear() {
231 $this->mDataLoaded = false;
232 $this->mDataLoadedFrom = self::READ_NONE;
233
234 $this->clearCacheFields();
235 }
236
237 /**
238 * Clear the object cache fields
239 * @return void
240 */
241 protected function clearCacheFields() {
242 $this->mId = null;
243 $this->mRedirectTarget = null; // Title object if set
244 $this->mLastRevision = null; // Latest revision
245 $this->mTouched = '19700101000000';
246 $this->mLinksUpdated = '19700101000000';
247 $this->mTimestamp = '';
248 $this->mIsRedirect = false;
249 $this->mLatest = false;
250 // Bug 57026: do not clear mPreparedEdit since prepareTextForEdit() already checks
251 // the requested rev ID and content against the cached one for equality. For most
252 // content types, the output should not change during the lifetime of this cache.
253 // Clearing it can cause extra parses on edit for no reason.
254 }
255
256 /**
257 * Clear the mPreparedEdit cache field, as may be needed by mutable content types
258 * @return void
259 * @since 1.23
260 */
261 public function clearPreparedEdit() {
262 $this->mPreparedEdit = false;
263 }
264
265 /**
266 * Return the list of revision fields that should be selected to create
267 * a new page.
268 *
269 * @return array
270 */
271 public static function selectFields() {
272 global $wgContentHandlerUseDB, $wgPageLanguageUseDB;
273
274 $fields = array(
275 'page_id',
276 'page_namespace',
277 'page_title',
278 'page_restrictions',
279 'page_is_redirect',
280 'page_is_new',
281 'page_random',
282 'page_touched',
283 'page_links_updated',
284 'page_latest',
285 'page_len',
286 );
287
288 if ( $wgContentHandlerUseDB ) {
289 $fields[] = 'page_content_model';
290 }
291
292 if ( $wgPageLanguageUseDB ) {
293 $fields[] = 'page_lang';
294 }
295
296 return $fields;
297 }
298
299 /**
300 * Fetch a page record with the given conditions
301 * @param DatabaseBase $dbr
302 * @param array $conditions
303 * @param array $options
304 * @return object|bool Database result resource, or false on failure
305 */
306 protected function pageData( $dbr, $conditions, $options = array() ) {
307 $fields = self::selectFields();
308
309 Hooks::run( 'ArticlePageDataBefore', array( &$this, &$fields ) );
310
311 $row = $dbr->selectRow( 'page', $fields, $conditions, __METHOD__, $options );
312
313 Hooks::run( 'ArticlePageDataAfter', array( &$this, &$row ) );
314
315 return $row;
316 }
317
318 /**
319 * Fetch a page record matching the Title object's namespace and title
320 * using a sanitized title string
321 *
322 * @param DatabaseBase $dbr
323 * @param Title $title
324 * @param array $options
325 * @return object|bool Database result resource, or false on failure
326 */
327 public function pageDataFromTitle( $dbr, $title, $options = array() ) {
328 return $this->pageData( $dbr, array(
329 'page_namespace' => $title->getNamespace(),
330 'page_title' => $title->getDBkey() ), $options );
331 }
332
333 /**
334 * Fetch a page record matching the requested ID
335 *
336 * @param DatabaseBase $dbr
337 * @param int $id
338 * @param array $options
339 * @return object|bool Database result resource, or false on failure
340 */
341 public function pageDataFromId( $dbr, $id, $options = array() ) {
342 return $this->pageData( $dbr, array( 'page_id' => $id ), $options );
343 }
344
345 /**
346 * Load the object from a given source by title
347 *
348 * @param object|string|int $from One of the following:
349 * - A DB query result object.
350 * - "fromdb" or WikiPage::READ_NORMAL to get from a slave DB.
351 * - "fromdbmaster" or WikiPage::READ_LATEST to get from the master DB.
352 * - "forupdate" or WikiPage::READ_LOCKING to get from the master DB
353 * using SELECT FOR UPDATE.
354 *
355 * @return void
356 */
357 public function loadPageData( $from = 'fromdb' ) {
358 $from = self::convertSelectType( $from );
359 if ( is_int( $from ) && $from <= $this->mDataLoadedFrom ) {
360 // We already have the data from the correct location, no need to load it twice.
361 return;
362 }
363
364 if ( $from === self::READ_LOCKING ) {
365 $data = $this->pageDataFromTitle( wfGetDB( DB_MASTER ), $this->mTitle, array( 'FOR UPDATE' ) );
366 } elseif ( $from === self::READ_LATEST ) {
367 $data = $this->pageDataFromTitle( wfGetDB( DB_MASTER ), $this->mTitle );
368 } elseif ( $from === self::READ_NORMAL ) {
369 $data = $this->pageDataFromTitle( wfGetDB( DB_SLAVE ), $this->mTitle );
370 // Use a "last rev inserted" timestamp key to diminish the issue of slave lag.
371 // Note that DB also stores the master position in the session and checks it.
372 $touched = $this->getCachedLastEditTime();
373 if ( $touched ) { // key set
374 if ( !$data || $touched > wfTimestamp( TS_MW, $data->page_touched ) ) {
375 $from = self::READ_LATEST;
376 $data = $this->pageDataFromTitle( wfGetDB( DB_MASTER ), $this->mTitle );
377 }
378 }
379 } else {
380 // No idea from where the caller got this data, assume slave database.
381 $data = $from;
382 $from = self::READ_NORMAL;
383 }
384
385 $this->loadFromRow( $data, $from );
386 }
387
388 /**
389 * Load the object from a database row
390 *
391 * @since 1.20
392 * @param object $data Database row containing at least fields returned by selectFields()
393 * @param string|int $from One of the following:
394 * - "fromdb" or WikiPage::READ_NORMAL if the data comes from a slave DB
395 * - "fromdbmaster" or WikiPage::READ_LATEST if the data comes from the master DB
396 * - "forupdate" or WikiPage::READ_LOCKING if the data comes from
397 * the master DB using SELECT FOR UPDATE
398 */
399 public function loadFromRow( $data, $from ) {
400 $lc = LinkCache::singleton();
401 $lc->clearLink( $this->mTitle );
402
403 if ( $data ) {
404 $lc->addGoodLinkObjFromRow( $this->mTitle, $data );
405
406 $this->mTitle->loadFromRow( $data );
407
408 // Old-fashioned restrictions
409 $this->mTitle->loadRestrictions( $data->page_restrictions );
410
411 $this->mId = intval( $data->page_id );
412 $this->mTouched = wfTimestamp( TS_MW, $data->page_touched );
413 $this->mLinksUpdated = wfTimestampOrNull( TS_MW, $data->page_links_updated );
414 $this->mIsRedirect = intval( $data->page_is_redirect );
415 $this->mLatest = intval( $data->page_latest );
416 // Bug 37225: $latest may no longer match the cached latest Revision object.
417 // Double-check the ID of any cached latest Revision object for consistency.
418 if ( $this->mLastRevision && $this->mLastRevision->getId() != $this->mLatest ) {
419 $this->mLastRevision = null;
420 $this->mTimestamp = '';
421 }
422 } else {
423 $lc->addBadLinkObj( $this->mTitle );
424
425 $this->mTitle->loadFromRow( false );
426
427 $this->clearCacheFields();
428
429 $this->mId = 0;
430 }
431
432 $this->mDataLoaded = true;
433 $this->mDataLoadedFrom = self::convertSelectType( $from );
434 }
435
436 /**
437 * @return int Page ID
438 */
439 public function getId() {
440 if ( !$this->mDataLoaded ) {
441 $this->loadPageData();
442 }
443 return $this->mId;
444 }
445
446 /**
447 * @return bool Whether or not the page exists in the database
448 */
449 public function exists() {
450 if ( !$this->mDataLoaded ) {
451 $this->loadPageData();
452 }
453 return $this->mId > 0;
454 }
455
456 /**
457 * Check if this page is something we're going to be showing
458 * some sort of sensible content for. If we return false, page
459 * views (plain action=view) will return an HTTP 404 response,
460 * so spiders and robots can know they're following a bad link.
461 *
462 * @return bool
463 */
464 public function hasViewableContent() {
465 return $this->exists() || $this->mTitle->isAlwaysKnown();
466 }
467
468 /**
469 * Tests if the article content represents a redirect
470 *
471 * @return bool
472 */
473 public function isRedirect() {
474 $content = $this->getContent();
475 if ( !$content ) {
476 return false;
477 }
478
479 return $content->isRedirect();
480 }
481
482 /**
483 * Returns the page's content model id (see the CONTENT_MODEL_XXX constants).
484 *
485 * Will use the revisions actual content model if the page exists,
486 * and the page's default if the page doesn't exist yet.
487 *
488 * @return string
489 *
490 * @since 1.21
491 */
492 public function getContentModel() {
493 if ( $this->exists() ) {
494 // look at the revision's actual content model
495 $rev = $this->getRevision();
496
497 if ( $rev !== null ) {
498 return $rev->getContentModel();
499 } else {
500 $title = $this->mTitle->getPrefixedDBkey();
501 wfWarn( "Page $title exists but has no (visible) revisions!" );
502 }
503 }
504
505 // use the default model for this page
506 return $this->mTitle->getContentModel();
507 }
508
509 /**
510 * Loads page_touched and returns a value indicating if it should be used
511 * @return bool True if not a redirect
512 */
513 public function checkTouched() {
514 if ( !$this->mDataLoaded ) {
515 $this->loadPageData();
516 }
517 return !$this->mIsRedirect;
518 }
519
520 /**
521 * Get the page_touched field
522 * @return string Containing GMT timestamp
523 */
524 public function getTouched() {
525 if ( !$this->mDataLoaded ) {
526 $this->loadPageData();
527 }
528 return $this->mTouched;
529 }
530
531 /**
532 * Get the page_links_updated field
533 * @return string|null Containing GMT timestamp
534 */
535 public function getLinksTimestamp() {
536 if ( !$this->mDataLoaded ) {
537 $this->loadPageData();
538 }
539 return $this->mLinksUpdated;
540 }
541
542 /**
543 * Get the page_latest field
544 * @return int The rev_id of current revision
545 */
546 public function getLatest() {
547 if ( !$this->mDataLoaded ) {
548 $this->loadPageData();
549 }
550 return (int)$this->mLatest;
551 }
552
553 /**
554 * Get the Revision object of the oldest revision
555 * @return Revision|null
556 */
557 public function getOldestRevision() {
558
559 // Try using the slave database first, then try the master
560 $continue = 2;
561 $db = wfGetDB( DB_SLAVE );
562 $revSelectFields = Revision::selectFields();
563
564 $row = null;
565 while ( $continue ) {
566 $row = $db->selectRow(
567 array( 'page', 'revision' ),
568 $revSelectFields,
569 array(
570 'page_namespace' => $this->mTitle->getNamespace(),
571 'page_title' => $this->mTitle->getDBkey(),
572 'rev_page = page_id'
573 ),
574 __METHOD__,
575 array(
576 'ORDER BY' => 'rev_timestamp ASC'
577 )
578 );
579
580 if ( $row ) {
581 $continue = 0;
582 } else {
583 $db = wfGetDB( DB_MASTER );
584 $continue--;
585 }
586 }
587
588 return $row ? Revision::newFromRow( $row ) : null;
589 }
590
591 /**
592 * Loads everything except the text
593 * This isn't necessary for all uses, so it's only done if needed.
594 */
595 protected function loadLastEdit() {
596 if ( $this->mLastRevision !== null ) {
597 return; // already loaded
598 }
599
600 $latest = $this->getLatest();
601 if ( !$latest ) {
602 return; // page doesn't exist or is missing page_latest info
603 }
604
605 if ( $this->mDataLoadedFrom == self::READ_LOCKING ) {
606 // Bug 37225: if session S1 loads the page row FOR UPDATE, the result always
607 // includes the latest changes committed. This is true even within REPEATABLE-READ
608 // transactions, where S1 normally only sees changes committed before the first S1
609 // SELECT. Thus we need S1 to also gets the revision row FOR UPDATE; otherwise, it
610 // may not find it since a page row UPDATE and revision row INSERT by S2 may have
611 // happened after the first S1 SELECT.
612 // http://dev.mysql.com/doc/refman/5.0/en/set-transaction.html#isolevel_repeatable-read.
613 $flags = Revision::READ_LOCKING;
614 } elseif ( $this->mDataLoadedFrom == self::READ_LATEST ) {
615 // Bug T93976: if page_latest was loaded from the master, fetch the
616 // revision from there as well, as it may not exist yet on a slave DB.
617 // Also, this keeps the queries in the same REPEATABLE-READ snapshot.
618 $flags = Revision::READ_LATEST;
619 } else {
620 $flags = 0;
621 }
622 $revision = Revision::newFromPageId( $this->getId(), $latest, $flags );
623 if ( $revision ) { // sanity
624 $this->setLastEdit( $revision );
625 }
626 }
627
628 /**
629 * Set the latest revision
630 * @param Revision $revision
631 */
632 protected function setLastEdit( Revision $revision ) {
633 $this->mLastRevision = $revision;
634 $this->mTimestamp = $revision->getTimestamp();
635 }
636
637 /**
638 * Get the latest revision
639 * @return Revision|null
640 */
641 public function getRevision() {
642 $this->loadLastEdit();
643 if ( $this->mLastRevision ) {
644 return $this->mLastRevision;
645 }
646 return null;
647 }
648
649 /**
650 * Get the content of the current revision. No side-effects...
651 *
652 * @param int $audience One of:
653 * Revision::FOR_PUBLIC to be displayed to all users
654 * Revision::FOR_THIS_USER to be displayed to $wgUser
655 * Revision::RAW get the text regardless of permissions
656 * @param User $user User object to check for, only if FOR_THIS_USER is passed
657 * to the $audience parameter
658 * @return Content|null The content of the current revision
659 *
660 * @since 1.21
661 */
662 public function getContent( $audience = Revision::FOR_PUBLIC, User $user = null ) {
663 $this->loadLastEdit();
664 if ( $this->mLastRevision ) {
665 return $this->mLastRevision->getContent( $audience, $user );
666 }
667 return null;
668 }
669
670 /**
671 * Get the text of the current revision. No side-effects...
672 *
673 * @param int $audience One of:
674 * Revision::FOR_PUBLIC to be displayed to all users
675 * Revision::FOR_THIS_USER to be displayed to the given user
676 * Revision::RAW get the text regardless of permissions
677 * @param User $user User object to check for, only if FOR_THIS_USER is passed
678 * to the $audience parameter
679 * @return string|bool The text of the current revision
680 * @deprecated since 1.21, getContent() should be used instead.
681 */
682 public function getText( $audience = Revision::FOR_PUBLIC, User $user = null ) {
683 ContentHandler::deprecated( __METHOD__, '1.21' );
684
685 $this->loadLastEdit();
686 if ( $this->mLastRevision ) {
687 return $this->mLastRevision->getText( $audience, $user );
688 }
689 return false;
690 }
691
692 /**
693 * Get the text of the current revision. No side-effects...
694 *
695 * @return string|bool The text of the current revision. False on failure
696 * @deprecated since 1.21, getContent() should be used instead.
697 */
698 public function getRawText() {
699 ContentHandler::deprecated( __METHOD__, '1.21' );
700
701 return $this->getText( Revision::RAW );
702 }
703
704 /**
705 * @return string MW timestamp of last article revision
706 */
707 public function getTimestamp() {
708 // Check if the field has been filled by WikiPage::setTimestamp()
709 if ( !$this->mTimestamp ) {
710 $this->loadLastEdit();
711 }
712
713 return wfTimestamp( TS_MW, $this->mTimestamp );
714 }
715
716 /**
717 * Set the page timestamp (use only to avoid DB queries)
718 * @param string $ts MW timestamp of last article revision
719 * @return void
720 */
721 public function setTimestamp( $ts ) {
722 $this->mTimestamp = wfTimestamp( TS_MW, $ts );
723 }
724
725 /**
726 * @param int $audience One of:
727 * Revision::FOR_PUBLIC to be displayed to all users
728 * Revision::FOR_THIS_USER to be displayed to the given user
729 * Revision::RAW get the text regardless of permissions
730 * @param User $user User object to check for, only if FOR_THIS_USER is passed
731 * to the $audience parameter
732 * @return int User ID for the user that made the last article revision
733 */
734 public function getUser( $audience = Revision::FOR_PUBLIC, User $user = null ) {
735 $this->loadLastEdit();
736 if ( $this->mLastRevision ) {
737 return $this->mLastRevision->getUser( $audience, $user );
738 } else {
739 return -1;
740 }
741 }
742
743 /**
744 * Get the User object of the user who created the page
745 * @param int $audience One of:
746 * Revision::FOR_PUBLIC to be displayed to all users
747 * Revision::FOR_THIS_USER to be displayed to the given user
748 * Revision::RAW get the text regardless of permissions
749 * @param User $user User object to check for, only if FOR_THIS_USER is passed
750 * to the $audience parameter
751 * @return User|null
752 */
753 public function getCreator( $audience = Revision::FOR_PUBLIC, User $user = null ) {
754 $revision = $this->getOldestRevision();
755 if ( $revision ) {
756 $userName = $revision->getUserText( $audience, $user );
757 return User::newFromName( $userName, false );
758 } else {
759 return null;
760 }
761 }
762
763 /**
764 * @param int $audience One of:
765 * Revision::FOR_PUBLIC to be displayed to all users
766 * Revision::FOR_THIS_USER to be displayed to the given user
767 * Revision::RAW get the text regardless of permissions
768 * @param User $user User object to check for, only if FOR_THIS_USER is passed
769 * to the $audience parameter
770 * @return string Username of the user that made the last article revision
771 */
772 public function getUserText( $audience = Revision::FOR_PUBLIC, User $user = null ) {
773 $this->loadLastEdit();
774 if ( $this->mLastRevision ) {
775 return $this->mLastRevision->getUserText( $audience, $user );
776 } else {
777 return '';
778 }
779 }
780
781 /**
782 * @param int $audience One of:
783 * Revision::FOR_PUBLIC to be displayed to all users
784 * Revision::FOR_THIS_USER to be displayed to the given user
785 * Revision::RAW get the text regardless of permissions
786 * @param User $user User object to check for, only if FOR_THIS_USER is passed
787 * to the $audience parameter
788 * @return string Comment stored for the last article revision
789 */
790 public function getComment( $audience = Revision::FOR_PUBLIC, User $user = null ) {
791 $this->loadLastEdit();
792 if ( $this->mLastRevision ) {
793 return $this->mLastRevision->getComment( $audience, $user );
794 } else {
795 return '';
796 }
797 }
798
799 /**
800 * Returns true if last revision was marked as "minor edit"
801 *
802 * @return bool Minor edit indicator for the last article revision.
803 */
804 public function getMinorEdit() {
805 $this->loadLastEdit();
806 if ( $this->mLastRevision ) {
807 return $this->mLastRevision->isMinor();
808 } else {
809 return false;
810 }
811 }
812
813 /**
814 * Get the cached timestamp for the last time the page changed.
815 * This is only used to help handle slave lag by comparing to page_touched.
816 * @return string MW timestamp
817 */
818 protected function getCachedLastEditTime() {
819 global $wgMemc;
820 $key = wfMemcKey( 'page-lastedit', md5( $this->mTitle->getPrefixedDBkey() ) );
821 return $wgMemc->get( $key );
822 }
823
824 /**
825 * Set the cached timestamp for the last time the page changed.
826 * This is only used to help handle slave lag by comparing to page_touched.
827 * @param string $timestamp
828 * @return void
829 */
830 public function setCachedLastEditTime( $timestamp ) {
831 global $wgMemc;
832 $key = wfMemcKey( 'page-lastedit', md5( $this->mTitle->getPrefixedDBkey() ) );
833 $wgMemc->set( $key, wfTimestamp( TS_MW, $timestamp ), 60 * 15 );
834 }
835
836 /**
837 * Determine whether a page would be suitable for being counted as an
838 * article in the site_stats table based on the title & its content
839 *
840 * @param object|bool $editInfo (false): object returned by prepareTextForEdit(),
841 * if false, the current database state will be used
842 * @return bool
843 */
844 public function isCountable( $editInfo = false ) {
845 global $wgArticleCountMethod;
846
847 if ( !$this->mTitle->isContentPage() ) {
848 return false;
849 }
850
851 if ( $editInfo ) {
852 $content = $editInfo->pstContent;
853 } else {
854 $content = $this->getContent();
855 }
856
857 if ( !$content || $content->isRedirect() ) {
858 return false;
859 }
860
861 $hasLinks = null;
862
863 if ( $wgArticleCountMethod === 'link' ) {
864 // nasty special case to avoid re-parsing to detect links
865
866 if ( $editInfo ) {
867 // ParserOutput::getLinks() is a 2D array of page links, so
868 // to be really correct we would need to recurse in the array
869 // but the main array should only have items in it if there are
870 // links.
871 $hasLinks = (bool)count( $editInfo->output->getLinks() );
872 } else {
873 $hasLinks = (bool)wfGetDB( DB_SLAVE )->selectField( 'pagelinks', 1,
874 array( 'pl_from' => $this->getId() ), __METHOD__ );
875 }
876 }
877
878 return $content->isCountable( $hasLinks );
879 }
880
881 /**
882 * If this page is a redirect, get its target
883 *
884 * The target will be fetched from the redirect table if possible.
885 * If this page doesn't have an entry there, call insertRedirect()
886 * @return Title|null Title object, or null if this page is not a redirect
887 */
888 public function getRedirectTarget() {
889 if ( !$this->mTitle->isRedirect() ) {
890 return null;
891 }
892
893 if ( $this->mRedirectTarget !== null ) {
894 return $this->mRedirectTarget;
895 }
896
897 // Query the redirect table
898 $dbr = wfGetDB( DB_SLAVE );
899 $row = $dbr->selectRow( 'redirect',
900 array( 'rd_namespace', 'rd_title', 'rd_fragment', 'rd_interwiki' ),
901 array( 'rd_from' => $this->getId() ),
902 __METHOD__
903 );
904
905 // rd_fragment and rd_interwiki were added later, populate them if empty
906 if ( $row && !is_null( $row->rd_fragment ) && !is_null( $row->rd_interwiki ) ) {
907 $this->mRedirectTarget = Title::makeTitle(
908 $row->rd_namespace, $row->rd_title,
909 $row->rd_fragment, $row->rd_interwiki );
910 return $this->mRedirectTarget;
911 }
912
913 // This page doesn't have an entry in the redirect table
914 $this->mRedirectTarget = $this->insertRedirect();
915 return $this->mRedirectTarget;
916 }
917
918 /**
919 * Insert an entry for this page into the redirect table.
920 *
921 * Don't call this function directly unless you know what you're doing.
922 * @return Title|null Title object or null if not a redirect
923 */
924 public function insertRedirect() {
925 // recurse through to only get the final target
926 $content = $this->getContent();
927 $retval = $content ? $content->getUltimateRedirectTarget() : null;
928 if ( !$retval ) {
929 return null;
930 }
931 $this->insertRedirectEntry( $retval );
932 return $retval;
933 }
934
935 /**
936 * Insert or update the redirect table entry for this page to indicate
937 * it redirects to $rt .
938 * @param Title $rt Redirect target
939 */
940 public function insertRedirectEntry( $rt ) {
941 $dbw = wfGetDB( DB_MASTER );
942 $dbw->replace( 'redirect', array( 'rd_from' ),
943 array(
944 'rd_from' => $this->getId(),
945 'rd_namespace' => $rt->getNamespace(),
946 'rd_title' => $rt->getDBkey(),
947 'rd_fragment' => $rt->getFragment(),
948 'rd_interwiki' => $rt->getInterwiki(),
949 ),
950 __METHOD__
951 );
952 }
953
954 /**
955 * Get the Title object or URL this page redirects to
956 *
957 * @return bool|Title|string False, Title of in-wiki target, or string with URL
958 */
959 public function followRedirect() {
960 return $this->getRedirectURL( $this->getRedirectTarget() );
961 }
962
963 /**
964 * Get the Title object or URL to use for a redirect. We use Title
965 * objects for same-wiki, non-special redirects and URLs for everything
966 * else.
967 * @param Title $rt Redirect target
968 * @return bool|Title|string False, Title object of local target, or string with URL
969 */
970 public function getRedirectURL( $rt ) {
971 if ( !$rt ) {
972 return false;
973 }
974
975 if ( $rt->isExternal() ) {
976 if ( $rt->isLocal() ) {
977 // Offsite wikis need an HTTP redirect.
978 //
979 // This can be hard to reverse and may produce loops,
980 // so they may be disabled in the site configuration.
981 $source = $this->mTitle->getFullURL( 'redirect=no' );
982 return $rt->getFullURL( array( 'rdfrom' => $source ) );
983 } else {
984 // External pages without "local" bit set are not valid
985 // redirect targets
986 return false;
987 }
988 }
989
990 if ( $rt->isSpecialPage() ) {
991 // Gotta handle redirects to special pages differently:
992 // Fill the HTTP response "Location" header and ignore
993 // the rest of the page we're on.
994 //
995 // Some pages are not valid targets
996 if ( $rt->isValidRedirectTarget() ) {
997 return $rt->getFullURL();
998 } else {
999 return false;
1000 }
1001 }
1002
1003 return $rt;
1004 }
1005
1006 /**
1007 * Get a list of users who have edited this article, not including the user who made
1008 * the most recent revision, which you can get from $article->getUser() if you want it
1009 * @return UserArrayFromResult
1010 */
1011 public function getContributors() {
1012 // @todo FIXME: This is expensive; cache this info somewhere.
1013
1014 $dbr = wfGetDB( DB_SLAVE );
1015
1016 if ( $dbr->implicitGroupby() ) {
1017 $realNameField = 'user_real_name';
1018 } else {
1019 $realNameField = 'MIN(user_real_name) AS user_real_name';
1020 }
1021
1022 $tables = array( 'revision', 'user' );
1023
1024 $fields = array(
1025 'user_id' => 'rev_user',
1026 'user_name' => 'rev_user_text',
1027 $realNameField,
1028 'timestamp' => 'MAX(rev_timestamp)',
1029 );
1030
1031 $conds = array( 'rev_page' => $this->getId() );
1032
1033 // The user who made the top revision gets credited as "this page was last edited by
1034 // John, based on contributions by Tom, Dick and Harry", so don't include them twice.
1035 $user = $this->getUser();
1036 if ( $user ) {
1037 $conds[] = "rev_user != $user";
1038 } else {
1039 $conds[] = "rev_user_text != {$dbr->addQuotes( $this->getUserText() )}";
1040 }
1041
1042 $conds[] = "{$dbr->bitAnd( 'rev_deleted', Revision::DELETED_USER )} = 0"; // username hidden?
1043
1044 $jconds = array(
1045 'user' => array( 'LEFT JOIN', 'rev_user = user_id' ),
1046 );
1047
1048 $options = array(
1049 'GROUP BY' => array( 'rev_user', 'rev_user_text' ),
1050 'ORDER BY' => 'timestamp DESC',
1051 );
1052
1053 $res = $dbr->select( $tables, $fields, $conds, __METHOD__, $options, $jconds );
1054 return new UserArrayFromResult( $res );
1055 }
1056
1057 /**
1058 * Get the last N authors
1059 * @param int $num Number of revisions to get
1060 * @param int|string $revLatest The latest rev_id, selected from the master (optional)
1061 * @return array Array of authors, duplicates not removed
1062 */
1063 public function getLastNAuthors( $num, $revLatest = 0 ) {
1064 // First try the slave
1065 // If that doesn't have the latest revision, try the master
1066 $continue = 2;
1067 $db = wfGetDB( DB_SLAVE );
1068
1069 do {
1070 $res = $db->select( array( 'page', 'revision' ),
1071 array( 'rev_id', 'rev_user_text' ),
1072 array(
1073 'page_namespace' => $this->mTitle->getNamespace(),
1074 'page_title' => $this->mTitle->getDBkey(),
1075 'rev_page = page_id'
1076 ), __METHOD__,
1077 array(
1078 'ORDER BY' => 'rev_timestamp DESC',
1079 'LIMIT' => $num
1080 )
1081 );
1082
1083 if ( !$res ) {
1084 return array();
1085 }
1086
1087 $row = $db->fetchObject( $res );
1088
1089 if ( $continue == 2 && $revLatest && $row->rev_id != $revLatest ) {
1090 $db = wfGetDB( DB_MASTER );
1091 $continue--;
1092 } else {
1093 $continue = 0;
1094 }
1095 } while ( $continue );
1096
1097 $authors = array( $row->rev_user_text );
1098
1099 foreach ( $res as $row ) {
1100 $authors[] = $row->rev_user_text;
1101 }
1102
1103 return $authors;
1104 }
1105
1106 /**
1107 * Should the parser cache be used?
1108 *
1109 * @param ParserOptions $parserOptions ParserOptions to check
1110 * @param int $oldid
1111 * @return bool
1112 */
1113 public function isParserCacheUsed( ParserOptions $parserOptions, $oldid ) {
1114 global $wgEnableParserCache;
1115
1116 return $wgEnableParserCache
1117 && $parserOptions->getStubThreshold() == 0
1118 && $this->exists()
1119 && ( $oldid === null || $oldid === 0 || $oldid === $this->getLatest() )
1120 && $this->getContentHandler()->isParserCacheSupported();
1121 }
1122
1123 /**
1124 * Get a ParserOutput for the given ParserOptions and revision ID.
1125 * The parser cache will be used if possible.
1126 *
1127 * @since 1.19
1128 * @param ParserOptions $parserOptions ParserOptions to use for the parse operation
1129 * @param null|int $oldid Revision ID to get the text from, passing null or 0 will
1130 * get the current revision (default value)
1131 *
1132 * @return ParserOutput|bool ParserOutput or false if the revision was not found
1133 */
1134 public function getParserOutput( ParserOptions $parserOptions, $oldid = null ) {
1135
1136 $useParserCache = $this->isParserCacheUsed( $parserOptions, $oldid );
1137 wfDebug( __METHOD__ . ': using parser cache: ' . ( $useParserCache ? 'yes' : 'no' ) . "\n" );
1138 if ( $parserOptions->getStubThreshold() ) {
1139 wfIncrStats( 'pcache_miss_stub' );
1140 }
1141
1142 if ( $useParserCache ) {
1143 $parserOutput = ParserCache::singleton()->get( $this, $parserOptions );
1144 if ( $parserOutput !== false ) {
1145 return $parserOutput;
1146 }
1147 }
1148
1149 if ( $oldid === null || $oldid === 0 ) {
1150 $oldid = $this->getLatest();
1151 }
1152
1153 $pool = new PoolWorkArticleView( $this, $parserOptions, $oldid, $useParserCache );
1154 $pool->execute();
1155
1156 return $pool->getParserOutput();
1157 }
1158
1159 /**
1160 * Do standard deferred updates after page view (existing or missing page)
1161 * @param User $user The relevant user
1162 * @param int $oldid The revision id being viewed. If not given or 0, latest revision is assumed.
1163 */
1164 public function doViewUpdates( User $user, $oldid = 0 ) {
1165 if ( wfReadOnly() ) {
1166 return;
1167 }
1168
1169 // Update newtalk / watchlist notification status
1170 $user->clearNotification( $this->mTitle, $oldid );
1171 }
1172
1173 /**
1174 * Perform the actions of a page purging
1175 * @return bool
1176 */
1177 public function doPurge() {
1178 global $wgUseSquid;
1179
1180 if ( !Hooks::run( 'ArticlePurge', array( &$this ) ) ) {
1181 return false;
1182 }
1183
1184 // Invalidate the cache
1185 $this->mTitle->invalidateCache();
1186
1187 if ( $wgUseSquid ) {
1188 // Commit the transaction before the purge is sent
1189 $dbw = wfGetDB( DB_MASTER );
1190 $dbw->commit( __METHOD__ );
1191
1192 // Send purge
1193 $update = SquidUpdate::newSimplePurge( $this->mTitle );
1194 $update->doUpdate();
1195 }
1196
1197 if ( $this->mTitle->getNamespace() == NS_MEDIAWIKI ) {
1198 // @todo move this logic to MessageCache
1199
1200 if ( $this->exists() ) {
1201 // NOTE: use transclusion text for messages.
1202 // This is consistent with MessageCache::getMsgFromNamespace()
1203
1204 $content = $this->getContent();
1205 $text = $content === null ? null : $content->getWikitextForTransclusion();
1206
1207 if ( $text === null ) {
1208 $text = false;
1209 }
1210 } else {
1211 $text = false;
1212 }
1213
1214 MessageCache::singleton()->replace( $this->mTitle->getDBkey(), $text );
1215 }
1216 return true;
1217 }
1218
1219 /**
1220 * Insert a new empty page record for this article.
1221 * This *must* be followed up by creating a revision
1222 * and running $this->updateRevisionOn( ... );
1223 * or else the record will be left in a funky state.
1224 * Best if all done inside a transaction.
1225 *
1226 * @param DatabaseBase $dbw
1227 * @return int The newly created page_id key, or false if the title already existed
1228 */
1229 public function insertOn( $dbw ) {
1230
1231 $page_id = $dbw->nextSequenceValue( 'page_page_id_seq' );
1232 $dbw->insert( 'page', array(
1233 'page_id' => $page_id,
1234 'page_namespace' => $this->mTitle->getNamespace(),
1235 'page_title' => $this->mTitle->getDBkey(),
1236 'page_restrictions' => '',
1237 'page_is_redirect' => 0, // Will set this shortly...
1238 'page_is_new' => 1,
1239 'page_random' => wfRandom(),
1240 'page_touched' => $dbw->timestamp(),
1241 'page_latest' => 0, // Fill this in shortly...
1242 'page_len' => 0, // Fill this in shortly...
1243 ), __METHOD__, 'IGNORE' );
1244
1245 $affected = $dbw->affectedRows();
1246
1247 if ( $affected ) {
1248 $newid = $dbw->insertId();
1249 $this->mId = $newid;
1250 $this->mTitle->resetArticleID( $newid );
1251 }
1252
1253 return $affected ? $newid : false;
1254 }
1255
1256 /**
1257 * Update the page record to point to a newly saved revision.
1258 *
1259 * @param DatabaseBase $dbw
1260 * @param Revision $revision For ID number, and text used to set
1261 * length and redirect status fields
1262 * @param int $lastRevision If given, will not overwrite the page field
1263 * when different from the currently set value.
1264 * Giving 0 indicates the new page flag should be set on.
1265 * @param bool $lastRevIsRedirect If given, will optimize adding and
1266 * removing rows in redirect table.
1267 * @return bool True on success, false on failure
1268 */
1269 public function updateRevisionOn( $dbw, $revision, $lastRevision = null,
1270 $lastRevIsRedirect = null
1271 ) {
1272 global $wgContentHandlerUseDB;
1273
1274 // Assertion to try to catch T92046
1275 if ( (int)$revision->getId() === 0 ) {
1276 throw new InvalidArgumentException(
1277 __METHOD__ . ': Revision has ID ' . var_export( $revision->getId(), 1 )
1278 );
1279 }
1280
1281 $content = $revision->getContent();
1282 $len = $content ? $content->getSize() : 0;
1283 $rt = $content ? $content->getUltimateRedirectTarget() : null;
1284
1285 $conditions = array( 'page_id' => $this->getId() );
1286
1287 if ( !is_null( $lastRevision ) ) {
1288 // An extra check against threads stepping on each other
1289 $conditions['page_latest'] = $lastRevision;
1290 }
1291
1292 $now = wfTimestampNow();
1293 $row = array( /* SET */
1294 'page_latest' => $revision->getId(),
1295 'page_touched' => $dbw->timestamp( $now ),
1296 'page_is_new' => ( $lastRevision === 0 ) ? 1 : 0,
1297 'page_is_redirect' => $rt !== null ? 1 : 0,
1298 'page_len' => $len,
1299 );
1300
1301 if ( $wgContentHandlerUseDB ) {
1302 $row['page_content_model'] = $revision->getContentModel();
1303 }
1304
1305 $dbw->update( 'page',
1306 $row,
1307 $conditions,
1308 __METHOD__ );
1309
1310 $result = $dbw->affectedRows() > 0;
1311 if ( $result ) {
1312 $this->updateRedirectOn( $dbw, $rt, $lastRevIsRedirect );
1313 $this->setLastEdit( $revision );
1314 $this->setCachedLastEditTime( $now );
1315 $this->mLatest = $revision->getId();
1316 $this->mIsRedirect = (bool)$rt;
1317 // Update the LinkCache.
1318 LinkCache::singleton()->addGoodLinkObj( $this->getId(), $this->mTitle, $len, $this->mIsRedirect,
1319 $this->mLatest, $revision->getContentModel() );
1320 }
1321
1322 return $result;
1323 }
1324
1325 /**
1326 * Add row to the redirect table if this is a redirect, remove otherwise.
1327 *
1328 * @param DatabaseBase $dbw
1329 * @param Title $redirectTitle Title object pointing to the redirect target,
1330 * or NULL if this is not a redirect
1331 * @param null|bool $lastRevIsRedirect If given, will optimize adding and
1332 * removing rows in redirect table.
1333 * @return bool True on success, false on failure
1334 * @private
1335 */
1336 public function updateRedirectOn( $dbw, $redirectTitle, $lastRevIsRedirect = null ) {
1337 // Always update redirects (target link might have changed)
1338 // Update/Insert if we don't know if the last revision was a redirect or not
1339 // Delete if changing from redirect to non-redirect
1340 $isRedirect = !is_null( $redirectTitle );
1341
1342 if ( !$isRedirect && $lastRevIsRedirect === false ) {
1343 return true;
1344 }
1345
1346 if ( $isRedirect ) {
1347 $this->insertRedirectEntry( $redirectTitle );
1348 } else {
1349 // This is not a redirect, remove row from redirect table
1350 $where = array( 'rd_from' => $this->getId() );
1351 $dbw->delete( 'redirect', $where, __METHOD__ );
1352 }
1353
1354 if ( $this->getTitle()->getNamespace() == NS_FILE ) {
1355 RepoGroup::singleton()->getLocalRepo()->invalidateImageRedirect( $this->getTitle() );
1356 }
1357
1358 return ( $dbw->affectedRows() != 0 );
1359 }
1360
1361 /**
1362 * If the given revision is newer than the currently set page_latest,
1363 * update the page record. Otherwise, do nothing.
1364 *
1365 * @deprecated since 1.24, use updateRevisionOn instead
1366 *
1367 * @param DatabaseBase $dbw
1368 * @param Revision $revision
1369 * @return bool
1370 */
1371 public function updateIfNewerOn( $dbw, $revision ) {
1372
1373 $row = $dbw->selectRow(
1374 array( 'revision', 'page' ),
1375 array( 'rev_id', 'rev_timestamp', 'page_is_redirect' ),
1376 array(
1377 'page_id' => $this->getId(),
1378 'page_latest=rev_id' ),
1379 __METHOD__ );
1380
1381 if ( $row ) {
1382 if ( wfTimestamp( TS_MW, $row->rev_timestamp ) >= $revision->getTimestamp() ) {
1383 return false;
1384 }
1385 $prev = $row->rev_id;
1386 $lastRevIsRedirect = (bool)$row->page_is_redirect;
1387 } else {
1388 // No or missing previous revision; mark the page as new
1389 $prev = 0;
1390 $lastRevIsRedirect = null;
1391 }
1392
1393 $ret = $this->updateRevisionOn( $dbw, $revision, $prev, $lastRevIsRedirect );
1394
1395 return $ret;
1396 }
1397
1398 /**
1399 * Get the content that needs to be saved in order to undo all revisions
1400 * between $undo and $undoafter. Revisions must belong to the same page,
1401 * must exist and must not be deleted
1402 * @param Revision $undo
1403 * @param Revision $undoafter Must be an earlier revision than $undo
1404 * @return mixed String on success, false on failure
1405 * @since 1.21
1406 * Before we had the Content object, this was done in getUndoText
1407 */
1408 public function getUndoContent( Revision $undo, Revision $undoafter = null ) {
1409 $handler = $undo->getContentHandler();
1410 return $handler->getUndoContent( $this->getRevision(), $undo, $undoafter );
1411 }
1412
1413 /**
1414 * Get the text that needs to be saved in order to undo all revisions
1415 * between $undo and $undoafter. Revisions must belong to the same page,
1416 * must exist and must not be deleted
1417 * @param Revision $undo
1418 * @param Revision $undoafter Must be an earlier revision than $undo
1419 * @return string|bool String on success, false on failure
1420 * @deprecated since 1.21: use ContentHandler::getUndoContent() instead.
1421 */
1422 public function getUndoText( Revision $undo, Revision $undoafter = null ) {
1423 ContentHandler::deprecated( __METHOD__, '1.21' );
1424
1425 $this->loadLastEdit();
1426
1427 if ( $this->mLastRevision ) {
1428 if ( is_null( $undoafter ) ) {
1429 $undoafter = $undo->getPrevious();
1430 }
1431
1432 $handler = $this->getContentHandler();
1433 $undone = $handler->getUndoContent( $this->mLastRevision, $undo, $undoafter );
1434
1435 if ( !$undone ) {
1436 return false;
1437 } else {
1438 return ContentHandler::getContentText( $undone );
1439 }
1440 }
1441
1442 return false;
1443 }
1444
1445 /**
1446 * @param string|number|null|bool $sectionId Section identifier as a number or string
1447 * (e.g. 0, 1 or 'T-1'), null/false or an empty string for the whole page
1448 * or 'new' for a new section.
1449 * @param string $text New text of the section.
1450 * @param string $sectionTitle New section's subject, only if $section is "new".
1451 * @param string $edittime Revision timestamp or null to use the current revision.
1452 *
1453 * @throws MWException
1454 * @return string New complete article text, or null if error.
1455 *
1456 * @deprecated since 1.21, use replaceSectionAtRev() instead
1457 */
1458 public function replaceSection( $sectionId, $text, $sectionTitle = '',
1459 $edittime = null
1460 ) {
1461 ContentHandler::deprecated( __METHOD__, '1.21' );
1462
1463 //NOTE: keep condition in sync with condition in replaceSectionContent!
1464 if ( strval( $sectionId ) === '' ) {
1465 // Whole-page edit; let the whole text through
1466 return $text;
1467 }
1468
1469 if ( !$this->supportsSections() ) {
1470 throw new MWException( "sections not supported for content model " .
1471 $this->getContentHandler()->getModelID() );
1472 }
1473
1474 // could even make section title, but that's not required.
1475 $sectionContent = ContentHandler::makeContent( $text, $this->getTitle() );
1476
1477 $newContent = $this->replaceSectionContent( $sectionId, $sectionContent, $sectionTitle,
1478 $edittime );
1479
1480 return ContentHandler::getContentText( $newContent );
1481 }
1482
1483 /**
1484 * Returns true if this page's content model supports sections.
1485 *
1486 * @return bool
1487 *
1488 * @todo The skin should check this and not offer section functionality if
1489 * sections are not supported.
1490 * @todo The EditPage should check this and not offer section functionality
1491 * if sections are not supported.
1492 */
1493 public function supportsSections() {
1494 return $this->getContentHandler()->supportsSections();
1495 }
1496
1497 /**
1498 * @param string|number|null|bool $sectionId Section identifier as a number or string
1499 * (e.g. 0, 1 or 'T-1'), null/false or an empty string for the whole page
1500 * or 'new' for a new section.
1501 * @param Content $sectionContent New content of the section.
1502 * @param string $sectionTitle New section's subject, only if $section is "new".
1503 * @param string $edittime Revision timestamp or null to use the current revision.
1504 *
1505 * @throws MWException
1506 * @return Content New complete article content, or null if error.
1507 *
1508 * @since 1.21
1509 * @deprecated since 1.24, use replaceSectionAtRev instead
1510 */
1511 public function replaceSectionContent( $sectionId, Content $sectionContent, $sectionTitle = '',
1512 $edittime = null ) {
1513
1514 $baseRevId = null;
1515 if ( $edittime && $sectionId !== 'new' ) {
1516 $dbw = wfGetDB( DB_MASTER );
1517 $rev = Revision::loadFromTimestamp( $dbw, $this->mTitle, $edittime );
1518 if ( $rev ) {
1519 $baseRevId = $rev->getId();
1520 }
1521 }
1522
1523 return $this->replaceSectionAtRev( $sectionId, $sectionContent, $sectionTitle, $baseRevId );
1524 }
1525
1526 /**
1527 * @param string|number|null|bool $sectionId Section identifier as a number or string
1528 * (e.g. 0, 1 or 'T-1'), null/false or an empty string for the whole page
1529 * or 'new' for a new section.
1530 * @param Content $sectionContent New content of the section.
1531 * @param string $sectionTitle New section's subject, only if $section is "new".
1532 * @param int|null $baseRevId
1533 *
1534 * @throws MWException
1535 * @return Content New complete article content, or null if error.
1536 *
1537 * @since 1.24
1538 */
1539 public function replaceSectionAtRev( $sectionId, Content $sectionContent,
1540 $sectionTitle = '', $baseRevId = null
1541 ) {
1542
1543 if ( strval( $sectionId ) === '' ) {
1544 // Whole-page edit; let the whole text through
1545 $newContent = $sectionContent;
1546 } else {
1547 if ( !$this->supportsSections() ) {
1548 throw new MWException( "sections not supported for content model " .
1549 $this->getContentHandler()->getModelID() );
1550 }
1551
1552 // Bug 30711: always use current version when adding a new section
1553 if ( is_null( $baseRevId ) || $sectionId === 'new' ) {
1554 $oldContent = $this->getContent();
1555 } else {
1556 $rev = Revision::newFromId( $baseRevId );
1557 if ( !$rev ) {
1558 wfDebug( __METHOD__ . " asked for bogus section (page: " .
1559 $this->getId() . "; section: $sectionId)\n" );
1560 return null;
1561 }
1562
1563 $oldContent = $rev->getContent();
1564 }
1565
1566 if ( !$oldContent ) {
1567 wfDebug( __METHOD__ . ": no page text\n" );
1568 return null;
1569 }
1570
1571 $newContent = $oldContent->replaceSection( $sectionId, $sectionContent, $sectionTitle );
1572 }
1573
1574 return $newContent;
1575 }
1576
1577 /**
1578 * Check flags and add EDIT_NEW or EDIT_UPDATE to them as needed.
1579 * @param int $flags
1580 * @return int Updated $flags
1581 */
1582 public function checkFlags( $flags ) {
1583 if ( !( $flags & EDIT_NEW ) && !( $flags & EDIT_UPDATE ) ) {
1584 if ( $this->exists() ) {
1585 $flags |= EDIT_UPDATE;
1586 } else {
1587 $flags |= EDIT_NEW;
1588 }
1589 }
1590
1591 return $flags;
1592 }
1593
1594 /**
1595 * Change an existing article or create a new article. Updates RC and all necessary caches,
1596 * optionally via the deferred update array.
1597 *
1598 * @param string $text New text
1599 * @param string $summary Edit summary
1600 * @param int $flags Bitfield:
1601 * EDIT_NEW
1602 * Article is known or assumed to be non-existent, create a new one
1603 * EDIT_UPDATE
1604 * Article is known or assumed to be pre-existing, update it
1605 * EDIT_MINOR
1606 * Mark this edit minor, if the user is allowed to do so
1607 * EDIT_SUPPRESS_RC
1608 * Do not log the change in recentchanges
1609 * EDIT_FORCE_BOT
1610 * Mark the edit a "bot" edit regardless of user rights
1611 * EDIT_DEFER_UPDATES
1612 * Defer some of the updates until the end of index.php
1613 * EDIT_AUTOSUMMARY
1614 * Fill in blank summaries with generated text where possible
1615 *
1616 * If neither EDIT_NEW nor EDIT_UPDATE is specified, the status of the
1617 * article will be detected. If EDIT_UPDATE is specified and the article
1618 * doesn't exist, the function will return an edit-gone-missing error. If
1619 * EDIT_NEW is specified and the article does exist, an edit-already-exists
1620 * error will be returned. These two conditions are also possible with
1621 * auto-detection due to MediaWiki's performance-optimised locking strategy.
1622 *
1623 * @param bool|int $baseRevId The revision ID this edit was based off, if any.
1624 * This is not the parent revision ID, rather the revision ID for older
1625 * content used as the source for a rollback, for example.
1626 * @param User $user The user doing the edit
1627 *
1628 * @throws MWException
1629 * @return Status Possible errors:
1630 * edit-hook-aborted: The ArticleSave hook aborted the edit but didn't
1631 * set the fatal flag of $status
1632 * edit-gone-missing: In update mode, but the article didn't exist.
1633 * edit-conflict: In update mode, the article changed unexpectedly.
1634 * edit-no-change: Warning that the text was the same as before.
1635 * edit-already-exists: In creation mode, but the article already exists.
1636 *
1637 * Extensions may define additional errors.
1638 *
1639 * $return->value will contain an associative array with members as follows:
1640 * new: Boolean indicating if the function attempted to create a new article.
1641 * revision: The revision object for the inserted revision, or null.
1642 *
1643 * Compatibility note: this function previously returned a boolean value
1644 * indicating success/failure
1645 *
1646 * @deprecated since 1.21: use doEditContent() instead.
1647 */
1648 public function doEdit( $text, $summary, $flags = 0, $baseRevId = false, $user = null ) {
1649 ContentHandler::deprecated( __METHOD__, '1.21' );
1650
1651 $content = ContentHandler::makeContent( $text, $this->getTitle() );
1652
1653 return $this->doEditContent( $content, $summary, $flags, $baseRevId, $user );
1654 }
1655
1656 /**
1657 * Change an existing article or create a new article. Updates RC and all necessary caches,
1658 * optionally via the deferred update array.
1659 *
1660 * @param Content $content New content
1661 * @param string $summary Edit summary
1662 * @param int $flags Bitfield:
1663 * EDIT_NEW
1664 * Article is known or assumed to be non-existent, create a new one
1665 * EDIT_UPDATE
1666 * Article is known or assumed to be pre-existing, update it
1667 * EDIT_MINOR
1668 * Mark this edit minor, if the user is allowed to do so
1669 * EDIT_SUPPRESS_RC
1670 * Do not log the change in recentchanges
1671 * EDIT_FORCE_BOT
1672 * Mark the edit a "bot" edit regardless of user rights
1673 * EDIT_DEFER_UPDATES
1674 * Defer some of the updates until the end of index.php
1675 * EDIT_AUTOSUMMARY
1676 * Fill in blank summaries with generated text where possible
1677 *
1678 * If neither EDIT_NEW nor EDIT_UPDATE is specified, the status of the
1679 * article will be detected. If EDIT_UPDATE is specified and the article
1680 * doesn't exist, the function will return an edit-gone-missing error. If
1681 * EDIT_NEW is specified and the article does exist, an edit-already-exists
1682 * error will be returned. These two conditions are also possible with
1683 * auto-detection due to MediaWiki's performance-optimised locking strategy.
1684 *
1685 * @param bool|int $baseRevId The revision ID this edit was based off, if any.
1686 * This is not the parent revision ID, rather the revision ID for older
1687 * content used as the source for a rollback, for example.
1688 * @param User $user The user doing the edit
1689 * @param string $serialFormat Format for storing the content in the
1690 * database.
1691 *
1692 * @throws MWException
1693 * @return Status Possible errors:
1694 * edit-hook-aborted: The ArticleSave hook aborted the edit but didn't
1695 * set the fatal flag of $status.
1696 * edit-gone-missing: In update mode, but the article didn't exist.
1697 * edit-conflict: In update mode, the article changed unexpectedly.
1698 * edit-no-change: Warning that the text was the same as before.
1699 * edit-already-exists: In creation mode, but the article already exists.
1700 *
1701 * Extensions may define additional errors.
1702 *
1703 * $return->value will contain an associative array with members as follows:
1704 * new: Boolean indicating if the function attempted to create a new article.
1705 * revision: The revision object for the inserted revision, or null.
1706 *
1707 * @since 1.21
1708 */
1709 public function doEditContent( Content $content, $summary, $flags = 0, $baseRevId = false,
1710 User $user = null, $serialFormat = null
1711 ) {
1712 global $wgUser, $wgUseAutomaticEditSummaries, $wgUseRCPatrol, $wgUseNPPatrol;
1713
1714 // Low-level sanity check
1715 if ( $this->mTitle->getText() === '' ) {
1716 throw new MWException( 'Something is trying to edit an article with an empty title' );
1717 }
1718
1719 if ( !$content->getContentHandler()->canBeUsedOn( $this->getTitle() ) ) {
1720 return Status::newFatal( 'content-not-allowed-here',
1721 ContentHandler::getLocalizedName( $content->getModel() ),
1722 $this->getTitle()->getPrefixedText() );
1723 }
1724
1725 $user = is_null( $user ) ? $wgUser : $user;
1726 $status = Status::newGood( array() );
1727
1728 // Load the data from the master database if needed.
1729 // The caller may already loaded it from the master or even loaded it using
1730 // SELECT FOR UPDATE, so do not override that using clear().
1731 $this->loadPageData( 'fromdbmaster' );
1732
1733 $flags = $this->checkFlags( $flags );
1734
1735 // handle hook
1736 $hook_args = array( &$this, &$user, &$content, &$summary,
1737 $flags & EDIT_MINOR, null, null, &$flags, &$status );
1738
1739 if ( !Hooks::run( 'PageContentSave', $hook_args )
1740 || !ContentHandler::runLegacyHooks( 'ArticleSave', $hook_args ) ) {
1741
1742 wfDebug( __METHOD__ . ": ArticleSave or ArticleSaveContent hook aborted save!\n" );
1743
1744 if ( $status->isOK() ) {
1745 $status->fatal( 'edit-hook-aborted' );
1746 }
1747
1748 return $status;
1749 }
1750
1751 // Silently ignore EDIT_MINOR if not allowed
1752 $isminor = ( $flags & EDIT_MINOR ) && $user->isAllowed( 'minoredit' );
1753 $bot = $flags & EDIT_FORCE_BOT;
1754
1755 $old_content = $this->getContent( Revision::RAW ); // current revision's content
1756
1757 $oldsize = $old_content ? $old_content->getSize() : 0;
1758 $oldid = $this->getLatest();
1759 $oldIsRedirect = $this->isRedirect();
1760 $oldcountable = $this->isCountable();
1761
1762 $handler = $content->getContentHandler();
1763
1764 // Provide autosummaries if one is not provided and autosummaries are enabled.
1765 if ( $wgUseAutomaticEditSummaries && $flags & EDIT_AUTOSUMMARY && $summary == '' ) {
1766 if ( !$old_content ) {
1767 $old_content = null;
1768 }
1769 $summary = $handler->getAutosummary( $old_content, $content, $flags );
1770 }
1771
1772 $editInfo = $this->prepareContentForEdit( $content, null, $user, $serialFormat );
1773 $serialized = $editInfo->pst;
1774
1775 /**
1776 * @var Content $content
1777 */
1778 $content = $editInfo->pstContent;
1779 $newsize = $content->getSize();
1780
1781 $dbw = wfGetDB( DB_MASTER );
1782 $now = wfTimestampNow();
1783 $this->mTimestamp = $now;
1784
1785 if ( $flags & EDIT_UPDATE ) {
1786 // Update article, but only if changed.
1787 $status->value['new'] = false;
1788
1789 if ( !$oldid ) {
1790 // Article gone missing
1791 wfDebug( __METHOD__ . ": EDIT_UPDATE specified but article doesn't exist\n" );
1792 $status->fatal( 'edit-gone-missing' );
1793
1794 return $status;
1795 } elseif ( !$old_content ) {
1796 // Sanity check for bug 37225
1797 throw new MWException( "Could not find text for current revision {$oldid}." );
1798 }
1799
1800 $revision = new Revision( array(
1801 'page' => $this->getId(),
1802 'title' => $this->getTitle(), // for determining the default content model
1803 'comment' => $summary,
1804 'minor_edit' => $isminor,
1805 'text' => $serialized,
1806 'len' => $newsize,
1807 'parent_id' => $oldid,
1808 'user' => $user->getId(),
1809 'user_text' => $user->getName(),
1810 'timestamp' => $now,
1811 'content_model' => $content->getModel(),
1812 'content_format' => $serialFormat,
1813 ) ); // XXX: pass content object?!
1814
1815 $changed = !$content->equals( $old_content );
1816
1817 if ( $changed ) {
1818 $dbw->begin( __METHOD__ );
1819 try {
1820
1821 $prepStatus = $content->prepareSave( $this, $flags, $oldid, $user );
1822 $status->merge( $prepStatus );
1823
1824 if ( !$status->isOK() ) {
1825 $dbw->rollback( __METHOD__ );
1826
1827 return $status;
1828 }
1829 $revisionId = $revision->insertOn( $dbw );
1830
1831 // Update page
1832 //
1833 // We check for conflicts by comparing $oldid with the current latest revision ID.
1834 $ok = $this->updateRevisionOn( $dbw, $revision, $oldid, $oldIsRedirect );
1835
1836 if ( !$ok ) {
1837 // Belated edit conflict! Run away!!
1838 $status->fatal( 'edit-conflict' );
1839
1840 $dbw->rollback( __METHOD__ );
1841
1842 return $status;
1843 }
1844
1845 Hooks::run( 'NewRevisionFromEditComplete', array( $this, $revision, $baseRevId, $user ) );
1846 // Update recentchanges
1847 if ( !( $flags & EDIT_SUPPRESS_RC ) ) {
1848 // Mark as patrolled if the user can do so
1849 $patrolled = $wgUseRCPatrol && !count(
1850 $this->mTitle->getUserPermissionsErrors( 'autopatrol', $user ) );
1851 // Add RC row to the DB
1852 $rc = RecentChange::notifyEdit( $now, $this->mTitle, $isminor, $user, $summary,
1853 $oldid, $this->getTimestamp(), $bot, '', $oldsize, $newsize,
1854 $revisionId, $patrolled
1855 );
1856
1857 // Log auto-patrolled edits
1858 if ( $patrolled ) {
1859 PatrolLog::record( $rc, true, $user );
1860 }
1861 }
1862 $user->incEditCount();
1863 } catch ( Exception $e ) {
1864 $dbw->rollback( __METHOD__ );
1865 // Question: Would it perhaps be better if this method turned all
1866 // exceptions into $status's?
1867 throw $e;
1868 }
1869 $dbw->commit( __METHOD__ );
1870 } else {
1871 // Bug 32948: revision ID must be set to page {{REVISIONID}} and
1872 // related variables correctly
1873 $revision->setId( $this->getLatest() );
1874 }
1875
1876 // Update links tables, site stats, etc.
1877 $this->doEditUpdates(
1878 $revision,
1879 $user,
1880 array(
1881 'changed' => $changed,
1882 'oldcountable' => $oldcountable
1883 )
1884 );
1885
1886 if ( !$changed ) {
1887 $status->warning( 'edit-no-change' );
1888 $revision = null;
1889 // Update page_touched, this is usually implicit in the page update
1890 // Other cache updates are done in onArticleEdit()
1891 $this->mTitle->invalidateCache();
1892 }
1893 } else {
1894 // Create new article
1895 $status->value['new'] = true;
1896
1897 $dbw->begin( __METHOD__ );
1898 try {
1899
1900 $prepStatus = $content->prepareSave( $this, $flags, $oldid, $user );
1901 $status->merge( $prepStatus );
1902
1903 if ( !$status->isOK() ) {
1904 $dbw->rollback( __METHOD__ );
1905
1906 return $status;
1907 }
1908
1909 $status->merge( $prepStatus );
1910
1911 // Add the page record; stake our claim on this title!
1912 // This will return false if the article already exists
1913 $newid = $this->insertOn( $dbw );
1914
1915 if ( $newid === false ) {
1916 $dbw->rollback( __METHOD__ );
1917 $status->fatal( 'edit-already-exists' );
1918
1919 return $status;
1920 }
1921
1922 // Save the revision text...
1923 $revision = new Revision( array(
1924 'page' => $newid,
1925 'title' => $this->getTitle(), // for determining the default content model
1926 'comment' => $summary,
1927 'minor_edit' => $isminor,
1928 'text' => $serialized,
1929 'len' => $newsize,
1930 'user' => $user->getId(),
1931 'user_text' => $user->getName(),
1932 'timestamp' => $now,
1933 'content_model' => $content->getModel(),
1934 'content_format' => $serialFormat,
1935 ) );
1936 $revisionId = $revision->insertOn( $dbw );
1937
1938 // Bug 37225: use accessor to get the text as Revision may trim it
1939 $content = $revision->getContent(); // sanity; get normalized version
1940
1941 if ( $content ) {
1942 $newsize = $content->getSize();
1943 }
1944
1945 // Update the page record with revision data
1946 $this->updateRevisionOn( $dbw, $revision, 0 );
1947
1948 Hooks::run( 'NewRevisionFromEditComplete', array( $this, $revision, false, $user ) );
1949
1950 // Update recentchanges
1951 if ( !( $flags & EDIT_SUPPRESS_RC ) ) {
1952 // Mark as patrolled if the user can do so
1953 $patrolled = ( $wgUseRCPatrol || $wgUseNPPatrol ) && !count(
1954 $this->mTitle->getUserPermissionsErrors( 'autopatrol', $user ) );
1955 // Add RC row to the DB
1956 $rc = RecentChange::notifyNew( $now, $this->mTitle, $isminor, $user, $summary, $bot,
1957 '', $newsize, $revisionId, $patrolled );
1958
1959 // Log auto-patrolled edits
1960 if ( $patrolled ) {
1961 PatrolLog::record( $rc, true, $user );
1962 }
1963 }
1964 $user->incEditCount();
1965
1966 } catch ( Exception $e ) {
1967 $dbw->rollback( __METHOD__ );
1968 throw $e;
1969 }
1970 $dbw->commit( __METHOD__ );
1971
1972 // Update links, etc.
1973 $this->doEditUpdates( $revision, $user, array( 'created' => true ) );
1974
1975 $hook_args = array( &$this, &$user, $content, $summary,
1976 $flags & EDIT_MINOR, null, null, &$flags, $revision );
1977
1978 ContentHandler::runLegacyHooks( 'ArticleInsertComplete', $hook_args );
1979 Hooks::run( 'PageContentInsertComplete', $hook_args );
1980 }
1981
1982 // Do updates right now unless deferral was requested
1983 if ( !( $flags & EDIT_DEFER_UPDATES ) ) {
1984 DeferredUpdates::doUpdates();
1985 }
1986
1987 // Return the new revision (or null) to the caller
1988 $status->value['revision'] = $revision;
1989
1990 $hook_args = array( &$this, &$user, $content, $summary,
1991 $flags & EDIT_MINOR, null, null, &$flags, $revision, &$status, $baseRevId );
1992
1993 ContentHandler::runLegacyHooks( 'ArticleSaveComplete', $hook_args );
1994 Hooks::run( 'PageContentSaveComplete', $hook_args );
1995
1996 // Promote user to any groups they meet the criteria for
1997 $dbw->onTransactionIdle( function () use ( $user ) {
1998 $user->addAutopromoteOnceGroups( 'onEdit' );
1999 $user->addAutopromoteOnceGroups( 'onView' ); // b/c
2000 } );
2001
2002 return $status;
2003 }
2004
2005 /**
2006 * Get parser options suitable for rendering the primary article wikitext
2007 *
2008 * @see ContentHandler::makeParserOptions
2009 *
2010 * @param IContextSource|User|string $context One of the following:
2011 * - IContextSource: Use the User and the Language of the provided
2012 * context
2013 * - User: Use the provided User object and $wgLang for the language,
2014 * so use an IContextSource object if possible.
2015 * - 'canonical': Canonical options (anonymous user with default
2016 * preferences and content language).
2017 * @return ParserOptions
2018 */
2019 public function makeParserOptions( $context ) {
2020 $options = $this->getContentHandler()->makeParserOptions( $context );
2021
2022 if ( $this->getTitle()->isConversionTable() ) {
2023 // @todo ConversionTable should become a separate content model, so
2024 // we don't need special cases like this one.
2025 $options->disableContentConversion();
2026 }
2027
2028 return $options;
2029 }
2030
2031 /**
2032 * Prepare text which is about to be saved.
2033 * Returns a stdClass with source, pst and output members
2034 *
2035 * @deprecated since 1.21: use prepareContentForEdit instead.
2036 * @return object
2037 */
2038 public function prepareTextForEdit( $text, $revid = null, User $user = null ) {
2039 ContentHandler::deprecated( __METHOD__, '1.21' );
2040 $content = ContentHandler::makeContent( $text, $this->getTitle() );
2041 return $this->prepareContentForEdit( $content, $revid, $user );
2042 }
2043
2044 /**
2045 * Prepare content which is about to be saved.
2046 * Returns a stdClass with source, pst and output members
2047 *
2048 * @param Content $content
2049 * @param Revision|int|null $revision Revision object. For backwards compatibility, a
2050 * revision ID is also accepted, but this is deprecated.
2051 * @param User|null $user
2052 * @param string|null $serialFormat
2053 * @param bool $useCache Check shared prepared edit cache
2054 *
2055 * @return object
2056 *
2057 * @since 1.21
2058 */
2059 public function prepareContentForEdit(
2060 Content $content, $revision = null, User $user = null, $serialFormat = null, $useCache = true
2061 ) {
2062 global $wgContLang, $wgUser, $wgAjaxEditStash;
2063
2064 if ( is_object( $revision ) ) {
2065 $revid = $revision->getId();
2066 } else {
2067 $revid = $revision;
2068 // This code path is deprecated, and nothing is known to
2069 // use it, so performance here shouldn't be a worry.
2070 if ( $revid !== null ) {
2071 $revision = Revision::newFromId( $revid, Revision::READ_LATEST );
2072 } else {
2073 $revision = null;
2074 }
2075 }
2076
2077 $user = is_null( $user ) ? $wgUser : $user;
2078 //XXX: check $user->getId() here???
2079
2080 // Use a sane default for $serialFormat, see bug 57026
2081 if ( $serialFormat === null ) {
2082 $serialFormat = $content->getContentHandler()->getDefaultFormat();
2083 }
2084
2085 if ( $this->mPreparedEdit
2086 && $this->mPreparedEdit->newContent
2087 && $this->mPreparedEdit->newContent->equals( $content )
2088 && $this->mPreparedEdit->revid == $revid
2089 && $this->mPreparedEdit->format == $serialFormat
2090 // XXX: also check $user here?
2091 ) {
2092 // Already prepared
2093 return $this->mPreparedEdit;
2094 }
2095
2096 // The edit may have already been prepared via api.php?action=stashedit
2097 $cachedEdit = $useCache && $wgAjaxEditStash
2098 ? ApiStashEdit::checkCache( $this->getTitle(), $content, $user )
2099 : false;
2100
2101 $popts = ParserOptions::newFromUserAndLang( $user, $wgContLang );
2102 Hooks::run( 'ArticlePrepareTextForEdit', array( $this, $popts ) );
2103
2104 $edit = (object)array();
2105 if ( $cachedEdit ) {
2106 $edit->timestamp = $cachedEdit->timestamp;
2107 } else {
2108 $edit->timestamp = wfTimestampNow();
2109 }
2110 // @note: $cachedEdit is not used if the rev ID was referenced in the text
2111 $edit->revid = $revid;
2112
2113 if ( $cachedEdit ) {
2114 $edit->pstContent = $cachedEdit->pstContent;
2115 } else {
2116 $edit->pstContent = $content
2117 ? $content->preSaveTransform( $this->mTitle, $user, $popts )
2118 : null;
2119 }
2120
2121 $edit->format = $serialFormat;
2122 $edit->popts = $this->makeParserOptions( 'canonical' );
2123 if ( $cachedEdit ) {
2124 $edit->output = $cachedEdit->output;
2125 } else {
2126 if ( $revision ) {
2127 // We get here if vary-revision is set. This means that this page references
2128 // itself (such as via self-transclusion). In this case, we need to make sure
2129 // that any such self-references refer to the newly-saved revision, and not
2130 // to the previous one, which could otherwise happen due to slave lag.
2131 $oldCallback = $edit->popts->setCurrentRevisionCallback(
2132 function ( $title, $parser = false ) use ( $revision, &$oldCallback ) {
2133 if ( $title->equals( $revision->getTitle() ) ) {
2134 return $revision;
2135 } else {
2136 return call_user_func(
2137 $oldCallback,
2138 $title,
2139 $parser
2140 );
2141 }
2142 }
2143 );
2144 }
2145 $edit->output = $edit->pstContent
2146 ? $edit->pstContent->getParserOutput( $this->mTitle, $revid, $edit->popts )
2147 : null;
2148 }
2149
2150 $edit->newContent = $content;
2151 $edit->oldContent = $this->getContent( Revision::RAW );
2152
2153 // NOTE: B/C for hooks! don't use these fields!
2154 $edit->newText = $edit->newContent ? ContentHandler::getContentText( $edit->newContent ) : '';
2155 $edit->oldText = $edit->oldContent ? ContentHandler::getContentText( $edit->oldContent ) : '';
2156 $edit->pst = $edit->pstContent ? $edit->pstContent->serialize( $serialFormat ) : '';
2157
2158 $this->mPreparedEdit = $edit;
2159 return $edit;
2160 }
2161
2162 /**
2163 * Do standard deferred updates after page edit.
2164 * Update links tables, site stats, search index and message cache.
2165 * Purges pages that include this page if the text was changed here.
2166 * Every 100th edit, prune the recent changes table.
2167 *
2168 * @param Revision $revision
2169 * @param User $user User object that did the revision
2170 * @param array $options Array of options, following indexes are used:
2171 * - changed: boolean, whether the revision changed the content (default true)
2172 * - created: boolean, whether the revision created the page (default false)
2173 * - moved: boolean, whether the page was moved (default false)
2174 * - oldcountable: boolean, null, or string 'no-change' (default null):
2175 * - boolean: whether the page was counted as an article before that
2176 * revision, only used in changed is true and created is false
2177 * - null: if created is false, don't update the article count; if created
2178 * is true, do update the article count
2179 * - 'no-change': don't update the article count, ever
2180 */
2181 public function doEditUpdates( Revision $revision, User $user, array $options = array() ) {
2182 global $wgEnableParserCache;
2183
2184 $options += array(
2185 'changed' => true,
2186 'created' => false,
2187 'moved' => false,
2188 'oldcountable' => null
2189 );
2190 $content = $revision->getContent();
2191
2192 // Parse the text
2193 // Be careful not to do pre-save transform twice: $text is usually
2194 // already pre-save transformed once.
2195 if ( !$this->mPreparedEdit || $this->mPreparedEdit->output->getFlag( 'vary-revision' ) ) {
2196 wfDebug( __METHOD__ . ": No prepared edit or vary-revision is set...\n" );
2197 $editInfo = $this->prepareContentForEdit( $content, $revision, $user );
2198 } else {
2199 wfDebug( __METHOD__ . ": No vary-revision, using prepared edit...\n" );
2200 $editInfo = $this->mPreparedEdit;
2201 }
2202
2203 // Save it to the parser cache
2204 if ( $wgEnableParserCache ) {
2205 $parserCache = ParserCache::singleton();
2206 $parserCache->save(
2207 $editInfo->output, $this, $editInfo->popts, $editInfo->timestamp, $editInfo->revid
2208 );
2209 }
2210
2211 // Update the links tables and other secondary data
2212 if ( $content ) {
2213 $recursive = $options['changed']; // bug 50785
2214 $updates = $content->getSecondaryDataUpdates(
2215 $this->getTitle(), null, $recursive, $editInfo->output );
2216 DataUpdate::runUpdates( $updates );
2217 }
2218
2219 Hooks::run( 'ArticleEditUpdates', array( &$this, &$editInfo, $options['changed'] ) );
2220
2221 if ( Hooks::run( 'ArticleEditUpdatesDeleteFromRecentchanges', array( &$this ) ) ) {
2222 // Flush old entries from the `recentchanges` table
2223 JobQueueGroup::singleton()->push( RecentChangesUpdateJob::newPurgeJob() );
2224 }
2225
2226 if ( !$this->exists() ) {
2227 return;
2228 }
2229
2230 $id = $this->getId();
2231 $title = $this->mTitle->getPrefixedDBkey();
2232 $shortTitle = $this->mTitle->getDBkey();
2233
2234 if ( $options['oldcountable'] === 'no-change' ||
2235 ( !$options['changed'] && !$options['moved'] )
2236 ) {
2237 $good = 0;
2238 } elseif ( $options['created'] ) {
2239 $good = (int)$this->isCountable( $editInfo );
2240 } elseif ( $options['oldcountable'] !== null ) {
2241 $good = (int)$this->isCountable( $editInfo ) - (int)$options['oldcountable'];
2242 } else {
2243 $good = 0;
2244 }
2245 $edits = $options['changed'] ? 1 : 0;
2246 $total = $options['created'] ? 1 : 0;
2247
2248 DeferredUpdates::addUpdate( new SiteStatsUpdate( 0, $edits, $good, $total ) );
2249 DeferredUpdates::addUpdate( new SearchUpdate( $id, $title, $content ) );
2250
2251 // If this is another user's talk page, update newtalk.
2252 // Don't do this if $options['changed'] = false (null-edits) nor if
2253 // it's a minor edit and the user doesn't want notifications for those.
2254 if ( $options['changed']
2255 && $this->mTitle->getNamespace() == NS_USER_TALK
2256 && $shortTitle != $user->getTitleKey()
2257 && !( $revision->isMinor() && $user->isAllowed( 'nominornewtalk' ) )
2258 ) {
2259 $recipient = User::newFromName( $shortTitle, false );
2260 if ( !$recipient ) {
2261 wfDebug( __METHOD__ . ": invalid username\n" );
2262 } else {
2263 // Allow extensions to prevent user notification when a new message is added to their talk page
2264 if ( Hooks::run( 'ArticleEditUpdateNewTalk', array( &$this, $recipient ) ) ) {
2265 if ( User::isIP( $shortTitle ) ) {
2266 // An anonymous user
2267 $recipient->setNewtalk( true, $revision );
2268 } elseif ( $recipient->isLoggedIn() ) {
2269 $recipient->setNewtalk( true, $revision );
2270 } else {
2271 wfDebug( __METHOD__ . ": don't need to notify a nonexistent user\n" );
2272 }
2273 }
2274 }
2275 }
2276
2277 if ( $this->mTitle->getNamespace() == NS_MEDIAWIKI ) {
2278 // XXX: could skip pseudo-messages like js/css here, based on content model.
2279 $msgtext = $content ? $content->getWikitextForTransclusion() : null;
2280 if ( $msgtext === false || $msgtext === null ) {
2281 $msgtext = '';
2282 }
2283
2284 MessageCache::singleton()->replace( $shortTitle, $msgtext );
2285 }
2286
2287 if ( $options['created'] ) {
2288 self::onArticleCreate( $this->mTitle );
2289 } elseif ( $options['changed'] ) { // bug 50785
2290 self::onArticleEdit( $this->mTitle );
2291 }
2292
2293 }
2294
2295 /**
2296 * Edit an article without doing all that other stuff
2297 * The article must already exist; link tables etc
2298 * are not updated, caches are not flushed.
2299 *
2300 * @param string $text Text submitted
2301 * @param User $user The relevant user
2302 * @param string $comment Comment submitted
2303 * @param bool $minor Whereas it's a minor modification
2304 *
2305 * @deprecated since 1.21, use doEditContent() instead.
2306 */
2307 public function doQuickEdit( $text, User $user, $comment = '', $minor = 0 ) {
2308 ContentHandler::deprecated( __METHOD__, "1.21" );
2309
2310 $content = ContentHandler::makeContent( $text, $this->getTitle() );
2311 $this->doQuickEditContent( $content, $user, $comment, $minor );
2312 }
2313
2314 /**
2315 * Edit an article without doing all that other stuff
2316 * The article must already exist; link tables etc
2317 * are not updated, caches are not flushed.
2318 *
2319 * @param Content $content Content submitted
2320 * @param User $user The relevant user
2321 * @param string $comment Comment submitted
2322 * @param bool $minor Whereas it's a minor modification
2323 * @param string $serialFormat Format for storing the content in the database
2324 */
2325 public function doQuickEditContent( Content $content, User $user, $comment = '', $minor = false,
2326 $serialFormat = null
2327 ) {
2328
2329 $serialized = $content->serialize( $serialFormat );
2330
2331 $dbw = wfGetDB( DB_MASTER );
2332 $revision = new Revision( array(
2333 'title' => $this->getTitle(), // for determining the default content model
2334 'page' => $this->getId(),
2335 'user_text' => $user->getName(),
2336 'user' => $user->getId(),
2337 'text' => $serialized,
2338 'length' => $content->getSize(),
2339 'comment' => $comment,
2340 'minor_edit' => $minor ? 1 : 0,
2341 ) ); // XXX: set the content object?
2342 $revision->insertOn( $dbw );
2343 $this->updateRevisionOn( $dbw, $revision );
2344
2345 Hooks::run( 'NewRevisionFromEditComplete', array( $this, $revision, false, $user ) );
2346
2347 }
2348
2349 /**
2350 * Update the article's restriction field, and leave a log entry.
2351 * This works for protection both existing and non-existing pages.
2352 *
2353 * @param array $limit Set of restriction keys
2354 * @param array $expiry Per restriction type expiration
2355 * @param int &$cascade Set to false if cascading protection isn't allowed.
2356 * @param string $reason
2357 * @param User $user The user updating the restrictions
2358 * @return Status
2359 */
2360 public function doUpdateRestrictions( array $limit, array $expiry,
2361 &$cascade, $reason, User $user
2362 ) {
2363 global $wgCascadingRestrictionLevels, $wgContLang;
2364
2365 if ( wfReadOnly() ) {
2366 return Status::newFatal( 'readonlytext', wfReadOnlyReason() );
2367 }
2368
2369 $this->loadPageData( 'fromdbmaster' );
2370 $restrictionTypes = $this->mTitle->getRestrictionTypes();
2371 $id = $this->getId();
2372
2373 if ( !$cascade ) {
2374 $cascade = false;
2375 }
2376
2377 // Take this opportunity to purge out expired restrictions
2378 Title::purgeExpiredRestrictions();
2379
2380 // @todo FIXME: Same limitations as described in ProtectionForm.php (line 37);
2381 // we expect a single selection, but the schema allows otherwise.
2382 $isProtected = false;
2383 $protect = false;
2384 $changed = false;
2385
2386 $dbw = wfGetDB( DB_MASTER );
2387
2388 foreach ( $restrictionTypes as $action ) {
2389 if ( !isset( $expiry[$action] ) ) {
2390 $expiry[$action] = $dbw->getInfinity();
2391 }
2392 if ( !isset( $limit[$action] ) ) {
2393 $limit[$action] = '';
2394 } elseif ( $limit[$action] != '' ) {
2395 $protect = true;
2396 }
2397
2398 // Get current restrictions on $action
2399 $current = implode( '', $this->mTitle->getRestrictions( $action ) );
2400 if ( $current != '' ) {
2401 $isProtected = true;
2402 }
2403
2404 if ( $limit[$action] != $current ) {
2405 $changed = true;
2406 } elseif ( $limit[$action] != '' ) {
2407 // Only check expiry change if the action is actually being
2408 // protected, since expiry does nothing on an not-protected
2409 // action.
2410 if ( $this->mTitle->getRestrictionExpiry( $action ) != $expiry[$action] ) {
2411 $changed = true;
2412 }
2413 }
2414 }
2415
2416 if ( !$changed && $protect && $this->mTitle->areRestrictionsCascading() != $cascade ) {
2417 $changed = true;
2418 }
2419
2420 // If nothing has changed, do nothing
2421 if ( !$changed ) {
2422 return Status::newGood();
2423 }
2424
2425 if ( !$protect ) { // No protection at all means unprotection
2426 $revCommentMsg = 'unprotectedarticle';
2427 $logAction = 'unprotect';
2428 } elseif ( $isProtected ) {
2429 $revCommentMsg = 'modifiedarticleprotection';
2430 $logAction = 'modify';
2431 } else {
2432 $revCommentMsg = 'protectedarticle';
2433 $logAction = 'protect';
2434 }
2435
2436 // Truncate for whole multibyte characters
2437 $reason = $wgContLang->truncate( $reason, 255 );
2438
2439 $logRelationsValues = array();
2440 $logRelationsField = null;
2441
2442 if ( $id ) { // Protection of existing page
2443 if ( !Hooks::run( 'ArticleProtect', array( &$this, &$user, $limit, $reason ) ) ) {
2444 return Status::newGood();
2445 }
2446
2447 // Only certain restrictions can cascade...
2448 $editrestriction = isset( $limit['edit'] )
2449 ? array( $limit['edit'] )
2450 : $this->mTitle->getRestrictions( 'edit' );
2451 foreach ( array_keys( $editrestriction, 'sysop' ) as $key ) {
2452 $editrestriction[$key] = 'editprotected'; // backwards compatibility
2453 }
2454 foreach ( array_keys( $editrestriction, 'autoconfirmed' ) as $key ) {
2455 $editrestriction[$key] = 'editsemiprotected'; // backwards compatibility
2456 }
2457
2458 $cascadingRestrictionLevels = $wgCascadingRestrictionLevels;
2459 foreach ( array_keys( $cascadingRestrictionLevels, 'sysop' ) as $key ) {
2460 $cascadingRestrictionLevels[$key] = 'editprotected'; // backwards compatibility
2461 }
2462 foreach ( array_keys( $cascadingRestrictionLevels, 'autoconfirmed' ) as $key ) {
2463 $cascadingRestrictionLevels[$key] = 'editsemiprotected'; // backwards compatibility
2464 }
2465
2466 // The schema allows multiple restrictions
2467 if ( !array_intersect( $editrestriction, $cascadingRestrictionLevels ) ) {
2468 $cascade = false;
2469 }
2470
2471 // insert null revision to identify the page protection change as edit summary
2472 $latest = $this->getLatest();
2473 $nullRevision = $this->insertProtectNullRevision(
2474 $revCommentMsg,
2475 $limit,
2476 $expiry,
2477 $cascade,
2478 $reason,
2479 $user
2480 );
2481
2482 if ( $nullRevision === null ) {
2483 return Status::newFatal( 'no-null-revision', $this->mTitle->getPrefixedText() );
2484 }
2485
2486 $logRelationsField = 'pr_id';
2487
2488 // Update restrictions table
2489 foreach ( $limit as $action => $restrictions ) {
2490 $dbw->delete(
2491 'page_restrictions',
2492 array(
2493 'pr_page' => $id,
2494 'pr_type' => $action
2495 ),
2496 __METHOD__
2497 );
2498 if ( $restrictions != '' ) {
2499 $dbw->insert(
2500 'page_restrictions',
2501 array(
2502 'pr_id' => $dbw->nextSequenceValue( 'page_restrictions_pr_id_seq' ),
2503 'pr_page' => $id,
2504 'pr_type' => $action,
2505 'pr_level' => $restrictions,
2506 'pr_cascade' => ( $cascade && $action == 'edit' ) ? 1 : 0,
2507 'pr_expiry' => $dbw->encodeExpiry( $expiry[$action] )
2508 ),
2509 __METHOD__
2510 );
2511 $logRelationsValues[] = $dbw->insertId();
2512 }
2513 }
2514
2515 // Clear out legacy restriction fields
2516 $dbw->update(
2517 'page',
2518 array( 'page_restrictions' => '' ),
2519 array( 'page_id' => $id ),
2520 __METHOD__
2521 );
2522
2523 Hooks::run( 'NewRevisionFromEditComplete', array( $this, $nullRevision, $latest, $user ) );
2524 Hooks::run( 'ArticleProtectComplete', array( &$this, &$user, $limit, $reason ) );
2525 } else { // Protection of non-existing page (also known as "title protection")
2526 // Cascade protection is meaningless in this case
2527 $cascade = false;
2528
2529 if ( $limit['create'] != '' ) {
2530 $dbw->replace( 'protected_titles',
2531 array( array( 'pt_namespace', 'pt_title' ) ),
2532 array(
2533 'pt_namespace' => $this->mTitle->getNamespace(),
2534 'pt_title' => $this->mTitle->getDBkey(),
2535 'pt_create_perm' => $limit['create'],
2536 'pt_timestamp' => $dbw->timestamp(),
2537 'pt_expiry' => $dbw->encodeExpiry( $expiry['create'] ),
2538 'pt_user' => $user->getId(),
2539 'pt_reason' => $reason,
2540 ), __METHOD__
2541 );
2542 } else {
2543 $dbw->delete( 'protected_titles',
2544 array(
2545 'pt_namespace' => $this->mTitle->getNamespace(),
2546 'pt_title' => $this->mTitle->getDBkey()
2547 ), __METHOD__
2548 );
2549 }
2550 }
2551
2552 $this->mTitle->flushRestrictions();
2553 InfoAction::invalidateCache( $this->mTitle );
2554
2555 if ( $logAction == 'unprotect' ) {
2556 $params = array();
2557 } else {
2558 $protectDescriptionLog = $this->protectDescriptionLog( $limit, $expiry );
2559 $params = array( $protectDescriptionLog, $cascade ? 'cascade' : '' );
2560 }
2561
2562 // Update the protection log
2563 $log = new LogPage( 'protect' );
2564 $logId = $log->addEntry( $logAction, $this->mTitle, $reason, $params, $user );
2565 if ( $logRelationsField !== null && count( $logRelationsValues ) ) {
2566 $log->addRelations( $logRelationsField, $logRelationsValues, $logId );
2567 }
2568
2569 return Status::newGood();
2570 }
2571
2572 /**
2573 * Insert a new null revision for this page.
2574 *
2575 * @param string $revCommentMsg Comment message key for the revision
2576 * @param array $limit Set of restriction keys
2577 * @param array $expiry Per restriction type expiration
2578 * @param int $cascade Set to false if cascading protection isn't allowed.
2579 * @param string $reason
2580 * @param User|null $user
2581 * @return Revision|null Null on error
2582 */
2583 public function insertProtectNullRevision( $revCommentMsg, array $limit,
2584 array $expiry, $cascade, $reason, $user = null
2585 ) {
2586 global $wgContLang;
2587 $dbw = wfGetDB( DB_MASTER );
2588
2589 // Prepare a null revision to be added to the history
2590 $editComment = $wgContLang->ucfirst(
2591 wfMessage(
2592 $revCommentMsg,
2593 $this->mTitle->getPrefixedText()
2594 )->inContentLanguage()->text()
2595 );
2596 if ( $reason ) {
2597 $editComment .= wfMessage( 'colon-separator' )->inContentLanguage()->text() . $reason;
2598 }
2599 $protectDescription = $this->protectDescription( $limit, $expiry );
2600 if ( $protectDescription ) {
2601 $editComment .= wfMessage( 'word-separator' )->inContentLanguage()->text();
2602 $editComment .= wfMessage( 'parentheses' )->params( $protectDescription )
2603 ->inContentLanguage()->text();
2604 }
2605 if ( $cascade ) {
2606 $editComment .= wfMessage( 'word-separator' )->inContentLanguage()->text();
2607 $editComment .= wfMessage( 'brackets' )->params(
2608 wfMessage( 'protect-summary-cascade' )->inContentLanguage()->text()
2609 )->inContentLanguage()->text();
2610 }
2611
2612 $nullRev = Revision::newNullRevision( $dbw, $this->getId(), $editComment, true, $user );
2613 if ( $nullRev ) {
2614 $nullRev->insertOn( $dbw );
2615
2616 // Update page record and touch page
2617 $oldLatest = $nullRev->getParentId();
2618 $this->updateRevisionOn( $dbw, $nullRev, $oldLatest );
2619 }
2620
2621 return $nullRev;
2622 }
2623
2624 /**
2625 * @param string $expiry 14-char timestamp or "infinity", or false if the input was invalid
2626 * @return string
2627 */
2628 protected function formatExpiry( $expiry ) {
2629 global $wgContLang;
2630 $dbr = wfGetDB( DB_SLAVE );
2631
2632 $encodedExpiry = $dbr->encodeExpiry( $expiry );
2633 if ( $encodedExpiry != 'infinity' ) {
2634 return wfMessage(
2635 'protect-expiring',
2636 $wgContLang->timeanddate( $expiry, false, false ),
2637 $wgContLang->date( $expiry, false, false ),
2638 $wgContLang->time( $expiry, false, false )
2639 )->inContentLanguage()->text();
2640 } else {
2641 return wfMessage( 'protect-expiry-indefinite' )
2642 ->inContentLanguage()->text();
2643 }
2644 }
2645
2646 /**
2647 * Builds the description to serve as comment for the edit.
2648 *
2649 * @param array $limit Set of restriction keys
2650 * @param array $expiry Per restriction type expiration
2651 * @return string
2652 */
2653 public function protectDescription( array $limit, array $expiry ) {
2654 $protectDescription = '';
2655
2656 foreach ( array_filter( $limit ) as $action => $restrictions ) {
2657 # $action is one of $wgRestrictionTypes = array( 'create', 'edit', 'move', 'upload' ).
2658 # All possible message keys are listed here for easier grepping:
2659 # * restriction-create
2660 # * restriction-edit
2661 # * restriction-move
2662 # * restriction-upload
2663 $actionText = wfMessage( 'restriction-' . $action )->inContentLanguage()->text();
2664 # $restrictions is one of $wgRestrictionLevels = array( '', 'autoconfirmed', 'sysop' ),
2665 # with '' filtered out. All possible message keys are listed below:
2666 # * protect-level-autoconfirmed
2667 # * protect-level-sysop
2668 $restrictionsText = wfMessage( 'protect-level-' . $restrictions )->inContentLanguage()->text();
2669
2670 $expiryText = $this->formatExpiry( $expiry[$action] );
2671
2672 if ( $protectDescription !== '' ) {
2673 $protectDescription .= wfMessage( 'word-separator' )->inContentLanguage()->text();
2674 }
2675 $protectDescription .= wfMessage( 'protect-summary-desc' )
2676 ->params( $actionText, $restrictionsText, $expiryText )
2677 ->inContentLanguage()->text();
2678 }
2679
2680 return $protectDescription;
2681 }
2682
2683 /**
2684 * Builds the description to serve as comment for the log entry.
2685 *
2686 * Some bots may parse IRC lines, which are generated from log entries which contain plain
2687 * protect description text. Keep them in old format to avoid breaking compatibility.
2688 * TODO: Fix protection log to store structured description and format it on-the-fly.
2689 *
2690 * @param array $limit Set of restriction keys
2691 * @param array $expiry Per restriction type expiration
2692 * @return string
2693 */
2694 public function protectDescriptionLog( array $limit, array $expiry ) {
2695 global $wgContLang;
2696
2697 $protectDescriptionLog = '';
2698
2699 foreach ( array_filter( $limit ) as $action => $restrictions ) {
2700 $expiryText = $this->formatExpiry( $expiry[$action] );
2701 $protectDescriptionLog .= $wgContLang->getDirMark() . "[$action=$restrictions] ($expiryText)";
2702 }
2703
2704 return trim( $protectDescriptionLog );
2705 }
2706
2707 /**
2708 * Take an array of page restrictions and flatten it to a string
2709 * suitable for insertion into the page_restrictions field.
2710 *
2711 * @param string[] $limit
2712 *
2713 * @throws MWException
2714 * @return string
2715 */
2716 protected static function flattenRestrictions( $limit ) {
2717 if ( !is_array( $limit ) ) {
2718 throw new MWException( 'WikiPage::flattenRestrictions given non-array restriction set' );
2719 }
2720
2721 $bits = array();
2722 ksort( $limit );
2723
2724 foreach ( array_filter( $limit ) as $action => $restrictions ) {
2725 $bits[] = "$action=$restrictions";
2726 }
2727
2728 return implode( ':', $bits );
2729 }
2730
2731 /**
2732 * Same as doDeleteArticleReal(), but returns a simple boolean. This is kept around for
2733 * backwards compatibility, if you care about error reporting you should use
2734 * doDeleteArticleReal() instead.
2735 *
2736 * Deletes the article with database consistency, writes logs, purges caches
2737 *
2738 * @param string $reason Delete reason for deletion log
2739 * @param bool $suppress Suppress all revisions and log the deletion in
2740 * the suppression log instead of the deletion log
2741 * @param int $id Article ID
2742 * @param bool $commit Defaults to true, triggers transaction end
2743 * @param array &$error Array of errors to append to
2744 * @param User $user The deleting user
2745 * @return bool True if successful
2746 */
2747 public function doDeleteArticle(
2748 $reason, $suppress = false, $id = 0, $commit = true, &$error = '', User $user = null
2749 ) {
2750 $status = $this->doDeleteArticleReal( $reason, $suppress, $id, $commit, $error, $user );
2751 return $status->isGood();
2752 }
2753
2754 /**
2755 * Back-end article deletion
2756 * Deletes the article with database consistency, writes logs, purges caches
2757 *
2758 * @since 1.19
2759 *
2760 * @param string $reason Delete reason for deletion log
2761 * @param bool $suppress Suppress all revisions and log the deletion in
2762 * the suppression log instead of the deletion log
2763 * @param int $id Article ID
2764 * @param bool $commit Defaults to true, triggers transaction end
2765 * @param array &$error Array of errors to append to
2766 * @param User $user The deleting user
2767 * @return Status Status object; if successful, $status->value is the log_id of the
2768 * deletion log entry. If the page couldn't be deleted because it wasn't
2769 * found, $status is a non-fatal 'cannotdelete' error
2770 */
2771 public function doDeleteArticleReal(
2772 $reason, $suppress = false, $id = 0, $commit = true, &$error = '', User $user = null
2773 ) {
2774 global $wgUser, $wgContentHandlerUseDB;
2775
2776 wfDebug( __METHOD__ . "\n" );
2777
2778 $status = Status::newGood();
2779
2780 if ( $this->mTitle->getDBkey() === '' ) {
2781 $status->error( 'cannotdelete', wfEscapeWikiText( $this->getTitle()->getPrefixedText() ) );
2782 return $status;
2783 }
2784
2785 $user = is_null( $user ) ? $wgUser : $user;
2786 if ( !Hooks::run( 'ArticleDelete', array( &$this, &$user, &$reason, &$error, &$status ) ) ) {
2787 if ( $status->isOK() ) {
2788 // Hook aborted but didn't set a fatal status
2789 $status->fatal( 'delete-hook-aborted' );
2790 }
2791 return $status;
2792 }
2793
2794 $dbw = wfGetDB( DB_MASTER );
2795 $dbw->begin( __METHOD__ );
2796
2797 if ( $id == 0 ) {
2798 $this->loadPageData( 'forupdate' );
2799 $id = $this->getID();
2800 if ( $id == 0 ) {
2801 $dbw->rollback( __METHOD__ );
2802 $status->error( 'cannotdelete', wfEscapeWikiText( $this->getTitle()->getPrefixedText() ) );
2803 return $status;
2804 }
2805 }
2806
2807 // we need to remember the old content so we can use it to generate all deletion updates.
2808 $content = $this->getContent( Revision::RAW );
2809
2810 // Bitfields to further suppress the content
2811 if ( $suppress ) {
2812 $bitfield = 0;
2813 // This should be 15...
2814 $bitfield |= Revision::DELETED_TEXT;
2815 $bitfield |= Revision::DELETED_COMMENT;
2816 $bitfield |= Revision::DELETED_USER;
2817 $bitfield |= Revision::DELETED_RESTRICTED;
2818 } else {
2819 $bitfield = 'rev_deleted';
2820 }
2821
2822 // For now, shunt the revision data into the archive table.
2823 // Text is *not* removed from the text table; bulk storage
2824 // is left intact to avoid breaking block-compression or
2825 // immutable storage schemes.
2826 //
2827 // For backwards compatibility, note that some older archive
2828 // table entries will have ar_text and ar_flags fields still.
2829 //
2830 // In the future, we may keep revisions and mark them with
2831 // the rev_deleted field, which is reserved for this purpose.
2832
2833 $row = array(
2834 'ar_namespace' => 'page_namespace',
2835 'ar_title' => 'page_title',
2836 'ar_comment' => 'rev_comment',
2837 'ar_user' => 'rev_user',
2838 'ar_user_text' => 'rev_user_text',
2839 'ar_timestamp' => 'rev_timestamp',
2840 'ar_minor_edit' => 'rev_minor_edit',
2841 'ar_rev_id' => 'rev_id',
2842 'ar_parent_id' => 'rev_parent_id',
2843 'ar_text_id' => 'rev_text_id',
2844 'ar_text' => '\'\'', // Be explicit to appease
2845 'ar_flags' => '\'\'', // MySQL's "strict mode"...
2846 'ar_len' => 'rev_len',
2847 'ar_page_id' => 'page_id',
2848 'ar_deleted' => $bitfield,
2849 'ar_sha1' => 'rev_sha1',
2850 );
2851
2852 if ( $wgContentHandlerUseDB ) {
2853 $row['ar_content_model'] = 'rev_content_model';
2854 $row['ar_content_format'] = 'rev_content_format';
2855 }
2856
2857 $dbw->insertSelect( 'archive', array( 'page', 'revision' ),
2858 $row,
2859 array(
2860 'page_id' => $id,
2861 'page_id = rev_page'
2862 ), __METHOD__
2863 );
2864
2865 // Now that it's safely backed up, delete it
2866 $dbw->delete( 'page', array( 'page_id' => $id ), __METHOD__ );
2867 $ok = ( $dbw->affectedRows() > 0 ); // $id could be laggy
2868
2869 if ( !$ok ) {
2870 $dbw->rollback( __METHOD__ );
2871 $status->error( 'cannotdelete', wfEscapeWikiText( $this->getTitle()->getPrefixedText() ) );
2872 return $status;
2873 }
2874
2875 if ( !$dbw->cascadingDeletes() ) {
2876 $dbw->delete( 'revision', array( 'rev_page' => $id ), __METHOD__ );
2877 }
2878
2879 // Clone the title, so we have the information we need when we log
2880 $logTitle = clone $this->mTitle;
2881
2882 // Log the deletion, if the page was suppressed, log it at Oversight instead
2883 $logtype = $suppress ? 'suppress' : 'delete';
2884
2885 $logEntry = new ManualLogEntry( $logtype, 'delete' );
2886 $logEntry->setPerformer( $user );
2887 $logEntry->setTarget( $logTitle );
2888 $logEntry->setComment( $reason );
2889 $logid = $logEntry->insert();
2890
2891 $dbw->onTransactionPreCommitOrIdle( function () use ( $dbw, $logEntry, $logid ) {
2892 // Bug 56776: avoid deadlocks (especially from FileDeleteForm)
2893 $logEntry->publish( $logid );
2894 } );
2895
2896 if ( $commit ) {
2897 $dbw->commit( __METHOD__ );
2898 }
2899
2900 $this->doDeleteUpdates( $id, $content );
2901
2902 Hooks::run( 'ArticleDeleteComplete', array( &$this, &$user, $reason, $id, $content, $logEntry ) );
2903 $status->value = $logid;
2904 return $status;
2905 }
2906
2907 /**
2908 * Do some database updates after deletion
2909 *
2910 * @param int $id The page_id value of the page being deleted
2911 * @param Content $content Optional page content to be used when determining
2912 * the required updates. This may be needed because $this->getContent()
2913 * may already return null when the page proper was deleted.
2914 */
2915 public function doDeleteUpdates( $id, Content $content = null ) {
2916 // update site status
2917 DeferredUpdates::addUpdate( new SiteStatsUpdate( 0, 1, - (int)$this->isCountable(), -1 ) );
2918
2919 // remove secondary indexes, etc
2920 $updates = $this->getDeletionUpdates( $content );
2921 DataUpdate::runUpdates( $updates );
2922
2923 // Reparse any pages transcluding this page
2924 LinksUpdate::queueRecursiveJobsForTable( $this->mTitle, 'templatelinks' );
2925
2926 // Reparse any pages including this image
2927 if ( $this->mTitle->getNamespace() == NS_FILE ) {
2928 LinksUpdate::queueRecursiveJobsForTable( $this->mTitle, 'imagelinks' );
2929 }
2930
2931 // Clear caches
2932 WikiPage::onArticleDelete( $this->mTitle );
2933
2934 // Reset this object and the Title object
2935 $this->loadFromRow( false, self::READ_LATEST );
2936
2937 // Search engine
2938 DeferredUpdates::addUpdate( new SearchUpdate( $id, $this->mTitle ) );
2939 }
2940
2941 /**
2942 * Roll back the most recent consecutive set of edits to a page
2943 * from the same user; fails if there are no eligible edits to
2944 * roll back to, e.g. user is the sole contributor. This function
2945 * performs permissions checks on $user, then calls commitRollback()
2946 * to do the dirty work
2947 *
2948 * @todo Separate the business/permission stuff out from backend code
2949 *
2950 * @param string $fromP Name of the user whose edits to rollback.
2951 * @param string $summary Custom summary. Set to default summary if empty.
2952 * @param string $token Rollback token.
2953 * @param bool $bot If true, mark all reverted edits as bot.
2954 *
2955 * @param array $resultDetails Array contains result-specific array of additional values
2956 * 'alreadyrolled' : 'current' (rev)
2957 * success : 'summary' (str), 'current' (rev), 'target' (rev)
2958 *
2959 * @param User $user The user performing the rollback
2960 * @return array Array of errors, each error formatted as
2961 * array(messagekey, param1, param2, ...).
2962 * On success, the array is empty. This array can also be passed to
2963 * OutputPage::showPermissionsErrorPage().
2964 */
2965 public function doRollback(
2966 $fromP, $summary, $token, $bot, &$resultDetails, User $user
2967 ) {
2968 $resultDetails = null;
2969
2970 // Check permissions
2971 $editErrors = $this->mTitle->getUserPermissionsErrors( 'edit', $user );
2972 $rollbackErrors = $this->mTitle->getUserPermissionsErrors( 'rollback', $user );
2973 $errors = array_merge( $editErrors, wfArrayDiff2( $rollbackErrors, $editErrors ) );
2974
2975 if ( !$user->matchEditToken( $token, array( $this->mTitle->getPrefixedText(), $fromP ) ) ) {
2976 $errors[] = array( 'sessionfailure' );
2977 }
2978
2979 if ( $user->pingLimiter( 'rollback' ) || $user->pingLimiter() ) {
2980 $errors[] = array( 'actionthrottledtext' );
2981 }
2982
2983 // If there were errors, bail out now
2984 if ( !empty( $errors ) ) {
2985 return $errors;
2986 }
2987
2988 return $this->commitRollback( $fromP, $summary, $bot, $resultDetails, $user );
2989 }
2990
2991 /**
2992 * Backend implementation of doRollback(), please refer there for parameter
2993 * and return value documentation
2994 *
2995 * NOTE: This function does NOT check ANY permissions, it just commits the
2996 * rollback to the DB. Therefore, you should only call this function direct-
2997 * ly if you want to use custom permissions checks. If you don't, use
2998 * doRollback() instead.
2999 * @param string $fromP Name of the user whose edits to rollback.
3000 * @param string $summary Custom summary. Set to default summary if empty.
3001 * @param bool $bot If true, mark all reverted edits as bot.
3002 *
3003 * @param array $resultDetails Contains result-specific array of additional values
3004 * @param User $guser The user performing the rollback
3005 * @return array
3006 */
3007 public function commitRollback( $fromP, $summary, $bot, &$resultDetails, User $guser ) {
3008 global $wgUseRCPatrol, $wgContLang;
3009
3010 $dbw = wfGetDB( DB_MASTER );
3011
3012 if ( wfReadOnly() ) {
3013 return array( array( 'readonlytext' ) );
3014 }
3015
3016 // Get the last editor
3017 $current = $this->getRevision();
3018 if ( is_null( $current ) ) {
3019 // Something wrong... no page?
3020 return array( array( 'notanarticle' ) );
3021 }
3022
3023 $from = str_replace( '_', ' ', $fromP );
3024 // User name given should match up with the top revision.
3025 // If the user was deleted then $from should be empty.
3026 if ( $from != $current->getUserText() ) {
3027 $resultDetails = array( 'current' => $current );
3028 return array( array( 'alreadyrolled',
3029 htmlspecialchars( $this->mTitle->getPrefixedText() ),
3030 htmlspecialchars( $fromP ),
3031 htmlspecialchars( $current->getUserText() )
3032 ) );
3033 }
3034
3035 // Get the last edit not by this guy...
3036 // Note: these may not be public values
3037 $user = intval( $current->getUser( Revision::RAW ) );
3038 $user_text = $dbw->addQuotes( $current->getUserText( Revision::RAW ) );
3039 $s = $dbw->selectRow( 'revision',
3040 array( 'rev_id', 'rev_timestamp', 'rev_deleted' ),
3041 array( 'rev_page' => $current->getPage(),
3042 "rev_user != {$user} OR rev_user_text != {$user_text}"
3043 ), __METHOD__,
3044 array( 'USE INDEX' => 'page_timestamp',
3045 'ORDER BY' => 'rev_timestamp DESC' )
3046 );
3047 if ( $s === false ) {
3048 // No one else ever edited this page
3049 return array( array( 'cantrollback' ) );
3050 } elseif ( $s->rev_deleted & Revision::DELETED_TEXT
3051 || $s->rev_deleted & Revision::DELETED_USER
3052 ) {
3053 // Only admins can see this text
3054 return array( array( 'notvisiblerev' ) );
3055 }
3056
3057 // Set patrolling and bot flag on the edits, which gets rollbacked.
3058 // This is done before the rollback edit to have patrolling also on failure (bug 62157).
3059 $set = array();
3060 if ( $bot && $guser->isAllowed( 'markbotedits' ) ) {
3061 // Mark all reverted edits as bot
3062 $set['rc_bot'] = 1;
3063 }
3064
3065 if ( $wgUseRCPatrol ) {
3066 // Mark all reverted edits as patrolled
3067 $set['rc_patrolled'] = 1;
3068 }
3069
3070 if ( count( $set ) ) {
3071 $dbw->update( 'recentchanges', $set,
3072 array( /* WHERE */
3073 'rc_cur_id' => $current->getPage(),
3074 'rc_user_text' => $current->getUserText(),
3075 'rc_timestamp > ' . $dbw->addQuotes( $s->rev_timestamp ),
3076 ), __METHOD__
3077 );
3078 }
3079
3080 // Generate the edit summary if necessary
3081 $target = Revision::newFromId( $s->rev_id, Revision::READ_LATEST );
3082 if ( empty( $summary ) ) {
3083 if ( $from == '' ) { // no public user name
3084 $summary = wfMessage( 'revertpage-nouser' );
3085 } else {
3086 $summary = wfMessage( 'revertpage' );
3087 }
3088 }
3089
3090 // Allow the custom summary to use the same args as the default message
3091 $args = array(
3092 $target->getUserText(), $from, $s->rev_id,
3093 $wgContLang->timeanddate( wfTimestamp( TS_MW, $s->rev_timestamp ) ),
3094 $current->getId(), $wgContLang->timeanddate( $current->getTimestamp() )
3095 );
3096 if ( $summary instanceof Message ) {
3097 $summary = $summary->params( $args )->inContentLanguage()->text();
3098 } else {
3099 $summary = wfMsgReplaceArgs( $summary, $args );
3100 }
3101
3102 // Trim spaces on user supplied text
3103 $summary = trim( $summary );
3104
3105 // Truncate for whole multibyte characters.
3106 $summary = $wgContLang->truncate( $summary, 255 );
3107
3108 // Save
3109 $flags = EDIT_UPDATE;
3110
3111 if ( $guser->isAllowed( 'minoredit' ) ) {
3112 $flags |= EDIT_MINOR;
3113 }
3114
3115 if ( $bot && ( $guser->isAllowedAny( 'markbotedits', 'bot' ) ) ) {
3116 $flags |= EDIT_FORCE_BOT;
3117 }
3118
3119 // Actually store the edit
3120 $status = $this->doEditContent(
3121 $target->getContent(),
3122 $summary,
3123 $flags,
3124 $target->getId(),
3125 $guser
3126 );
3127
3128 if ( !$status->isOK() ) {
3129 return $status->getErrorsArray();
3130 }
3131
3132 // raise error, when the edit is an edit without a new version
3133 if ( empty( $status->value['revision'] ) ) {
3134 $resultDetails = array( 'current' => $current );
3135 return array( array( 'alreadyrolled',
3136 htmlspecialchars( $this->mTitle->getPrefixedText() ),
3137 htmlspecialchars( $fromP ),
3138 htmlspecialchars( $current->getUserText() )
3139 ) );
3140 }
3141
3142 $revId = $status->value['revision']->getId();
3143
3144 Hooks::run( 'ArticleRollbackComplete', array( $this, $guser, $target, $current ) );
3145
3146 $resultDetails = array(
3147 'summary' => $summary,
3148 'current' => $current,
3149 'target' => $target,
3150 'newid' => $revId
3151 );
3152
3153 return array();
3154 }
3155
3156 /**
3157 * The onArticle*() functions are supposed to be a kind of hooks
3158 * which should be called whenever any of the specified actions
3159 * are done.
3160 *
3161 * This is a good place to put code to clear caches, for instance.
3162 *
3163 * This is called on page move and undelete, as well as edit
3164 *
3165 * @param Title $title
3166 */
3167 public static function onArticleCreate( Title $title ) {
3168 // Update existence markers on article/talk tabs...
3169 $other = $title->getOtherPage();
3170
3171 $other->invalidateCache();
3172 $other->purgeSquid();
3173
3174 $title->touchLinks();
3175 $title->purgeSquid();
3176 $title->deleteTitleProtection();
3177 }
3178
3179 /**
3180 * Clears caches when article is deleted
3181 *
3182 * @param Title $title
3183 */
3184 public static function onArticleDelete( Title $title ) {
3185 // Update existence markers on article/talk tabs...
3186 $other = $title->getOtherPage();
3187
3188 $other->invalidateCache();
3189 $other->purgeSquid();
3190
3191 $title->touchLinks();
3192 $title->purgeSquid();
3193
3194 // File cache
3195 HTMLFileCache::clearFileCache( $title );
3196 InfoAction::invalidateCache( $title );
3197
3198 // Messages
3199 if ( $title->getNamespace() == NS_MEDIAWIKI ) {
3200 MessageCache::singleton()->replace( $title->getDBkey(), false );
3201 }
3202
3203 // Images
3204 if ( $title->getNamespace() == NS_FILE ) {
3205 $update = new HTMLCacheUpdate( $title, 'imagelinks' );
3206 $update->doUpdate();
3207 }
3208
3209 // User talk pages
3210 if ( $title->getNamespace() == NS_USER_TALK ) {
3211 $user = User::newFromName( $title->getText(), false );
3212 if ( $user ) {
3213 $user->setNewtalk( false );
3214 }
3215 }
3216
3217 // Image redirects
3218 RepoGroup::singleton()->getLocalRepo()->invalidateImageRedirect( $title );
3219 }
3220
3221 /**
3222 * Purge caches on page update etc
3223 *
3224 * @param Title $title
3225 */
3226 public static function onArticleEdit( Title $title ) {
3227 // Invalidate caches of articles which include this page
3228 DeferredUpdates::addHTMLCacheUpdate( $title, 'templatelinks' );
3229
3230 // Invalidate the caches of all pages which redirect here
3231 DeferredUpdates::addHTMLCacheUpdate( $title, 'redirect' );
3232
3233 // Purge squid for this page only
3234 $title->purgeSquid();
3235
3236 // Clear file cache for this page only
3237 HTMLFileCache::clearFileCache( $title );
3238 InfoAction::invalidateCache( $title );
3239 }
3240
3241 /**#@-*/
3242
3243 /**
3244 * Returns a list of categories this page is a member of.
3245 * Results will include hidden categories
3246 *
3247 * @return TitleArray
3248 */
3249 public function getCategories() {
3250 $id = $this->getId();
3251 if ( $id == 0 ) {
3252 return TitleArray::newFromResult( new FakeResultWrapper( array() ) );
3253 }
3254
3255 $dbr = wfGetDB( DB_SLAVE );
3256 $res = $dbr->select( 'categorylinks',
3257 array( 'cl_to AS page_title, ' . NS_CATEGORY . ' AS page_namespace' ),
3258 // Have to do that since DatabaseBase::fieldNamesWithAlias treats numeric indexes
3259 // as not being aliases, and NS_CATEGORY is numeric
3260 array( 'cl_from' => $id ),
3261 __METHOD__ );
3262
3263 return TitleArray::newFromResult( $res );
3264 }
3265
3266 /**
3267 * Returns a list of hidden categories this page is a member of.
3268 * Uses the page_props and categorylinks tables.
3269 *
3270 * @return array Array of Title objects
3271 */
3272 public function getHiddenCategories() {
3273 $result = array();
3274 $id = $this->getId();
3275
3276 if ( $id == 0 ) {
3277 return array();
3278 }
3279
3280 $dbr = wfGetDB( DB_SLAVE );
3281 $res = $dbr->select( array( 'categorylinks', 'page_props', 'page' ),
3282 array( 'cl_to' ),
3283 array( 'cl_from' => $id, 'pp_page=page_id', 'pp_propname' => 'hiddencat',
3284 'page_namespace' => NS_CATEGORY, 'page_title=cl_to' ),
3285 __METHOD__ );
3286
3287 if ( $res !== false ) {
3288 foreach ( $res as $row ) {
3289 $result[] = Title::makeTitle( NS_CATEGORY, $row->cl_to );
3290 }
3291 }
3292
3293 return $result;
3294 }
3295
3296 /**
3297 * Return an applicable autosummary if one exists for the given edit.
3298 * @param string|null $oldtext The previous text of the page.
3299 * @param string|null $newtext The submitted text of the page.
3300 * @param int $flags Bitmask: a bitmask of flags submitted for the edit.
3301 * @return string An appropriate autosummary, or an empty string.
3302 *
3303 * @deprecated since 1.21, use ContentHandler::getAutosummary() instead
3304 */
3305 public static function getAutosummary( $oldtext, $newtext, $flags ) {
3306 // NOTE: stub for backwards-compatibility. assumes the given text is
3307 // wikitext. will break horribly if it isn't.
3308
3309 ContentHandler::deprecated( __METHOD__, '1.21' );
3310
3311 $handler = ContentHandler::getForModelID( CONTENT_MODEL_WIKITEXT );
3312 $oldContent = is_null( $oldtext ) ? null : $handler->unserializeContent( $oldtext );
3313 $newContent = is_null( $newtext ) ? null : $handler->unserializeContent( $newtext );
3314
3315 return $handler->getAutosummary( $oldContent, $newContent, $flags );
3316 }
3317
3318 /**
3319 * Auto-generates a deletion reason
3320 *
3321 * @param bool &$hasHistory Whether the page has a history
3322 * @return string|bool String containing deletion reason or empty string, or boolean false
3323 * if no revision occurred
3324 */
3325 public function getAutoDeleteReason( &$hasHistory ) {
3326 return $this->getContentHandler()->getAutoDeleteReason( $this->getTitle(), $hasHistory );
3327 }
3328
3329 /**
3330 * Update all the appropriate counts in the category table, given that
3331 * we've added the categories $added and deleted the categories $deleted.
3332 *
3333 * @param array $added The names of categories that were added
3334 * @param array $deleted The names of categories that were deleted
3335 */
3336 public function updateCategoryCounts( array $added, array $deleted ) {
3337 $that = $this;
3338 $method = __METHOD__;
3339 $dbw = wfGetDB( DB_MASTER );
3340
3341 // Do this at the end of the commit to reduce lock wait timeouts
3342 $dbw->onTransactionPreCommitOrIdle(
3343 function () use ( $dbw, $that, $method, $added, $deleted ) {
3344 $ns = $that->getTitle()->getNamespace();
3345
3346 $addFields = array( 'cat_pages = cat_pages + 1' );
3347 $removeFields = array( 'cat_pages = cat_pages - 1' );
3348 if ( $ns == NS_CATEGORY ) {
3349 $addFields[] = 'cat_subcats = cat_subcats + 1';
3350 $removeFields[] = 'cat_subcats = cat_subcats - 1';
3351 } elseif ( $ns == NS_FILE ) {
3352 $addFields[] = 'cat_files = cat_files + 1';
3353 $removeFields[] = 'cat_files = cat_files - 1';
3354 }
3355
3356 if ( count( $added ) ) {
3357 $insertRows = array();
3358 foreach ( $added as $cat ) {
3359 $insertRows[] = array(
3360 'cat_title' => $cat,
3361 'cat_pages' => 1,
3362 'cat_subcats' => ( $ns == NS_CATEGORY ) ? 1 : 0,
3363 'cat_files' => ( $ns == NS_FILE ) ? 1 : 0,
3364 );
3365 }
3366 $dbw->upsert(
3367 'category',
3368 $insertRows,
3369 array( 'cat_title' ),
3370 $addFields,
3371 $method
3372 );
3373 }
3374
3375 if ( count( $deleted ) ) {
3376 $dbw->update(
3377 'category',
3378 $removeFields,
3379 array( 'cat_title' => $deleted ),
3380 $method
3381 );
3382 }
3383
3384 foreach ( $added as $catName ) {
3385 $cat = Category::newFromName( $catName );
3386 Hooks::run( 'CategoryAfterPageAdded', array( $cat, $that ) );
3387 }
3388
3389 foreach ( $deleted as $catName ) {
3390 $cat = Category::newFromName( $catName );
3391 Hooks::run( 'CategoryAfterPageRemoved', array( $cat, $that ) );
3392 }
3393 }
3394 );
3395 }
3396
3397 /**
3398 * Opportunistically enqueue link update jobs given fresh parser output if useful
3399 *
3400 * @param ParserOutput $parserOutput Current version page output
3401 * @since 1.25
3402 */
3403 public function triggerOpportunisticLinksUpdate( ParserOutput $parserOutput ) {
3404 if ( wfReadOnly() ) {
3405 return;
3406 }
3407
3408 if ( !Hooks::run( 'OpportunisticLinksUpdate', array( $this, $this->mTitle, $parserOutput ) ) ) {
3409 return;
3410 }
3411
3412 if ( $this->mTitle->areRestrictionsCascading() ) {
3413 // If the page is cascade protecting, the links should really be up-to-date
3414 $params = array( 'prioritize' => true );
3415 } elseif ( $parserOutput->hasDynamicContent() ) {
3416 // Assume the output contains time/random based magic words
3417 $params = array();
3418 } else {
3419 // If the inclusions are deterministic, the edit-triggered link jobs are enough
3420 return;
3421 }
3422
3423 // Check if the last link refresh was before page_touched
3424 if ( $this->getLinksTimestamp() < $this->getTouched() ) {
3425 JobQueueGroup::singleton()->push( EnqueueJob::newFromLocalJobs(
3426 new JobSpecification( 'refreshLinks', $params, array(), $this->mTitle )
3427 ) );
3428 return;
3429 }
3430
3431 return;
3432 }
3433
3434 /**
3435 * Return a list of templates used by this article.
3436 * Uses the templatelinks table
3437 *
3438 * @deprecated since 1.19; use Title::getTemplateLinksFrom()
3439 * @return array Array of Title objects
3440 */
3441 public function getUsedTemplates() {
3442 return $this->mTitle->getTemplateLinksFrom();
3443 }
3444
3445 /**
3446 * This function is called right before saving the wikitext,
3447 * so we can do things like signatures and links-in-context.
3448 *
3449 * @deprecated since 1.19; use Parser::preSaveTransform() instead
3450 * @param string $text Article contents
3451 * @param User $user User doing the edit
3452 * @param ParserOptions $popts Parser options, default options for
3453 * the user loaded if null given
3454 * @return string Article contents with altered wikitext markup (signatures
3455 * converted, {{subst:}}, templates, etc.)
3456 */
3457 public function preSaveTransform( $text, User $user = null, ParserOptions $popts = null ) {
3458 global $wgParser, $wgUser;
3459
3460 wfDeprecated( __METHOD__, '1.19' );
3461
3462 $user = is_null( $user ) ? $wgUser : $user;
3463
3464 if ( $popts === null ) {
3465 $popts = ParserOptions::newFromUser( $user );
3466 }
3467
3468 return $wgParser->preSaveTransform( $text, $this->mTitle, $user, $popts );
3469 }
3470
3471 /**
3472 * Update the article's restriction field, and leave a log entry.
3473 *
3474 * @deprecated since 1.19
3475 * @param array $limit Set of restriction keys
3476 * @param string $reason
3477 * @param int &$cascade Set to false if cascading protection isn't allowed.
3478 * @param array $expiry Per restriction type expiration
3479 * @param User $user The user updating the restrictions
3480 * @return bool True on success
3481 */
3482 public function updateRestrictions(
3483 $limit = array(), $reason = '', &$cascade = 0, $expiry = array(), User $user = null
3484 ) {
3485 global $wgUser;
3486
3487 $user = is_null( $user ) ? $wgUser : $user;
3488
3489 return $this->doUpdateRestrictions( $limit, $expiry, $cascade, $reason, $user )->isOK();
3490 }
3491
3492 /**
3493 * Returns a list of updates to be performed when this page is deleted. The
3494 * updates should remove any information about this page from secondary data
3495 * stores such as links tables.
3496 *
3497 * @param Content|null $content Optional Content object for determining the
3498 * necessary updates.
3499 * @return array An array of DataUpdates objects
3500 */
3501 public function getDeletionUpdates( Content $content = null ) {
3502 if ( !$content ) {
3503 // load content object, which may be used to determine the necessary updates
3504 // XXX: the content may not be needed to determine the updates, then this would be overhead.
3505 $content = $this->getContent( Revision::RAW );
3506 }
3507
3508 if ( !$content ) {
3509 $updates = array();
3510 } else {
3511 $updates = $content->getDeletionUpdates( $this );
3512 }
3513
3514 Hooks::run( 'WikiPageDeletionUpdates', array( $this, $content, &$updates ) );
3515 return $updates;
3516 }
3517 }