MediaWiki  master
MemoryFileBackend.php
Go to the documentation of this file.
1 <?php
35  protected $files = [];
36 
37  public function getFeatures() {
38  return self::ATTR_UNICODE_PATHS;
39  }
40 
41  public function isPathUsableInternal( $storagePath ) {
42  return true;
43  }
44 
45  protected function doCreateInternal( array $params ) {
46  $status = $this->newStatus();
47 
48  $dst = $this->resolveHashKey( $params['dst'] );
49  if ( $dst === null ) {
50  $status->fatal( 'backend-fail-invalidpath', $params['dst'] );
51 
52  return $status;
53  }
54 
55  $this->files[$dst] = [
56  'data' => $params['content'],
57  'mtime' => wfTimestamp( TS_MW, time() )
58  ];
59 
60  return $status;
61  }
62 
63  protected function doStoreInternal( array $params ) {
64  $status = $this->newStatus();
65 
66  $dst = $this->resolveHashKey( $params['dst'] );
67  if ( $dst === null ) {
68  $status->fatal( 'backend-fail-invalidpath', $params['dst'] );
69 
70  return $status;
71  }
72 
73  Wikimedia\suppressWarnings();
74  $data = file_get_contents( $params['src'] );
75  Wikimedia\restoreWarnings();
76  if ( $data === false ) { // source doesn't exist?
77  $status->fatal( 'backend-fail-store', $params['src'], $params['dst'] );
78 
79  return $status;
80  }
81 
82  $this->files[$dst] = [
83  'data' => $data,
84  'mtime' => wfTimestamp( TS_MW, time() )
85  ];
86 
87  return $status;
88  }
89 
90  protected function doCopyInternal( array $params ) {
91  $status = $this->newStatus();
92 
93  $src = $this->resolveHashKey( $params['src'] );
94  if ( $src === null ) {
95  $status->fatal( 'backend-fail-invalidpath', $params['src'] );
96 
97  return $status;
98  }
99 
100  $dst = $this->resolveHashKey( $params['dst'] );
101  if ( $dst === null ) {
102  $status->fatal( 'backend-fail-invalidpath', $params['dst'] );
103 
104  return $status;
105  }
106 
107  if ( !isset( $this->files[$src] ) ) {
108  if ( empty( $params['ignoreMissingSource'] ) ) {
109  $status->fatal( 'backend-fail-copy', $params['src'], $params['dst'] );
110  }
111 
112  return $status;
113  }
114 
115  $this->files[$dst] = [
116  'data' => $this->files[$src]['data'],
117  'mtime' => wfTimestamp( TS_MW, time() )
118  ];
119 
120  return $status;
121  }
122 
123  protected function doDeleteInternal( array $params ) {
124  $status = $this->newStatus();
125 
126  $src = $this->resolveHashKey( $params['src'] );
127  if ( $src === null ) {
128  $status->fatal( 'backend-fail-invalidpath', $params['src'] );
129 
130  return $status;
131  }
132 
133  if ( !isset( $this->files[$src] ) ) {
134  if ( empty( $params['ignoreMissingSource'] ) ) {
135  $status->fatal( 'backend-fail-delete', $params['src'] );
136  }
137 
138  return $status;
139  }
140 
141  unset( $this->files[$src] );
142 
143  return $status;
144  }
145 
146  protected function doGetFileStat( array $params ) {
147  $src = $this->resolveHashKey( $params['src'] );
148  if ( $src === null ) {
149  return null;
150  }
151 
152  if ( isset( $this->files[$src] ) ) {
153  return [
154  'mtime' => $this->files[$src]['mtime'],
155  'size' => strlen( $this->files[$src]['data'] ),
156  ];
157  }
158 
159  return false;
160  }
161 
162  protected function doGetLocalCopyMulti( array $params ) {
163  $tmpFiles = []; // (path => TempFSFile)
164  foreach ( $params['srcs'] as $srcPath ) {
165  $src = $this->resolveHashKey( $srcPath );
166  if ( $src === null || !isset( $this->files[$src] ) ) {
167  $fsFile = null;
168  } else {
169  // Create a new temporary file with the same extension...
171  $fsFile = $this->tmpFileFactory->newTempFSFile( 'localcopy_', $ext );
172  if ( $fsFile ) {
173  $bytes = file_put_contents( $fsFile->getPath(), $this->files[$src]['data'] );
174  if ( $bytes !== strlen( $this->files[$src]['data'] ) ) {
175  $fsFile = null;
176  }
177  }
178  }
179  $tmpFiles[$srcPath] = $fsFile;
180  }
181 
182  return $tmpFiles;
183  }
184 
185  protected function doDirectoryExists( $container, $dir, array $params ) {
186  $prefix = rtrim( "$container/$dir", '/' ) . '/';
187  foreach ( $this->files as $path => $data ) {
188  if ( strpos( $path, $prefix ) === 0 ) {
189  return true;
190  }
191  }
192 
193  return false;
194  }
195 
196  public function getDirectoryListInternal( $container, $dir, array $params ) {
197  $dirs = [];
198  $prefix = rtrim( "$container/$dir", '/' ) . '/';
199  $prefixLen = strlen( $prefix );
200  foreach ( $this->files as $path => $data ) {
201  if ( strpos( $path, $prefix ) === 0 ) {
202  $relPath = substr( $path, $prefixLen );
203  if ( $relPath === false ) {
204  continue;
205  } elseif ( strpos( $relPath, '/' ) === false ) {
206  continue; // just a file
207  }
208  $parts = array_slice( explode( '/', $relPath ), 0, -1 ); // last part is file name
209  if ( !empty( $params['topOnly'] ) ) {
210  $dirs[$parts[0]] = 1; // top directory
211  } else {
212  $current = '';
213  foreach ( $parts as $part ) { // all directories
214  $dir = ( $current === '' ) ? $part : "$current/$part";
215  $dirs[$dir] = 1;
216  $current = $dir;
217  }
218  }
219  }
220  }
221 
222  return array_keys( $dirs );
223  }
224 
225  public function getFileListInternal( $container, $dir, array $params ) {
226  $files = [];
227  $prefix = rtrim( "$container/$dir", '/' ) . '/';
228  $prefixLen = strlen( $prefix );
229  foreach ( $this->files as $path => $data ) {
230  if ( strpos( $path, $prefix ) === 0 ) {
231  $relPath = substr( $path, $prefixLen );
232  if ( $relPath === false ) {
233  continue;
234  } elseif ( !empty( $params['topOnly'] ) && strpos( $relPath, '/' ) !== false ) {
235  continue;
236  }
237  $files[] = $relPath;
238  }
239  }
240 
241  return $files;
242  }
243 
244  protected function directoriesAreVirtual() {
245  return true;
246  }
247 
254  protected function resolveHashKey( $storagePath ) {
255  list( $fullCont, $relPath ) = $this->resolveStoragePathReal( $storagePath );
256  if ( $relPath === null ) {
257  return null; // invalid
258  }
259 
260  return ( $relPath !== '' ) ? "$fullCont/$relPath" : $fullCont;
261  }
262 }
resolveStoragePathReal( $storagePath)
Like resolveStoragePath() except null values are returned if the container is sharded and the shard c...
resolveHashKey( $storagePath)
Get the absolute file system path for a storage path.
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
doDirectoryExists( $container, $dir, array $params)
static extensionFromPath( $path, $case='lowercase')
Get the final extension from a storage or FS path.
Status::newGood()` to allow deletion, and then `return false` from the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry out custom deletion actions. $tag:name of the tag $user:user initiating the action & $status:Status object. See above. 'ChangeTagsListActive':Allows you to nominate which of the tags your extension uses are in active use. & $tags:list of all active tags. Append to this array. 'ChangeTagsAfterUpdateTags':Called after tags have been updated with the ChangeTags::updateTags function. Params:$addedTags:tags effectively added in the update $removedTags:tags effectively removed in the update $prevTags:tags that were present prior to the update $rc_id:recentchanges table id $rev_id:revision table id $log_id:logging table id $params:tag params $rc:RecentChange being tagged when the tagging accompanies the action, or null $user:User who performed the tagging when the tagging is subsequent to the action, or null 'ChangeTagsAllowedAdd':Called when checking if a user can add tags to a change. & $allowedTags:List of all the tags the user is allowed to add. Any tags the user wants to add( $addTags) that are not in this array will cause it to fail. You may add or remove tags to this array as required. $addTags:List of tags user intends to add. $user:User who is adding the tags. 'ChangeUserGroups':Called before user groups are changed. $performer:The User who will perform the change $user:The User whose groups will be changed & $add:The groups that will be added & $remove:The groups that will be removed 'Collation::factory':Called if $wgCategoryCollation is an unknown collation. $collationName:Name of the collation in question & $collationObject:Null. Replace with a subclass of the Collation class that implements the collation given in $collationName. 'ConfirmEmailComplete':Called after a user 's email has been confirmed successfully. $user:user(object) whose email is being confirmed 'ContentAlterParserOutput':Modify parser output for a given content object. Called by Content::getParserOutput after parsing has finished. Can be used for changes that depend on the result of the parsing but have to be done before LinksUpdate is called(such as adding tracking categories based on the rendered HTML). $content:The Content to render $title:Title of the page, as context $parserOutput:ParserOutput to manipulate 'ContentGetParserOutput':Customize parser output for a given content object, called by AbstractContent::getParserOutput. May be used to override the normal model-specific rendering of page content. $content:The Content to render $title:Title of the page, as context $revId:The revision ID, as context $options:ParserOptions for rendering. To avoid confusing the parser cache, the output can only depend on parameters provided to this hook function, not on global state. $generateHtml:boolean, indicating whether full HTML should be generated. If false, generation of HTML may be skipped, but other information should still be present in the ParserOutput object. & $output:ParserOutput, to manipulate or replace 'ContentHandlerDefaultModelFor':Called when the default content model is determined for a given title. May be used to assign a different model for that title. $title:the Title in question & $model:the model name. Use with CONTENT_MODEL_XXX constants. 'ContentHandlerForModelID':Called when a ContentHandler is requested for a given content model name, but no entry for that model exists in $wgContentHandlers. Note:if your extension implements additional models via this hook, please use GetContentModels hook to make them known to core. $modeName:the requested content model name & $handler:set this to a ContentHandler object, if desired. 'ContentModelCanBeUsedOn':Called to determine whether that content model can be used on a given page. This is especially useful to prevent some content models to be used in some special location. $contentModel:ID of the content model in question $title:the Title in question. & $ok:Output parameter, whether it is OK to use $contentModel on $title. Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok. 'ContribsPager::getQueryInfo':Before the contributions query is about to run & $pager:Pager object for contributions & $queryInfo:The query for the contribs Pager 'ContribsPager::reallyDoQuery':Called before really executing the query for My Contributions & $data:an array of results of all contribs queries $pager:The ContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'ContributionsLineEnding':Called before a contributions HTML line is finished $page:SpecialPage object for contributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'ContributionsToolLinks':Change tool links above Special:Contributions $id:User identifier $title:User page title & $tools:Array of tool links $specialPage:SpecialPage instance for context and services. Can be either SpecialContributions or DeletedContributionsPage. Extensions should type hint against a generic SpecialPage though. 'ConvertContent':Called by AbstractContent::convert when a conversion to another content model is requested. Handler functions that modify $result should generally return false to disable further attempts at conversion. $content:The Content object to be converted. $toModel:The ID of the content model to convert to. $lossy:boolean indicating whether lossy conversion is allowed. & $result:Output parameter, in case the handler function wants to provide a converted Content object. Note that $result->getContentModel() must return $toModel. 'ContentSecurityPolicyDefaultSource':Modify the allowed CSP load sources. This affects all directives except for the script directive. If you want to add a script source, see ContentSecurityPolicyScriptSource hook. & $defaultSrc:Array of Content-Security-Policy allowed sources $policyConfig:Current configuration for the Content-Security-Policy header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyDirectives':Modify the content security policy directives. Use this only if ContentSecurityPolicyDefaultSource and ContentSecurityPolicyScriptSource do not meet your needs. & $directives:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyScriptSource':Modify the allowed CSP script sources. Note that you also have to use ContentSecurityPolicyDefaultSource if you want non-script sources to be loaded from whatever you add. & $scriptSrc:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'CustomEditor':When invoking the page editor Return true to allow the normal editor to be used, or false if implementing a custom editor, e.g. for a special namespace, etc. $article:Article being edited $user:User performing the edit 'DeletedContribsPager::reallyDoQuery':Called before really executing the query for Special:DeletedContributions Similar to ContribsPager::reallyDoQuery & $data:an array of results of all contribs queries $pager:The DeletedContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'DeletedContributionsLineEnding':Called before a DeletedContributions HTML line is finished. Similar to ContributionsLineEnding $page:SpecialPage object for DeletedContributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'DeleteUnknownPreferences':Called by the cleanupPreferences.php maintenance script to build a WHERE clause with which to delete preferences that are not known about. This hook is used by extensions that have dynamically-named preferences that should not be deleted in the usual cleanup process. For example, the Gadgets extension creates preferences prefixed with 'gadget-', and so anything with that prefix is excluded from the deletion. &where:An array that will be passed as the $cond parameter to IDatabase::select() to determine what will be deleted from the user_properties table. $db:The IDatabase object, useful for accessing $db->buildLike() etc. 'DifferenceEngineAfterLoadNewText':called in DifferenceEngine::loadNewText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before returning true from this function. $differenceEngine:DifferenceEngine object 'DifferenceEngineLoadTextAfterNewContentIsLoaded':called in DifferenceEngine::loadText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before checking if the variable 's value is null. This hook can be used to inject content into said class member variable. $differenceEngine:DifferenceEngine object 'DifferenceEngineMarkPatrolledLink':Allows extensions to change the "mark as patrolled" link which is shown both on the diff header as well as on the bottom of a page, usually wrapped in a span element which has class="patrollink". $differenceEngine:DifferenceEngine object & $markAsPatrolledLink:The "mark as patrolled" link HTML(string) $rcid:Recent change ID(rc_id) for this change(int) 'DifferenceEngineMarkPatrolledRCID':Allows extensions to possibly change the rcid parameter. For example the rcid might be set to zero due to the user being the same as the performer of the change but an extension might still want to show it under certain conditions. & $rcid:rc_id(int) of the change or 0 $differenceEngine:DifferenceEngine object $change:RecentChange object $user:User object representing the current user 'DifferenceEngineNewHeader':Allows extensions to change the $newHeader variable, which contains information about the new revision, such as the revision 's author, whether the revision was marked as a minor edit or not, etc. $differenceEngine:DifferenceEngine object & $newHeader:The string containing the various #mw-diff-otitle[1-5] divs, which include things like revision author info, revision comment, RevisionDelete link and more $formattedRevisionTools:Array containing revision tools, some of which may have been injected with the DiffRevisionTools hook $nextlink:String containing the link to the next revision(if any) $status
Definition: hooks.txt:1250
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
getFileListInternal( $container, $dir, array $params)
doGetFileStat(array $params)
doStoreInternal(array $params)
$params
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:773
newStatus(... $args)
Yields the result of the status wrapper callback on either:
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
Base class for all backends using particular storage medium.
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
array $files
Map of (file path => (data,mtime)
doGetLocalCopyMulti(array $params)
Simulation of a backend storage in memory.
isPathUsableInternal( $storagePath)
if(!is_readable( $file)) $ext
Definition: router.php:48
doCreateInternal(array $params)
doDeleteInternal(array $params)
doCopyInternal(array $params)
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation files(the "Software")
getDirectoryListInternal( $container, $dir, array $params)