MediaWiki  1.27.2
LocalRepo.php
Go to the documentation of this file.
1 <?php
31 class LocalRepo extends FileRepo {
33  protected $fileFactory = [ 'LocalFile', 'newFromTitle' ];
34 
36  protected $fileFactoryKey = [ 'LocalFile', 'newFromKey' ];
37 
39  protected $fileFromRowFactory = [ 'LocalFile', 'newFromRow' ];
40 
42  protected $oldFileFromRowFactory = [ 'OldLocalFile', 'newFromRow' ];
43 
45  protected $oldFileFactory = [ 'OldLocalFile', 'newFromTitle' ];
46 
48  protected $oldFileFactoryKey = [ 'OldLocalFile', 'newFromKey' ];
49 
50  function __construct( array $info = null ) {
51  parent::__construct( $info );
52 
53  $this->hasSha1Storage = isset( $info['storageLayout'] ) && $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  $that = $this;
203  $redirDbKey = ObjectCache::getMainWANInstance()->getWithSetCallback(
204  $memcKey,
205  $expiry,
206  function ( $oldValue, &$ttl, array &$setOpts ) use ( $that, $title ) {
207  $dbr = $that->getSlaveDB(); // 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' => 30 ]
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  $that = $this;
278  $applyMatchingFiles = function ( ResultWrapper $res, &$searchSet, &$finalFiles )
279  use ( $that, $fileMatchesSearch, $flags )
280  {
282  $info = $that->getInfo();
283  foreach ( $res as $row ) {
284  $file = $that->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[] = $wgContLang->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->getSlaveDB();
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  $res = $dbr->select( 'image',
315  LocalFile::selectFields(), [ 'img_name' => $imgNames ], __METHOD__ );
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  $res = $dbr->select( 'oldimage',
335  OldLocalFile::selectFields(), $dbr->makeList( $oiConds, LIST_OR ), __METHOD__ );
336  $applyMatchingFiles( $res, $searchSet, $finalFiles );
337  }
338 
339  // Check for redirects...
340  foreach ( $searchSet as $dbKey => $search ) {
341  if ( !empty( $search['ignoreRedirect'] ) ) {
342  continue;
343  }
344 
345  $title = File::normalizeTitle( $dbKey );
346  $redir = $this->checkRedirect( $title ); // hopefully hits memcached
347 
348  if ( $redir && $redir->getNamespace() == NS_FILE ) {
349  $file = $this->newFile( $redir );
350  if ( $file && $fileMatchesSearch( $file, $search ) ) {
351  $file->redirectedFrom( $title->getDBkey() );
353  $finalFiles[$dbKey] = [
354  'title' => $file->getTitle()->getDBkey(),
355  'timestamp' => $file->getTimestamp()
356  ];
357  } else {
358  $finalFiles[$dbKey] = $file;
359  }
360  }
361  }
362  }
363 
364  return $finalFiles;
365  }
366 
374  function findBySha1( $hash ) {
375  $dbr = $this->getSlaveDB();
376  $res = $dbr->select(
377  'image',
379  [ 'img_sha1' => $hash ],
380  __METHOD__,
381  [ 'ORDER BY' => 'img_name' ]
382  );
383 
384  $result = [];
385  foreach ( $res as $row ) {
386  $result[] = $this->newFileFromRow( $row );
387  }
388  $res->free();
389 
390  return $result;
391  }
392 
402  function findBySha1s( array $hashes ) {
403  if ( !count( $hashes ) ) {
404  return []; // empty parameter
405  }
406 
407  $dbr = $this->getSlaveDB();
408  $res = $dbr->select(
409  'image',
411  [ 'img_sha1' => $hashes ],
412  __METHOD__,
413  [ 'ORDER BY' => 'img_name' ]
414  );
415 
416  $result = [];
417  foreach ( $res as $row ) {
418  $file = $this->newFileFromRow( $row );
419  $result[$file->getSha1()][] = $file;
420  }
421  $res->free();
422 
423  return $result;
424  }
425 
433  public function findFilesByPrefix( $prefix, $limit ) {
434  $selectOptions = [ 'ORDER BY' => 'img_name', 'LIMIT' => intval( $limit ) ];
435 
436  // Query database
437  $dbr = $this->getSlaveDB();
438  $res = $dbr->select(
439  'image',
441  'img_name ' . $dbr->buildLike( $prefix, $dbr->anyString() ),
442  __METHOD__,
443  $selectOptions
444  );
445 
446  // Build file objects
447  $files = [];
448  foreach ( $res as $row ) {
449  $files[] = $this->newFileFromRow( $row );
450  }
451 
452  return $files;
453  }
454 
459  function getSlaveDB() {
460  return wfGetDB( DB_SLAVE );
461  }
462 
467  function getMasterDB() {
468  return wfGetDB( DB_MASTER );
469  }
470 
475  protected function getDBFactory() {
476  return function( $index ) {
477  return wfGetDB( $index );
478  };
479  }
480 
488  function getSharedCacheKey( /*...*/ ) {
489  $args = func_get_args();
490 
491  return call_user_func_array( 'wfMemcKey', $args );
492  }
493 
501  $key = $this->getSharedCacheKey( 'image_redirect', md5( $title->getDBkey() ) );
502  if ( $key ) {
503  $this->getMasterDB()->onTransactionPreCommitOrIdle( function() use ( $key ) {
505  } );
506  }
507  }
508 
515  function getInfo() {
517 
518  return array_merge( parent::getInfo(), [
519  'favicon' => wfExpandUrl( $wgFavicon ),
520  ] );
521  }
522 
523  public function store( $srcPath, $dstZone, $dstRel, $flags = 0 ) {
524  return $this->skipWriteOperationIfSha1( __FUNCTION__, func_get_args() );
525  }
526 
527  public function storeBatch( array $triplets, $flags = 0 ) {
528  return $this->skipWriteOperationIfSha1( __FUNCTION__, func_get_args() );
529  }
530 
531  public function cleanupBatch( array $files, $flags = 0 ) {
532  return $this->skipWriteOperationIfSha1( __FUNCTION__, func_get_args() );
533  }
534 
535  public function publish(
536  $src,
537  $dstRel,
538  $archiveRel,
539  $flags = 0,
540  array $options = []
541  ) {
542  return $this->skipWriteOperationIfSha1( __FUNCTION__, func_get_args() );
543  }
544 
545  public function publishBatch( array $ntuples, $flags = 0 ) {
546  return $this->skipWriteOperationIfSha1( __FUNCTION__, func_get_args() );
547  }
548 
549  public function delete( $srcRel, $archiveRel ) {
550  return $this->skipWriteOperationIfSha1( __FUNCTION__, func_get_args() );
551  }
552 
553  public function deleteBatch( array $sourceDestPairs ) {
554  return $this->skipWriteOperationIfSha1( __FUNCTION__, func_get_args() );
555  }
556 
564  protected function skipWriteOperationIfSha1( $function, array $args ) {
565  $this->assertWritableRepo(); // fail out if read-only
566 
567  if ( $this->hasSha1Storage() ) {
568  wfDebug( __METHOD__ . ": skipped because storage uses sha1 paths\n" );
569  return Status::newGood();
570  } else {
571  return call_user_func_array( 'parent::' . $function, $args );
572  }
573  }
574 }
assertWritableRepo()
Throw an exception if this repo is read-only by design.
Definition: FileRepo.php:1877
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:69
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:84
magic word the default is to use $key to get the and $key value or $key value text $key value html to format the value $key
Definition: hooks.txt:2321
getSlaveDB()
Get a connection to the slave DB.
Definition: LocalRepo.php:459
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:2147
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
static newFromArchiveName($title, $repo, $archiveName)
getLocalCacheKey()
Get a key for this repo in the local cache domain.
Definition: FileRepo.php:1816
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:402
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:2548
doOperation(array $op, array $opts=[])
Same as doOperations() except it takes a single operation.
publishBatch(array $ntuples, $flags=0)
Definition: LocalRepo.php:545
cleanupBatch(array $files, $flags=0)
Definition: LocalRepo.php:531
static newFromText($text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:277
Represents a title within MediaWiki.
Definition: Title.php:34
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:1864
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:488
getTitle()
Return the associated title object.
Definition: File.php:325
static normalizeExtension($extension)
Normalize a file extension to the common form, making it lowercase and checking some synonyms...
Definition: File.php:223
deleteBatch(array $sourceDestPairs)
Definition: LocalRepo.php:553
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':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:1796
if($line===false) $args
Definition: cdb.php:64
array $fileFactory
Definition: LocalRepo.php:33
findBySha1($hash)
Get an array or iterator of file objects for files that have a given SHA-1 content hash...
Definition: LocalRepo.php:374
array $oldFileFromRowFactory
Definition: LocalRepo.php:42
findFilesByPrefix($prefix, $limit)
Return an array of files where the name starts with $prefix.
Definition: LocalRepo.php:433
publish($src, $dstRel, $archiveRel, $flags=0, array $options=[])
Definition: LocalRepo.php:535
invalidateImageRedirect(Title $title)
Invalidates image redirect cache related to that image.
Definition: LocalRepo.php:500
deletedFileHasKey($key, $lock=null)
Check if a deleted (filearchive) file has this sha1 key.
Definition: LocalRepo.php:141
array $fileFromRowFactory
Definition: LocalRepo.php:39
const LIST_AND
Definition: Defines.php:193
isDeleted($field)
Is this file a "deleted" file in a private archive? STUB.
Definition: File.php:1875
getMasterDB()
Get a connection to the master DB.
Definition: LocalRepo.php:467
getDBkey()
Get the main part with underscores.
Definition: Title.php:911
cleanupDeletedBatch(array $storageKeys)
Delete files in the deleted directory if they are not referenced in the filearchive table...
Definition: LocalRepo.php:98
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:1004
$res
Definition: database.txt:21
static selectFields()
Fields in the image table.
Definition: LocalFile.php:192
hiddenFileHasKey($key, $lock=null)
Check if a hidden (revision delete) file has this sha1 key.
Definition: LocalRepo.php:159
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_SLAVE/DB_MASTER)
Definition: LocalRepo.php:475
static selectFields()
Fields in the oldimage table.
getInfo()
Return information about the repository.
Definition: LocalRepo.php:515
const DB_SLAVE
Definition: Defines.php:46
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:912
getNamespace()
Get the namespace index, i.e.
Definition: Title.php:934
const NS_FILE
Definition: Defines.php:75
__construct(array $info=null)
Definition: LocalRepo.php:50
static getCacheSetOptions(IDatabase $db1)
Merge the result of getSessionLagStatus() for several DBs using the most pessimistic values to estima...
Definition: Database.php:2907
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:630
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:196
const NAME_AND_TIME_ONLY
Definition: FileRepo.php:43
array $fileFactoryKey
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 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:564
store($srcPath, $dstZone, $dstRel, $flags=0)
Definition: LocalRepo.php:523
getTimestamp()
Get the 14-character timestamp of the file upload.
Definition: File.php:2095
static getHashFromKey($key)
Gets the SHA1 hash from a storage key.
Definition: LocalRepo.php:181
storeBatch(array $triplets, $flags=0)
Definition: LocalRepo.php:527
getDeletedHashPath($key)
Get a relative path for a deletion archive key, e.g.
Definition: FileRepo.php:1488
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:1004
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:1004
redirectedFrom($from)
Definition: File.php:2225
findFiles(array $items, $flags=0)
Definition: LocalRepo.php:242
const DB_MASTER
Definition: Defines.php:47
FileBackend $backend
Definition: FileRepo.php:59
Result wrapper for grabbing data queried by someone else.
Implements some public methods and some protected utility functions which are required by multiple ch...
Definition: File.php:50
getZonePath($zone)
Get the storage path corresponding to one of the zones.
Definition: FileRepo.php:363
array $oldFileFactory
Definition: LocalRepo.php:45
array $oldFileFactoryKey
Definition: LocalRepo.php:48
hasSha1Storage()
Returns whether or not storage is SHA-1 based.
Definition: FileRepo.php:1911
static & makeTitle($ns, $title, $fragment= '', $interwiki= '')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:524
static newGood($value=null)
Factory function for good results.
Definition: Status.php:101
newGood($value=null)
Create a new good result.
Definition: FileRepo.php:1727
checkRedirect(Title $title)
Checks if there is a redirect named as $title.
Definition: LocalRepo.php:191
Proxy backend that manages file layout rewriting for FileRepo.
$wgFavicon
The URL path of the shortcut icon.