Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
Complex classes like WikiPage often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use WikiPage, and based on these observations, apply Extract Interface, too.
1 | <?php |
||
32 | class WikiPage implements Page, IDBAccessObject { |
||
33 | // Constants for $mDataLoadedFrom and related |
||
34 | |||
35 | /** |
||
36 | * @var Title |
||
37 | */ |
||
38 | public $mTitle = null; |
||
39 | |||
40 | /**@{{ |
||
41 | * @protected |
||
42 | */ |
||
43 | public $mDataLoaded = false; // !< Boolean |
||
44 | public $mIsRedirect = false; // !< Boolean |
||
45 | public $mLatest = false; // !< Integer (false means "not loaded") |
||
46 | /**@}}*/ |
||
47 | |||
48 | /** @var stdClass Map of cache fields (text, parser output, ect) for a proposed/new edit */ |
||
49 | public $mPreparedEdit = false; |
||
50 | |||
51 | /** |
||
52 | * @var int |
||
53 | */ |
||
54 | protected $mId = null; |
||
55 | |||
56 | /** |
||
57 | * @var int One of the READ_* constants |
||
58 | */ |
||
59 | protected $mDataLoadedFrom = self::READ_NONE; |
||
60 | |||
61 | /** |
||
62 | * @var Title |
||
63 | */ |
||
64 | protected $mRedirectTarget = null; |
||
65 | |||
66 | /** |
||
67 | * @var Revision |
||
68 | */ |
||
69 | protected $mLastRevision = null; |
||
70 | |||
71 | /** |
||
72 | * @var string Timestamp of the current revision or empty string if not loaded |
||
73 | */ |
||
74 | protected $mTimestamp = ''; |
||
75 | |||
76 | /** |
||
77 | * @var string |
||
78 | */ |
||
79 | protected $mTouched = '19700101000000'; |
||
80 | |||
81 | /** |
||
82 | * @var string |
||
83 | */ |
||
84 | protected $mLinksUpdated = '19700101000000'; |
||
85 | |||
86 | const PURGE_CDN_CACHE = 1; // purge CDN cache for page variant URLs |
||
87 | const PURGE_CLUSTER_PCACHE = 2; // purge parser cache in the local datacenter |
||
88 | const PURGE_GLOBAL_PCACHE = 4; // set page_touched to clear parser cache in all datacenters |
||
89 | const PURGE_ALL = 7; |
||
90 | |||
91 | /** |
||
92 | * Constructor and clear the article |
||
93 | * @param Title $title Reference to a Title object. |
||
94 | */ |
||
95 | public function __construct( Title $title ) { |
||
98 | |||
99 | /** |
||
100 | * Makes sure that the mTitle object is cloned |
||
101 | * to the newly cloned WikiPage. |
||
102 | */ |
||
103 | public function __clone() { |
||
106 | |||
107 | /** |
||
108 | * Create a WikiPage object of the appropriate class for the given title. |
||
109 | * |
||
110 | * @param Title $title |
||
111 | * |
||
112 | * @throws MWException |
||
113 | * @return WikiPage|WikiCategoryPage|WikiFilePage |
||
114 | */ |
||
115 | public static function factory( Title $title ) { |
||
142 | |||
143 | /** |
||
144 | * Constructor from a page id |
||
145 | * |
||
146 | * @param int $id Article ID to load |
||
147 | * @param string|int $from One of the following values: |
||
148 | * - "fromdb" or WikiPage::READ_NORMAL to select from a replica DB |
||
149 | * - "fromdbmaster" or WikiPage::READ_LATEST to select from the master database |
||
150 | * |
||
151 | * @return WikiPage|null |
||
152 | */ |
||
153 | public static function newFromID( $id, $from = 'fromdb' ) { |
||
168 | |||
169 | /** |
||
170 | * Constructor from a database row |
||
171 | * |
||
172 | * @since 1.20 |
||
173 | * @param object $row Database row containing at least fields returned by selectFields(). |
||
174 | * @param string|int $from Source of $data: |
||
175 | * - "fromdb" or WikiPage::READ_NORMAL: from a replica DB |
||
176 | * - "fromdbmaster" or WikiPage::READ_LATEST: from the master DB |
||
177 | * - "forupdate" or WikiPage::READ_LOCKING: from the master DB using SELECT FOR UPDATE |
||
178 | * @return WikiPage |
||
179 | */ |
||
180 | public static function newFromRow( $row, $from = 'fromdb' ) { |
||
185 | |||
186 | /** |
||
187 | * Convert 'fromdb', 'fromdbmaster' and 'forupdate' to READ_* constants. |
||
188 | * |
||
189 | * @param object|string|int $type |
||
190 | * @return mixed |
||
191 | */ |
||
192 | private static function convertSelectType( $type ) { |
||
205 | |||
206 | /** |
||
207 | * @todo Move this UI stuff somewhere else |
||
208 | * |
||
209 | * @see ContentHandler::getActionOverrides |
||
210 | */ |
||
211 | public function getActionOverrides() { |
||
214 | |||
215 | /** |
||
216 | * Returns the ContentHandler instance to be used to deal with the content of this WikiPage. |
||
217 | * |
||
218 | * Shorthand for ContentHandler::getForModelID( $this->getContentModel() ); |
||
219 | * |
||
220 | * @return ContentHandler |
||
221 | * |
||
222 | * @since 1.21 |
||
223 | */ |
||
224 | public function getContentHandler() { |
||
227 | |||
228 | /** |
||
229 | * Get the title object of the article |
||
230 | * @return Title Title object of this page |
||
231 | */ |
||
232 | public function getTitle() { |
||
235 | |||
236 | /** |
||
237 | * Clear the object |
||
238 | * @return void |
||
239 | */ |
||
240 | public function clear() { |
||
246 | |||
247 | /** |
||
248 | * Clear the object cache fields |
||
249 | * @return void |
||
250 | */ |
||
251 | protected function clearCacheFields() { |
||
265 | |||
266 | /** |
||
267 | * Clear the mPreparedEdit cache field, as may be needed by mutable content types |
||
268 | * @return void |
||
269 | * @since 1.23 |
||
270 | */ |
||
271 | public function clearPreparedEdit() { |
||
274 | |||
275 | /** |
||
276 | * Return the list of revision fields that should be selected to create |
||
277 | * a new page. |
||
278 | * |
||
279 | * @return array |
||
280 | */ |
||
281 | public static function selectFields() { |
||
308 | |||
309 | /** |
||
310 | * Fetch a page record with the given conditions |
||
311 | * @param IDatabase $dbr |
||
312 | * @param array $conditions |
||
313 | * @param array $options |
||
314 | * @return object|bool Database result resource, or false on failure |
||
315 | */ |
||
316 | protected function pageData( $dbr, $conditions, $options = [] ) { |
||
327 | |||
328 | /** |
||
329 | * Fetch a page record matching the Title object's namespace and title |
||
330 | * using a sanitized title string |
||
331 | * |
||
332 | * @param IDatabase $dbr |
||
333 | * @param Title $title |
||
334 | * @param array $options |
||
335 | * @return object|bool Database result resource, or false on failure |
||
336 | */ |
||
337 | public function pageDataFromTitle( $dbr, $title, $options = [] ) { |
||
342 | |||
343 | /** |
||
344 | * Fetch a page record matching the requested ID |
||
345 | * |
||
346 | * @param IDatabase $dbr |
||
347 | * @param int $id |
||
348 | * @param array $options |
||
349 | * @return object|bool Database result resource, or false on failure |
||
350 | */ |
||
351 | public function pageDataFromId( $dbr, $id, $options = [] ) { |
||
354 | |||
355 | /** |
||
356 | * Load the object from a given source by title |
||
357 | * |
||
358 | * @param object|string|int $from One of the following: |
||
359 | * - A DB query result object. |
||
360 | * - "fromdb" or WikiPage::READ_NORMAL to get from a replica DB. |
||
361 | * - "fromdbmaster" or WikiPage::READ_LATEST to get from the master DB. |
||
362 | * - "forupdate" or WikiPage::READ_LOCKING to get from the master DB |
||
363 | * using SELECT FOR UPDATE. |
||
364 | * |
||
365 | * @return void |
||
366 | */ |
||
367 | public function loadPageData( $from = 'fromdb' ) { |
||
395 | |||
396 | /** |
||
397 | * Load the object from a database row |
||
398 | * |
||
399 | * @since 1.20 |
||
400 | * @param object|bool $data DB row containing fields returned by selectFields() or false |
||
401 | * @param string|int $from One of the following: |
||
402 | * - "fromdb" or WikiPage::READ_NORMAL if the data comes from a replica DB |
||
403 | * - "fromdbmaster" or WikiPage::READ_LATEST if the data comes from the master DB |
||
404 | * - "forupdate" or WikiPage::READ_LOCKING if the data comes from |
||
405 | * the master DB using SELECT FOR UPDATE |
||
406 | */ |
||
407 | public function loadFromRow( $data, $from ) { |
||
443 | |||
444 | /** |
||
445 | * @return int Page ID |
||
446 | */ |
||
447 | public function getId() { |
||
453 | |||
454 | /** |
||
455 | * @return bool Whether or not the page exists in the database |
||
456 | */ |
||
457 | public function exists() { |
||
463 | |||
464 | /** |
||
465 | * Check if this page is something we're going to be showing |
||
466 | * some sort of sensible content for. If we return false, page |
||
467 | * views (plain action=view) will return an HTTP 404 response, |
||
468 | * so spiders and robots can know they're following a bad link. |
||
469 | * |
||
470 | * @return bool |
||
471 | */ |
||
472 | public function hasViewableContent() { |
||
475 | |||
476 | /** |
||
477 | * Tests if the article content represents a redirect |
||
478 | * |
||
479 | * @return bool |
||
480 | */ |
||
481 | public function isRedirect() { |
||
488 | |||
489 | /** |
||
490 | * Returns the page's content model id (see the CONTENT_MODEL_XXX constants). |
||
491 | * |
||
492 | * Will use the revisions actual content model if the page exists, |
||
493 | * and the page's default if the page doesn't exist yet. |
||
494 | * |
||
495 | * @return string |
||
496 | * |
||
497 | * @since 1.21 |
||
498 | */ |
||
499 | public function getContentModel() { |
||
523 | |||
524 | /** |
||
525 | * Loads page_touched and returns a value indicating if it should be used |
||
526 | * @return bool True if this page exists and is not a redirect |
||
527 | */ |
||
528 | public function checkTouched() { |
||
534 | |||
535 | /** |
||
536 | * Get the page_touched field |
||
537 | * @return string Containing GMT timestamp |
||
538 | */ |
||
539 | public function getTouched() { |
||
545 | |||
546 | /** |
||
547 | * Get the page_links_updated field |
||
548 | * @return string|null Containing GMT timestamp |
||
549 | */ |
||
550 | public function getLinksTimestamp() { |
||
556 | |||
557 | /** |
||
558 | * Get the page_latest field |
||
559 | * @return int The rev_id of current revision |
||
560 | */ |
||
561 | public function getLatest() { |
||
567 | |||
568 | /** |
||
569 | * Get the Revision object of the oldest revision |
||
570 | * @return Revision|null |
||
571 | */ |
||
572 | public function getOldestRevision() { |
||
605 | |||
606 | /** |
||
607 | * Loads everything except the text |
||
608 | * This isn't necessary for all uses, so it's only done if needed. |
||
609 | */ |
||
610 | protected function loadLastEdit() { |
||
645 | |||
646 | /** |
||
647 | * Set the latest revision |
||
648 | * @param Revision $revision |
||
649 | */ |
||
650 | protected function setLastEdit( Revision $revision ) { |
||
654 | |||
655 | /** |
||
656 | * Get the latest revision |
||
657 | * @return Revision|null |
||
658 | */ |
||
659 | public function getRevision() { |
||
666 | |||
667 | /** |
||
668 | * Get the content of the current revision. No side-effects... |
||
669 | * |
||
670 | * @param int $audience One of: |
||
671 | * Revision::FOR_PUBLIC to be displayed to all users |
||
672 | * Revision::FOR_THIS_USER to be displayed to $wgUser |
||
673 | * Revision::RAW get the text regardless of permissions |
||
674 | * @param User $user User object to check for, only if FOR_THIS_USER is passed |
||
675 | * to the $audience parameter |
||
676 | * @return Content|null The content of the current revision |
||
677 | * |
||
678 | * @since 1.21 |
||
679 | */ |
||
680 | View Code Duplication | public function getContent( $audience = Revision::FOR_PUBLIC, User $user = null ) { |
|
687 | |||
688 | /** |
||
689 | * Get the text of the current revision. No side-effects... |
||
690 | * |
||
691 | * @param int $audience One of: |
||
692 | * Revision::FOR_PUBLIC to be displayed to all users |
||
693 | * Revision::FOR_THIS_USER to be displayed to the given user |
||
694 | * Revision::RAW get the text regardless of permissions |
||
695 | * @param User $user User object to check for, only if FOR_THIS_USER is passed |
||
696 | * to the $audience parameter |
||
697 | * @return string|bool The text of the current revision |
||
698 | * @deprecated since 1.21, getContent() should be used instead. |
||
699 | */ |
||
700 | public function getText( $audience = Revision::FOR_PUBLIC, User $user = null ) { |
||
709 | |||
710 | /** |
||
711 | * @return string MW timestamp of last article revision |
||
712 | */ |
||
713 | public function getTimestamp() { |
||
721 | |||
722 | /** |
||
723 | * Set the page timestamp (use only to avoid DB queries) |
||
724 | * @param string $ts MW timestamp of last article revision |
||
725 | * @return void |
||
726 | */ |
||
727 | public function setTimestamp( $ts ) { |
||
730 | |||
731 | /** |
||
732 | * @param int $audience One of: |
||
733 | * Revision::FOR_PUBLIC to be displayed to all users |
||
734 | * Revision::FOR_THIS_USER to be displayed to the given user |
||
735 | * Revision::RAW get the text regardless of permissions |
||
736 | * @param User $user User object to check for, only if FOR_THIS_USER is passed |
||
737 | * to the $audience parameter |
||
738 | * @return int User ID for the user that made the last article revision |
||
739 | */ |
||
740 | View Code Duplication | public function getUser( $audience = Revision::FOR_PUBLIC, User $user = null ) { |
|
748 | |||
749 | /** |
||
750 | * Get the User object of the user who created the page |
||
751 | * @param int $audience One of: |
||
752 | * Revision::FOR_PUBLIC to be displayed to all users |
||
753 | * Revision::FOR_THIS_USER to be displayed to the given user |
||
754 | * Revision::RAW get the text regardless of permissions |
||
755 | * @param User $user User object to check for, only if FOR_THIS_USER is passed |
||
756 | * to the $audience parameter |
||
757 | * @return User|null |
||
758 | */ |
||
759 | public function getCreator( $audience = Revision::FOR_PUBLIC, User $user = null ) { |
||
768 | |||
769 | /** |
||
770 | * @param int $audience One of: |
||
771 | * Revision::FOR_PUBLIC to be displayed to all users |
||
772 | * Revision::FOR_THIS_USER to be displayed to the given user |
||
773 | * Revision::RAW get the text regardless of permissions |
||
774 | * @param User $user User object to check for, only if FOR_THIS_USER is passed |
||
775 | * to the $audience parameter |
||
776 | * @return string Username of the user that made the last article revision |
||
777 | */ |
||
778 | View Code Duplication | public function getUserText( $audience = Revision::FOR_PUBLIC, User $user = null ) { |
|
786 | |||
787 | /** |
||
788 | * @param int $audience One of: |
||
789 | * Revision::FOR_PUBLIC to be displayed to all users |
||
790 | * Revision::FOR_THIS_USER to be displayed to the given user |
||
791 | * Revision::RAW get the text regardless of permissions |
||
792 | * @param User $user User object to check for, only if FOR_THIS_USER is passed |
||
793 | * to the $audience parameter |
||
794 | * @return string Comment stored for the last article revision |
||
795 | */ |
||
796 | View Code Duplication | public function getComment( $audience = Revision::FOR_PUBLIC, User $user = null ) { |
|
804 | |||
805 | /** |
||
806 | * Returns true if last revision was marked as "minor edit" |
||
807 | * |
||
808 | * @return bool Minor edit indicator for the last article revision. |
||
809 | */ |
||
810 | public function getMinorEdit() { |
||
818 | |||
819 | /** |
||
820 | * Determine whether a page would be suitable for being counted as an |
||
821 | * article in the site_stats table based on the title & its content |
||
822 | * |
||
823 | * @param object|bool $editInfo (false): object returned by prepareTextForEdit(), |
||
824 | * if false, the current database state will be used |
||
825 | * @return bool |
||
826 | */ |
||
827 | public function isCountable( $editInfo = false ) { |
||
863 | |||
864 | /** |
||
865 | * If this page is a redirect, get its target |
||
866 | * |
||
867 | * The target will be fetched from the redirect table if possible. |
||
868 | * If this page doesn't have an entry there, call insertRedirect() |
||
869 | * @return Title|null Title object, or null if this page is not a redirect |
||
870 | */ |
||
871 | public function getRedirectTarget() { |
||
901 | |||
902 | /** |
||
903 | * Insert an entry for this page into the redirect table if the content is a redirect |
||
904 | * |
||
905 | * The database update will be deferred via DeferredUpdates |
||
906 | * |
||
907 | * Don't call this function directly unless you know what you're doing. |
||
908 | * @return Title|null Title object or null if not a redirect |
||
909 | */ |
||
910 | public function insertRedirect() { |
||
930 | |||
931 | /** |
||
932 | * Insert or update the redirect table entry for this page to indicate it redirects to $rt |
||
933 | * @param Title $rt Redirect target |
||
934 | * @param int|null $oldLatest Prior page_latest for check and set |
||
935 | */ |
||
936 | public function insertRedirectEntry( Title $rt, $oldLatest = null ) { |
||
956 | |||
957 | /** |
||
958 | * Get the Title object or URL this page redirects to |
||
959 | * |
||
960 | * @return bool|Title|string False, Title of in-wiki target, or string with URL |
||
961 | */ |
||
962 | public function followRedirect() { |
||
965 | |||
966 | /** |
||
967 | * Get the Title object or URL to use for a redirect. We use Title |
||
968 | * objects for same-wiki, non-special redirects and URLs for everything |
||
969 | * else. |
||
970 | * @param Title $rt Redirect target |
||
971 | * @return bool|Title|string False, Title object of local target, or string with URL |
||
972 | */ |
||
973 | public function getRedirectURL( $rt ) { |
||
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() { |
||
1057 | |||
1058 | /** |
||
1059 | * Should the parser cache be used? |
||
1060 | * |
||
1061 | * @param ParserOptions $parserOptions ParserOptions to check |
||
1062 | * @param int $oldId |
||
1063 | * @return bool |
||
1064 | */ |
||
1065 | public function shouldCheckParserCache( ParserOptions $parserOptions, $oldId ) { |
||
1071 | |||
1072 | /** |
||
1073 | * Get a ParserOutput for the given ParserOptions and revision ID. |
||
1074 | * |
||
1075 | * The parser cache will be used if possible. Cache misses that result |
||
1076 | * in parser runs are debounced with PoolCounter. |
||
1077 | * |
||
1078 | * @since 1.19 |
||
1079 | * @param ParserOptions $parserOptions ParserOptions to use for the parse operation |
||
1080 | * @param null|int $oldid Revision ID to get the text from, passing null or 0 will |
||
1081 | * get the current revision (default value) |
||
1082 | * @param bool $forceParse Force reindexing, regardless of cache settings |
||
1083 | * @return bool|ParserOutput ParserOutput or false if the revision was not found |
||
1084 | */ |
||
1085 | public function getParserOutput( |
||
1112 | |||
1113 | /** |
||
1114 | * Do standard deferred updates after page view (existing or missing page) |
||
1115 | * @param User $user The relevant user |
||
1116 | * @param int $oldid Revision id being viewed; if not given or 0, latest revision is assumed |
||
1117 | */ |
||
1118 | public function doViewUpdates( User $user, $oldid = 0 ) { |
||
1132 | |||
1133 | /** |
||
1134 | * Perform the actions of a page purging |
||
1135 | * @param integer $flags Bitfield of WikiPage::PURGE_* constants |
||
1136 | * @return bool |
||
1137 | */ |
||
1138 | public function doPurge( $flags = self::PURGE_ALL ) { |
||
1189 | |||
1190 | /** |
||
1191 | * Get the last time a user explicitly purged the page via action=purge |
||
1192 | * |
||
1193 | * @return string|bool TS_MW timestamp or false |
||
1194 | * @since 1.28 |
||
1195 | */ |
||
1196 | public function getLastPurgeTimestamp() { |
||
1201 | |||
1202 | /** |
||
1203 | * Insert a new empty page record for this article. |
||
1204 | * This *must* be followed up by creating a revision |
||
1205 | * and running $this->updateRevisionOn( ... ); |
||
1206 | * or else the record will be left in a funky state. |
||
1207 | * Best if all done inside a transaction. |
||
1208 | * |
||
1209 | * @param IDatabase $dbw |
||
1210 | * @param int|null $pageId Custom page ID that will be used for the insert statement |
||
1211 | * |
||
1212 | * @return bool|int The newly created page_id key; false if the row was not |
||
1213 | * inserted, e.g. because the title already existed or because the specified |
||
1214 | * page ID is already in use. |
||
1215 | */ |
||
1216 | public function insertOn( $dbw, $pageId = null ) { |
||
1246 | |||
1247 | /** |
||
1248 | * Update the page record to point to a newly saved revision. |
||
1249 | * |
||
1250 | * @param IDatabase $dbw |
||
1251 | * @param Revision $revision For ID number, and text used to set |
||
1252 | * length and redirect status fields |
||
1253 | * @param int $lastRevision If given, will not overwrite the page field |
||
1254 | * when different from the currently set value. |
||
1255 | * Giving 0 indicates the new page flag should be set on. |
||
1256 | * @param bool $lastRevIsRedirect If given, will optimize adding and |
||
1257 | * removing rows in redirect table. |
||
1258 | * @return bool Success; false if the page row was missing or page_latest changed |
||
1259 | */ |
||
1260 | public function updateRevisionOn( $dbw, $revision, $lastRevision = null, |
||
1319 | |||
1320 | /** |
||
1321 | * Add row to the redirect table if this is a redirect, remove otherwise. |
||
1322 | * |
||
1323 | * @param IDatabase $dbw |
||
1324 | * @param Title $redirectTitle Title object pointing to the redirect target, |
||
1325 | * or NULL if this is not a redirect |
||
1326 | * @param null|bool $lastRevIsRedirect If given, will optimize adding and |
||
1327 | * removing rows in redirect table. |
||
1328 | * @return bool True on success, false on failure |
||
1329 | * @private |
||
1330 | */ |
||
1331 | public function updateRedirectOn( $dbw, $redirectTitle, $lastRevIsRedirect = null ) { |
||
1355 | |||
1356 | /** |
||
1357 | * If the given revision is newer than the currently set page_latest, |
||
1358 | * update the page record. Otherwise, do nothing. |
||
1359 | * |
||
1360 | * @deprecated since 1.24, use updateRevisionOn instead |
||
1361 | * |
||
1362 | * @param IDatabase $dbw |
||
1363 | * @param Revision $revision |
||
1364 | * @return bool |
||
1365 | */ |
||
1366 | public function updateIfNewerOn( $dbw, $revision ) { |
||
1392 | |||
1393 | /** |
||
1394 | * Get the content that needs to be saved in order to undo all revisions |
||
1395 | * between $undo and $undoafter. Revisions must belong to the same page, |
||
1396 | * must exist and must not be deleted |
||
1397 | * @param Revision $undo |
||
1398 | * @param Revision $undoafter Must be an earlier revision than $undo |
||
1399 | * @return Content|bool Content on success, false on failure |
||
1400 | * @since 1.21 |
||
1401 | * Before we had the Content object, this was done in getUndoText |
||
1402 | */ |
||
1403 | public function getUndoContent( Revision $undo, Revision $undoafter = null ) { |
||
1407 | |||
1408 | /** |
||
1409 | * Returns true if this page's content model supports sections. |
||
1410 | * |
||
1411 | * @return bool |
||
1412 | * |
||
1413 | * @todo The skin should check this and not offer section functionality if |
||
1414 | * sections are not supported. |
||
1415 | * @todo The EditPage should check this and not offer section functionality |
||
1416 | * if sections are not supported. |
||
1417 | */ |
||
1418 | public function supportsSections() { |
||
1421 | |||
1422 | /** |
||
1423 | * @param string|number|null|bool $sectionId Section identifier as a number or string |
||
1424 | * (e.g. 0, 1 or 'T-1'), null/false or an empty string for the whole page |
||
1425 | * or 'new' for a new section. |
||
1426 | * @param Content $sectionContent New content of the section. |
||
1427 | * @param string $sectionTitle New section's subject, only if $section is "new". |
||
1428 | * @param string $edittime Revision timestamp or null to use the current revision. |
||
1429 | * |
||
1430 | * @throws MWException |
||
1431 | * @return Content|null New complete article content, or null if error. |
||
1432 | * |
||
1433 | * @since 1.21 |
||
1434 | * @deprecated since 1.24, use replaceSectionAtRev instead |
||
1435 | */ |
||
1436 | public function replaceSectionContent( |
||
1461 | |||
1462 | /** |
||
1463 | * @param string|number|null|bool $sectionId Section identifier as a number or string |
||
1464 | * (e.g. 0, 1 or 'T-1'), null/false or an empty string for the whole page |
||
1465 | * or 'new' for a new section. |
||
1466 | * @param Content $sectionContent New content of the section. |
||
1467 | * @param string $sectionTitle New section's subject, only if $section is "new". |
||
1468 | * @param int|null $baseRevId |
||
1469 | * |
||
1470 | * @throws MWException |
||
1471 | * @return Content|null New complete article content, or null if error. |
||
1472 | * |
||
1473 | * @since 1.24 |
||
1474 | */ |
||
1475 | public function replaceSectionAtRev( $sectionId, Content $sectionContent, |
||
1512 | |||
1513 | /** |
||
1514 | * Check flags and add EDIT_NEW or EDIT_UPDATE to them as needed. |
||
1515 | * @param int $flags |
||
1516 | * @return int Updated $flags |
||
1517 | */ |
||
1518 | public function checkFlags( $flags ) { |
||
1529 | |||
1530 | /** |
||
1531 | * Change an existing article or create a new article. Updates RC and all necessary caches, |
||
1532 | * optionally via the deferred update array. |
||
1533 | * |
||
1534 | * @param string $text New text |
||
1535 | * @param string $summary Edit summary |
||
1536 | * @param int $flags Bitfield: |
||
1537 | * EDIT_NEW |
||
1538 | * Article is known or assumed to be non-existent, create a new one |
||
1539 | * EDIT_UPDATE |
||
1540 | * Article is known or assumed to be pre-existing, update it |
||
1541 | * EDIT_MINOR |
||
1542 | * Mark this edit minor, if the user is allowed to do so |
||
1543 | * EDIT_SUPPRESS_RC |
||
1544 | * Do not log the change in recentchanges |
||
1545 | * EDIT_FORCE_BOT |
||
1546 | * Mark the edit a "bot" edit regardless of user rights |
||
1547 | * EDIT_AUTOSUMMARY |
||
1548 | * Fill in blank summaries with generated text where possible |
||
1549 | * EDIT_INTERNAL |
||
1550 | * Signal that the page retrieve/save cycle happened entirely in this request. |
||
1551 | * |
||
1552 | * If neither EDIT_NEW nor EDIT_UPDATE is specified, the status of the |
||
1553 | * article will be detected. If EDIT_UPDATE is specified and the article |
||
1554 | * doesn't exist, the function will return an edit-gone-missing error. If |
||
1555 | * EDIT_NEW is specified and the article does exist, an edit-already-exists |
||
1556 | * error will be returned. These two conditions are also possible with |
||
1557 | * auto-detection due to MediaWiki's performance-optimised locking strategy. |
||
1558 | * |
||
1559 | * @param bool|int $baseRevId The revision ID this edit was based off, if any. |
||
1560 | * This is not the parent revision ID, rather the revision ID for older |
||
1561 | * content used as the source for a rollback, for example. |
||
1562 | * @param User $user The user doing the edit |
||
1563 | * |
||
1564 | * @throws MWException |
||
1565 | * @return Status Possible errors: |
||
1566 | * edit-hook-aborted: The ArticleSave hook aborted the edit but didn't |
||
1567 | * set the fatal flag of $status |
||
1568 | * edit-gone-missing: In update mode, but the article didn't exist. |
||
1569 | * edit-conflict: In update mode, the article changed unexpectedly. |
||
1570 | * edit-no-change: Warning that the text was the same as before. |
||
1571 | * edit-already-exists: In creation mode, but the article already exists. |
||
1572 | * |
||
1573 | * Extensions may define additional errors. |
||
1574 | * |
||
1575 | * $return->value will contain an associative array with members as follows: |
||
1576 | * new: Boolean indicating if the function attempted to create a new article. |
||
1577 | * revision: The revision object for the inserted revision, or null. |
||
1578 | * |
||
1579 | * Compatibility note: this function previously returned a boolean value |
||
1580 | * indicating success/failure |
||
1581 | * |
||
1582 | * @deprecated since 1.21: use doEditContent() instead. |
||
1583 | */ |
||
1584 | public function doEdit( $text, $summary, $flags = 0, $baseRevId = false, $user = null ) { |
||
1591 | |||
1592 | /** |
||
1593 | * Change an existing article or create a new article. Updates RC and all necessary caches, |
||
1594 | * optionally via the deferred update array. |
||
1595 | * |
||
1596 | * @param Content $content New content |
||
1597 | * @param string $summary Edit summary |
||
1598 | * @param int $flags Bitfield: |
||
1599 | * EDIT_NEW |
||
1600 | * Article is known or assumed to be non-existent, create a new one |
||
1601 | * EDIT_UPDATE |
||
1602 | * Article is known or assumed to be pre-existing, update it |
||
1603 | * EDIT_MINOR |
||
1604 | * Mark this edit minor, if the user is allowed to do so |
||
1605 | * EDIT_SUPPRESS_RC |
||
1606 | * Do not log the change in recentchanges |
||
1607 | * EDIT_FORCE_BOT |
||
1608 | * Mark the edit a "bot" edit regardless of user rights |
||
1609 | * EDIT_AUTOSUMMARY |
||
1610 | * Fill in blank summaries with generated text where possible |
||
1611 | * EDIT_INTERNAL |
||
1612 | * Signal that the page retrieve/save cycle happened entirely in this request. |
||
1613 | * |
||
1614 | * If neither EDIT_NEW nor EDIT_UPDATE is specified, the status of the |
||
1615 | * article will be detected. If EDIT_UPDATE is specified and the article |
||
1616 | * doesn't exist, the function will return an edit-gone-missing error. If |
||
1617 | * EDIT_NEW is specified and the article does exist, an edit-already-exists |
||
1618 | * error will be returned. These two conditions are also possible with |
||
1619 | * auto-detection due to MediaWiki's performance-optimised locking strategy. |
||
1620 | * |
||
1621 | * @param bool|int $baseRevId The revision ID this edit was based off, if any. |
||
1622 | * This is not the parent revision ID, rather the revision ID for older |
||
1623 | * content used as the source for a rollback, for example. |
||
1624 | * @param User $user The user doing the edit |
||
1625 | * @param string $serialFormat Format for storing the content in the |
||
1626 | * database. |
||
1627 | * @param array|null $tags Change tags to apply to this edit |
||
1628 | * Callers are responsible for permission checks |
||
1629 | * (with ChangeTags::canAddTagsAccompanyingChange) |
||
1630 | * |
||
1631 | * @throws MWException |
||
1632 | * @return Status Possible errors: |
||
1633 | * edit-hook-aborted: The ArticleSave hook aborted the edit but didn't |
||
1634 | * set the fatal flag of $status. |
||
1635 | * edit-gone-missing: In update mode, but the article didn't exist. |
||
1636 | * edit-conflict: In update mode, the article changed unexpectedly. |
||
1637 | * edit-no-change: Warning that the text was the same as before. |
||
1638 | * edit-already-exists: In creation mode, but the article already exists. |
||
1639 | * |
||
1640 | * Extensions may define additional errors. |
||
1641 | * |
||
1642 | * $return->value will contain an associative array with members as follows: |
||
1643 | * new: Boolean indicating if the function attempted to create a new article. |
||
1644 | * revision: The revision object for the inserted revision, or null. |
||
1645 | * |
||
1646 | * @since 1.21 |
||
1647 | * @throws MWException |
||
1648 | */ |
||
1649 | public function doEditContent( |
||
1748 | |||
1749 | /** |
||
1750 | * @param Content $content Pre-save transform content |
||
1751 | * @param integer $flags |
||
1752 | * @param User $user |
||
1753 | * @param string $summary |
||
1754 | * @param array $meta |
||
1755 | * @return Status |
||
1756 | * @throws DBUnexpectedError |
||
1757 | * @throws Exception |
||
1758 | * @throws FatalError |
||
1759 | * @throws MWException |
||
1760 | */ |
||
1761 | private function doModify( |
||
1920 | |||
1921 | /** |
||
1922 | * @param Content $content Pre-save transform content |
||
1923 | * @param integer $flags |
||
1924 | * @param User $user |
||
1925 | * @param string $summary |
||
1926 | * @param array $meta |
||
1927 | * @return Status |
||
1928 | * @throws DBUnexpectedError |
||
1929 | * @throws Exception |
||
1930 | * @throws FatalError |
||
1931 | * @throws MWException |
||
1932 | */ |
||
1933 | private function doCreate( |
||
2045 | |||
2046 | /** |
||
2047 | * Get parser options suitable for rendering the primary article wikitext |
||
2048 | * |
||
2049 | * @see ContentHandler::makeParserOptions |
||
2050 | * |
||
2051 | * @param IContextSource|User|string $context One of the following: |
||
2052 | * - IContextSource: Use the User and the Language of the provided |
||
2053 | * context |
||
2054 | * - User: Use the provided User object and $wgLang for the language, |
||
2055 | * so use an IContextSource object if possible. |
||
2056 | * - 'canonical': Canonical options (anonymous user with default |
||
2057 | * preferences and content language). |
||
2058 | * @return ParserOptions |
||
2059 | */ |
||
2060 | public function makeParserOptions( $context ) { |
||
2071 | |||
2072 | /** |
||
2073 | * Prepare text which is about to be saved. |
||
2074 | * Returns a stdClass with source, pst and output members |
||
2075 | * |
||
2076 | * @param string $text |
||
2077 | * @param int|null $revid |
||
2078 | * @param User|null $user |
||
2079 | * @deprecated since 1.21: use prepareContentForEdit instead. |
||
2080 | * @return object |
||
2081 | */ |
||
2082 | public function prepareTextForEdit( $text, $revid = null, User $user = null ) { |
||
2087 | |||
2088 | /** |
||
2089 | * Prepare content which is about to be saved. |
||
2090 | * Returns a stdClass with source, pst and output members |
||
2091 | * |
||
2092 | * @param Content $content |
||
2093 | * @param Revision|int|null $revision Revision object. For backwards compatibility, a |
||
2094 | * revision ID is also accepted, but this is deprecated. |
||
2095 | * @param User|null $user |
||
2096 | * @param string|null $serialFormat |
||
2097 | * @param bool $useCache Check shared prepared edit cache |
||
2098 | * |
||
2099 | * @return object |
||
2100 | * |
||
2101 | * @since 1.21 |
||
2102 | */ |
||
2103 | public function prepareContentForEdit( |
||
2223 | |||
2224 | /** |
||
2225 | * Do standard deferred updates after page edit. |
||
2226 | * Update links tables, site stats, search index and message cache. |
||
2227 | * Purges pages that include this page if the text was changed here. |
||
2228 | * Every 100th edit, prune the recent changes table. |
||
2229 | * |
||
2230 | * @param Revision $revision |
||
2231 | * @param User $user User object that did the revision |
||
2232 | * @param array $options Array of options, following indexes are used: |
||
2233 | * - changed: boolean, whether the revision changed the content (default true) |
||
2234 | * - created: boolean, whether the revision created the page (default false) |
||
2235 | * - moved: boolean, whether the page was moved (default false) |
||
2236 | * - restored: boolean, whether the page was undeleted (default false) |
||
2237 | * - oldrevision: Revision object for the pre-update revision (default null) |
||
2238 | * - oldcountable: boolean, null, or string 'no-change' (default null): |
||
2239 | * - boolean: whether the page was counted as an article before that |
||
2240 | * revision, only used in changed is true and created is false |
||
2241 | * - null: if created is false, don't update the article count; if created |
||
2242 | * is true, do update the article count |
||
2243 | * - 'no-change': don't update the article count, ever |
||
2244 | */ |
||
2245 | public function doEditUpdates( Revision $revision, User $user, array $options = [] ) { |
||
2246 | global $wgRCWatchCategoryMembership, $wgContLang; |
||
2247 | |||
2248 | $options += [ |
||
2249 | 'changed' => true, |
||
2250 | 'created' => false, |
||
2251 | 'moved' => false, |
||
2252 | 'restored' => false, |
||
2253 | 'oldrevision' => null, |
||
2254 | 'oldcountable' => null |
||
2255 | ]; |
||
2256 | $content = $revision->getContent(); |
||
2257 | |||
2258 | $logger = LoggerFactory::getInstance( 'SaveParse' ); |
||
2259 | |||
2260 | // See if the parser output before $revision was inserted is still valid |
||
2261 | $editInfo = false; |
||
2262 | if ( !$this->mPreparedEdit ) { |
||
2263 | $logger->debug( __METHOD__ . ": No prepared edit...\n" ); |
||
2264 | } elseif ( $this->mPreparedEdit->output->getFlag( 'vary-revision' ) ) { |
||
2265 | $logger->info( __METHOD__ . ": Prepared edit has vary-revision...\n" ); |
||
2266 | } elseif ( $this->mPreparedEdit->output->getFlag( 'vary-revision-id' ) |
||
2267 | && $this->mPreparedEdit->output->getSpeculativeRevIdUsed() !== $revision->getId() |
||
2268 | ) { |
||
2269 | $logger->info( __METHOD__ . ": Prepared edit has vary-revision-id with wrong ID...\n" ); |
||
2270 | } elseif ( $this->mPreparedEdit->output->getFlag( 'vary-user' ) && !$options['changed'] ) { |
||
2271 | $logger->info( __METHOD__ . ": Prepared edit has vary-user and is null...\n" ); |
||
2272 | } else { |
||
2273 | wfDebug( __METHOD__ . ": Using prepared edit...\n" ); |
||
2274 | $editInfo = $this->mPreparedEdit; |
||
2275 | } |
||
2276 | |||
2277 | if ( !$editInfo ) { |
||
2278 | // Parse the text again if needed. Be careful not to do pre-save transform twice: |
||
2279 | // $text is usually already pre-save transformed once. Avoid using the edit stash |
||
2280 | // as any prepared content from there or in doEditContent() was already rejected. |
||
2281 | $editInfo = $this->prepareContentForEdit( $content, $revision, $user, null, false ); |
||
2282 | } |
||
2283 | |||
2284 | // Save it to the parser cache. |
||
2285 | // Make sure the cache time matches page_touched to avoid double parsing. |
||
2286 | ParserCache::singleton()->save( |
||
2287 | $editInfo->output, $this, $editInfo->popts, |
||
2288 | $revision->getTimestamp(), $editInfo->revid |
||
2289 | ); |
||
2290 | |||
2291 | // Update the links tables and other secondary data |
||
2292 | if ( $content ) { |
||
2293 | $recursive = $options['changed']; // bug 50785 |
||
2294 | $updates = $content->getSecondaryDataUpdates( |
||
2295 | $this->getTitle(), null, $recursive, $editInfo->output |
||
2296 | ); |
||
2297 | foreach ( $updates as $update ) { |
||
2298 | if ( $update instanceof LinksUpdate ) { |
||
2299 | $update->setRevision( $revision ); |
||
2300 | $update->setTriggeringUser( $user ); |
||
2301 | } |
||
2302 | DeferredUpdates::addUpdate( $update ); |
||
2303 | } |
||
2304 | if ( $wgRCWatchCategoryMembership |
||
2305 | && $this->getContentHandler()->supportsCategories() === true |
||
2306 | && ( $options['changed'] || $options['created'] ) |
||
2307 | && !$options['restored'] |
||
2308 | ) { |
||
2309 | // Note: jobs are pushed after deferred updates, so the job should be able to see |
||
2310 | // the recent change entry (also done via deferred updates) and carry over any |
||
2311 | // bot/deletion/IP flags, ect. |
||
2312 | JobQueueGroup::singleton()->lazyPush( new CategoryMembershipChangeJob( |
||
2313 | $this->getTitle(), |
||
2314 | [ |
||
2315 | 'pageId' => $this->getId(), |
||
2316 | 'revTimestamp' => $revision->getTimestamp() |
||
2317 | ] |
||
2318 | ) ); |
||
2319 | } |
||
2320 | } |
||
2321 | |||
2322 | Hooks::run( 'ArticleEditUpdates', [ &$this, &$editInfo, $options['changed'] ] ); |
||
2323 | |||
2324 | if ( Hooks::run( 'ArticleEditUpdatesDeleteFromRecentchanges', [ &$this ] ) ) { |
||
2325 | // Flush old entries from the `recentchanges` table |
||
2326 | if ( mt_rand( 0, 9 ) == 0 ) { |
||
2327 | JobQueueGroup::singleton()->lazyPush( RecentChangesUpdateJob::newPurgeJob() ); |
||
2328 | } |
||
2329 | } |
||
2330 | |||
2331 | if ( !$this->exists() ) { |
||
2332 | return; |
||
2333 | } |
||
2334 | |||
2335 | $id = $this->getId(); |
||
2336 | $title = $this->mTitle->getPrefixedDBkey(); |
||
2337 | $shortTitle = $this->mTitle->getDBkey(); |
||
2338 | |||
2339 | if ( $options['oldcountable'] === 'no-change' || |
||
2340 | ( !$options['changed'] && !$options['moved'] ) |
||
2341 | ) { |
||
2342 | $good = 0; |
||
2343 | } elseif ( $options['created'] ) { |
||
2344 | $good = (int)$this->isCountable( $editInfo ); |
||
2345 | } elseif ( $options['oldcountable'] !== null ) { |
||
2346 | $good = (int)$this->isCountable( $editInfo ) - (int)$options['oldcountable']; |
||
2347 | } else { |
||
2348 | $good = 0; |
||
2349 | } |
||
2350 | $edits = $options['changed'] ? 1 : 0; |
||
2351 | $total = $options['created'] ? 1 : 0; |
||
2352 | |||
2353 | DeferredUpdates::addUpdate( new SiteStatsUpdate( 0, $edits, $good, $total ) ); |
||
2354 | DeferredUpdates::addUpdate( new SearchUpdate( $id, $title, $content ) ); |
||
2355 | |||
2356 | // If this is another user's talk page, update newtalk. |
||
2357 | // Don't do this if $options['changed'] = false (null-edits) nor if |
||
2358 | // it's a minor edit and the user doesn't want notifications for those. |
||
2359 | if ( $options['changed'] |
||
2360 | && $this->mTitle->getNamespace() == NS_USER_TALK |
||
2361 | && $shortTitle != $user->getTitleKey() |
||
2362 | && !( $revision->isMinor() && $user->isAllowed( 'nominornewtalk' ) ) |
||
2363 | ) { |
||
2364 | $recipient = User::newFromName( $shortTitle, false ); |
||
2365 | if ( !$recipient ) { |
||
2366 | wfDebug( __METHOD__ . ": invalid username\n" ); |
||
2367 | } else { |
||
2368 | // Allow extensions to prevent user notification |
||
2369 | // when a new message is added to their talk page |
||
2370 | if ( Hooks::run( 'ArticleEditUpdateNewTalk', [ &$this, $recipient ] ) ) { |
||
2371 | if ( User::isIP( $shortTitle ) ) { |
||
2372 | // An anonymous user |
||
2373 | $recipient->setNewtalk( true, $revision ); |
||
2374 | } elseif ( $recipient->isLoggedIn() ) { |
||
2375 | $recipient->setNewtalk( true, $revision ); |
||
2376 | } else { |
||
2377 | wfDebug( __METHOD__ . ": don't need to notify a nonexistent user\n" ); |
||
2378 | } |
||
2379 | } |
||
2380 | } |
||
2381 | } |
||
2382 | |||
2383 | if ( $this->mTitle->getNamespace() == NS_MEDIAWIKI ) { |
||
2384 | // XXX: could skip pseudo-messages like js/css here, based on content model. |
||
2385 | $msgtext = $content ? $content->getWikitextForTransclusion() : null; |
||
2386 | if ( $msgtext === false || $msgtext === null ) { |
||
2387 | $msgtext = ''; |
||
2388 | } |
||
2389 | |||
2390 | MessageCache::singleton()->replace( $shortTitle, $msgtext ); |
||
2391 | |||
2392 | if ( $wgContLang->hasVariants() ) { |
||
2393 | $wgContLang->updateConversionTable( $this->mTitle ); |
||
2394 | } |
||
2395 | } |
||
2396 | |||
2397 | if ( $options['created'] ) { |
||
2398 | self::onArticleCreate( $this->mTitle ); |
||
2399 | } elseif ( $options['changed'] ) { // bug 50785 |
||
2400 | self::onArticleEdit( $this->mTitle, $revision ); |
||
2401 | } |
||
2402 | |||
2403 | ResourceLoaderWikiModule::invalidateModuleCache( |
||
2404 | $this->mTitle, $options['oldrevision'], $revision, wfWikiID() |
||
2405 | ); |
||
2406 | } |
||
2407 | |||
2408 | /** |
||
2409 | * Update the article's restriction field, and leave a log entry. |
||
2410 | * This works for protection both existing and non-existing pages. |
||
2411 | * |
||
2412 | * @param array $limit Set of restriction keys |
||
2413 | * @param array $expiry Per restriction type expiration |
||
2414 | * @param int &$cascade Set to false if cascading protection isn't allowed. |
||
2415 | * @param string $reason |
||
2416 | * @param User $user The user updating the restrictions |
||
2417 | * @param string|string[] $tags Change tags to add to the pages and protection log entries |
||
2418 | * ($user should be able to add the specified tags before this is called) |
||
2419 | * @return Status Status object; if action is taken, $status->value is the log_id of the |
||
2420 | * protection log entry. |
||
2421 | */ |
||
2422 | public function doUpdateRestrictions( array $limit, array $expiry, |
||
2423 | &$cascade, $reason, User $user, $tags = null |
||
2424 | ) { |
||
2425 | global $wgCascadingRestrictionLevels, $wgContLang; |
||
2426 | |||
2427 | if ( wfReadOnly() ) { |
||
2428 | return Status::newFatal( 'readonlytext', wfReadOnlyReason() ); |
||
2429 | } |
||
2430 | |||
2431 | $this->loadPageData( 'fromdbmaster' ); |
||
2432 | $restrictionTypes = $this->mTitle->getRestrictionTypes(); |
||
2433 | $id = $this->getId(); |
||
2434 | |||
2435 | if ( !$cascade ) { |
||
2436 | $cascade = false; |
||
2437 | } |
||
2438 | |||
2439 | // Take this opportunity to purge out expired restrictions |
||
2440 | Title::purgeExpiredRestrictions(); |
||
2441 | |||
2442 | // @todo FIXME: Same limitations as described in ProtectionForm.php (line 37); |
||
2443 | // we expect a single selection, but the schema allows otherwise. |
||
2444 | $isProtected = false; |
||
2445 | $protect = false; |
||
2446 | $changed = false; |
||
2447 | |||
2448 | $dbw = wfGetDB( DB_MASTER ); |
||
2449 | |||
2450 | foreach ( $restrictionTypes as $action ) { |
||
2451 | if ( !isset( $expiry[$action] ) || $expiry[$action] === $dbw->getInfinity() ) { |
||
2452 | $expiry[$action] = 'infinity'; |
||
2453 | } |
||
2454 | if ( !isset( $limit[$action] ) ) { |
||
2455 | $limit[$action] = ''; |
||
2456 | } elseif ( $limit[$action] != '' ) { |
||
2457 | $protect = true; |
||
2458 | } |
||
2459 | |||
2460 | // Get current restrictions on $action |
||
2461 | $current = implode( '', $this->mTitle->getRestrictions( $action ) ); |
||
2462 | if ( $current != '' ) { |
||
2463 | $isProtected = true; |
||
2464 | } |
||
2465 | |||
2466 | if ( $limit[$action] != $current ) { |
||
2467 | $changed = true; |
||
2468 | } elseif ( $limit[$action] != '' ) { |
||
2469 | // Only check expiry change if the action is actually being |
||
2470 | // protected, since expiry does nothing on an not-protected |
||
2471 | // action. |
||
2472 | if ( $this->mTitle->getRestrictionExpiry( $action ) != $expiry[$action] ) { |
||
2473 | $changed = true; |
||
2474 | } |
||
2475 | } |
||
2476 | } |
||
2477 | |||
2478 | if ( !$changed && $protect && $this->mTitle->areRestrictionsCascading() != $cascade ) { |
||
2479 | $changed = true; |
||
2480 | } |
||
2481 | |||
2482 | // If nothing has changed, do nothing |
||
2483 | if ( !$changed ) { |
||
2484 | return Status::newGood(); |
||
2485 | } |
||
2486 | |||
2487 | if ( !$protect ) { // No protection at all means unprotection |
||
2488 | $revCommentMsg = 'unprotectedarticle'; |
||
2489 | $logAction = 'unprotect'; |
||
2490 | } elseif ( $isProtected ) { |
||
2491 | $revCommentMsg = 'modifiedarticleprotection'; |
||
2492 | $logAction = 'modify'; |
||
2493 | } else { |
||
2494 | $revCommentMsg = 'protectedarticle'; |
||
2495 | $logAction = 'protect'; |
||
2496 | } |
||
2497 | |||
2498 | // Truncate for whole multibyte characters |
||
2499 | $reason = $wgContLang->truncate( $reason, 255 ); |
||
2500 | |||
2501 | $logRelationsValues = []; |
||
2502 | $logRelationsField = null; |
||
2503 | $logParamsDetails = []; |
||
2504 | |||
2505 | // Null revision (used for change tag insertion) |
||
2506 | $nullRevision = null; |
||
2507 | |||
2508 | if ( $id ) { // Protection of existing page |
||
2509 | if ( !Hooks::run( 'ArticleProtect', [ &$this, &$user, $limit, $reason ] ) ) { |
||
2510 | return Status::newGood(); |
||
2511 | } |
||
2512 | |||
2513 | // Only certain restrictions can cascade... |
||
2514 | $editrestriction = isset( $limit['edit'] ) |
||
2515 | ? [ $limit['edit'] ] |
||
2516 | : $this->mTitle->getRestrictions( 'edit' ); |
||
2517 | foreach ( array_keys( $editrestriction, 'sysop' ) as $key ) { |
||
2518 | $editrestriction[$key] = 'editprotected'; // backwards compatibility |
||
2519 | } |
||
2520 | foreach ( array_keys( $editrestriction, 'autoconfirmed' ) as $key ) { |
||
2521 | $editrestriction[$key] = 'editsemiprotected'; // backwards compatibility |
||
2522 | } |
||
2523 | |||
2524 | $cascadingRestrictionLevels = $wgCascadingRestrictionLevels; |
||
2525 | foreach ( array_keys( $cascadingRestrictionLevels, 'sysop' ) as $key ) { |
||
2526 | $cascadingRestrictionLevels[$key] = 'editprotected'; // backwards compatibility |
||
2527 | } |
||
2528 | foreach ( array_keys( $cascadingRestrictionLevels, 'autoconfirmed' ) as $key ) { |
||
2529 | $cascadingRestrictionLevels[$key] = 'editsemiprotected'; // backwards compatibility |
||
2530 | } |
||
2531 | |||
2532 | // The schema allows multiple restrictions |
||
2533 | if ( !array_intersect( $editrestriction, $cascadingRestrictionLevels ) ) { |
||
2534 | $cascade = false; |
||
2535 | } |
||
2536 | |||
2537 | // insert null revision to identify the page protection change as edit summary |
||
2538 | $latest = $this->getLatest(); |
||
2539 | $nullRevision = $this->insertProtectNullRevision( |
||
2540 | $revCommentMsg, |
||
2541 | $limit, |
||
2542 | $expiry, |
||
2543 | $cascade, |
||
2544 | $reason, |
||
2545 | $user |
||
2546 | ); |
||
2547 | |||
2548 | if ( $nullRevision === null ) { |
||
2549 | return Status::newFatal( 'no-null-revision', $this->mTitle->getPrefixedText() ); |
||
2550 | } |
||
2551 | |||
2552 | $logRelationsField = 'pr_id'; |
||
2553 | |||
2554 | // Update restrictions table |
||
2555 | foreach ( $limit as $action => $restrictions ) { |
||
2556 | $dbw->delete( |
||
2557 | 'page_restrictions', |
||
2558 | [ |
||
2559 | 'pr_page' => $id, |
||
2560 | 'pr_type' => $action |
||
2561 | ], |
||
2562 | __METHOD__ |
||
2563 | ); |
||
2564 | if ( $restrictions != '' ) { |
||
2565 | $cascadeValue = ( $cascade && $action == 'edit' ) ? 1 : 0; |
||
2566 | $dbw->insert( |
||
2567 | 'page_restrictions', |
||
2568 | [ |
||
2569 | 'pr_id' => $dbw->nextSequenceValue( 'page_restrictions_pr_id_seq' ), |
||
2570 | 'pr_page' => $id, |
||
2571 | 'pr_type' => $action, |
||
2572 | 'pr_level' => $restrictions, |
||
2573 | 'pr_cascade' => $cascadeValue, |
||
2574 | 'pr_expiry' => $dbw->encodeExpiry( $expiry[$action] ) |
||
2575 | ], |
||
2576 | __METHOD__ |
||
2577 | ); |
||
2578 | $logRelationsValues[] = $dbw->insertId(); |
||
2579 | $logParamsDetails[] = [ |
||
2580 | 'type' => $action, |
||
2581 | 'level' => $restrictions, |
||
2582 | 'expiry' => $expiry[$action], |
||
2583 | 'cascade' => (bool)$cascadeValue, |
||
2584 | ]; |
||
2585 | } |
||
2586 | } |
||
2587 | |||
2588 | // Clear out legacy restriction fields |
||
2589 | $dbw->update( |
||
2590 | 'page', |
||
2591 | [ 'page_restrictions' => '' ], |
||
2592 | [ 'page_id' => $id ], |
||
2593 | __METHOD__ |
||
2594 | ); |
||
2595 | |||
2596 | Hooks::run( 'NewRevisionFromEditComplete', |
||
2597 | [ $this, $nullRevision, $latest, $user ] ); |
||
2598 | Hooks::run( 'ArticleProtectComplete', [ &$this, &$user, $limit, $reason ] ); |
||
2599 | } else { // Protection of non-existing page (also known as "title protection") |
||
2600 | // Cascade protection is meaningless in this case |
||
2601 | $cascade = false; |
||
2602 | |||
2603 | if ( $limit['create'] != '' ) { |
||
2604 | $dbw->replace( 'protected_titles', |
||
2605 | [ [ 'pt_namespace', 'pt_title' ] ], |
||
2606 | [ |
||
2607 | 'pt_namespace' => $this->mTitle->getNamespace(), |
||
2608 | 'pt_title' => $this->mTitle->getDBkey(), |
||
2609 | 'pt_create_perm' => $limit['create'], |
||
2610 | 'pt_timestamp' => $dbw->timestamp(), |
||
2611 | 'pt_expiry' => $dbw->encodeExpiry( $expiry['create'] ), |
||
2612 | 'pt_user' => $user->getId(), |
||
2613 | 'pt_reason' => $reason, |
||
2614 | ], __METHOD__ |
||
2615 | ); |
||
2616 | $logParamsDetails[] = [ |
||
2617 | 'type' => 'create', |
||
2618 | 'level' => $limit['create'], |
||
2619 | 'expiry' => $expiry['create'], |
||
2620 | ]; |
||
2621 | } else { |
||
2622 | $dbw->delete( 'protected_titles', |
||
2623 | [ |
||
2624 | 'pt_namespace' => $this->mTitle->getNamespace(), |
||
2625 | 'pt_title' => $this->mTitle->getDBkey() |
||
2626 | ], __METHOD__ |
||
2627 | ); |
||
2628 | } |
||
2629 | } |
||
2630 | |||
2631 | $this->mTitle->flushRestrictions(); |
||
2632 | InfoAction::invalidateCache( $this->mTitle ); |
||
2633 | |||
2634 | if ( $logAction == 'unprotect' ) { |
||
2635 | $params = []; |
||
2636 | } else { |
||
2637 | $protectDescriptionLog = $this->protectDescriptionLog( $limit, $expiry ); |
||
2638 | $params = [ |
||
2639 | '4::description' => $protectDescriptionLog, // parameter for IRC |
||
2640 | '5:bool:cascade' => $cascade, |
||
2641 | 'details' => $logParamsDetails, // parameter for localize and api |
||
2642 | ]; |
||
2643 | } |
||
2644 | |||
2645 | // Update the protection log |
||
2646 | $logEntry = new ManualLogEntry( 'protect', $logAction ); |
||
2647 | $logEntry->setTarget( $this->mTitle ); |
||
2648 | $logEntry->setComment( $reason ); |
||
2649 | $logEntry->setPerformer( $user ); |
||
2650 | $logEntry->setParameters( $params ); |
||
2651 | if ( !is_null( $nullRevision ) ) { |
||
2652 | $logEntry->setAssociatedRevId( $nullRevision->getId() ); |
||
2653 | } |
||
2654 | $logEntry->setTags( $tags ); |
||
2655 | if ( $logRelationsField !== null && count( $logRelationsValues ) ) { |
||
2656 | $logEntry->setRelations( [ $logRelationsField => $logRelationsValues ] ); |
||
2657 | } |
||
2658 | $logId = $logEntry->insert(); |
||
2659 | $logEntry->publish( $logId ); |
||
2660 | |||
2661 | return Status::newGood( $logId ); |
||
2662 | } |
||
2663 | |||
2664 | /** |
||
2665 | * Insert a new null revision for this page. |
||
2666 | * |
||
2667 | * @param string $revCommentMsg Comment message key for the revision |
||
2668 | * @param array $limit Set of restriction keys |
||
2669 | * @param array $expiry Per restriction type expiration |
||
2670 | * @param int $cascade Set to false if cascading protection isn't allowed. |
||
2671 | * @param string $reason |
||
2672 | * @param User|null $user |
||
2673 | * @return Revision|null Null on error |
||
2674 | */ |
||
2675 | public function insertProtectNullRevision( $revCommentMsg, array $limit, |
||
2676 | array $expiry, $cascade, $reason, $user = null |
||
2677 | ) { |
||
2678 | global $wgContLang; |
||
2679 | $dbw = wfGetDB( DB_MASTER ); |
||
2680 | |||
2681 | // Prepare a null revision to be added to the history |
||
2682 | $editComment = $wgContLang->ucfirst( |
||
2683 | wfMessage( |
||
2684 | $revCommentMsg, |
||
2685 | $this->mTitle->getPrefixedText() |
||
2686 | )->inContentLanguage()->text() |
||
2687 | ); |
||
2688 | if ( $reason ) { |
||
2689 | $editComment .= wfMessage( 'colon-separator' )->inContentLanguage()->text() . $reason; |
||
2690 | } |
||
2691 | $protectDescription = $this->protectDescription( $limit, $expiry ); |
||
2692 | if ( $protectDescription ) { |
||
2693 | $editComment .= wfMessage( 'word-separator' )->inContentLanguage()->text(); |
||
2694 | $editComment .= wfMessage( 'parentheses' )->params( $protectDescription ) |
||
2695 | ->inContentLanguage()->text(); |
||
2696 | } |
||
2697 | if ( $cascade ) { |
||
2698 | $editComment .= wfMessage( 'word-separator' )->inContentLanguage()->text(); |
||
2699 | $editComment .= wfMessage( 'brackets' )->params( |
||
2700 | wfMessage( 'protect-summary-cascade' )->inContentLanguage()->text() |
||
2701 | )->inContentLanguage()->text(); |
||
2702 | } |
||
2703 | |||
2704 | $nullRev = Revision::newNullRevision( $dbw, $this->getId(), $editComment, true, $user ); |
||
2705 | if ( $nullRev ) { |
||
2706 | $nullRev->insertOn( $dbw ); |
||
2707 | |||
2708 | // Update page record and touch page |
||
2709 | $oldLatest = $nullRev->getParentId(); |
||
2710 | $this->updateRevisionOn( $dbw, $nullRev, $oldLatest ); |
||
2711 | } |
||
2712 | |||
2713 | return $nullRev; |
||
2714 | } |
||
2715 | |||
2716 | /** |
||
2717 | * @param string $expiry 14-char timestamp or "infinity", or false if the input was invalid |
||
2718 | * @return string |
||
2719 | */ |
||
2720 | protected function formatExpiry( $expiry ) { |
||
2721 | global $wgContLang; |
||
2722 | |||
2723 | if ( $expiry != 'infinity' ) { |
||
2724 | return wfMessage( |
||
2725 | 'protect-expiring', |
||
2726 | $wgContLang->timeanddate( $expiry, false, false ), |
||
2727 | $wgContLang->date( $expiry, false, false ), |
||
2728 | $wgContLang->time( $expiry, false, false ) |
||
2729 | )->inContentLanguage()->text(); |
||
2730 | } else { |
||
2731 | return wfMessage( 'protect-expiry-indefinite' ) |
||
2732 | ->inContentLanguage()->text(); |
||
2733 | } |
||
2734 | } |
||
2735 | |||
2736 | /** |
||
2737 | * Builds the description to serve as comment for the edit. |
||
2738 | * |
||
2739 | * @param array $limit Set of restriction keys |
||
2740 | * @param array $expiry Per restriction type expiration |
||
2741 | * @return string |
||
2742 | */ |
||
2743 | public function protectDescription( array $limit, array $expiry ) { |
||
2744 | $protectDescription = ''; |
||
2745 | |||
2746 | foreach ( array_filter( $limit ) as $action => $restrictions ) { |
||
2747 | # $action is one of $wgRestrictionTypes = [ 'create', 'edit', 'move', 'upload' ]. |
||
2748 | # All possible message keys are listed here for easier grepping: |
||
2749 | # * restriction-create |
||
2750 | # * restriction-edit |
||
2751 | # * restriction-move |
||
2752 | # * restriction-upload |
||
2753 | $actionText = wfMessage( 'restriction-' . $action )->inContentLanguage()->text(); |
||
2754 | # $restrictions is one of $wgRestrictionLevels = [ '', 'autoconfirmed', 'sysop' ], |
||
2755 | # with '' filtered out. All possible message keys are listed below: |
||
2756 | # * protect-level-autoconfirmed |
||
2757 | # * protect-level-sysop |
||
2758 | $restrictionsText = wfMessage( 'protect-level-' . $restrictions ) |
||
2759 | ->inContentLanguage()->text(); |
||
2760 | |||
2761 | $expiryText = $this->formatExpiry( $expiry[$action] ); |
||
2762 | |||
2763 | if ( $protectDescription !== '' ) { |
||
2764 | $protectDescription .= wfMessage( 'word-separator' )->inContentLanguage()->text(); |
||
2765 | } |
||
2766 | $protectDescription .= wfMessage( 'protect-summary-desc' ) |
||
2767 | ->params( $actionText, $restrictionsText, $expiryText ) |
||
2768 | ->inContentLanguage()->text(); |
||
2769 | } |
||
2770 | |||
2771 | return $protectDescription; |
||
2772 | } |
||
2773 | |||
2774 | /** |
||
2775 | * Builds the description to serve as comment for the log entry. |
||
2776 | * |
||
2777 | * Some bots may parse IRC lines, which are generated from log entries which contain plain |
||
2778 | * protect description text. Keep them in old format to avoid breaking compatibility. |
||
2779 | * TODO: Fix protection log to store structured description and format it on-the-fly. |
||
2780 | * |
||
2781 | * @param array $limit Set of restriction keys |
||
2782 | * @param array $expiry Per restriction type expiration |
||
2783 | * @return string |
||
2784 | */ |
||
2785 | public function protectDescriptionLog( array $limit, array $expiry ) { |
||
2786 | global $wgContLang; |
||
2787 | |||
2788 | $protectDescriptionLog = ''; |
||
2789 | |||
2790 | foreach ( array_filter( $limit ) as $action => $restrictions ) { |
||
2791 | $expiryText = $this->formatExpiry( $expiry[$action] ); |
||
2792 | $protectDescriptionLog .= $wgContLang->getDirMark() . |
||
2793 | "[$action=$restrictions] ($expiryText)"; |
||
2794 | } |
||
2795 | |||
2796 | return trim( $protectDescriptionLog ); |
||
2797 | } |
||
2798 | |||
2799 | /** |
||
2800 | * Take an array of page restrictions and flatten it to a string |
||
2801 | * suitable for insertion into the page_restrictions field. |
||
2802 | * |
||
2803 | * @param string[] $limit |
||
2804 | * |
||
2805 | * @throws MWException |
||
2806 | * @return string |
||
2807 | */ |
||
2808 | protected static function flattenRestrictions( $limit ) { |
||
2809 | if ( !is_array( $limit ) ) { |
||
2810 | throw new MWException( __METHOD__ . ' given non-array restriction set' ); |
||
2811 | } |
||
2812 | |||
2813 | $bits = []; |
||
2814 | ksort( $limit ); |
||
2815 | |||
2816 | foreach ( array_filter( $limit ) as $action => $restrictions ) { |
||
2817 | $bits[] = "$action=$restrictions"; |
||
2818 | } |
||
2819 | |||
2820 | return implode( ':', $bits ); |
||
2821 | } |
||
2822 | |||
2823 | /** |
||
2824 | * Same as doDeleteArticleReal(), but returns a simple boolean. This is kept around for |
||
2825 | * backwards compatibility, if you care about error reporting you should use |
||
2826 | * doDeleteArticleReal() instead. |
||
2827 | * |
||
2828 | * Deletes the article with database consistency, writes logs, purges caches |
||
2829 | * |
||
2830 | * @param string $reason Delete reason for deletion log |
||
2831 | * @param bool $suppress Suppress all revisions and log the deletion in |
||
2832 | * the suppression log instead of the deletion log |
||
2833 | * @param int $u1 Unused |
||
2834 | * @param bool $u2 Unused |
||
2835 | * @param array|string &$error Array of errors to append to |
||
2836 | * @param User $user The deleting user |
||
2837 | * @return bool True if successful |
||
2838 | */ |
||
2839 | public function doDeleteArticle( |
||
2840 | $reason, $suppress = false, $u1 = null, $u2 = null, &$error = '', User $user = null |
||
2841 | ) { |
||
2842 | $status = $this->doDeleteArticleReal( $reason, $suppress, $u1, $u2, $error, $user ); |
||
2843 | return $status->isGood(); |
||
2844 | } |
||
2845 | |||
2846 | /** |
||
2847 | * Back-end article deletion |
||
2848 | * Deletes the article with database consistency, writes logs, purges caches |
||
2849 | * |
||
2850 | * @since 1.19 |
||
2851 | * |
||
2852 | * @param string $reason Delete reason for deletion log |
||
2853 | * @param bool $suppress Suppress all revisions and log the deletion in |
||
2854 | * the suppression log instead of the deletion log |
||
2855 | * @param int $u1 Unused |
||
2856 | * @param bool $u2 Unused |
||
2857 | * @param array|string &$error Array of errors to append to |
||
2858 | * @param User $user The deleting user |
||
2859 | * @param array $tags Tags to apply to the deletion action |
||
2860 | * @return Status Status object; if successful, $status->value is the log_id of the |
||
2861 | * deletion log entry. If the page couldn't be deleted because it wasn't |
||
2862 | * found, $status is a non-fatal 'cannotdelete' error |
||
2863 | */ |
||
2864 | public function doDeleteArticleReal( |
||
2865 | $reason, $suppress = false, $u1 = null, $u2 = null, &$error = '', User $user = null, |
||
2866 | $tags = [] |
||
2867 | ) { |
||
2868 | global $wgUser, $wgContentHandlerUseDB; |
||
2869 | |||
2870 | wfDebug( __METHOD__ . "\n" ); |
||
2871 | |||
2872 | $status = Status::newGood(); |
||
2873 | |||
2874 | if ( $this->mTitle->getDBkey() === '' ) { |
||
2875 | $status->error( 'cannotdelete', |
||
2876 | wfEscapeWikiText( $this->getTitle()->getPrefixedText() ) ); |
||
2877 | return $status; |
||
2878 | } |
||
2879 | |||
2880 | $user = is_null( $user ) ? $wgUser : $user; |
||
2881 | if ( !Hooks::run( 'ArticleDelete', |
||
2882 | [ &$this, &$user, &$reason, &$error, &$status, $suppress ] |
||
2883 | ) ) { |
||
2884 | if ( $status->isOK() ) { |
||
2885 | // Hook aborted but didn't set a fatal status |
||
2886 | $status->fatal( 'delete-hook-aborted' ); |
||
2887 | } |
||
2888 | return $status; |
||
2889 | } |
||
2890 | |||
2891 | $dbw = wfGetDB( DB_MASTER ); |
||
2892 | $dbw->startAtomic( __METHOD__ ); |
||
2893 | |||
2894 | $this->loadPageData( self::READ_LATEST ); |
||
2895 | $id = $this->getId(); |
||
2896 | // T98706: lock the page from various other updates but avoid using |
||
2897 | // WikiPage::READ_LOCKING as that will carry over the FOR UPDATE to |
||
2898 | // the revisions queries (which also JOIN on user). Only lock the page |
||
2899 | // row and CAS check on page_latest to see if the trx snapshot matches. |
||
2900 | $lockedLatest = $this->lockAndGetLatest(); |
||
2901 | if ( $id == 0 || $this->getLatest() != $lockedLatest ) { |
||
2902 | $dbw->endAtomic( __METHOD__ ); |
||
2903 | // Page not there or trx snapshot is stale |
||
2904 | $status->error( 'cannotdelete', |
||
2905 | wfEscapeWikiText( $this->getTitle()->getPrefixedText() ) ); |
||
2906 | return $status; |
||
2907 | } |
||
2908 | |||
2909 | // Given the lock above, we can be confident in the title and page ID values |
||
2910 | $namespace = $this->getTitle()->getNamespace(); |
||
2911 | $dbKey = $this->getTitle()->getDBkey(); |
||
2912 | |||
2913 | // At this point we are now comitted to returning an OK |
||
2914 | // status unless some DB query error or other exception comes up. |
||
2915 | // This way callers don't have to call rollback() if $status is bad |
||
2916 | // unless they actually try to catch exceptions (which is rare). |
||
2917 | |||
2918 | // we need to remember the old content so we can use it to generate all deletion updates. |
||
2919 | $revision = $this->getRevision(); |
||
2920 | try { |
||
2921 | $content = $this->getContent( Revision::RAW ); |
||
2922 | } catch ( Exception $ex ) { |
||
2923 | wfLogWarning( __METHOD__ . ': failed to load content during deletion! ' |
||
2924 | . $ex->getMessage() ); |
||
2925 | |||
2926 | $content = null; |
||
2927 | } |
||
2928 | |||
2929 | $fields = Revision::selectFields(); |
||
2930 | $bitfield = false; |
||
2931 | |||
2932 | // Bitfields to further suppress the content |
||
2933 | if ( $suppress ) { |
||
2934 | $bitfield = Revision::SUPPRESSED_ALL; |
||
2935 | $fields = array_diff( $fields, [ 'rev_deleted' ] ); |
||
2936 | } |
||
2937 | |||
2938 | // For now, shunt the revision data into the archive table. |
||
2939 | // Text is *not* removed from the text table; bulk storage |
||
2940 | // is left intact to avoid breaking block-compression or |
||
2941 | // immutable storage schemes. |
||
2942 | // In the future, we may keep revisions and mark them with |
||
2943 | // the rev_deleted field, which is reserved for this purpose. |
||
2944 | |||
2945 | // Get all of the page revisions |
||
2946 | $res = $dbw->select( |
||
2947 | 'revision', |
||
2948 | $fields, |
||
2949 | [ 'rev_page' => $id ], |
||
2950 | __METHOD__, |
||
2951 | 'FOR UPDATE' |
||
2952 | ); |
||
2953 | // Build their equivalent archive rows |
||
2954 | $rowsInsert = []; |
||
2955 | foreach ( $res as $row ) { |
||
2956 | $rowInsert = [ |
||
2957 | 'ar_namespace' => $namespace, |
||
2958 | 'ar_title' => $dbKey, |
||
2959 | 'ar_comment' => $row->rev_comment, |
||
2960 | 'ar_user' => $row->rev_user, |
||
2961 | 'ar_user_text' => $row->rev_user_text, |
||
2962 | 'ar_timestamp' => $row->rev_timestamp, |
||
2963 | 'ar_minor_edit' => $row->rev_minor_edit, |
||
2964 | 'ar_rev_id' => $row->rev_id, |
||
2965 | 'ar_parent_id' => $row->rev_parent_id, |
||
2966 | 'ar_text_id' => $row->rev_text_id, |
||
2967 | 'ar_text' => '', |
||
2968 | 'ar_flags' => '', |
||
2969 | 'ar_len' => $row->rev_len, |
||
2970 | 'ar_page_id' => $id, |
||
2971 | 'ar_deleted' => $suppress ? $bitfield : $row->rev_deleted, |
||
2972 | 'ar_sha1' => $row->rev_sha1, |
||
2973 | ]; |
||
2974 | if ( $wgContentHandlerUseDB ) { |
||
2975 | $rowInsert['ar_content_model'] = $row->rev_content_model; |
||
2976 | $rowInsert['ar_content_format'] = $row->rev_content_format; |
||
2977 | } |
||
2978 | $rowsInsert[] = $rowInsert; |
||
2979 | } |
||
2980 | // Copy them into the archive table |
||
2981 | $dbw->insert( 'archive', $rowsInsert, __METHOD__ ); |
||
2982 | // Save this so we can pass it to the ArticleDeleteComplete hook. |
||
2983 | $archivedRevisionCount = $dbw->affectedRows(); |
||
2984 | |||
2985 | // Clone the title and wikiPage, so we have the information we need when |
||
2986 | // we log and run the ArticleDeleteComplete hook. |
||
2987 | $logTitle = clone $this->mTitle; |
||
2988 | $wikiPageBeforeDelete = clone $this; |
||
2989 | |||
2990 | // Now that it's safely backed up, delete it |
||
2991 | $dbw->delete( 'page', [ 'page_id' => $id ], __METHOD__ ); |
||
2992 | $dbw->delete( 'revision', [ 'rev_page' => $id ], __METHOD__ ); |
||
2993 | |||
2994 | // Log the deletion, if the page was suppressed, put it in the suppression log instead |
||
2995 | $logtype = $suppress ? 'suppress' : 'delete'; |
||
2996 | |||
2997 | $logEntry = new ManualLogEntry( $logtype, 'delete' ); |
||
2998 | $logEntry->setPerformer( $user ); |
||
2999 | $logEntry->setTarget( $logTitle ); |
||
3000 | $logEntry->setComment( $reason ); |
||
3001 | $logEntry->setTags( $tags ); |
||
3002 | $logid = $logEntry->insert(); |
||
3003 | |||
3004 | $dbw->onTransactionPreCommitOrIdle( |
||
3005 | function () use ( $dbw, $logEntry, $logid ) { |
||
3006 | // Bug 56776: avoid deadlocks (especially from FileDeleteForm) |
||
3007 | $logEntry->publish( $logid ); |
||
3008 | }, |
||
3009 | __METHOD__ |
||
3010 | ); |
||
3011 | |||
3012 | $dbw->endAtomic( __METHOD__ ); |
||
3013 | |||
3014 | $this->doDeleteUpdates( $id, $content, $revision ); |
||
3015 | |||
3016 | Hooks::run( 'ArticleDeleteComplete', [ |
||
3017 | &$wikiPageBeforeDelete, |
||
3018 | &$user, |
||
3019 | $reason, |
||
3020 | $id, |
||
3021 | $content, |
||
3022 | $logEntry, |
||
3023 | $archivedRevisionCount |
||
3024 | ] ); |
||
3025 | $status->value = $logid; |
||
3026 | |||
3027 | // Show log excerpt on 404 pages rather than just a link |
||
3028 | $cache = ObjectCache::getMainStashInstance(); |
||
3029 | $key = wfMemcKey( 'page-recent-delete', md5( $logTitle->getPrefixedText() ) ); |
||
3030 | $cache->set( $key, 1, $cache::TTL_DAY ); |
||
3031 | |||
3032 | return $status; |
||
3033 | } |
||
3034 | |||
3035 | /** |
||
3036 | * Lock the page row for this title+id and return page_latest (or 0) |
||
3037 | * |
||
3038 | * @return integer Returns 0 if no row was found with this title+id |
||
3039 | * @since 1.27 |
||
3040 | */ |
||
3041 | public function lockAndGetLatest() { |
||
3056 | |||
3057 | /** |
||
3058 | * Do some database updates after deletion |
||
3059 | * |
||
3060 | * @param int $id The page_id value of the page being deleted |
||
3061 | * @param Content|null $content Optional page content to be used when determining |
||
3062 | * the required updates. This may be needed because $this->getContent() |
||
3063 | * may already return null when the page proper was deleted. |
||
3064 | * @param Revision|null $revision The latest page revision |
||
3065 | */ |
||
3066 | public function doDeleteUpdates( $id, Content $content = null, Revision $revision = null ) { |
||
3104 | |||
3105 | /** |
||
3106 | * Roll back the most recent consecutive set of edits to a page |
||
3107 | * from the same user; fails if there are no eligible edits to |
||
3108 | * roll back to, e.g. user is the sole contributor. This function |
||
3109 | * performs permissions checks on $user, then calls commitRollback() |
||
3110 | * to do the dirty work |
||
3111 | * |
||
3112 | * @todo Separate the business/permission stuff out from backend code |
||
3113 | * @todo Remove $token parameter. Already verified by RollbackAction and ApiRollback. |
||
3114 | * |
||
3115 | * @param string $fromP Name of the user whose edits to rollback. |
||
3116 | * @param string $summary Custom summary. Set to default summary if empty. |
||
3117 | * @param string $token Rollback token. |
||
3118 | * @param bool $bot If true, mark all reverted edits as bot. |
||
3119 | * |
||
3120 | * @param array $resultDetails Array contains result-specific array of additional values |
||
3121 | * 'alreadyrolled' : 'current' (rev) |
||
3122 | * success : 'summary' (str), 'current' (rev), 'target' (rev) |
||
3123 | * |
||
3124 | * @param User $user The user performing the rollback |
||
3125 | * @param array|null $tags Change tags to apply to the rollback |
||
3126 | * Callers are responsible for permission checks |
||
3127 | * (with ChangeTags::canAddTagsAccompanyingChange) |
||
3128 | * |
||
3129 | * @return array Array of errors, each error formatted as |
||
3130 | * array(messagekey, param1, param2, ...). |
||
3131 | * On success, the array is empty. This array can also be passed to |
||
3132 | * OutputPage::showPermissionsErrorPage(). |
||
3133 | */ |
||
3134 | public function doRollback( |
||
3159 | |||
3160 | /** |
||
3161 | * Backend implementation of doRollback(), please refer there for parameter |
||
3162 | * and return value documentation |
||
3163 | * |
||
3164 | * NOTE: This function does NOT check ANY permissions, it just commits the |
||
3165 | * rollback to the DB. Therefore, you should only call this function direct- |
||
3166 | * ly if you want to use custom permissions checks. If you don't, use |
||
3167 | * doRollback() instead. |
||
3168 | * @param string $fromP Name of the user whose edits to rollback. |
||
3169 | * @param string $summary Custom summary. Set to default summary if empty. |
||
3170 | * @param bool $bot If true, mark all reverted edits as bot. |
||
3171 | * |
||
3172 | * @param array $resultDetails Contains result-specific array of additional values |
||
3173 | * @param User $guser The user performing the rollback |
||
3174 | * @param array|null $tags Change tags to apply to the rollback |
||
3175 | * Callers are responsible for permission checks |
||
3176 | * (with ChangeTags::canAddTagsAccompanyingChange) |
||
3177 | * |
||
3178 | * @return array |
||
3179 | */ |
||
3180 | public function commitRollback( $fromP, $summary, $bot, |
||
3355 | |||
3356 | /** |
||
3357 | * The onArticle*() functions are supposed to be a kind of hooks |
||
3358 | * which should be called whenever any of the specified actions |
||
3359 | * are done. |
||
3360 | * |
||
3361 | * This is a good place to put code to clear caches, for instance. |
||
3362 | * |
||
3363 | * This is called on page move and undelete, as well as edit |
||
3364 | * |
||
3365 | * @param Title $title |
||
3366 | */ |
||
3367 | public static function onArticleCreate( Title $title ) { |
||
3387 | |||
3388 | /** |
||
3389 | * Clears caches when article is deleted |
||
3390 | * |
||
3391 | * @param Title $title |
||
3392 | */ |
||
3393 | public static function onArticleDelete( Title $title ) { |
||
3435 | |||
3436 | /** |
||
3437 | * Purge caches on page update etc |
||
3438 | * |
||
3439 | * @param Title $title |
||
3440 | * @param Revision|null $revision Revision that was just saved, may be null |
||
3441 | */ |
||
3442 | public static function onArticleEdit( Title $title, Revision $revision = null ) { |
||
3461 | |||
3462 | /**#@-*/ |
||
3463 | |||
3464 | /** |
||
3465 | * Returns a list of categories this page is a member of. |
||
3466 | * Results will include hidden categories |
||
3467 | * |
||
3468 | * @return TitleArray |
||
3469 | */ |
||
3470 | public function getCategories() { |
||
3486 | |||
3487 | /** |
||
3488 | * Returns a list of hidden categories this page is a member of. |
||
3489 | * Uses the page_props and categorylinks tables. |
||
3490 | * |
||
3491 | * @return array Array of Title objects |
||
3492 | */ |
||
3493 | public function getHiddenCategories() { |
||
3516 | |||
3517 | /** |
||
3518 | * Return an applicable autosummary if one exists for the given edit. |
||
3519 | * @param string|null $oldtext The previous text of the page. |
||
3520 | * @param string|null $newtext The submitted text of the page. |
||
3521 | * @param int $flags Bitmask: a bitmask of flags submitted for the edit. |
||
3522 | * @return string An appropriate autosummary, or an empty string. |
||
3523 | * |
||
3524 | * @deprecated since 1.21, use ContentHandler::getAutosummary() instead |
||
3525 | */ |
||
3526 | public static function getAutosummary( $oldtext, $newtext, $flags ) { |
||
3538 | |||
3539 | /** |
||
3540 | * Auto-generates a deletion reason |
||
3541 | * |
||
3542 | * @param bool &$hasHistory Whether the page has a history |
||
3543 | * @return string|bool String containing deletion reason or empty string, or boolean false |
||
3544 | * if no revision occurred |
||
3545 | */ |
||
3546 | public function getAutoDeleteReason( &$hasHistory ) { |
||
3549 | |||
3550 | /** |
||
3551 | * Update all the appropriate counts in the category table, given that |
||
3552 | * we've added the categories $added and deleted the categories $deleted. |
||
3553 | * |
||
3554 | * @param array $added The names of categories that were added |
||
3555 | * @param array $deleted The names of categories that were deleted |
||
3556 | * @param integer $id Page ID (this should be the original deleted page ID) |
||
3557 | */ |
||
3558 | public function updateCategoryCounts( array $added, array $deleted, $id = 0 ) { |
||
3656 | |||
3657 | /** |
||
3658 | * Opportunistically enqueue link update jobs given fresh parser output if useful |
||
3659 | * |
||
3660 | * @param ParserOutput $parserOutput Current version page output |
||
3661 | * @since 1.25 |
||
3662 | */ |
||
3663 | public function triggerOpportunisticLinksUpdate( ParserOutput $parserOutput ) { |
||
3707 | |||
3708 | /** |
||
3709 | * Returns a list of updates to be performed when this page is deleted. The |
||
3710 | * updates should remove any information about this page from secondary data |
||
3711 | * stores such as links tables. |
||
3712 | * |
||
3713 | * @param Content|null $content Optional Content object for determining the |
||
3714 | * necessary updates. |
||
3715 | * @return DeferrableUpdate[] |
||
3716 | */ |
||
3717 | public function getDeletionUpdates( Content $content = null ) { |
||
3740 | |||
3741 | /** |
||
3742 | * Whether this content displayed on this page |
||
3743 | * comes from the local database |
||
3744 | * |
||
3745 | * @since 1.28 |
||
3746 | * @return bool |
||
3747 | */ |
||
3748 | public function isLocal() { |
||
3751 | } |
||
3752 |
If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check:
If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue.