MediaWiki REL1_28
Go to the documentation of this file.
42 protected $backend;
44 protected $repoName;
46 protected $dbHandleFunc;
50 protected $dbs;
52 public function __construct( array $config ) {
54 $backend = $config['backend'];
55 $config['name'] = $backend->getName();
56 $config['wikiId'] = $backend->getWikiId();
57 parent::__construct( $config );
58 $this->backend = $config['backend'];
59 $this->repoName = $config['repoName'];
60 $this->dbHandleFunc = $config['dbHandleFactory'];
61 $this->resolvedPathCache = new ProcessCacheLRU( 100 );
62 }
69 public function getInternalBackend() {
70 return $this->backend;
71 }
83 public function getBackendPath( $path, $latest = true ) {
84 $paths = $this->getBackendPaths( [ $path ], $latest );
85 return current( $paths );
86 }
98 public function getBackendPaths( array $paths, $latest = true ) {
99 $db = $this->getDB( $latest ? DB_MASTER : DB_REPLICA );
101 // @TODO: batching
102 $resolved = [];
103 foreach ( $paths as $i => $path ) {
104 if ( !$latest && $this->resolvedPathCache->has( $path, 'target', 10 ) ) {
105 $resolved[$i] = $this->resolvedPathCache->get( $path, 'target' );
106 continue;
107 }
109 list( , $container ) = FileBackend::splitStoragePath( $path );
111 if ( $container === "{$this->repoName}-public" ) {
112 $name = basename( $path );
113 if ( strpos( $path, '!' ) !== false ) {
114 $sha1 = $db->selectField( 'oldimage', 'oi_sha1',
115 [ 'oi_archive_name' => $name ],
116 __METHOD__
117 );
118 } else {
119 $sha1 = $db->selectField( 'image', 'img_sha1',
120 [ 'img_name' => $name ],
121 __METHOD__
122 );
123 }
124 if ( !strlen( $sha1 ) ) {
125 $resolved[$i] = $path; // give up
126 continue;
127 }
128 $resolved[$i] = $this->getPathForSHA1( $sha1 );
129 $this->resolvedPathCache->set( $path, 'target', $resolved[$i] );
130 } elseif ( $container === "{$this->repoName}-deleted" ) {
131 $name = basename( $path ); // <hash>.<ext>
132 $sha1 = substr( $name, 0, strpos( $name, '.' ) ); // ignore extension
133 $resolved[$i] = $this->getPathForSHA1( $sha1 );
134 $this->resolvedPathCache->set( $path, 'target', $resolved[$i] );
135 } else {
136 $resolved[$i] = $path;
137 }
138 }
140 $res = [];
141 foreach ( $paths as $i => $path ) {
142 $res[$i] = $resolved[$i];
143 }
145 return $res;
146 }
148 protected function doOperationsInternal( array $ops, array $opts ) {
149 return $this->backend->doOperationsInternal( $this->mungeOpPaths( $ops ), $opts );
150 }
152 protected function doQuickOperationsInternal( array $ops ) {
153 return $this->backend->doQuickOperationsInternal( $this->mungeOpPaths( $ops ) );
154 }
156 protected function doPrepare( array $params ) {
157 return $this->backend->doPrepare( $params );
158 }
160 protected function doSecure( array $params ) {
161 return $this->backend->doSecure( $params );
162 }
164 protected function doPublish( array $params ) {
165 return $this->backend->doPublish( $params );
166 }
168 protected function doClean( array $params ) {
169 return $this->backend->doClean( $params );
170 }
172 public function concatenate( array $params ) {
173 return $this->translateSrcParams( __FUNCTION__, $params );
174 }
176 public function fileExists( array $params ) {
177 return $this->translateSrcParams( __FUNCTION__, $params );
178 }
180 public function getFileTimestamp( array $params ) {
181 return $this->translateSrcParams( __FUNCTION__, $params );
182 }
184 public function getFileSize( array $params ) {
185 return $this->translateSrcParams( __FUNCTION__, $params );
186 }
188 public function getFileStat( array $params ) {
189 return $this->translateSrcParams( __FUNCTION__, $params );
190 }
192 public function getFileXAttributes( array $params ) {
193 return $this->translateSrcParams( __FUNCTION__, $params );
194 }
196 public function getFileSha1Base36( array $params ) {
197 return $this->translateSrcParams( __FUNCTION__, $params );
198 }
200 public function getFileProps( array $params ) {
201 return $this->translateSrcParams( __FUNCTION__, $params );
202 }
204 public function streamFile( array $params ) {
205 // The stream methods use the file extension to determine the
206 // Content-Type (as MediaWiki should already validate it on upload).
207 // The translated SHA1 path has no extension, so this needs to use
208 // the untranslated path extension.
210 if ( $type && $type != 'unknown/unknown' ) {
211 $params['headers'][] = "Content-type: $type";
212 }
213 return $this->translateSrcParams( __FUNCTION__, $params );
214 }
216 public function getFileContentsMulti( array $params ) {
217 return $this->translateArrayResults( __FUNCTION__, $params );
218 }
221 return $this->translateArrayResults( __FUNCTION__, $params );
222 }
224 public function getLocalCopyMulti( array $params ) {
225 return $this->translateArrayResults( __FUNCTION__, $params );
226 }
228 public function getFileHttpUrl( array $params ) {
229 return $this->translateSrcParams( __FUNCTION__, $params );
230 }
232 public function directoryExists( array $params ) {
233 return $this->backend->directoryExists( $params );
234 }
236 public function getDirectoryList( array $params ) {
237 return $this->backend->getDirectoryList( $params );
238 }
240 public function getFileList( array $params ) {
241 return $this->backend->getFileList( $params );
242 }
244 public function getFeatures() {
245 return $this->backend->getFeatures();
246 }
248 public function clearCache( array $paths = null ) {
249 $this->backend->clearCache( null ); // clear all
250 }
252 public function preloadCache( array $paths ) {
253 $paths = $this->getBackendPaths( $paths );
254 $this->backend->preloadCache( $paths );
255 }
257 public function preloadFileStat( array $params ) {
258 return $this->translateSrcParams( __FUNCTION__, $params );
259 }
261 public function getScopedLocksForOps( array $ops, StatusValue $status ) {
262 return $this->backend->getScopedLocksForOps( $ops, $status );
263 }
273 public function getPathForSHA1( $sha1 ) {
274 if ( strlen( $sha1 ) < 3 ) {
275 throw new InvalidArgumentException( "Invalid file SHA-1." );
276 }
277 return $this->backend->getContainerStoragePath( "{$this->repoName}-original" ) .
278 "/{$sha1[0]}/{$sha1[1]}/{$sha1[2]}/{$sha1}";
279 }
287 protected function getDB( $index ) {
288 if ( !isset( $this->dbs[$index] ) ) {
289 $func = $this->dbHandleFunc;
290 $this->dbs[$index] = $func( $index );
291 }
292 return $this->dbs[$index];
293 }
301 protected function translateSrcParams( $function, array $params ) {
302 $latest = !empty( $params['latest'] );
304 if ( isset( $params['src'] ) ) {
305 $params['src'] = $this->getBackendPath( $params['src'], $latest );
306 }
308 if ( isset( $params['srcs'] ) ) {
309 $params['srcs'] = $this->getBackendPaths( $params['srcs'], $latest );
310 }
312 return $this->backend->$function( $params );
313 }
322 protected function translateArrayResults( $function, array $params ) {
323 $origPaths = $params['srcs'];
324 $params['srcs'] = $this->getBackendPaths( $params['srcs'], !empty( $params['latest'] ) );
325 $pathMap = array_combine( $params['srcs'], $origPaths );
327 $results = $this->backend->$function( $params );
329 $contents = [];
330 foreach ( $results as $path => $result ) {
331 $contents[$pathMap[$path]] = $result;
332 }
334 return $contents;
335 }
345 protected function mungeOpPaths( array $ops ) {
346 // Ops that use 'src' and do not mutate core file data there
347 static $srcRefOps = [ 'store', 'copy', 'describe' ];
348 foreach ( $ops as &$op ) {
349 if ( isset( $op['src'] ) && in_array( $op['op'], $srcRefOps ) ) {
350 $op['src'] = $this->getBackendPath( $op['src'], true );
351 }
352 if ( isset( $op['srcs'] ) ) {
353 $op['srcs'] = $this->getBackendPaths( $op['srcs'], true );
354 }
355 }
356 return $ops;
357 }
Helper class to handle automatically marking connections as reusable (via RAII pattern) as well handl...
Definition DBConnRef.php:10
Proxy backend that manages file layout rewriting for FileRepo.
getFileSha1Base36(array $params)
Get a SHA-1 hash of the file at a storage path in the backend.
__construct(array $config)
Create a new backend instance from configuration.
concatenate(array $params)
Concatenate a list of storage files into a single file system file.
streamFile(array $params)
Stream the file at a storage path in the backend.
getScopedLocksForOps(array $ops, StatusValue $status)
Get an array of scoped locks needed for a batch of file operations.
Get the underlying FileBackend that is being wrapped.
getLocalCopyMulti(array $params)
Like getLocalCopy() except it takes an array of storage paths and returns a map of storage paths to T...
doOperationsInternal(array $ops, array $opts)
fileExists(array $params)
Check if a file exists at a storage path in the backend.
clearCache(array $paths=null)
Invalidate any in-process file stat and property cache.
getPathForSHA1( $sha1)
Get the ultimate original storage path for a file.
getDB( $index)
Get a connection to the repo file registry DB.
translateSrcParams( $function, array $params)
Translates paths found in the "src" or "srcs" keys of a params array.
mungeOpPaths(array $ops)
Translate legacy "title" source paths to their "sha1" counterparts.
getFileHttpUrl(array $params)
Return an HTTP URL to a given file that requires no authentication to use.
getLocalReferenceMulti(array $params)
Like getLocalReference() except it takes an array of storage paths and returns a map of storage paths...
preloadCache(array $paths)
Preload persistent file stat cache and property cache into in-process cache.
getFileSize(array $params)
Get the size (bytes) of a file at a storage path in the backend.
getFileProps(array $params)
Get the properties of the file at a storage path in the backend.
Get the a bitfield of extra features supported by the backend medium.
translateArrayResults( $function, array $params)
Translates paths when the backend function returns results keyed by paths.
preloadFileStat(array $params)
Preload file stat information (concurrently if possible) into in-process cache.
directoryExists(array $params)
Check if a directory exists at a given storage path.
getBackendPaths(array $paths, $latest=true)
Translate legacy "title" paths to their "sha1" counterparts.
getFileList(array $params)
Get an iterator to list all stored files under a storage directory.
getFileStat(array $params)
Get quick information about a file at a storage path in the backend.
getFileTimestamp(array $params)
Get the last-modified timestamp of the file at a storage path.
getFileXAttributes(array $params)
Get metadata about a file at a storage path in the backend.
getFileContentsMulti(array $params)
Like getFileContents() except it takes an array of storage paths and returns a map of storage paths t...
getDirectoryList(array $params)
Get an iterator to list all directories under a storage directory.
getBackendPath( $path, $latest=true)
Translate a legacy "title" path to it's "sha1" counterpart.
Base class for all file backend classes (including multi-write backends).
string $name
Unique backend name.
static splitStoragePath( $storagePath)
Split a storage path into a backend name, a container name, and a relative file path.
Alias to getDomainId()
Get the unique backend name.
Handles per process caching of items.
Generic operation result class Has warning/error list, boolean status and arbitrary value.
static contentTypeFromPath( $filename, $safe=true)
Determine the file type of a file based on the path.
Definition database.txt:21
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition deferred.txt:11
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
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:1049
the array() calling protocol came about after MediaWiki 1.4rc1.
namespace are movable Hooks may change this value to override the return value of MWNamespace::isMovable(). 'NewDifferenceEngine' do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached one of or reset my talk my contributions etc etc otherwise the built in rate limiting checks are if enabled allows for interception of redirect as a string mapping parameter names to values & $type
Definition hooks.txt:2568
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:1937
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
Definition defines.php:22
Definition defines.php:23