Merge "Implement HTMLTitleTextField with suggestions for non-OOUI forms, too"
[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 /**
23 * Handles the backend logic of moving a page from one title
24 * to another.
25 *
26 * @since 1.24
27 */
28 class MovePage {
29
30 /**
31 * @var Title
32 */
33 protected $oldTitle;
34
35 /**
36 * @var Title
37 */
38 protected $newTitle;
39
40 public function __construct( Title $oldTitle, Title $newTitle ) {
41 $this->oldTitle = $oldTitle;
42 $this->newTitle = $newTitle;
43 }
44
45 public function checkPermissions( User $user, $reason ) {
46 $status = new Status();
47
48 $errors = wfMergeErrorArrays(
49 $this->oldTitle->getUserPermissionsErrors( 'move', $user ),
50 $this->oldTitle->getUserPermissionsErrors( 'edit', $user ),
51 $this->newTitle->getUserPermissionsErrors( 'move-target', $user ),
52 $this->newTitle->getUserPermissionsErrors( 'edit', $user )
53 );
54
55 // Convert into a Status object
56 if ( $errors ) {
57 foreach ( $errors as $error ) {
58 call_user_func_array( [ $status, 'fatal' ], $error );
59 }
60 }
61
62 if ( EditPage::matchSummarySpamRegex( $reason ) !== false ) {
63 // This is kind of lame, won't display nice
64 $status->fatal( 'spamprotectiontext' );
65 }
66
67 $tp = $this->newTitle->getTitleProtection();
68 if ( $tp !== false && !$user->isAllowed( $tp['permission'] ) ) {
69 $status->fatal( 'cantmove-titleprotected' );
70 }
71
72 Hooks::run( 'MovePageCheckPermissions',
73 [ $this->oldTitle, $this->newTitle, $user, $reason, $status ]
74 );
75
76 return $status;
77 }
78
79 /**
80 * Does various sanity checks that the move is
81 * valid. Only things based on the two titles
82 * should be checked here.
83 *
84 * @return Status
85 */
86 public function isValidMove() {
87 global $wgContentHandlerUseDB;
88 $status = new Status();
89
90 if ( $this->oldTitle->equals( $this->newTitle ) ) {
91 $status->fatal( 'selfmove' );
92 }
93 if ( !$this->oldTitle->isMovable() ) {
94 $status->fatal( 'immobile-source-namespace', $this->oldTitle->getNsText() );
95 }
96 if ( $this->newTitle->isExternal() ) {
97 $status->fatal( 'immobile-target-namespace-iw' );
98 }
99 if ( !$this->newTitle->isMovable() ) {
100 $status->fatal( 'immobile-target-namespace', $this->newTitle->getNsText() );
101 }
102
103 $oldid = $this->oldTitle->getArticleID();
104
105 if ( strlen( $this->newTitle->getDBkey() ) < 1 ) {
106 $status->fatal( 'articleexists' );
107 }
108 if (
109 ( $this->oldTitle->getDBkey() == '' ) ||
110 ( !$oldid ) ||
111 ( $this->newTitle->getDBkey() == '' )
112 ) {
113 $status->fatal( 'badarticleerror' );
114 }
115
116 # The move is allowed only if (1) the target doesn't exist, or
117 # (2) the target is a redirect to the source, and has no history
118 # (so we can undo bad moves right after they're done).
119 if ( $this->newTitle->getArticleID() && !$this->isValidMoveTarget() ) {
120 $status->fatal( 'articleexists' );
121 }
122
123 // Content model checks
124 if ( !$wgContentHandlerUseDB &&
125 $this->oldTitle->getContentModel() !== $this->newTitle->getContentModel() ) {
126 // can't move a page if that would change the page's content model
127 $status->fatal(
128 'bad-target-model',
129 ContentHandler::getLocalizedName( $this->oldTitle->getContentModel() ),
130 ContentHandler::getLocalizedName( $this->newTitle->getContentModel() )
131 );
132 }
133
134 // Image-specific checks
135 if ( $this->oldTitle->inNamespace( NS_FILE ) ) {
136 $status->merge( $this->isValidFileMove() );
137 }
138
139 if ( $this->newTitle->inNamespace( NS_FILE ) && !$this->oldTitle->inNamespace( NS_FILE ) ) {
140 $status->fatal( 'nonfile-cannot-move-to-file' );
141 }
142
143 // Hook for extensions to say a title can't be moved for technical reasons
144 Hooks::run( 'MovePageIsValidMove', [ $this->oldTitle, $this->newTitle, $status ] );
145
146 return $status;
147 }
148
149 /**
150 * Sanity checks for when a file is being moved
151 *
152 * @return Status
153 */
154 protected function isValidFileMove() {
155 $status = new Status();
156 $file = wfLocalFile( $this->oldTitle );
157 $file->load( File::READ_LATEST );
158 if ( $file->exists() ) {
159 if ( $this->newTitle->getText() != wfStripIllegalFilenameChars( $this->newTitle->getText() ) ) {
160 $status->fatal( 'imageinvalidfilename' );
161 }
162 if ( !File::checkExtensionCompatibility( $file, $this->newTitle->getDBkey() ) ) {
163 $status->fatal( 'imagetypemismatch' );
164 }
165 }
166
167 if ( !$this->newTitle->inNamespace( NS_FILE ) ) {
168 $status->fatal( 'imagenocrossnamespace' );
169 }
170
171 return $status;
172 }
173
174 /**
175 * Checks if $this can be moved to a given Title
176 * - Selects for update, so don't call it unless you mean business
177 *
178 * @since 1.25
179 * @return bool
180 */
181 protected function isValidMoveTarget() {
182 # Is it an existing file?
183 if ( $this->newTitle->inNamespace( NS_FILE ) ) {
184 $file = wfLocalFile( $this->newTitle );
185 $file->load( File::READ_LATEST );
186 if ( $file->exists() ) {
187 wfDebug( __METHOD__ . ": file exists\n" );
188 return false;
189 }
190 }
191 # Is it a redirect with no history?
192 if ( !$this->newTitle->isSingleRevRedirect() ) {
193 wfDebug( __METHOD__ . ": not a one-rev redirect\n" );
194 return false;
195 }
196 # Get the article text
197 $rev = Revision::newFromTitle( $this->newTitle, false, Revision::READ_LATEST );
198 if ( !is_object( $rev ) ) {
199 return false;
200 }
201 $content = $rev->getContent();
202 # Does the redirect point to the source?
203 # Or is it a broken self-redirect, usually caused by namespace collisions?
204 $redirTitle = $content ? $content->getRedirectTarget() : null;
205
206 if ( $redirTitle ) {
207 if ( $redirTitle->getPrefixedDBkey() !== $this->oldTitle->getPrefixedDBkey() &&
208 $redirTitle->getPrefixedDBkey() !== $this->newTitle->getPrefixedDBkey() ) {
209 wfDebug( __METHOD__ . ": redirect points to other page\n" );
210 return false;
211 } else {
212 return true;
213 }
214 } else {
215 # Fail safe (not a redirect after all. strange.)
216 wfDebug( __METHOD__ . ": failsafe: database says " . $this->newTitle->getPrefixedDBkey() .
217 " is a redirect, but it doesn't contain a valid redirect.\n" );
218 return false;
219 }
220 }
221
222 /**
223 * @param User $user
224 * @param string $reason
225 * @param bool $createRedirect
226 * @return Status
227 */
228 public function move( User $user, $reason, $createRedirect ) {
229 global $wgCategoryCollation;
230
231 Hooks::run( 'TitleMove', [ $this->oldTitle, $this->newTitle, $user ] );
232
233 // If it is a file, move it first.
234 // It is done before all other moving stuff is done because it's hard to revert.
235 $dbw = wfGetDB( DB_MASTER );
236 if ( $this->oldTitle->getNamespace() == NS_FILE ) {
237 $file = wfLocalFile( $this->oldTitle );
238 $file->load( File::READ_LATEST );
239 if ( $file->exists() ) {
240 $status = $file->move( $this->newTitle );
241 if ( !$status->isOk() ) {
242 return $status;
243 }
244 }
245 // Clear RepoGroup process cache
246 RepoGroup::singleton()->clearCache( $this->oldTitle );
247 RepoGroup::singleton()->clearCache( $this->newTitle ); # clear false negative cache
248 }
249
250 $dbw->startAtomic( __METHOD__ );
251
252 Hooks::run( 'TitleMoveStarting', [ $this->oldTitle, $this->newTitle, $user ] );
253
254 $pageid = $this->oldTitle->getArticleID( Title::GAID_FOR_UPDATE );
255 $protected = $this->oldTitle->isProtected();
256
257 // Do the actual move
258 $nullRevision = $this->moveToInternal( $user, $this->newTitle, $reason, $createRedirect );
259
260 // Refresh the sortkey for this row. Be careful to avoid resetting
261 // cl_timestamp, which may disturb time-based lists on some sites.
262 // @todo This block should be killed, it's duplicating code
263 // from LinksUpdate::getCategoryInsertions() and friends.
264 $prefixes = $dbw->select(
265 'categorylinks',
266 [ 'cl_sortkey_prefix', 'cl_to' ],
267 [ 'cl_from' => $pageid ],
268 __METHOD__
269 );
270 if ( $this->newTitle->getNamespace() == NS_CATEGORY ) {
271 $type = 'subcat';
272 } elseif ( $this->newTitle->getNamespace() == NS_FILE ) {
273 $type = 'file';
274 } else {
275 $type = 'page';
276 }
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 $dbw->insertSelect( 'page_restrictions', 'page_restrictions',
299 [
300 'pr_page' => $redirid,
301 'pr_type' => 'pr_type',
302 'pr_level' => 'pr_level',
303 'pr_cascade' => 'pr_cascade',
304 'pr_user' => 'pr_user',
305 'pr_expiry' => 'pr_expiry'
306 ],
307 [ 'pr_page' => $pageid ],
308 __METHOD__,
309 [ 'IGNORE' ]
310 );
311
312 // Build comment for log
313 $comment = wfMessage(
314 'prot_1movedto2',
315 $this->oldTitle->getPrefixedText(),
316 $this->newTitle->getPrefixedText()
317 )->inContentLanguage()->text();
318 if ( $reason ) {
319 $comment .= wfMessage( 'colon-separator' )->inContentLanguage()->text() . $reason;
320 }
321
322 // reread inserted pr_ids for log relation
323 $insertedPrIds = $dbw->select(
324 'page_restrictions',
325 'pr_id',
326 [ 'pr_page' => $redirid ],
327 __METHOD__
328 );
329 $logRelationsValues = [];
330 foreach ( $insertedPrIds as $prid ) {
331 $logRelationsValues[] = $prid->pr_id;
332 }
333
334 // Update the protection log
335 $logEntry = new ManualLogEntry( 'protect', 'move_prot' );
336 $logEntry->setTarget( $this->newTitle );
337 $logEntry->setComment( $comment );
338 $logEntry->setPerformer( $user );
339 $logEntry->setParameters( [
340 '4::oldtitle' => $this->oldTitle->getPrefixedText(),
341 ] );
342 $logEntry->setRelations( [ 'pr_id' => $logRelationsValues ] );
343 $logId = $logEntry->insert();
344 $logEntry->publish( $logId );
345 }
346
347 // Update *_from_namespace fields as needed
348 if ( $this->oldTitle->getNamespace() != $this->newTitle->getNamespace() ) {
349 $dbw->update( 'pagelinks',
350 [ 'pl_from_namespace' => $this->newTitle->getNamespace() ],
351 [ 'pl_from' => $pageid ],
352 __METHOD__
353 );
354 $dbw->update( 'templatelinks',
355 [ 'tl_from_namespace' => $this->newTitle->getNamespace() ],
356 [ 'tl_from' => $pageid ],
357 __METHOD__
358 );
359 $dbw->update( 'imagelinks',
360 [ 'il_from_namespace' => $this->newTitle->getNamespace() ],
361 [ 'il_from' => $pageid ],
362 __METHOD__
363 );
364 }
365
366 # Update watchlists
367 $oldtitle = $this->oldTitle->getDBkey();
368 $newtitle = $this->newTitle->getDBkey();
369 $oldsnamespace = MWNamespace::getSubject( $this->oldTitle->getNamespace() );
370 $newsnamespace = MWNamespace::getSubject( $this->newTitle->getNamespace() );
371 if ( $oldsnamespace != $newsnamespace || $oldtitle != $newtitle ) {
372 WatchedItem::duplicateEntries( $this->oldTitle, $this->newTitle );
373 }
374
375 Hooks::run(
376 'TitleMoveCompleting',
377 [ $this->oldTitle, $this->newTitle,
378 $user, $pageid, $redirid, $reason, $nullRevision ]
379 );
380
381 $dbw->endAtomic( __METHOD__ );
382
383 $params = [
384 &$this->oldTitle,
385 &$this->newTitle,
386 &$user,
387 $pageid,
388 $redirid,
389 $reason,
390 $nullRevision
391 ];
392 $dbw->onTransactionIdle( function () use ( $params, $dbw ) {
393 // Keep each single hook handler atomic
394 $dbw->setFlag( DBO_TRX ); // flag is automatically reset by DB layer
395 Hooks::run( 'TitleMoveComplete', $params );
396 } );
397
398 return Status::newGood();
399 }
400
401 /**
402 * Move page to a title which is either a redirect to the
403 * source page or nonexistent
404 *
405 * @fixme This was basically directly moved from Title, it should be split into smaller functions
406 * @param User $user the User doing the move
407 * @param Title $nt The page to move to, which should be a redirect or nonexistent
408 * @param string $reason The reason for the move
409 * @param bool $createRedirect Whether to leave a redirect at the old title. Does not check
410 * if the user has the suppressredirect right
411 * @return Revision the revision created by the move
412 * @throws MWException
413 */
414 private function moveToInternal( User $user, &$nt, $reason = '', $createRedirect = true ) {
415 global $wgContLang;
416
417 if ( $nt->exists() ) {
418 $moveOverRedirect = true;
419 $logType = 'move_redir';
420 } else {
421 $moveOverRedirect = false;
422 $logType = 'move';
423 }
424
425 if ( $createRedirect ) {
426 if ( $this->oldTitle->getNamespace() == NS_CATEGORY
427 && !wfMessage( 'category-move-redirect-override' )->inContentLanguage()->isDisabled()
428 ) {
429 $redirectContent = new WikitextContent(
430 wfMessage( 'category-move-redirect-override' )
431 ->params( $nt->getPrefixedText() )->inContentLanguage()->plain() );
432 } else {
433 $contentHandler = ContentHandler::getForTitle( $this->oldTitle );
434 $redirectContent = $contentHandler->makeRedirectContent( $nt,
435 wfMessage( 'move-redirect-text' )->inContentLanguage()->plain() );
436 }
437
438 // NOTE: If this page's content model does not support redirects, $redirectContent will be null.
439 } else {
440 $redirectContent = null;
441 }
442
443 // Figure out whether the content model is no longer the default
444 $oldDefault = ContentHandler::getDefaultModelFor( $this->oldTitle );
445 $contentModel = $this->oldTitle->getContentModel();
446 $newDefault = ContentHandler::getDefaultModelFor( $nt );
447 $defaultContentModelChanging = ( $oldDefault !== $newDefault
448 && $oldDefault === $contentModel );
449
450 // bug 57084: log_page should be the ID of the *moved* page
451 $oldid = $this->oldTitle->getArticleID();
452 $logTitle = clone $this->oldTitle;
453
454 $logEntry = new ManualLogEntry( 'move', $logType );
455 $logEntry->setPerformer( $user );
456 $logEntry->setTarget( $logTitle );
457 $logEntry->setComment( $reason );
458 $logEntry->setParameters( [
459 '4::target' => $nt->getPrefixedText(),
460 '5::noredir' => $redirectContent ? '0': '1',
461 ] );
462
463 $formatter = LogFormatter::newFromEntry( $logEntry );
464 $formatter->setContext( RequestContext::newExtraneousContext( $this->oldTitle ) );
465 $comment = $formatter->getPlainActionText();
466 if ( $reason ) {
467 $comment .= wfMessage( 'colon-separator' )->inContentLanguage()->text() . $reason;
468 }
469 # Truncate for whole multibyte characters.
470 $comment = $wgContLang->truncate( $comment, 255 );
471
472 $dbw = wfGetDB( DB_MASTER );
473
474 $oldpage = WikiPage::factory( $this->oldTitle );
475 $oldcountable = $oldpage->isCountable();
476
477 $newpage = WikiPage::factory( $nt );
478
479 if ( $moveOverRedirect ) {
480 $newid = $nt->getArticleID();
481 $newcontent = $newpage->getContent();
482
483 # Delete the old redirect. We don't save it to history since
484 # by definition if we've got here it's rather uninteresting.
485 # We have to remove it so that the next step doesn't trigger
486 # a conflict on the unique namespace+title index...
487 $dbw->delete( 'page', [ 'page_id' => $newid ], __METHOD__ );
488
489 $newpage->doDeleteUpdates( $newid, $newcontent );
490 }
491
492 # Save a null revision in the page's history notifying of the move
493 $nullRevision = Revision::newNullRevision( $dbw, $oldid, $comment, true, $user );
494 if ( !is_object( $nullRevision ) ) {
495 throw new MWException( 'No valid null revision produced in ' . __METHOD__ );
496 }
497
498 $nullRevision->insertOn( $dbw );
499
500 # Change the name of the target page:
501 $dbw->update( 'page',
502 /* SET */ [
503 'page_namespace' => $nt->getNamespace(),
504 'page_title' => $nt->getDBkey(),
505 ],
506 /* WHERE */ [ 'page_id' => $oldid ],
507 __METHOD__
508 );
509
510 // clean up the old title before reset article id - bug 45348
511 if ( !$redirectContent ) {
512 WikiPage::onArticleDelete( $this->oldTitle );
513 }
514
515 $this->oldTitle->resetArticleID( 0 ); // 0 == non existing
516 $nt->resetArticleID( $oldid );
517 $newpage->loadPageData( WikiPage::READ_LOCKING ); // bug 46397
518
519 $newpage->updateRevisionOn( $dbw, $nullRevision );
520
521 Hooks::run( 'NewRevisionFromEditComplete',
522 [ $newpage, $nullRevision, $nullRevision->getParentId(), $user ] );
523
524 $newpage->doEditUpdates( $nullRevision, $user,
525 [ 'changed' => false, 'moved' => true, 'oldcountable' => $oldcountable ] );
526
527 // If the default content model changes, we need to populate rev_content_model
528 if ( $defaultContentModelChanging ) {
529 $dbw->update(
530 'revision',
531 [ 'rev_content_model' => $contentModel ],
532 [ 'rev_page' => $nt->getArticleID(), 'rev_content_model IS NULL' ],
533 __METHOD__
534 );
535 }
536
537 if ( !$moveOverRedirect ) {
538 WikiPage::onArticleCreate( $nt );
539 }
540
541 # Recreate the redirect, this time in the other direction.
542 if ( $redirectContent ) {
543 $redirectArticle = WikiPage::factory( $this->oldTitle );
544 $redirectArticle->loadFromRow( false, WikiPage::READ_LOCKING ); // bug 46397
545 $newid = $redirectArticle->insertOn( $dbw );
546 if ( $newid ) { // sanity
547 $this->oldTitle->resetArticleID( $newid );
548 $redirectRevision = new Revision( [
549 'title' => $this->oldTitle, // for determining the default content model
550 'page' => $newid,
551 'user_text' => $user->getName(),
552 'user' => $user->getId(),
553 'comment' => $comment,
554 'content' => $redirectContent ] );
555 $redirectRevision->insertOn( $dbw );
556 $redirectArticle->updateRevisionOn( $dbw, $redirectRevision, 0 );
557
558 Hooks::run( 'NewRevisionFromEditComplete',
559 [ $redirectArticle, $redirectRevision, false, $user ] );
560
561 $redirectArticle->doEditUpdates( $redirectRevision, $user, [ 'created' => true ] );
562 }
563 }
564
565 # Log the move
566 $logid = $logEntry->insert();
567 $logEntry->publish( $logid );
568
569 return $nullRevision;
570 }
571 }