MediaWiki  master
LocalRepo.php
Go to the documentation of this file.
1 <?php
29 
36 class LocalRepo extends FileRepo {
38  protected $fileFactory = [ LocalFile::class, 'newFromTitle' ];
40  protected $fileFactoryKey = [ LocalFile::class, 'newFromKey' ];
42  protected $fileFromRowFactory = [ LocalFile::class, 'newFromRow' ];
44  protected $oldFileFromRowFactory = [ OldLocalFile::class, 'newFromRow' ];
46  protected $oldFileFactory = [ OldLocalFile::class, 'newFromTitle' ];
48  protected $oldFileFactoryKey = [ OldLocalFile::class, 'newFromKey' ];
49 
50  function __construct( array $info = null ) {
51  parent::__construct( $info );
52 
53  $this->hasSha1Storage = isset( $info['storageLayout'] )
54  && $info['storageLayout'] === 'sha1';
55 
56  if ( $this->hasSha1Storage() ) {
57  $this->backend = new FileBackendDBRepoWrapper( [
58  'backend' => $this->backend,
59  'repoName' => $this->name,
60  'dbHandleFactory' => $this->getDBFactory()
61  ] );
62  }
63  }
64 
70  function newFileFromRow( $row ) {
71  if ( isset( $row->img_name ) ) {
72  return call_user_func( $this->fileFromRowFactory, $row, $this );
73  } elseif ( isset( $row->oi_name ) ) {
74  return call_user_func( $this->oldFileFromRowFactory, $row, $this );
75  } else {
76  throw new MWException( __METHOD__ . ': invalid row' );
77  }
78  }
79 
85  function newFromArchiveName( $title, $archiveName ) {
86  return OldLocalFile::newFromArchiveName( $title, $this, $archiveName );
87  }
88 
99  function cleanupDeletedBatch( array $storageKeys ) {
100  if ( $this->hasSha1Storage() ) {
101  wfDebug( __METHOD__ . ": skipped because storage uses sha1 paths\n" );
102  return Status::newGood();
103  }
104 
105  $backend = $this->backend; // convenience
106  $root = $this->getZonePath( 'deleted' );
107  $dbw = $this->getMasterDB();
108  $status = $this->newGood();
109  $storageKeys = array_unique( $storageKeys );
110  foreach ( $storageKeys as $key ) {
111  $hashPath = $this->getDeletedHashPath( $key );
112  $path = "$root/$hashPath$key";
113  $dbw->startAtomic( __METHOD__ );
114  // Check for usage in deleted/hidden files and preemptively
115  // lock the key to avoid any future use until we are finished.
116  $deleted = $this->deletedFileHasKey( $key, 'lock' );
117  $hidden = $this->hiddenFileHasKey( $key, 'lock' );
118  if ( !$deleted && !$hidden ) { // not in use now
119  wfDebug( __METHOD__ . ": deleting $key\n" );
120  $op = [ 'op' => 'delete', 'src' => $path ];
121  if ( !$backend->doOperation( $op )->isOK() ) {
122  $status->error( 'undelete-cleanup-error', $path );
123  $status->failCount++;
124  }
125  } else {
126  wfDebug( __METHOD__ . ": $key still in use\n" );
127  $status->successCount++;
128  }
129  $dbw->endAtomic( __METHOD__ );
130  }
131 
132  return $status;
133  }
134 
142  protected function deletedFileHasKey( $key, $lock = null ) {
143  $options = ( $lock === 'lock' ) ? [ 'FOR UPDATE' ] : [];
144 
145  $dbw = $this->getMasterDB();
146 
147  return (bool)$dbw->selectField( 'filearchive', '1',
148  [ 'fa_storage_group' => 'deleted', 'fa_storage_key' => $key ],
149  __METHOD__, $options
150  );
151  }
152 
160  protected function hiddenFileHasKey( $key, $lock = null ) {
161  $options = ( $lock === 'lock' ) ? [ 'FOR UPDATE' ] : [];
162 
163  $sha1 = self::getHashFromKey( $key );
164  $ext = File::normalizeExtension( substr( $key, strcspn( $key, '.' ) + 1 ) );
165 
166  $dbw = $this->getMasterDB();
167 
168  return (bool)$dbw->selectField( 'oldimage', '1',
169  [ 'oi_sha1' => $sha1,
170  'oi_archive_name ' . $dbw->buildLike( $dbw->anyString(), ".$ext" ),
171  $dbw->bitAnd( 'oi_deleted', File::DELETED_FILE ) => File::DELETED_FILE ],
172  __METHOD__, $options
173  );
174  }
175 
182  public static function getHashFromKey( $key ) {
183  return strtok( $key, '.' );
184  }
185 
192  function checkRedirect( Title $title ) {
193  $title = File::normalizeTitle( $title, 'exception' );
194 
195  $memcKey = $this->getSharedCacheKey( 'image_redirect', md5( $title->getDBkey() ) );
196  if ( $memcKey === false ) {
197  $memcKey = $this->getLocalCacheKey( 'image_redirect', md5( $title->getDBkey() ) );
198  $expiry = 300; // no invalidation, 5 minutes
199  } else {
200  $expiry = 86400; // has invalidation, 1 day
201  }
202 
203  $method = __METHOD__;
204  $redirDbKey = $this->wanCache->getWithSetCallback(
205  $memcKey,
206  $expiry,
207  function ( $oldValue, &$ttl, array &$setOpts ) use ( $method, $title ) {
208  $dbr = $this->getReplicaDB(); // possibly remote DB
209 
210  $setOpts += Database::getCacheSetOptions( $dbr );
211 
212  if ( $title instanceof Title ) {
213  $row = $dbr->selectRow(
214  [ 'page', 'redirect' ],
215  [ 'rd_namespace', 'rd_title' ],
216  [
217  'page_namespace' => $title->getNamespace(),
218  'page_title' => $title->getDBkey(),
219  'rd_from = page_id'
220  ],
221  $method
222  );
223  } else {
224  $row = false;
225  }
226 
227  return ( $row && $row->rd_namespace == NS_FILE )
228  ? Title::makeTitle( $row->rd_namespace, $row->rd_title )->getDBkey()
229  : ''; // negative cache
230  },
231  [ 'pcTTL' => WANObjectCache::TTL_PROC_LONG ]
232  );
233 
234  // @note: also checks " " for b/c
235  if ( $redirDbKey !== ' ' && strval( $redirDbKey ) !== '' ) {
236  // Page is a redirect to another file
237  return Title::newFromText( $redirDbKey, NS_FILE );
238  }
239 
240  return false; // no redirect
241  }
242 
243  public function findFiles( array $items, $flags = 0 ) {
244  $finalFiles = []; // map of (DB key => corresponding File) for matches
245 
246  $searchSet = []; // map of (normalized DB key => search params)
247  foreach ( $items as $item ) {
248  if ( is_array( $item ) ) {
249  $title = File::normalizeTitle( $item['title'] );
250  if ( $title ) {
251  $searchSet[$title->getDBkey()] = $item;
252  }
253  } else {
254  $title = File::normalizeTitle( $item );
255  if ( $title ) {
256  $searchSet[$title->getDBkey()] = [];
257  }
258  }
259  }
260 
261  $fileMatchesSearch = function ( File $file, array $search ) {
262  // Note: file name comparison done elsewhere (to handle redirects)
263  $user = ( !empty( $search['private'] ) && $search['private'] instanceof User )
264  ? $search['private']
265  : null;
266 
267  return (
268  $file->exists() &&
269  (
270  ( empty( $search['time'] ) && !$file->isOld() ) ||
271  ( !empty( $search['time'] ) && $search['time'] === $file->getTimestamp() )
272  ) &&
273  ( !empty( $search['private'] ) || !$file->isDeleted( File::DELETED_FILE ) ) &&
274  $file->userCan( File::DELETED_FILE, $user )
275  );
276  };
277 
278  $applyMatchingFiles = function ( IResultWrapper $res, &$searchSet, &$finalFiles )
279  use ( $fileMatchesSearch, $flags )
280  {
281  $contLang = MediaWikiServices::getInstance()->getContentLanguage();
282  $info = $this->getInfo();
283  foreach ( $res as $row ) {
284  $file = $this->newFileFromRow( $row );
285  // There must have been a search for this DB key, but this has to handle the
286  // cases were title capitalization is different on the client and repo wikis.
287  $dbKeysLook = [ strtr( $file->getName(), ' ', '_' ) ];
288  if ( !empty( $info['initialCapital'] ) ) {
289  // Search keys for "hi.png" and "Hi.png" should use the "Hi.png file"
290  $dbKeysLook[] = $contLang->lcfirst( $file->getName() );
291  }
292  foreach ( $dbKeysLook as $dbKey ) {
293  if ( isset( $searchSet[$dbKey] )
294  && $fileMatchesSearch( $file, $searchSet[$dbKey] )
295  ) {
296  $finalFiles[$dbKey] = ( $flags & FileRepo::NAME_AND_TIME_ONLY )
297  ? [ 'title' => $dbKey, 'timestamp' => $file->getTimestamp() ]
298  : $file;
299  unset( $searchSet[$dbKey] );
300  }
301  }
302  }
303  };
304 
305  $dbr = $this->getReplicaDB();
306 
307  // Query image table
308  $imgNames = [];
309  foreach ( array_keys( $searchSet ) as $dbKey ) {
310  $imgNames[] = $this->getNameFromTitle( File::normalizeTitle( $dbKey ) );
311  }
312 
313  if ( count( $imgNames ) ) {
314  $fileQuery = LocalFile::getQueryInfo();
315  $res = $dbr->select( $fileQuery['tables'], $fileQuery['fields'], [ 'img_name' => $imgNames ],
316  __METHOD__, [], $fileQuery['joins'] );
317  $applyMatchingFiles( $res, $searchSet, $finalFiles );
318  }
319 
320  // Query old image table
321  $oiConds = []; // WHERE clause array for each file
322  foreach ( $searchSet as $dbKey => $search ) {
323  if ( isset( $search['time'] ) ) {
324  $oiConds[] = $dbr->makeList(
325  [
326  'oi_name' => $this->getNameFromTitle( File::normalizeTitle( $dbKey ) ),
327  'oi_timestamp' => $dbr->timestamp( $search['time'] )
328  ],
329  LIST_AND
330  );
331  }
332  }
333 
334  if ( count( $oiConds ) ) {
335  $fileQuery = OldLocalFile::getQueryInfo();
336  $res = $dbr->select( $fileQuery['tables'], $fileQuery['fields'],
337  $dbr->makeList( $oiConds, LIST_OR ),
338  __METHOD__, [], $fileQuery['joins'] );
339  $applyMatchingFiles( $res, $searchSet, $finalFiles );
340  }
341 
342  // Check for redirects...
343  foreach ( $searchSet as $dbKey => $search ) {
344  if ( !empty( $search['ignoreRedirect'] ) ) {
345  continue;
346  }
347 
348  $title = File::normalizeTitle( $dbKey );
349  $redir = $this->checkRedirect( $title ); // hopefully hits memcached
350 
351  if ( $redir && $redir->getNamespace() == NS_FILE ) {
352  $file = $this->newFile( $redir );
353  if ( $file && $fileMatchesSearch( $file, $search ) ) {
354  $file->redirectedFrom( $title->getDBkey() );
355  if ( $flags & FileRepo::NAME_AND_TIME_ONLY ) {
356  $finalFiles[$dbKey] = [
357  'title' => $file->getTitle()->getDBkey(),
358  'timestamp' => $file->getTimestamp()
359  ];
360  } else {
361  $finalFiles[$dbKey] = $file;
362  }
363  }
364  }
365  }
366 
367  return $finalFiles;
368  }
369 
377  function findBySha1( $hash ) {
378  $dbr = $this->getReplicaDB();
379  $fileQuery = LocalFile::getQueryInfo();
380  $res = $dbr->select(
381  $fileQuery['tables'],
382  $fileQuery['fields'],
383  [ 'img_sha1' => $hash ],
384  __METHOD__,
385  [ 'ORDER BY' => 'img_name' ],
386  $fileQuery['joins']
387  );
388 
389  $result = [];
390  foreach ( $res as $row ) {
391  $result[] = $this->newFileFromRow( $row );
392  }
393  $res->free();
394 
395  return $result;
396  }
397 
407  function findBySha1s( array $hashes ) {
408  if ( $hashes === [] ) {
409  return []; // empty parameter
410  }
411 
412  $dbr = $this->getReplicaDB();
413  $fileQuery = LocalFile::getQueryInfo();
414  $res = $dbr->select(
415  $fileQuery['tables'],
416  $fileQuery['fields'],
417  [ 'img_sha1' => $hashes ],
418  __METHOD__,
419  [ 'ORDER BY' => 'img_name' ],
420  $fileQuery['joins']
421  );
422 
423  $result = [];
424  foreach ( $res as $row ) {
425  $file = $this->newFileFromRow( $row );
426  $result[$file->getSha1()][] = $file;
427  }
428  $res->free();
429 
430  return $result;
431  }
432 
440  public function findFilesByPrefix( $prefix, $limit ) {
441  $selectOptions = [ 'ORDER BY' => 'img_name', 'LIMIT' => intval( $limit ) ];
442 
443  // Query database
444  $dbr = $this->getReplicaDB();
445  $fileQuery = LocalFile::getQueryInfo();
446  $res = $dbr->select(
447  $fileQuery['tables'],
448  $fileQuery['fields'],
449  'img_name ' . $dbr->buildLike( $prefix, $dbr->anyString() ),
450  __METHOD__,
451  $selectOptions,
452  $fileQuery['joins']
453  );
454 
455  // Build file objects
456  $files = [];
457  foreach ( $res as $row ) {
458  $files[] = $this->newFileFromRow( $row );
459  }
460 
461  return $files;
462  }
463 
468  function getReplicaDB() {
469  return wfGetDB( DB_REPLICA );
470  }
471 
478  function getSlaveDB() {
479  return $this->getReplicaDB();
480  }
481 
486  function getMasterDB() {
487  return wfGetDB( DB_MASTER );
488  }
489 
494  protected function getDBFactory() {
495  return function ( $index ) {
496  return wfGetDB( $index );
497  };
498  }
499 
507  function getSharedCacheKey( /*...*/ ) {
508  $args = func_get_args();
509 
510  return $this->wanCache->makeKey( ...$args );
511  }
512 
520  $key = $this->getSharedCacheKey( 'image_redirect', md5( $title->getDBkey() ) );
521  if ( $key ) {
522  $this->getMasterDB()->onTransactionPreCommitOrIdle(
523  function () use ( $key ) {
524  $this->wanCache->delete( $key );
525  },
526  __METHOD__
527  );
528  }
529  }
530 
537  function getInfo() {
538  global $wgFavicon;
539 
540  return array_merge( parent::getInfo(), [
541  'favicon' => wfExpandUrl( $wgFavicon ),
542  ] );
543  }
544 
545  public function store( $srcPath, $dstZone, $dstRel, $flags = 0 ) {
546  return $this->skipWriteOperationIfSha1( __FUNCTION__, func_get_args() );
547  }
548 
549  public function storeBatch( array $triplets, $flags = 0 ) {
550  return $this->skipWriteOperationIfSha1( __FUNCTION__, func_get_args() );
551  }
552 
553  public function cleanupBatch( array $files, $flags = 0 ) {
554  return $this->skipWriteOperationIfSha1( __FUNCTION__, func_get_args() );
555  }
556 
557  public function publish(
558  $src,
559  $dstRel,
560  $archiveRel,
561  $flags = 0,
562  array $options = []
563  ) {
564  return $this->skipWriteOperationIfSha1( __FUNCTION__, func_get_args() );
565  }
566 
567  public function publishBatch( array $ntuples, $flags = 0 ) {
568  return $this->skipWriteOperationIfSha1( __FUNCTION__, func_get_args() );
569  }
570 
571  public function delete( $srcRel, $archiveRel ) {
572  return $this->skipWriteOperationIfSha1( __FUNCTION__, func_get_args() );
573  }
574 
575  public function deleteBatch( array $sourceDestPairs ) {
576  return $this->skipWriteOperationIfSha1( __FUNCTION__, func_get_args() );
577  }
578 
586  protected function skipWriteOperationIfSha1( $function, array $args ) {
587  $this->assertWritableRepo(); // fail out if read-only
588 
589  if ( $this->hasSha1Storage() ) {
590  wfDebug( __METHOD__ . ": skipped because storage uses sha1 paths\n" );
591  return Status::newGood();
592  } else {
593  return parent::$function( ...$args );
594  }
595  }
596 }
assertWritableRepo()
Throw an exception if this repo is read-only by design.
Definition: FileRepo.php:1895
getSlaveDB()
Alias for getReplicaDB()
Definition: LocalRepo.php:478
newFromArchiveName( $title, $archiveName)
Definition: LocalRepo.php:85
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 newFromArchiveName( $title, $repo, $archiveName)
wfExpandUrl( $url, $defaultProto=PROTO_CURRENT)
Expand a potentially local URL to a fully-qualified URL.
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
store( $srcPath, $dstZone, $dstRel, $flags=0)
Definition: LocalRepo.php:545
getLocalCacheKey()
Get a key for this repo in the local cache domain.
Definition: FileRepo.php:1834
findBySha1s(array $hashes)
Get an array of arrays or iterators of file objects for files that have the given SHA-1 content hashe...
Definition: LocalRepo.php:407
getReplicaDB()
Get a connection to the replica DB.
Definition: LocalRepo.php:468
A repository that stores files in the local filesystem and registers them in the wiki&#39;s own database...
Definition: LocalRepo.php:36
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
getName()
Return the name of this file.
Definition: File.php:307
doOperation(array $op, array $opts=[])
Same as doOperations() except it takes a single operation.
publishBatch(array $ntuples, $flags=0)
Definition: LocalRepo.php:567
cleanupBatch(array $files, $flags=0)
Definition: LocalRepo.php:553
isOld()
Returns true if the image is an old version STUB.
Definition: File.php:1885
getSharedCacheKey()
Get a key on the primary cache for this repository.
Definition: LocalRepo.php:507
getTitle()
Return the associated title object.
Definition: File.php:336
const DB_MASTER
Definition: defines.php:26
callable $oldFileFromRowFactory
Definition: LocalRepo.php:44
deleteBatch(array $sourceDestPairs)
Definition: LocalRepo.php:575
const DELETED_FILE
Definition: File.php:63
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED since 1.28! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:1980
if( $line===false) $args
Definition: cdb.php:64
and how to run hooks for an and one after Each event has a name
Definition: hooks.txt:6
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
invalidateImageRedirect(Title $title)
Invalidates image redirect cache related to that image.
Definition: LocalRepo.php:519
callable $fileFactoryKey
Definition: LocalRepo.php:40
const LIST_AND
Definition: Defines.php:39
getMasterDB()
Get a connection to the master DB.
Definition: LocalRepo.php:486
getDBkey()
Get the main part with underscores.
Definition: Title.php:1002
cleanupDeletedBatch(array $storageKeys)
Delete files in the deleted directory if they are not referenced in the filearchive table...
Definition: LocalRepo.php:99
$res
Definition: database.txt:21
userCan( $field, User $user=null)
Determine if the current user is allowed to view a particular field of this file, if it&#39;s marked as d...
Definition: File.php:2168
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.
Result wrapper for grabbing data queried from an IDatabase object.
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped & $options
Definition: hooks.txt:1982
getDBFactory()
Get a callback to get a DB handle given an index (DB_REPLICA/DB_MASTER)
Definition: LocalRepo.php:494
newFile( $title, $time=false)
Create a new File object from the local repository.
Definition: FileRepo.php:388
getInfo()
Return information about the repository.
Definition: LocalRepo.php:537
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
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:925
skipWriteOperationIfSha1( $function, array $args)
Skips the write operation if storage is sha1-based, executes it normally otherwise.
Definition: LocalRepo.php:586
getNamespace()
Get the namespace index, i.e.
Definition: Title.php:1026
const NS_FILE
Definition: Defines.php:66
getZonePath( $zone)
Get the storage path corresponding to one of the zones.
Definition: FileRepo.php:364
__construct(array $info=null)
Definition: LocalRepo.php:50
callable $fileFactory
Definition: LocalRepo.php:38
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
hiddenFileHasKey( $key, $lock=null)
Check if a hidden (revision delete) file has this sha1 key.
Definition: LocalRepo.php:160
static getHashFromKey( $key)
Gets the SHA1 hash from a storage key.
Definition: LocalRepo.php:182
getNameFromTitle(Title $title)
Get the name of a file from its title object.
Definition: FileRepo.php:648
const LIST_OR
Definition: Defines.php:42
findFilesByPrefix( $prefix, $limit)
Return an array of files where the name starts with $prefix.
Definition: LocalRepo.php:440
const NAME_AND_TIME_ONLY
Definition: FileRepo.php:45
static getQueryInfo(array $options=[])
Return the tables, fields, and join conditions to be selected to create a new oldlocalfile object...
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:589
redirectedFrom( $from)
Definition: File.php:2257
deletedFileHasKey( $key, $lock=null)
Check if a deleted (filearchive) file has this sha1 key.
Definition: LocalRepo.php:142
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
getTimestamp()
Get the 14-character timestamp of the file upload.
Definition: File.php:2116
callable $fileFromRowFactory
Definition: LocalRepo.php:42
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
Definition: maintenance.txt:52
callable $oldFileFactory
Definition: LocalRepo.php:46
storeBatch(array $triplets, $flags=0)
Definition: LocalRepo.php:549
exists()
Returns true if file exists in the repository.
Definition: File.php:901
if(!is_readable( $file)) $ext
Definition: router.php:48
Base class for file repositories.
Definition: FileRepo.php:39
findFiles(array $items, $flags=0)
Definition: LocalRepo.php:243
FileBackend $backend
Definition: FileRepo.php:61
const DB_REPLICA
Definition: defines.php:25
getDeletedHashPath( $key)
Get a relative path for a deletion archive key, e.g.
Definition: FileRepo.php:1498
static getQueryInfo(array $options=[])
Return the tables, fields, and join conditions to be selected to create a new localfile object...
Definition: LocalFile.php:253
publish( $src, $dstRel, $archiveRel, $flags=0, array $options=[])
Definition: LocalRepo.php:557
static normalizeExtension( $extension)
Normalize a file extension to the common form, making it lowercase and checking some synonyms...
Definition: File.php:234
Implements some public methods and some protected utility functions which are required by multiple ch...
Definition: File.php:61
findBySha1( $hash)
Get an array or iterator of file objects for files that have a given SHA-1 content hash...
Definition: LocalRepo.php:377
callable $oldFileFactoryKey
Definition: LocalRepo.php:48
hasSha1Storage()
Returns whether or not storage is SHA-1 based.
Definition: FileRepo.php:1929
isDeleted( $field)
Is this file a "deleted" file in a private archive? STUB.
Definition: File.php:1896
static normalizeTitle( $title, $exception=false)
Given a string or Title object return either a valid Title object with namespace NS_FILE or null...
Definition: File.php:194
return true to allow those checks to and false if checking is done & $user
Definition: hooks.txt:1473
checkRedirect(Title $title)
Checks if there is a redirect named as $title.
Definition: LocalRepo.php:192
Proxy backend that manages file layout rewriting for FileRepo.
newGood( $value=null)
Create a new good result.
Definition: FileRepo.php:1745
newFileFromRow( $row)
Definition: LocalRepo.php:70
$wgFavicon
The URL path of the shortcut icon.
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:319