MediaWiki  1.28.1
LocalRepo.php
Go to the documentation of this file.
1 <?php
31 class LocalRepo extends FileRepo {
33  protected $fileFactory = [ 'LocalFile', 'newFromTitle' ];
35  protected $fileFactoryKey = [ 'LocalFile', 'newFromKey' ];
37  protected $fileFromRowFactory = [ 'LocalFile', 'newFromRow' ];
39  protected $oldFileFromRowFactory = [ 'OldLocalFile', 'newFromRow' ];
41  protected $oldFileFactory = [ 'OldLocalFile', 'newFromTitle' ];
43  protected $oldFileFactoryKey = [ 'OldLocalFile', 'newFromKey' ];
44 
45  function __construct( array $info = null ) {
46  parent::__construct( $info );
47 
48  $this->hasSha1Storage = isset( $info['storageLayout'] )
49  && $info['storageLayout'] === 'sha1';
50 
51  if ( $this->hasSha1Storage() ) {
52  $this->backend = new FileBackendDBRepoWrapper( [
53  'backend' => $this->backend,
54  'repoName' => $this->name,
55  'dbHandleFactory' => $this->getDBFactory()
56  ] );
57  }
58  }
59 
65  function newFileFromRow( $row ) {
66  if ( isset( $row->img_name ) ) {
67  return call_user_func( $this->fileFromRowFactory, $row, $this );
68  } elseif ( isset( $row->oi_name ) ) {
69  return call_user_func( $this->oldFileFromRowFactory, $row, $this );
70  } else {
71  throw new MWException( __METHOD__ . ': invalid row' );
72  }
73  }
74 
80  function newFromArchiveName( $title, $archiveName ) {
81  return OldLocalFile::newFromArchiveName( $title, $this, $archiveName );
82  }
83 
94  function cleanupDeletedBatch( array $storageKeys ) {
95  if ( $this->hasSha1Storage() ) {
96  wfDebug( __METHOD__ . ": skipped because storage uses sha1 paths\n" );
97  return Status::newGood();
98  }
99 
100  $backend = $this->backend; // convenience
101  $root = $this->getZonePath( 'deleted' );
102  $dbw = $this->getMasterDB();
103  $status = $this->newGood();
104  $storageKeys = array_unique( $storageKeys );
105  foreach ( $storageKeys as $key ) {
106  $hashPath = $this->getDeletedHashPath( $key );
107  $path = "$root/$hashPath$key";
108  $dbw->startAtomic( __METHOD__ );
109  // Check for usage in deleted/hidden files and preemptively
110  // lock the key to avoid any future use until we are finished.
111  $deleted = $this->deletedFileHasKey( $key, 'lock' );
112  $hidden = $this->hiddenFileHasKey( $key, 'lock' );
113  if ( !$deleted && !$hidden ) { // not in use now
114  wfDebug( __METHOD__ . ": deleting $key\n" );
115  $op = [ 'op' => 'delete', 'src' => $path ];
116  if ( !$backend->doOperation( $op )->isOK() ) {
117  $status->error( 'undelete-cleanup-error', $path );
118  $status->failCount++;
119  }
120  } else {
121  wfDebug( __METHOD__ . ": $key still in use\n" );
122  $status->successCount++;
123  }
124  $dbw->endAtomic( __METHOD__ );
125  }
126 
127  return $status;
128  }
129 
137  protected function deletedFileHasKey( $key, $lock = null ) {
138  $options = ( $lock === 'lock' ) ? [ 'FOR UPDATE' ] : [];
139 
140  $dbw = $this->getMasterDB();
141 
142  return (bool)$dbw->selectField( 'filearchive', '1',
143  [ 'fa_storage_group' => 'deleted', 'fa_storage_key' => $key ],
144  __METHOD__, $options
145  );
146  }
147 
155  protected function hiddenFileHasKey( $key, $lock = null ) {
156  $options = ( $lock === 'lock' ) ? [ 'FOR UPDATE' ] : [];
157 
158  $sha1 = self::getHashFromKey( $key );
159  $ext = File::normalizeExtension( substr( $key, strcspn( $key, '.' ) + 1 ) );
160 
161  $dbw = $this->getMasterDB();
162 
163  return (bool)$dbw->selectField( 'oldimage', '1',
164  [ 'oi_sha1' => $sha1,
165  'oi_archive_name ' . $dbw->buildLike( $dbw->anyString(), ".$ext" ),
166  $dbw->bitAnd( 'oi_deleted', File::DELETED_FILE ) => File::DELETED_FILE ],
167  __METHOD__, $options
168  );
169  }
170 
177  public static function getHashFromKey( $key ) {
178  return strtok( $key, '.' );
179  }
180 
187  function checkRedirect( Title $title ) {
188  $title = File::normalizeTitle( $title, 'exception' );
189 
190  $memcKey = $this->getSharedCacheKey( 'image_redirect', md5( $title->getDBkey() ) );
191  if ( $memcKey === false ) {
192  $memcKey = $this->getLocalCacheKey( 'image_redirect', md5( $title->getDBkey() ) );
193  $expiry = 300; // no invalidation, 5 minutes
194  } else {
195  $expiry = 86400; // has invalidation, 1 day
196  }
197 
198  $that = $this;
199  $redirDbKey = ObjectCache::getMainWANInstance()->getWithSetCallback(
200  $memcKey,
201  $expiry,
202  function ( $oldValue, &$ttl, array &$setOpts ) use ( $that, $title ) {
203  $dbr = $that->getSlaveDB(); // possibly remote DB
204 
205  $setOpts += Database::getCacheSetOptions( $dbr );
206 
207  if ( $title instanceof Title ) {
208  $row = $dbr->selectRow(
209  [ 'page', 'redirect' ],
210  [ 'rd_namespace', 'rd_title' ],
211  [
212  'page_namespace' => $title->getNamespace(),
213  'page_title' => $title->getDBkey(),
214  'rd_from = page_id'
215  ],
216  __METHOD__
217  );
218  } else {
219  $row = false;
220  }
221 
222  return ( $row && $row->rd_namespace == NS_FILE )
223  ? Title::makeTitle( $row->rd_namespace, $row->rd_title )->getDBkey()
224  : ''; // negative cache
225  },
226  [ 'pcTTL' => WANObjectCache::TTL_PROC_LONG ]
227  );
228 
229  // @note: also checks " " for b/c
230  if ( $redirDbKey !== ' ' && strval( $redirDbKey ) !== '' ) {
231  // Page is a redirect to another file
232  return Title::newFromText( $redirDbKey, NS_FILE );
233  }
234 
235  return false; // no redirect
236  }
237 
238  public function findFiles( array $items, $flags = 0 ) {
239  $finalFiles = []; // map of (DB key => corresponding File) for matches
240 
241  $searchSet = []; // map of (normalized DB key => search params)
242  foreach ( $items as $item ) {
243  if ( is_array( $item ) ) {
244  $title = File::normalizeTitle( $item['title'] );
245  if ( $title ) {
246  $searchSet[$title->getDBkey()] = $item;
247  }
248  } else {
249  $title = File::normalizeTitle( $item );
250  if ( $title ) {
251  $searchSet[$title->getDBkey()] = [];
252  }
253  }
254  }
255 
256  $fileMatchesSearch = function ( File $file, array $search ) {
257  // Note: file name comparison done elsewhere (to handle redirects)
258  $user = ( !empty( $search['private'] ) && $search['private'] instanceof User )
259  ? $search['private']
260  : null;
261 
262  return (
263  $file->exists() &&
264  (
265  ( empty( $search['time'] ) && !$file->isOld() ) ||
266  ( !empty( $search['time'] ) && $search['time'] === $file->getTimestamp() )
267  ) &&
268  ( !empty( $search['private'] ) || !$file->isDeleted( File::DELETED_FILE ) ) &&
269  $file->userCan( File::DELETED_FILE, $user )
270  );
271  };
272 
273  $that = $this;
274  $applyMatchingFiles = function ( ResultWrapper $res, &$searchSet, &$finalFiles )
275  use ( $that, $fileMatchesSearch, $flags )
276  {
278  $info = $that->getInfo();
279  foreach ( $res as $row ) {
280  $file = $that->newFileFromRow( $row );
281  // There must have been a search for this DB key, but this has to handle the
282  // cases were title capitalization is different on the client and repo wikis.
283  $dbKeysLook = [ strtr( $file->getName(), ' ', '_' ) ];
284  if ( !empty( $info['initialCapital'] ) ) {
285  // Search keys for "hi.png" and "Hi.png" should use the "Hi.png file"
286  $dbKeysLook[] = $wgContLang->lcfirst( $file->getName() );
287  }
288  foreach ( $dbKeysLook as $dbKey ) {
289  if ( isset( $searchSet[$dbKey] )
290  && $fileMatchesSearch( $file, $searchSet[$dbKey] )
291  ) {
292  $finalFiles[$dbKey] = ( $flags & FileRepo::NAME_AND_TIME_ONLY )
293  ? [ 'title' => $dbKey, 'timestamp' => $file->getTimestamp() ]
294  : $file;
295  unset( $searchSet[$dbKey] );
296  }
297  }
298  }
299  };
300 
301  $dbr = $this->getSlaveDB();
302 
303  // Query image table
304  $imgNames = [];
305  foreach ( array_keys( $searchSet ) as $dbKey ) {
306  $imgNames[] = $this->getNameFromTitle( File::normalizeTitle( $dbKey ) );
307  }
308 
309  if ( count( $imgNames ) ) {
310  $res = $dbr->select( 'image',
311  LocalFile::selectFields(), [ 'img_name' => $imgNames ], __METHOD__ );
312  $applyMatchingFiles( $res, $searchSet, $finalFiles );
313  }
314 
315  // Query old image table
316  $oiConds = []; // WHERE clause array for each file
317  foreach ( $searchSet as $dbKey => $search ) {
318  if ( isset( $search['time'] ) ) {
319  $oiConds[] = $dbr->makeList(
320  [
321  'oi_name' => $this->getNameFromTitle( File::normalizeTitle( $dbKey ) ),
322  'oi_timestamp' => $dbr->timestamp( $search['time'] )
323  ],
324  LIST_AND
325  );
326  }
327  }
328 
329  if ( count( $oiConds ) ) {
330  $res = $dbr->select( 'oldimage',
331  OldLocalFile::selectFields(), $dbr->makeList( $oiConds, LIST_OR ), __METHOD__ );
332  $applyMatchingFiles( $res, $searchSet, $finalFiles );
333  }
334 
335  // Check for redirects...
336  foreach ( $searchSet as $dbKey => $search ) {
337  if ( !empty( $search['ignoreRedirect'] ) ) {
338  continue;
339  }
340 
341  $title = File::normalizeTitle( $dbKey );
342  $redir = $this->checkRedirect( $title ); // hopefully hits memcached
343 
344  if ( $redir && $redir->getNamespace() == NS_FILE ) {
345  $file = $this->newFile( $redir );
346  if ( $file && $fileMatchesSearch( $file, $search ) ) {
347  $file->redirectedFrom( $title->getDBkey() );
349  $finalFiles[$dbKey] = [
350  'title' => $file->getTitle()->getDBkey(),
351  'timestamp' => $file->getTimestamp()
352  ];
353  } else {
354  $finalFiles[$dbKey] = $file;
355  }
356  }
357  }
358  }
359 
360  return $finalFiles;
361  }
362 
370  function findBySha1( $hash ) {
371  $dbr = $this->getSlaveDB();
372  $res = $dbr->select(
373  'image',
375  [ 'img_sha1' => $hash ],
376  __METHOD__,
377  [ 'ORDER BY' => 'img_name' ]
378  );
379 
380  $result = [];
381  foreach ( $res as $row ) {
382  $result[] = $this->newFileFromRow( $row );
383  }
384  $res->free();
385 
386  return $result;
387  }
388 
398  function findBySha1s( array $hashes ) {
399  if ( !count( $hashes ) ) {
400  return []; // empty parameter
401  }
402 
403  $dbr = $this->getSlaveDB();
404  $res = $dbr->select(
405  'image',
407  [ 'img_sha1' => $hashes ],
408  __METHOD__,
409  [ 'ORDER BY' => 'img_name' ]
410  );
411 
412  $result = [];
413  foreach ( $res as $row ) {
414  $file = $this->newFileFromRow( $row );
415  $result[$file->getSha1()][] = $file;
416  }
417  $res->free();
418 
419  return $result;
420  }
421 
429  public function findFilesByPrefix( $prefix, $limit ) {
430  $selectOptions = [ 'ORDER BY' => 'img_name', 'LIMIT' => intval( $limit ) ];
431 
432  // Query database
433  $dbr = $this->getSlaveDB();
434  $res = $dbr->select(
435  'image',
437  'img_name ' . $dbr->buildLike( $prefix, $dbr->anyString() ),
438  __METHOD__,
439  $selectOptions
440  );
441 
442  // Build file objects
443  $files = [];
444  foreach ( $res as $row ) {
445  $files[] = $this->newFileFromRow( $row );
446  }
447 
448  return $files;
449  }
450 
455  function getSlaveDB() {
456  return wfGetDB( DB_REPLICA );
457  }
458 
463  function getMasterDB() {
464  return wfGetDB( DB_MASTER );
465  }
466 
471  protected function getDBFactory() {
472  return function( $index ) {
473  return wfGetDB( $index );
474  };
475  }
476 
484  function getSharedCacheKey( /*...*/ ) {
485  $args = func_get_args();
486 
487  return call_user_func_array( 'wfMemcKey', $args );
488  }
489 
497  $key = $this->getSharedCacheKey( 'image_redirect', md5( $title->getDBkey() ) );
498  if ( $key ) {
499  $this->getMasterDB()->onTransactionPreCommitOrIdle(
500  function () use ( $key ) {
501  ObjectCache::getMainWANInstance()->delete( $key );
502  },
503  __METHOD__
504  );
505  }
506  }
507 
514  function getInfo() {
516 
517  return array_merge( parent::getInfo(), [
518  'favicon' => wfExpandUrl( $wgFavicon ),
519  ] );
520  }
521 
522  public function store( $srcPath, $dstZone, $dstRel, $flags = 0 ) {
523  return $this->skipWriteOperationIfSha1( __FUNCTION__, func_get_args() );
524  }
525 
526  public function storeBatch( array $triplets, $flags = 0 ) {
527  return $this->skipWriteOperationIfSha1( __FUNCTION__, func_get_args() );
528  }
529 
530  public function cleanupBatch( array $files, $flags = 0 ) {
531  return $this->skipWriteOperationIfSha1( __FUNCTION__, func_get_args() );
532  }
533 
534  public function publish(
535  $src,
536  $dstRel,
537  $archiveRel,
538  $flags = 0,
539  array $options = []
540  ) {
541  return $this->skipWriteOperationIfSha1( __FUNCTION__, func_get_args() );
542  }
543 
544  public function publishBatch( array $ntuples, $flags = 0 ) {
545  return $this->skipWriteOperationIfSha1( __FUNCTION__, func_get_args() );
546  }
547 
548  public function delete( $srcRel, $archiveRel ) {
549  return $this->skipWriteOperationIfSha1( __FUNCTION__, func_get_args() );
550  }
551 
552  public function deleteBatch( array $sourceDestPairs ) {
553  return $this->skipWriteOperationIfSha1( __FUNCTION__, func_get_args() );
554  }
555 
563  protected function skipWriteOperationIfSha1( $function, array $args ) {
564  $this->assertWritableRepo(); // fail out if read-only
565 
566  if ( $this->hasSha1Storage() ) {
567  wfDebug( __METHOD__ . ": skipped because storage uses sha1 paths\n" );
568  return Status::newGood();
569  } else {
570  return call_user_func_array( 'parent::' . $function, $args );
571  }
572  }
573 }
assertWritableRepo()
Throw an exception if this repo is read-only by design.
Definition: FileRepo.php:1881
static getMainWANInstance()
Get the main WAN cache object.
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:183
newFileFromRow($row)
Definition: LocalRepo.php:65
wfGetDB($db, $groups=[], $wiki=false)
Get a Database object.
the array() calling protocol came about after MediaWiki 1.4rc1.
newFromArchiveName($title, $archiveName)
Definition: LocalRepo.php:80
getSlaveDB()
Get a connection to the replica DB.
Definition: LocalRepo.php:455
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:2146
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
static getCacheSetOptions(IDatabase $db1)
Merge the result of getSessionLagStatus() for several DBs using the most pessimistic values to estima...
Definition: Database.php:3039
static newFromArchiveName($title, $repo, $archiveName)
getLocalCacheKey()
Get a key for this repo in the local cache domain.
Definition: FileRepo.php:1820
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:398
A repository that stores files in the local filesystem and registers them in the wiki's own database...
Definition: LocalRepo.php:31
$files
getName()
Return the name of this file.
Definition: File.php:296
it s the revision text itself In either if gzip is the revision text is gzipped $flags
Definition: hooks.txt:2703
doOperation(array $op, array $opts=[])
Same as doOperations() except it takes a single operation.
publishBatch(array $ntuples, $flags=0)
Definition: LocalRepo.php:544
cleanupBatch(array $files, $flags=0)
Definition: LocalRepo.php:530
static newFromText($text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:262
when a variable name is used in a it is silently declared as a new local masking the global
Definition: design.txt:93
isOld()
Returns true if the image is an old version STUB.
Definition: File.php:1863
wfExpandUrl($url, $defaultProto=PROTO_CURRENT)
Expand a potentially local URL to a fully-qualified URL.
getSharedCacheKey()
Get a key on the primary cache for this repository.
Definition: LocalRepo.php:484
getTitle()
Return the associated title object.
Definition: File.php:325
const DB_MASTER
Definition: defines.php:23
static normalizeExtension($extension)
Normalize a file extension to the common form, making it lowercase and checking some synonyms...
Definition: File.php:223
callable $oldFileFromRowFactory
Definition: LocalRepo.php:39
deleteBatch(array $sourceDestPairs)
Definition: LocalRepo.php:552
wfDebug($text, $dest= 'all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
const DELETED_FILE
Definition: File.php:52
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 '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:Associative array mapping language codes to prefixed links of the form"language:title".&$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:1934
if($line===false) $args
Definition: cdb.php:64
findBySha1($hash)
Get an array or iterator of file objects for files that have a given SHA-1 content hash...
Definition: LocalRepo.php:370
findFilesByPrefix($prefix, $limit)
Return an array of files where the name starts with $prefix.
Definition: LocalRepo.php:429
publish($src, $dstRel, $archiveRel, $flags=0, array $options=[])
Definition: LocalRepo.php:534
invalidateImageRedirect(Title $title)
Invalidates image redirect cache related to that image.
Definition: LocalRepo.php:496
deletedFileHasKey($key, $lock=null)
Check if a deleted (filearchive) file has this sha1 key.
Definition: LocalRepo.php:137
callable $fileFactoryKey
Definition: LocalRepo.php:35
const LIST_AND
Definition: Defines.php:35
isDeleted($field)
Is this file a "deleted" file in a private archive? STUB.
Definition: File.php:1874
getMasterDB()
Get a connection to the master DB.
Definition: LocalRepo.php:463
getDBkey()
Get the main part with underscores.
Definition: Title.php:898
cleanupDeletedBatch(array $storageKeys)
Delete files in the deleted directory if they are not referenced in the filearchive table...
Definition: LocalRepo.php:94
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context $options
Definition: hooks.txt:1046
$res
Definition: database.txt:21
static selectFields()
Fields in the image table.
Definition: LocalFile.php:196
hiddenFileHasKey($key, $lock=null)
Check if a hidden (revision delete) file has this sha1 key.
Definition: LocalRepo.php:155
newFile($title, $time=false)
Create a new File object from the local repository.
Definition: FileRepo.php:387
getDBFactory()
Get a callback to get a DB handle given an index (DB_REPLICA/DB_MASTER)
Definition: LocalRepo.php:471
static selectFields()
Fields in the oldimage table.
getInfo()
Return information about the repository.
Definition: LocalRepo.php:514
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:953
static newGood($value=null)
Factory function for good results.
Definition: StatusValue.php:76
getNamespace()
Get the namespace index, i.e.
Definition: Title.php:921
const NS_FILE
Definition: Defines.php:62
__construct(array $info=null)
Definition: LocalRepo.php:45
callable $fileFactory
Definition: LocalRepo.php:33
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
getNameFromTitle(Title $title)
Get the name of a file from its title object.
Definition: FileRepo.php:629
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 local account $user
Definition: hooks.txt:242
const LIST_OR
Definition: Defines.php:38
const NAME_AND_TIME_ONLY
Definition: FileRepo.php:43
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
skipWriteOperationIfSha1($function, array $args)
Skips the write operation if storage is sha1-based, executes it normally otherwise.
Definition: LocalRepo.php:563
store($srcPath, $dstZone, $dstRel, $flags=0)
Definition: LocalRepo.php:522
getTimestamp()
Get the 14-character timestamp of the file upload.
Definition: File.php:2094
callable $fileFromRowFactory
Definition: LocalRepo.php:37
static getHashFromKey($key)
Gets the SHA1 hash from a storage key.
Definition: LocalRepo.php:177
callable $oldFileFactory
Definition: LocalRepo.php:41
storeBatch(array $triplets, $flags=0)
Definition: LocalRepo.php:526
getDeletedHashPath($key)
Get a relative path for a deletion archive key, e.g.
Definition: FileRepo.php:1482
exists()
Returns true if file exists in the repository.
Definition: File.php:876
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
Base class for file repositories.
Definition: FileRepo.php:37
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state indicating whether full HTML should be generated If generation of HTML may be but other information should still be present in the ParserOutput object to manipulate or replace but no entry for that model exists in $wgContentHandlers if desired 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 inclusive $limit
Definition: hooks.txt:1046
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 local content language as $wgContLang
Definition: design.txt:56
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set $status
Definition: hooks.txt:1046
redirectedFrom($from)
Definition: File.php:2224
findFiles(array $items, $flags=0)
Definition: LocalRepo.php:238
FileBackend $backend
Definition: FileRepo.php:59
const DB_REPLICA
Definition: defines.php:22
Result wrapper for grabbing data queried from an IDatabase object.
Implements some public methods and some protected utility functions which are required by multiple ch...
Definition: File.php:50
callable $oldFileFactoryKey
Definition: LocalRepo.php:43
getZonePath($zone)
Get the storage path corresponding to one of the zones.
Definition: FileRepo.php:363
hasSha1Storage()
Returns whether or not storage is SHA-1 based.
Definition: FileRepo.php:1915
static makeTitle($ns, $title, $fragment= '', $interwiki= '')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:511
newGood($value=null)
Create a new good result.
Definition: FileRepo.php:1731
checkRedirect(Title $title)
Checks if there is a redirect named as $title.
Definition: LocalRepo.php:187
Proxy backend that manages file layout rewriting for FileRepo.
$wgFavicon
The URL path of the shortcut icon.