Merge "Update docs/hooks.txt for ShowSearchHitTitle"
[mediawiki.git] / includes / MovePage.php
blobae12ba5e7d84616019dbca996fcd2d6eeeaea4f9
1 <?php
3 /**
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License along
15 * with this program; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17 * http://www.gnu.org/copyleft/gpl.html
19 * @file
22 use MediaWiki\MediaWikiServices;
24 /**
25 * Handles the backend logic of moving a page from one title
26 * to another.
28 * @since 1.24
30 class MovePage {
32 /**
33 * @var Title
35 protected $oldTitle;
37 /**
38 * @var Title
40 protected $newTitle;
42 public function __construct( Title $oldTitle, Title $newTitle ) {
43 $this->oldTitle = $oldTitle;
44 $this->newTitle = $newTitle;
47 public function checkPermissions( User $user, $reason ) {
48 $status = new Status();
50 $errors = wfMergeErrorArrays(
51 $this->oldTitle->getUserPermissionsErrors( 'move', $user ),
52 $this->oldTitle->getUserPermissionsErrors( 'edit', $user ),
53 $this->newTitle->getUserPermissionsErrors( 'move-target', $user ),
54 $this->newTitle->getUserPermissionsErrors( 'edit', $user )
57 // Convert into a Status object
58 if ( $errors ) {
59 foreach ( $errors as $error ) {
60 call_user_func_array( [ $status, 'fatal' ], $error );
64 if ( EditPage::matchSummarySpamRegex( $reason ) !== false ) {
65 // This is kind of lame, won't display nice
66 $status->fatal( 'spamprotectiontext' );
69 $tp = $this->newTitle->getTitleProtection();
70 if ( $tp !== false && !$user->isAllowed( $tp['permission'] ) ) {
71 $status->fatal( 'cantmove-titleprotected' );
74 Hooks::run( 'MovePageCheckPermissions',
75 [ $this->oldTitle, $this->newTitle, $user, $reason, $status ]
78 return $status;
81 /**
82 * Does various sanity checks that the move is
83 * valid. Only things based on the two titles
84 * should be checked here.
86 * @return Status
88 public function isValidMove() {
89 global $wgContentHandlerUseDB;
90 $status = new Status();
92 if ( $this->oldTitle->equals( $this->newTitle ) ) {
93 $status->fatal( 'selfmove' );
95 if ( !$this->oldTitle->isMovable() ) {
96 $status->fatal( 'immobile-source-namespace', $this->oldTitle->getNsText() );
98 if ( $this->newTitle->isExternal() ) {
99 $status->fatal( 'immobile-target-namespace-iw' );
101 if ( !$this->newTitle->isMovable() ) {
102 $status->fatal( 'immobile-target-namespace', $this->newTitle->getNsText() );
105 $oldid = $this->oldTitle->getArticleID();
107 if ( strlen( $this->newTitle->getDBkey() ) < 1 ) {
108 $status->fatal( 'articleexists' );
110 if (
111 ( $this->oldTitle->getDBkey() == '' ) ||
112 ( !$oldid ) ||
113 ( $this->newTitle->getDBkey() == '' )
115 $status->fatal( 'badarticleerror' );
118 # The move is allowed only if (1) the target doesn't exist, or
119 # (2) the target is a redirect to the source, and has no history
120 # (so we can undo bad moves right after they're done).
121 if ( $this->newTitle->getArticleID() && !$this->isValidMoveTarget() ) {
122 $status->fatal( 'articleexists' );
125 // Content model checks
126 if ( !$wgContentHandlerUseDB &&
127 $this->oldTitle->getContentModel() !== $this->newTitle->getContentModel() ) {
128 // can't move a page if that would change the page's content model
129 $status->fatal(
130 'bad-target-model',
131 ContentHandler::getLocalizedName( $this->oldTitle->getContentModel() ),
132 ContentHandler::getLocalizedName( $this->newTitle->getContentModel() )
134 } elseif (
135 !ContentHandler::getForTitle( $this->oldTitle )->canBeUsedOn( $this->newTitle )
137 $status->fatal(
138 'content-not-allowed-here',
139 ContentHandler::getLocalizedName( $this->oldTitle->getContentModel() ),
140 $this->newTitle->getPrefixedText()
144 // Image-specific checks
145 if ( $this->oldTitle->inNamespace( NS_FILE ) ) {
146 $status->merge( $this->isValidFileMove() );
149 if ( $this->newTitle->inNamespace( NS_FILE ) && !$this->oldTitle->inNamespace( NS_FILE ) ) {
150 $status->fatal( 'nonfile-cannot-move-to-file' );
153 // Hook for extensions to say a title can't be moved for technical reasons
154 Hooks::run( 'MovePageIsValidMove', [ $this->oldTitle, $this->newTitle, $status ] );
156 return $status;
160 * Sanity checks for when a file is being moved
162 * @return Status
164 protected function isValidFileMove() {
165 $status = new Status();
166 $file = wfLocalFile( $this->oldTitle );
167 $file->load( File::READ_LATEST );
168 if ( $file->exists() ) {
169 if ( $this->newTitle->getText() != wfStripIllegalFilenameChars( $this->newTitle->getText() ) ) {
170 $status->fatal( 'imageinvalidfilename' );
172 if ( !File::checkExtensionCompatibility( $file, $this->newTitle->getDBkey() ) ) {
173 $status->fatal( 'imagetypemismatch' );
177 if ( !$this->newTitle->inNamespace( NS_FILE ) ) {
178 $status->fatal( 'imagenocrossnamespace' );
181 return $status;
185 * Checks if $this can be moved to a given Title
186 * - Selects for update, so don't call it unless you mean business
188 * @since 1.25
189 * @return bool
191 protected function isValidMoveTarget() {
192 # Is it an existing file?
193 if ( $this->newTitle->inNamespace( NS_FILE ) ) {
194 $file = wfLocalFile( $this->newTitle );
195 $file->load( File::READ_LATEST );
196 if ( $file->exists() ) {
197 wfDebug( __METHOD__ . ": file exists\n" );
198 return false;
201 # Is it a redirect with no history?
202 if ( !$this->newTitle->isSingleRevRedirect() ) {
203 wfDebug( __METHOD__ . ": not a one-rev redirect\n" );
204 return false;
206 # Get the article text
207 $rev = Revision::newFromTitle( $this->newTitle, false, Revision::READ_LATEST );
208 if ( !is_object( $rev ) ) {
209 return false;
211 $content = $rev->getContent();
212 # Does the redirect point to the source?
213 # Or is it a broken self-redirect, usually caused by namespace collisions?
214 $redirTitle = $content ? $content->getRedirectTarget() : null;
216 if ( $redirTitle ) {
217 if ( $redirTitle->getPrefixedDBkey() !== $this->oldTitle->getPrefixedDBkey() &&
218 $redirTitle->getPrefixedDBkey() !== $this->newTitle->getPrefixedDBkey() ) {
219 wfDebug( __METHOD__ . ": redirect points to other page\n" );
220 return false;
221 } else {
222 return true;
224 } else {
225 # Fail safe (not a redirect after all. strange.)
226 wfDebug( __METHOD__ . ": failsafe: database says " . $this->newTitle->getPrefixedDBkey() .
227 " is a redirect, but it doesn't contain a valid redirect.\n" );
228 return false;
233 * @param User $user
234 * @param string $reason
235 * @param bool $createRedirect
236 * @param string[] $changeTags Change tags to apply to the entry in the move log. Caller
237 * should perform permission checks with ChangeTags::canAddTagsAccompanyingChange
238 * @return Status
240 public function move( User $user, $reason, $createRedirect, array $changeTags = [] ) {
241 global $wgCategoryCollation;
243 Hooks::run( 'TitleMove', [ $this->oldTitle, $this->newTitle, $user ] );
245 // If it is a file, move it first.
246 // It is done before all other moving stuff is done because it's hard to revert.
247 $dbw = wfGetDB( DB_MASTER );
248 if ( $this->oldTitle->getNamespace() == NS_FILE ) {
249 $file = wfLocalFile( $this->oldTitle );
250 $file->load( File::READ_LATEST );
251 if ( $file->exists() ) {
252 $status = $file->move( $this->newTitle );
253 if ( !$status->isOK() ) {
254 return $status;
257 // Clear RepoGroup process cache
258 RepoGroup::singleton()->clearCache( $this->oldTitle );
259 RepoGroup::singleton()->clearCache( $this->newTitle ); # clear false negative cache
262 $dbw->startAtomic( __METHOD__ );
264 Hooks::run( 'TitleMoveStarting', [ $this->oldTitle, $this->newTitle, $user ] );
266 $pageid = $this->oldTitle->getArticleID( Title::GAID_FOR_UPDATE );
267 $protected = $this->oldTitle->isProtected();
269 // Do the actual move; if this fails, it will throw an MWException(!)
270 $nullRevision = $this->moveToInternal( $user, $this->newTitle, $reason, $createRedirect,
271 $changeTags );
273 // Refresh the sortkey for this row. Be careful to avoid resetting
274 // cl_timestamp, which may disturb time-based lists on some sites.
275 // @todo This block should be killed, it's duplicating code
276 // from LinksUpdate::getCategoryInsertions() and friends.
277 $prefixes = $dbw->select(
278 'categorylinks',
279 [ 'cl_sortkey_prefix', 'cl_to' ],
280 [ 'cl_from' => $pageid ],
281 __METHOD__
283 if ( $this->newTitle->getNamespace() == NS_CATEGORY ) {
284 $type = 'subcat';
285 } elseif ( $this->newTitle->getNamespace() == NS_FILE ) {
286 $type = 'file';
287 } else {
288 $type = 'page';
290 foreach ( $prefixes as $prefixRow ) {
291 $prefix = $prefixRow->cl_sortkey_prefix;
292 $catTo = $prefixRow->cl_to;
293 $dbw->update( 'categorylinks',
295 'cl_sortkey' => Collation::singleton()->getSortKey(
296 $this->newTitle->getCategorySortkey( $prefix ) ),
297 'cl_collation' => $wgCategoryCollation,
298 'cl_type' => $type,
299 'cl_timestamp=cl_timestamp' ],
301 'cl_from' => $pageid,
302 'cl_to' => $catTo ],
303 __METHOD__
307 $redirid = $this->oldTitle->getArticleID();
309 if ( $protected ) {
310 # Protect the redirect title as the title used to be...
311 $res = $dbw->select(
312 'page_restrictions',
313 '*',
314 [ 'pr_page' => $pageid ],
315 __METHOD__,
316 'FOR UPDATE'
318 $rowsInsert = [];
319 foreach ( $res as $row ) {
320 $rowsInsert[] = [
321 'pr_page' => $redirid,
322 'pr_type' => $row->pr_type,
323 'pr_level' => $row->pr_level,
324 'pr_cascade' => $row->pr_cascade,
325 'pr_user' => $row->pr_user,
326 'pr_expiry' => $row->pr_expiry
329 $dbw->insert( 'page_restrictions', $rowsInsert, __METHOD__, [ 'IGNORE' ] );
331 // Build comment for log
332 $comment = wfMessage(
333 'prot_1movedto2',
334 $this->oldTitle->getPrefixedText(),
335 $this->newTitle->getPrefixedText()
336 )->inContentLanguage()->text();
337 if ( $reason ) {
338 $comment .= wfMessage( 'colon-separator' )->inContentLanguage()->text() . $reason;
341 // reread inserted pr_ids for log relation
342 $insertedPrIds = $dbw->select(
343 'page_restrictions',
344 'pr_id',
345 [ 'pr_page' => $redirid ],
346 __METHOD__
348 $logRelationsValues = [];
349 foreach ( $insertedPrIds as $prid ) {
350 $logRelationsValues[] = $prid->pr_id;
353 // Update the protection log
354 $logEntry = new ManualLogEntry( 'protect', 'move_prot' );
355 $logEntry->setTarget( $this->newTitle );
356 $logEntry->setComment( $comment );
357 $logEntry->setPerformer( $user );
358 $logEntry->setParameters( [
359 '4::oldtitle' => $this->oldTitle->getPrefixedText(),
360 ] );
361 $logEntry->setRelations( [ 'pr_id' => $logRelationsValues ] );
362 $logEntry->setTags( $changeTags );
363 $logId = $logEntry->insert();
364 $logEntry->publish( $logId );
367 // Update *_from_namespace fields as needed
368 if ( $this->oldTitle->getNamespace() != $this->newTitle->getNamespace() ) {
369 $dbw->update( 'pagelinks',
370 [ 'pl_from_namespace' => $this->newTitle->getNamespace() ],
371 [ 'pl_from' => $pageid ],
372 __METHOD__
374 $dbw->update( 'templatelinks',
375 [ 'tl_from_namespace' => $this->newTitle->getNamespace() ],
376 [ 'tl_from' => $pageid ],
377 __METHOD__
379 $dbw->update( 'imagelinks',
380 [ 'il_from_namespace' => $this->newTitle->getNamespace() ],
381 [ 'il_from' => $pageid ],
382 __METHOD__
386 # Update watchlists
387 $oldtitle = $this->oldTitle->getDBkey();
388 $newtitle = $this->newTitle->getDBkey();
389 $oldsnamespace = MWNamespace::getSubject( $this->oldTitle->getNamespace() );
390 $newsnamespace = MWNamespace::getSubject( $this->newTitle->getNamespace() );
391 if ( $oldsnamespace != $newsnamespace || $oldtitle != $newtitle ) {
392 $store = MediaWikiServices::getInstance()->getWatchedItemStore();
393 $store->duplicateAllAssociatedEntries( $this->oldTitle, $this->newTitle );
396 Hooks::run(
397 'TitleMoveCompleting',
398 [ $this->oldTitle, $this->newTitle,
399 $user, $pageid, $redirid, $reason, $nullRevision ]
402 $dbw->endAtomic( __METHOD__ );
404 $params = [
405 &$this->oldTitle,
406 &$this->newTitle,
407 &$user,
408 $pageid,
409 $redirid,
410 $reason,
411 $nullRevision
413 // Keep each single hook handler atomic
414 DeferredUpdates::addUpdate(
415 new AtomicSectionUpdate(
416 $dbw,
417 __METHOD__,
418 function () use ( $params ) {
419 Hooks::run( 'TitleMoveComplete', $params );
424 return Status::newGood();
428 * Move page to a title which is either a redirect to the
429 * source page or nonexistent
431 * @todo This was basically directly moved from Title, it should be split into
432 * smaller functions
433 * @param User $user the User doing the move
434 * @param Title $nt The page to move to, which should be a redirect or non-existent
435 * @param string $reason The reason for the move
436 * @param bool $createRedirect Whether to leave a redirect at the old title. Does not check
437 * if the user has the suppressredirect right
438 * @param string[] $changeTags Change tags to apply to the entry in the move log
439 * @return Revision the revision created by the move
440 * @throws MWException
442 private function moveToInternal( User $user, &$nt, $reason = '', $createRedirect = true,
443 array $changeTags = [] ) {
445 global $wgContLang;
446 if ( $nt->exists() ) {
447 $moveOverRedirect = true;
448 $logType = 'move_redir';
449 } else {
450 $moveOverRedirect = false;
451 $logType = 'move';
454 if ( $moveOverRedirect ) {
455 $overwriteMessage = wfMessage(
456 'delete_and_move_reason',
457 $this->oldTitle->getPrefixedText()
458 )->text();
459 $newpage = WikiPage::factory( $nt );
460 $errs = [];
461 $status = $newpage->doDeleteArticleReal(
462 $overwriteMessage,
463 /* $suppress */ false,
464 $nt->getArticleID(),
465 /* $commit */ false,
466 $errs,
467 $user,
468 $changeTags,
469 'delete_redir'
472 if ( !$status->isGood() ) {
473 throw new MWException( 'Failed to delete page-move revision: ' . $status );
476 $nt->resetArticleID( false );
479 if ( $createRedirect ) {
480 if ( $this->oldTitle->getNamespace() == NS_CATEGORY
481 && !wfMessage( 'category-move-redirect-override' )->inContentLanguage()->isDisabled()
483 $redirectContent = new WikitextContent(
484 wfMessage( 'category-move-redirect-override' )
485 ->params( $nt->getPrefixedText() )->inContentLanguage()->plain() );
486 } else {
487 $contentHandler = ContentHandler::getForTitle( $this->oldTitle );
488 $redirectContent = $contentHandler->makeRedirectContent( $nt,
489 wfMessage( 'move-redirect-text' )->inContentLanguage()->plain() );
492 // NOTE: If this page's content model does not support redirects, $redirectContent will be null.
493 } else {
494 $redirectContent = null;
497 // Figure out whether the content model is no longer the default
498 $oldDefault = ContentHandler::getDefaultModelFor( $this->oldTitle );
499 $contentModel = $this->oldTitle->getContentModel();
500 $newDefault = ContentHandler::getDefaultModelFor( $nt );
501 $defaultContentModelChanging = ( $oldDefault !== $newDefault
502 && $oldDefault === $contentModel );
504 // bug 57084: log_page should be the ID of the *moved* page
505 $oldid = $this->oldTitle->getArticleID();
506 $logTitle = clone $this->oldTitle;
508 $logEntry = new ManualLogEntry( 'move', $logType );
509 $logEntry->setPerformer( $user );
510 $logEntry->setTarget( $logTitle );
511 $logEntry->setComment( $reason );
512 $logEntry->setParameters( [
513 '4::target' => $nt->getPrefixedText(),
514 '5::noredir' => $redirectContent ? '0': '1',
515 ] );
517 $formatter = LogFormatter::newFromEntry( $logEntry );
518 $formatter->setContext( RequestContext::newExtraneousContext( $this->oldTitle ) );
519 $comment = $formatter->getPlainActionText();
520 if ( $reason ) {
521 $comment .= wfMessage( 'colon-separator' )->inContentLanguage()->text() . $reason;
523 # Truncate for whole multibyte characters.
524 $comment = $wgContLang->truncate( $comment, 255 );
526 $dbw = wfGetDB( DB_MASTER );
528 $oldpage = WikiPage::factory( $this->oldTitle );
529 $oldcountable = $oldpage->isCountable();
531 $newpage = WikiPage::factory( $nt );
533 # Save a null revision in the page's history notifying of the move
534 $nullRevision = Revision::newNullRevision( $dbw, $oldid, $comment, true, $user );
535 if ( !is_object( $nullRevision ) ) {
536 throw new MWException( 'No valid null revision produced in ' . __METHOD__ );
539 $nullRevId = $nullRevision->insertOn( $dbw );
540 $logEntry->setAssociatedRevId( $nullRevId );
542 # Change the name of the target page:
543 $dbw->update( 'page',
544 /* SET */ [
545 'page_namespace' => $nt->getNamespace(),
546 'page_title' => $nt->getDBkey(),
548 /* WHERE */ [ 'page_id' => $oldid ],
549 __METHOD__
552 if ( !$redirectContent ) {
553 // Clean up the old title *before* reset article id - bug 45348
554 WikiPage::onArticleDelete( $this->oldTitle );
557 $this->oldTitle->resetArticleID( 0 ); // 0 == non existing
558 $nt->resetArticleID( $oldid );
559 $newpage->loadPageData( WikiPage::READ_LOCKING ); // bug 46397
561 $newpage->updateRevisionOn( $dbw, $nullRevision );
563 Hooks::run( 'NewRevisionFromEditComplete',
564 [ $newpage, $nullRevision, $nullRevision->getParentId(), $user ] );
566 $newpage->doEditUpdates( $nullRevision, $user,
567 [ 'changed' => false, 'moved' => true, 'oldcountable' => $oldcountable ] );
569 // If the default content model changes, we need to populate rev_content_model
570 if ( $defaultContentModelChanging ) {
571 $dbw->update(
572 'revision',
573 [ 'rev_content_model' => $contentModel ],
574 [ 'rev_page' => $nt->getArticleID(), 'rev_content_model IS NULL' ],
575 __METHOD__
579 WikiPage::onArticleCreate( $nt );
581 # Recreate the redirect, this time in the other direction.
582 if ( $redirectContent ) {
583 $redirectArticle = WikiPage::factory( $this->oldTitle );
584 $redirectArticle->loadFromRow( false, WikiPage::READ_LOCKING ); // bug 46397
585 $newid = $redirectArticle->insertOn( $dbw );
586 if ( $newid ) { // sanity
587 $this->oldTitle->resetArticleID( $newid );
588 $redirectRevision = new Revision( [
589 'title' => $this->oldTitle, // for determining the default content model
590 'page' => $newid,
591 'user_text' => $user->getName(),
592 'user' => $user->getId(),
593 'comment' => $comment,
594 'content' => $redirectContent ] );
595 $redirectRevId = $redirectRevision->insertOn( $dbw );
596 $redirectArticle->updateRevisionOn( $dbw, $redirectRevision, 0 );
598 Hooks::run( 'NewRevisionFromEditComplete',
599 [ $redirectArticle, $redirectRevision, false, $user ] );
601 $redirectArticle->doEditUpdates( $redirectRevision, $user, [ 'created' => true ] );
603 ChangeTags::addTags( $changeTags, null, $redirectRevId, null );
607 # Log the move
608 $logid = $logEntry->insert();
610 $logEntry->setTags( $changeTags );
611 $logEntry->publish( $logid );
613 return $nullRevision;