MediaWiki  REL1_31
LocalRepo.php
Go to the documentation of this file.
1 <?php
28 
35 class LocalRepo extends FileRepo {
37  protected $fileFactory = [ LocalFile::class, 'newFromTitle' ];
39  protected $fileFactoryKey = [ LocalFile::class, 'newFromKey' ];
41  protected $fileFromRowFactory = [ LocalFile::class, 'newFromRow' ];
43  protected $oldFileFromRowFactory = [ OldLocalFile::class, 'newFromRow' ];
45  protected $oldFileFactory = [ OldLocalFile::class, 'newFromTitle' ];
47  protected $oldFileFactoryKey = [ OldLocalFile::class, 'newFromKey' ];
48 
49  function __construct( array $info = null ) {
50  parent::__construct( $info );
51 
52  $this->hasSha1Storage = isset( $info['storageLayout'] )
53  && $info['storageLayout'] === 'sha1';
54 
55  if ( $this->hasSha1Storage() ) {
56  $this->backend = new FileBackendDBRepoWrapper( [
57  'backend' => $this->backend,
58  'repoName' => $this->name,
59  'dbHandleFactory' => $this->getDBFactory()
60  ] );
61  }
62  }
63 
69  function newFileFromRow( $row ) {
70  if ( isset( $row->img_name ) ) {
71  return call_user_func( $this->fileFromRowFactory, $row, $this );
72  } elseif ( isset( $row->oi_name ) ) {
73  return call_user_func( $this->oldFileFromRowFactory, $row, $this );
74  } else {
75  throw new MWException( __METHOD__ . ': invalid row' );
76  }
77  }
78 
84  function newFromArchiveName( $title, $archiveName ) {
85  return OldLocalFile::newFromArchiveName( $title, $this, $archiveName );
86  }
87 
98  function cleanupDeletedBatch( array $storageKeys ) {
99  if ( $this->hasSha1Storage() ) {
100  wfDebug( __METHOD__ . ": skipped because storage uses sha1 paths\n" );
101  return Status::newGood();
102  }
103 
104  $backend = $this->backend; // convenience
105  $root = $this->getZonePath( 'deleted' );
106  $dbw = $this->getMasterDB();
107  $status = $this->newGood();
108  $storageKeys = array_unique( $storageKeys );
109  foreach ( $storageKeys as $key ) {
110  $hashPath = $this->getDeletedHashPath( $key );
111  $path = "$root/$hashPath$key";
112  $dbw->startAtomic( __METHOD__ );
113  // Check for usage in deleted/hidden files and preemptively
114  // lock the key to avoid any future use until we are finished.
115  $deleted = $this->deletedFileHasKey( $key, 'lock' );
116  $hidden = $this->hiddenFileHasKey( $key, 'lock' );
117  if ( !$deleted && !$hidden ) { // not in use now
118  wfDebug( __METHOD__ . ": deleting $key\n" );
119  $op = [ 'op' => 'delete', 'src' => $path ];
120  if ( !$backend->doOperation( $op )->isOK() ) {
121  $status->error( 'undelete-cleanup-error', $path );
122  $status->failCount++;
123  }
124  } else {
125  wfDebug( __METHOD__ . ": $key still in use\n" );
126  $status->successCount++;
127  }
128  $dbw->endAtomic( __METHOD__ );
129  }
130 
131  return $status;
132  }
133 
141  protected function deletedFileHasKey( $key, $lock = null ) {
142  $options = ( $lock === 'lock' ) ? [ 'FOR UPDATE' ] : [];
143 
144  $dbw = $this->getMasterDB();
145 
146  return (bool)$dbw->selectField( 'filearchive', '1',
147  [ 'fa_storage_group' => 'deleted', 'fa_storage_key' => $key ],
148  __METHOD__, $options
149  );
150  }
151 
159  protected function hiddenFileHasKey( $key, $lock = null ) {
160  $options = ( $lock === 'lock' ) ? [ 'FOR UPDATE' ] : [];
161 
162  $sha1 = self::getHashFromKey( $key );
163  $ext = File::normalizeExtension( substr( $key, strcspn( $key, '.' ) + 1 ) );
164 
165  $dbw = $this->getMasterDB();
166 
167  return (bool)$dbw->selectField( 'oldimage', '1',
168  [ 'oi_sha1' => $sha1,
169  'oi_archive_name ' . $dbw->buildLike( $dbw->anyString(), ".$ext" ),
170  $dbw->bitAnd( 'oi_deleted', File::DELETED_FILE ) => File::DELETED_FILE ],
171  __METHOD__, $options
172  );
173  }
174 
181  public static function getHashFromKey( $key ) {
182  return strtok( $key, '.' );
183  }
184 
191  function checkRedirect( Title $title ) {
192  $title = File::normalizeTitle( $title, 'exception' );
193 
194  $memcKey = $this->getSharedCacheKey( 'image_redirect', md5( $title->getDBkey() ) );
195  if ( $memcKey === false ) {
196  $memcKey = $this->getLocalCacheKey( 'image_redirect', md5( $title->getDBkey() ) );
197  $expiry = 300; // no invalidation, 5 minutes
198  } else {
199  $expiry = 86400; // has invalidation, 1 day
200  }
201 
202  $method = __METHOD__;
203  $redirDbKey = ObjectCache::getMainWANInstance()->getWithSetCallback(
204  $memcKey,
205  $expiry,
206  function ( $oldValue, &$ttl, array &$setOpts ) use ( $method, $title ) {
207  $dbr = $this->getReplicaDB(); // possibly remote DB
208 
209  $setOpts += Database::getCacheSetOptions( $dbr );
210 
211  if ( $title instanceof Title ) {
212  $row = $dbr->selectRow(
213  [ 'page', 'redirect' ],
214  [ 'rd_namespace', 'rd_title' ],
215  [
216  'page_namespace' => $title->getNamespace(),
217  'page_title' => $title->getDBkey(),
218  'rd_from = page_id'
219  ],
220  $method
221  );
222  } else {
223  $row = false;
224  }
225 
226  return ( $row && $row->rd_namespace == NS_FILE )
227  ? Title::makeTitle( $row->rd_namespace, $row->rd_title )->getDBkey()
228  : ''; // negative cache
229  },
230  [ 'pcTTL' => WANObjectCache::TTL_PROC_LONG ]
231  );
232 
233  // @note: also checks " " for b/c
234  if ( $redirDbKey !== ' ' && strval( $redirDbKey ) !== '' ) {
235  // Page is a redirect to another file
236  return Title::newFromText( $redirDbKey, NS_FILE );
237  }
238 
239  return false; // no redirect
240  }
241 
242  public function findFiles( array $items, $flags = 0 ) {
243  $finalFiles = []; // map of (DB key => corresponding File) for matches
244 
245  $searchSet = []; // map of (normalized DB key => search params)
246  foreach ( $items as $item ) {
247  if ( is_array( $item ) ) {
248  $title = File::normalizeTitle( $item['title'] );
249  if ( $title ) {
250  $searchSet[$title->getDBkey()] = $item;
251  }
252  } else {
253  $title = File::normalizeTitle( $item );
254  if ( $title ) {
255  $searchSet[$title->getDBkey()] = [];
256  }
257  }
258  }
259 
260  $fileMatchesSearch = function ( File $file, array $search ) {
261  // Note: file name comparison done elsewhere (to handle redirects)
262  $user = ( !empty( $search['private'] ) && $search['private'] instanceof User )
263  ? $search['private']
264  : null;
265 
266  return (
267  $file->exists() &&
268  (
269  ( empty( $search['time'] ) && !$file->isOld() ) ||
270  ( !empty( $search['time'] ) && $search['time'] === $file->getTimestamp() )
271  ) &&
272  ( !empty( $search['private'] ) || !$file->isDeleted( File::DELETED_FILE ) ) &&
273  $file->userCan( File::DELETED_FILE, $user )
274  );
275  };
276 
277  $applyMatchingFiles = function ( ResultWrapper $res, &$searchSet, &$finalFiles )
278  use ( $fileMatchesSearch, $flags )
279  {
281  $info = $this->getInfo();
282  foreach ( $res as $row ) {
283  $file = $this->newFileFromRow( $row );
284  // There must have been a search for this DB key, but this has to handle the
285  // cases were title capitalization is different on the client and repo wikis.
286  $dbKeysLook = [ strtr( $file->getName(), ' ', '_' ) ];
287  if ( !empty( $info['initialCapital'] ) ) {
288  // Search keys for "hi.png" and "Hi.png" should use the "Hi.png file"
289  $dbKeysLook[] = $wgContLang->lcfirst( $file->getName() );
290  }
291  foreach ( $dbKeysLook as $dbKey ) {
292  if ( isset( $searchSet[$dbKey] )
293  && $fileMatchesSearch( $file, $searchSet[$dbKey] )
294  ) {
295  $finalFiles[$dbKey] = ( $flags & FileRepo::NAME_AND_TIME_ONLY )
296  ? [ 'title' => $dbKey, 'timestamp' => $file->getTimestamp() ]
297  : $file;
298  unset( $searchSet[$dbKey] );
299  }
300  }
301  }
302  };
303 
304  $dbr = $this->getReplicaDB();
305 
306  // Query image table
307  $imgNames = [];
308  foreach ( array_keys( $searchSet ) as $dbKey ) {
309  $imgNames[] = $this->getNameFromTitle( File::normalizeTitle( $dbKey ) );
310  }
311 
312  if ( count( $imgNames ) ) {
313  $fileQuery = LocalFile::getQueryInfo();
314  $res = $dbr->select( $fileQuery['tables'], $fileQuery['fields'], [ 'img_name' => $imgNames ],
315  __METHOD__, [], $fileQuery['joins'] );
316  $applyMatchingFiles( $res, $searchSet, $finalFiles );
317  }
318 
319  // Query old image table
320  $oiConds = []; // WHERE clause array for each file
321  foreach ( $searchSet as $dbKey => $search ) {
322  if ( isset( $search['time'] ) ) {
323  $oiConds[] = $dbr->makeList(
324  [
325  'oi_name' => $this->getNameFromTitle( File::normalizeTitle( $dbKey ) ),
326  'oi_timestamp' => $dbr->timestamp( $search['time'] )
327  ],
328  LIST_AND
329  );
330  }
331  }
332 
333  if ( count( $oiConds ) ) {
334  $fileQuery = OldLocalFile::getQueryInfo();
335  $res = $dbr->select( $fileQuery['tables'], $fileQuery['fields'],
336  $dbr->makeList( $oiConds, LIST_OR ),
337  __METHOD__, [], $fileQuery['joins'] );
338  $applyMatchingFiles( $res, $searchSet, $finalFiles );
339  }
340 
341  // Check for redirects...
342  foreach ( $searchSet as $dbKey => $search ) {
343  if ( !empty( $search['ignoreRedirect'] ) ) {
344  continue;
345  }
346 
347  $title = File::normalizeTitle( $dbKey );
348  $redir = $this->checkRedirect( $title ); // hopefully hits memcached
349 
350  if ( $redir && $redir->getNamespace() == NS_FILE ) {
351  $file = $this->newFile( $redir );
352  if ( $file && $fileMatchesSearch( $file, $search ) ) {
353  $file->redirectedFrom( $title->getDBkey() );
354  if ( $flags & FileRepo::NAME_AND_TIME_ONLY ) {
355  $finalFiles[$dbKey] = [
356  'title' => $file->getTitle()->getDBkey(),
357  'timestamp' => $file->getTimestamp()
358  ];
359  } else {
360  $finalFiles[$dbKey] = $file;
361  }
362  }
363  }
364  }
365 
366  return $finalFiles;
367  }
368 
376  function findBySha1( $hash ) {
377  $dbr = $this->getReplicaDB();
378  $fileQuery = LocalFile::getQueryInfo();
379  $res = $dbr->select(
380  $fileQuery['tables'],
381  $fileQuery['fields'],
382  [ 'img_sha1' => $hash ],
383  __METHOD__,
384  [ 'ORDER BY' => 'img_name' ],
385  $fileQuery['joins']
386  );
387 
388  $result = [];
389  foreach ( $res as $row ) {
390  $result[] = $this->newFileFromRow( $row );
391  }
392  $res->free();
393 
394  return $result;
395  }
396 
406  function findBySha1s( array $hashes ) {
407  if ( !count( $hashes ) ) {
408  return []; // empty parameter
409  }
410 
411  $dbr = $this->getReplicaDB();
412  $fileQuery = LocalFile::getQueryInfo();
413  $res = $dbr->select(
414  $fileQuery['tables'],
415  $fileQuery['fields'],
416  [ 'img_sha1' => $hashes ],
417  __METHOD__,
418  [ 'ORDER BY' => 'img_name' ],
419  $fileQuery['joins']
420  );
421 
422  $result = [];
423  foreach ( $res as $row ) {
424  $file = $this->newFileFromRow( $row );
425  $result[$file->getSha1()][] = $file;
426  }
427  $res->free();
428 
429  return $result;
430  }
431 
439  public function findFilesByPrefix( $prefix, $limit ) {
440  $selectOptions = [ 'ORDER BY' => 'img_name', 'LIMIT' => intval( $limit ) ];
441 
442  // Query database
443  $dbr = $this->getReplicaDB();
444  $fileQuery = LocalFile::getQueryInfo();
445  $res = $dbr->select(
446  $fileQuery['tables'],
447  $fileQuery['fields'],
448  'img_name ' . $dbr->buildLike( $prefix, $dbr->anyString() ),
449  __METHOD__,
450  $selectOptions,
451  $fileQuery['joins']
452  );
453 
454  // Build file objects
455  $files = [];
456  foreach ( $res as $row ) {
457  $files[] = $this->newFileFromRow( $row );
458  }
459 
460  return $files;
461  }
462 
467  function getReplicaDB() {
468  return wfGetDB( DB_REPLICA );
469  }
470 
477  function getSlaveDB() {
478  return $this->getReplicaDB();
479  }
480 
485  function getMasterDB() {
486  return wfGetDB( DB_MASTER );
487  }
488 
493  protected function getDBFactory() {
494  return function ( $index ) {
495  return wfGetDB( $index );
496  };
497  }
498 
506  function getSharedCacheKey( /*...*/ ) {
507  $args = func_get_args();
508 
509  return call_user_func_array( 'wfMemcKey', $args );
510  }
511 
519  $key = $this->getSharedCacheKey( 'image_redirect', md5( $title->getDBkey() ) );
520  if ( $key ) {
521  $this->getMasterDB()->onTransactionPreCommitOrIdle(
522  function () use ( $key ) {
523  ObjectCache::getMainWANInstance()->delete( $key );
524  },
525  __METHOD__
526  );
527  }
528  }
529 
536  function getInfo() {
538 
539  return array_merge( parent::getInfo(), [
540  'favicon' => wfExpandUrl( $wgFavicon ),
541  ] );
542  }
543 
544  public function store( $srcPath, $dstZone, $dstRel, $flags = 0 ) {
545  return $this->skipWriteOperationIfSha1( __FUNCTION__, func_get_args() );
546  }
547 
548  public function storeBatch( array $triplets, $flags = 0 ) {
549  return $this->skipWriteOperationIfSha1( __FUNCTION__, func_get_args() );
550  }
551 
552  public function cleanupBatch( array $files, $flags = 0 ) {
553  return $this->skipWriteOperationIfSha1( __FUNCTION__, func_get_args() );
554  }
555 
556  public function publish(
557  $src,
558  $dstRel,
559  $archiveRel,
560  $flags = 0,
561  array $options = []
562  ) {
563  return $this->skipWriteOperationIfSha1( __FUNCTION__, func_get_args() );
564  }
565 
566  public function publishBatch( array $ntuples, $flags = 0 ) {
567  return $this->skipWriteOperationIfSha1( __FUNCTION__, func_get_args() );
568  }
569 
570  public function delete( $srcRel, $archiveRel ) {
571  return $this->skipWriteOperationIfSha1( __FUNCTION__, func_get_args() );
572  }
573 
574  public function deleteBatch( array $sourceDestPairs ) {
575  return $this->skipWriteOperationIfSha1( __FUNCTION__, func_get_args() );
576  }
577 
585  protected function skipWriteOperationIfSha1( $function, array $args ) {
586  $this->assertWritableRepo(); // fail out if read-only
587 
588  if ( $this->hasSha1Storage() ) {
589  wfDebug( __METHOD__ . ": skipped because storage uses sha1 paths\n" );
590  return Status::newGood();
591  } else {
592  return call_user_func_array( 'parent::' . $function, $args );
593  }
594  }
595 }
$user
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a account $user
Definition: hooks.txt:247
File\redirectedFrom
redirectedFrom( $from)
Definition: File.php:2264
Wikimedia\Rdbms\Database
Relational database abstraction object.
Definition: Database.php:48
Title\newFromText
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:273
LocalRepo\getInfo
getInfo()
Return information about the repository.
Definition: LocalRepo.php:536
LocalRepo\newFileFromRow
newFileFromRow( $row)
Definition: LocalRepo.php:69
use
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: APACHE-LICENSE-2.0.txt:10
FileRepo\newGood
newGood( $value=null)
Create a new good result.
Definition: FileRepo.php:1760
array
the array() calling protocol came about after MediaWiki 1.4rc1.
LocalRepo\getMasterDB
getMasterDB()
Get a connection to the master DB.
Definition: LocalRepo.php:485
OldLocalFile\getQueryInfo
static getQueryInfo(array $options=[])
Return the tables, fields, and join conditions to be selected to create a new oldlocalfile object.
Definition: OldLocalFile.php:157
LocalRepo\getReplicaDB
getReplicaDB()
Get a connection to the replica DB.
Definition: LocalRepo.php:467
LocalRepo\publish
publish( $src, $dstRel, $archiveRel, $flags=0, array $options=[])
Copy or move a file either from a storage path, virtual URL, or file system path, into this repositor...
Definition: LocalRepo.php:556
LocalRepo\deletedFileHasKey
deletedFileHasKey( $key, $lock=null)
Check if a deleted (filearchive) file has this sha1 key.
Definition: LocalRepo.php:141
File\getTimestamp
getTimestamp()
Get the 14-character timestamp of the file upload.
Definition: File.php:2115
LocalRepo\$oldFileFactoryKey
callable $oldFileFactoryKey
Definition: LocalRepo.php:47
NS_FILE
const NS_FILE
Definition: Defines.php:80
LocalRepo\$oldFileFactory
callable $oldFileFactory
Definition: LocalRepo.php:45
FileRepo\getZonePath
getZonePath( $zone)
Get the storage path corresponding to one of the zones.
Definition: FileRepo.php:366
$res
$res
Definition: database.txt:21
Wikimedia\Rdbms\ResultWrapper
Result wrapper for grabbing data queried from an IDatabase object.
Definition: ResultWrapper.php:24
FileRepo\$backend
FileBackend $backend
Definition: FileRepo.php:59
User
User
Definition: All_system_messages.txt:425
$result
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. 'ImgAuthModifyHeaders':Executed just before a file is streamed to a user via img_auth.php, allowing headers to be modified beforehand. $title:LinkTarget object & $headers:HTTP headers(name=> value, names are case insensitive). Two headers get special handling:If-Modified-Since(value must be a valid HTTP date) and Range(must be of the form "bytes=(\d*-\d*)") will be honored when streaming the file. '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. 'LanguageGetMagic':DEPRECATED! Use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language & $magicExtensions:associative array of magic words synonyms $lang:language code(string) '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 'LanguageGetSpecialPageAliases':DEPRECATED! Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language & $specialPageAliases:associative array of magic words synonyms $lang:language code(string) '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! 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:1993
File\isDeleted
isDeleted( $field)
Is this file a "deleted" file in a private archive? STUB.
Definition: File.php:1895
LocalRepo\hiddenFileHasKey
hiddenFileHasKey( $key, $lock=null)
Check if a hidden (revision delete) file has this sha1 key.
Definition: LocalRepo.php:159
LocalRepo\getHashFromKey
static getHashFromKey( $key)
Gets the SHA1 hash from a storage key.
Definition: LocalRepo.php:181
File\normalizeTitle
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:184
php
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:37
LIST_AND
const LIST_AND
Definition: Defines.php:53
File\exists
exists()
Returns true if file exists in the repository.
Definition: File.php:896
Wikimedia\Rdbms\IDatabase
Basic database interface for live and lazy-loaded relation database handles.
Definition: IDatabase.php:38
$dbr
$dbr
Definition: testCompression.php:50
FileRepo
Base class for file repositories.
Definition: FileRepo.php:37
FileRepo\hasSha1Storage
hasSha1Storage()
Returns whether or not storage is SHA-1 based.
Definition: FileRepo.php:1944
File
Implements some public methods and some protected utility functions which are required by multiple ch...
Definition: File.php:51
LocalRepo\$oldFileFromRowFactory
callable $oldFileFromRowFactory
Definition: LocalRepo.php:43
LIST_OR
const LIST_OR
Definition: Defines.php:56
FileRepo\newFile
newFile( $title, $time=false)
Create a new File object from the local repository.
Definition: FileRepo.php:390
MWException
MediaWiki exception.
Definition: MWException.php:26
LocalRepo\getSlaveDB
getSlaveDB()
Alias for getReplicaDB()
Definition: LocalRepo.php:477
FileBackend\doOperation
doOperation(array $op, array $opts=[])
Same as doOperations() except it takes a single operation.
Definition: FileBackend.php:460
wfGetDB
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
Definition: GlobalFunctions.php:2812
File\normalizeExtension
static normalizeExtension( $extension)
Normalize a file extension to the common form, making it lowercase and checking some synonyms,...
Definition: File.php:224
LocalRepo\store
store( $srcPath, $dstZone, $dstRel, $flags=0)
Store a file to a given destination.
Definition: LocalRepo.php:544
LocalRepo\getDBFactory
getDBFactory()
Get a callback to get a DB handle given an index (DB_REPLICA/DB_MASTER)
Definition: LocalRepo.php:493
LocalRepo\invalidateImageRedirect
invalidateImageRedirect(Title $title)
Invalidates image redirect cache related to that image.
Definition: LocalRepo.php:518
LocalRepo\storeBatch
storeBatch(array $triplets, $flags=0)
Store a batch of files.
Definition: LocalRepo.php:548
$title
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:964
Title\makeTitle
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:534
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:95
DB_REPLICA
const DB_REPLICA
Definition: defines.php:25
DB_MASTER
const DB_MASTER
Definition: defines.php:26
wfDebug
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
Definition: GlobalFunctions.php:994
LocalRepo\cleanupBatch
cleanupBatch(array $files, $flags=0)
Deletes a batch of files.
Definition: LocalRepo.php:552
LocalRepo\findFiles
findFiles(array $items, $flags=0)
Find many files at once.
Definition: LocalRepo.php:242
FileRepo\getNameFromTitle
getNameFromTitle(Title $title)
Get the name of a file from its title object.
Definition: FileRepo.php:650
$options
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:2001
LocalRepo\newFromArchiveName
newFromArchiveName( $title, $archiveName)
Definition: LocalRepo.php:84
File\isOld
isOld()
Returns true if the image is an old version STUB.
Definition: File.php:1884
StatusValue\newGood
static newGood( $value=null)
Factory function for good results.
Definition: StatusValue.php:81
LocalRepo\$fileFactory
callable $fileFactory
Definition: LocalRepo.php:37
LocalRepo\$fileFactoryKey
callable $fileFactoryKey
Definition: LocalRepo.php:39
File\getName
getName()
Return the name of this file.
Definition: File.php:297
$status
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. '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 'DatabaseOraclePostInit':Called after initialising an Oracle database $db:the DatabaseOracle object '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:1255
LocalRepo\findBySha1s
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:406
$wgFavicon
$wgFavicon
The URL path of the shortcut icon.
Definition: DefaultSettings.php:316
FileRepo\getLocalCacheKey
getLocalCacheKey()
Get a key for this repo in the local cache domain.
Definition: FileRepo.php:1849
LocalRepo\findFilesByPrefix
findFilesByPrefix( $prefix, $limit)
Return an array of files where the name starts with $prefix.
Definition: LocalRepo.php:439
LocalRepo\checkRedirect
checkRedirect(Title $title)
Checks if there is a redirect named as $title.
Definition: LocalRepo.php:191
$args
if( $line===false) $args
Definition: cdb.php:64
File\getTitle
getTitle()
Return the associated title object.
Definition: File.php:326
LocalFile\getQueryInfo
static getQueryInfo(array $options=[])
Return the tables, fields, and join conditions to be selected to create a new localfile object.
Definition: LocalFile.php:243
Title
Represents a title within MediaWiki.
Definition: Title.php:39
LocalRepo\cleanupDeletedBatch
cleanupDeletedBatch(array $storageKeys)
Delete files in the deleted directory if they are not referenced in the filearchive table.
Definition: LocalRepo.php:98
ObjectCache\getMainWANInstance
static getMainWANInstance()
Get the main WAN cache object.
Definition: ObjectCache.php:380
LocalRepo\getSharedCacheKey
getSharedCacheKey()
Get a key on the primary cache for this repository.
Definition: LocalRepo.php:506
$path
$path
Definition: NoLocalSettings.php:25
as
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:22
LocalRepo\deleteBatch
deleteBatch(array $sourceDestPairs)
Move a group of files to the deletion archive.
Definition: LocalRepo.php:574
LocalRepo\findBySha1
findBySha1( $hash)
Get an array or iterator of file objects for files that have a given SHA-1 content hash.
Definition: LocalRepo.php:376
$hashes
$hashes
Definition: testCompression.php:66
File\DELETED_FILE
const DELETED_FILE
Definition: File.php:53
LocalRepo\skipWriteOperationIfSha1
skipWriteOperationIfSha1( $function, array $args)
Skips the write operation if storage is sha1-based, executes it normally otherwise.
Definition: LocalRepo.php:585
name
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at name
Definition: design.txt:12
class
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:56
LocalRepo\__construct
__construct(array $info=null)
Definition: LocalRepo.php:49
File\userCan
userCan( $field, User $user=null)
Determine if the current user is allowed to view a particular field of this file, if it's marked as d...
Definition: File.php:2167
$ext
$ext
Definition: router.php:55
OldLocalFile\newFromArchiveName
static newFromArchiveName( $title, $repo, $archiveName)
Definition: OldLocalFile.php:61
LocalRepo\publishBatch
publishBatch(array $ntuples, $flags=0)
Publish a batch of files.
Definition: LocalRepo.php:566
FileRepo\getDeletedHashPath
getDeletedHashPath( $key)
Get a relative path for a deletion archive key, e.g.
Definition: FileRepo.php:1501
FileRepo\assertWritableRepo
assertWritableRepo()
Throw an exception if this repo is read-only by design.
Definition: FileRepo.php:1910
FileRepo\NAME_AND_TIME_ONLY
const NAME_AND_TIME_ONLY
Definition: FileRepo.php:43
FileBackendDBRepoWrapper
Proxy backend that manages file layout rewriting for FileRepo.
Definition: FileBackendDBRepoWrapper.php:41
LocalRepo
A repository that stores files in the local filesystem and registers them in the wiki's own database.
Definition: LocalRepo.php:35
IExpiringStore\TTL_PROC_LONG
const TTL_PROC_LONG
Definition: IExpiringStore.php:43
wfExpandUrl
wfExpandUrl( $url, $defaultProto=PROTO_CURRENT)
Expand a potentially local URL to a fully-qualified URL.
Definition: GlobalFunctions.php:521
$wgContLang
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as and the content language as $wgContLang
Definition: design.txt:57
LocalRepo\$fileFromRowFactory
callable $fileFromRowFactory
Definition: LocalRepo.php:41