Go to the documentation of this file.
50 parent::__construct( $info );
53 && $info[
'storageLayout'] ===
'sha1';
57 'backend' => $this->backend,
58 'repoName' => $this->
name,
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 );
75 throw new MWException( __METHOD__ .
': invalid row' );
100 wfDebug( __METHOD__ .
": skipped because storage uses sha1 paths\n" );
108 $storageKeys = array_unique( $storageKeys );
109 foreach ( $storageKeys
as $key ) {
111 $path =
"$root/$hashPath$key";
112 $dbw->startAtomic( __METHOD__ );
117 if ( !$deleted && !$hidden ) {
118 wfDebug( __METHOD__ .
": deleting $key\n" );
119 $op = [
'op' =>
'delete',
'src' =>
$path ];
125 wfDebug( __METHOD__ .
": $key still in use\n" );
128 $dbw->endAtomic( __METHOD__ );
142 $options = ( $lock ===
'lock' ) ? [
'FOR UPDATE' ] : [];
146 return (
bool)$dbw->selectField(
'filearchive',
'1',
147 [
'fa_storage_group' =>
'deleted',
'fa_storage_key' => $key ],
160 $options = ( $lock ===
'lock' ) ? [
'FOR UPDATE' ] : [];
167 return (
bool)$dbw->selectField(
'oldimage',
'1',
168 [
'oi_sha1' => $sha1,
169 'oi_archive_name ' . $dbw->buildLike( $dbw->anyString(),
".$ext" ),
182 return strtok( $key,
'.' );
195 if ( $memcKey ===
false ) {
202 $method = __METHOD__;
206 function ( $oldValue, &$ttl,
array &$setOpts )
use ( $method,
$title ) {
209 $setOpts += Database::getCacheSetOptions(
$dbr );
212 $row =
$dbr->selectRow(
213 [
'page',
'redirect' ],
214 [
'rd_namespace',
'rd_title' ],
216 'page_namespace' =>
$title->getNamespace(),
217 'page_title' =>
$title->getDBkey(),
226 return ( $row && $row->rd_namespace ==
NS_FILE )
234 if ( $redirDbKey !==
' ' && strval( $redirDbKey ) !==
'' ) {
246 foreach ( $items
as $item ) {
247 if ( is_array( $item ) ) {
250 $searchSet[
$title->getDBkey()] = $item;
255 $searchSet[
$title->getDBkey()] = [];
260 $fileMatchesSearch =
function (
File $file,
array $search ) {
262 $user = ( !empty( $search[
'private'] ) && $search[
'private'] instanceof
User )
269 ( empty( $search[
'time'] ) && !$file->
isOld() ) ||
270 ( !empty( $search[
'time'] ) && $search[
'time'] === $file->
getTimestamp() )
279 use ( $that, $fileMatchesSearch,
$flags )
282 $info = $that->getInfo();
283 foreach (
$res as $row ) {
284 $file = $that->newFileFromRow( $row );
287 $dbKeysLook = [ strtr( $file->
getName(),
' ',
'_' ) ];
288 if ( !empty( $info[
'initialCapital'] ) ) {
292 foreach ( $dbKeysLook
as $dbKey ) {
293 if ( isset( $searchSet[$dbKey] )
294 && $fileMatchesSearch( $file, $searchSet[$dbKey] )
297 ? [
'title' => $dbKey,
'timestamp' => $file->
getTimestamp() ]
299 unset( $searchSet[$dbKey] );
309 foreach ( array_keys( $searchSet )
as $dbKey ) {
313 if (
count( $imgNames ) ) {
316 $applyMatchingFiles(
$res, $searchSet, $finalFiles );
321 foreach ( $searchSet
as $dbKey => $search ) {
322 if ( isset( $search[
'time'] ) ) {
323 $oiConds[] =
$dbr->makeList(
326 'oi_timestamp' =>
$dbr->timestamp( $search[
'time'] )
333 if (
count( $oiConds ) ) {
336 $applyMatchingFiles(
$res, $searchSet, $finalFiles );
340 foreach ( $searchSet
as $dbKey => $search ) {
341 if ( !empty( $search[
'ignoreRedirect'] ) ) {
348 if ( $redir && $redir->getNamespace() ==
NS_FILE ) {
349 $file = $this->
newFile( $redir );
350 if ( $file && $fileMatchesSearch( $file, $search ) ) {
353 $finalFiles[$dbKey] = [
354 'title' => $file->
getTitle()->getDBkey(),
358 $finalFiles[$dbKey] = $file;
379 [
'img_sha1' => $hash ],
381 [
'ORDER BY' =>
'img_name' ]
385 foreach (
$res as $row ) {
411 [
'img_sha1' => $hashes ],
413 [
'ORDER BY' =>
'img_name' ]
417 foreach (
$res as $row ) {
419 $result[$file->getSha1()][] = $file;
434 $selectOptions = [
'ORDER BY' =>
'img_name',
'LIMIT' => intval(
$limit ) ];
441 'img_name ' .
$dbr->buildLike( $prefix,
$dbr->anyString() ),
448 foreach (
$res as $row ) {
486 return function( $index ) {
499 $args = func_get_args();
501 return call_user_func_array(
'wfMemcKey',
$args );
513 $this->
getMasterDB()->onTransactionPreCommitOrIdle(
514 function ()
use ( $key ) {
531 return array_merge( parent::getInfo(), [
536 public function store( $srcPath, $dstZone, $dstRel,
$flags = 0 ) {
562 public function delete( $srcRel, $archiveRel ) {
581 wfDebug( __METHOD__ .
": skipped because storage uses sha1 paths\n" );
584 return call_user_func_array(
'parent::' . $function,
$args );
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
getInfo()
Return information about the repository.
newGood( $value=null)
Create a new good result.
getMasterDB()
Get a connection to the master DB.
getReplicaDB()
Get a connection to the replica DB.
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...
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: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
deletedFileHasKey( $key, $lock=null)
Check if a deleted (filearchive) file has this sha1 key.
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup 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
getTimestamp()
Get the 14-character timestamp of the file upload.
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
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
callable $oldFileFactoryKey
getZonePath( $zone)
Get the storage path corresponding to one of the zones.
static selectFields()
Fields in the oldimage table.
isDeleted( $field)
Is this file a "deleted" file in a private archive? STUB.
hiddenFileHasKey( $key, $lock=null)
Check if a hidden (revision delete) file has this sha1 key.
static getHashFromKey( $key)
Gets the SHA1 hash from a storage key.
static normalizeTitle( $title, $exception=false)
Given a string or Title object return either a valid Title object with namespace NS_FILE or null.
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
exists()
Returns true if file exists in the repository.
Base class for file repositories.
hasSha1Storage()
Returns whether or not storage is SHA-1 based.
Implements some public methods and some protected utility functions which are required by multiple ch...
callable $oldFileFromRowFactory
newFile( $title, $time=false)
Create a new File object from the local repository.
getSlaveDB()
Alias for getReplicaDB()
namespace and then decline to actually register it file or subcat img or subcat $title
doOperation(array $op, array $opts=[])
Same as doOperations() except it takes a single operation.
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
static normalizeExtension( $extension)
Normalize a file extension to the common form, making it lowercase and checking some synonyms,...
store( $srcPath, $dstZone, $dstRel, $flags=0)
Store a file to a given destination.
getDBFactory()
Get a callback to get a DB handle given an index (DB_REPLICA/DB_MASTER)
invalidateImageRedirect(Title $title)
Invalidates image redirect cache related to that image.
storeBatch(array $triplets, $flags=0)
Store a batch of files.
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup 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 please use GetContentModels hook to make them known to core 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
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
when a variable name is used in a it is silently declared as a new masking the global
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
cleanupBatch(array $files, $flags=0)
Deletes a batch of files.
findFiles(array $items, $flags=0)
Find many files at once.
getNameFromTitle(Title $title)
Get the name of a file from its title object.
newFromArchiveName( $title, $archiveName)
isOld()
Returns true if the image is an old version STUB.
static newGood( $value=null)
Factory function for good results.
getName()
Return the name of this file.
findBySha1s(array $hashes)
Get an array of arrays or iterators of file objects for files that have the given SHA-1 content hashe...
$wgFavicon
The URL path of the shortcut icon.
getLocalCacheKey()
Get a key for this repo in the local cache domain.
findFilesByPrefix( $prefix, $limit)
Return an array of files where the name starts with $prefix.
checkRedirect(Title $title)
Checks if there is a redirect named as $title.
static selectFields()
Fields in the image table.
getTitle()
Return the associated title object.
Represents a title within MediaWiki.
cleanupDeletedBatch(array $storageKeys)
Delete files in the deleted directory if they are not referenced in the filearchive table.
static getMainWANInstance()
Get the main WAN cache object.
getSharedCacheKey()
Get a key on the primary cache for this repository.
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
deleteBatch(array $sourceDestPairs)
Move a group of files to the deletion archive.
findBySha1( $hash)
Get an array or iterator of file objects for files that have a given SHA-1 content hash.
skipWriteOperationIfSha1( $function, array $args)
Skips the write operation if storage is sha1-based, executes it normally otherwise.
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
__construct(array $info=null)
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...
static newFromArchiveName( $title, $repo, $archiveName)
publishBatch(array $ntuples, $flags=0)
Publish a batch of files.
getDeletedHashPath( $key)
Get a relative path for a deletion archive key, e.g.
assertWritableRepo()
Throw an exception if this repo is read-only by design.
Proxy backend that manages file layout rewriting for FileRepo.
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup 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
it s the revision text itself In either if gzip is the revision text is gzipped $flags
A repository that stores files in the local filesystem and registers them in the wiki's own database.
wfExpandUrl( $url, $defaultProto=PROTO_CURRENT)
Expand a potentially local URL to a fully-qualified URL.
the array() calling protocol came about after MediaWiki 1.4rc1.
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
callable $fileFromRowFactory