3 * Local repository that stores files in the local filesystem and registers them
4 * in the wiki's own database.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License along
17 * with this program; if not, write to the Free Software Foundation, Inc.,
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19 * http://www.gnu.org/copyleft/gpl.html
25 use Wikimedia\Rdbms\ResultWrapper
;
26 use Wikimedia\Rdbms\Database
;
27 use Wikimedia\Rdbms\IDatabase
;
30 * A repository that stores files in the local filesystem and registers them
31 * in the wiki's own database. This is the most commonly used repository class.
35 class LocalRepo
extends FileRepo
{
37 protected $fileFactory = [ LocalFile
::class, 'newFromTitle' ];
39 protected $fileFactoryKey = [ LocalFile
::class, 'newFromKey' ];
41 protected $fileFromRowFactory = [ LocalFile
::class, 'newFromRow' ];
43 protected $oldFileFromRowFactory = [ OldLocalFile
::class, 'newFromRow' ];
45 protected $oldFileFactory = [ OldLocalFile
::class, 'newFromTitle' ];
47 protected $oldFileFactoryKey = [ OldLocalFile
::class, 'newFromKey' ];
49 function __construct( array $info = null ) {
50 parent
::__construct( $info );
52 $this->hasSha1Storage
= isset( $info['storageLayout'] )
53 && $info['storageLayout'] === 'sha1';
55 if ( $this->hasSha1Storage() ) {
56 $this->backend
= new FileBackendDBRepoWrapper( [
57 'backend' => $this->backend
,
58 'repoName' => $this->name
,
59 'dbHandleFactory' => $this->getDBFactory()
66 * @param stdClass $row
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 );
75 throw new MWException( __METHOD__
. ': invalid row' );
81 * @param string $archiveName
82 * @return OldLocalFile
84 function newFromArchiveName( $title, $archiveName ) {
85 return OldLocalFile
::newFromArchiveName( $title, $this, $archiveName );
89 * Delete files in the deleted directory if they are not referenced in the
90 * filearchive table. This needs to be done in the repo because it needs to
91 * interleave database locks with file operations, which is potentially a
94 * @param array $storageKeys
98 function cleanupDeletedBatch( array $storageKeys ) {
99 if ( $this->hasSha1Storage() ) {
100 wfDebug( __METHOD__
. ": skipped because storage uses sha1 paths\n" );
101 return Status
::newGood();
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++
;
125 wfDebug( __METHOD__
. ": $key still in use\n" );
126 $status->successCount++
;
128 $dbw->endAtomic( __METHOD__
);
135 * Check if a deleted (filearchive) file has this sha1 key
137 * @param string $key File storage key (base-36 sha1 key with file extension)
138 * @param string|null $lock Use "lock" to lock the row via FOR UPDATE
139 * @return bool File with this key is in use
141 protected function deletedFileHasKey( $key, $lock = null ) {
142 $options = ( $lock === 'lock' ) ?
[ 'FOR UPDATE' ] : [];
144 $dbw = $this->getMasterDB();
146 return (bool)$dbw->selectField( 'filearchive', '1',
147 [ 'fa_storage_group' => 'deleted', 'fa_storage_key' => $key ],
153 * Check if a hidden (revision delete) file has this sha1 key
155 * @param string $key File storage key (base-36 sha1 key with file extension)
156 * @param string|null $lock Use "lock" to lock the row via FOR UPDATE
157 * @return bool File with this key is in use
159 protected function hiddenFileHasKey( $key, $lock = null ) {
160 $options = ( $lock === 'lock' ) ?
[ 'FOR UPDATE' ] : [];
162 $sha1 = self
::getHashFromKey( $key );
163 $ext = File
::normalizeExtension( substr( $key, strcspn( $key, '.' ) +
1 ) );
165 $dbw = $this->getMasterDB();
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
],
176 * Gets the SHA1 hash from a storage key
181 public static function getHashFromKey( $key ) {
182 return strtok( $key, '.' );
186 * Checks if there is a redirect named as $title
188 * @param Title $title Title of file
191 function checkRedirect( Title
$title ) {
192 $title = File
::normalizeTitle( $title, 'exception' );
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
199 $expiry = 86400; // has invalidation, 1 day
202 $method = __METHOD__
;
203 $redirDbKey = ObjectCache
::getMainWANInstance()->getWithSetCallback(
206 function ( $oldValue, &$ttl, array &$setOpts ) use ( $method, $title ) {
207 $dbr = $this->getReplicaDB(); // possibly remote DB
209 $setOpts +
= Database
::getCacheSetOptions( $dbr );
211 if ( $title instanceof Title
) {
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
)
227 ? Title
::makeTitle( $row->rd_namespace
, $row->rd_title
)->getDBkey()
228 : ''; // negative cache
230 [ 'pcTTL' => WANObjectCache
::TTL_PROC_LONG
]
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
);
239 return false; // no redirect
242 public function findFiles( array $items, $flags = 0 ) {
243 $finalFiles = []; // map of (DB key => corresponding File) for matches
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'] );
250 $searchSet[$title->getDBkey()] = $item;
253 $title = File
::normalizeTitle( $item );
255 $searchSet[$title->getDBkey()] = [];
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
)
269 ( empty( $search['time'] ) && !$file->isOld() ) ||
270 ( !empty( $search['time'] ) && $search['time'] === $file->getTimestamp() )
272 ( !empty( $search['private'] ) ||
!$file->isDeleted( File
::DELETED_FILE
) ) &&
273 $file->userCan( File
::DELETED_FILE
, $user )
277 $applyMatchingFiles = function ( ResultWrapper
$res, &$searchSet, &$finalFiles )
278 use ( $fileMatchesSearch, $flags )
281 $info = $this->getInfo();
282 foreach ( $res as $row ) {
283 $file = $this->newFileFromRow( $row );
284 // There must have been a search for this DB key, but this has to handle the
285 // cases were title capitalization is different on the client and repo wikis.
286 $dbKeysLook = [ strtr( $file->getName(), ' ', '_' ) ];
287 if ( !empty( $info['initialCapital'] ) ) {
288 // Search keys for "hi.png" and "Hi.png" should use the "Hi.png file"
289 $dbKeysLook[] = $wgContLang->lcfirst( $file->getName() );
291 foreach ( $dbKeysLook as $dbKey ) {
292 if ( isset( $searchSet[$dbKey] )
293 && $fileMatchesSearch( $file, $searchSet[$dbKey] )
295 $finalFiles[$dbKey] = ( $flags & FileRepo
::NAME_AND_TIME_ONLY
)
296 ?
[ 'title' => $dbKey, 'timestamp' => $file->getTimestamp() ]
298 unset( $searchSet[$dbKey] );
304 $dbr = $this->getReplicaDB();
308 foreach ( array_keys( $searchSet ) as $dbKey ) {
309 $imgNames[] = $this->getNameFromTitle( File
::normalizeTitle( $dbKey ) );
312 if ( count( $imgNames ) ) {
313 $fileQuery = LocalFile
::getQueryInfo();
314 $res = $dbr->select( $fileQuery['tables'], $fileQuery['fields'], [ 'img_name' => $imgNames ],
315 __METHOD__
, [], $fileQuery['joins'] );
316 $applyMatchingFiles( $res, $searchSet, $finalFiles );
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(
325 'oi_name' => $this->getNameFromTitle( File
::normalizeTitle( $dbKey ) ),
326 'oi_timestamp' => $dbr->timestamp( $search['time'] )
333 if ( count( $oiConds ) ) {
334 $fileQuery = OldLocalFile
::getQueryInfo();
335 $res = $dbr->select( $fileQuery['tables'], $fileQuery['fields'],
336 $dbr->makeList( $oiConds, LIST_OR
),
337 __METHOD__
, [], $fileQuery['joins'] );
338 $applyMatchingFiles( $res, $searchSet, $finalFiles );
341 // Check for redirects...
342 foreach ( $searchSet as $dbKey => $search ) {
343 if ( !empty( $search['ignoreRedirect'] ) ) {
347 $title = File
::normalizeTitle( $dbKey );
348 $redir = $this->checkRedirect( $title ); // hopefully hits memcached
350 if ( $redir && $redir->getNamespace() == NS_FILE
) {
351 $file = $this->newFile( $redir );
352 if ( $file && $fileMatchesSearch( $file, $search ) ) {
353 $file->redirectedFrom( $title->getDBkey() );
354 if ( $flags & FileRepo
::NAME_AND_TIME_ONLY
) {
355 $finalFiles[$dbKey] = [
356 'title' => $file->getTitle()->getDBkey(),
357 'timestamp' => $file->getTimestamp()
360 $finalFiles[$dbKey] = $file;
370 * Get an array or iterator of file objects for files that have a given
371 * SHA-1 content hash.
373 * @param string $hash A sha1 hash to look for
376 function findBySha1( $hash ) {
377 $dbr = $this->getReplicaDB();
378 $fileQuery = LocalFile
::getQueryInfo();
380 $fileQuery['tables'],
381 $fileQuery['fields'],
382 [ 'img_sha1' => $hash ],
384 [ 'ORDER BY' => 'img_name' ],
389 foreach ( $res as $row ) {
390 $result[] = $this->newFileFromRow( $row );
398 * Get an array of arrays or iterators of file objects for files that
399 * have the given SHA-1 content hashes.
401 * Overrides generic implementation in FileRepo for performance reason
403 * @param array $hashes An array of hashes
404 * @return array An Array of arrays or iterators of file objects and the hash as key
406 function findBySha1s( array $hashes ) {
407 if ( !count( $hashes ) ) {
408 return []; // empty parameter
411 $dbr = $this->getReplicaDB();
412 $fileQuery = LocalFile
::getQueryInfo();
414 $fileQuery['tables'],
415 $fileQuery['fields'],
416 [ 'img_sha1' => $hashes ],
418 [ 'ORDER BY' => 'img_name' ],
423 foreach ( $res as $row ) {
424 $file = $this->newFileFromRow( $row );
425 $result[$file->getSha1()][] = $file;
433 * Return an array of files where the name starts with $prefix.
435 * @param string $prefix The prefix to search for
436 * @param int $limit The maximum amount of files to return
439 public function findFilesByPrefix( $prefix, $limit ) {
440 $selectOptions = [ 'ORDER BY' => 'img_name', 'LIMIT' => intval( $limit ) ];
443 $dbr = $this->getReplicaDB();
444 $fileQuery = LocalFile
::getQueryInfo();
446 $fileQuery['tables'],
447 $fileQuery['fields'],
448 'img_name ' . $dbr->buildLike( $prefix, $dbr->anyString() ),
454 // Build file objects
456 foreach ( $res as $row ) {
457 $files[] = $this->newFileFromRow( $row );
464 * Get a connection to the replica DB
467 function getReplicaDB() {
468 return wfGetDB( DB_REPLICA
);
472 * Alias for getReplicaDB()
475 * @deprecated Since 1.29
477 function getSlaveDB() {
478 return $this->getReplicaDB();
482 * Get a connection to the master DB
485 function getMasterDB() {
486 return wfGetDB( DB_MASTER
);
490 * Get a callback to get a DB handle given an index (DB_REPLICA/DB_MASTER)
493 protected function getDBFactory() {
494 return function ( $index ) {
495 return wfGetDB( $index );
500 * Get a key on the primary cache for this repository.
501 * Returns false if the repository's cache is not accessible at this site.
502 * The parameters are the parts of the key, as for wfMemcKey().
506 function getSharedCacheKey( /*...*/ ) {
507 $args = func_get_args();
509 return call_user_func_array( 'wfMemcKey', $args );
513 * Invalidates image redirect cache related to that image
515 * @param Title $title Title of page
518 function invalidateImageRedirect( Title
$title ) {
519 $key = $this->getSharedCacheKey( 'image_redirect', md5( $title->getDBkey() ) );
521 $this->getMasterDB()->onTransactionPreCommitOrIdle(
522 function () use ( $key ) {
523 ObjectCache
::getMainWANInstance()->delete( $key );
531 * Return information about the repository.
539 return array_merge( parent
::getInfo(), [
540 'favicon' => wfExpandUrl( $wgFavicon ),
544 public function store( $srcPath, $dstZone, $dstRel, $flags = 0 ) {
545 return $this->skipWriteOperationIfSha1( __FUNCTION__
, func_get_args() );
548 public function storeBatch( array $triplets, $flags = 0 ) {
549 return $this->skipWriteOperationIfSha1( __FUNCTION__
, func_get_args() );
552 public function cleanupBatch( array $files, $flags = 0 ) {
553 return $this->skipWriteOperationIfSha1( __FUNCTION__
, func_get_args() );
556 public function publish(
563 return $this->skipWriteOperationIfSha1( __FUNCTION__
, func_get_args() );
566 public function publishBatch( array $ntuples, $flags = 0 ) {
567 return $this->skipWriteOperationIfSha1( __FUNCTION__
, func_get_args() );
570 public function delete( $srcRel, $archiveRel ) {
571 return $this->skipWriteOperationIfSha1( __FUNCTION__
, func_get_args() );
574 public function deleteBatch( array $sourceDestPairs ) {
575 return $this->skipWriteOperationIfSha1( __FUNCTION__
, func_get_args() );
579 * Skips the write operation if storage is sha1-based, executes it normally otherwise
581 * @param string $function
585 protected function skipWriteOperationIfSha1( $function, array $args ) {
586 $this->assertWritableRepo(); // fail out if read-only
588 if ( $this->hasSha1Storage() ) {
589 wfDebug( __METHOD__
. ": skipped because storage uses sha1 paths\n" );
590 return Status
::newGood();
592 return call_user_func_array( 'parent::' . $function, $args );