Merge "Improve docs for Title::getInternalURL/getCanonicalURL"
[lhc/web/wiklou.git] / includes / MovePage.php
1 <?php
2
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.
8 *
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.
13 *
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
18 *
19 * @file
20 */
21
22 use MediaWiki\MediaWikiServices;
23 use MediaWiki\Revision\SlotRecord;
24 use Wikimedia\Rdbms\IDatabase;
25
26 /**
27 * Handles the backend logic of moving a page from one title
28 * to another.
29 *
30 * @since 1.24
31 */
32 class MovePage {
33
34 /**
35 * @var Title
36 */
37 protected $oldTitle;
38
39 /**
40 * @var Title
41 */
42 protected $newTitle;
43
44 public function __construct( Title $oldTitle, Title $newTitle ) {
45 $this->oldTitle = $oldTitle;
46 $this->newTitle = $newTitle;
47 }
48
49 public function checkPermissions( User $user, $reason ) {
50 $status = new Status();
51
52 $errors = wfMergeErrorArrays(
53 $this->oldTitle->getUserPermissionsErrors( 'move', $user ),
54 $this->oldTitle->getUserPermissionsErrors( 'edit', $user ),
55 $this->newTitle->getUserPermissionsErrors( 'move-target', $user ),
56 $this->newTitle->getUserPermissionsErrors( 'edit', $user )
57 );
58
59 // Convert into a Status object
60 if ( $errors ) {
61 foreach ( $errors as $error ) {
62 $status->fatal( ...$error );
63 }
64 }
65
66 if ( EditPage::matchSummarySpamRegex( $reason ) !== false ) {
67 // This is kind of lame, won't display nice
68 $status->fatal( 'spamprotectiontext' );
69 }
70
71 $tp = $this->newTitle->getTitleProtection();
72 if ( $tp !== false && !$user->isAllowed( $tp['permission'] ) ) {
73 $status->fatal( 'cantmove-titleprotected' );
74 }
75
76 Hooks::run( 'MovePageCheckPermissions',
77 [ $this->oldTitle, $this->newTitle, $user, $reason, $status ]
78 );
79
80 return $status;
81 }
82
83 /**
84 * Does various sanity checks that the move is
85 * valid. Only things based on the two titles
86 * should be checked here.
87 *
88 * @return Status
89 */
90 public function isValidMove() {
91 global $wgContentHandlerUseDB;
92 $status = new Status();
93
94 if ( $this->oldTitle->equals( $this->newTitle ) ) {
95 $status->fatal( 'selfmove' );
96 }
97 if ( !$this->oldTitle->isMovable() ) {
98 $status->fatal( 'immobile-source-namespace', $this->oldTitle->getNsText() );
99 }
100 if ( $this->newTitle->isExternal() ) {
101 $status->fatal( 'immobile-target-namespace-iw' );
102 }
103 if ( !$this->newTitle->isMovable() ) {
104 $status->fatal( 'immobile-target-namespace', $this->newTitle->getNsText() );
105 }
106
107 $oldid = $this->oldTitle->getArticleID();
108
109 if ( $this->newTitle->getDBkey() === '' ) {
110 $status->fatal( 'articleexists' );
111 }
112 if (
113 ( $this->oldTitle->getDBkey() == '' ) ||
114 ( !$oldid ) ||
115 ( $this->newTitle->getDBkey() == '' )
116 ) {
117 $status->fatal( 'badarticleerror' );
118 }
119
120 # The move is allowed only if (1) the target doesn't exist, or
121 # (2) the target is a redirect to the source, and has no history
122 # (so we can undo bad moves right after they're done).
123 if ( $this->newTitle->getArticleID() && !$this->isValidMoveTarget() ) {
124 $status->fatal( 'articleexists' );
125 }
126
127 // Content model checks
128 if ( !$wgContentHandlerUseDB &&
129 $this->oldTitle->getContentModel() !== $this->newTitle->getContentModel() ) {
130 // can't move a page if that would change the page's content model
131 $status->fatal(
132 'bad-target-model',
133 ContentHandler::getLocalizedName( $this->oldTitle->getContentModel() ),
134 ContentHandler::getLocalizedName( $this->newTitle->getContentModel() )
135 );
136 } elseif (
137 !ContentHandler::getForTitle( $this->oldTitle )->canBeUsedOn( $this->newTitle )
138 ) {
139 $status->fatal(
140 'content-not-allowed-here',
141 ContentHandler::getLocalizedName( $this->oldTitle->getContentModel() ),
142 $this->newTitle->getPrefixedText(),
143 SlotRecord::MAIN
144 );
145 }
146
147 // Image-specific checks
148 if ( $this->oldTitle->inNamespace( NS_FILE ) ) {
149 $status->merge( $this->isValidFileMove() );
150 }
151
152 if ( $this->newTitle->inNamespace( NS_FILE ) && !$this->oldTitle->inNamespace( NS_FILE ) ) {
153 $status->fatal( 'nonfile-cannot-move-to-file' );
154 }
155
156 // Hook for extensions to say a title can't be moved for technical reasons
157 Hooks::run( 'MovePageIsValidMove', [ $this->oldTitle, $this->newTitle, $status ] );
158
159 return $status;
160 }
161
162 /**
163 * Sanity checks for when a file is being moved
164 *
165 * @return Status
166 */
167 protected function isValidFileMove() {
168 $status = new Status();
169 $file = wfLocalFile( $this->oldTitle );
170 $file->load( File::READ_LATEST );
171 if ( $file->exists() ) {
172 if ( $this->newTitle->getText() != wfStripIllegalFilenameChars( $this->newTitle->getText() ) ) {
173 $status->fatal( 'imageinvalidfilename' );
174 }
175 if ( !File::checkExtensionCompatibility( $file, $this->newTitle->getDBkey() ) ) {
176 $status->fatal( 'imagetypemismatch' );
177 }
178 }
179
180 if ( !$this->newTitle->inNamespace( NS_FILE ) ) {
181 $status->fatal( 'imagenocrossnamespace' );
182 }
183
184 return $status;
185 }
186
187 /**
188 * Checks if $this can be moved to a given Title
189 * - Selects for update, so don't call it unless you mean business
190 *
191 * @since 1.25
192 * @return bool
193 */
194 protected function isValidMoveTarget() {
195 # Is it an existing file?
196 if ( $this->newTitle->inNamespace( NS_FILE ) ) {
197 $file = wfLocalFile( $this->newTitle );
198 $file->load( File::READ_LATEST );
199 if ( $file->exists() ) {
200 wfDebug( __METHOD__ . ": file exists\n" );
201 return false;
202 }
203 }
204 # Is it a redirect with no history?
205 if ( !$this->newTitle->isSingleRevRedirect() ) {
206 wfDebug( __METHOD__ . ": not a one-rev redirect\n" );
207 return false;
208 }
209 # Get the article text
210 $rev = Revision::newFromTitle( $this->newTitle, false, Revision::READ_LATEST );
211 if ( !is_object( $rev ) ) {
212 return false;
213 }
214 $content = $rev->getContent();
215 # Does the redirect point to the source?
216 # Or is it a broken self-redirect, usually caused by namespace collisions?
217 $redirTitle = $content ? $content->getRedirectTarget() : null;
218
219 if ( $redirTitle ) {
220 if ( $redirTitle->getPrefixedDBkey() !== $this->oldTitle->getPrefixedDBkey() &&
221 $redirTitle->getPrefixedDBkey() !== $this->newTitle->getPrefixedDBkey() ) {
222 wfDebug( __METHOD__ . ": redirect points to other page\n" );
223 return false;
224 } else {
225 return true;
226 }
227 } else {
228 # Fail safe (not a redirect after all. strange.)
229 wfDebug( __METHOD__ . ": failsafe: database says " . $this->newTitle->getPrefixedDBkey() .
230 " is a redirect, but it doesn't contain a valid redirect.\n" );
231 return false;
232 }
233 }
234
235 /**
236 * @param User $user
237 * @param string $reason
238 * @param bool $createRedirect
239 * @param string[] $changeTags Change tags to apply to the entry in the move log. Caller
240 * should perform permission checks with ChangeTags::canAddTagsAccompanyingChange
241 * @return Status
242 */
243 public function move( User $user, $reason, $createRedirect, array $changeTags = [] ) {
244 global $wgCategoryCollation;
245
246 $status = Status::newGood();
247 Hooks::run( 'TitleMove', [ $this->oldTitle, $this->newTitle, $user, $reason, &$status ] );
248 if ( !$status->isOK() ) {
249 // Move was aborted by the hook
250 return $status;
251 }
252
253 $dbw = wfGetDB( DB_MASTER );
254 $dbw->startAtomic( __METHOD__, IDatabase::ATOMIC_CANCELABLE );
255
256 Hooks::run( 'TitleMoveStarting', [ $this->oldTitle, $this->newTitle, $user ] );
257
258 $pageid = $this->oldTitle->getArticleID( Title::GAID_FOR_UPDATE );
259 $protected = $this->oldTitle->isProtected();
260
261 // Do the actual move; if this fails, it will throw an MWException(!)
262 $nullRevision = $this->moveToInternal( $user, $this->newTitle, $reason, $createRedirect,
263 $changeTags );
264
265 // Refresh the sortkey for this row. Be careful to avoid resetting
266 // cl_timestamp, which may disturb time-based lists on some sites.
267 // @todo This block should be killed, it's duplicating code
268 // from LinksUpdate::getCategoryInsertions() and friends.
269 $prefixes = $dbw->select(
270 'categorylinks',
271 [ 'cl_sortkey_prefix', 'cl_to' ],
272 [ 'cl_from' => $pageid ],
273 __METHOD__
274 );
275 $type = MWNamespace::getCategoryLinkType( $this->newTitle->getNamespace() );
276 foreach ( $prefixes as $prefixRow ) {
277 $prefix = $prefixRow->cl_sortkey_prefix;
278 $catTo = $prefixRow->cl_to;
279 $dbw->update( 'categorylinks',
280 [
281 'cl_sortkey' => Collation::singleton()->getSortKey(
282 $this->newTitle->getCategorySortkey( $prefix ) ),
283 'cl_collation' => $wgCategoryCollation,
284 'cl_type' => $type,
285 'cl_timestamp=cl_timestamp' ],
286 [
287 'cl_from' => $pageid,
288 'cl_to' => $catTo ],
289 __METHOD__
290 );
291 }
292
293 $redirid = $this->oldTitle->getArticleID();
294
295 if ( $protected ) {
296 # Protect the redirect title as the title used to be...
297 $res = $dbw->select(
298 'page_restrictions',
299 [ 'pr_type', 'pr_level', 'pr_cascade', 'pr_user', 'pr_expiry' ],
300 [ 'pr_page' => $pageid ],
301 __METHOD__,
302 'FOR UPDATE'
303 );
304 $rowsInsert = [];
305 foreach ( $res as $row ) {
306 $rowsInsert[] = [
307 'pr_page' => $redirid,
308 'pr_type' => $row->pr_type,
309 'pr_level' => $row->pr_level,
310 'pr_cascade' => $row->pr_cascade,
311 'pr_user' => $row->pr_user,
312 'pr_expiry' => $row->pr_expiry
313 ];
314 }
315 $dbw->insert( 'page_restrictions', $rowsInsert, __METHOD__, [ 'IGNORE' ] );
316
317 // Build comment for log
318 $comment = wfMessage(
319 'prot_1movedto2',
320 $this->oldTitle->getPrefixedText(),
321 $this->newTitle->getPrefixedText()
322 )->inContentLanguage()->text();
323 if ( $reason ) {
324 $comment .= wfMessage( 'colon-separator' )->inContentLanguage()->text() . $reason;
325 }
326
327 // reread inserted pr_ids for log relation
328 $insertedPrIds = $dbw->select(
329 'page_restrictions',
330 'pr_id',
331 [ 'pr_page' => $redirid ],
332 __METHOD__
333 );
334 $logRelationsValues = [];
335 foreach ( $insertedPrIds as $prid ) {
336 $logRelationsValues[] = $prid->pr_id;
337 }
338
339 // Update the protection log
340 $logEntry = new ManualLogEntry( 'protect', 'move_prot' );
341 $logEntry->setTarget( $this->newTitle );
342 $logEntry->setComment( $comment );
343 $logEntry->setPerformer( $user );
344 $logEntry->setParameters( [
345 '4::oldtitle' => $this->oldTitle->getPrefixedText(),
346 ] );
347 $logEntry->setRelations( [ 'pr_id' => $logRelationsValues ] );
348 $logEntry->setTags( $changeTags );
349 $logId = $logEntry->insert();
350 $logEntry->publish( $logId );
351 }
352
353 // Update *_from_namespace fields as needed
354 if ( $this->oldTitle->getNamespace() != $this->newTitle->getNamespace() ) {
355 $dbw->update( 'pagelinks',
356 [ 'pl_from_namespace' => $this->newTitle->getNamespace() ],
357 [ 'pl_from' => $pageid ],
358 __METHOD__
359 );
360 $dbw->update( 'templatelinks',
361 [ 'tl_from_namespace' => $this->newTitle->getNamespace() ],
362 [ 'tl_from' => $pageid ],
363 __METHOD__
364 );
365 $dbw->update( 'imagelinks',
366 [ 'il_from_namespace' => $this->newTitle->getNamespace() ],
367 [ 'il_from' => $pageid ],
368 __METHOD__
369 );
370 }
371
372 # Update watchlists
373 $oldtitle = $this->oldTitle->getDBkey();
374 $newtitle = $this->newTitle->getDBkey();
375 $oldsnamespace = MWNamespace::getSubject( $this->oldTitle->getNamespace() );
376 $newsnamespace = MWNamespace::getSubject( $this->newTitle->getNamespace() );
377 if ( $oldsnamespace != $newsnamespace || $oldtitle != $newtitle ) {
378 $store = MediaWikiServices::getInstance()->getWatchedItemStore();
379 $store->duplicateAllAssociatedEntries( $this->oldTitle, $this->newTitle );
380 }
381
382 // If it is a file then move it last.
383 // This is done after all database changes so that file system errors cancel the transaction.
384 if ( $this->oldTitle->getNamespace() == NS_FILE ) {
385 $status = $this->moveFile( $this->oldTitle, $this->newTitle );
386 if ( !$status->isOK() ) {
387 $dbw->cancelAtomic( __METHOD__ );
388 return $status;
389 }
390 }
391
392 Hooks::run(
393 'TitleMoveCompleting',
394 [ $this->oldTitle, $this->newTitle,
395 $user, $pageid, $redirid, $reason, $nullRevision ]
396 );
397
398 $dbw->endAtomic( __METHOD__ );
399
400 $params = [
401 &$this->oldTitle,
402 &$this->newTitle,
403 &$user,
404 $pageid,
405 $redirid,
406 $reason,
407 $nullRevision
408 ];
409 // Keep each single hook handler atomic
410 DeferredUpdates::addUpdate(
411 new AtomicSectionUpdate(
412 $dbw,
413 __METHOD__,
414 // Hold onto $user to avoid HHVM bug where it no longer
415 // becomes a reference (T118683)
416 function () use ( $params, &$user ) {
417 Hooks::run( 'TitleMoveComplete', $params );
418 }
419 )
420 );
421
422 return Status::newGood();
423 }
424
425 /**
426 * Move a file associated with a page to a new location.
427 * Can also be used to revert after a DB failure.
428 *
429 * @private
430 * @param Title $oldTitle Old location to move the file from.
431 * @param Title $newTitle New location to move the file to.
432 * @return Status
433 */
434 private function moveFile( $oldTitle, $newTitle ) {
435 $status = Status::newFatal(
436 'cannotdelete',
437 $oldTitle->getPrefixedText()
438 );
439
440 $file = wfLocalFile( $oldTitle );
441 $file->load( File::READ_LATEST );
442 if ( $file->exists() ) {
443 $status = $file->move( $newTitle );
444 }
445
446 // Clear RepoGroup process cache
447 RepoGroup::singleton()->clearCache( $oldTitle );
448 RepoGroup::singleton()->clearCache( $newTitle ); # clear false negative cache
449 return $status;
450 }
451
452 /**
453 * Move page to a title which is either a redirect to the
454 * source page or nonexistent
455 *
456 * @todo This was basically directly moved from Title, it should be split into
457 * smaller functions
458 * @param User $user the User doing the move
459 * @param Title $nt The page to move to, which should be a redirect or non-existent
460 * @param string $reason The reason for the move
461 * @param bool $createRedirect Whether to leave a redirect at the old title. Does not check
462 * if the user has the suppressredirect right
463 * @param string[] $changeTags Change tags to apply to the entry in the move log
464 * @return Revision the revision created by the move
465 * @throws MWException
466 */
467 private function moveToInternal( User $user, &$nt, $reason = '', $createRedirect = true,
468 array $changeTags = []
469 ) {
470 if ( $nt->exists() ) {
471 $moveOverRedirect = true;
472 $logType = 'move_redir';
473 } else {
474 $moveOverRedirect = false;
475 $logType = 'move';
476 }
477
478 if ( $moveOverRedirect ) {
479 $overwriteMessage = wfMessage(
480 'delete_and_move_reason',
481 $this->oldTitle->getPrefixedText()
482 )->inContentLanguage()->text();
483 $newpage = WikiPage::factory( $nt );
484 $errs = [];
485 $status = $newpage->doDeleteArticleReal(
486 $overwriteMessage,
487 /* $suppress */ false,
488 $nt->getArticleID(),
489 /* $commit */ false,
490 $errs,
491 $user,
492 $changeTags,
493 'delete_redir'
494 );
495
496 if ( !$status->isGood() ) {
497 throw new MWException( 'Failed to delete page-move revision: '
498 . $status->getWikiText( false, false, 'en' ) );
499 }
500
501 $nt->resetArticleID( false );
502 }
503
504 if ( $createRedirect ) {
505 if ( $this->oldTitle->getNamespace() == NS_CATEGORY
506 && !wfMessage( 'category-move-redirect-override' )->inContentLanguage()->isDisabled()
507 ) {
508 $redirectContent = new WikitextContent(
509 wfMessage( 'category-move-redirect-override' )
510 ->params( $nt->getPrefixedText() )->inContentLanguage()->plain() );
511 } else {
512 $contentHandler = ContentHandler::getForTitle( $this->oldTitle );
513 $redirectContent = $contentHandler->makeRedirectContent( $nt,
514 wfMessage( 'move-redirect-text' )->inContentLanguage()->plain() );
515 }
516
517 // NOTE: If this page's content model does not support redirects, $redirectContent will be null.
518 } else {
519 $redirectContent = null;
520 }
521
522 // Figure out whether the content model is no longer the default
523 $oldDefault = ContentHandler::getDefaultModelFor( $this->oldTitle );
524 $contentModel = $this->oldTitle->getContentModel();
525 $newDefault = ContentHandler::getDefaultModelFor( $nt );
526 $defaultContentModelChanging = ( $oldDefault !== $newDefault
527 && $oldDefault === $contentModel );
528
529 // T59084: log_page should be the ID of the *moved* page
530 $oldid = $this->oldTitle->getArticleID();
531 $logTitle = clone $this->oldTitle;
532
533 $logEntry = new ManualLogEntry( 'move', $logType );
534 $logEntry->setPerformer( $user );
535 $logEntry->setTarget( $logTitle );
536 $logEntry->setComment( $reason );
537 $logEntry->setParameters( [
538 '4::target' => $nt->getPrefixedText(),
539 '5::noredir' => $redirectContent ? '0' : '1',
540 ] );
541
542 $formatter = LogFormatter::newFromEntry( $logEntry );
543 $formatter->setContext( RequestContext::newExtraneousContext( $this->oldTitle ) );
544 $comment = $formatter->getPlainActionText();
545 if ( $reason ) {
546 $comment .= wfMessage( 'colon-separator' )->inContentLanguage()->text() . $reason;
547 }
548
549 $dbw = wfGetDB( DB_MASTER );
550
551 $oldpage = WikiPage::factory( $this->oldTitle );
552 $oldcountable = $oldpage->isCountable();
553
554 $newpage = WikiPage::factory( $nt );
555
556 # Change the name of the target page:
557 $dbw->update( 'page',
558 /* SET */ [
559 'page_namespace' => $nt->getNamespace(),
560 'page_title' => $nt->getDBkey(),
561 ],
562 /* WHERE */ [ 'page_id' => $oldid ],
563 __METHOD__
564 );
565
566 # Save a null revision in the page's history notifying of the move
567 $nullRevision = Revision::newNullRevision( $dbw, $oldid, $comment, true, $user );
568 if ( !is_object( $nullRevision ) ) {
569 throw new MWException( 'Failed to create null revision while moving page ID '
570 . $oldid . ' to ' . $nt->getPrefixedDBkey() );
571 }
572
573 $nullRevId = $nullRevision->insertOn( $dbw );
574 $logEntry->setAssociatedRevId( $nullRevId );
575
576 /**
577 * T163966
578 * Increment user_editcount during page moves
579 * Moved from SpecialMovepage.php per T195550
580 */
581 $user->incEditCount();
582
583 if ( !$redirectContent ) {
584 // Clean up the old title *before* reset article id - T47348
585 WikiPage::onArticleDelete( $this->oldTitle );
586 }
587
588 $this->oldTitle->resetArticleID( 0 ); // 0 == non existing
589 $nt->resetArticleID( $oldid );
590 $newpage->loadPageData( WikiPage::READ_LOCKING ); // T48397
591
592 $newpage->updateRevisionOn( $dbw, $nullRevision );
593
594 Hooks::run( 'NewRevisionFromEditComplete',
595 [ $newpage, $nullRevision, $nullRevision->getParentId(), $user ] );
596
597 $newpage->doEditUpdates( $nullRevision, $user,
598 [ 'changed' => false, 'moved' => true, 'oldcountable' => $oldcountable ] );
599
600 // If the default content model changes, we need to populate rev_content_model
601 if ( $defaultContentModelChanging ) {
602 $dbw->update(
603 'revision',
604 [ 'rev_content_model' => $contentModel ],
605 [ 'rev_page' => $nt->getArticleID(), 'rev_content_model IS NULL' ],
606 __METHOD__
607 );
608 }
609
610 WikiPage::onArticleCreate( $nt );
611
612 # Recreate the redirect, this time in the other direction.
613 if ( $redirectContent ) {
614 $redirectArticle = WikiPage::factory( $this->oldTitle );
615 $redirectArticle->loadFromRow( false, WikiPage::READ_LOCKING ); // T48397
616 $newid = $redirectArticle->insertOn( $dbw );
617 if ( $newid ) { // sanity
618 $this->oldTitle->resetArticleID( $newid );
619 $redirectRevision = new Revision( [
620 'title' => $this->oldTitle, // for determining the default content model
621 'page' => $newid,
622 'user_text' => $user->getName(),
623 'user' => $user->getId(),
624 'comment' => $comment,
625 'content' => $redirectContent ] );
626 $redirectRevId = $redirectRevision->insertOn( $dbw );
627 $redirectArticle->updateRevisionOn( $dbw, $redirectRevision, 0 );
628
629 Hooks::run( 'NewRevisionFromEditComplete',
630 [ $redirectArticle, $redirectRevision, false, $user ] );
631
632 $redirectArticle->doEditUpdates( $redirectRevision, $user, [ 'created' => true ] );
633
634 // make a copy because of log entry below
635 $redirectTags = $changeTags;
636 if ( in_array( 'mw-new-redirect', ChangeTags::getSoftwareTags() ) ) {
637 $redirectTags[] = 'mw-new-redirect';
638 }
639 ChangeTags::addTags( $redirectTags, null, $redirectRevId, null );
640 }
641 }
642
643 # Log the move
644 $logid = $logEntry->insert();
645
646 $logEntry->setTags( $changeTags );
647 $logEntry->publish( $logid );
648
649 return $nullRevision;
650 }
651 }