MediaWiki  master
MovePage.php
Go to the documentation of this file.
1 <?php
2 
25 
32 class MovePage {
33 
37  protected $oldTitle;
38 
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 
90  public function isValidMove() {
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 
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 
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 
243  public function move( User $user, $reason, $createRedirect, array $changeTags = [] ) {
244  global $wgCategoryCollation;
245 
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 = [
404  &$user,
405  $pageid,
406  $redirid,
407  $reason,
408  $nullRevision
409  ];
410  // Keep each single hook handler atomic
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 
435  private function moveFile( $oldTitle, $newTitle ) {
437  'cannotdelete',
439  );
440 
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 
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 
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 
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 }
The wiki should then use memcached to cache various data To use multiple just add more items to the array To increase the weight of a make its entry a array("192.168.0.1:11211", 2))
static factory(Title $title)
Create a WikiPage object of the appropriate class for the given title.
Definition: WikiPage.php:138
static onArticleCreate(Title $title)
The onArticle*() functions are supposed to be a kind of hooks which should be called whenever any of ...
Definition: WikiPage.php:3377
either a plain
Definition: hooks.txt:2043
Handles the backend logic of moving a page from one title to another.
Definition: MovePage.php:32
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
if(PHP_SAPI !='cli-server') if(!isset( $_SERVER['SCRIPT_FILENAME'])) $file
Definition: router.php:42
static singleton()
Definition: Collation.php:36
static newFromEntry(LogEntry $entry)
Constructs a new formatter suitable for given entry.
static getSubject( $index)
Get the subject namespace index for a given namespace Special namespaces (NS_MEDIA, NS_SPECIAL) are always the subject.
Definition: MWNamespace.php:76
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
const READ_LOCKING
Constants for object loading bitfield flags (higher => higher QoS)
static getDefaultModelFor(Title $title)
Returns the name of the default content model to be used for the page with the given title...
wfStripIllegalFilenameChars( $name)
Replace all invalid characters with &#39;-&#39;.
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency MediaWikiServices
Definition: injection.txt:23
getPrefixedText()
Get the prefixed title with spaces.
Definition: Title.php:1691
static getLocalizedName( $name, Language $lang=null)
Returns the localized name for a given content model.
static newFromTitle(LinkTarget $linkTarget, $id=0, $flags=0)
Load either the current, or a specified, revision that&#39;s attached to a given link target...
Definition: Revision.php:137
wfLocalFile( $title)
Get an object referring to a locally registered file.
$wgCategoryCollation
Specify how category names should be sorted, when listed on a category page.
const DB_MASTER
Definition: defines.php:26
getName()
Get the user name, or the IP of an anonymous user.
Definition: User.php:2454
The User object encapsulates all of the user-specific settings (user_id, name, rights, email address, options, last login time).
Definition: User.php:48
$wgContentHandlerUseDB
Set to false to disable use of the database fields introduced by the ContentHandler facility...
you have access to all of the normal MediaWiki so you can get a DB use the cache
Definition: maintenance.txt:52
static newFatal( $message)
Factory function for fatal errors.
Definition: StatusValue.php:68
Status::newGood()` to allow deletion, and then `return false` from the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry out custom deletion actions. $tag:name of the tag $user:user initiating the action & $status:Status object. See above. 'ChangeTagsListActive':Allows you to nominate which of the tags your extension uses are in active use. & $tags:list of all active tags. Append to this array. 'ChangeTagsAfterUpdateTags':Called after tags have been updated with the ChangeTags::updateTags function. Params:$addedTags:tags effectively added in the update $removedTags:tags effectively removed in the update $prevTags:tags that were present prior to the update $rc_id:recentchanges table id $rev_id:revision table id $log_id:logging table id $params:tag params $rc:RecentChange being tagged when the tagging accompanies the action, or null $user:User who performed the tagging when the tagging is subsequent to the action, or null 'ChangeTagsAllowedAdd':Called when checking if a user can add tags to a change. & $allowedTags:List of all the tags the user is allowed to add. Any tags the user wants to add( $addTags) that are not in this array will cause it to fail. You may add or remove tags to this array as required. $addTags:List of tags user intends to add. $user:User who is adding the tags. 'ChangeUserGroups':Called before user groups are changed. $performer:The User who will perform the change $user:The User whose groups will be changed & $add:The groups that will be added & $remove:The groups that will be removed 'Collation::factory':Called if $wgCategoryCollation is an unknown collation. $collationName:Name of the collation in question & $collationObject:Null. Replace with a subclass of the Collation class that implements the collation given in $collationName. 'ConfirmEmailComplete':Called after a user 's email has been confirmed successfully. $user:user(object) whose email is being confirmed 'ContentAlterParserOutput':Modify parser output for a given content object. Called by Content::getParserOutput after parsing has finished. Can be used for changes that depend on the result of the parsing but have to be done before LinksUpdate is called(such as adding tracking categories based on the rendered HTML). $content:The Content to render $title:Title of the page, as context $parserOutput:ParserOutput to manipulate 'ContentGetParserOutput':Customize parser output for a given content object, called by AbstractContent::getParserOutput. May be used to override the normal model-specific rendering of page content. $content:The Content to render $title:Title of the page, as context $revId:The revision ID, as context $options:ParserOptions for rendering. To avoid confusing the parser cache, the output can only depend on parameters provided to this hook function, not on global state. $generateHtml:boolean, indicating whether full HTML should be generated. If false, generation of HTML may be skipped, but other information should still be present in the ParserOutput object. & $output:ParserOutput, to manipulate or replace 'ContentHandlerDefaultModelFor':Called when the default content model is determined for a given title. May be used to assign a different model for that title. $title:the Title in question & $model:the model name. Use with CONTENT_MODEL_XXX constants. 'ContentHandlerForModelID':Called when a ContentHandler is requested for a given content model name, but no entry for that model exists in $wgContentHandlers. Note:if your extension implements additional models via this hook, please use GetContentModels hook to make them known to core. $modeName:the requested content model name & $handler:set this to a ContentHandler object, if desired. 'ContentModelCanBeUsedOn':Called to determine whether that content model can be used on a given page. This is especially useful to prevent some content models to be used in some special location. $contentModel:ID of the content model in question $title:the Title in question. & $ok:Output parameter, whether it is OK to use $contentModel on $title. Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok. 'ContribsPager::getQueryInfo':Before the contributions query is about to run & $pager:Pager object for contributions & $queryInfo:The query for the contribs Pager 'ContribsPager::reallyDoQuery':Called before really executing the query for My Contributions & $data:an array of results of all contribs queries $pager:The ContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'ContributionsLineEnding':Called before a contributions HTML line is finished $page:SpecialPage object for contributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'ContributionsToolLinks':Change tool links above Special:Contributions $id:User identifier $title:User page title & $tools:Array of tool links $specialPage:SpecialPage instance for context and services. Can be either SpecialContributions or DeletedContributionsPage. Extensions should type hint against a generic SpecialPage though. 'ConvertContent':Called by AbstractContent::convert when a conversion to another content model is requested. Handler functions that modify $result should generally return false to disable further attempts at conversion. $content:The Content object to be converted. $toModel:The ID of the content model to convert to. $lossy:boolean indicating whether lossy conversion is allowed. & $result:Output parameter, in case the handler function wants to provide a converted Content object. Note that $result->getContentModel() must return $toModel. 'ContentSecurityPolicyDefaultSource':Modify the allowed CSP load sources. This affects all directives except for the script directive. If you want to add a script source, see ContentSecurityPolicyScriptSource hook. & $defaultSrc:Array of Content-Security-Policy allowed sources $policyConfig:Current configuration for the Content-Security-Policy header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyDirectives':Modify the content security policy directives. Use this only if ContentSecurityPolicyDefaultSource and ContentSecurityPolicyScriptSource do not meet your needs. & $directives:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyScriptSource':Modify the allowed CSP script sources. Note that you also have to use ContentSecurityPolicyDefaultSource if you want non-script sources to be loaded from whatever you add. & $scriptSrc:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'CustomEditor':When invoking the page editor Return true to allow the normal editor to be used, or false if implementing a custom editor, e.g. for a special namespace, etc. $article:Article being edited $user:User performing the edit 'DeletedContribsPager::reallyDoQuery':Called before really executing the query for Special:DeletedContributions Similar to ContribsPager::reallyDoQuery & $data:an array of results of all contribs queries $pager:The DeletedContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'DeletedContributionsLineEnding':Called before a DeletedContributions HTML line is finished. Similar to ContributionsLineEnding $page:SpecialPage object for DeletedContributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'DeleteUnknownPreferences':Called by the cleanupPreferences.php maintenance script to build a WHERE clause with which to delete preferences that are not known about. This hook is used by extensions that have dynamically-named preferences that should not be deleted in the usual cleanup process. For example, the Gadgets extension creates preferences prefixed with 'gadget-', and so anything with that prefix is excluded from the deletion. &where:An array that will be passed as the $cond parameter to IDatabase::select() to determine what will be deleted from the user_properties table. $db:The IDatabase object, useful for accessing $db->buildLike() etc. 'DifferenceEngineAfterLoadNewText':called in DifferenceEngine::loadNewText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before returning true from this function. $differenceEngine:DifferenceEngine object 'DifferenceEngineLoadTextAfterNewContentIsLoaded':called in DifferenceEngine::loadText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before checking if the variable 's value is null. This hook can be used to inject content into said class member variable. $differenceEngine:DifferenceEngine object 'DifferenceEngineMarkPatrolledLink':Allows extensions to change the "mark as patrolled" link which is shown both on the diff header as well as on the bottom of a page, usually wrapped in a span element which has class="patrollink". $differenceEngine:DifferenceEngine object & $markAsPatrolledLink:The "mark as patrolled" link HTML(string) $rcid:Recent change ID(rc_id) for this change(int) 'DifferenceEngineMarkPatrolledRCID':Allows extensions to possibly change the rcid parameter. For example the rcid might be set to zero due to the user being the same as the performer of the change but an extension might still want to show it under certain conditions. & $rcid:rc_id(int) of the change or 0 $differenceEngine:DifferenceEngine object $change:RecentChange object $user:User object representing the current user 'DifferenceEngineNewHeader':Allows extensions to change the $newHeader variable, which contains information about the new revision, such as the revision 's author, whether the revision was marked as a minor edit or not, etc. $differenceEngine:DifferenceEngine object & $newHeader:The string containing the various #mw-diff-otitle[1-5] divs, which include things like revision author info, revision comment, RevisionDelete link and more $formattedRevisionTools:Array containing revision tools, some of which may have been injected with the DiffRevisionTools hook $nextlink:String containing the link to the next revision(if any) $status
Definition: hooks.txt:1263
wfMergeErrorArrays(... $args)
Merge arrays in the style of getUserPermissionsErrors, with duplicate removal e.g.
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation use $formDescriptor instead default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock() - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset - wrap String Wrap the message in html(usually something like "&lt
checkPermissions(User $user, $reason)
Definition: MovePage.php:49
$res
Definition: database.txt:21
static singleton()
Get a RepoGroup instance.
Definition: RepoGroup.php:61
moveFile( $oldTitle, $newTitle)
Move a file associated with a page to a new location.
Definition: MovePage.php:435
static newGood( $value=null)
Factory function for good results.
Definition: StatusValue.php:81
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
moveToInternal(User $user, &$nt, $reason='', $createRedirect=true, array $changeTags=[])
Move page to a title which is either a redirect to the source page or nonexistent.
Definition: MovePage.php:468
const GAID_FOR_UPDATE
Used to be GAID_FOR_UPDATE define.
Definition: Title.php:55
incEditCount()
Schedule a deferred update to update the user&#39;s edit count.
Definition: User.php:5355
$params
const NS_CATEGORY
Definition: Defines.php:78
isAllowed( $action='')
Internal mechanics of testing a permission.
Definition: User.php:3861
static getSoftwareTags( $all=false)
Loads defined core tags, checks for invalid types (if not array), and filters for supported and enabl...
Definition: ChangeTags.php:57
static newExtraneousContext(Title $title, $request=[])
Create a new extraneous context.
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:780
const NS_FILE
Definition: Defines.php:70
presenting them properly to the user as errors is done by the caller return true use this to change the list i e etc $rev
Definition: hooks.txt:1766
static getForTitle(Title $title)
Returns the appropriate ContentHandler singleton for the given title.
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
insertOn( $dbw)
Insert a new revision into the database, returning the new revision ID number on success and dies hor...
Definition: Revision.php:1152
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
isValidFileMove()
Sanity checks for when a file is being moved.
Definition: MovePage.php:167
static checkExtensionCompatibility(File $old, $new)
Checks if file extensions are compatible.
Definition: File.php:250
static addUpdate(DeferrableUpdate $update, $stage=self::POSTSEND)
Add an update to the deferred list to be run later by execute()
__construct(Title $oldTitle, Title $newTitle)
Definition: MovePage.php:44
isValidMoveTarget()
Checks if $this can be moved to a given Title.
Definition: MovePage.php:194
getId()
Get the user&#39;s ID.
Definition: User.php:2427
static matchSummarySpamRegex( $text)
Check given input text against $wgSummarySpamRegex, and return the text of the first match...
Definition: EditPage.php:2469
static onArticleDelete(Title $title)
Clears caches when article is deleted.
Definition: WikiPage.php:3410
Title $oldTitle
Definition: MovePage.php:37
$content
Definition: pageupdater.txt:72
isValidMove()
Does various sanity checks that the move is valid.
Definition: MovePage.php:90
static newNullRevision( $dbw, $pageId, $summary, $minor, $user=null)
Create a new null-revision for insertion into a page&#39;s history.
Definition: Revision.php:1198
static addTags( $tags, $rc_id=null, $rev_id=null, $log_id=null, $params=null, RecentChange $rc=null)
Add tags to a change given its rc_id, rev_id and/or log_id.
Definition: ChangeTags.php:226
Title $newTitle
Definition: MovePage.php:42
move(User $user, $reason, $createRedirect, array $changeTags=[])
Definition: MovePage.php:243
return true to allow those checks to and false if checking is done & $user
Definition: hooks.txt:1473
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:200