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 |
||
31 | class WikiPage implements Page, IDBAccessObject { |
||
32 | // Constants for $mDataLoadedFrom and related |
||
33 | |||
34 | /** |
||
35 | * @var Title |
||
36 | */ |
||
37 | public $mTitle = null; |
||
38 | |||
39 | /**@{{ |
||
40 | * @protected |
||
41 | */ |
||
42 | public $mDataLoaded = false; // !< Boolean |
||
43 | public $mIsRedirect = false; // !< Boolean |
||
44 | public $mLatest = false; // !< Integer (false means "not loaded") |
||
45 | /**@}}*/ |
||
46 | |||
47 | /** @var stdClass Map of cache fields (text, parser output, ect) for a proposed/new edit */ |
||
48 | public $mPreparedEdit = false; |
||
49 | |||
50 | /** |
||
51 | * @var int |
||
52 | */ |
||
53 | protected $mId = null; |
||
54 | |||
55 | /** |
||
56 | * @var int One of the READ_* constants |
||
57 | */ |
||
58 | protected $mDataLoadedFrom = self::READ_NONE; |
||
59 | |||
60 | /** |
||
61 | * @var Title |
||
62 | */ |
||
63 | protected $mRedirectTarget = null; |
||
64 | |||
65 | /** |
||
66 | * @var Revision |
||
67 | */ |
||
68 | protected $mLastRevision = null; |
||
69 | |||
70 | /** |
||
71 | * @var string Timestamp of the current revision or empty string if not loaded |
||
72 | */ |
||
73 | protected $mTimestamp = ''; |
||
74 | |||
75 | /** |
||
76 | * @var string |
||
77 | */ |
||
78 | protected $mTouched = '19700101000000'; |
||
79 | |||
80 | /** |
||
81 | * @var string |
||
82 | */ |
||
83 | protected $mLinksUpdated = '19700101000000'; |
||
84 | |||
85 | /** |
||
86 | * Constructor and clear the article |
||
87 | * @param Title $title Reference to a Title object. |
||
88 | */ |
||
89 | public function __construct( Title $title ) { |
||
92 | |||
93 | /** |
||
94 | * Makes sure that the mTitle object is cloned |
||
95 | * to the newly cloned WikiPage. |
||
96 | */ |
||
97 | public function __clone() { |
||
98 | $this->mTitle = clone $this->mTitle; |
||
99 | } |
||
100 | |||
101 | /** |
||
102 | * Create a WikiPage object of the appropriate class for the given title. |
||
103 | * |
||
104 | * @param Title $title |
||
105 | * |
||
106 | * @throws MWException |
||
107 | * @return WikiPage|WikiCategoryPage|WikiFilePage |
||
108 | */ |
||
109 | public static function factory( Title $title ) { |
||
131 | |||
132 | /** |
||
133 | * Constructor from a page id |
||
134 | * |
||
135 | * @param int $id Article ID to load |
||
136 | * @param string|int $from One of the following values: |
||
137 | * - "fromdb" or WikiPage::READ_NORMAL to select from a slave database |
||
138 | * - "fromdbmaster" or WikiPage::READ_LATEST to select from the master database |
||
139 | * |
||
140 | * @return WikiPage|null |
||
141 | */ |
||
142 | public static function newFromID( $id, $from = 'fromdb' ) { |
||
157 | |||
158 | /** |
||
159 | * Constructor from a database row |
||
160 | * |
||
161 | * @since 1.20 |
||
162 | * @param object $row Database row containing at least fields returned by selectFields(). |
||
163 | * @param string|int $from Source of $data: |
||
164 | * - "fromdb" or WikiPage::READ_NORMAL: from a slave DB |
||
165 | * - "fromdbmaster" or WikiPage::READ_LATEST: from the master DB |
||
166 | * - "forupdate" or WikiPage::READ_LOCKING: from the master DB using SELECT FOR UPDATE |
||
167 | * @return WikiPage |
||
168 | */ |
||
169 | public static function newFromRow( $row, $from = 'fromdb' ) { |
||
174 | |||
175 | /** |
||
176 | * Convert 'fromdb', 'fromdbmaster' and 'forupdate' to READ_* constants. |
||
177 | * |
||
178 | * @param object|string|int $type |
||
179 | * @return mixed |
||
180 | */ |
||
181 | private static function convertSelectType( $type ) { |
||
194 | |||
195 | /** |
||
196 | * @todo Move this UI stuff somewhere else |
||
197 | * |
||
198 | * @see ContentHandler::getActionOverrides |
||
199 | */ |
||
200 | public function getActionOverrides() { |
||
203 | |||
204 | /** |
||
205 | * Returns the ContentHandler instance to be used to deal with the content of this WikiPage. |
||
206 | * |
||
207 | * Shorthand for ContentHandler::getForModelID( $this->getContentModel() ); |
||
208 | * |
||
209 | * @return ContentHandler |
||
210 | * |
||
211 | * @since 1.21 |
||
212 | */ |
||
213 | public function getContentHandler() { |
||
216 | |||
217 | /** |
||
218 | * Get the title object of the article |
||
219 | * @return Title Title object of this page |
||
220 | */ |
||
221 | public function getTitle() { |
||
224 | |||
225 | /** |
||
226 | * Clear the object |
||
227 | * @return void |
||
228 | */ |
||
229 | public function clear() { |
||
235 | |||
236 | /** |
||
237 | * Clear the object cache fields |
||
238 | * @return void |
||
239 | */ |
||
240 | protected function clearCacheFields() { |
||
254 | |||
255 | /** |
||
256 | * Clear the mPreparedEdit cache field, as may be needed by mutable content types |
||
257 | * @return void |
||
258 | * @since 1.23 |
||
259 | */ |
||
260 | public function clearPreparedEdit() { |
||
263 | |||
264 | /** |
||
265 | * Return the list of revision fields that should be selected to create |
||
266 | * a new page. |
||
267 | * |
||
268 | * @return array |
||
269 | */ |
||
270 | public static function selectFields() { |
||
297 | |||
298 | /** |
||
299 | * Fetch a page record with the given conditions |
||
300 | * @param IDatabase $dbr |
||
301 | * @param array $conditions |
||
302 | * @param array $options |
||
303 | * @return object|bool Database result resource, or false on failure |
||
304 | */ |
||
305 | protected function pageData( $dbr, $conditions, $options = [] ) { |
||
316 | |||
317 | /** |
||
318 | * Fetch a page record matching the Title object's namespace and title |
||
319 | * using a sanitized title string |
||
320 | * |
||
321 | * @param IDatabase $dbr |
||
322 | * @param Title $title |
||
323 | * @param array $options |
||
324 | * @return object|bool Database result resource, or false on failure |
||
325 | */ |
||
326 | public function pageDataFromTitle( $dbr, $title, $options = [] ) { |
||
331 | |||
332 | /** |
||
333 | * Fetch a page record matching the requested ID |
||
334 | * |
||
335 | * @param IDatabase $dbr |
||
336 | * @param int $id |
||
337 | * @param array $options |
||
338 | * @return object|bool Database result resource, or false on failure |
||
339 | */ |
||
340 | public function pageDataFromId( $dbr, $id, $options = [] ) { |
||
343 | |||
344 | /** |
||
345 | * Load the object from a given source by title |
||
346 | * |
||
347 | * @param object|string|int $from One of the following: |
||
348 | * - A DB query result object. |
||
349 | * - "fromdb" or WikiPage::READ_NORMAL to get from a slave DB. |
||
350 | * - "fromdbmaster" or WikiPage::READ_LATEST to get from the master DB. |
||
351 | * - "forupdate" or WikiPage::READ_LOCKING to get from the master DB |
||
352 | * using SELECT FOR UPDATE. |
||
353 | * |
||
354 | * @return void |
||
355 | */ |
||
356 | public function loadPageData( $from = 'fromdb' ) { |
||
384 | |||
385 | /** |
||
386 | * Load the object from a database row |
||
387 | * |
||
388 | * @since 1.20 |
||
389 | * @param object|bool $data DB row containing fields returned by selectFields() or false |
||
390 | * @param string|int $from One of the following: |
||
391 | * - "fromdb" or WikiPage::READ_NORMAL if the data comes from a slave DB |
||
392 | * - "fromdbmaster" or WikiPage::READ_LATEST if the data comes from the master DB |
||
393 | * - "forupdate" or WikiPage::READ_LOCKING if the data comes from |
||
394 | * the master DB using SELECT FOR UPDATE |
||
395 | */ |
||
396 | public function loadFromRow( $data, $from ) { |
||
432 | |||
433 | /** |
||
434 | * @return int Page ID |
||
435 | */ |
||
436 | public function getId() { |
||
442 | |||
443 | /** |
||
444 | * @return bool Whether or not the page exists in the database |
||
445 | */ |
||
446 | public function exists() { |
||
452 | |||
453 | /** |
||
454 | * Check if this page is something we're going to be showing |
||
455 | * some sort of sensible content for. If we return false, page |
||
456 | * views (plain action=view) will return an HTTP 404 response, |
||
457 | * so spiders and robots can know they're following a bad link. |
||
458 | * |
||
459 | * @return bool |
||
460 | */ |
||
461 | public function hasViewableContent() { |
||
464 | |||
465 | /** |
||
466 | * Tests if the article content represents a redirect |
||
467 | * |
||
468 | * @return bool |
||
469 | */ |
||
470 | public function isRedirect() { |
||
477 | |||
478 | /** |
||
479 | * Returns the page's content model id (see the CONTENT_MODEL_XXX constants). |
||
480 | * |
||
481 | * Will use the revisions actual content model if the page exists, |
||
482 | * and the page's default if the page doesn't exist yet. |
||
483 | * |
||
484 | * @return string |
||
485 | * |
||
486 | * @since 1.21 |
||
487 | */ |
||
488 | public function getContentModel() { |
||
504 | |||
505 | /** |
||
506 | * Loads page_touched and returns a value indicating if it should be used |
||
507 | * @return bool True if this page exists and is not a redirect |
||
508 | */ |
||
509 | public function checkTouched() { |
||
510 | if ( !$this->mDataLoaded ) { |
||
511 | $this->loadPageData(); |
||
512 | } |
||
513 | return ( $this->mId && !$this->mIsRedirect ); |
||
514 | } |
||
515 | |||
516 | /** |
||
517 | * Get the page_touched field |
||
518 | * @return string Containing GMT timestamp |
||
519 | */ |
||
520 | public function getTouched() { |
||
526 | |||
527 | /** |
||
528 | * Get the page_links_updated field |
||
529 | * @return string|null Containing GMT timestamp |
||
530 | */ |
||
531 | public function getLinksTimestamp() { |
||
537 | |||
538 | /** |
||
539 | * Get the page_latest field |
||
540 | * @return int The rev_id of current revision |
||
541 | */ |
||
542 | public function getLatest() { |
||
548 | |||
549 | /** |
||
550 | * Get the Revision object of the oldest revision |
||
551 | * @return Revision|null |
||
552 | */ |
||
553 | public function getOldestRevision() { |
||
586 | |||
587 | /** |
||
588 | * Loads everything except the text |
||
589 | * This isn't necessary for all uses, so it's only done if needed. |
||
590 | */ |
||
591 | protected function loadLastEdit() { |
||
623 | |||
624 | /** |
||
625 | * Set the latest revision |
||
626 | * @param Revision $revision |
||
627 | */ |
||
628 | protected function setLastEdit( Revision $revision ) { |
||
632 | |||
633 | /** |
||
634 | * Get the latest revision |
||
635 | * @return Revision|null |
||
636 | */ |
||
637 | public function getRevision() { |
||
644 | |||
645 | /** |
||
646 | * Get the content of the current revision. No side-effects... |
||
647 | * |
||
648 | * @param int $audience One of: |
||
649 | * Revision::FOR_PUBLIC to be displayed to all users |
||
650 | * Revision::FOR_THIS_USER to be displayed to $wgUser |
||
651 | * Revision::RAW get the text regardless of permissions |
||
652 | * @param User $user User object to check for, only if FOR_THIS_USER is passed |
||
653 | * to the $audience parameter |
||
654 | * @return Content|null The content of the current revision |
||
655 | * |
||
656 | * @since 1.21 |
||
657 | */ |
||
658 | View Code Duplication | public function getContent( $audience = Revision::FOR_PUBLIC, User $user = null ) { |
|
665 | |||
666 | /** |
||
667 | * Get the text of the current revision. No side-effects... |
||
668 | * |
||
669 | * @param int $audience One of: |
||
670 | * Revision::FOR_PUBLIC to be displayed to all users |
||
671 | * Revision::FOR_THIS_USER to be displayed to the given user |
||
672 | * Revision::RAW get the text regardless of permissions |
||
673 | * @param User $user User object to check for, only if FOR_THIS_USER is passed |
||
674 | * to the $audience parameter |
||
675 | * @return string|bool The text of the current revision |
||
676 | * @deprecated since 1.21, getContent() should be used instead. |
||
677 | */ |
||
678 | public function getText( $audience = Revision::FOR_PUBLIC, User $user = null ) { |
||
687 | |||
688 | /** |
||
689 | * @return string MW timestamp of last article revision |
||
690 | */ |
||
691 | public function getTimestamp() { |
||
699 | |||
700 | /** |
||
701 | * Set the page timestamp (use only to avoid DB queries) |
||
702 | * @param string $ts MW timestamp of last article revision |
||
703 | * @return void |
||
704 | */ |
||
705 | public function setTimestamp( $ts ) { |
||
708 | |||
709 | /** |
||
710 | * @param int $audience One of: |
||
711 | * Revision::FOR_PUBLIC to be displayed to all users |
||
712 | * Revision::FOR_THIS_USER to be displayed to the given user |
||
713 | * Revision::RAW get the text regardless of permissions |
||
714 | * @param User $user User object to check for, only if FOR_THIS_USER is passed |
||
715 | * to the $audience parameter |
||
716 | * @return int User ID for the user that made the last article revision |
||
717 | */ |
||
718 | View Code Duplication | public function getUser( $audience = Revision::FOR_PUBLIC, User $user = null ) { |
|
726 | |||
727 | /** |
||
728 | * Get the User object of the user who created the page |
||
729 | * @param int $audience One of: |
||
730 | * Revision::FOR_PUBLIC to be displayed to all users |
||
731 | * Revision::FOR_THIS_USER to be displayed to the given user |
||
732 | * Revision::RAW get the text regardless of permissions |
||
733 | * @param User $user User object to check for, only if FOR_THIS_USER is passed |
||
734 | * to the $audience parameter |
||
735 | * @return User|null |
||
736 | */ |
||
737 | public function getCreator( $audience = Revision::FOR_PUBLIC, User $user = null ) { |
||
746 | |||
747 | /** |
||
748 | * @param int $audience One of: |
||
749 | * Revision::FOR_PUBLIC to be displayed to all users |
||
750 | * Revision::FOR_THIS_USER to be displayed to the given user |
||
751 | * Revision::RAW get the text regardless of permissions |
||
752 | * @param User $user User object to check for, only if FOR_THIS_USER is passed |
||
753 | * to the $audience parameter |
||
754 | * @return string Username of the user that made the last article revision |
||
755 | */ |
||
756 | View Code Duplication | public function getUserText( $audience = Revision::FOR_PUBLIC, User $user = null ) { |
|
764 | |||
765 | /** |
||
766 | * @param int $audience One of: |
||
767 | * Revision::FOR_PUBLIC to be displayed to all users |
||
768 | * Revision::FOR_THIS_USER to be displayed to the given user |
||
769 | * Revision::RAW get the text regardless of permissions |
||
770 | * @param User $user User object to check for, only if FOR_THIS_USER is passed |
||
771 | * to the $audience parameter |
||
772 | * @return string Comment stored for the last article revision |
||
773 | */ |
||
774 | View Code Duplication | public function getComment( $audience = Revision::FOR_PUBLIC, User $user = null ) { |
|
782 | |||
783 | /** |
||
784 | * Returns true if last revision was marked as "minor edit" |
||
785 | * |
||
786 | * @return bool Minor edit indicator for the last article revision. |
||
787 | */ |
||
788 | public function getMinorEdit() { |
||
796 | |||
797 | /** |
||
798 | * Determine whether a page would be suitable for being counted as an |
||
799 | * article in the site_stats table based on the title & its content |
||
800 | * |
||
801 | * @param object|bool $editInfo (false): object returned by prepareTextForEdit(), |
||
802 | * if false, the current database state will be used |
||
803 | * @return bool |
||
804 | */ |
||
805 | public function isCountable( $editInfo = false ) { |
||
841 | |||
842 | /** |
||
843 | * If this page is a redirect, get its target |
||
844 | * |
||
845 | * The target will be fetched from the redirect table if possible. |
||
846 | * If this page doesn't have an entry there, call insertRedirect() |
||
847 | * @return Title|null Title object, or null if this page is not a redirect |
||
848 | */ |
||
849 | public function getRedirectTarget() { |
||
879 | |||
880 | /** |
||
881 | * Insert an entry for this page into the redirect table if the content is a redirect |
||
882 | * |
||
883 | * The database update will be deferred via DeferredUpdates |
||
884 | * |
||
885 | * Don't call this function directly unless you know what you're doing. |
||
886 | * @return Title|null Title object or null if not a redirect |
||
887 | */ |
||
888 | public function insertRedirect() { |
||
889 | $content = $this->getContent(); |
||
890 | $retval = $content ? $content->getUltimateRedirectTarget() : null; |
||
891 | if ( !$retval ) { |
||
892 | return null; |
||
893 | } |
||
894 | |||
895 | // Update the DB post-send if the page has not cached since now |
||
896 | $that = $this; |
||
897 | $latest = $this->getLatest(); |
||
898 | DeferredUpdates::addCallableUpdate( |
||
899 | function () use ( $that, $retval, $latest ) { |
||
900 | $that->insertRedirectEntry( $retval, $latest ); |
||
901 | }, |
||
902 | DeferredUpdates::POSTSEND, |
||
903 | wfGetDB( DB_MASTER ) |
||
904 | ); |
||
905 | |||
906 | return $retval; |
||
907 | } |
||
908 | |||
909 | /** |
||
910 | * Insert or update the redirect table entry for this page to indicate it redirects to $rt |
||
911 | * @param Title $rt Redirect target |
||
912 | * @param int|null $oldLatest Prior page_latest for check and set |
||
913 | */ |
||
914 | public function insertRedirectEntry( Title $rt, $oldLatest = null ) { |
||
934 | |||
935 | /** |
||
936 | * Get the Title object or URL this page redirects to |
||
937 | * |
||
938 | * @return bool|Title|string False, Title of in-wiki target, or string with URL |
||
939 | */ |
||
940 | public function followRedirect() { |
||
943 | |||
944 | /** |
||
945 | * Get the Title object or URL to use for a redirect. We use Title |
||
946 | * objects for same-wiki, non-special redirects and URLs for everything |
||
947 | * else. |
||
948 | * @param Title $rt Redirect target |
||
949 | * @return bool|Title|string False, Title object of local target, or string with URL |
||
950 | */ |
||
951 | public function getRedirectURL( $rt ) { |
||
983 | |||
984 | /** |
||
985 | * Get a list of users who have edited this article, not including the user who made |
||
986 | * the most recent revision, which you can get from $article->getUser() if you want it |
||
987 | * @return UserArrayFromResult |
||
988 | */ |
||
989 | public function getContributors() { |
||
1035 | |||
1036 | /** |
||
1037 | * Should the parser cache be used? |
||
1038 | * |
||
1039 | * @param ParserOptions $parserOptions ParserOptions to check |
||
1040 | * @param int $oldId |
||
1041 | * @return bool |
||
1042 | */ |
||
1043 | public function shouldCheckParserCache( ParserOptions $parserOptions, $oldId ) { |
||
1049 | |||
1050 | /** |
||
1051 | * Get a ParserOutput for the given ParserOptions and revision ID. |
||
1052 | * |
||
1053 | * The parser cache will be used if possible. Cache misses that result |
||
1054 | * in parser runs are debounced with PoolCounter. |
||
1055 | * |
||
1056 | * @since 1.19 |
||
1057 | * @param ParserOptions $parserOptions ParserOptions to use for the parse operation |
||
1058 | * @param null|int $oldid Revision ID to get the text from, passing null or 0 will |
||
1059 | * get the current revision (default value) |
||
1060 | * @param bool $forceParse Force reindexing, regardless of cache settings |
||
1061 | * @return bool|ParserOutput ParserOutput or false if the revision was not found |
||
1062 | */ |
||
1063 | public function getParserOutput( |
||
1064 | ParserOptions $parserOptions, $oldid = null, $forceParse = false |
||
1065 | ) { |
||
1066 | $useParserCache = |
||
1067 | ( !$forceParse ) && $this->shouldCheckParserCache( $parserOptions, $oldid ); |
||
1068 | wfDebug( __METHOD__ . |
||
1069 | ': using parser cache: ' . ( $useParserCache ? 'yes' : 'no' ) . "\n" ); |
||
1070 | if ( $parserOptions->getStubThreshold() ) { |
||
1071 | wfIncrStats( 'pcache.miss.stub' ); |
||
1072 | } |
||
1073 | |||
1074 | if ( $useParserCache ) { |
||
1075 | $parserOutput = ParserCache::singleton()->get( $this, $parserOptions ); |
||
1076 | if ( $parserOutput !== false ) { |
||
1077 | return $parserOutput; |
||
1078 | } |
||
1079 | } |
||
1080 | |||
1081 | if ( $oldid === null || $oldid === 0 ) { |
||
1082 | $oldid = $this->getLatest(); |
||
1083 | } |
||
1084 | |||
1085 | $pool = new PoolWorkArticleView( $this, $parserOptions, $oldid, $useParserCache ); |
||
1086 | $pool->execute(); |
||
1087 | |||
1088 | return $pool->getParserOutput(); |
||
1089 | } |
||
1090 | |||
1091 | /** |
||
1092 | * Do standard deferred updates after page view (existing or missing page) |
||
1093 | * @param User $user The relevant user |
||
1094 | * @param int $oldid Revision id being viewed; if not given or 0, latest revision is assumed |
||
1095 | */ |
||
1096 | public function doViewUpdates( User $user, $oldid = 0 ) { |
||
1110 | |||
1111 | /** |
||
1112 | * Perform the actions of a page purging |
||
1113 | * @return bool |
||
1114 | */ |
||
1115 | public function doPurge() { |
||
1148 | |||
1149 | /** |
||
1150 | * Insert a new empty page record for this article. |
||
1151 | * This *must* be followed up by creating a revision |
||
1152 | * and running $this->updateRevisionOn( ... ); |
||
1153 | * or else the record will be left in a funky state. |
||
1154 | * Best if all done inside a transaction. |
||
1155 | * |
||
1156 | * @param IDatabase $dbw |
||
1157 | * @param int|null $pageId Custom page ID that will be used for the insert statement |
||
1158 | * |
||
1159 | * @return bool|int The newly created page_id key; false if the row was not |
||
1160 | * inserted, e.g. because the title already existed or because the specified |
||
1161 | * page ID is already in use. |
||
1162 | */ |
||
1163 | public function insertOn( $dbw, $pageId = null ) { |
||
1193 | |||
1194 | /** |
||
1195 | * Update the page record to point to a newly saved revision. |
||
1196 | * |
||
1197 | * @param IDatabase $dbw |
||
1198 | * @param Revision $revision For ID number, and text used to set |
||
1199 | * length and redirect status fields |
||
1200 | * @param int $lastRevision If given, will not overwrite the page field |
||
1201 | * when different from the currently set value. |
||
1202 | * Giving 0 indicates the new page flag should be set on. |
||
1203 | * @param bool $lastRevIsRedirect If given, will optimize adding and |
||
1204 | * removing rows in redirect table. |
||
1205 | * @return bool Success; false if the page row was missing or page_latest changed |
||
1206 | */ |
||
1207 | public function updateRevisionOn( $dbw, $revision, $lastRevision = null, |
||
1266 | |||
1267 | /** |
||
1268 | * Add row to the redirect table if this is a redirect, remove otherwise. |
||
1269 | * |
||
1270 | * @param IDatabase $dbw |
||
1271 | * @param Title $redirectTitle Title object pointing to the redirect target, |
||
1272 | * or NULL if this is not a redirect |
||
1273 | * @param null|bool $lastRevIsRedirect If given, will optimize adding and |
||
1274 | * removing rows in redirect table. |
||
1275 | * @return bool True on success, false on failure |
||
1276 | * @private |
||
1277 | */ |
||
1278 | public function updateRedirectOn( $dbw, $redirectTitle, $lastRevIsRedirect = null ) { |
||
1302 | |||
1303 | /** |
||
1304 | * If the given revision is newer than the currently set page_latest, |
||
1305 | * update the page record. Otherwise, do nothing. |
||
1306 | * |
||
1307 | * @deprecated since 1.24, use updateRevisionOn instead |
||
1308 | * |
||
1309 | * @param IDatabase $dbw |
||
1310 | * @param Revision $revision |
||
1311 | * @return bool |
||
1312 | */ |
||
1313 | public function updateIfNewerOn( $dbw, $revision ) { |
||
1339 | |||
1340 | /** |
||
1341 | * Get the content that needs to be saved in order to undo all revisions |
||
1342 | * between $undo and $undoafter. Revisions must belong to the same page, |
||
1343 | * must exist and must not be deleted |
||
1344 | * @param Revision $undo |
||
1345 | * @param Revision $undoafter Must be an earlier revision than $undo |
||
1346 | * @return Content|bool Content on success, false on failure |
||
1347 | * @since 1.21 |
||
1348 | * Before we had the Content object, this was done in getUndoText |
||
1349 | */ |
||
1350 | public function getUndoContent( Revision $undo, Revision $undoafter = null ) { |
||
1354 | |||
1355 | /** |
||
1356 | * Returns true if this page's content model supports sections. |
||
1357 | * |
||
1358 | * @return bool |
||
1359 | * |
||
1360 | * @todo The skin should check this and not offer section functionality if |
||
1361 | * sections are not supported. |
||
1362 | * @todo The EditPage should check this and not offer section functionality |
||
1363 | * if sections are not supported. |
||
1364 | */ |
||
1365 | public function supportsSections() { |
||
1368 | |||
1369 | /** |
||
1370 | * @param string|number|null|bool $sectionId Section identifier as a number or string |
||
1371 | * (e.g. 0, 1 or 'T-1'), null/false or an empty string for the whole page |
||
1372 | * or 'new' for a new section. |
||
1373 | * @param Content $sectionContent New content of the section. |
||
1374 | * @param string $sectionTitle New section's subject, only if $section is "new". |
||
1375 | * @param string $edittime Revision timestamp or null to use the current revision. |
||
1376 | * |
||
1377 | * @throws MWException |
||
1378 | * @return Content|null New complete article content, or null if error. |
||
1379 | * |
||
1380 | * @since 1.21 |
||
1381 | * @deprecated since 1.24, use replaceSectionAtRev instead |
||
1382 | */ |
||
1383 | public function replaceSectionContent( |
||
1408 | |||
1409 | /** |
||
1410 | * @param string|number|null|bool $sectionId Section identifier as a number or string |
||
1411 | * (e.g. 0, 1 or 'T-1'), null/false or an empty string for the whole page |
||
1412 | * or 'new' for a new section. |
||
1413 | * @param Content $sectionContent New content of the section. |
||
1414 | * @param string $sectionTitle New section's subject, only if $section is "new". |
||
1415 | * @param int|null $baseRevId |
||
1416 | * |
||
1417 | * @throws MWException |
||
1418 | * @return Content|null New complete article content, or null if error. |
||
1419 | * |
||
1420 | * @since 1.24 |
||
1421 | */ |
||
1422 | public function replaceSectionAtRev( $sectionId, Content $sectionContent, |
||
1459 | |||
1460 | /** |
||
1461 | * Check flags and add EDIT_NEW or EDIT_UPDATE to them as needed. |
||
1462 | * @param int $flags |
||
1463 | * @return int Updated $flags |
||
1464 | */ |
||
1465 | public function checkFlags( $flags ) { |
||
1476 | |||
1477 | /** |
||
1478 | * Change an existing article or create a new article. Updates RC and all necessary caches, |
||
1479 | * optionally via the deferred update array. |
||
1480 | * |
||
1481 | * @param string $text New text |
||
1482 | * @param string $summary Edit summary |
||
1483 | * @param int $flags Bitfield: |
||
1484 | * EDIT_NEW |
||
1485 | * Article is known or assumed to be non-existent, create a new one |
||
1486 | * EDIT_UPDATE |
||
1487 | * Article is known or assumed to be pre-existing, update it |
||
1488 | * EDIT_MINOR |
||
1489 | * Mark this edit minor, if the user is allowed to do so |
||
1490 | * EDIT_SUPPRESS_RC |
||
1491 | * Do not log the change in recentchanges |
||
1492 | * EDIT_FORCE_BOT |
||
1493 | * Mark the edit a "bot" edit regardless of user rights |
||
1494 | * EDIT_AUTOSUMMARY |
||
1495 | * Fill in blank summaries with generated text where possible |
||
1496 | * EDIT_INTERNAL |
||
1497 | * Signal that the page retrieve/save cycle happened entirely in this request. |
||
1498 | * |
||
1499 | * If neither EDIT_NEW nor EDIT_UPDATE is specified, the status of the |
||
1500 | * article will be detected. If EDIT_UPDATE is specified and the article |
||
1501 | * doesn't exist, the function will return an edit-gone-missing error. If |
||
1502 | * EDIT_NEW is specified and the article does exist, an edit-already-exists |
||
1503 | * error will be returned. These two conditions are also possible with |
||
1504 | * auto-detection due to MediaWiki's performance-optimised locking strategy. |
||
1505 | * |
||
1506 | * @param bool|int $baseRevId The revision ID this edit was based off, if any. |
||
1507 | * This is not the parent revision ID, rather the revision ID for older |
||
1508 | * content used as the source for a rollback, for example. |
||
1509 | * @param User $user The user doing the edit |
||
1510 | * |
||
1511 | * @throws MWException |
||
1512 | * @return Status Possible errors: |
||
1513 | * edit-hook-aborted: The ArticleSave hook aborted the edit but didn't |
||
1514 | * set the fatal flag of $status |
||
1515 | * edit-gone-missing: In update mode, but the article didn't exist. |
||
1516 | * edit-conflict: In update mode, the article changed unexpectedly. |
||
1517 | * edit-no-change: Warning that the text was the same as before. |
||
1518 | * edit-already-exists: In creation mode, but the article already exists. |
||
1519 | * |
||
1520 | * Extensions may define additional errors. |
||
1521 | * |
||
1522 | * $return->value will contain an associative array with members as follows: |
||
1523 | * new: Boolean indicating if the function attempted to create a new article. |
||
1524 | * revision: The revision object for the inserted revision, or null. |
||
1525 | * |
||
1526 | * Compatibility note: this function previously returned a boolean value |
||
1527 | * indicating success/failure |
||
1528 | * |
||
1529 | * @deprecated since 1.21: use doEditContent() instead. |
||
1530 | */ |
||
1531 | public function doEdit( $text, $summary, $flags = 0, $baseRevId = false, $user = null ) { |
||
1538 | |||
1539 | /** |
||
1540 | * Change an existing article or create a new article. Updates RC and all necessary caches, |
||
1541 | * optionally via the deferred update array. |
||
1542 | * |
||
1543 | * @param Content $content New content |
||
1544 | * @param string $summary Edit summary |
||
1545 | * @param int $flags Bitfield: |
||
1546 | * EDIT_NEW |
||
1547 | * Article is known or assumed to be non-existent, create a new one |
||
1548 | * EDIT_UPDATE |
||
1549 | * Article is known or assumed to be pre-existing, update it |
||
1550 | * EDIT_MINOR |
||
1551 | * Mark this edit minor, if the user is allowed to do so |
||
1552 | * EDIT_SUPPRESS_RC |
||
1553 | * Do not log the change in recentchanges |
||
1554 | * EDIT_FORCE_BOT |
||
1555 | * Mark the edit a "bot" edit regardless of user rights |
||
1556 | * EDIT_AUTOSUMMARY |
||
1557 | * Fill in blank summaries with generated text where possible |
||
1558 | * EDIT_INTERNAL |
||
1559 | * Signal that the page retrieve/save cycle happened entirely in this request. |
||
1560 | * |
||
1561 | * If neither EDIT_NEW nor EDIT_UPDATE is specified, the status of the |
||
1562 | * article will be detected. If EDIT_UPDATE is specified and the article |
||
1563 | * doesn't exist, the function will return an edit-gone-missing error. If |
||
1564 | * EDIT_NEW is specified and the article does exist, an edit-already-exists |
||
1565 | * error will be returned. These two conditions are also possible with |
||
1566 | * auto-detection due to MediaWiki's performance-optimised locking strategy. |
||
1567 | * |
||
1568 | * @param bool|int $baseRevId The revision ID this edit was based off, if any. |
||
1569 | * This is not the parent revision ID, rather the revision ID for older |
||
1570 | * content used as the source for a rollback, for example. |
||
1571 | * @param User $user The user doing the edit |
||
1572 | * @param string $serialFormat Format for storing the content in the |
||
1573 | * database. |
||
1574 | * @param array|null $tags Change tags to apply to this edit |
||
1575 | * Callers are responsible for permission checks |
||
1576 | * (with ChangeTags::canAddTagsAccompanyingChange) |
||
1577 | * |
||
1578 | * @throws MWException |
||
1579 | * @return Status Possible errors: |
||
1580 | * edit-hook-aborted: The ArticleSave hook aborted the edit but didn't |
||
1581 | * set the fatal flag of $status. |
||
1582 | * edit-gone-missing: In update mode, but the article didn't exist. |
||
1583 | * edit-conflict: In update mode, the article changed unexpectedly. |
||
1584 | * edit-no-change: Warning that the text was the same as before. |
||
1585 | * edit-already-exists: In creation mode, but the article already exists. |
||
1586 | * |
||
1587 | * Extensions may define additional errors. |
||
1588 | * |
||
1589 | * $return->value will contain an associative array with members as follows: |
||
1590 | * new: Boolean indicating if the function attempted to create a new article. |
||
1591 | * revision: The revision object for the inserted revision, or null. |
||
1592 | * |
||
1593 | * @since 1.21 |
||
1594 | * @throws MWException |
||
1595 | */ |
||
1596 | public function doEditContent( |
||
1686 | |||
1687 | /** |
||
1688 | * @param Content $content Pre-save transform content |
||
1689 | * @param integer $flags |
||
1690 | * @param User $user |
||
1691 | * @param string $summary |
||
1692 | * @param array $meta |
||
1693 | * @return Status |
||
1694 | * @throws DBUnexpectedError |
||
1695 | * @throws Exception |
||
1696 | * @throws FatalError |
||
1697 | * @throws MWException |
||
1698 | */ |
||
1699 | private function doModify( |
||
1700 | Content $content, $flags, User $user, $summary, array $meta |
||
1701 | ) { |
||
1702 | global $wgUseRCPatrol; |
||
1703 | |||
1704 | // Update article, but only if changed. |
||
1705 | $status = Status::newGood( [ 'new' => false, 'revision' => null ] ); |
||
1706 | |||
1707 | // Convenience variables |
||
1708 | $now = wfTimestampNow(); |
||
1709 | $oldid = $meta['oldId']; |
||
1710 | /** @var $oldContent Content|null */ |
||
1711 | $oldContent = $meta['oldContent']; |
||
1712 | $newsize = $content->getSize(); |
||
1713 | |||
1714 | if ( !$oldid ) { |
||
1715 | // Article gone missing |
||
1716 | $status->fatal( 'edit-gone-missing' ); |
||
1717 | |||
1718 | return $status; |
||
1719 | } elseif ( !$oldContent ) { |
||
1720 | // Sanity check for bug 37225 |
||
1721 | throw new MWException( "Could not find text for current revision {$oldid}." ); |
||
1722 | } |
||
1723 | |||
1724 | // @TODO: pass content object?! |
||
1725 | $revision = new Revision( [ |
||
1726 | 'page' => $this->getId(), |
||
1727 | 'title' => $this->mTitle, // for determining the default content model |
||
1728 | 'comment' => $summary, |
||
1729 | 'minor_edit' => $meta['minor'], |
||
1730 | 'text' => $meta['serialized'], |
||
1731 | 'len' => $newsize, |
||
1732 | 'parent_id' => $oldid, |
||
1733 | 'user' => $user->getId(), |
||
1734 | 'user_text' => $user->getName(), |
||
1735 | 'timestamp' => $now, |
||
1736 | 'content_model' => $content->getModel(), |
||
1737 | 'content_format' => $meta['serialFormat'], |
||
1738 | ] ); |
||
1739 | |||
1740 | $changed = !$content->equals( $oldContent ); |
||
1741 | |||
1742 | $dbw = wfGetDB( DB_MASTER ); |
||
1743 | |||
1744 | if ( $changed ) { |
||
1745 | $prepStatus = $content->prepareSave( $this, $flags, $oldid, $user ); |
||
1746 | $status->merge( $prepStatus ); |
||
1747 | if ( !$status->isOK() ) { |
||
1748 | return $status; |
||
1749 | } |
||
1750 | |||
1751 | $dbw->startAtomic( __METHOD__ ); |
||
1752 | // Get the latest page_latest value while locking it. |
||
1753 | // Do a CAS style check to see if it's the same as when this method |
||
1754 | // started. If it changed then bail out before touching the DB. |
||
1755 | $latestNow = $this->lockAndGetLatest(); |
||
1756 | if ( $latestNow != $oldid ) { |
||
1757 | $dbw->endAtomic( __METHOD__ ); |
||
1758 | // Page updated or deleted in the mean time |
||
1759 | $status->fatal( 'edit-conflict' ); |
||
1760 | |||
1761 | return $status; |
||
1762 | } |
||
1763 | |||
1764 | // At this point we are now comitted to returning an OK |
||
1765 | // status unless some DB query error or other exception comes up. |
||
1766 | // This way callers don't have to call rollback() if $status is bad |
||
1767 | // unless they actually try to catch exceptions (which is rare). |
||
1768 | |||
1769 | // Save the revision text |
||
1770 | $revisionId = $revision->insertOn( $dbw ); |
||
1771 | // Update page_latest and friends to reflect the new revision |
||
1772 | if ( !$this->updateRevisionOn( $dbw, $revision, null, $meta['oldIsRedirect'] ) ) { |
||
1773 | throw new MWException( "Failed to update page row to use new revision." ); |
||
1774 | } |
||
1775 | |||
1776 | Hooks::run( 'NewRevisionFromEditComplete', |
||
1777 | [ $this, $revision, $meta['baseRevId'], $user ] ); |
||
1778 | |||
1779 | // Update recentchanges |
||
1780 | if ( !( $flags & EDIT_SUPPRESS_RC ) ) { |
||
1781 | // Mark as patrolled if the user can do so |
||
1782 | $patrolled = $wgUseRCPatrol && !count( |
||
1783 | $this->mTitle->getUserPermissionsErrors( 'autopatrol', $user ) ); |
||
1784 | // Add RC row to the DB |
||
1785 | RecentChange::notifyEdit( |
||
1786 | $now, |
||
1787 | $this->mTitle, |
||
1788 | $revision->isMinor(), |
||
1789 | $user, |
||
1790 | $summary, |
||
1791 | $oldid, |
||
1792 | $this->getTimestamp(), |
||
1793 | $meta['bot'], |
||
1794 | '', |
||
1795 | $oldContent ? $oldContent->getSize() : 0, |
||
1796 | $newsize, |
||
1797 | $revisionId, |
||
1798 | $patrolled, |
||
1799 | $meta['tags'] |
||
1800 | ); |
||
1801 | } |
||
1802 | |||
1803 | $user->incEditCount(); |
||
1804 | |||
1805 | $dbw->endAtomic( __METHOD__ ); |
||
1806 | $this->mTimestamp = $now; |
||
1807 | } else { |
||
1808 | // Bug 32948: revision ID must be set to page {{REVISIONID}} and |
||
1809 | // related variables correctly. Likewise for {{REVISIONUSER}} (T135261). |
||
1810 | $revision->setId( $this->getLatest() ); |
||
1811 | $revision->setUserIdAndName( |
||
1812 | $this->getUser( Revision::RAW ), |
||
1813 | $this->getUserText( Revision::RAW ) |
||
1814 | ); |
||
1815 | } |
||
1816 | |||
1817 | if ( $changed ) { |
||
1818 | // Return the new revision to the caller |
||
1819 | $status->value['revision'] = $revision; |
||
1820 | } else { |
||
1821 | $status->warning( 'edit-no-change' ); |
||
1822 | // Update page_touched as updateRevisionOn() was not called. |
||
1823 | // Other cache updates are managed in onArticleEdit() via doEditUpdates(). |
||
1824 | $this->mTitle->invalidateCache( $now ); |
||
1825 | } |
||
1826 | |||
1827 | // Do secondary updates once the main changes have been committed... |
||
1828 | DeferredUpdates::addUpdate( |
||
1829 | new AtomicSectionUpdate( |
||
1830 | $dbw, |
||
1831 | __METHOD__, |
||
1832 | function () use ( |
||
1833 | $revision, &$user, $content, $summary, &$flags, |
||
1834 | $changed, $meta, &$status |
||
1835 | ) { |
||
1836 | // Update links tables, site stats, etc. |
||
1837 | $this->doEditUpdates( |
||
1838 | $revision, |
||
1839 | $user, |
||
1840 | [ |
||
1841 | 'changed' => $changed, |
||
1842 | 'oldcountable' => $meta['oldCountable'], |
||
1843 | 'oldrevision' => $meta['oldRevision'] |
||
1844 | ] |
||
1845 | ); |
||
1846 | // Trigger post-save hook |
||
1847 | $params = [ &$this, &$user, $content, $summary, $flags & EDIT_MINOR, |
||
1848 | null, null, &$flags, $revision, &$status, $meta['baseRevId'] ]; |
||
1849 | ContentHandler::runLegacyHooks( 'ArticleSaveComplete', $params ); |
||
1850 | Hooks::run( 'PageContentSaveComplete', $params ); |
||
1851 | } |
||
1852 | ), |
||
1853 | DeferredUpdates::PRESEND |
||
1854 | ); |
||
1855 | |||
1856 | return $status; |
||
1857 | } |
||
1858 | |||
1859 | /** |
||
1860 | * @param Content $content Pre-save transform content |
||
1861 | * @param integer $flags |
||
1862 | * @param User $user |
||
1863 | * @param string $summary |
||
1864 | * @param array $meta |
||
1865 | * @return Status |
||
1866 | * @throws DBUnexpectedError |
||
1867 | * @throws Exception |
||
1868 | * @throws FatalError |
||
1869 | * @throws MWException |
||
1870 | */ |
||
1871 | private function doCreate( |
||
1872 | Content $content, $flags, User $user, $summary, array $meta |
||
1873 | ) { |
||
1874 | global $wgUseRCPatrol, $wgUseNPPatrol; |
||
1875 | |||
1876 | $status = Status::newGood( [ 'new' => true, 'revision' => null ] ); |
||
1877 | |||
1878 | $now = wfTimestampNow(); |
||
1879 | $newsize = $content->getSize(); |
||
1880 | $prepStatus = $content->prepareSave( $this, $flags, $meta['oldId'], $user ); |
||
1881 | $status->merge( $prepStatus ); |
||
1882 | if ( !$status->isOK() ) { |
||
1883 | return $status; |
||
1884 | } |
||
1885 | |||
1886 | $dbw = wfGetDB( DB_MASTER ); |
||
1887 | $dbw->startAtomic( __METHOD__ ); |
||
1888 | |||
1889 | // Add the page record unless one already exists for the title |
||
1890 | $newid = $this->insertOn( $dbw ); |
||
1891 | if ( $newid === false ) { |
||
1892 | $dbw->endAtomic( __METHOD__ ); // nothing inserted |
||
1893 | $status->fatal( 'edit-already-exists' ); |
||
1894 | |||
1895 | return $status; // nothing done |
||
1896 | } |
||
1897 | |||
1898 | // At this point we are now comitted to returning an OK |
||
1899 | // status unless some DB query error or other exception comes up. |
||
1900 | // This way callers don't have to call rollback() if $status is bad |
||
1901 | // unless they actually try to catch exceptions (which is rare). |
||
1902 | |||
1903 | // @TODO: pass content object?! |
||
1904 | $revision = new Revision( [ |
||
1905 | 'page' => $newid, |
||
1906 | 'title' => $this->mTitle, // for determining the default content model |
||
1907 | 'comment' => $summary, |
||
1908 | 'minor_edit' => $meta['minor'], |
||
1909 | 'text' => $meta['serialized'], |
||
1910 | 'len' => $newsize, |
||
1911 | 'user' => $user->getId(), |
||
1912 | 'user_text' => $user->getName(), |
||
1913 | 'timestamp' => $now, |
||
1914 | 'content_model' => $content->getModel(), |
||
1915 | 'content_format' => $meta['serialFormat'], |
||
1916 | ] ); |
||
1917 | |||
1918 | // Save the revision text... |
||
1919 | $revisionId = $revision->insertOn( $dbw ); |
||
1920 | // Update the page record with revision data |
||
1921 | if ( !$this->updateRevisionOn( $dbw, $revision, 0 ) ) { |
||
1922 | throw new MWException( "Failed to update page row to use new revision." ); |
||
1923 | } |
||
1924 | |||
1925 | Hooks::run( 'NewRevisionFromEditComplete', [ $this, $revision, false, $user ] ); |
||
1926 | |||
1927 | // Update recentchanges |
||
1928 | if ( !( $flags & EDIT_SUPPRESS_RC ) ) { |
||
1929 | // Mark as patrolled if the user can do so |
||
1930 | $patrolled = ( $wgUseRCPatrol || $wgUseNPPatrol ) && |
||
1931 | !count( $this->mTitle->getUserPermissionsErrors( 'autopatrol', $user ) ); |
||
1932 | // Add RC row to the DB |
||
1933 | RecentChange::notifyNew( |
||
1934 | $now, |
||
1935 | $this->mTitle, |
||
1936 | $revision->isMinor(), |
||
1937 | $user, |
||
1938 | $summary, |
||
1939 | $meta['bot'], |
||
1940 | '', |
||
1941 | $newsize, |
||
1942 | $revisionId, |
||
1943 | $patrolled, |
||
1944 | $meta['tags'] |
||
1945 | ); |
||
1946 | } |
||
1947 | |||
1948 | $user->incEditCount(); |
||
1949 | |||
1950 | $dbw->endAtomic( __METHOD__ ); |
||
1951 | $this->mTimestamp = $now; |
||
1952 | |||
1953 | // Return the new revision to the caller |
||
1954 | $status->value['revision'] = $revision; |
||
1955 | |||
1956 | // Do secondary updates once the main changes have been committed... |
||
1957 | DeferredUpdates::addUpdate( |
||
1958 | new AtomicSectionUpdate( |
||
1959 | $dbw, |
||
1960 | __METHOD__, |
||
1961 | function () use ( |
||
1962 | $revision, &$user, $content, $summary, &$flags, $meta, &$status |
||
1963 | ) { |
||
1964 | // Update links, etc. |
||
1965 | $this->doEditUpdates( $revision, $user, [ 'created' => true ] ); |
||
1966 | // Trigger post-create hook |
||
1967 | $params = [ &$this, &$user, $content, $summary, |
||
1968 | $flags & EDIT_MINOR, null, null, &$flags, $revision ]; |
||
1969 | ContentHandler::runLegacyHooks( 'ArticleInsertComplete', $params ); |
||
1970 | Hooks::run( 'PageContentInsertComplete', $params ); |
||
1971 | // Trigger post-save hook |
||
1972 | $params = array_merge( $params, [ &$status, $meta['baseRevId'] ] ); |
||
1973 | ContentHandler::runLegacyHooks( 'ArticleSaveComplete', $params ); |
||
1974 | Hooks::run( 'PageContentSaveComplete', $params ); |
||
1975 | |||
1976 | } |
||
1977 | ), |
||
1978 | DeferredUpdates::PRESEND |
||
1979 | ); |
||
1980 | |||
1981 | return $status; |
||
1982 | } |
||
1983 | |||
1984 | /** |
||
1985 | * Get parser options suitable for rendering the primary article wikitext |
||
1986 | * |
||
1987 | * @see ContentHandler::makeParserOptions |
||
1988 | * |
||
1989 | * @param IContextSource|User|string $context One of the following: |
||
1990 | * - IContextSource: Use the User and the Language of the provided |
||
1991 | * context |
||
1992 | * - User: Use the provided User object and $wgLang for the language, |
||
1993 | * so use an IContextSource object if possible. |
||
1994 | * - 'canonical': Canonical options (anonymous user with default |
||
1995 | * preferences and content language). |
||
1996 | * @return ParserOptions |
||
1997 | */ |
||
1998 | public function makeParserOptions( $context ) { |
||
2009 | |||
2010 | /** |
||
2011 | * Prepare text which is about to be saved. |
||
2012 | * Returns a stdClass with source, pst and output members |
||
2013 | * |
||
2014 | * @param string $text |
||
2015 | * @param int|null $revid |
||
2016 | * @param User|null $user |
||
2017 | * @deprecated since 1.21: use prepareContentForEdit instead. |
||
2018 | * @return object |
||
2019 | */ |
||
2020 | public function prepareTextForEdit( $text, $revid = null, User $user = null ) { |
||
2025 | |||
2026 | /** |
||
2027 | * Prepare content which is about to be saved. |
||
2028 | * Returns a stdClass with source, pst and output members |
||
2029 | * |
||
2030 | * @param Content $content |
||
2031 | * @param Revision|int|null $revision Revision object. For backwards compatibility, a |
||
2032 | * revision ID is also accepted, but this is deprecated. |
||
2033 | * @param User|null $user |
||
2034 | * @param string|null $serialFormat |
||
2035 | * @param bool $useCache Check shared prepared edit cache |
||
2036 | * |
||
2037 | * @return object |
||
2038 | * |
||
2039 | * @since 1.21 |
||
2040 | */ |
||
2041 | public function prepareContentForEdit( |
||
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 | * - restored: boolean, whether the page was undeleted (default false) |
||
2175 | * - oldrevision: Revision object for the pre-update revision (default null) |
||
2176 | * - oldcountable: boolean, null, or string 'no-change' (default null): |
||
2177 | * - boolean: whether the page was counted as an article before that |
||
2178 | * revision, only used in changed is true and created is false |
||
2179 | * - null: if created is false, don't update the article count; if created |
||
2180 | * is true, do update the article count |
||
2181 | * - 'no-change': don't update the article count, ever |
||
2182 | */ |
||
2183 | public function doEditUpdates( Revision $revision, User $user, array $options = [] ) { |
||
2341 | |||
2342 | /** |
||
2343 | * Edit an article without doing all that other stuff |
||
2344 | * The article must already exist; link tables etc |
||
2345 | * are not updated, caches are not flushed. |
||
2346 | * |
||
2347 | * @param Content $content Content submitted |
||
2348 | * @param User $user The relevant user |
||
2349 | * @param string $comment Comment submitted |
||
2350 | * @param bool $minor Whereas it's a minor modification |
||
2351 | * @param string $serialFormat Format for storing the content in the database |
||
2352 | */ |
||
2353 | public function doQuickEditContent( |
||
2376 | |||
2377 | /** |
||
2378 | * Update the article's restriction field, and leave a log entry. |
||
2379 | * This works for protection both existing and non-existing pages. |
||
2380 | * |
||
2381 | * @param array $limit Set of restriction keys |
||
2382 | * @param array $expiry Per restriction type expiration |
||
2383 | * @param int &$cascade Set to false if cascading protection isn't allowed. |
||
2384 | * @param string $reason |
||
2385 | * @param User $user The user updating the restrictions |
||
2386 | * @param string|string[] $tags Change tags to add to the pages and protection log entries |
||
2387 | * ($user should be able to add the specified tags before this is called) |
||
2388 | * @return Status Status object; if action is taken, $status->value is the log_id of the |
||
2389 | * protection log entry. |
||
2390 | */ |
||
2391 | public function doUpdateRestrictions( array $limit, array $expiry, |
||
2632 | |||
2633 | /** |
||
2634 | * Insert a new null revision for this page. |
||
2635 | * |
||
2636 | * @param string $revCommentMsg Comment message key for the revision |
||
2637 | * @param array $limit Set of restriction keys |
||
2638 | * @param array $expiry Per restriction type expiration |
||
2639 | * @param int $cascade Set to false if cascading protection isn't allowed. |
||
2640 | * @param string $reason |
||
2641 | * @param User|null $user |
||
2642 | * @return Revision|null Null on error |
||
2643 | */ |
||
2644 | public function insertProtectNullRevision( $revCommentMsg, array $limit, |
||
2684 | |||
2685 | /** |
||
2686 | * @param string $expiry 14-char timestamp or "infinity", or false if the input was invalid |
||
2687 | * @return string |
||
2688 | */ |
||
2689 | protected function formatExpiry( $expiry ) { |
||
2704 | |||
2705 | /** |
||
2706 | * Builds the description to serve as comment for the edit. |
||
2707 | * |
||
2708 | * @param array $limit Set of restriction keys |
||
2709 | * @param array $expiry Per restriction type expiration |
||
2710 | * @return string |
||
2711 | */ |
||
2712 | public function protectDescription( array $limit, array $expiry ) { |
||
2742 | |||
2743 | /** |
||
2744 | * Builds the description to serve as comment for the log entry. |
||
2745 | * |
||
2746 | * Some bots may parse IRC lines, which are generated from log entries which contain plain |
||
2747 | * protect description text. Keep them in old format to avoid breaking compatibility. |
||
2748 | * TODO: Fix protection log to store structured description and format it on-the-fly. |
||
2749 | * |
||
2750 | * @param array $limit Set of restriction keys |
||
2751 | * @param array $expiry Per restriction type expiration |
||
2752 | * @return string |
||
2753 | */ |
||
2754 | public function protectDescriptionLog( array $limit, array $expiry ) { |
||
2767 | |||
2768 | /** |
||
2769 | * Take an array of page restrictions and flatten it to a string |
||
2770 | * suitable for insertion into the page_restrictions field. |
||
2771 | * |
||
2772 | * @param string[] $limit |
||
2773 | * |
||
2774 | * @throws MWException |
||
2775 | * @return string |
||
2776 | */ |
||
2777 | protected static function flattenRestrictions( $limit ) { |
||
2791 | |||
2792 | /** |
||
2793 | * Same as doDeleteArticleReal(), but returns a simple boolean. This is kept around for |
||
2794 | * backwards compatibility, if you care about error reporting you should use |
||
2795 | * doDeleteArticleReal() instead. |
||
2796 | * |
||
2797 | * Deletes the article with database consistency, writes logs, purges caches |
||
2798 | * |
||
2799 | * @param string $reason Delete reason for deletion log |
||
2800 | * @param bool $suppress Suppress all revisions and log the deletion in |
||
2801 | * the suppression log instead of the deletion log |
||
2802 | * @param int $u1 Unused |
||
2803 | * @param bool $u2 Unused |
||
2804 | * @param array|string &$error Array of errors to append to |
||
2805 | * @param User $user The deleting user |
||
2806 | * @return bool True if successful |
||
2807 | */ |
||
2808 | public function doDeleteArticle( |
||
2814 | |||
2815 | /** |
||
2816 | * Back-end article deletion |
||
2817 | * Deletes the article with database consistency, writes logs, purges caches |
||
2818 | * |
||
2819 | * @since 1.19 |
||
2820 | * |
||
2821 | * @param string $reason Delete reason for deletion log |
||
2822 | * @param bool $suppress Suppress all revisions and log the deletion in |
||
2823 | * the suppression log instead of the deletion log |
||
2824 | * @param int $u1 Unused |
||
2825 | * @param bool $u2 Unused |
||
2826 | * @param array|string &$error Array of errors to append to |
||
2827 | * @param User $user The deleting user |
||
2828 | * @return Status Status object; if successful, $status->value is the log_id of the |
||
2829 | * deletion log entry. If the page couldn't be deleted because it wasn't |
||
2830 | * found, $status is a non-fatal 'cannotdelete' error |
||
2831 | */ |
||
2832 | public function doDeleteArticleReal( |
||
3002 | |||
3003 | /** |
||
3004 | * Lock the page row for this title+id and return page_latest (or 0) |
||
3005 | * |
||
3006 | * @return integer Returns 0 if no row was found with this title+id |
||
3007 | * @since 1.27 |
||
3008 | */ |
||
3009 | public function lockAndGetLatest() { |
||
3024 | |||
3025 | /** |
||
3026 | * Do some database updates after deletion |
||
3027 | * |
||
3028 | * @param int $id The page_id value of the page being deleted |
||
3029 | * @param Content $content Optional page content to be used when determining |
||
3030 | * the required updates. This may be needed because $this->getContent() |
||
3031 | * may already return null when the page proper was deleted. |
||
3032 | */ |
||
3033 | public function doDeleteUpdates( $id, Content $content = null ) { |
||
3068 | |||
3069 | /** |
||
3070 | * Roll back the most recent consecutive set of edits to a page |
||
3071 | * from the same user; fails if there are no eligible edits to |
||
3072 | * roll back to, e.g. user is the sole contributor. This function |
||
3073 | * performs permissions checks on $user, then calls commitRollback() |
||
3074 | * to do the dirty work |
||
3075 | * |
||
3076 | * @todo Separate the business/permission stuff out from backend code |
||
3077 | * @todo Remove $token parameter. Already verified by RollbackAction and ApiRollback. |
||
3078 | * |
||
3079 | * @param string $fromP Name of the user whose edits to rollback. |
||
3080 | * @param string $summary Custom summary. Set to default summary if empty. |
||
3081 | * @param string $token Rollback token. |
||
3082 | * @param bool $bot If true, mark all reverted edits as bot. |
||
3083 | * |
||
3084 | * @param array $resultDetails Array contains result-specific array of additional values |
||
3085 | * 'alreadyrolled' : 'current' (rev) |
||
3086 | * success : 'summary' (str), 'current' (rev), 'target' (rev) |
||
3087 | * |
||
3088 | * @param User $user The user performing the rollback |
||
3089 | * @param array|null $tags Change tags to apply to the rollback |
||
3090 | * Callers are responsible for permission checks |
||
3091 | * (with ChangeTags::canAddTagsAccompanyingChange) |
||
3092 | * |
||
3093 | * @return array Array of errors, each error formatted as |
||
3094 | * array(messagekey, param1, param2, ...). |
||
3095 | * On success, the array is empty. This array can also be passed to |
||
3096 | * OutputPage::showPermissionsErrorPage(). |
||
3097 | */ |
||
3098 | public function doRollback( |
||
3123 | |||
3124 | /** |
||
3125 | * Backend implementation of doRollback(), please refer there for parameter |
||
3126 | * and return value documentation |
||
3127 | * |
||
3128 | * NOTE: This function does NOT check ANY permissions, it just commits the |
||
3129 | * rollback to the DB. Therefore, you should only call this function direct- |
||
3130 | * ly if you want to use custom permissions checks. If you don't, use |
||
3131 | * doRollback() instead. |
||
3132 | * @param string $fromP Name of the user whose edits to rollback. |
||
3133 | * @param string $summary Custom summary. Set to default summary if empty. |
||
3134 | * @param bool $bot If true, mark all reverted edits as bot. |
||
3135 | * |
||
3136 | * @param array $resultDetails Contains result-specific array of additional values |
||
3137 | * @param User $guser The user performing the rollback |
||
3138 | * @param array|null $tags Change tags to apply to the rollback |
||
3139 | * Callers are responsible for permission checks |
||
3140 | * (with ChangeTags::canAddTagsAccompanyingChange) |
||
3141 | * |
||
3142 | * @return array |
||
3143 | */ |
||
3144 | public function commitRollback( $fromP, $summary, $bot, |
||
3300 | |||
3301 | /** |
||
3302 | * The onArticle*() functions are supposed to be a kind of hooks |
||
3303 | * which should be called whenever any of the specified actions |
||
3304 | * are done. |
||
3305 | * |
||
3306 | * This is a good place to put code to clear caches, for instance. |
||
3307 | * |
||
3308 | * This is called on page move and undelete, as well as edit |
||
3309 | * |
||
3310 | * @param Title $title |
||
3311 | */ |
||
3312 | public static function onArticleCreate( Title $title ) { |
||
3330 | |||
3331 | /** |
||
3332 | * Clears caches when article is deleted |
||
3333 | * |
||
3334 | * @param Title $title |
||
3335 | */ |
||
3336 | public static function onArticleDelete( Title $title ) { |
||
3376 | |||
3377 | /** |
||
3378 | * Purge caches on page update etc |
||
3379 | * |
||
3380 | * @param Title $title |
||
3381 | * @param Revision|null $revision Revision that was just saved, may be null |
||
3382 | */ |
||
3383 | public static function onArticleEdit( Title $title, Revision $revision = null ) { |
||
3400 | |||
3401 | /**#@-*/ |
||
3402 | |||
3403 | /** |
||
3404 | * Returns a list of categories this page is a member of. |
||
3405 | * Results will include hidden categories |
||
3406 | * |
||
3407 | * @return TitleArray |
||
3408 | */ |
||
3409 | public function getCategories() { |
||
3425 | |||
3426 | /** |
||
3427 | * Returns a list of hidden categories this page is a member of. |
||
3428 | * Uses the page_props and categorylinks tables. |
||
3429 | * |
||
3430 | * @return array Array of Title objects |
||
3431 | */ |
||
3432 | public function getHiddenCategories() { |
||
3455 | |||
3456 | /** |
||
3457 | * Return an applicable autosummary if one exists for the given edit. |
||
3458 | * @param string|null $oldtext The previous text of the page. |
||
3459 | * @param string|null $newtext The submitted text of the page. |
||
3460 | * @param int $flags Bitmask: a bitmask of flags submitted for the edit. |
||
3461 | * @return string An appropriate autosummary, or an empty string. |
||
3462 | * |
||
3463 | * @deprecated since 1.21, use ContentHandler::getAutosummary() instead |
||
3464 | */ |
||
3465 | public static function getAutosummary( $oldtext, $newtext, $flags ) { |
||
3477 | |||
3478 | /** |
||
3479 | * Auto-generates a deletion reason |
||
3480 | * |
||
3481 | * @param bool &$hasHistory Whether the page has a history |
||
3482 | * @return string|bool String containing deletion reason or empty string, or boolean false |
||
3483 | * if no revision occurred |
||
3484 | */ |
||
3485 | public function getAutoDeleteReason( &$hasHistory ) { |
||
3488 | |||
3489 | /** |
||
3490 | * Update all the appropriate counts in the category table, given that |
||
3491 | * we've added the categories $added and deleted the categories $deleted. |
||
3492 | * |
||
3493 | * @param array $added The names of categories that were added |
||
3494 | * @param array $deleted The names of categories that were deleted |
||
3495 | * @param integer $id Page ID (this should be the original deleted page ID) |
||
3496 | */ |
||
3497 | public function updateCategoryCounts( array $added, array $deleted, $id = 0 ) { |
||
3594 | |||
3595 | /** |
||
3596 | * Opportunistically enqueue link update jobs given fresh parser output if useful |
||
3597 | * |
||
3598 | * @param ParserOutput $parserOutput Current version page output |
||
3599 | * @since 1.25 |
||
3600 | */ |
||
3601 | public function triggerOpportunisticLinksUpdate( ParserOutput $parserOutput ) { |
||
3645 | |||
3646 | /** |
||
3647 | * Returns a list of updates to be performed when this page is deleted. The |
||
3648 | * updates should remove any information about this page from secondary data |
||
3649 | * stores such as links tables. |
||
3650 | * |
||
3651 | * @param Content|null $content Optional Content object for determining the |
||
3652 | * necessary updates. |
||
3653 | * @return DataUpdate[] |
||
3654 | */ |
||
3655 | public function getDeletionUpdates( Content $content = null ) { |
||
3678 | } |
||
3679 |
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.