3 * Local file in the wiki's own database.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
21 * @ingroup FileAbstraction
24 use MediaWiki\Logger\LoggerFactory
;
25 use Wikimedia\Rdbms\Database
;
26 use Wikimedia\Rdbms\IDatabase
;
29 * Class to represent a local file in the wiki's own database
31 * Provides methods to retrieve paths (physical, logical, URL),
32 * to generate image thumbnails or for uploading.
34 * Note that only the repo object knows what its file class is called. You should
35 * never name a file class explictly outside of the repo class. Instead use the
36 * repo's factory functions to generate file objects, for example:
38 * RepoGroup::singleton()->getLocalRepo()->newFile( $title );
40 * The convenience functions wfLocalFile() and wfFindFile() should be sufficient
43 * @ingroup FileAbstraction
45 class LocalFile
extends File
{
46 const VERSION
= 11; // cache version
48 const CACHE_FIELD_MAX_LEN
= 1000;
50 /** @var bool Does the file exist on disk? (loadFromXxx) */
51 protected $fileExists;
53 /** @var int Image width */
56 /** @var int Image height */
59 /** @var int Returned by getimagesize (loadFromXxx) */
62 /** @var string MEDIATYPE_xxx (bitmap, drawing, audio...) */
63 protected $media_type;
65 /** @var string MIME type, determined by MimeMagic::guessMimeType */
68 /** @var int Size in bytes (loadFromXxx) */
71 /** @var string Handler-specific metadata */
74 /** @var string SHA-1 base 36 content hash */
77 /** @var bool Whether or not core data has been loaded from the database (loadFromXxx) */
78 protected $dataLoaded;
80 /** @var bool Whether or not lazy-loaded data has been loaded from the database */
81 protected $extraDataLoaded;
83 /** @var int Bitfield akin to rev_deleted */
87 protected $repoClass = LocalRepo
::class;
89 /** @var int Number of line to return by nextHistoryLine() (constructor) */
92 /** @var int Result of the query for the file's history (nextHistoryLine) */
95 /** @var string Major MIME type */
98 /** @var string Minor MIME type */
101 /** @var string Upload timestamp */
104 /** @var int User ID of uploader */
107 /** @var string User name of uploader */
110 /** @var string Description of current revision of the file */
111 private $description;
113 /** @var string TS_MW timestamp of the last change of the file description */
114 private $descriptionTouched;
116 /** @var bool Whether the row was upgraded on load */
119 /** @var bool Whether the row was scheduled to upgrade on load */
122 /** @var bool True if the image row is locked */
125 /** @var bool True if the image row is locked with a lock initiated transaction */
126 private $lockedOwnTrx;
128 /** @var bool True if file is not present in file system. Not to be cached in memcached */
131 // @note: higher than IDBAccessObject constants
132 const LOAD_ALL
= 16; // integer; load all the lazy fields too (like metadata)
134 const ATOMIC_SECTION_LOCK
= 'LocalFile::lockingTransaction';
137 * Create a LocalFile from a title
138 * Do not call this except from inside a repo class.
140 * Note: $unused param is only here to avoid an E_STRICT
142 * @param Title $title
143 * @param FileRepo $repo
144 * @param null $unused
148 static function newFromTitle( $title, $repo, $unused = null ) {
149 return new self( $title, $repo );
153 * Create a LocalFile from a title
154 * Do not call this except from inside a repo class.
156 * @param stdClass $row
157 * @param FileRepo $repo
161 static function newFromRow( $row, $repo ) {
162 $title = Title
::makeTitle( NS_FILE
, $row->img_name
);
163 $file = new self( $title, $repo );
164 $file->loadFromRow( $row );
170 * Create a LocalFile from a SHA-1 key
171 * Do not call this except from inside a repo class.
173 * @param string $sha1 Base-36 SHA-1
174 * @param LocalRepo $repo
175 * @param string|bool $timestamp MW_timestamp (optional)
176 * @return bool|LocalFile
178 static function newFromKey( $sha1, $repo, $timestamp = false ) {
179 $dbr = $repo->getReplicaDB();
181 $conds = [ 'img_sha1' => $sha1 ];
183 $conds['img_timestamp'] = $dbr->timestamp( $timestamp );
186 $fileQuery = self
::getQueryInfo();
187 $row = $dbr->selectRow(
188 $fileQuery['tables'], $fileQuery['fields'], $conds, __METHOD__
, [], $fileQuery['joins']
191 return self
::newFromRow( $row, $repo );
198 * Fields in the image table
199 * @deprecated since 1.31, use self::getQueryInfo() instead.
202 static function selectFields() {
203 wfDeprecated( __METHOD__
, '1.31' );
218 ] + CommentStore
::getStore()->getFields( 'img_description' );
222 * Return the tables, fields, and join conditions to be selected to create
223 * a new localfile object.
225 * @param string[] $options
226 * - omit-lazy: Omit fields that are lazily cached.
227 * @return array With three keys:
228 * - tables: (string[]) to include in the `$table` to `IDatabase->select()`
229 * - fields: (string[]) to include in the `$vars` to `IDatabase->select()`
230 * - joins: (array) to include in the `$join_conds` to `IDatabase->select()`
232 public static function getQueryInfo( array $options = [] ) {
233 $commentQuery = CommentStore
::getStore()->getJoin( 'img_description' );
235 'tables' => [ 'image' ] +
$commentQuery['tables'],
250 ] +
$commentQuery['fields'],
251 'joins' => $commentQuery['joins'],
254 if ( in_array( 'omit-nonlazy', $options, true ) ) {
255 // Internal use only for getting only the lazy fields
258 if ( !in_array( 'omit-lazy', $options, true ) ) {
259 // Note: Keep this in sync with self::getLazyCacheFields()
260 $ret['fields'][] = 'img_metadata';
267 * Do not call this except from inside a repo class.
268 * @param Title $title
269 * @param FileRepo $repo
271 function __construct( $title, $repo ) {
272 parent
::__construct( $title, $repo );
274 $this->metadata
= '';
275 $this->historyLine
= 0;
276 $this->historyRes
= null;
277 $this->dataLoaded
= false;
278 $this->extraDataLoaded
= false;
280 $this->assertRepoDefined();
281 $this->assertTitleDefined();
285 * Get the memcached key for the main data for this file, or false if
286 * there is no access to the shared cache.
287 * @return string|bool
289 function getCacheKey() {
290 return $this->repo
->getSharedCacheKey( 'file', sha1( $this->getName() ) );
294 * @param WANObjectCache $cache
298 public function getMutableCacheKeys( WANObjectCache
$cache ) {
299 return [ $this->getCacheKey() ];
303 * Try to load file metadata from memcached, falling back to the database
305 private function loadFromCache() {
306 $this->dataLoaded
= false;
307 $this->extraDataLoaded
= false;
309 $key = $this->getCacheKey();
311 $this->loadFromDB( self
::READ_NORMAL
);
316 $cache = ObjectCache
::getMainWANInstance();
317 $cachedValues = $cache->getWithSetCallback(
320 function ( $oldValue, &$ttl, array &$setOpts ) use ( $cache ) {
321 $setOpts +
= Database
::getCacheSetOptions( $this->repo
->getReplicaDB() );
323 $this->loadFromDB( self
::READ_NORMAL
);
325 $fields = $this->getCacheFields( '' );
326 $cacheVal['fileExists'] = $this->fileExists
;
327 if ( $this->fileExists
) {
328 foreach ( $fields as $field ) {
329 $cacheVal[$field] = $this->$field;
332 // Strip off excessive entries from the subset of fields that can become large.
333 // If the cache value gets to large it will not fit in memcached and nothing will
334 // get cached at all, causing master queries for any file access.
335 foreach ( $this->getLazyCacheFields( '' ) as $field ) {
336 if ( isset( $cacheVal[$field] )
337 && strlen( $cacheVal[$field] ) > 100 * 1024
339 unset( $cacheVal[$field] ); // don't let the value get too big
343 if ( $this->fileExists
) {
344 $ttl = $cache->adaptiveTTL( wfTimestamp( TS_UNIX
, $this->timestamp
), $ttl );
346 $ttl = $cache::TTL_DAY
;
351 [ 'version' => self
::VERSION
]
354 $this->fileExists
= $cachedValues['fileExists'];
355 if ( $this->fileExists
) {
356 $this->setProps( $cachedValues );
359 $this->dataLoaded
= true;
360 $this->extraDataLoaded
= true;
361 foreach ( $this->getLazyCacheFields( '' ) as $field ) {
362 $this->extraDataLoaded
= $this->extraDataLoaded
&& isset( $cachedValues[$field] );
367 * Purge the file object/metadata cache
369 public function invalidateCache() {
370 $key = $this->getCacheKey();
375 $this->repo
->getMasterDB()->onTransactionPreCommitOrIdle(
376 function () use ( $key ) {
377 ObjectCache
::getMainWANInstance()->delete( $key );
384 * Load metadata from the file itself
386 function loadFromFile() {
387 $props = $this->repo
->getFileProps( $this->getVirtualUrl() );
388 $this->setProps( $props );
392 * Returns the list of object properties that are included as-is in the cache.
393 * @param string $prefix Must be the empty string
395 * @since 1.31 No longer accepts a non-empty $prefix
397 protected function getCacheFields( $prefix = 'img_' ) {
398 if ( $prefix !== '' ) {
399 throw new InvalidArgumentException(
400 __METHOD__
. ' with a non-empty prefix is no longer supported.'
404 // See self::getQueryInfo() for the fetching of the data from the DB,
405 // self::loadFromRow() for the loading of the object from the DB row,
406 // and self::loadFromCache() for the caching, and self::setProps() for
407 // populating the object from an array of data.
408 return [ 'size', 'width', 'height', 'bits', 'media_type',
409 'major_mime', 'minor_mime', 'metadata', 'timestamp', 'sha1', 'user',
410 'user_text', 'description' ];
414 * Returns the list of object properties that are included as-is in the
415 * cache, only when they're not too big, and are lazily loaded by self::loadExtraFromDB().
416 * @param string $prefix Must be the empty string
418 * @since 1.31 No longer accepts a non-empty $prefix
420 protected function getLazyCacheFields( $prefix = 'img_' ) {
421 if ( $prefix !== '' ) {
422 throw new InvalidArgumentException(
423 __METHOD__
. ' with a non-empty prefix is no longer supported.'
427 // Keep this in sync with the omit-lazy option in self::getQueryInfo().
428 return [ 'metadata' ];
432 * Load file metadata from the DB
435 function loadFromDB( $flags = 0 ) {
436 $fname = static::class . '::' . __FUNCTION__
;
438 # Unconditionally set loaded=true, we don't want the accessors constantly rechecking
439 $this->dataLoaded
= true;
440 $this->extraDataLoaded
= true;
442 $dbr = ( $flags & self
::READ_LATEST
)
443 ?
$this->repo
->getMasterDB()
444 : $this->repo
->getReplicaDB();
446 $fileQuery = static::getQueryInfo();
447 $row = $dbr->selectRow(
448 $fileQuery['tables'],
449 $fileQuery['fields'],
450 [ 'img_name' => $this->getName() ],
457 $this->loadFromRow( $row );
459 $this->fileExists
= false;
464 * Load lazy file metadata from the DB.
465 * This covers fields that are sometimes not cached.
467 protected function loadExtraFromDB() {
468 $fname = static::class . '::' . __FUNCTION__
;
470 # Unconditionally set loaded=true, we don't want the accessors constantly rechecking
471 $this->extraDataLoaded
= true;
473 $fieldMap = $this->loadExtraFieldsWithTimestamp( $this->repo
->getReplicaDB(), $fname );
475 $fieldMap = $this->loadExtraFieldsWithTimestamp( $this->repo
->getMasterDB(), $fname );
479 foreach ( $fieldMap as $name => $value ) {
480 $this->$name = $value;
483 throw new MWException( "Could not find data for image '{$this->getName()}'." );
488 * @param IDatabase $dbr
489 * @param string $fname
492 private function loadExtraFieldsWithTimestamp( $dbr, $fname ) {
495 $fileQuery = self
::getQueryInfo( [ 'omit-nonlazy' ] );
496 $row = $dbr->selectRow(
497 $fileQuery['tables'],
498 $fileQuery['fields'],
500 'img_name' => $this->getName(),
501 'img_timestamp' => $dbr->timestamp( $this->getTimestamp() ),
508 $fieldMap = $this->unprefixRow( $row, 'img_' );
510 # File may have been uploaded over in the meantime; check the old versions
511 $fileQuery = OldLocalFile
::getQueryInfo( [ 'omit-nonlazy' ] );
512 $row = $dbr->selectRow(
513 $fileQuery['tables'],
514 $fileQuery['fields'],
516 'oi_name' => $this->getName(),
517 'oi_timestamp' => $dbr->timestamp( $this->getTimestamp() ),
524 $fieldMap = $this->unprefixRow( $row, 'oi_' );
528 if ( isset( $fieldMap['metadata'] ) ) {
529 $fieldMap['metadata'] = $this->repo
->getReplicaDB()->decodeBlob( $fieldMap['metadata'] );
536 * @param array|object $row
537 * @param string $prefix
538 * @throws MWException
541 protected function unprefixRow( $row, $prefix = 'img_' ) {
542 $array = (array)$row;
543 $prefixLength = strlen( $prefix );
545 // Sanity check prefix once
546 if ( substr( key( $array ), 0, $prefixLength ) !== $prefix ) {
547 throw new MWException( __METHOD__
. ': incorrect $prefix parameter' );
551 foreach ( $array as $name => $value ) {
552 $decoded[substr( $name, $prefixLength )] = $value;
559 * Decode a row from the database (either object or array) to an array
560 * with timestamps and MIME types decoded, and the field prefix removed.
562 * @param string $prefix
563 * @throws MWException
566 function decodeRow( $row, $prefix = 'img_' ) {
567 $decoded = $this->unprefixRow( $row, $prefix );
569 $decoded['description'] = CommentStore
::getStore()
570 ->getComment( 'description', (object)$decoded )->text
;
572 $decoded['timestamp'] = wfTimestamp( TS_MW
, $decoded['timestamp'] );
574 $decoded['metadata'] = $this->repo
->getReplicaDB()->decodeBlob( $decoded['metadata'] );
576 if ( empty( $decoded['major_mime'] ) ) {
577 $decoded['mime'] = 'unknown/unknown';
579 if ( !$decoded['minor_mime'] ) {
580 $decoded['minor_mime'] = 'unknown';
582 $decoded['mime'] = $decoded['major_mime'] . '/' . $decoded['minor_mime'];
585 // Trim zero padding from char/binary field
586 $decoded['sha1'] = rtrim( $decoded['sha1'], "\0" );
588 // Normalize some fields to integer type, per their database definition.
589 // Use unary + so that overflows will be upgraded to double instead of
590 // being trucated as with intval(). This is important to allow >2GB
591 // files on 32-bit systems.
592 foreach ( [ 'size', 'width', 'height', 'bits' ] as $field ) {
593 $decoded[$field] = +
$decoded[$field];
600 * Load file metadata from a DB result row
603 * @param string $prefix
605 function loadFromRow( $row, $prefix = 'img_' ) {
606 $this->dataLoaded
= true;
607 $this->extraDataLoaded
= true;
609 $array = $this->decodeRow( $row, $prefix );
611 foreach ( $array as $name => $value ) {
612 $this->$name = $value;
615 $this->fileExists
= true;
616 $this->maybeUpgradeRow();
620 * Load file metadata from cache or DB, unless already loaded
623 function load( $flags = 0 ) {
624 if ( !$this->dataLoaded
) {
625 if ( $flags & self
::READ_LATEST
) {
626 $this->loadFromDB( $flags );
628 $this->loadFromCache();
632 if ( ( $flags & self
::LOAD_ALL
) && !$this->extraDataLoaded
) {
633 // @note: loads on name/timestamp to reduce race condition problems
634 $this->loadExtraFromDB();
639 * Upgrade a row if it needs it
641 function maybeUpgradeRow() {
642 global $wgUpdateCompatibleMetadata;
644 if ( wfReadOnly() ||
$this->upgrading
) {
649 if ( is_null( $this->media_type
) ||
$this->mime
== 'image/svg' ) {
652 $handler = $this->getHandler();
654 $validity = $handler->isMetadataValid( $this, $this->getMetadata() );
655 if ( $validity === MediaHandler
::METADATA_BAD
) {
657 } elseif ( $validity === MediaHandler
::METADATA_COMPATIBLE
) {
658 $upgrade = $wgUpdateCompatibleMetadata;
664 $this->upgrading
= true;
665 // Defer updates unless in auto-commit CLI mode
666 DeferredUpdates
::addCallableUpdate( function () {
667 $this->upgrading
= false; // avoid duplicate updates
670 } catch ( LocalFileLockError
$e ) {
671 // let the other process handle it (or do it next time)
678 * @return bool Whether upgradeRow() ran for this object
680 function getUpgraded() {
681 return $this->upgraded
;
685 * Fix assorted version-related problems with the image row by reloading it from the file
687 function upgradeRow() {
688 $this->lock(); // begin
690 $this->loadFromFile();
692 # Don't destroy file info of missing files
693 if ( !$this->fileExists
) {
695 wfDebug( __METHOD__
. ": file does not exist, aborting\n" );
700 $dbw = $this->repo
->getMasterDB();
701 list( $major, $minor ) = self
::splitMime( $this->mime
);
703 if ( wfReadOnly() ) {
708 wfDebug( __METHOD__
. ': upgrading ' . $this->getName() . " to the current schema\n" );
710 $dbw->update( 'image',
712 'img_size' => $this->size
, // sanity
713 'img_width' => $this->width
,
714 'img_height' => $this->height
,
715 'img_bits' => $this->bits
,
716 'img_media_type' => $this->media_type
,
717 'img_major_mime' => $major,
718 'img_minor_mime' => $minor,
719 'img_metadata' => $dbw->encodeBlob( $this->metadata
),
720 'img_sha1' => $this->sha1
,
722 [ 'img_name' => $this->getName() ],
726 $this->invalidateCache();
728 $this->unlock(); // done
729 $this->upgraded
= true; // avoid rework/retries
733 * Set properties in this object to be equal to those given in the
734 * associative array $info. Only cacheable fields can be set.
735 * All fields *must* be set in $info except for getLazyCacheFields().
737 * If 'mime' is given, it will be split into major_mime/minor_mime.
738 * If major_mime/minor_mime are given, $this->mime will also be set.
742 function setProps( $info ) {
743 $this->dataLoaded
= true;
744 $fields = $this->getCacheFields( '' );
745 $fields[] = 'fileExists';
747 foreach ( $fields as $field ) {
748 if ( isset( $info[$field] ) ) {
749 $this->$field = $info[$field];
753 // Fix up mime fields
754 if ( isset( $info['major_mime'] ) ) {
755 $this->mime
= "{$info['major_mime']}/{$info['minor_mime']}";
756 } elseif ( isset( $info['mime'] ) ) {
757 $this->mime
= $info['mime'];
758 list( $this->major_mime
, $this->minor_mime
) = self
::splitMime( $this->mime
);
762 /** splitMime inherited */
763 /** getName inherited */
764 /** getTitle inherited */
765 /** getURL inherited */
766 /** getViewURL inherited */
767 /** getPath inherited */
768 /** isVisible inherited */
773 function isMissing() {
774 if ( $this->missing
=== null ) {
775 list( $fileExists ) = $this->repo
->fileExists( $this->getVirtualUrl() );
776 $this->missing
= !$fileExists;
779 return $this->missing
;
783 * Return the width of the image
788 public function getWidth( $page = 1 ) {
796 if ( $this->isMultipage() ) {
797 $handler = $this->getHandler();
801 $dim = $handler->getPageDimensions( $this, $page );
803 return $dim['width'];
805 // For non-paged media, the false goes through an
806 // intval, turning failure into 0, so do same here.
815 * Return the height of the image
820 public function getHeight( $page = 1 ) {
828 if ( $this->isMultipage() ) {
829 $handler = $this->getHandler();
833 $dim = $handler->getPageDimensions( $this, $page );
835 return $dim['height'];
837 // For non-paged media, the false goes through an
838 // intval, turning failure into 0, so do same here.
842 return $this->height
;
847 * Returns ID or name of user who uploaded the file
849 * @param string $type 'text' or 'id'
852 function getUser( $type = 'text' ) {
855 if ( $type == 'text' ) {
856 return $this->user_text
;
858 return (int)$this->user
;
863 * Get short description URL for a file based on the page ID.
865 * @return string|null
866 * @throws MWException
869 public function getDescriptionShortUrl() {
870 $pageId = $this->title
->getArticleID();
872 if ( $pageId !== null ) {
873 $url = $this->repo
->makeUrl( [ 'curid' => $pageId ] );
874 if ( $url !== false ) {
882 * Get handler-specific metadata
885 function getMetadata() {
886 $this->load( self
::LOAD_ALL
); // large metadata is loaded in another step
887 return $this->metadata
;
893 function getBitDepth() {
896 return (int)$this->bits
;
900 * Returns the size of the image file, in bytes
903 public function getSize() {
910 * Returns the MIME type of the file.
913 function getMimeType() {
920 * Returns the type of the media in the file.
921 * Use the value returned by this function with the MEDIATYPE_xxx constants.
924 function getMediaType() {
927 return $this->media_type
;
930 /** canRender inherited */
931 /** mustRender inherited */
932 /** allowInlineDisplay inherited */
933 /** isSafeFile inherited */
934 /** isTrustedFile inherited */
937 * Returns true if the file exists on disk.
938 * @return bool Whether file exist on disk.
940 public function exists() {
943 return $this->fileExists
;
946 /** getTransformScript inherited */
947 /** getUnscaledThumb inherited */
948 /** thumbName inherited */
949 /** createThumb inherited */
950 /** transform inherited */
952 /** getHandler inherited */
953 /** iconThumb inherited */
954 /** getLastError inherited */
957 * Get all thumbnail names previously generated for this file
958 * @param string|bool $archiveName Name of an archive file, default false
959 * @return array First element is the base dir, then files in that base dir.
961 function getThumbnails( $archiveName = false ) {
962 if ( $archiveName ) {
963 $dir = $this->getArchiveThumbPath( $archiveName );
965 $dir = $this->getThumbPath();
968 $backend = $this->repo
->getBackend();
971 $iterator = $backend->getFileList( [ 'dir' => $dir ] );
972 foreach ( $iterator as $file ) {
975 } catch ( FileBackendError
$e ) {
976 } // suppress (T56674)
982 * Refresh metadata in memcached, but don't touch thumbnails or CDN
984 function purgeMetadataCache() {
985 $this->invalidateCache();
989 * Delete all previously generated thumbnails, refresh metadata in memcached and purge the CDN.
991 * @param array $options An array potentially with the key forThumbRefresh.
993 * @note This used to purge old thumbnails by default as well, but doesn't anymore.
995 function purgeCache( $options = [] ) {
996 // Refresh metadata cache
997 $this->purgeMetadataCache();
1000 $this->purgeThumbnails( $options );
1002 // Purge CDN cache for this file
1003 DeferredUpdates
::addUpdate(
1004 new CdnCacheUpdate( [ $this->getUrl() ] ),
1005 DeferredUpdates
::PRESEND
1010 * Delete cached transformed files for an archived version only.
1011 * @param string $archiveName Name of the archived file
1013 function purgeOldThumbnails( $archiveName ) {
1014 // Get a list of old thumbnails and URLs
1015 $files = $this->getThumbnails( $archiveName );
1017 // Purge any custom thumbnail caches
1018 Hooks
::run( 'LocalFilePurgeThumbnails', [ $this, $archiveName ] );
1020 // Delete thumbnails
1021 $dir = array_shift( $files );
1022 $this->purgeThumbList( $dir, $files );
1026 foreach ( $files as $file ) {
1027 $urls[] = $this->getArchiveThumbUrl( $archiveName, $file );
1029 DeferredUpdates
::addUpdate( new CdnCacheUpdate( $urls ), DeferredUpdates
::PRESEND
);
1033 * Delete cached transformed files for the current version only.
1034 * @param array $options
1036 public function purgeThumbnails( $options = [] ) {
1037 $files = $this->getThumbnails();
1038 // Always purge all files from CDN regardless of handler filters
1040 foreach ( $files as $file ) {
1041 $urls[] = $this->getThumbUrl( $file );
1043 array_shift( $urls ); // don't purge directory
1045 // Give media handler a chance to filter the file purge list
1046 if ( !empty( $options['forThumbRefresh'] ) ) {
1047 $handler = $this->getHandler();
1049 $handler->filterThumbnailPurgeList( $files, $options );
1053 // Purge any custom thumbnail caches
1054 Hooks
::run( 'LocalFilePurgeThumbnails', [ $this, false ] );
1056 // Delete thumbnails
1057 $dir = array_shift( $files );
1058 $this->purgeThumbList( $dir, $files );
1061 DeferredUpdates
::addUpdate( new CdnCacheUpdate( $urls ), DeferredUpdates
::PRESEND
);
1065 * Prerenders a configurable set of thumbnails
1069 public function prerenderThumbnails() {
1070 global $wgUploadThumbnailRenderMap;
1074 $sizes = $wgUploadThumbnailRenderMap;
1077 foreach ( $sizes as $size ) {
1078 if ( $this->isVectorized() ||
$this->getWidth() > $size ) {
1079 $jobs[] = new ThumbnailRenderJob(
1081 [ 'transformParams' => [ 'width' => $size ] ]
1087 JobQueueGroup
::singleton()->lazyPush( $jobs );
1092 * Delete a list of thumbnails visible at urls
1093 * @param string $dir Base dir of the files.
1094 * @param array $files Array of strings: relative filenames (to $dir)
1096 protected function purgeThumbList( $dir, $files ) {
1097 $fileListDebug = strtr(
1098 var_export( $files, true ),
1101 wfDebug( __METHOD__
. ": $fileListDebug\n" );
1104 foreach ( $files as $file ) {
1105 if ( $this->repo
->supportsSha1URLs() ) {
1106 $reference = $this->getSha1();
1108 $reference = $this->getName();
1111 # Check that the reference (filename or sha1) is part of the thumb name
1112 # This is a basic sanity check to avoid erasing unrelated directories
1113 if ( strpos( $file, $reference ) !== false
1114 ||
strpos( $file, "-thumbnail" ) !== false // "short" thumb name
1116 $purgeList[] = "{$dir}/{$file}";
1120 # Delete the thumbnails
1121 $this->repo
->quickPurgeBatch( $purgeList );
1122 # Clear out the thumbnail directory if empty
1123 $this->repo
->quickCleanDir( $dir );
1126 /** purgeDescription inherited */
1127 /** purgeEverything inherited */
1130 * @param int $limit Optional: Limit to number of results
1131 * @param int $start Optional: Timestamp, start from
1132 * @param int $end Optional: Timestamp, end at
1134 * @return OldLocalFile[]
1136 function getHistory( $limit = null, $start = null, $end = null, $inc = true ) {
1137 $dbr = $this->repo
->getReplicaDB();
1138 $oldFileQuery = OldLocalFile
::getQueryInfo();
1140 $tables = $oldFileQuery['tables'];
1141 $fields = $oldFileQuery['fields'];
1142 $join_conds = $oldFileQuery['joins'];
1143 $conds = $opts = [];
1144 $eq = $inc ?
'=' : '';
1145 $conds[] = "oi_name = " . $dbr->addQuotes( $this->title
->getDBkey() );
1148 $conds[] = "oi_timestamp <$eq " . $dbr->addQuotes( $dbr->timestamp( $start ) );
1152 $conds[] = "oi_timestamp >$eq " . $dbr->addQuotes( $dbr->timestamp( $end ) );
1156 $opts['LIMIT'] = $limit;
1159 // Search backwards for time > x queries
1160 $order = ( !$start && $end !== null ) ?
'ASC' : 'DESC';
1161 $opts['ORDER BY'] = "oi_timestamp $order";
1162 $opts['USE INDEX'] = [ 'oldimage' => 'oi_name_timestamp' ];
1164 // Avoid PHP 7.1 warning from passing $this by reference
1166 Hooks
::run( 'LocalFile::getHistory', [ &$localFile, &$tables, &$fields,
1167 &$conds, &$opts, &$join_conds ] );
1169 $res = $dbr->select( $tables, $fields, $conds, __METHOD__
, $opts, $join_conds );
1172 foreach ( $res as $row ) {
1173 $r[] = $this->repo
->newFileFromRow( $row );
1176 if ( $order == 'ASC' ) {
1177 $r = array_reverse( $r ); // make sure it ends up descending
1184 * Returns the history of this file, line by line.
1185 * starts with current version, then old versions.
1186 * uses $this->historyLine to check which line to return:
1187 * 0 return line for current version
1188 * 1 query for old versions, return first one
1189 * 2, ... return next old version from above query
1192 public function nextHistoryLine() {
1193 # Polymorphic function name to distinguish foreign and local fetches
1194 $fname = static::class . '::' . __FUNCTION__
;
1196 $dbr = $this->repo
->getReplicaDB();
1198 if ( $this->historyLine
== 0 ) { // called for the first time, return line from cur
1199 $fileQuery = self
::getQueryInfo();
1200 $this->historyRes
= $dbr->select( $fileQuery['tables'],
1201 $fileQuery['fields'] +
[
1202 'oi_archive_name' => $dbr->addQuotes( '' ),
1205 [ 'img_name' => $this->title
->getDBkey() ],
1211 if ( 0 == $dbr->numRows( $this->historyRes
) ) {
1212 $this->historyRes
= null;
1216 } elseif ( $this->historyLine
== 1 ) {
1217 $fileQuery = OldLocalFile
::getQueryInfo();
1218 $this->historyRes
= $dbr->select(
1219 $fileQuery['tables'],
1220 $fileQuery['fields'],
1221 [ 'oi_name' => $this->title
->getDBkey() ],
1223 [ 'ORDER BY' => 'oi_timestamp DESC' ],
1227 $this->historyLine++
;
1229 return $dbr->fetchObject( $this->historyRes
);
1233 * Reset the history pointer to the first element of the history
1235 public function resetHistory() {
1236 $this->historyLine
= 0;
1238 if ( !is_null( $this->historyRes
) ) {
1239 $this->historyRes
= null;
1243 /** getHashPath inherited */
1244 /** getRel inherited */
1245 /** getUrlRel inherited */
1246 /** getArchiveRel inherited */
1247 /** getArchivePath inherited */
1248 /** getThumbPath inherited */
1249 /** getArchiveUrl inherited */
1250 /** getThumbUrl inherited */
1251 /** getArchiveVirtualUrl inherited */
1252 /** getThumbVirtualUrl inherited */
1253 /** isHashed inherited */
1256 * Upload a file and record it in the DB
1257 * @param string|FSFile $src Source storage path, virtual URL, or filesystem path
1258 * @param string $comment Upload description
1259 * @param string $pageText Text to use for the new description page,
1260 * if a new description page is created
1261 * @param int|bool $flags Flags for publish()
1262 * @param array|bool $props File properties, if known. This can be used to
1263 * reduce the upload time when uploading virtual URLs for which the file
1264 * info is already known
1265 * @param string|bool $timestamp Timestamp for img_timestamp, or false to use the
1267 * @param User|null $user User object or null to use $wgUser
1268 * @param string[] $tags Change tags to add to the log entry and page revision.
1269 * (This doesn't check $user's permissions.)
1270 * @return Status On success, the value member contains the
1271 * archive name, or an empty string if it was a new file.
1273 function upload( $src, $comment, $pageText, $flags = 0, $props = false,
1274 $timestamp = false, $user = null, $tags = []
1276 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
1277 return $this->readOnlyFatalStatus();
1280 $srcPath = ( $src instanceof FSFile
) ?
$src->getPath() : $src;
1282 if ( $this->repo
->isVirtualUrl( $srcPath )
1283 || FileBackend
::isStoragePath( $srcPath )
1285 $props = $this->repo
->getFileProps( $srcPath );
1287 $mwProps = new MWFileProps( MediaWiki\MediaWikiServices
::getInstance()->getMimeAnalyzer() );
1288 $props = $mwProps->getPropsFromPath( $srcPath, true );
1293 $handler = MediaHandler
::getHandler( $props['mime'] );
1295 $metadata = Wikimedia\
quietCall( 'unserialize', $props['metadata'] );
1297 if ( !is_array( $metadata ) ) {
1301 $options['headers'] = $handler->getContentHeaders( $metadata );
1303 $options['headers'] = [];
1306 // Trim spaces on user supplied text
1307 $comment = trim( $comment );
1309 $this->lock(); // begin
1310 $status = $this->publish( $src, $flags, $options );
1312 if ( $status->successCount
>= 2 ) {
1313 // There will be a copy+(one of move,copy,store).
1314 // The first succeeding does not commit us to updating the DB
1315 // since it simply copied the current version to a timestamped file name.
1316 // It is only *preferable* to avoid leaving such files orphaned.
1317 // Once the second operation goes through, then the current version was
1318 // updated and we must therefore update the DB too.
1319 $oldver = $status->value
;
1320 $uploadStatus = $this->recordUpload2(
1329 if ( !$uploadStatus->isOK() ) {
1330 if ( $uploadStatus->hasMessage( 'filenotfound' ) ) {
1331 // update filenotfound error with more specific path
1332 $status->fatal( 'filenotfound', $srcPath );
1334 $status->merge( $uploadStatus );
1339 $this->unlock(); // done
1345 * Record a file upload in the upload log and the image table
1346 * @param string $oldver
1347 * @param string $desc
1348 * @param string $license
1349 * @param string $copyStatus
1350 * @param string $source
1351 * @param bool $watch
1352 * @param string|bool $timestamp
1353 * @param User|null $user User object or null to use $wgUser
1356 function recordUpload( $oldver, $desc, $license = '', $copyStatus = '', $source = '',
1357 $watch = false, $timestamp = false, User
$user = null ) {
1363 $pageText = SpecialUpload
::getInitialPageText( $desc, $license, $copyStatus, $source );
1365 if ( !$this->recordUpload2( $oldver, $desc, $pageText, false, $timestamp, $user )->isOK() ) {
1370 $user->addWatch( $this->getTitle() );
1377 * Record a file upload in the upload log and the image table
1378 * @param string $oldver
1379 * @param string $comment
1380 * @param string $pageText
1381 * @param bool|array $props
1382 * @param string|bool $timestamp
1383 * @param null|User $user
1384 * @param string[] $tags
1387 function recordUpload2(
1388 $oldver, $comment, $pageText, $props = false, $timestamp = false, $user = null, $tags = []
1390 global $wgCommentTableSchemaMigrationStage;
1392 if ( is_null( $user ) ) {
1397 $dbw = $this->repo
->getMasterDB();
1399 # Imports or such might force a certain timestamp; otherwise we generate
1400 # it and can fudge it slightly to keep (name,timestamp) unique on re-upload.
1401 if ( $timestamp === false ) {
1402 $timestamp = $dbw->timestamp();
1403 $allowTimeKludge = true;
1405 $allowTimeKludge = false;
1408 $props = $props ?
: $this->repo
->getFileProps( $this->getVirtualUrl() );
1409 $props['description'] = $comment;
1410 $props['user'] = $user->getId();
1411 $props['user_text'] = $user->getName();
1412 $props['timestamp'] = wfTimestamp( TS_MW
, $timestamp ); // DB -> TS_MW
1413 $this->setProps( $props );
1415 # Fail now if the file isn't there
1416 if ( !$this->fileExists
) {
1417 wfDebug( __METHOD__
. ": File " . $this->getRel() . " went missing!\n" );
1419 return Status
::newFatal( 'filenotfound', $this->getRel() );
1422 $dbw->startAtomic( __METHOD__
);
1424 # Test to see if the row exists using INSERT IGNORE
1425 # This avoids race conditions by locking the row until the commit, and also
1426 # doesn't deadlock. SELECT FOR UPDATE causes a deadlock for every race condition.
1427 $commentStore = CommentStore
::getStore();
1428 list( $commentFields, $commentCallback ) =
1429 $commentStore->insertWithTempTable( $dbw, 'img_description', $comment );
1430 $dbw->insert( 'image',
1432 'img_name' => $this->getName(),
1433 'img_size' => $this->size
,
1434 'img_width' => intval( $this->width
),
1435 'img_height' => intval( $this->height
),
1436 'img_bits' => $this->bits
,
1437 'img_media_type' => $this->media_type
,
1438 'img_major_mime' => $this->major_mime
,
1439 'img_minor_mime' => $this->minor_mime
,
1440 'img_timestamp' => $timestamp,
1441 'img_user' => $user->getId(),
1442 'img_user_text' => $user->getName(),
1443 'img_metadata' => $dbw->encodeBlob( $this->metadata
),
1444 'img_sha1' => $this->sha1
1449 $reupload = ( $dbw->affectedRows() == 0 );
1452 $row = $dbw->selectRow(
1454 [ 'img_timestamp', 'img_sha1' ],
1455 [ 'img_name' => $this->getName() ],
1457 [ 'LOCK IN SHARE MODE' ]
1460 if ( $row && $row->img_sha1
=== $this->sha1
) {
1461 $dbw->endAtomic( __METHOD__
);
1462 wfDebug( __METHOD__
. ": File " . $this->getRel() . " already exists!\n" );
1463 $title = Title
::newFromText( $this->getName(), NS_FILE
);
1464 return Status
::newFatal( 'fileexists-no-change', $title->getPrefixedText() );
1467 if ( $allowTimeKludge ) {
1468 # Use LOCK IN SHARE MODE to ignore any transaction snapshotting
1469 $lUnixtime = $row ?
wfTimestamp( TS_UNIX
, $row->img_timestamp
) : false;
1470 # Avoid a timestamp that is not newer than the last version
1471 # TODO: the image/oldimage tables should be like page/revision with an ID field
1472 if ( $lUnixtime && wfTimestamp( TS_UNIX
, $timestamp ) <= $lUnixtime ) {
1473 sleep( 1 ); // fast enough re-uploads would go far in the future otherwise
1474 $timestamp = $dbw->timestamp( $lUnixtime +
1 );
1475 $this->timestamp
= wfTimestamp( TS_MW
, $timestamp ); // DB -> TS_MW
1479 $tables = [ 'image' ];
1481 'oi_name' => 'img_name',
1482 'oi_archive_name' => $dbw->addQuotes( $oldver ),
1483 'oi_size' => 'img_size',
1484 'oi_width' => 'img_width',
1485 'oi_height' => 'img_height',
1486 'oi_bits' => 'img_bits',
1487 'oi_timestamp' => 'img_timestamp',
1488 'oi_user' => 'img_user',
1489 'oi_user_text' => 'img_user_text',
1490 'oi_metadata' => 'img_metadata',
1491 'oi_media_type' => 'img_media_type',
1492 'oi_major_mime' => 'img_major_mime',
1493 'oi_minor_mime' => 'img_minor_mime',
1494 'oi_sha1' => 'img_sha1',
1498 if ( $wgCommentTableSchemaMigrationStage <= MIGRATION_WRITE_BOTH
) {
1499 $fields['oi_description'] = 'img_description';
1501 if ( $wgCommentTableSchemaMigrationStage >= MIGRATION_WRITE_BOTH
) {
1502 $tables[] = 'image_comment_temp';
1503 $fields['oi_description_id'] = 'imgcomment_description_id';
1504 $joins['image_comment_temp'] = [
1505 $wgCommentTableSchemaMigrationStage === MIGRATION_NEW ?
'JOIN' : 'LEFT JOIN',
1506 [ 'imgcomment_name = img_name' ]
1510 if ( $wgCommentTableSchemaMigrationStage !== MIGRATION_OLD
&&
1511 $wgCommentTableSchemaMigrationStage !== MIGRATION_NEW
1513 // Upgrade any rows that are still old-style. Otherwise an upgrade
1514 // might be missed if a deletion happens while the migration script
1516 $res = $dbw->select(
1517 [ 'image', 'image_comment_temp' ],
1518 [ 'img_name', 'img_description' ],
1519 [ 'img_name' => $this->getName(), 'imgcomment_name' => null ],
1522 [ 'image_comment_temp' => [ 'LEFT JOIN', [ 'imgcomment_name = img_name' ] ] ]
1524 foreach ( $res as $row ) {
1525 list( , $callback ) = $commentStore->insertWithTempTable(
1526 $dbw, 'img_description', $row->img_description
1528 $callback( $row->img_name
);
1532 # (T36993) Note: $oldver can be empty here, if the previous
1533 # version of the file was broken. Allow registration of the new
1534 # version to continue anyway, because that's better than having
1535 # an image that's not fixable by user operations.
1536 # Collision, this is an update of a file
1537 # Insert previous contents into oldimage
1538 $dbw->insertSelect( 'oldimage', $tables, $fields,
1539 [ 'img_name' => $this->getName() ], __METHOD__
, [], [], $joins );
1541 # Update the current image row
1542 $dbw->update( 'image',
1544 'img_size' => $this->size
,
1545 'img_width' => intval( $this->width
),
1546 'img_height' => intval( $this->height
),
1547 'img_bits' => $this->bits
,
1548 'img_media_type' => $this->media_type
,
1549 'img_major_mime' => $this->major_mime
,
1550 'img_minor_mime' => $this->minor_mime
,
1551 'img_timestamp' => $timestamp,
1552 'img_user' => $user->getId(),
1553 'img_user_text' => $user->getName(),
1554 'img_metadata' => $dbw->encodeBlob( $this->metadata
),
1555 'img_sha1' => $this->sha1
1557 [ 'img_name' => $this->getName() ],
1560 if ( $wgCommentTableSchemaMigrationStage > MIGRATION_OLD
) {
1561 // So $commentCallback can insert the new row
1562 $dbw->delete( 'image_comment_temp', [ 'imgcomment_name' => $this->getName() ], __METHOD__
);
1565 $commentCallback( $this->getName() );
1567 $descTitle = $this->getTitle();
1568 $descId = $descTitle->getArticleID();
1569 $wikiPage = new WikiFilePage( $descTitle );
1570 $wikiPage->setFile( $this );
1572 // Add the log entry...
1573 $logEntry = new ManualLogEntry( 'upload', $reupload ?
'overwrite' : 'upload' );
1574 $logEntry->setTimestamp( $this->timestamp
);
1575 $logEntry->setPerformer( $user );
1576 $logEntry->setComment( $comment );
1577 $logEntry->setTarget( $descTitle );
1578 // Allow people using the api to associate log entries with the upload.
1579 // Log has a timestamp, but sometimes different from upload timestamp.
1580 $logEntry->setParameters(
1582 'img_sha1' => $this->sha1
,
1583 'img_timestamp' => $timestamp,
1586 // Note we keep $logId around since during new image
1587 // creation, page doesn't exist yet, so log_page = 0
1588 // but we want it to point to the page we're making,
1589 // so we later modify the log entry.
1590 // For a similar reason, we avoid making an RC entry
1591 // now and wait until the page exists.
1592 $logId = $logEntry->insert();
1594 if ( $descTitle->exists() ) {
1595 // Use own context to get the action text in content language
1596 $formatter = LogFormatter
::newFromEntry( $logEntry );
1597 $formatter->setContext( RequestContext
::newExtraneousContext( $descTitle ) );
1598 $editSummary = $formatter->getPlainActionText();
1600 $nullRevision = Revision
::newNullRevision(
1607 if ( $nullRevision ) {
1608 $nullRevision->insertOn( $dbw );
1610 'NewRevisionFromEditComplete',
1611 [ $wikiPage, $nullRevision, $nullRevision->getParentId(), $user ]
1613 $wikiPage->updateRevisionOn( $dbw, $nullRevision );
1614 // Associate null revision id
1615 $logEntry->setAssociatedRevId( $nullRevision->getId() );
1618 $newPageContent = null;
1620 // Make the description page and RC log entry post-commit
1621 $newPageContent = ContentHandler
::makeContent( $pageText, $descTitle );
1624 # Defer purges, page creation, and link updates in case they error out.
1625 # The most important thing is that files and the DB registry stay synced.
1626 $dbw->endAtomic( __METHOD__
);
1628 # Do some cache purges after final commit so that:
1629 # a) Changes are more likely to be seen post-purge
1630 # b) They won't cause rollback of the log publish/update above
1631 DeferredUpdates
::addUpdate(
1632 new AutoCommitUpdate(
1636 $reupload, $wikiPage, $newPageContent, $comment, $user,
1637 $logEntry, $logId, $descId, $tags
1639 # Update memcache after the commit
1640 $this->invalidateCache();
1642 $updateLogPage = false;
1643 if ( $newPageContent ) {
1644 # New file page; create the description page.
1645 # There's already a log entry, so don't make a second RC entry
1646 # CDN and file cache for the description page are purged by doEditContent.
1647 $status = $wikiPage->doEditContent(
1650 EDIT_NEW | EDIT_SUPPRESS_RC
,
1655 if ( isset( $status->value
['revision'] ) ) {
1656 /** @var Revision $rev */
1657 $rev = $status->value
['revision'];
1658 // Associate new page revision id
1659 $logEntry->setAssociatedRevId( $rev->getId() );
1661 // This relies on the resetArticleID() call in WikiPage::insertOn(),
1662 // which is triggered on $descTitle by doEditContent() above.
1663 if ( isset( $status->value
['revision'] ) ) {
1664 /** @var Revision $rev */
1665 $rev = $status->value
['revision'];
1666 $updateLogPage = $rev->getPage();
1669 # Existing file page: invalidate description page cache
1670 $wikiPage->getTitle()->invalidateCache();
1671 $wikiPage->getTitle()->purgeSquid();
1672 # Allow the new file version to be patrolled from the page footer
1673 Article
::purgePatrolFooterCache( $descId );
1676 # Update associated rev id. This should be done by $logEntry->insert() earlier,
1677 # but setAssociatedRevId() wasn't called at that point yet...
1678 $logParams = $logEntry->getParameters();
1679 $logParams['associated_rev_id'] = $logEntry->getAssociatedRevId();
1680 $update = [ 'log_params' => LogEntryBase
::makeParamBlob( $logParams ) ];
1681 if ( $updateLogPage ) {
1682 # Also log page, in case where we just created it above
1683 $update['log_page'] = $updateLogPage;
1685 $this->getRepo()->getMasterDB()->update(
1688 [ 'log_id' => $logId ],
1691 $this->getRepo()->getMasterDB()->insert(
1694 'ls_field' => 'associated_rev_id',
1695 'ls_value' => $logEntry->getAssociatedRevId(),
1696 'ls_log_id' => $logId,
1701 # Add change tags, if any
1703 $logEntry->setTags( $tags );
1706 # Uploads can be patrolled
1707 $logEntry->setIsPatrollable( true );
1709 # Now that the log entry is up-to-date, make an RC entry.
1710 $logEntry->publish( $logId );
1712 # Run hook for other updates (typically more cache purging)
1713 Hooks
::run( 'FileUpload', [ $this, $reupload, !$newPageContent ] );
1716 # Delete old thumbnails
1717 $this->purgeThumbnails();
1718 # Remove the old file from the CDN cache
1719 DeferredUpdates
::addUpdate(
1720 new CdnCacheUpdate( [ $this->getUrl() ] ),
1721 DeferredUpdates
::PRESEND
1724 # Update backlink pages pointing to this title if created
1725 LinksUpdate
::queueRecursiveJobsForTable(
1733 $this->prerenderThumbnails();
1736 DeferredUpdates
::PRESEND
1740 # This is a new file, so update the image count
1741 DeferredUpdates
::addUpdate( SiteStatsUpdate
::factory( [ 'images' => 1 ] ) );
1744 # Invalidate cache for all pages using this file
1745 DeferredUpdates
::addUpdate(
1746 new HTMLCacheUpdate( $this->getTitle(), 'imagelinks', 'file-upload' )
1749 return Status
::newGood();
1753 * Move or copy a file to its public location. If a file exists at the
1754 * destination, move it to an archive. Returns a Status object with
1755 * the archive name in the "value" member on success.
1757 * The archive name should be passed through to recordUpload for database
1760 * @param string|FSFile $src Local filesystem path or virtual URL to the source image
1761 * @param int $flags A bitwise combination of:
1762 * File::DELETE_SOURCE Delete the source file, i.e. move rather than copy
1763 * @param array $options Optional additional parameters
1764 * @return Status On success, the value member contains the
1765 * archive name, or an empty string if it was a new file.
1767 function publish( $src, $flags = 0, array $options = [] ) {
1768 return $this->publishTo( $src, $this->getRel(), $flags, $options );
1772 * Move or copy a file to a specified location. Returns a Status
1773 * object with the archive name in the "value" member on success.
1775 * The archive name should be passed through to recordUpload for database
1778 * @param string|FSFile $src Local filesystem path or virtual URL to the source image
1779 * @param string $dstRel Target relative path
1780 * @param int $flags A bitwise combination of:
1781 * File::DELETE_SOURCE Delete the source file, i.e. move rather than copy
1782 * @param array $options Optional additional parameters
1783 * @return Status On success, the value member contains the
1784 * archive name, or an empty string if it was a new file.
1786 function publishTo( $src, $dstRel, $flags = 0, array $options = [] ) {
1787 $srcPath = ( $src instanceof FSFile
) ?
$src->getPath() : $src;
1789 $repo = $this->getRepo();
1790 if ( $repo->getReadOnlyReason() !== false ) {
1791 return $this->readOnlyFatalStatus();
1794 $this->lock(); // begin
1796 $archiveName = wfTimestamp( TS_MW
) . '!' . $this->getName();
1797 $archiveRel = 'archive/' . $this->getHashPath() . $archiveName;
1799 if ( $repo->hasSha1Storage() ) {
1800 $sha1 = $repo->isVirtualUrl( $srcPath )
1801 ?
$repo->getFileSha1( $srcPath )
1802 : FSFile
::getSha1Base36FromPath( $srcPath );
1803 /** @var FileBackendDBRepoWrapper $wrapperBackend */
1804 $wrapperBackend = $repo->getBackend();
1805 $dst = $wrapperBackend->getPathForSHA1( $sha1 );
1806 $status = $repo->quickImport( $src, $dst );
1807 if ( $flags & File
::DELETE_SOURCE
) {
1811 if ( $this->exists() ) {
1812 $status->value
= $archiveName;
1815 $flags = $flags & File
::DELETE_SOURCE ? LocalRepo
::DELETE_SOURCE
: 0;
1816 $status = $repo->publish( $srcPath, $dstRel, $archiveRel, $flags, $options );
1818 if ( $status->value
== 'new' ) {
1819 $status->value
= '';
1821 $status->value
= $archiveName;
1825 $this->unlock(); // done
1830 /** getLinksTo inherited */
1831 /** getExifData inherited */
1832 /** isLocal inherited */
1833 /** wasDeleted inherited */
1836 * Move file to the new title
1838 * Move current, old version and all thumbnails
1839 * to the new filename. Old file is deleted.
1841 * Cache purging is done; checks for validity
1842 * and logging are caller's responsibility
1844 * @param Title $target New file name
1847 function move( $target ) {
1848 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
1849 return $this->readOnlyFatalStatus();
1852 wfDebugLog( 'imagemove', "Got request to move {$this->name} to " . $target->getText() );
1853 $batch = new LocalFileMoveBatch( $this, $target );
1855 $this->lock(); // begin
1856 $batch->addCurrent();
1857 $archiveNames = $batch->addOlds();
1858 $status = $batch->execute();
1859 $this->unlock(); // done
1861 wfDebugLog( 'imagemove', "Finished moving {$this->name}" );
1863 // Purge the source and target files...
1864 $oldTitleFile = wfLocalFile( $this->title
);
1865 $newTitleFile = wfLocalFile( $target );
1866 // To avoid slow purges in the transaction, move them outside...
1867 DeferredUpdates
::addUpdate(
1868 new AutoCommitUpdate(
1869 $this->getRepo()->getMasterDB(),
1871 function () use ( $oldTitleFile, $newTitleFile, $archiveNames ) {
1872 $oldTitleFile->purgeEverything();
1873 foreach ( $archiveNames as $archiveName ) {
1874 $oldTitleFile->purgeOldThumbnails( $archiveName );
1876 $newTitleFile->purgeEverything();
1879 DeferredUpdates
::PRESEND
1882 if ( $status->isOK() ) {
1883 // Now switch the object
1884 $this->title
= $target;
1885 // Force regeneration of the name and hashpath
1886 unset( $this->name
);
1887 unset( $this->hashPath
);
1894 * Delete all versions of the file.
1896 * Moves the files into an archive directory (or deletes them)
1897 * and removes the database rows.
1899 * Cache purging is done; logging is caller's responsibility.
1901 * @param string $reason
1902 * @param bool $suppress
1903 * @param User|null $user
1906 function delete( $reason, $suppress = false, $user = null ) {
1907 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
1908 return $this->readOnlyFatalStatus();
1911 $batch = new LocalFileDeleteBatch( $this, $reason, $suppress, $user );
1913 $this->lock(); // begin
1914 $batch->addCurrent();
1915 // Get old version relative paths
1916 $archiveNames = $batch->addOlds();
1917 $status = $batch->execute();
1918 $this->unlock(); // done
1920 if ( $status->isOK() ) {
1921 DeferredUpdates
::addUpdate( SiteStatsUpdate
::factory( [ 'images' => -1 ] ) );
1924 // To avoid slow purges in the transaction, move them outside...
1925 DeferredUpdates
::addUpdate(
1926 new AutoCommitUpdate(
1927 $this->getRepo()->getMasterDB(),
1929 function () use ( $archiveNames ) {
1930 $this->purgeEverything();
1931 foreach ( $archiveNames as $archiveName ) {
1932 $this->purgeOldThumbnails( $archiveName );
1936 DeferredUpdates
::PRESEND
1941 foreach ( $archiveNames as $archiveName ) {
1942 $purgeUrls[] = $this->getArchiveUrl( $archiveName );
1944 DeferredUpdates
::addUpdate( new CdnCacheUpdate( $purgeUrls ), DeferredUpdates
::PRESEND
);
1950 * Delete an old version of the file.
1952 * Moves the file into an archive directory (or deletes it)
1953 * and removes the database row.
1955 * Cache purging is done; logging is caller's responsibility.
1957 * @param string $archiveName
1958 * @param string $reason
1959 * @param bool $suppress
1960 * @param User|null $user
1961 * @throws MWException Exception on database or file store failure
1964 function deleteOld( $archiveName, $reason, $suppress = false, $user = null ) {
1965 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
1966 return $this->readOnlyFatalStatus();
1969 $batch = new LocalFileDeleteBatch( $this, $reason, $suppress, $user );
1971 $this->lock(); // begin
1972 $batch->addOld( $archiveName );
1973 $status = $batch->execute();
1974 $this->unlock(); // done
1976 $this->purgeOldThumbnails( $archiveName );
1977 if ( $status->isOK() ) {
1978 $this->purgeDescription();
1981 DeferredUpdates
::addUpdate(
1982 new CdnCacheUpdate( [ $this->getArchiveUrl( $archiveName ) ] ),
1983 DeferredUpdates
::PRESEND
1990 * Restore all or specified deleted revisions to the given file.
1991 * Permissions and logging are left to the caller.
1993 * May throw database exceptions on error.
1995 * @param array $versions Set of record ids of deleted items to restore,
1996 * or empty to restore all revisions.
1997 * @param bool $unsuppress
2000 function restore( $versions = [], $unsuppress = false ) {
2001 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
2002 return $this->readOnlyFatalStatus();
2005 $batch = new LocalFileRestoreBatch( $this, $unsuppress );
2007 $this->lock(); // begin
2011 $batch->addIds( $versions );
2013 $status = $batch->execute();
2014 if ( $status->isGood() ) {
2015 $cleanupStatus = $batch->cleanup();
2016 $cleanupStatus->successCount
= 0;
2017 $cleanupStatus->failCount
= 0;
2018 $status->merge( $cleanupStatus );
2020 $this->unlock(); // done
2025 /** isMultipage inherited */
2026 /** pageCount inherited */
2027 /** scaleHeight inherited */
2028 /** getImageSize inherited */
2031 * Get the URL of the file description page.
2034 function getDescriptionUrl() {
2035 return $this->title
->getLocalURL();
2039 * Get the HTML text of the description page
2040 * This is not used by ImagePage for local files, since (among other things)
2041 * it skips the parser cache.
2043 * @param Language $lang What language to get description in (Optional)
2044 * @return bool|mixed
2046 function getDescriptionText( $lang = null ) {
2047 $revision = Revision
::newFromTitle( $this->title
, false, Revision
::READ_NORMAL
);
2051 $content = $revision->getContent();
2055 $pout = $content->getParserOutput( $this->title
, null, new ParserOptions( null, $lang ) );
2057 return $pout->getText();
2061 * @param int $audience
2065 function getDescription( $audience = self
::FOR_PUBLIC
, User
$user = null ) {
2067 if ( $audience == self
::FOR_PUBLIC
&& $this->isDeleted( self
::DELETED_COMMENT
) ) {
2069 } elseif ( $audience == self
::FOR_THIS_USER
2070 && !$this->userCan( self
::DELETED_COMMENT
, $user )
2074 return $this->description
;
2079 * @return bool|string
2081 function getTimestamp() {
2084 return $this->timestamp
;
2088 * @return bool|string
2090 public function getDescriptionTouched() {
2091 // The DB lookup might return false, e.g. if the file was just deleted, or the shared DB repo
2092 // itself gets it from elsewhere. To avoid repeating the DB lookups in such a case, we
2093 // need to differentiate between null (uninitialized) and false (failed to load).
2094 if ( $this->descriptionTouched
=== null ) {
2096 'page_namespace' => $this->title
->getNamespace(),
2097 'page_title' => $this->title
->getDBkey()
2099 $touched = $this->repo
->getReplicaDB()->selectField( 'page', 'page_touched', $cond, __METHOD__
);
2100 $this->descriptionTouched
= $touched ?
wfTimestamp( TS_MW
, $touched ) : false;
2103 return $this->descriptionTouched
;
2109 function getSha1() {
2111 // Initialise now if necessary
2112 if ( $this->sha1
== '' && $this->fileExists
) {
2113 $this->lock(); // begin
2115 $this->sha1
= $this->repo
->getFileSha1( $this->getPath() );
2116 if ( !wfReadOnly() && strval( $this->sha1
) != '' ) {
2117 $dbw = $this->repo
->getMasterDB();
2118 $dbw->update( 'image',
2119 [ 'img_sha1' => $this->sha1
],
2120 [ 'img_name' => $this->getName() ],
2122 $this->invalidateCache();
2125 $this->unlock(); // done
2132 * @return bool Whether to cache in RepoGroup (this avoids OOMs)
2134 function isCacheable() {
2137 // If extra data (metadata) was not loaded then it must have been large
2138 return $this->extraDataLoaded
2139 && strlen( serialize( $this->metadata
) ) <= self
::CACHE_FIELD_MAX_LEN
;
2146 public function acquireFileLock() {
2147 return $this->getRepo()->getBackend()->lockFiles(
2148 [ $this->getPath() ], LockManager
::LOCK_EX
, 10
2156 public function releaseFileLock() {
2157 return $this->getRepo()->getBackend()->unlockFiles(
2158 [ $this->getPath() ], LockManager
::LOCK_EX
2163 * Start an atomic DB section and lock the image for update
2164 * or increments a reference counter if the lock is already held
2166 * This method should not be used outside of LocalFile/LocalFile*Batch
2168 * @throws LocalFileLockError Throws an error if the lock was not acquired
2169 * @return bool Whether the file lock owns/spawned the DB transaction
2171 public function lock() {
2172 if ( !$this->locked
) {
2173 $logger = LoggerFactory
::getInstance( 'LocalFile' );
2175 $dbw = $this->repo
->getMasterDB();
2176 $makesTransaction = !$dbw->trxLevel();
2177 $dbw->startAtomic( self
::ATOMIC_SECTION_LOCK
);
2178 // T56736: use simple lock to handle when the file does not exist.
2179 // SELECT FOR UPDATE prevents changes, not other SELECTs with FOR UPDATE.
2180 // Also, that would cause contention on INSERT of similarly named rows.
2181 $status = $this->acquireFileLock(); // represents all versions of the file
2182 if ( !$status->isGood() ) {
2183 $dbw->endAtomic( self
::ATOMIC_SECTION_LOCK
);
2184 $logger->warning( "Failed to lock '{file}'", [ 'file' => $this->name
] );
2186 throw new LocalFileLockError( $status );
2188 // Release the lock *after* commit to avoid row-level contention.
2189 // Make sure it triggers on rollback() as well as commit() (T132921).
2190 $dbw->onTransactionResolution(
2191 function () use ( $logger ) {
2192 $status = $this->releaseFileLock();
2193 if ( !$status->isGood() ) {
2194 $logger->error( "Failed to unlock '{file}'", [ 'file' => $this->name
] );
2199 // Callers might care if the SELECT snapshot is safely fresh
2200 $this->lockedOwnTrx
= $makesTransaction;
2205 return $this->lockedOwnTrx
;
2209 * Decrement the lock reference count and end the atomic section if it reaches zero
2211 * This method should not be used outside of LocalFile/LocalFile*Batch
2213 * The commit and loc release will happen when no atomic sections are active, which
2214 * may happen immediately or at some point after calling this
2216 public function unlock() {
2217 if ( $this->locked
) {
2219 if ( !$this->locked
) {
2220 $dbw = $this->repo
->getMasterDB();
2221 $dbw->endAtomic( self
::ATOMIC_SECTION_LOCK
);
2222 $this->lockedOwnTrx
= false;
2230 protected function readOnlyFatalStatus() {
2231 return $this->getRepo()->newFatal( 'filereadonlyerror', $this->getName(),
2232 $this->getRepo()->getName(), $this->getRepo()->getReadOnlyReason() );
2236 * Clean up any dangling locks
2238 function __destruct() {
2241 } // LocalFile class
2243 # ------------------------------------------------------------------------------
2246 * Helper class for file deletion
2247 * @ingroup FileAbstraction
2249 class LocalFileDeleteBatch
{
2250 /** @var LocalFile */
2257 private $srcRels = [];
2260 private $archiveUrls = [];
2262 /** @var array Items to be processed in the deletion batch */
2263 private $deletionBatch;
2265 /** @var bool Whether to suppress all suppressable fields when deleting */
2276 * @param string $reason
2277 * @param bool $suppress
2278 * @param User|null $user
2280 function __construct( File
$file, $reason = '', $suppress = false, $user = null ) {
2281 $this->file
= $file;
2282 $this->reason
= $reason;
2283 $this->suppress
= $suppress;
2285 $this->user
= $user;
2288 $this->user
= $wgUser;
2290 $this->status
= $file->repo
->newGood();
2293 public function addCurrent() {
2294 $this->srcRels
['.'] = $this->file
->getRel();
2298 * @param string $oldName
2300 public function addOld( $oldName ) {
2301 $this->srcRels
[$oldName] = $this->file
->getArchiveRel( $oldName );
2302 $this->archiveUrls
[] = $this->file
->getArchiveUrl( $oldName );
2306 * Add the old versions of the image to the batch
2307 * @return array List of archive names from old versions
2309 public function addOlds() {
2312 $dbw = $this->file
->repo
->getMasterDB();
2313 $result = $dbw->select( 'oldimage',
2314 [ 'oi_archive_name' ],
2315 [ 'oi_name' => $this->file
->getName() ],
2319 foreach ( $result as $row ) {
2320 $this->addOld( $row->oi_archive_name
);
2321 $archiveNames[] = $row->oi_archive_name
;
2324 return $archiveNames;
2330 protected function getOldRels() {
2331 if ( !isset( $this->srcRels
['.'] ) ) {
2332 $oldRels =& $this->srcRels
;
2333 $deleteCurrent = false;
2335 $oldRels = $this->srcRels
;
2336 unset( $oldRels['.'] );
2337 $deleteCurrent = true;
2340 return [ $oldRels, $deleteCurrent ];
2346 protected function getHashes() {
2348 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
2350 if ( $deleteCurrent ) {
2351 $hashes['.'] = $this->file
->getSha1();
2354 if ( count( $oldRels ) ) {
2355 $dbw = $this->file
->repo
->getMasterDB();
2356 $res = $dbw->select(
2358 [ 'oi_archive_name', 'oi_sha1' ],
2359 [ 'oi_archive_name' => array_keys( $oldRels ),
2360 'oi_name' => $this->file
->getName() ], // performance
2364 foreach ( $res as $row ) {
2365 if ( rtrim( $row->oi_sha1
, "\0" ) === '' ) {
2366 // Get the hash from the file
2367 $oldUrl = $this->file
->getArchiveVirtualUrl( $row->oi_archive_name
);
2368 $props = $this->file
->repo
->getFileProps( $oldUrl );
2370 if ( $props['fileExists'] ) {
2371 // Upgrade the oldimage row
2372 $dbw->update( 'oldimage',
2373 [ 'oi_sha1' => $props['sha1'] ],
2374 [ 'oi_name' => $this->file
->getName(), 'oi_archive_name' => $row->oi_archive_name
],
2376 $hashes[$row->oi_archive_name
] = $props['sha1'];
2378 $hashes[$row->oi_archive_name
] = false;
2381 $hashes[$row->oi_archive_name
] = $row->oi_sha1
;
2386 $missing = array_diff_key( $this->srcRels
, $hashes );
2388 foreach ( $missing as $name => $rel ) {
2389 $this->status
->error( 'filedelete-old-unregistered', $name );
2392 foreach ( $hashes as $name => $hash ) {
2394 $this->status
->error( 'filedelete-missing', $this->srcRels
[$name] );
2395 unset( $hashes[$name] );
2402 protected function doDBInserts() {
2403 global $wgCommentTableSchemaMigrationStage;
2406 $dbw = $this->file
->repo
->getMasterDB();
2408 $commentStore = CommentStore
::getStore();
2410 $encTimestamp = $dbw->addQuotes( $dbw->timestamp( $now ) );
2411 $encUserId = $dbw->addQuotes( $this->user
->getId() );
2412 $encGroup = $dbw->addQuotes( 'deleted' );
2413 $ext = $this->file
->getExtension();
2414 $dotExt = $ext === '' ?
'' : ".$ext";
2415 $encExt = $dbw->addQuotes( $dotExt );
2416 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
2418 // Bitfields to further suppress the content
2419 if ( $this->suppress
) {
2420 $bitfield = Revision
::SUPPRESSED_ALL
;
2422 $bitfield = 'oi_deleted';
2425 if ( $deleteCurrent ) {
2426 $tables = [ 'image' ];
2428 'fa_storage_group' => $encGroup,
2429 'fa_storage_key' => $dbw->conditional(
2430 [ 'img_sha1' => '' ],
2431 $dbw->addQuotes( '' ),
2432 $dbw->buildConcat( [ "img_sha1", $encExt ] )
2434 'fa_deleted_user' => $encUserId,
2435 'fa_deleted_timestamp' => $encTimestamp,
2436 'fa_deleted' => $this->suppress ?
$bitfield : 0,
2437 'fa_name' => 'img_name',
2438 'fa_archive_name' => 'NULL',
2439 'fa_size' => 'img_size',
2440 'fa_width' => 'img_width',
2441 'fa_height' => 'img_height',
2442 'fa_metadata' => 'img_metadata',
2443 'fa_bits' => 'img_bits',
2444 'fa_media_type' => 'img_media_type',
2445 'fa_major_mime' => 'img_major_mime',
2446 'fa_minor_mime' => 'img_minor_mime',
2447 'fa_user' => 'img_user',
2448 'fa_user_text' => 'img_user_text',
2449 'fa_timestamp' => 'img_timestamp',
2450 'fa_sha1' => 'img_sha1'
2454 $fields +
= array_map(
2455 [ $dbw, 'addQuotes' ],
2456 $commentStore->insert( $dbw, 'fa_deleted_reason', $this->reason
)
2459 if ( $wgCommentTableSchemaMigrationStage <= MIGRATION_WRITE_BOTH
) {
2460 $fields['fa_description'] = 'img_description';
2462 if ( $wgCommentTableSchemaMigrationStage >= MIGRATION_WRITE_BOTH
) {
2463 $tables[] = 'image_comment_temp';
2464 $fields['fa_description_id'] = 'imgcomment_description_id';
2465 $joins['image_comment_temp'] = [
2466 $wgCommentTableSchemaMigrationStage === MIGRATION_NEW ?
'JOIN' : 'LEFT JOIN',
2467 [ 'imgcomment_name = img_name' ]
2471 if ( $wgCommentTableSchemaMigrationStage !== MIGRATION_OLD
&&
2472 $wgCommentTableSchemaMigrationStage !== MIGRATION_NEW
2474 // Upgrade any rows that are still old-style. Otherwise an upgrade
2475 // might be missed if a deletion happens while the migration script
2477 $res = $dbw->select(
2478 [ 'image', 'image_comment_temp' ],
2479 [ 'img_name', 'img_description' ],
2480 [ 'img_name' => $this->file
->getName(), 'imgcomment_name' => null ],
2483 [ 'image_comment_temp' => [ 'LEFT JOIN', [ 'imgcomment_name = img_name' ] ] ]
2485 foreach ( $res as $row ) {
2486 list( , $callback ) = $commentStore->insertWithTempTable(
2487 $dbw, 'img_description', $row->img_description
2489 $callback( $row->img_name
);
2493 $dbw->insertSelect( 'filearchive', $tables, $fields,
2494 [ 'img_name' => $this->file
->getName() ], __METHOD__
, [], [], $joins );
2497 if ( count( $oldRels ) ) {
2498 $fileQuery = OldLocalFile
::getQueryInfo();
2499 $res = $dbw->select(
2500 $fileQuery['tables'],
2501 $fileQuery['fields'],
2503 'oi_name' => $this->file
->getName(),
2504 'oi_archive_name' => array_keys( $oldRels )
2511 if ( $res->numRows() ) {
2512 $reason = $commentStore->createComment( $dbw, $this->reason
);
2513 foreach ( $res as $row ) {
2514 $comment = $commentStore->getComment( 'oi_description', $row );
2516 // Deletion-specific fields
2517 'fa_storage_group' => 'deleted',
2518 'fa_storage_key' => ( $row->oi_sha1
=== '' )
2520 : "{$row->oi_sha1}{$dotExt}",
2521 'fa_deleted_user' => $this->user
->getId(),
2522 'fa_deleted_timestamp' => $dbw->timestamp( $now ),
2523 // Counterpart fields
2524 'fa_deleted' => $this->suppress ?
$bitfield : $row->oi_deleted
,
2525 'fa_name' => $row->oi_name
,
2526 'fa_archive_name' => $row->oi_archive_name
,
2527 'fa_size' => $row->oi_size
,
2528 'fa_width' => $row->oi_width
,
2529 'fa_height' => $row->oi_height
,
2530 'fa_metadata' => $row->oi_metadata
,
2531 'fa_bits' => $row->oi_bits
,
2532 'fa_media_type' => $row->oi_media_type
,
2533 'fa_major_mime' => $row->oi_major_mime
,
2534 'fa_minor_mime' => $row->oi_minor_mime
,
2535 'fa_user' => $row->oi_user
,
2536 'fa_user_text' => $row->oi_user_text
,
2537 'fa_timestamp' => $row->oi_timestamp
,
2538 'fa_sha1' => $row->oi_sha1
2539 ] +
$commentStore->insert( $dbw, 'fa_deleted_reason', $reason )
2540 +
$commentStore->insert( $dbw, 'fa_description', $comment );
2544 $dbw->insert( 'filearchive', $rowsInsert, __METHOD__
);
2548 function doDBDeletes() {
2549 global $wgCommentTableSchemaMigrationStage;
2551 $dbw = $this->file
->repo
->getMasterDB();
2552 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
2554 if ( count( $oldRels ) ) {
2555 $dbw->delete( 'oldimage',
2557 'oi_name' => $this->file
->getName(),
2558 'oi_archive_name' => array_keys( $oldRels )
2562 if ( $deleteCurrent ) {
2563 $dbw->delete( 'image', [ 'img_name' => $this->file
->getName() ], __METHOD__
);
2564 if ( $wgCommentTableSchemaMigrationStage > MIGRATION_OLD
) {
2566 'image_comment_temp', [ 'imgcomment_name' => $this->file
->getName() ], __METHOD__
2573 * Run the transaction
2576 public function execute() {
2577 $repo = $this->file
->getRepo();
2578 $this->file
->lock();
2580 // Prepare deletion batch
2581 $hashes = $this->getHashes();
2582 $this->deletionBatch
= [];
2583 $ext = $this->file
->getExtension();
2584 $dotExt = $ext === '' ?
'' : ".$ext";
2586 foreach ( $this->srcRels
as $name => $srcRel ) {
2587 // Skip files that have no hash (e.g. missing DB record, or sha1 field and file source)
2588 if ( isset( $hashes[$name] ) ) {
2589 $hash = $hashes[$name];
2590 $key = $hash . $dotExt;
2591 $dstRel = $repo->getDeletedHashPath( $key ) . $key;
2592 $this->deletionBatch
[$name] = [ $srcRel, $dstRel ];
2596 if ( !$repo->hasSha1Storage() ) {
2597 // Removes non-existent file from the batch, so we don't get errors.
2598 // This also handles files in the 'deleted' zone deleted via revision deletion.
2599 $checkStatus = $this->removeNonexistentFiles( $this->deletionBatch
);
2600 if ( !$checkStatus->isGood() ) {
2601 $this->status
->merge( $checkStatus );
2602 return $this->status
;
2604 $this->deletionBatch
= $checkStatus->value
;
2606 // Execute the file deletion batch
2607 $status = $this->file
->repo
->deleteBatch( $this->deletionBatch
);
2608 if ( !$status->isGood() ) {
2609 $this->status
->merge( $status );
2613 if ( !$this->status
->isOK() ) {
2614 // Critical file deletion error; abort
2615 $this->file
->unlock();
2617 return $this->status
;
2620 // Copy the image/oldimage rows to filearchive
2621 $this->doDBInserts();
2622 // Delete image/oldimage rows
2623 $this->doDBDeletes();
2625 // Commit and return
2626 $this->file
->unlock();
2628 return $this->status
;
2632 * Removes non-existent files from a deletion batch.
2633 * @param array $batch
2636 protected function removeNonexistentFiles( $batch ) {
2637 $files = $newBatch = [];
2639 foreach ( $batch as $batchItem ) {
2640 list( $src, ) = $batchItem;
2641 $files[$src] = $this->file
->repo
->getVirtualUrl( 'public' ) . '/' . rawurlencode( $src );
2644 $result = $this->file
->repo
->fileExistsBatch( $files );
2645 if ( in_array( null, $result, true ) ) {
2646 return Status
::newFatal( 'backend-fail-internal',
2647 $this->file
->repo
->getBackend()->getName() );
2650 foreach ( $batch as $batchItem ) {
2651 if ( $result[$batchItem[0]] ) {
2652 $newBatch[] = $batchItem;
2656 return Status
::newGood( $newBatch );
2660 # ------------------------------------------------------------------------------
2663 * Helper class for file undeletion
2664 * @ingroup FileAbstraction
2666 class LocalFileRestoreBatch
{
2667 /** @var LocalFile */
2670 /** @var array List of file IDs to restore */
2671 private $cleanupBatch;
2673 /** @var array List of file IDs to restore */
2676 /** @var bool Add all revisions of the file */
2679 /** @var bool Whether to remove all settings for suppressed fields */
2680 private $unsuppress = false;
2684 * @param bool $unsuppress
2686 function __construct( File
$file, $unsuppress = false ) {
2687 $this->file
= $file;
2688 $this->cleanupBatch
= $this->ids
= [];
2690 $this->unsuppress
= $unsuppress;
2697 public function addId( $fa_id ) {
2698 $this->ids
[] = $fa_id;
2702 * Add a whole lot of files by ID
2705 public function addIds( $ids ) {
2706 $this->ids
= array_merge( $this->ids
, $ids );
2710 * Add all revisions of the file
2712 public function addAll() {
2717 * Run the transaction, except the cleanup batch.
2718 * The cleanup batch should be run in a separate transaction, because it locks different
2719 * rows and there's no need to keep the image row locked while it's acquiring those locks
2720 * The caller may have its own transaction open.
2721 * So we save the batch and let the caller call cleanup()
2724 public function execute() {
2725 /** @var Language */
2728 $repo = $this->file
->getRepo();
2729 if ( !$this->all
&& !$this->ids
) {
2731 return $repo->newGood();
2734 $lockOwnsTrx = $this->file
->lock();
2736 $dbw = $this->file
->repo
->getMasterDB();
2738 $commentStore = CommentStore
::getStore();
2740 $status = $this->file
->repo
->newGood();
2742 $exists = (bool)$dbw->selectField( 'image', '1',
2743 [ 'img_name' => $this->file
->getName() ],
2745 // The lock() should already prevents changes, but this still may need
2746 // to bypass any transaction snapshot. However, if lock() started the
2747 // trx (which it probably did) then snapshot is post-lock and up-to-date.
2748 $lockOwnsTrx ?
[] : [ 'LOCK IN SHARE MODE' ]
2751 // Fetch all or selected archived revisions for the file,
2752 // sorted from the most recent to the oldest.
2753 $conditions = [ 'fa_name' => $this->file
->getName() ];
2755 if ( !$this->all
) {
2756 $conditions['fa_id'] = $this->ids
;
2759 $arFileQuery = ArchivedFile
::getQueryInfo();
2760 $result = $dbw->select(
2761 $arFileQuery['tables'],
2762 $arFileQuery['fields'],
2765 [ 'ORDER BY' => 'fa_timestamp DESC' ],
2766 $arFileQuery['joins']
2772 $insertCurrent = false;
2777 foreach ( $result as $row ) {
2778 $idsPresent[] = $row->fa_id
;
2780 if ( $row->fa_name
!= $this->file
->getName() ) {
2781 $status->error( 'undelete-filename-mismatch', $wgLang->timeanddate( $row->fa_timestamp
) );
2782 $status->failCount++
;
2786 if ( $row->fa_storage_key
== '' ) {
2787 // Revision was missing pre-deletion
2788 $status->error( 'undelete-bad-store-key', $wgLang->timeanddate( $row->fa_timestamp
) );
2789 $status->failCount++
;
2793 $deletedRel = $repo->getDeletedHashPath( $row->fa_storage_key
) .
2794 $row->fa_storage_key
;
2795 $deletedUrl = $repo->getVirtualUrl() . '/deleted/' . $deletedRel;
2797 if ( isset( $row->fa_sha1
) ) {
2798 $sha1 = $row->fa_sha1
;
2800 // old row, populate from key
2801 $sha1 = LocalRepo
::getHashFromKey( $row->fa_storage_key
);
2805 if ( strlen( $sha1 ) == 32 && $sha1[0] == '0' ) {
2806 $sha1 = substr( $sha1, 1 );
2809 if ( is_null( $row->fa_major_mime
) ||
$row->fa_major_mime
== 'unknown'
2810 ||
is_null( $row->fa_minor_mime
) ||
$row->fa_minor_mime
== 'unknown'
2811 ||
is_null( $row->fa_media_type
) ||
$row->fa_media_type
== 'UNKNOWN'
2812 ||
is_null( $row->fa_metadata
)
2814 // Refresh our metadata
2815 // Required for a new current revision; nice for older ones too. :)
2816 $props = RepoGroup
::singleton()->getFileProps( $deletedUrl );
2819 'minor_mime' => $row->fa_minor_mime
,
2820 'major_mime' => $row->fa_major_mime
,
2821 'media_type' => $row->fa_media_type
,
2822 'metadata' => $row->fa_metadata
2826 $comment = $commentStore->getComment( 'fa_description', $row );
2827 if ( $first && !$exists ) {
2828 // This revision will be published as the new current version
2829 $destRel = $this->file
->getRel();
2830 list( $commentFields, $commentCallback ) =
2831 $commentStore->insertWithTempTable( $dbw, 'img_description', $comment );
2833 'img_name' => $row->fa_name
,
2834 'img_size' => $row->fa_size
,
2835 'img_width' => $row->fa_width
,
2836 'img_height' => $row->fa_height
,
2837 'img_metadata' => $props['metadata'],
2838 'img_bits' => $row->fa_bits
,
2839 'img_media_type' => $props['media_type'],
2840 'img_major_mime' => $props['major_mime'],
2841 'img_minor_mime' => $props['minor_mime'],
2842 'img_user' => $row->fa_user
,
2843 'img_user_text' => $row->fa_user_text
,
2844 'img_timestamp' => $row->fa_timestamp
,
2848 // The live (current) version cannot be hidden!
2849 if ( !$this->unsuppress
&& $row->fa_deleted
) {
2850 $status->fatal( 'undeleterevdel' );
2851 $this->file
->unlock();
2855 $archiveName = $row->fa_archive_name
;
2857 if ( $archiveName == '' ) {
2858 // This was originally a current version; we
2859 // have to devise a new archive name for it.
2860 // Format is <timestamp of archiving>!<name>
2861 $timestamp = wfTimestamp( TS_UNIX
, $row->fa_deleted_timestamp
);
2864 $archiveName = wfTimestamp( TS_MW
, $timestamp ) . '!' . $row->fa_name
;
2866 } while ( isset( $archiveNames[$archiveName] ) );
2869 $archiveNames[$archiveName] = true;
2870 $destRel = $this->file
->getArchiveRel( $archiveName );
2872 'oi_name' => $row->fa_name
,
2873 'oi_archive_name' => $archiveName,
2874 'oi_size' => $row->fa_size
,
2875 'oi_width' => $row->fa_width
,
2876 'oi_height' => $row->fa_height
,
2877 'oi_bits' => $row->fa_bits
,
2878 'oi_user' => $row->fa_user
,
2879 'oi_user_text' => $row->fa_user_text
,
2880 'oi_timestamp' => $row->fa_timestamp
,
2881 'oi_metadata' => $props['metadata'],
2882 'oi_media_type' => $props['media_type'],
2883 'oi_major_mime' => $props['major_mime'],
2884 'oi_minor_mime' => $props['minor_mime'],
2885 'oi_deleted' => $this->unsuppress ?
0 : $row->fa_deleted
,
2887 ] +
$commentStore->insert( $dbw, 'oi_description', $comment );
2890 $deleteIds[] = $row->fa_id
;
2892 if ( !$this->unsuppress
&& $row->fa_deleted
& File
::DELETED_FILE
) {
2893 // private files can stay where they are
2894 $status->successCount++
;
2896 $storeBatch[] = [ $deletedUrl, 'public', $destRel ];
2897 $this->cleanupBatch
[] = $row->fa_storage_key
;
2905 // Add a warning to the status object for missing IDs
2906 $missingIds = array_diff( $this->ids
, $idsPresent );
2908 foreach ( $missingIds as $id ) {
2909 $status->error( 'undelete-missing-filearchive', $id );
2912 if ( !$repo->hasSha1Storage() ) {
2913 // Remove missing files from batch, so we don't get errors when undeleting them
2914 $checkStatus = $this->removeNonexistentFiles( $storeBatch );
2915 if ( !$checkStatus->isGood() ) {
2916 $status->merge( $checkStatus );
2919 $storeBatch = $checkStatus->value
;
2921 // Run the store batch
2922 // Use the OVERWRITE_SAME flag to smooth over a common error
2923 $storeStatus = $this->file
->repo
->storeBatch( $storeBatch, FileRepo
::OVERWRITE_SAME
);
2924 $status->merge( $storeStatus );
2926 if ( !$status->isGood() ) {
2927 // Even if some files could be copied, fail entirely as that is the
2928 // easiest thing to do without data loss
2929 $this->cleanupFailedBatch( $storeStatus, $storeBatch );
2930 $status->setOK( false );
2931 $this->file
->unlock();
2937 // Run the DB updates
2938 // Because we have locked the image row, key conflicts should be rare.
2939 // If they do occur, we can roll back the transaction at this time with
2940 // no data loss, but leaving unregistered files scattered throughout the
2942 // This is not ideal, which is why it's important to lock the image row.
2943 if ( $insertCurrent ) {
2944 $dbw->insert( 'image', $insertCurrent, __METHOD__
);
2945 $commentCallback( $insertCurrent['img_name'] );
2948 if ( $insertBatch ) {
2949 $dbw->insert( 'oldimage', $insertBatch, __METHOD__
);
2953 $dbw->delete( 'filearchive',
2954 [ 'fa_id' => $deleteIds ],
2958 // If store batch is empty (all files are missing), deletion is to be considered successful
2959 if ( $status->successCount
> 0 ||
!$storeBatch ||
$repo->hasSha1Storage() ) {
2961 wfDebug( __METHOD__
. " restored {$status->successCount} items, creating a new current\n" );
2963 DeferredUpdates
::addUpdate( SiteStatsUpdate
::factory( [ 'images' => 1 ] ) );
2965 $this->file
->purgeEverything();
2967 wfDebug( __METHOD__
. " restored {$status->successCount} as archived versions\n" );
2968 $this->file
->purgeDescription();
2972 $this->file
->unlock();
2978 * Removes non-existent files from a store batch.
2979 * @param array $triplets
2982 protected function removeNonexistentFiles( $triplets ) {
2983 $files = $filteredTriplets = [];
2984 foreach ( $triplets as $file ) {
2985 $files[$file[0]] = $file[0];
2988 $result = $this->file
->repo
->fileExistsBatch( $files );
2989 if ( in_array( null, $result, true ) ) {
2990 return Status
::newFatal( 'backend-fail-internal',
2991 $this->file
->repo
->getBackend()->getName() );
2994 foreach ( $triplets as $file ) {
2995 if ( $result[$file[0]] ) {
2996 $filteredTriplets[] = $file;
3000 return Status
::newGood( $filteredTriplets );
3004 * Removes non-existent files from a cleanup batch.
3005 * @param array $batch
3008 protected function removeNonexistentFromCleanup( $batch ) {
3009 $files = $newBatch = [];
3010 $repo = $this->file
->repo
;
3012 foreach ( $batch as $file ) {
3013 $files[$file] = $repo->getVirtualUrl( 'deleted' ) . '/' .
3014 rawurlencode( $repo->getDeletedHashPath( $file ) . $file );
3017 $result = $repo->fileExistsBatch( $files );
3019 foreach ( $batch as $file ) {
3020 if ( $result[$file] ) {
3021 $newBatch[] = $file;
3029 * Delete unused files in the deleted zone.
3030 * This should be called from outside the transaction in which execute() was called.
3033 public function cleanup() {
3034 if ( !$this->cleanupBatch
) {
3035 return $this->file
->repo
->newGood();
3038 $this->cleanupBatch
= $this->removeNonexistentFromCleanup( $this->cleanupBatch
);
3040 $status = $this->file
->repo
->cleanupDeletedBatch( $this->cleanupBatch
);
3046 * Cleanup a failed batch. The batch was only partially successful, so
3047 * rollback by removing all items that were succesfully copied.
3049 * @param Status $storeStatus
3050 * @param array $storeBatch
3052 protected function cleanupFailedBatch( $storeStatus, $storeBatch ) {
3055 foreach ( $storeStatus->success
as $i => $success ) {
3056 // Check if this item of the batch was successfully copied
3058 // Item was successfully copied and needs to be removed again
3059 // Extract ($dstZone, $dstRel) from the batch
3060 $cleanupBatch[] = [ $storeBatch[$i][1], $storeBatch[$i][2] ];
3063 $this->file
->repo
->cleanupBatch( $cleanupBatch );
3067 # ------------------------------------------------------------------------------
3070 * Helper class for file movement
3071 * @ingroup FileAbstraction
3073 class LocalFileMoveBatch
{
3074 /** @var LocalFile */
3084 protected $oldCount;
3088 /** @var IDatabase */
3093 * @param Title $target
3095 function __construct( File
$file, Title
$target ) {
3096 $this->file
= $file;
3097 $this->target
= $target;
3098 $this->oldHash
= $this->file
->repo
->getHashPath( $this->file
->getName() );
3099 $this->newHash
= $this->file
->repo
->getHashPath( $this->target
->getDBkey() );
3100 $this->oldName
= $this->file
->getName();
3101 $this->newName
= $this->file
->repo
->getNameFromTitle( $this->target
);
3102 $this->oldRel
= $this->oldHash
. $this->oldName
;
3103 $this->newRel
= $this->newHash
. $this->newName
;
3104 $this->db
= $file->getRepo()->getMasterDB();
3108 * Add the current image to the batch
3110 public function addCurrent() {
3111 $this->cur
= [ $this->oldRel
, $this->newRel
];
3115 * Add the old versions of the image to the batch
3116 * @return array List of archive names from old versions
3118 public function addOlds() {
3119 $archiveBase = 'archive';
3121 $this->oldCount
= 0;
3124 $result = $this->db
->select( 'oldimage',
3125 [ 'oi_archive_name', 'oi_deleted' ],
3126 [ 'oi_name' => $this->oldName
],
3128 [ 'LOCK IN SHARE MODE' ] // ignore snapshot
3131 foreach ( $result as $row ) {
3132 $archiveNames[] = $row->oi_archive_name
;
3133 $oldName = $row->oi_archive_name
;
3134 $bits = explode( '!', $oldName, 2 );
3136 if ( count( $bits ) != 2 ) {
3137 wfDebug( "Old file name missing !: '$oldName' \n" );
3141 list( $timestamp, $filename ) = $bits;
3143 if ( $this->oldName
!= $filename ) {
3144 wfDebug( "Old file name doesn't match: '$oldName' \n" );
3150 // Do we want to add those to oldCount?
3151 if ( $row->oi_deleted
& File
::DELETED_FILE
) {
3156 "{$archiveBase}/{$this->oldHash}{$oldName}",
3157 "{$archiveBase}/{$this->newHash}{$timestamp}!{$this->newName}"
3161 return $archiveNames;
3168 public function execute() {
3169 $repo = $this->file
->repo
;
3170 $status = $repo->newGood();
3171 $destFile = wfLocalFile( $this->target
);
3173 $this->file
->lock(); // begin
3174 $destFile->lock(); // quickly fail if destination is not available
3176 $triplets = $this->getMoveTriplets();
3177 $checkStatus = $this->removeNonexistentFiles( $triplets );
3178 if ( !$checkStatus->isGood() ) {
3179 $destFile->unlock();
3180 $this->file
->unlock();
3181 $status->merge( $checkStatus ); // couldn't talk to file backend
3184 $triplets = $checkStatus->value
;
3186 // Verify the file versions metadata in the DB.
3187 $statusDb = $this->verifyDBUpdates();
3188 if ( !$statusDb->isGood() ) {
3189 $destFile->unlock();
3190 $this->file
->unlock();
3191 $statusDb->setOK( false );
3196 if ( !$repo->hasSha1Storage() ) {
3197 // Copy the files into their new location.
3198 // If a prior process fataled copying or cleaning up files we tolerate any
3199 // of the existing files if they are identical to the ones being stored.
3200 $statusMove = $repo->storeBatch( $triplets, FileRepo
::OVERWRITE_SAME
);
3201 wfDebugLog( 'imagemove', "Moved files for {$this->file->getName()}: " .
3202 "{$statusMove->successCount} successes, {$statusMove->failCount} failures" );
3203 if ( !$statusMove->isGood() ) {
3204 // Delete any files copied over (while the destination is still locked)
3205 $this->cleanupTarget( $triplets );
3206 $destFile->unlock();
3207 $this->file
->unlock();
3208 wfDebugLog( 'imagemove', "Error in moving files: "
3209 . $statusMove->getWikiText( false, false, 'en' ) );
3210 $statusMove->setOK( false );
3214 $status->merge( $statusMove );
3217 // Rename the file versions metadata in the DB.
3218 $this->doDBUpdates();
3220 wfDebugLog( 'imagemove', "Renamed {$this->file->getName()} in database: " .
3221 "{$statusDb->successCount} successes, {$statusDb->failCount} failures" );
3223 $destFile->unlock();
3224 $this->file
->unlock(); // done
3226 // Everything went ok, remove the source files
3227 $this->cleanupSource( $triplets );
3229 $status->merge( $statusDb );
3235 * Verify the database updates and return a new Status indicating how
3236 * many rows would be updated.
3240 protected function verifyDBUpdates() {
3241 $repo = $this->file
->repo
;
3242 $status = $repo->newGood();
3245 $hasCurrent = $dbw->selectField(
3248 [ 'img_name' => $this->oldName
],
3252 $oldRowCount = $dbw->selectField(
3255 [ 'oi_name' => $this->oldName
],
3260 if ( $hasCurrent ) {
3261 $status->successCount++
;
3263 $status->failCount++
;
3265 $status->successCount +
= $oldRowCount;
3266 // T36934: oldCount is based on files that actually exist.
3267 // There may be more DB rows than such files, in which case $affected
3268 // can be greater than $total. We use max() to avoid negatives here.
3269 $status->failCount +
= max( 0, $this->oldCount
- $oldRowCount );
3270 if ( $status->failCount
) {
3271 $status->error( 'imageinvalidfilename' );
3278 * Do the database updates and return a new Status indicating how
3279 * many rows where updated.
3281 protected function doDBUpdates() {
3284 // Update current image
3287 [ 'img_name' => $this->newName
],
3288 [ 'img_name' => $this->oldName
],
3291 // Update old images
3295 'oi_name' => $this->newName
,
3296 'oi_archive_name = ' . $dbw->strreplace( 'oi_archive_name',
3297 $dbw->addQuotes( $this->oldName
), $dbw->addQuotes( $this->newName
) ),
3299 [ 'oi_name' => $this->oldName
],
3305 * Generate triplets for FileRepo::storeBatch().
3308 protected function getMoveTriplets() {
3309 $moves = array_merge( [ $this->cur
], $this->olds
);
3310 $triplets = []; // The format is: (srcUrl, destZone, destUrl)
3312 foreach ( $moves as $move ) {
3313 // $move: (oldRelativePath, newRelativePath)
3314 $srcUrl = $this->file
->repo
->getVirtualUrl() . '/public/' . rawurlencode( $move[0] );
3315 $triplets[] = [ $srcUrl, 'public', $move[1] ];
3318 "Generated move triplet for {$this->file->getName()}: {$srcUrl} :: public :: {$move[1]}"
3326 * Removes non-existent files from move batch.
3327 * @param array $triplets
3330 protected function removeNonexistentFiles( $triplets ) {
3333 foreach ( $triplets as $file ) {
3334 $files[$file[0]] = $file[0];
3337 $result = $this->file
->repo
->fileExistsBatch( $files );
3338 if ( in_array( null, $result, true ) ) {
3339 return Status
::newFatal( 'backend-fail-internal',
3340 $this->file
->repo
->getBackend()->getName() );
3343 $filteredTriplets = [];
3344 foreach ( $triplets as $file ) {
3345 if ( $result[$file[0]] ) {
3346 $filteredTriplets[] = $file;
3348 wfDebugLog( 'imagemove', "File {$file[0]} does not exist" );
3352 return Status
::newGood( $filteredTriplets );
3356 * Cleanup a partially moved array of triplets by deleting the target
3357 * files. Called if something went wrong half way.
3358 * @param array $triplets
3360 protected function cleanupTarget( $triplets ) {
3361 // Create dest pairs from the triplets
3363 foreach ( $triplets as $triplet ) {
3364 // $triplet: (old source virtual URL, dst zone, dest rel)
3365 $pairs[] = [ $triplet[1], $triplet[2] ];
3368 $this->file
->repo
->cleanupBatch( $pairs );
3372 * Cleanup a fully moved array of triplets by deleting the source files.
3373 * Called at the end of the move process if everything else went ok.
3374 * @param array $triplets
3376 protected function cleanupSource( $triplets ) {
3377 // Create source file names from the triplets
3379 foreach ( $triplets as $triplet ) {
3380 $files[] = $triplet[0];
3383 $this->file
->repo
->cleanupBatch( $files );
3387 class LocalFileLockError
extends ErrorPageError
{
3388 public function __construct( Status
$status ) {
3389 parent
::__construct(
3391 $status->getMessage()
3395 public function report() {
3397 $wgOut->setStatusCode( 429 );