Split parser related files to have one class in one file
[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 = MediaWikiServices::getInstance()->getNamespaceInfo()->
276 getCategoryLinkType( $this->newTitle->getNamespace() );
277 foreach ( $prefixes as $prefixRow ) {
278 $prefix = $prefixRow->cl_sortkey_prefix;
279 $catTo = $prefixRow->cl_to;
280 $dbw->update( 'categorylinks',
281 [
282 'cl_sortkey' => Collation::singleton()->getSortKey(
283 $this->newTitle->getCategorySortkey( $prefix ) ),
284 'cl_collation' => $wgCategoryCollation,
285 'cl_type' => $type,
286 'cl_timestamp=cl_timestamp' ],
287 [
288 'cl_from' => $pageid,
289 'cl_to' => $catTo ],
290 __METHOD__
291 );
292 }
293
294 $redirid = $this->oldTitle->getArticleID();
295
296 if ( $protected ) {
297 # Protect the redirect title as the title used to be...
298 $res = $dbw->select(
299 'page_restrictions',
300 [ 'pr_type', 'pr_level', 'pr_cascade', 'pr_user', 'pr_expiry' ],
301 [ 'pr_page' => $pageid ],
302 __METHOD__,
303 'FOR UPDATE'
304 );
305 $rowsInsert = [];
306 foreach ( $res as $row ) {
307 $rowsInsert[] = [
308 'pr_page' => $redirid,
309 'pr_type' => $row->pr_type,
310 'pr_level' => $row->pr_level,
311 'pr_cascade' => $row->pr_cascade,
312 'pr_user' => $row->pr_user,
313 'pr_expiry' => $row->pr_expiry
314 ];
315 }
316 $dbw->insert( 'page_restrictions', $rowsInsert, __METHOD__, [ 'IGNORE' ] );
317
318 // Build comment for log
319 $comment = wfMessage(
320 'prot_1movedto2',
321 $this->oldTitle->getPrefixedText(),
322 $this->newTitle->getPrefixedText()
323 )->inContentLanguage()->text();
324 if ( $reason ) {
325 $comment .= wfMessage( 'colon-separator' )->inContentLanguage()->text() . $reason;
326 }
327
328 // reread inserted pr_ids for log relation
329 $insertedPrIds = $dbw->select(
330 'page_restrictions',
331 'pr_id',
332 [ 'pr_page' => $redirid ],
333 __METHOD__
334 );
335 $logRelationsValues = [];
336 foreach ( $insertedPrIds as $prid ) {
337 $logRelationsValues[] = $prid->pr_id;
338 }
339
340 // Update the protection log
341 $logEntry = new ManualLogEntry( 'protect', 'move_prot' );
342 $logEntry->setTarget( $this->newTitle );
343 $logEntry->setComment( $comment );
344 $logEntry->setPerformer( $user );
345 $logEntry->setParameters( [
346 '4::oldtitle' => $this->oldTitle->getPrefixedText(),
347 ] );
348 $logEntry->setRelations( [ 'pr_id' => $logRelationsValues ] );
349 $logEntry->setTags( $changeTags );
350 $logId = $logEntry->insert();
351 $logEntry->publish( $logId );
352 }
353
354 // Update *_from_namespace fields as needed
355 if ( $this->oldTitle->getNamespace() != $this->newTitle->getNamespace() ) {
356 $dbw->update( 'pagelinks',
357 [ 'pl_from_namespace' => $this->newTitle->getNamespace() ],
358 [ 'pl_from' => $pageid ],
359 __METHOD__
360 );
361 $dbw->update( 'templatelinks',
362 [ 'tl_from_namespace' => $this->newTitle->getNamespace() ],
363 [ 'tl_from' => $pageid ],
364 __METHOD__
365 );
366 $dbw->update( 'imagelinks',
367 [ 'il_from_namespace' => $this->newTitle->getNamespace() ],
368 [ 'il_from' => $pageid ],
369 __METHOD__
370 );
371 }
372
373 # Update watchlists
374 $oldtitle = $this->oldTitle->getDBkey();
375 $newtitle = $this->newTitle->getDBkey();
376 $oldsnamespace = MWNamespace::getSubject( $this->oldTitle->getNamespace() );
377 $newsnamespace = MWNamespace::getSubject( $this->newTitle->getNamespace() );
378 if ( $oldsnamespace != $newsnamespace || $oldtitle != $newtitle ) {
379 $store = MediaWikiServices::getInstance()->getWatchedItemStore();
380 $store->duplicateAllAssociatedEntries( $this->oldTitle, $this->newTitle );
381 }
382
383 // If it is a file then move it last.
384 // This is done after all database changes so that file system errors cancel the transaction.
385 if ( $this->oldTitle->getNamespace() == NS_FILE ) {
386 $status = $this->moveFile( $this->oldTitle, $this->newTitle );
387 if ( !$status->isOK() ) {
388 $dbw->cancelAtomic( __METHOD__ );
389 return $status;
390 }
391 }
392
393 Hooks::run(
394 'TitleMoveCompleting',
395 [ $this->oldTitle, $this->newTitle,
396 $user, $pageid, $redirid, $reason, $nullRevision ]
397 );
398
399 $dbw->endAtomic( __METHOD__ );
400
401 $params = [
402 &$this->oldTitle,
403 &$this->newTitle,
404 &$user,
405 $pageid,
406 $redirid,
407 $reason,
408 $nullRevision
409 ];
410 // Keep each single hook handler atomic
411 DeferredUpdates::addUpdate(
412 new AtomicSectionUpdate(
413 $dbw,
414 __METHOD__,
415 // Hold onto $user to avoid HHVM bug where it no longer
416 // becomes a reference (T118683)
417 function () use ( $params, &$user ) {
418 Hooks::run( 'TitleMoveComplete', $params );
419 }
420 )
421 );
422
423 return Status::newGood();
424 }
425
426 /**
427 * Move a file associated with a page to a new location.
428 * Can also be used to revert after a DB failure.
429 *
430 * @private
431 * @param Title $oldTitle Old location to move the file from.
432 * @param Title $newTitle New location to move the file to.
433 * @return Status
434 */
435 private function moveFile( $oldTitle, $newTitle ) {
436 $status = Status::newFatal(
437 'cannotdelete',
438 $oldTitle->getPrefixedText()
439 );
440
441 $file = wfLocalFile( $oldTitle );
442 $file->load( File::READ_LATEST );
443 if ( $file->exists() ) {
444 $status = $file->move( $newTitle );
445 }
446
447 // Clear RepoGroup process cache
448 RepoGroup::singleton()->clearCache( $oldTitle );
449 RepoGroup::singleton()->clearCache( $newTitle ); # clear false negative cache
450 return $status;
451 }
452
453 /**
454 * Move page to a title which is either a redirect to the
455 * source page or nonexistent
456 *
457 * @todo This was basically directly moved from Title, it should be split into
458 * smaller functions
459 * @param User $user the User doing the move
460 * @param Title $nt The page to move to, which should be a redirect or non-existent
461 * @param string $reason The reason for the move
462 * @param bool $createRedirect Whether to leave a redirect at the old title. Does not check
463 * if the user has the suppressredirect right
464 * @param string[] $changeTags Change tags to apply to the entry in the move log
465 * @return Revision the revision created by the move
466 * @throws MWException
467 */
468 private function moveToInternal( User $user, &$nt, $reason = '', $createRedirect = true,
469 array $changeTags = []
470 ) {
471 if ( $nt->exists() ) {
472 $moveOverRedirect = true;
473 $logType = 'move_redir';
474 } else {
475 $moveOverRedirect = false;
476 $logType = 'move';
477 }
478
479 if ( $moveOverRedirect ) {
480 $overwriteMessage = wfMessage(
481 'delete_and_move_reason',
482 $this->oldTitle->getPrefixedText()
483 )->inContentLanguage()->text();
484 $newpage = WikiPage::factory( $nt );
485 $errs = [];
486 $status = $newpage->doDeleteArticleReal(
487 $overwriteMessage,
488 /* $suppress */ false,
489 $nt->getArticleID(),
490 /* $commit */ false,
491 $errs,
492 $user,
493 $changeTags,
494 'delete_redir'
495 );
496
497 if ( !$status->isGood() ) {
498 throw new MWException( 'Failed to delete page-move revision: '
499 . $status->getWikiText( false, false, 'en' ) );
500 }
501
502 $nt->resetArticleID( false );
503 }
504
505 if ( $createRedirect ) {
506 if ( $this->oldTitle->getNamespace() == NS_CATEGORY
507 && !wfMessage( 'category-move-redirect-override' )->inContentLanguage()->isDisabled()
508 ) {
509 $redirectContent = new WikitextContent(
510 wfMessage( 'category-move-redirect-override' )
511 ->params( $nt->getPrefixedText() )->inContentLanguage()->plain() );
512 } else {
513 $contentHandler = ContentHandler::getForTitle( $this->oldTitle );
514 $redirectContent = $contentHandler->makeRedirectContent( $nt,
515 wfMessage( 'move-redirect-text' )->inContentLanguage()->plain() );
516 }
517
518 // NOTE: If this page's content model does not support redirects, $redirectContent will be null.
519 } else {
520 $redirectContent = null;
521 }
522
523 // Figure out whether the content model is no longer the default
524 $oldDefault = ContentHandler::getDefaultModelFor( $this->oldTitle );
525 $contentModel = $this->oldTitle->getContentModel();
526 $newDefault = ContentHandler::getDefaultModelFor( $nt );
527 $defaultContentModelChanging = ( $oldDefault !== $newDefault
528 && $oldDefault === $contentModel );
529
530 // T59084: log_page should be the ID of the *moved* page
531 $oldid = $this->oldTitle->getArticleID();
532 $logTitle = clone $this->oldTitle;
533
534 $logEntry = new ManualLogEntry( 'move', $logType );
535 $logEntry->setPerformer( $user );
536 $logEntry->setTarget( $logTitle );
537 $logEntry->setComment( $reason );
538 $logEntry->setParameters( [
539 '4::target' => $nt->getPrefixedText(),
540 '5::noredir' => $redirectContent ? '0' : '1',
541 ] );
542
543 $formatter = LogFormatter::newFromEntry( $logEntry );
544 $formatter->setContext( RequestContext::newExtraneousContext( $this->oldTitle ) );
545 $comment = $formatter->getPlainActionText();
546 if ( $reason ) {
547 $comment .= wfMessage( 'colon-separator' )->inContentLanguage()->text() . $reason;
548 }
549
550 $dbw = wfGetDB( DB_MASTER );
551
552 $oldpage = WikiPage::factory( $this->oldTitle );
553 $oldcountable = $oldpage->isCountable();
554
555 $newpage = WikiPage::factory( $nt );
556
557 # Change the name of the target page:
558 $dbw->update( 'page',
559 /* SET */ [
560 'page_namespace' => $nt->getNamespace(),
561 'page_title' => $nt->getDBkey(),
562 ],
563 /* WHERE */ [ 'page_id' => $oldid ],
564 __METHOD__
565 );
566
567 # Save a null revision in the page's history notifying of the move
568 $nullRevision = Revision::newNullRevision( $dbw, $oldid, $comment, true, $user );
569 if ( !is_object( $nullRevision ) ) {
570 throw new MWException( 'Failed to create null revision while moving page ID '
571 . $oldid . ' to ' . $nt->getPrefixedDBkey() );
572 }
573
574 $nullRevId = $nullRevision->insertOn( $dbw );
575 $logEntry->setAssociatedRevId( $nullRevId );
576
577 /**
578 * T163966
579 * Increment user_editcount during page moves
580 * Moved from SpecialMovepage.php per T195550
581 */
582 $user->incEditCount();
583
584 if ( !$redirectContent ) {
585 // Clean up the old title *before* reset article id - T47348
586 WikiPage::onArticleDelete( $this->oldTitle );
587 }
588
589 $this->oldTitle->resetArticleID( 0 ); // 0 == non existing
590 $nt->resetArticleID( $oldid );
591 $newpage->loadPageData( WikiPage::READ_LOCKING ); // T48397
592
593 $newpage->updateRevisionOn( $dbw, $nullRevision );
594
595 Hooks::run( 'NewRevisionFromEditComplete',
596 [ $newpage, $nullRevision, $nullRevision->getParentId(), $user ] );
597
598 $newpage->doEditUpdates( $nullRevision, $user,
599 [ 'changed' => false, 'moved' => true, 'oldcountable' => $oldcountable ] );
600
601 // If the default content model changes, we need to populate rev_content_model
602 if ( $defaultContentModelChanging ) {
603 $dbw->update(
604 'revision',
605 [ 'rev_content_model' => $contentModel ],
606 [ 'rev_page' => $nt->getArticleID(), 'rev_content_model IS NULL' ],
607 __METHOD__
608 );
609 }
610
611 WikiPage::onArticleCreate( $nt );
612
613 # Recreate the redirect, this time in the other direction.
614 if ( $redirectContent ) {
615 $redirectArticle = WikiPage::factory( $this->oldTitle );
616 $redirectArticle->loadFromRow( false, WikiPage::READ_LOCKING ); // T48397
617 $newid = $redirectArticle->insertOn( $dbw );
618 if ( $newid ) { // sanity
619 $this->oldTitle->resetArticleID( $newid );
620 $redirectRevision = new Revision( [
621 'title' => $this->oldTitle, // for determining the default content model
622 'page' => $newid,
623 'user_text' => $user->getName(),
624 'user' => $user->getId(),
625 'comment' => $comment,
626 'content' => $redirectContent ] );
627 $redirectRevId = $redirectRevision->insertOn( $dbw );
628 $redirectArticle->updateRevisionOn( $dbw, $redirectRevision, 0 );
629
630 Hooks::run( 'NewRevisionFromEditComplete',
631 [ $redirectArticle, $redirectRevision, false, $user ] );
632
633 $redirectArticle->doEditUpdates( $redirectRevision, $user, [ 'created' => true ] );
634
635 // make a copy because of log entry below
636 $redirectTags = $changeTags;
637 if ( in_array( 'mw-new-redirect', ChangeTags::getSoftwareTags() ) ) {
638 $redirectTags[] = 'mw-new-redirect';
639 }
640 ChangeTags::addTags( $redirectTags, null, $redirectRevId, null );
641 }
642 }
643
644 # Log the move
645 $logid = $logEntry->insert();
646
647 $logEntry->setTags( $changeTags );
648 $logEntry->publish( $logid );
649
650 return $nullRevision;
651 }
652 }