MediaWiki master
FileBackendDBRepoWrapper.php
Go to the documentation of this file.
1<?php
23
40 protected $backend;
42 protected $repoName;
44 protected $dbHandleFunc;
48 protected $dbs;
49
50 public function __construct( array $config ) {
52 $backend = $config['backend'];
53 $config['name'] = $backend->getName();
54 $config['domainId'] = $backend->getDomainId();
55 parent::__construct( $config );
56 $this->backend = $config['backend'];
57 $this->repoName = $config['repoName'];
58 $this->dbHandleFunc = $config['dbHandleFactory'];
59 $this->resolvedPathCache = new MapCacheLRU( 100 );
60 }
61
67 public function getInternalBackend() {
68 return $this->backend;
69 }
70
81 public function getBackendPath( $path, $latest = true ) {
82 $paths = $this->getBackendPaths( [ $path ], $latest );
83 return current( $paths );
84 }
85
96 public function getBackendPaths( array $paths, $latest = true ) {
97 $db = $this->getDB( $latest ? DB_PRIMARY : DB_REPLICA );
98
99 // @TODO: batching
100 $resolved = [];
101 foreach ( $paths as $i => $path ) {
102 if ( !$latest && $this->resolvedPathCache->hasField( $path, 'target', 10 ) ) {
103 $resolved[$i] = $this->resolvedPathCache->getField( $path, 'target' );
104 continue;
105 }
106
107 [ , $container ] = FileBackend::splitStoragePath( $path );
108
109 if ( $container === "{$this->repoName}-public" ) {
110 $name = basename( $path );
111 if ( str_contains( $path, '!' ) ) {
112 $sha1 = $db->newSelectQueryBuilder()
113 ->select( 'oi_sha1' )
114 ->from( 'oldimage' )
115 ->where( [ 'oi_archive_name' => $name ] )
116 ->caller( __METHOD__ )->fetchField();
117 } else {
118 $sha1 = $db->newSelectQueryBuilder()
119 ->select( 'img_sha1' )
120 ->from( 'image' )
121 ->where( [ 'img_name' => $name ] )
122 ->caller( __METHOD__ )->fetchField();
123 }
124 if ( $sha1 === null || !strlen( $sha1 ) ) {
125 $resolved[$i] = $path; // give up
126 continue;
127 }
128 $resolved[$i] = $this->getPathForSHA1( $sha1 );
129 $this->resolvedPathCache->setField( $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->setField( $path, 'target', $resolved[$i] );
135 } else {
136 $resolved[$i] = $path;
137 }
138 }
139
140 $res = [];
141 foreach ( $paths as $i => $path ) {
142 $res[$i] = $resolved[$i];
143 }
144
145 return $res;
146 }
147
148 protected function doOperationsInternal( array $ops, array $opts ) {
149 return $this->backend->doOperationsInternal( $this->mungeOpPaths( $ops ), $opts );
150 }
151
152 protected function doQuickOperationsInternal( array $ops, array $opts ) {
153 return $this->backend->doQuickOperationsInternal( $this->mungeOpPaths( $ops ), $opts );
154 }
155
156 protected function doPrepare( array $params ) {
157 return $this->backend->doPrepare( $params );
158 }
159
160 protected function doSecure( array $params ) {
161 return $this->backend->doSecure( $params );
162 }
163
164 protected function doPublish( array $params ) {
165 return $this->backend->doPublish( $params );
166 }
167
168 protected function doClean( array $params ) {
169 return $this->backend->doClean( $params );
170 }
171
172 public function concatenate( array $params ) {
173 return $this->translateSrcParams( __FUNCTION__, $params );
174 }
175
176 public function fileExists( array $params ) {
177 return $this->translateSrcParams( __FUNCTION__, $params );
178 }
179
180 public function getFileTimestamp( array $params ) {
181 return $this->translateSrcParams( __FUNCTION__, $params );
182 }
183
184 public function getFileSize( array $params ) {
185 return $this->translateSrcParams( __FUNCTION__, $params );
186 }
187
188 public function getFileStat( array $params ) {
189 return $this->translateSrcParams( __FUNCTION__, $params );
190 }
191
192 public function getFileXAttributes( array $params ) {
193 return $this->translateSrcParams( __FUNCTION__, $params );
194 }
195
196 public function getFileSha1Base36( array $params ) {
197 return $this->translateSrcParams( __FUNCTION__, $params );
198 }
199
200 public function getFileProps( array $params ) {
201 return $this->translateSrcParams( __FUNCTION__, $params );
202 }
203
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.
209 $type = StreamFile::contentTypeFromPath( $params['src'] );
210 if ( $type && $type != 'unknown/unknown' ) {
211 $params['headers'][] = "Content-type: $type";
212 }
213 return $this->translateSrcParams( __FUNCTION__, $params );
214 }
215
216 public function getFileContentsMulti( array $params ) {
217 return $this->translateArrayResults( __FUNCTION__, $params );
218 }
219
220 public function getLocalReferenceMulti( array $params ) {
221 return $this->translateArrayResults( __FUNCTION__, $params );
222 }
223
224 public function getLocalCopyMulti( array $params ) {
225 return $this->translateArrayResults( __FUNCTION__, $params );
226 }
227
228 public function getFileHttpUrl( array $params ) {
229 return $this->translateSrcParams( __FUNCTION__, $params );
230 }
231
232 public function directoryExists( array $params ) {
233 return $this->backend->directoryExists( $params );
234 }
235
236 public function getDirectoryList( array $params ) {
237 return $this->backend->getDirectoryList( $params );
238 }
239
240 public function getFileList( array $params ) {
241 return $this->backend->getFileList( $params );
242 }
243
244 public function getFeatures() {
245 return $this->backend->getFeatures();
246 }
247
248 public function clearCache( array $paths = null ) {
249 $this->backend->clearCache( null ); // clear all
250 }
251
252 public function preloadCache( array $paths ) {
253 $paths = $this->getBackendPaths( $paths );
254 $this->backend->preloadCache( $paths );
255 }
256
257 public function preloadFileStat( array $params ) {
258 return $this->translateSrcParams( __FUNCTION__, $params );
259 }
260
261 public function getScopedLocksForOps( array $ops, StatusValue $status ) {
262 return $this->backend->getScopedLocksForOps( $ops, $status );
263 }
264
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 }
280
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 }
294
302 protected function translateSrcParams( $function, array $params ) {
303 $latest = !empty( $params['latest'] );
304
305 if ( isset( $params['src'] ) ) {
306 $params['src'] = $this->getBackendPath( $params['src'], $latest );
307 }
308
309 if ( isset( $params['srcs'] ) ) {
310 $params['srcs'] = $this->getBackendPaths( $params['srcs'], $latest );
311 }
312
313 return $this->backend->$function( $params );
314 }
315
323 protected function translateArrayResults( $function, array $params ) {
324 $origPaths = $params['srcs'];
325 $params['srcs'] = $this->getBackendPaths( $params['srcs'], !empty( $params['latest'] ) );
326 $pathMap = array_combine( $params['srcs'], $origPaths );
327
328 $results = $this->backend->$function( $params );
329
330 $contents = [];
331 foreach ( $results as $path => $result ) {
332 $contents[$pathMap[$path]] = $result;
333 }
334
335 return $contents;
336 }
337
346 protected function mungeOpPaths( array $ops ) {
347 // Ops that use 'src' and do not mutate core file data there
348 static $srcRefOps = [ 'store', 'copy', 'describe' ];
349 foreach ( $ops as &$op ) {
350 if ( isset( $op['src'] ) && in_array( $op['op'], $srcRefOps ) ) {
351 $op['src'] = $this->getBackendPath( $op['src'], true );
352 }
353 if ( isset( $op['srcs'] ) ) {
354 $op['srcs'] = $this->getBackendPaths( $op['srcs'], true );
355 }
356 }
357 return $ops;
358 }
359}
getDB()
Proxy backend that manages file layout rewriting for FileRepo.
getFileSha1Base36(array $params)
Get a SHA-1 hash of the content 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 content of 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.
getInternalBackend()
Get the underlying FileBackend that is being wrapped.
getLocalCopyMulti(array $params)
Like getLocalCopy() except it takes an array of storage paths and yields an order preserved-map of st...
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 yields an order-preserved map ...
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 content of the file at a storage path in the backend.
getFeatures()
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 an order preserved map o...
doQuickOperationsInternal(array $ops, array $opts)
getDirectoryList(array $params)
Get an iterator to list all directories under a storage directory.
getBackendPath( $path, $latest=true)
Translate a legacy "title" path to its "sha1" counterpart.
Base class for all file backend classes (including multi-write backends).
string $name
Unique backend name.
getDomainId()
Get the domain identifier used for this backend (possibly empty).
static splitStoragePath( $storagePath)
Split a storage path into a backend name, a container name, and a relative file path.
getName()
Get the unique backend name.
Store key-value entries in a size-limited in-memory LRU cache.
Functions related to the output of file content.
Generic operation result class Has warning/error list, boolean status and arbitrary value.
Helper class used for automatically marking an IDatabase connection as reusable (once it no longer ma...
Definition DBConnRef.php:29
const DB_REPLICA
Definition defines.php:26
const DB_PRIMARY
Definition defines.php:28