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
= 10; // 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';
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 $row = $dbr->selectRow( 'image', self
::selectFields(), $conds, __METHOD__
);
188 return self
::newFromRow( $row, $repo );
195 * Fields in the image table
196 * @todo Deprecate this in favor of a method that returns tables and joins
197 * as well, and use CommentStore::getJoin().
200 static function selectFields() {
215 ] + CommentStore
::newKey( 'img_description' )->getFields();
219 * Do not call this except from inside a repo class.
220 * @param Title $title
221 * @param FileRepo $repo
223 function __construct( $title, $repo ) {
224 parent
::__construct( $title, $repo );
226 $this->metadata
= '';
227 $this->historyLine
= 0;
228 $this->historyRes
= null;
229 $this->dataLoaded
= false;
230 $this->extraDataLoaded
= false;
232 $this->assertRepoDefined();
233 $this->assertTitleDefined();
237 * Get the memcached key for the main data for this file, or false if
238 * there is no access to the shared cache.
239 * @return string|bool
241 function getCacheKey() {
242 return $this->repo
->getSharedCacheKey( 'file', sha1( $this->getName() ) );
246 * @param WANObjectCache $cache
250 public function getMutableCacheKeys( WANObjectCache
$cache ) {
251 return [ $this->getCacheKey() ];
255 * Try to load file metadata from memcached, falling back to the database
257 private function loadFromCache() {
258 $this->dataLoaded
= false;
259 $this->extraDataLoaded
= false;
261 $key = $this->getCacheKey();
263 $this->loadFromDB( self
::READ_NORMAL
);
268 $cache = ObjectCache
::getMainWANInstance();
269 $cachedValues = $cache->getWithSetCallback(
272 function ( $oldValue, &$ttl, array &$setOpts ) use ( $cache ) {
273 $setOpts +
= Database
::getCacheSetOptions( $this->repo
->getReplicaDB() );
275 $this->loadFromDB( self
::READ_NORMAL
);
277 $fields = $this->getCacheFields( '' );
278 $cacheVal['fileExists'] = $this->fileExists
;
279 if ( $this->fileExists
) {
280 foreach ( $fields as $field ) {
281 $cacheVal[$field] = $this->$field;
284 // Strip off excessive entries from the subset of fields that can become large.
285 // If the cache value gets to large it will not fit in memcached and nothing will
286 // get cached at all, causing master queries for any file access.
287 foreach ( $this->getLazyCacheFields( '' ) as $field ) {
288 if ( isset( $cacheVal[$field] )
289 && strlen( $cacheVal[$field] ) > 100 * 1024
291 unset( $cacheVal[$field] ); // don't let the value get too big
295 if ( $this->fileExists
) {
296 $ttl = $cache->adaptiveTTL( wfTimestamp( TS_UNIX
, $this->timestamp
), $ttl );
298 $ttl = $cache::TTL_DAY
;
303 [ 'version' => self
::VERSION
]
306 $this->fileExists
= $cachedValues['fileExists'];
307 if ( $this->fileExists
) {
308 $this->setProps( $cachedValues );
311 $this->dataLoaded
= true;
312 $this->extraDataLoaded
= true;
313 foreach ( $this->getLazyCacheFields( '' ) as $field ) {
314 $this->extraDataLoaded
= $this->extraDataLoaded
&& isset( $cachedValues[$field] );
319 * Purge the file object/metadata cache
321 public function invalidateCache() {
322 $key = $this->getCacheKey();
327 $this->repo
->getMasterDB()->onTransactionPreCommitOrIdle(
328 function () use ( $key ) {
329 ObjectCache
::getMainWANInstance()->delete( $key );
336 * Load metadata from the file itself
338 function loadFromFile() {
339 $props = $this->repo
->getFileProps( $this->getVirtualUrl() );
340 $this->setProps( $props );
344 * @param string $prefix
347 function getCacheFields( $prefix = 'img_' ) {
348 static $fields = [ 'size', 'width', 'height', 'bits', 'media_type',
349 'major_mime', 'minor_mime', 'metadata', 'timestamp', 'sha1', 'user',
350 'user_text', 'description' ];
351 static $results = [];
353 if ( $prefix == '' ) {
357 if ( !isset( $results[$prefix] ) ) {
358 $prefixedFields = [];
359 foreach ( $fields as $field ) {
360 $prefixedFields[] = $prefix . $field;
362 $results[$prefix] = $prefixedFields;
365 return $results[$prefix];
369 * @param string $prefix
372 function getLazyCacheFields( $prefix = 'img_' ) {
373 static $fields = [ 'metadata' ];
374 static $results = [];
376 if ( $prefix == '' ) {
380 if ( !isset( $results[$prefix] ) ) {
381 $prefixedFields = [];
382 foreach ( $fields as $field ) {
383 $prefixedFields[] = $prefix . $field;
385 $results[$prefix] = $prefixedFields;
388 return $results[$prefix];
392 * Load file metadata from the DB
395 function loadFromDB( $flags = 0 ) {
396 $fname = static::class . '::' . __FUNCTION__
;
398 # Unconditionally set loaded=true, we don't want the accessors constantly rechecking
399 $this->dataLoaded
= true;
400 $this->extraDataLoaded
= true;
402 $dbr = ( $flags & self
::READ_LATEST
)
403 ?
$this->repo
->getMasterDB()
404 : $this->repo
->getReplicaDB();
406 $row = $dbr->selectRow( 'image', $this->getCacheFields( 'img_' ),
407 [ 'img_name' => $this->getName() ], $fname );
410 $this->loadFromRow( $row );
412 $this->fileExists
= false;
417 * Load lazy file metadata from the DB.
418 * This covers fields that are sometimes not cached.
420 protected function loadExtraFromDB() {
421 $fname = static::class . '::' . __FUNCTION__
;
423 # Unconditionally set loaded=true, we don't want the accessors constantly rechecking
424 $this->extraDataLoaded
= true;
426 $fieldMap = $this->loadFieldsWithTimestamp( $this->repo
->getReplicaDB(), $fname );
428 $fieldMap = $this->loadFieldsWithTimestamp( $this->repo
->getMasterDB(), $fname );
432 foreach ( $fieldMap as $name => $value ) {
433 $this->$name = $value;
436 throw new MWException( "Could not find data for image '{$this->getName()}'." );
441 * @param IDatabase $dbr
442 * @param string $fname
445 private function loadFieldsWithTimestamp( $dbr, $fname ) {
448 $row = $dbr->selectRow( 'image', $this->getLazyCacheFields( 'img_' ), [
449 'img_name' => $this->getName(),
450 'img_timestamp' => $dbr->timestamp( $this->getTimestamp() )
453 $fieldMap = $this->unprefixRow( $row, 'img_' );
455 # File may have been uploaded over in the meantime; check the old versions
456 $row = $dbr->selectRow( 'oldimage', $this->getLazyCacheFields( 'oi_' ), [
457 'oi_name' => $this->getName(),
458 'oi_timestamp' => $dbr->timestamp( $this->getTimestamp() )
461 $fieldMap = $this->unprefixRow( $row, 'oi_' );
469 * @param array|object $row
470 * @param string $prefix
471 * @throws MWException
474 protected function unprefixRow( $row, $prefix = 'img_' ) {
475 $array = (array)$row;
476 $prefixLength = strlen( $prefix );
478 // Sanity check prefix once
479 if ( substr( key( $array ), 0, $prefixLength ) !== $prefix ) {
480 throw new MWException( __METHOD__
. ': incorrect $prefix parameter' );
484 foreach ( $array as $name => $value ) {
485 $decoded[substr( $name, $prefixLength )] = $value;
492 * Decode a row from the database (either object or array) to an array
493 * with timestamps and MIME types decoded, and the field prefix removed.
495 * @param string $prefix
496 * @throws MWException
499 function decodeRow( $row, $prefix = 'img_' ) {
500 $decoded = $this->unprefixRow( $row, $prefix );
502 $decoded['timestamp'] = wfTimestamp( TS_MW
, $decoded['timestamp'] );
504 $decoded['metadata'] = $this->repo
->getReplicaDB()->decodeBlob( $decoded['metadata'] );
506 if ( empty( $decoded['major_mime'] ) ) {
507 $decoded['mime'] = 'unknown/unknown';
509 if ( !$decoded['minor_mime'] ) {
510 $decoded['minor_mime'] = 'unknown';
512 $decoded['mime'] = $decoded['major_mime'] . '/' . $decoded['minor_mime'];
515 // Trim zero padding from char/binary field
516 $decoded['sha1'] = rtrim( $decoded['sha1'], "\0" );
518 // Normalize some fields to integer type, per their database definition.
519 // Use unary + so that overflows will be upgraded to double instead of
520 // being trucated as with intval(). This is important to allow >2GB
521 // files on 32-bit systems.
522 foreach ( [ 'size', 'width', 'height', 'bits' ] as $field ) {
523 $decoded[$field] = +
$decoded[$field];
530 * Load file metadata from a DB result row
533 * @param string $prefix
535 function loadFromRow( $row, $prefix = 'img_' ) {
536 $this->dataLoaded
= true;
537 $this->extraDataLoaded
= true;
539 $array = $this->decodeRow( $row, $prefix );
541 foreach ( $array as $name => $value ) {
542 $this->$name = $value;
545 $this->fileExists
= true;
546 $this->maybeUpgradeRow();
550 * Load file metadata from cache or DB, unless already loaded
553 function load( $flags = 0 ) {
554 if ( !$this->dataLoaded
) {
555 if ( $flags & self
::READ_LATEST
) {
556 $this->loadFromDB( $flags );
558 $this->loadFromCache();
562 if ( ( $flags & self
::LOAD_ALL
) && !$this->extraDataLoaded
) {
563 // @note: loads on name/timestamp to reduce race condition problems
564 $this->loadExtraFromDB();
569 * Upgrade a row if it needs it
571 function maybeUpgradeRow() {
572 global $wgUpdateCompatibleMetadata;
574 if ( wfReadOnly() ||
$this->upgrading
) {
579 if ( is_null( $this->media_type
) ||
$this->mime
== 'image/svg' ) {
582 $handler = $this->getHandler();
584 $validity = $handler->isMetadataValid( $this, $this->getMetadata() );
585 if ( $validity === MediaHandler
::METADATA_BAD
) {
587 } elseif ( $validity === MediaHandler
::METADATA_COMPATIBLE
) {
588 $upgrade = $wgUpdateCompatibleMetadata;
594 $this->upgrading
= true;
595 // Defer updates unless in auto-commit CLI mode
596 DeferredUpdates
::addCallableUpdate( function () {
597 $this->upgrading
= false; // avoid duplicate updates
600 } catch ( LocalFileLockError
$e ) {
601 // let the other process handle it (or do it next time)
608 * @return bool Whether upgradeRow() ran for this object
610 function getUpgraded() {
611 return $this->upgraded
;
615 * Fix assorted version-related problems with the image row by reloading it from the file
617 function upgradeRow() {
618 $this->lock(); // begin
620 $this->loadFromFile();
622 # Don't destroy file info of missing files
623 if ( !$this->fileExists
) {
625 wfDebug( __METHOD__
. ": file does not exist, aborting\n" );
630 $dbw = $this->repo
->getMasterDB();
631 list( $major, $minor ) = self
::splitMime( $this->mime
);
633 if ( wfReadOnly() ) {
638 wfDebug( __METHOD__
. ': upgrading ' . $this->getName() . " to the current schema\n" );
640 $dbw->update( 'image',
642 'img_size' => $this->size
, // sanity
643 'img_width' => $this->width
,
644 'img_height' => $this->height
,
645 'img_bits' => $this->bits
,
646 'img_media_type' => $this->media_type
,
647 'img_major_mime' => $major,
648 'img_minor_mime' => $minor,
649 'img_metadata' => $dbw->encodeBlob( $this->metadata
),
650 'img_sha1' => $this->sha1
,
652 [ 'img_name' => $this->getName() ],
656 $this->invalidateCache();
658 $this->unlock(); // done
659 $this->upgraded
= true; // avoid rework/retries
663 * Set properties in this object to be equal to those given in the
664 * associative array $info. Only cacheable fields can be set.
665 * All fields *must* be set in $info except for getLazyCacheFields().
667 * If 'mime' is given, it will be split into major_mime/minor_mime.
668 * If major_mime/minor_mime are given, $this->mime will also be set.
672 function setProps( $info ) {
673 $this->dataLoaded
= true;
674 $fields = $this->getCacheFields( '' );
675 $fields[] = 'fileExists';
677 foreach ( $fields as $field ) {
678 if ( isset( $info[$field] ) ) {
679 $this->$field = $info[$field];
683 // Fix up mime fields
684 if ( isset( $info['major_mime'] ) ) {
685 $this->mime
= "{$info['major_mime']}/{$info['minor_mime']}";
686 } elseif ( isset( $info['mime'] ) ) {
687 $this->mime
= $info['mime'];
688 list( $this->major_mime
, $this->minor_mime
) = self
::splitMime( $this->mime
);
692 /** splitMime inherited */
693 /** getName inherited */
694 /** getTitle inherited */
695 /** getURL inherited */
696 /** getViewURL inherited */
697 /** getPath inherited */
698 /** isVisible inherited */
703 function isMissing() {
704 if ( $this->missing
=== null ) {
705 list( $fileExists ) = $this->repo
->fileExists( $this->getVirtualUrl() );
706 $this->missing
= !$fileExists;
709 return $this->missing
;
713 * Return the width of the image
718 public function getWidth( $page = 1 ) {
726 if ( $this->isMultipage() ) {
727 $handler = $this->getHandler();
731 $dim = $handler->getPageDimensions( $this, $page );
733 return $dim['width'];
735 // For non-paged media, the false goes through an
736 // intval, turning failure into 0, so do same here.
745 * Return the height of the image
750 public function getHeight( $page = 1 ) {
758 if ( $this->isMultipage() ) {
759 $handler = $this->getHandler();
763 $dim = $handler->getPageDimensions( $this, $page );
765 return $dim['height'];
767 // For non-paged media, the false goes through an
768 // intval, turning failure into 0, so do same here.
772 return $this->height
;
777 * Returns ID or name of user who uploaded the file
779 * @param string $type 'text' or 'id'
782 function getUser( $type = 'text' ) {
785 if ( $type == 'text' ) {
786 return $this->user_text
;
788 return (int)$this->user
;
793 * Get short description URL for a file based on the page ID.
795 * @return string|null
796 * @throws MWException
799 public function getDescriptionShortUrl() {
800 $pageId = $this->title
->getArticleID();
802 if ( $pageId !== null ) {
803 $url = $this->repo
->makeUrl( [ 'curid' => $pageId ] );
804 if ( $url !== false ) {
812 * Get handler-specific metadata
815 function getMetadata() {
816 $this->load( self
::LOAD_ALL
); // large metadata is loaded in another step
817 return $this->metadata
;
823 function getBitDepth() {
826 return (int)$this->bits
;
830 * Returns the size of the image file, in bytes
833 public function getSize() {
840 * Returns the MIME type of the file.
843 function getMimeType() {
850 * Returns the type of the media in the file.
851 * Use the value returned by this function with the MEDIATYPE_xxx constants.
854 function getMediaType() {
857 return $this->media_type
;
860 /** canRender inherited */
861 /** mustRender inherited */
862 /** allowInlineDisplay inherited */
863 /** isSafeFile inherited */
864 /** isTrustedFile inherited */
867 * Returns true if the file exists on disk.
868 * @return bool Whether file exist on disk.
870 public function exists() {
873 return $this->fileExists
;
876 /** getTransformScript inherited */
877 /** getUnscaledThumb inherited */
878 /** thumbName inherited */
879 /** createThumb inherited */
880 /** transform inherited */
882 /** getHandler inherited */
883 /** iconThumb inherited */
884 /** getLastError inherited */
887 * Get all thumbnail names previously generated for this file
888 * @param string|bool $archiveName Name of an archive file, default false
889 * @return array First element is the base dir, then files in that base dir.
891 function getThumbnails( $archiveName = false ) {
892 if ( $archiveName ) {
893 $dir = $this->getArchiveThumbPath( $archiveName );
895 $dir = $this->getThumbPath();
898 $backend = $this->repo
->getBackend();
901 $iterator = $backend->getFileList( [ 'dir' => $dir ] );
902 foreach ( $iterator as $file ) {
905 } catch ( FileBackendError
$e ) {
906 } // suppress (T56674)
912 * Refresh metadata in memcached, but don't touch thumbnails or CDN
914 function purgeMetadataCache() {
915 $this->invalidateCache();
919 * Delete all previously generated thumbnails, refresh metadata in memcached and purge the CDN.
921 * @param array $options An array potentially with the key forThumbRefresh.
923 * @note This used to purge old thumbnails by default as well, but doesn't anymore.
925 function purgeCache( $options = [] ) {
926 // Refresh metadata cache
927 $this->purgeMetadataCache();
930 $this->purgeThumbnails( $options );
932 // Purge CDN cache for this file
933 DeferredUpdates
::addUpdate(
934 new CdnCacheUpdate( [ $this->getUrl() ] ),
935 DeferredUpdates
::PRESEND
940 * Delete cached transformed files for an archived version only.
941 * @param string $archiveName Name of the archived file
943 function purgeOldThumbnails( $archiveName ) {
944 // Get a list of old thumbnails and URLs
945 $files = $this->getThumbnails( $archiveName );
947 // Purge any custom thumbnail caches
948 Hooks
::run( 'LocalFilePurgeThumbnails', [ $this, $archiveName ] );
951 $dir = array_shift( $files );
952 $this->purgeThumbList( $dir, $files );
956 foreach ( $files as $file ) {
957 $urls[] = $this->getArchiveThumbUrl( $archiveName, $file );
959 DeferredUpdates
::addUpdate( new CdnCacheUpdate( $urls ), DeferredUpdates
::PRESEND
);
963 * Delete cached transformed files for the current version only.
964 * @param array $options
966 public function purgeThumbnails( $options = [] ) {
967 $files = $this->getThumbnails();
968 // Always purge all files from CDN regardless of handler filters
970 foreach ( $files as $file ) {
971 $urls[] = $this->getThumbUrl( $file );
973 array_shift( $urls ); // don't purge directory
975 // Give media handler a chance to filter the file purge list
976 if ( !empty( $options['forThumbRefresh'] ) ) {
977 $handler = $this->getHandler();
979 $handler->filterThumbnailPurgeList( $files, $options );
983 // Purge any custom thumbnail caches
984 Hooks
::run( 'LocalFilePurgeThumbnails', [ $this, false ] );
987 $dir = array_shift( $files );
988 $this->purgeThumbList( $dir, $files );
991 DeferredUpdates
::addUpdate( new CdnCacheUpdate( $urls ), DeferredUpdates
::PRESEND
);
995 * Prerenders a configurable set of thumbnails
999 public function prerenderThumbnails() {
1000 global $wgUploadThumbnailRenderMap;
1004 $sizes = $wgUploadThumbnailRenderMap;
1007 foreach ( $sizes as $size ) {
1008 if ( $this->isVectorized() ||
$this->getWidth() > $size ) {
1009 $jobs[] = new ThumbnailRenderJob(
1011 [ 'transformParams' => [ 'width' => $size ] ]
1017 JobQueueGroup
::singleton()->lazyPush( $jobs );
1022 * Delete a list of thumbnails visible at urls
1023 * @param string $dir Base dir of the files.
1024 * @param array $files Array of strings: relative filenames (to $dir)
1026 protected function purgeThumbList( $dir, $files ) {
1027 $fileListDebug = strtr(
1028 var_export( $files, true ),
1031 wfDebug( __METHOD__
. ": $fileListDebug\n" );
1034 foreach ( $files as $file ) {
1035 if ( $this->repo
->supportsSha1URLs() ) {
1036 $reference = $this->getSha1();
1038 $reference = $this->getName();
1041 # Check that the reference (filename or sha1) is part of the thumb name
1042 # This is a basic sanity check to avoid erasing unrelated directories
1043 if ( strpos( $file, $reference ) !== false
1044 ||
strpos( $file, "-thumbnail" ) !== false // "short" thumb name
1046 $purgeList[] = "{$dir}/{$file}";
1050 # Delete the thumbnails
1051 $this->repo
->quickPurgeBatch( $purgeList );
1052 # Clear out the thumbnail directory if empty
1053 $this->repo
->quickCleanDir( $dir );
1056 /** purgeDescription inherited */
1057 /** purgeEverything inherited */
1060 * @param int $limit Optional: Limit to number of results
1061 * @param int $start Optional: Timestamp, start from
1062 * @param int $end Optional: Timestamp, end at
1064 * @return OldLocalFile[]
1066 function getHistory( $limit = null, $start = null, $end = null, $inc = true ) {
1067 $dbr = $this->repo
->getReplicaDB();
1068 $tables = [ 'oldimage' ];
1069 $fields = OldLocalFile
::selectFields();
1070 $conds = $opts = $join_conds = [];
1071 $eq = $inc ?
'=' : '';
1072 $conds[] = "oi_name = " . $dbr->addQuotes( $this->title
->getDBkey() );
1075 $conds[] = "oi_timestamp <$eq " . $dbr->addQuotes( $dbr->timestamp( $start ) );
1079 $conds[] = "oi_timestamp >$eq " . $dbr->addQuotes( $dbr->timestamp( $end ) );
1083 $opts['LIMIT'] = $limit;
1086 // Search backwards for time > x queries
1087 $order = ( !$start && $end !== null ) ?
'ASC' : 'DESC';
1088 $opts['ORDER BY'] = "oi_timestamp $order";
1089 $opts['USE INDEX'] = [ 'oldimage' => 'oi_name_timestamp' ];
1091 // Avoid PHP 7.1 warning from passing $this by reference
1093 Hooks
::run( 'LocalFile::getHistory', [ &$localFile, &$tables, &$fields,
1094 &$conds, &$opts, &$join_conds ] );
1096 $res = $dbr->select( $tables, $fields, $conds, __METHOD__
, $opts, $join_conds );
1099 foreach ( $res as $row ) {
1100 $r[] = $this->repo
->newFileFromRow( $row );
1103 if ( $order == 'ASC' ) {
1104 $r = array_reverse( $r ); // make sure it ends up descending
1111 * Returns the history of this file, line by line.
1112 * starts with current version, then old versions.
1113 * uses $this->historyLine to check which line to return:
1114 * 0 return line for current version
1115 * 1 query for old versions, return first one
1116 * 2, ... return next old version from above query
1119 public function nextHistoryLine() {
1120 # Polymorphic function name to distinguish foreign and local fetches
1121 $fname = static::class . '::' . __FUNCTION__
;
1123 $dbr = $this->repo
->getReplicaDB();
1125 if ( $this->historyLine
== 0 ) { // called for the first time, return line from cur
1126 $this->historyRes
= $dbr->select( 'image',
1129 "'' AS oi_archive_name",
1133 [ 'img_name' => $this->title
->getDBkey() ],
1137 if ( 0 == $dbr->numRows( $this->historyRes
) ) {
1138 $this->historyRes
= null;
1142 } elseif ( $this->historyLine
== 1 ) {
1143 $this->historyRes
= $dbr->select( 'oldimage', '*',
1144 [ 'oi_name' => $this->title
->getDBkey() ],
1146 [ 'ORDER BY' => 'oi_timestamp DESC' ]
1149 $this->historyLine++
;
1151 return $dbr->fetchObject( $this->historyRes
);
1155 * Reset the history pointer to the first element of the history
1157 public function resetHistory() {
1158 $this->historyLine
= 0;
1160 if ( !is_null( $this->historyRes
) ) {
1161 $this->historyRes
= null;
1165 /** getHashPath inherited */
1166 /** getRel inherited */
1167 /** getUrlRel inherited */
1168 /** getArchiveRel inherited */
1169 /** getArchivePath inherited */
1170 /** getThumbPath inherited */
1171 /** getArchiveUrl inherited */
1172 /** getThumbUrl inherited */
1173 /** getArchiveVirtualUrl inherited */
1174 /** getThumbVirtualUrl inherited */
1175 /** isHashed inherited */
1178 * Upload a file and record it in the DB
1179 * @param string|FSFile $src Source storage path, virtual URL, or filesystem path
1180 * @param string $comment Upload description
1181 * @param string $pageText Text to use for the new description page,
1182 * if a new description page is created
1183 * @param int|bool $flags Flags for publish()
1184 * @param array|bool $props File properties, if known. This can be used to
1185 * reduce the upload time when uploading virtual URLs for which the file
1186 * info is already known
1187 * @param string|bool $timestamp Timestamp for img_timestamp, or false to use the
1189 * @param User|null $user User object or null to use $wgUser
1190 * @param string[] $tags Change tags to add to the log entry and page revision.
1191 * (This doesn't check $user's permissions.)
1192 * @return Status On success, the value member contains the
1193 * archive name, or an empty string if it was a new file.
1195 function upload( $src, $comment, $pageText, $flags = 0, $props = false,
1196 $timestamp = false, $user = null, $tags = []
1200 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
1201 return $this->readOnlyFatalStatus();
1204 $srcPath = ( $src instanceof FSFile
) ?
$src->getPath() : $src;
1206 if ( $this->repo
->isVirtualUrl( $srcPath )
1207 || FileBackend
::isStoragePath( $srcPath )
1209 $props = $this->repo
->getFileProps( $srcPath );
1211 $mwProps = new MWFileProps( MimeMagic
::singleton() );
1212 $props = $mwProps->getPropsFromPath( $srcPath, true );
1217 $handler = MediaHandler
::getHandler( $props['mime'] );
1219 $metadata = MediaWiki\
quietCall( 'unserialize', $props['metadata'] );
1221 if ( !is_array( $metadata ) ) {
1225 $options['headers'] = $handler->getContentHeaders( $metadata );
1227 $options['headers'] = [];
1230 // Trim spaces on user supplied text
1231 $comment = trim( $comment );
1233 // Truncate nicely or the DB will do it for us
1234 // non-nicely (dangling multi-byte chars, non-truncated version in cache).
1235 $comment = $wgContLang->truncate( $comment, 255 );
1236 $this->lock(); // begin
1237 $status = $this->publish( $src, $flags, $options );
1239 if ( $status->successCount
>= 2 ) {
1240 // There will be a copy+(one of move,copy,store).
1241 // The first succeeding does not commit us to updating the DB
1242 // since it simply copied the current version to a timestamped file name.
1243 // It is only *preferable* to avoid leaving such files orphaned.
1244 // Once the second operation goes through, then the current version was
1245 // updated and we must therefore update the DB too.
1246 $oldver = $status->value
;
1247 if ( !$this->recordUpload2( $oldver, $comment, $pageText, $props, $timestamp, $user, $tags ) ) {
1248 $status->fatal( 'filenotfound', $srcPath );
1252 $this->unlock(); // done
1258 * Record a file upload in the upload log and the image table
1259 * @param string $oldver
1260 * @param string $desc
1261 * @param string $license
1262 * @param string $copyStatus
1263 * @param string $source
1264 * @param bool $watch
1265 * @param string|bool $timestamp
1266 * @param User|null $user User object or null to use $wgUser
1269 function recordUpload( $oldver, $desc, $license = '', $copyStatus = '', $source = '',
1270 $watch = false, $timestamp = false, User
$user = null ) {
1276 $pageText = SpecialUpload
::getInitialPageText( $desc, $license, $copyStatus, $source );
1278 if ( !$this->recordUpload2( $oldver, $desc, $pageText, false, $timestamp, $user ) ) {
1283 $user->addWatch( $this->getTitle() );
1290 * Record a file upload in the upload log and the image table
1291 * @param string $oldver
1292 * @param string $comment
1293 * @param string $pageText
1294 * @param bool|array $props
1295 * @param string|bool $timestamp
1296 * @param null|User $user
1297 * @param string[] $tags
1300 function recordUpload2(
1301 $oldver, $comment, $pageText, $props = false, $timestamp = false, $user = null, $tags = []
1303 global $wgCommentTableSchemaMigrationStage;
1305 if ( is_null( $user ) ) {
1310 $dbw = $this->repo
->getMasterDB();
1312 # Imports or such might force a certain timestamp; otherwise we generate
1313 # it and can fudge it slightly to keep (name,timestamp) unique on re-upload.
1314 if ( $timestamp === false ) {
1315 $timestamp = $dbw->timestamp();
1316 $allowTimeKludge = true;
1318 $allowTimeKludge = false;
1321 $props = $props ?
: $this->repo
->getFileProps( $this->getVirtualUrl() );
1322 $props['description'] = $comment;
1323 $props['user'] = $user->getId();
1324 $props['user_text'] = $user->getName();
1325 $props['timestamp'] = wfTimestamp( TS_MW
, $timestamp ); // DB -> TS_MW
1326 $this->setProps( $props );
1328 # Fail now if the file isn't there
1329 if ( !$this->fileExists
) {
1330 wfDebug( __METHOD__
. ": File " . $this->getRel() . " went missing!\n" );
1335 $dbw->startAtomic( __METHOD__
);
1337 # Test to see if the row exists using INSERT IGNORE
1338 # This avoids race conditions by locking the row until the commit, and also
1339 # doesn't deadlock. SELECT FOR UPDATE causes a deadlock for every race condition.
1340 $commentStore = new CommentStore( 'img_description' );
1341 list( $commentFields, $commentCallback ) =
1342 $commentStore->insertWithTempTable( $dbw, $comment );
1343 $dbw->insert( 'image',
1345 'img_name' => $this->getName(),
1346 'img_size' => $this->size
,
1347 'img_width' => intval( $this->width
),
1348 'img_height' => intval( $this->height
),
1349 'img_bits' => $this->bits
,
1350 'img_media_type' => $this->media_type
,
1351 'img_major_mime' => $this->major_mime
,
1352 'img_minor_mime' => $this->minor_mime
,
1353 'img_timestamp' => $timestamp,
1354 'img_user' => $user->getId(),
1355 'img_user_text' => $user->getName(),
1356 'img_metadata' => $dbw->encodeBlob( $this->metadata
),
1357 'img_sha1' => $this->sha1
1362 $reupload = ( $dbw->affectedRows() == 0 );
1365 if ( $allowTimeKludge ) {
1366 # Use LOCK IN SHARE MODE to ignore any transaction snapshotting
1367 $ltimestamp = $dbw->selectField(
1370 [ 'img_name' => $this->getName() ],
1372 [ 'LOCK IN SHARE MODE' ]
1374 $lUnixtime = $ltimestamp ?
wfTimestamp( TS_UNIX
, $ltimestamp ) : false;
1375 # Avoid a timestamp that is not newer than the last version
1376 # TODO: the image/oldimage tables should be like page/revision with an ID field
1377 if ( $lUnixtime && wfTimestamp( TS_UNIX
, $timestamp ) <= $lUnixtime ) {
1378 sleep( 1 ); // fast enough re-uploads would go far in the future otherwise
1379 $timestamp = $dbw->timestamp( $lUnixtime +
1 );
1380 $this->timestamp
= wfTimestamp( TS_MW
, $timestamp ); // DB -> TS_MW
1384 $tables = [ 'image' ];
1386 'oi_name' => 'img_name',
1387 'oi_archive_name' => $dbw->addQuotes( $oldver ),
1388 'oi_size' => 'img_size',
1389 'oi_width' => 'img_width',
1390 'oi_height' => 'img_height',
1391 'oi_bits' => 'img_bits',
1392 'oi_timestamp' => 'img_timestamp',
1393 'oi_user' => 'img_user',
1394 'oi_user_text' => 'img_user_text',
1395 'oi_metadata' => 'img_metadata',
1396 'oi_media_type' => 'img_media_type',
1397 'oi_major_mime' => 'img_major_mime',
1398 'oi_minor_mime' => 'img_minor_mime',
1399 'oi_sha1' => 'img_sha1',
1403 if ( $wgCommentTableSchemaMigrationStage <= MIGRATION_WRITE_BOTH
) {
1404 $fields['oi_description'] = 'img_description';
1406 if ( $wgCommentTableSchemaMigrationStage >= MIGRATION_WRITE_BOTH
) {
1407 $tables[] = 'image_comment_temp';
1408 $fields['oi_description_id'] = 'imgcomment_description_id';
1409 $joins['image_comment_temp'] = [
1410 $wgCommentTableSchemaMigrationStage === MIGRATION_NEW ?
'JOIN' : 'LEFT JOIN',
1411 [ 'imgcomment_name = img_name' ]
1415 if ( $wgCommentTableSchemaMigrationStage !== MIGRATION_OLD
&&
1416 $wgCommentTableSchemaMigrationStage !== MIGRATION_NEW
1418 // Upgrade any rows that are still old-style. Otherwise an upgrade
1419 // might be missed if a deletion happens while the migration script
1421 $res = $dbw->select(
1422 [ 'image', 'image_comment_temp' ],
1423 [ 'img_name', 'img_description' ],
1424 [ 'img_name' => $this->getName(), 'imgcomment_name' => null ],
1427 [ 'image_comment_temp' => [ 'LEFT JOIN', [ 'imgcomment_name = img_name' ] ] ]
1429 foreach ( $res as $row ) {
1430 list( , $callback ) = $commentStore->insertWithTempTable( $dbw, $row->img_description
);
1431 $callback( $row->img_name
);
1435 # (T36993) Note: $oldver can be empty here, if the previous
1436 # version of the file was broken. Allow registration of the new
1437 # version to continue anyway, because that's better than having
1438 # an image that's not fixable by user operations.
1439 # Collision, this is an update of a file
1440 # Insert previous contents into oldimage
1441 $dbw->insertSelect( 'oldimage', $tables, $fields,
1442 [ 'img_name' => $this->getName() ], __METHOD__
, [], [], $joins );
1444 # Update the current image row
1445 $dbw->update( 'image',
1447 'img_size' => $this->size
,
1448 'img_width' => intval( $this->width
),
1449 'img_height' => intval( $this->height
),
1450 'img_bits' => $this->bits
,
1451 'img_media_type' => $this->media_type
,
1452 'img_major_mime' => $this->major_mime
,
1453 'img_minor_mime' => $this->minor_mime
,
1454 'img_timestamp' => $timestamp,
1455 'img_user' => $user->getId(),
1456 'img_user_text' => $user->getName(),
1457 'img_metadata' => $dbw->encodeBlob( $this->metadata
),
1458 'img_sha1' => $this->sha1
1460 [ 'img_name' => $this->getName() ],
1463 if ( $wgCommentTableSchemaMigrationStage > MIGRATION_OLD
) {
1464 // So $commentCallback can insert the new row
1465 $dbw->delete( 'image_comment_temp', [ 'imgcomment_name' => $this->getName() ], __METHOD__
);
1468 $commentCallback( $this->getName() );
1470 $descTitle = $this->getTitle();
1471 $descId = $descTitle->getArticleID();
1472 $wikiPage = new WikiFilePage( $descTitle );
1473 $wikiPage->setFile( $this );
1475 // Add the log entry...
1476 $logEntry = new ManualLogEntry( 'upload', $reupload ?
'overwrite' : 'upload' );
1477 $logEntry->setTimestamp( $this->timestamp
);
1478 $logEntry->setPerformer( $user );
1479 $logEntry->setComment( $comment );
1480 $logEntry->setTarget( $descTitle );
1481 // Allow people using the api to associate log entries with the upload.
1482 // Log has a timestamp, but sometimes different from upload timestamp.
1483 $logEntry->setParameters(
1485 'img_sha1' => $this->sha1
,
1486 'img_timestamp' => $timestamp,
1489 // Note we keep $logId around since during new image
1490 // creation, page doesn't exist yet, so log_page = 0
1491 // but we want it to point to the page we're making,
1492 // so we later modify the log entry.
1493 // For a similar reason, we avoid making an RC entry
1494 // now and wait until the page exists.
1495 $logId = $logEntry->insert();
1497 if ( $descTitle->exists() ) {
1498 // Use own context to get the action text in content language
1499 $formatter = LogFormatter
::newFromEntry( $logEntry );
1500 $formatter->setContext( RequestContext
::newExtraneousContext( $descTitle ) );
1501 $editSummary = $formatter->getPlainActionText();
1503 $nullRevision = Revision
::newNullRevision(
1510 if ( $nullRevision ) {
1511 $nullRevision->insertOn( $dbw );
1513 'NewRevisionFromEditComplete',
1514 [ $wikiPage, $nullRevision, $nullRevision->getParentId(), $user ]
1516 $wikiPage->updateRevisionOn( $dbw, $nullRevision );
1517 // Associate null revision id
1518 $logEntry->setAssociatedRevId( $nullRevision->getId() );
1521 $newPageContent = null;
1523 // Make the description page and RC log entry post-commit
1524 $newPageContent = ContentHandler
::makeContent( $pageText, $descTitle );
1527 # Defer purges, page creation, and link updates in case they error out.
1528 # The most important thing is that files and the DB registry stay synced.
1529 $dbw->endAtomic( __METHOD__
);
1531 # Do some cache purges after final commit so that:
1532 # a) Changes are more likely to be seen post-purge
1533 # b) They won't cause rollback of the log publish/update above
1534 DeferredUpdates
::addUpdate(
1535 new AutoCommitUpdate(
1539 $reupload, $wikiPage, $newPageContent, $comment, $user,
1540 $logEntry, $logId, $descId, $tags
1542 # Update memcache after the commit
1543 $this->invalidateCache();
1545 $updateLogPage = false;
1546 if ( $newPageContent ) {
1547 # New file page; create the description page.
1548 # There's already a log entry, so don't make a second RC entry
1549 # CDN and file cache for the description page are purged by doEditContent.
1550 $status = $wikiPage->doEditContent(
1553 EDIT_NEW | EDIT_SUPPRESS_RC
,
1558 if ( isset( $status->value
['revision'] ) ) {
1559 /** @var $rev Revision */
1560 $rev = $status->value
['revision'];
1561 // Associate new page revision id
1562 $logEntry->setAssociatedRevId( $rev->getId() );
1564 // This relies on the resetArticleID() call in WikiPage::insertOn(),
1565 // which is triggered on $descTitle by doEditContent() above.
1566 if ( isset( $status->value
['revision'] ) ) {
1567 /** @var $rev Revision */
1568 $rev = $status->value
['revision'];
1569 $updateLogPage = $rev->getPage();
1572 # Existing file page: invalidate description page cache
1573 $wikiPage->getTitle()->invalidateCache();
1574 $wikiPage->getTitle()->purgeSquid();
1575 # Allow the new file version to be patrolled from the page footer
1576 Article
::purgePatrolFooterCache( $descId );
1579 # Update associated rev id. This should be done by $logEntry->insert() earlier,
1580 # but setAssociatedRevId() wasn't called at that point yet...
1581 $logParams = $logEntry->getParameters();
1582 $logParams['associated_rev_id'] = $logEntry->getAssociatedRevId();
1583 $update = [ 'log_params' => LogEntryBase
::makeParamBlob( $logParams ) ];
1584 if ( $updateLogPage ) {
1585 # Also log page, in case where we just created it above
1586 $update['log_page'] = $updateLogPage;
1588 $this->getRepo()->getMasterDB()->update(
1591 [ 'log_id' => $logId ],
1594 $this->getRepo()->getMasterDB()->insert(
1597 'ls_field' => 'associated_rev_id',
1598 'ls_value' => $logEntry->getAssociatedRevId(),
1599 'ls_log_id' => $logId,
1604 # Add change tags, if any
1606 $logEntry->setTags( $tags );
1609 # Uploads can be patrolled
1610 $logEntry->setIsPatrollable( true );
1612 # Now that the log entry is up-to-date, make an RC entry.
1613 $logEntry->publish( $logId );
1615 # Run hook for other updates (typically more cache purging)
1616 Hooks
::run( 'FileUpload', [ $this, $reupload, !$newPageContent ] );
1619 # Delete old thumbnails
1620 $this->purgeThumbnails();
1621 # Remove the old file from the CDN cache
1622 DeferredUpdates
::addUpdate(
1623 new CdnCacheUpdate( [ $this->getUrl() ] ),
1624 DeferredUpdates
::PRESEND
1627 # Update backlink pages pointing to this title if created
1628 LinksUpdate
::queueRecursiveJobsForTable( $this->getTitle(), 'imagelinks' );
1631 $this->prerenderThumbnails();
1634 DeferredUpdates
::PRESEND
1638 # This is a new file, so update the image count
1639 DeferredUpdates
::addUpdate( SiteStatsUpdate
::factory( [ 'images' => 1 ] ) );
1642 # Invalidate cache for all pages using this file
1643 DeferredUpdates
::addUpdate( new HTMLCacheUpdate( $this->getTitle(), 'imagelinks' ) );
1649 * Move or copy a file to its public location. If a file exists at the
1650 * destination, move it to an archive. Returns a Status object with
1651 * the archive name in the "value" member on success.
1653 * The archive name should be passed through to recordUpload for database
1656 * @param string|FSFile $src Local filesystem path or virtual URL to the source image
1657 * @param int $flags A bitwise combination of:
1658 * File::DELETE_SOURCE Delete the source file, i.e. move rather than copy
1659 * @param array $options Optional additional parameters
1660 * @return Status On success, the value member contains the
1661 * archive name, or an empty string if it was a new file.
1663 function publish( $src, $flags = 0, array $options = [] ) {
1664 return $this->publishTo( $src, $this->getRel(), $flags, $options );
1668 * Move or copy a file to a specified location. Returns a Status
1669 * object with the archive name in the "value" member on success.
1671 * The archive name should be passed through to recordUpload for database
1674 * @param string|FSFile $src Local filesystem path or virtual URL to the source image
1675 * @param string $dstRel Target relative path
1676 * @param int $flags A bitwise combination of:
1677 * File::DELETE_SOURCE Delete the source file, i.e. move rather than copy
1678 * @param array $options Optional additional parameters
1679 * @return Status On success, the value member contains the
1680 * archive name, or an empty string if it was a new file.
1682 function publishTo( $src, $dstRel, $flags = 0, array $options = [] ) {
1683 $srcPath = ( $src instanceof FSFile
) ?
$src->getPath() : $src;
1685 $repo = $this->getRepo();
1686 if ( $repo->getReadOnlyReason() !== false ) {
1687 return $this->readOnlyFatalStatus();
1690 $this->lock(); // begin
1692 $archiveName = wfTimestamp( TS_MW
) . '!' . $this->getName();
1693 $archiveRel = 'archive/' . $this->getHashPath() . $archiveName;
1695 if ( $repo->hasSha1Storage() ) {
1696 $sha1 = $repo->isVirtualUrl( $srcPath )
1697 ?
$repo->getFileSha1( $srcPath )
1698 : FSFile
::getSha1Base36FromPath( $srcPath );
1699 /** @var FileBackendDBRepoWrapper $wrapperBackend */
1700 $wrapperBackend = $repo->getBackend();
1701 $dst = $wrapperBackend->getPathForSHA1( $sha1 );
1702 $status = $repo->quickImport( $src, $dst );
1703 if ( $flags & File
::DELETE_SOURCE
) {
1707 if ( $this->exists() ) {
1708 $status->value
= $archiveName;
1711 $flags = $flags & File
::DELETE_SOURCE ? LocalRepo
::DELETE_SOURCE
: 0;
1712 $status = $repo->publish( $srcPath, $dstRel, $archiveRel, $flags, $options );
1714 if ( $status->value
== 'new' ) {
1715 $status->value
= '';
1717 $status->value
= $archiveName;
1721 $this->unlock(); // done
1726 /** getLinksTo inherited */
1727 /** getExifData inherited */
1728 /** isLocal inherited */
1729 /** wasDeleted inherited */
1732 * Move file to the new title
1734 * Move current, old version and all thumbnails
1735 * to the new filename. Old file is deleted.
1737 * Cache purging is done; checks for validity
1738 * and logging are caller's responsibility
1740 * @param Title $target New file name
1743 function move( $target ) {
1744 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
1745 return $this->readOnlyFatalStatus();
1748 wfDebugLog( 'imagemove', "Got request to move {$this->name} to " . $target->getText() );
1749 $batch = new LocalFileMoveBatch( $this, $target );
1751 $this->lock(); // begin
1752 $batch->addCurrent();
1753 $archiveNames = $batch->addOlds();
1754 $status = $batch->execute();
1755 $this->unlock(); // done
1757 wfDebugLog( 'imagemove', "Finished moving {$this->name}" );
1759 // Purge the source and target files...
1760 $oldTitleFile = wfLocalFile( $this->title
);
1761 $newTitleFile = wfLocalFile( $target );
1762 // To avoid slow purges in the transaction, move them outside...
1763 DeferredUpdates
::addUpdate(
1764 new AutoCommitUpdate(
1765 $this->getRepo()->getMasterDB(),
1767 function () use ( $oldTitleFile, $newTitleFile, $archiveNames ) {
1768 $oldTitleFile->purgeEverything();
1769 foreach ( $archiveNames as $archiveName ) {
1770 $oldTitleFile->purgeOldThumbnails( $archiveName );
1772 $newTitleFile->purgeEverything();
1775 DeferredUpdates
::PRESEND
1778 if ( $status->isOK() ) {
1779 // Now switch the object
1780 $this->title
= $target;
1781 // Force regeneration of the name and hashpath
1782 unset( $this->name
);
1783 unset( $this->hashPath
);
1790 * Delete all versions of the file.
1792 * Moves the files into an archive directory (or deletes them)
1793 * and removes the database rows.
1795 * Cache purging is done; logging is caller's responsibility.
1797 * @param string $reason
1798 * @param bool $suppress
1799 * @param User|null $user
1802 function delete( $reason, $suppress = false, $user = null ) {
1803 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
1804 return $this->readOnlyFatalStatus();
1807 $batch = new LocalFileDeleteBatch( $this, $reason, $suppress, $user );
1809 $this->lock(); // begin
1810 $batch->addCurrent();
1811 // Get old version relative paths
1812 $archiveNames = $batch->addOlds();
1813 $status = $batch->execute();
1814 $this->unlock(); // done
1816 if ( $status->isOK() ) {
1817 DeferredUpdates
::addUpdate( SiteStatsUpdate
::factory( [ 'images' => -1 ] ) );
1820 // To avoid slow purges in the transaction, move them outside...
1821 DeferredUpdates
::addUpdate(
1822 new AutoCommitUpdate(
1823 $this->getRepo()->getMasterDB(),
1825 function () use ( $archiveNames ) {
1826 $this->purgeEverything();
1827 foreach ( $archiveNames as $archiveName ) {
1828 $this->purgeOldThumbnails( $archiveName );
1832 DeferredUpdates
::PRESEND
1837 foreach ( $archiveNames as $archiveName ) {
1838 $purgeUrls[] = $this->getArchiveUrl( $archiveName );
1840 DeferredUpdates
::addUpdate( new CdnCacheUpdate( $purgeUrls ), DeferredUpdates
::PRESEND
);
1846 * Delete an old version of the file.
1848 * Moves the file into an archive directory (or deletes it)
1849 * and removes the database row.
1851 * Cache purging is done; logging is caller's responsibility.
1853 * @param string $archiveName
1854 * @param string $reason
1855 * @param bool $suppress
1856 * @param User|null $user
1857 * @throws MWException Exception on database or file store failure
1860 function deleteOld( $archiveName, $reason, $suppress = false, $user = null ) {
1861 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
1862 return $this->readOnlyFatalStatus();
1865 $batch = new LocalFileDeleteBatch( $this, $reason, $suppress, $user );
1867 $this->lock(); // begin
1868 $batch->addOld( $archiveName );
1869 $status = $batch->execute();
1870 $this->unlock(); // done
1872 $this->purgeOldThumbnails( $archiveName );
1873 if ( $status->isOK() ) {
1874 $this->purgeDescription();
1877 DeferredUpdates
::addUpdate(
1878 new CdnCacheUpdate( [ $this->getArchiveUrl( $archiveName ) ] ),
1879 DeferredUpdates
::PRESEND
1886 * Restore all or specified deleted revisions to the given file.
1887 * Permissions and logging are left to the caller.
1889 * May throw database exceptions on error.
1891 * @param array $versions Set of record ids of deleted items to restore,
1892 * or empty to restore all revisions.
1893 * @param bool $unsuppress
1896 function restore( $versions = [], $unsuppress = false ) {
1897 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
1898 return $this->readOnlyFatalStatus();
1901 $batch = new LocalFileRestoreBatch( $this, $unsuppress );
1903 $this->lock(); // begin
1907 $batch->addIds( $versions );
1909 $status = $batch->execute();
1910 if ( $status->isGood() ) {
1911 $cleanupStatus = $batch->cleanup();
1912 $cleanupStatus->successCount
= 0;
1913 $cleanupStatus->failCount
= 0;
1914 $status->merge( $cleanupStatus );
1916 $this->unlock(); // done
1921 /** isMultipage inherited */
1922 /** pageCount inherited */
1923 /** scaleHeight inherited */
1924 /** getImageSize inherited */
1927 * Get the URL of the file description page.
1930 function getDescriptionUrl() {
1931 return $this->title
->getLocalURL();
1935 * Get the HTML text of the description page
1936 * This is not used by ImagePage for local files, since (among other things)
1937 * it skips the parser cache.
1939 * @param Language $lang What language to get description in (Optional)
1940 * @return bool|mixed
1942 function getDescriptionText( $lang = null ) {
1943 $revision = Revision
::newFromTitle( $this->title
, false, Revision
::READ_NORMAL
);
1947 $content = $revision->getContent();
1951 $pout = $content->getParserOutput( $this->title
, null, new ParserOptions( null, $lang ) );
1953 return $pout->getText();
1957 * @param int $audience
1961 function getDescription( $audience = self
::FOR_PUBLIC
, User
$user = null ) {
1963 if ( $audience == self
::FOR_PUBLIC
&& $this->isDeleted( self
::DELETED_COMMENT
) ) {
1965 } elseif ( $audience == self
::FOR_THIS_USER
1966 && !$this->userCan( self
::DELETED_COMMENT
, $user )
1970 return $this->description
;
1975 * @return bool|string
1977 function getTimestamp() {
1980 return $this->timestamp
;
1984 * @return bool|string
1986 public function getDescriptionTouched() {
1987 // The DB lookup might return false, e.g. if the file was just deleted, or the shared DB repo
1988 // itself gets it from elsewhere. To avoid repeating the DB lookups in such a case, we
1989 // need to differentiate between null (uninitialized) and false (failed to load).
1990 if ( $this->descriptionTouched
=== null ) {
1992 'page_namespace' => $this->title
->getNamespace(),
1993 'page_title' => $this->title
->getDBkey()
1995 $touched = $this->repo
->getReplicaDB()->selectField( 'page', 'page_touched', $cond, __METHOD__
);
1996 $this->descriptionTouched
= $touched ?
wfTimestamp( TS_MW
, $touched ) : false;
1999 return $this->descriptionTouched
;
2005 function getSha1() {
2007 // Initialise now if necessary
2008 if ( $this->sha1
== '' && $this->fileExists
) {
2009 $this->lock(); // begin
2011 $this->sha1
= $this->repo
->getFileSha1( $this->getPath() );
2012 if ( !wfReadOnly() && strval( $this->sha1
) != '' ) {
2013 $dbw = $this->repo
->getMasterDB();
2014 $dbw->update( 'image',
2015 [ 'img_sha1' => $this->sha1
],
2016 [ 'img_name' => $this->getName() ],
2018 $this->invalidateCache();
2021 $this->unlock(); // done
2028 * @return bool Whether to cache in RepoGroup (this avoids OOMs)
2030 function isCacheable() {
2033 // If extra data (metadata) was not loaded then it must have been large
2034 return $this->extraDataLoaded
2035 && strlen( serialize( $this->metadata
) ) <= self
::CACHE_FIELD_MAX_LEN
;
2042 public function acquireFileLock() {
2043 return $this->getRepo()->getBackend()->lockFiles(
2044 [ $this->getPath() ], LockManager
::LOCK_EX
, 10
2052 public function releaseFileLock() {
2053 return $this->getRepo()->getBackend()->unlockFiles(
2054 [ $this->getPath() ], LockManager
::LOCK_EX
2059 * Start an atomic DB section and lock the image for update
2060 * or increments a reference counter if the lock is already held
2062 * This method should not be used outside of LocalFile/LocalFile*Batch
2064 * @throws LocalFileLockError Throws an error if the lock was not acquired
2065 * @return bool Whether the file lock owns/spawned the DB transaction
2067 public function lock() {
2068 if ( !$this->locked
) {
2069 $logger = LoggerFactory
::getInstance( 'LocalFile' );
2071 $dbw = $this->repo
->getMasterDB();
2072 $makesTransaction = !$dbw->trxLevel();
2073 $dbw->startAtomic( self
::ATOMIC_SECTION_LOCK
);
2074 // T56736: use simple lock to handle when the file does not exist.
2075 // SELECT FOR UPDATE prevents changes, not other SELECTs with FOR UPDATE.
2076 // Also, that would cause contention on INSERT of similarly named rows.
2077 $status = $this->acquireFileLock(); // represents all versions of the file
2078 if ( !$status->isGood() ) {
2079 $dbw->endAtomic( self
::ATOMIC_SECTION_LOCK
);
2080 $logger->warning( "Failed to lock '{file}'", [ 'file' => $this->name
] );
2082 throw new LocalFileLockError( $status );
2084 // Release the lock *after* commit to avoid row-level contention.
2085 // Make sure it triggers on rollback() as well as commit() (T132921).
2086 $dbw->onTransactionResolution(
2087 function () use ( $logger ) {
2088 $status = $this->releaseFileLock();
2089 if ( !$status->isGood() ) {
2090 $logger->error( "Failed to unlock '{file}'", [ 'file' => $this->name
] );
2095 // Callers might care if the SELECT snapshot is safely fresh
2096 $this->lockedOwnTrx
= $makesTransaction;
2101 return $this->lockedOwnTrx
;
2105 * Decrement the lock reference count and end the atomic section if it reaches zero
2107 * This method should not be used outside of LocalFile/LocalFile*Batch
2109 * The commit and loc release will happen when no atomic sections are active, which
2110 * may happen immediately or at some point after calling this
2112 public function unlock() {
2113 if ( $this->locked
) {
2115 if ( !$this->locked
) {
2116 $dbw = $this->repo
->getMasterDB();
2117 $dbw->endAtomic( self
::ATOMIC_SECTION_LOCK
);
2118 $this->lockedOwnTrx
= false;
2126 protected function readOnlyFatalStatus() {
2127 return $this->getRepo()->newFatal( 'filereadonlyerror', $this->getName(),
2128 $this->getRepo()->getName(), $this->getRepo()->getReadOnlyReason() );
2132 * Clean up any dangling locks
2134 function __destruct() {
2137 } // LocalFile class
2139 # ------------------------------------------------------------------------------
2142 * Helper class for file deletion
2143 * @ingroup FileAbstraction
2145 class LocalFileDeleteBatch
{
2146 /** @var LocalFile */
2153 private $srcRels = [];
2156 private $archiveUrls = [];
2158 /** @var array Items to be processed in the deletion batch */
2159 private $deletionBatch;
2161 /** @var bool Whether to suppress all suppressable fields when deleting */
2172 * @param string $reason
2173 * @param bool $suppress
2174 * @param User|null $user
2176 function __construct( File
$file, $reason = '', $suppress = false, $user = null ) {
2177 $this->file
= $file;
2178 $this->reason
= $reason;
2179 $this->suppress
= $suppress;
2181 $this->user
= $user;
2184 $this->user
= $wgUser;
2186 $this->status
= $file->repo
->newGood();
2189 public function addCurrent() {
2190 $this->srcRels
['.'] = $this->file
->getRel();
2194 * @param string $oldName
2196 public function addOld( $oldName ) {
2197 $this->srcRels
[$oldName] = $this->file
->getArchiveRel( $oldName );
2198 $this->archiveUrls
[] = $this->file
->getArchiveUrl( $oldName );
2202 * Add the old versions of the image to the batch
2203 * @return array List of archive names from old versions
2205 public function addOlds() {
2208 $dbw = $this->file
->repo
->getMasterDB();
2209 $result = $dbw->select( 'oldimage',
2210 [ 'oi_archive_name' ],
2211 [ 'oi_name' => $this->file
->getName() ],
2215 foreach ( $result as $row ) {
2216 $this->addOld( $row->oi_archive_name
);
2217 $archiveNames[] = $row->oi_archive_name
;
2220 return $archiveNames;
2226 protected function getOldRels() {
2227 if ( !isset( $this->srcRels
['.'] ) ) {
2228 $oldRels =& $this->srcRels
;
2229 $deleteCurrent = false;
2231 $oldRels = $this->srcRels
;
2232 unset( $oldRels['.'] );
2233 $deleteCurrent = true;
2236 return [ $oldRels, $deleteCurrent ];
2242 protected function getHashes() {
2244 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
2246 if ( $deleteCurrent ) {
2247 $hashes['.'] = $this->file
->getSha1();
2250 if ( count( $oldRels ) ) {
2251 $dbw = $this->file
->repo
->getMasterDB();
2252 $res = $dbw->select(
2254 [ 'oi_archive_name', 'oi_sha1' ],
2255 [ 'oi_archive_name' => array_keys( $oldRels ),
2256 'oi_name' => $this->file
->getName() ], // performance
2260 foreach ( $res as $row ) {
2261 if ( rtrim( $row->oi_sha1
, "\0" ) === '' ) {
2262 // Get the hash from the file
2263 $oldUrl = $this->file
->getArchiveVirtualUrl( $row->oi_archive_name
);
2264 $props = $this->file
->repo
->getFileProps( $oldUrl );
2266 if ( $props['fileExists'] ) {
2267 // Upgrade the oldimage row
2268 $dbw->update( 'oldimage',
2269 [ 'oi_sha1' => $props['sha1'] ],
2270 [ 'oi_name' => $this->file
->getName(), 'oi_archive_name' => $row->oi_archive_name
],
2272 $hashes[$row->oi_archive_name
] = $props['sha1'];
2274 $hashes[$row->oi_archive_name
] = false;
2277 $hashes[$row->oi_archive_name
] = $row->oi_sha1
;
2282 $missing = array_diff_key( $this->srcRels
, $hashes );
2284 foreach ( $missing as $name => $rel ) {
2285 $this->status
->error( 'filedelete-old-unregistered', $name );
2288 foreach ( $hashes as $name => $hash ) {
2290 $this->status
->error( 'filedelete-missing', $this->srcRels
[$name] );
2291 unset( $hashes[$name] );
2298 protected function doDBInserts() {
2299 global $wgCommentTableSchemaMigrationStage;
2302 $dbw = $this->file
->repo
->getMasterDB();
2304 $commentStoreImgDesc = new CommentStore( 'img_description' );
2305 $commentStoreOiDesc = new CommentStore( 'oi_description' );
2306 $commentStoreFaDesc = new CommentStore( 'fa_description' );
2307 $commentStoreFaReason = new CommentStore( 'fa_deleted_reason' );
2309 $encTimestamp = $dbw->addQuotes( $dbw->timestamp( $now ) );
2310 $encUserId = $dbw->addQuotes( $this->user
->getId() );
2311 $encReason = $dbw->addQuotes( $this->reason
);
2312 $encGroup = $dbw->addQuotes( 'deleted' );
2313 $ext = $this->file
->getExtension();
2314 $dotExt = $ext === '' ?
'' : ".$ext";
2315 $encExt = $dbw->addQuotes( $dotExt );
2316 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
2318 // Bitfields to further suppress the content
2319 if ( $this->suppress
) {
2320 $bitfield = Revision
::SUPPRESSED_ALL
;
2322 $bitfield = 'oi_deleted';
2325 if ( $deleteCurrent ) {
2326 $tables = [ 'image' ];
2328 'fa_storage_group' => $encGroup,
2329 'fa_storage_key' => $dbw->conditional(
2330 [ 'img_sha1' => '' ],
2331 $dbw->addQuotes( '' ),
2332 $dbw->buildConcat( [ "img_sha1", $encExt ] )
2334 'fa_deleted_user' => $encUserId,
2335 'fa_deleted_timestamp' => $encTimestamp,
2336 'fa_deleted' => $this->suppress ?
$bitfield : 0,
2337 'fa_name' => 'img_name',
2338 'fa_archive_name' => 'NULL',
2339 'fa_size' => 'img_size',
2340 'fa_width' => 'img_width',
2341 'fa_height' => 'img_height',
2342 'fa_metadata' => 'img_metadata',
2343 'fa_bits' => 'img_bits',
2344 'fa_media_type' => 'img_media_type',
2345 'fa_major_mime' => 'img_major_mime',
2346 'fa_minor_mime' => 'img_minor_mime',
2347 'fa_user' => 'img_user',
2348 'fa_user_text' => 'img_user_text',
2349 'fa_timestamp' => 'img_timestamp',
2350 'fa_sha1' => 'img_sha1'
2354 $fields +
= $commentStoreFaReason->insert( $dbw, $encReason );
2356 if ( $wgCommentTableSchemaMigrationStage <= MIGRATION_WRITE_BOTH
) {
2357 $fields['fa_description'] = 'img_description';
2359 if ( $wgCommentTableSchemaMigrationStage >= MIGRATION_WRITE_BOTH
) {
2360 $tables[] = 'image_comment_temp';
2361 $fields['fa_description_id'] = 'imgcomment_description_id';
2362 $joins['image_comment_temp'] = [
2363 $wgCommentTableSchemaMigrationStage === MIGRATION_NEW ?
'JOIN' : 'LEFT JOIN',
2364 [ 'imgcomment_name = img_name' ]
2368 if ( $wgCommentTableSchemaMigrationStage !== MIGRATION_OLD
&&
2369 $wgCommentTableSchemaMigrationStage !== MIGRATION_NEW
2371 // Upgrade any rows that are still old-style. Otherwise an upgrade
2372 // might be missed if a deletion happens while the migration script
2374 $res = $dbw->select(
2375 [ 'image', 'image_comment_temp' ],
2376 [ 'img_name', 'img_description' ],
2377 [ 'img_name' => $this->file
->getName(), 'imgcomment_name' => null ],
2380 [ 'image_comment_temp' => [ 'LEFT JOIN', [ 'imgcomment_name = img_name' ] ] ]
2382 foreach ( $res as $row ) {
2383 list( , $callback ) = $commentStoreImgDesc->insertWithTempTable( $dbw, $row->img_description
);
2384 $callback( $row->img_name
);
2388 $dbw->insertSelect( 'filearchive', $tables, $fields,
2389 [ 'img_name' => $this->file
->getName() ], __METHOD__
, [], [], $joins );
2392 if ( count( $oldRels ) ) {
2393 $res = $dbw->select(
2395 OldLocalFile
::selectFields(),
2397 'oi_name' => $this->file
->getName(),
2398 'oi_archive_name' => array_keys( $oldRels )
2404 if ( $res->numRows() ) {
2405 $reason = $commentStoreFaReason->createComment( $dbw, $this->reason
);
2406 foreach ( $res as $row ) {
2407 // Legacy from OldLocalFile::selectFields() just above
2408 $comment = $commentStoreOiDesc->getCommentLegacy( $dbw, $row );
2410 // Deletion-specific fields
2411 'fa_storage_group' => 'deleted',
2412 'fa_storage_key' => ( $row->oi_sha1
=== '' )
2414 : "{$row->oi_sha1}{$dotExt}",
2415 'fa_deleted_user' => $this->user
->getId(),
2416 'fa_deleted_timestamp' => $dbw->timestamp( $now ),
2417 // Counterpart fields
2418 'fa_deleted' => $this->suppress ?
$bitfield : $row->oi_deleted
,
2419 'fa_name' => $row->oi_name
,
2420 'fa_archive_name' => $row->oi_archive_name
,
2421 'fa_size' => $row->oi_size
,
2422 'fa_width' => $row->oi_width
,
2423 'fa_height' => $row->oi_height
,
2424 'fa_metadata' => $row->oi_metadata
,
2425 'fa_bits' => $row->oi_bits
,
2426 'fa_media_type' => $row->oi_media_type
,
2427 'fa_major_mime' => $row->oi_major_mime
,
2428 'fa_minor_mime' => $row->oi_minor_mime
,
2429 'fa_user' => $row->oi_user
,
2430 'fa_user_text' => $row->oi_user_text
,
2431 'fa_timestamp' => $row->oi_timestamp
,
2432 'fa_sha1' => $row->oi_sha1
2433 ] +
$commentStoreFaReason->insert( $dbw, $reason )
2434 +
$commentStoreFaDesc->insert( $dbw, $comment );
2438 $dbw->insert( 'filearchive', $rowsInsert, __METHOD__
);
2442 function doDBDeletes() {
2443 global $wgUpdateCompatibleMetadata;
2445 $dbw = $this->file
->repo
->getMasterDB();
2446 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
2448 if ( count( $oldRels ) ) {
2449 $dbw->delete( 'oldimage',
2451 'oi_name' => $this->file
->getName(),
2452 'oi_archive_name' => array_keys( $oldRels )
2456 if ( $deleteCurrent ) {
2457 $dbw->delete( 'image', [ 'img_name' => $this->file
->getName() ], __METHOD__
);
2458 if ( $wgUpdateCompatibleMetadata > MIGRATION_OLD
) {
2460 'image_comment_temp', [ 'imgcomment_name' => $this->file
->getName() ], __METHOD__
2467 * Run the transaction
2470 public function execute() {
2471 $repo = $this->file
->getRepo();
2472 $this->file
->lock();
2474 // Prepare deletion batch
2475 $hashes = $this->getHashes();
2476 $this->deletionBatch
= [];
2477 $ext = $this->file
->getExtension();
2478 $dotExt = $ext === '' ?
'' : ".$ext";
2480 foreach ( $this->srcRels
as $name => $srcRel ) {
2481 // Skip files that have no hash (e.g. missing DB record, or sha1 field and file source)
2482 if ( isset( $hashes[$name] ) ) {
2483 $hash = $hashes[$name];
2484 $key = $hash . $dotExt;
2485 $dstRel = $repo->getDeletedHashPath( $key ) . $key;
2486 $this->deletionBatch
[$name] = [ $srcRel, $dstRel ];
2490 if ( !$repo->hasSha1Storage() ) {
2491 // Removes non-existent file from the batch, so we don't get errors.
2492 // This also handles files in the 'deleted' zone deleted via revision deletion.
2493 $checkStatus = $this->removeNonexistentFiles( $this->deletionBatch
);
2494 if ( !$checkStatus->isGood() ) {
2495 $this->status
->merge( $checkStatus );
2496 return $this->status
;
2498 $this->deletionBatch
= $checkStatus->value
;
2500 // Execute the file deletion batch
2501 $status = $this->file
->repo
->deleteBatch( $this->deletionBatch
);
2502 if ( !$status->isGood() ) {
2503 $this->status
->merge( $status );
2507 if ( !$this->status
->isOK() ) {
2508 // Critical file deletion error; abort
2509 $this->file
->unlock();
2511 return $this->status
;
2514 // Copy the image/oldimage rows to filearchive
2515 $this->doDBInserts();
2516 // Delete image/oldimage rows
2517 $this->doDBDeletes();
2519 // Commit and return
2520 $this->file
->unlock();
2522 return $this->status
;
2526 * Removes non-existent files from a deletion batch.
2527 * @param array $batch
2530 protected function removeNonexistentFiles( $batch ) {
2531 $files = $newBatch = [];
2533 foreach ( $batch as $batchItem ) {
2534 list( $src, ) = $batchItem;
2535 $files[$src] = $this->file
->repo
->getVirtualUrl( 'public' ) . '/' . rawurlencode( $src );
2538 $result = $this->file
->repo
->fileExistsBatch( $files );
2539 if ( in_array( null, $result, true ) ) {
2540 return Status
::newFatal( 'backend-fail-internal',
2541 $this->file
->repo
->getBackend()->getName() );
2544 foreach ( $batch as $batchItem ) {
2545 if ( $result[$batchItem[0]] ) {
2546 $newBatch[] = $batchItem;
2550 return Status
::newGood( $newBatch );
2554 # ------------------------------------------------------------------------------
2557 * Helper class for file undeletion
2558 * @ingroup FileAbstraction
2560 class LocalFileRestoreBatch
{
2561 /** @var LocalFile */
2564 /** @var array List of file IDs to restore */
2565 private $cleanupBatch;
2567 /** @var array List of file IDs to restore */
2570 /** @var bool Add all revisions of the file */
2573 /** @var bool Whether to remove all settings for suppressed fields */
2574 private $unsuppress = false;
2578 * @param bool $unsuppress
2580 function __construct( File
$file, $unsuppress = false ) {
2581 $this->file
= $file;
2582 $this->cleanupBatch
= $this->ids
= [];
2584 $this->unsuppress
= $unsuppress;
2591 public function addId( $fa_id ) {
2592 $this->ids
[] = $fa_id;
2596 * Add a whole lot of files by ID
2599 public function addIds( $ids ) {
2600 $this->ids
= array_merge( $this->ids
, $ids );
2604 * Add all revisions of the file
2606 public function addAll() {
2611 * Run the transaction, except the cleanup batch.
2612 * The cleanup batch should be run in a separate transaction, because it locks different
2613 * rows and there's no need to keep the image row locked while it's acquiring those locks
2614 * The caller may have its own transaction open.
2615 * So we save the batch and let the caller call cleanup()
2618 public function execute() {
2619 /** @var Language */
2622 $repo = $this->file
->getRepo();
2623 if ( !$this->all
&& !$this->ids
) {
2625 return $repo->newGood();
2628 $lockOwnsTrx = $this->file
->lock();
2630 $dbw = $this->file
->repo
->getMasterDB();
2632 $commentStoreImgDesc = new CommentStore( 'img_description' );
2633 $commentStoreOiDesc = new CommentStore( 'oi_description' );
2634 $commentStoreFaDesc = new CommentStore( 'fa_description' );
2636 $status = $this->file
->repo
->newGood();
2638 $exists = (bool)$dbw->selectField( 'image', '1',
2639 [ 'img_name' => $this->file
->getName() ],
2641 // The lock() should already prevents changes, but this still may need
2642 // to bypass any transaction snapshot. However, if lock() started the
2643 // trx (which it probably did) then snapshot is post-lock and up-to-date.
2644 $lockOwnsTrx ?
[] : [ 'LOCK IN SHARE MODE' ]
2647 // Fetch all or selected archived revisions for the file,
2648 // sorted from the most recent to the oldest.
2649 $conditions = [ 'fa_name' => $this->file
->getName() ];
2651 if ( !$this->all
) {
2652 $conditions['fa_id'] = $this->ids
;
2655 $result = $dbw->select(
2657 ArchivedFile
::selectFields(),
2660 [ 'ORDER BY' => 'fa_timestamp DESC' ]
2666 $insertCurrent = false;
2671 foreach ( $result as $row ) {
2672 $idsPresent[] = $row->fa_id
;
2674 if ( $row->fa_name
!= $this->file
->getName() ) {
2675 $status->error( 'undelete-filename-mismatch', $wgLang->timeanddate( $row->fa_timestamp
) );
2676 $status->failCount++
;
2680 if ( $row->fa_storage_key
== '' ) {
2681 // Revision was missing pre-deletion
2682 $status->error( 'undelete-bad-store-key', $wgLang->timeanddate( $row->fa_timestamp
) );
2683 $status->failCount++
;
2687 $deletedRel = $repo->getDeletedHashPath( $row->fa_storage_key
) .
2688 $row->fa_storage_key
;
2689 $deletedUrl = $repo->getVirtualUrl() . '/deleted/' . $deletedRel;
2691 if ( isset( $row->fa_sha1
) ) {
2692 $sha1 = $row->fa_sha1
;
2694 // old row, populate from key
2695 $sha1 = LocalRepo
::getHashFromKey( $row->fa_storage_key
);
2699 if ( strlen( $sha1 ) == 32 && $sha1[0] == '0' ) {
2700 $sha1 = substr( $sha1, 1 );
2703 if ( is_null( $row->fa_major_mime
) ||
$row->fa_major_mime
== 'unknown'
2704 ||
is_null( $row->fa_minor_mime
) ||
$row->fa_minor_mime
== 'unknown'
2705 ||
is_null( $row->fa_media_type
) ||
$row->fa_media_type
== 'UNKNOWN'
2706 ||
is_null( $row->fa_metadata
)
2708 // Refresh our metadata
2709 // Required for a new current revision; nice for older ones too. :)
2710 $props = RepoGroup
::singleton()->getFileProps( $deletedUrl );
2713 'minor_mime' => $row->fa_minor_mime
,
2714 'major_mime' => $row->fa_major_mime
,
2715 'media_type' => $row->fa_media_type
,
2716 'metadata' => $row->fa_metadata
2720 // Legacy from ArchivedFile::selectFields() just above
2721 $comment = $commentStoreFaDesc->getCommentLegacy( $dbw, $row );
2722 if ( $first && !$exists ) {
2723 // This revision will be published as the new current version
2724 $destRel = $this->file
->getRel();
2725 list( $commentFields, $commentCallback ) =
2726 $commentStoreImgDesc->insertWithTempTable( $dbw, $comment );
2728 'img_name' => $row->fa_name
,
2729 'img_size' => $row->fa_size
,
2730 'img_width' => $row->fa_width
,
2731 'img_height' => $row->fa_height
,
2732 'img_metadata' => $props['metadata'],
2733 'img_bits' => $row->fa_bits
,
2734 'img_media_type' => $props['media_type'],
2735 'img_major_mime' => $props['major_mime'],
2736 'img_minor_mime' => $props['minor_mime'],
2737 'img_user' => $row->fa_user
,
2738 'img_user_text' => $row->fa_user_text
,
2739 'img_timestamp' => $row->fa_timestamp
,
2743 // The live (current) version cannot be hidden!
2744 if ( !$this->unsuppress
&& $row->fa_deleted
) {
2745 $status->fatal( 'undeleterevdel' );
2746 $this->file
->unlock();
2750 $archiveName = $row->fa_archive_name
;
2752 if ( $archiveName == '' ) {
2753 // This was originally a current version; we
2754 // have to devise a new archive name for it.
2755 // Format is <timestamp of archiving>!<name>
2756 $timestamp = wfTimestamp( TS_UNIX
, $row->fa_deleted_timestamp
);
2759 $archiveName = wfTimestamp( TS_MW
, $timestamp ) . '!' . $row->fa_name
;
2761 } while ( isset( $archiveNames[$archiveName] ) );
2764 $archiveNames[$archiveName] = true;
2765 $destRel = $this->file
->getArchiveRel( $archiveName );
2767 'oi_name' => $row->fa_name
,
2768 'oi_archive_name' => $archiveName,
2769 'oi_size' => $row->fa_size
,
2770 'oi_width' => $row->fa_width
,
2771 'oi_height' => $row->fa_height
,
2772 'oi_bits' => $row->fa_bits
,
2773 'oi_user' => $row->fa_user
,
2774 'oi_user_text' => $row->fa_user_text
,
2775 'oi_timestamp' => $row->fa_timestamp
,
2776 'oi_metadata' => $props['metadata'],
2777 'oi_media_type' => $props['media_type'],
2778 'oi_major_mime' => $props['major_mime'],
2779 'oi_minor_mime' => $props['minor_mime'],
2780 'oi_deleted' => $this->unsuppress ?
0 : $row->fa_deleted
,
2782 ] +
$commentStoreOiDesc->insert( $dbw, $comment );
2785 $deleteIds[] = $row->fa_id
;
2787 if ( !$this->unsuppress
&& $row->fa_deleted
& File
::DELETED_FILE
) {
2788 // private files can stay where they are
2789 $status->successCount++
;
2791 $storeBatch[] = [ $deletedUrl, 'public', $destRel ];
2792 $this->cleanupBatch
[] = $row->fa_storage_key
;
2800 // Add a warning to the status object for missing IDs
2801 $missingIds = array_diff( $this->ids
, $idsPresent );
2803 foreach ( $missingIds as $id ) {
2804 $status->error( 'undelete-missing-filearchive', $id );
2807 if ( !$repo->hasSha1Storage() ) {
2808 // Remove missing files from batch, so we don't get errors when undeleting them
2809 $checkStatus = $this->removeNonexistentFiles( $storeBatch );
2810 if ( !$checkStatus->isGood() ) {
2811 $status->merge( $checkStatus );
2814 $storeBatch = $checkStatus->value
;
2816 // Run the store batch
2817 // Use the OVERWRITE_SAME flag to smooth over a common error
2818 $storeStatus = $this->file
->repo
->storeBatch( $storeBatch, FileRepo
::OVERWRITE_SAME
);
2819 $status->merge( $storeStatus );
2821 if ( !$status->isGood() ) {
2822 // Even if some files could be copied, fail entirely as that is the
2823 // easiest thing to do without data loss
2824 $this->cleanupFailedBatch( $storeStatus, $storeBatch );
2825 $status->setOK( false );
2826 $this->file
->unlock();
2832 // Run the DB updates
2833 // Because we have locked the image row, key conflicts should be rare.
2834 // If they do occur, we can roll back the transaction at this time with
2835 // no data loss, but leaving unregistered files scattered throughout the
2837 // This is not ideal, which is why it's important to lock the image row.
2838 if ( $insertCurrent ) {
2839 $dbw->insert( 'image', $insertCurrent, __METHOD__
);
2840 $commentCallback( $insertCurrent['img_name'] );
2843 if ( $insertBatch ) {
2844 $dbw->insert( 'oldimage', $insertBatch, __METHOD__
);
2848 $dbw->delete( 'filearchive',
2849 [ 'fa_id' => $deleteIds ],
2853 // If store batch is empty (all files are missing), deletion is to be considered successful
2854 if ( $status->successCount
> 0 ||
!$storeBatch ||
$repo->hasSha1Storage() ) {
2856 wfDebug( __METHOD__
. " restored {$status->successCount} items, creating a new current\n" );
2858 DeferredUpdates
::addUpdate( SiteStatsUpdate
::factory( [ 'images' => 1 ] ) );
2860 $this->file
->purgeEverything();
2862 wfDebug( __METHOD__
. " restored {$status->successCount} as archived versions\n" );
2863 $this->file
->purgeDescription();
2867 $this->file
->unlock();
2873 * Removes non-existent files from a store batch.
2874 * @param array $triplets
2877 protected function removeNonexistentFiles( $triplets ) {
2878 $files = $filteredTriplets = [];
2879 foreach ( $triplets as $file ) {
2880 $files[$file[0]] = $file[0];
2883 $result = $this->file
->repo
->fileExistsBatch( $files );
2884 if ( in_array( null, $result, true ) ) {
2885 return Status
::newFatal( 'backend-fail-internal',
2886 $this->file
->repo
->getBackend()->getName() );
2889 foreach ( $triplets as $file ) {
2890 if ( $result[$file[0]] ) {
2891 $filteredTriplets[] = $file;
2895 return Status
::newGood( $filteredTriplets );
2899 * Removes non-existent files from a cleanup batch.
2900 * @param array $batch
2903 protected function removeNonexistentFromCleanup( $batch ) {
2904 $files = $newBatch = [];
2905 $repo = $this->file
->repo
;
2907 foreach ( $batch as $file ) {
2908 $files[$file] = $repo->getVirtualUrl( 'deleted' ) . '/' .
2909 rawurlencode( $repo->getDeletedHashPath( $file ) . $file );
2912 $result = $repo->fileExistsBatch( $files );
2914 foreach ( $batch as $file ) {
2915 if ( $result[$file] ) {
2916 $newBatch[] = $file;
2924 * Delete unused files in the deleted zone.
2925 * This should be called from outside the transaction in which execute() was called.
2928 public function cleanup() {
2929 if ( !$this->cleanupBatch
) {
2930 return $this->file
->repo
->newGood();
2933 $this->cleanupBatch
= $this->removeNonexistentFromCleanup( $this->cleanupBatch
);
2935 $status = $this->file
->repo
->cleanupDeletedBatch( $this->cleanupBatch
);
2941 * Cleanup a failed batch. The batch was only partially successful, so
2942 * rollback by removing all items that were succesfully copied.
2944 * @param Status $storeStatus
2945 * @param array $storeBatch
2947 protected function cleanupFailedBatch( $storeStatus, $storeBatch ) {
2950 foreach ( $storeStatus->success
as $i => $success ) {
2951 // Check if this item of the batch was successfully copied
2953 // Item was successfully copied and needs to be removed again
2954 // Extract ($dstZone, $dstRel) from the batch
2955 $cleanupBatch[] = [ $storeBatch[$i][1], $storeBatch[$i][2] ];
2958 $this->file
->repo
->cleanupBatch( $cleanupBatch );
2962 # ------------------------------------------------------------------------------
2965 * Helper class for file movement
2966 * @ingroup FileAbstraction
2968 class LocalFileMoveBatch
{
2969 /** @var LocalFile */
2979 protected $oldCount;
2983 /** @var IDatabase */
2988 * @param Title $target
2990 function __construct( File
$file, Title
$target ) {
2991 $this->file
= $file;
2992 $this->target
= $target;
2993 $this->oldHash
= $this->file
->repo
->getHashPath( $this->file
->getName() );
2994 $this->newHash
= $this->file
->repo
->getHashPath( $this->target
->getDBkey() );
2995 $this->oldName
= $this->file
->getName();
2996 $this->newName
= $this->file
->repo
->getNameFromTitle( $this->target
);
2997 $this->oldRel
= $this->oldHash
. $this->oldName
;
2998 $this->newRel
= $this->newHash
. $this->newName
;
2999 $this->db
= $file->getRepo()->getMasterDB();
3003 * Add the current image to the batch
3005 public function addCurrent() {
3006 $this->cur
= [ $this->oldRel
, $this->newRel
];
3010 * Add the old versions of the image to the batch
3011 * @return array List of archive names from old versions
3013 public function addOlds() {
3014 $archiveBase = 'archive';
3016 $this->oldCount
= 0;
3019 $result = $this->db
->select( 'oldimage',
3020 [ 'oi_archive_name', 'oi_deleted' ],
3021 [ 'oi_name' => $this->oldName
],
3023 [ 'LOCK IN SHARE MODE' ] // ignore snapshot
3026 foreach ( $result as $row ) {
3027 $archiveNames[] = $row->oi_archive_name
;
3028 $oldName = $row->oi_archive_name
;
3029 $bits = explode( '!', $oldName, 2 );
3031 if ( count( $bits ) != 2 ) {
3032 wfDebug( "Old file name missing !: '$oldName' \n" );
3036 list( $timestamp, $filename ) = $bits;
3038 if ( $this->oldName
!= $filename ) {
3039 wfDebug( "Old file name doesn't match: '$oldName' \n" );
3045 // Do we want to add those to oldCount?
3046 if ( $row->oi_deleted
& File
::DELETED_FILE
) {
3051 "{$archiveBase}/{$this->oldHash}{$oldName}",
3052 "{$archiveBase}/{$this->newHash}{$timestamp}!{$this->newName}"
3056 return $archiveNames;
3063 public function execute() {
3064 $repo = $this->file
->repo
;
3065 $status = $repo->newGood();
3066 $destFile = wfLocalFile( $this->target
);
3068 $this->file
->lock(); // begin
3069 $destFile->lock(); // quickly fail if destination is not available
3071 $triplets = $this->getMoveTriplets();
3072 $checkStatus = $this->removeNonexistentFiles( $triplets );
3073 if ( !$checkStatus->isGood() ) {
3074 $destFile->unlock();
3075 $this->file
->unlock();
3076 $status->merge( $checkStatus ); // couldn't talk to file backend
3079 $triplets = $checkStatus->value
;
3081 // Verify the file versions metadata in the DB.
3082 $statusDb = $this->verifyDBUpdates();
3083 if ( !$statusDb->isGood() ) {
3084 $destFile->unlock();
3085 $this->file
->unlock();
3086 $statusDb->setOK( false );
3091 if ( !$repo->hasSha1Storage() ) {
3092 // Copy the files into their new location.
3093 // If a prior process fataled copying or cleaning up files we tolerate any
3094 // of the existing files if they are identical to the ones being stored.
3095 $statusMove = $repo->storeBatch( $triplets, FileRepo
::OVERWRITE_SAME
);
3096 wfDebugLog( 'imagemove', "Moved files for {$this->file->getName()}: " .
3097 "{$statusMove->successCount} successes, {$statusMove->failCount} failures" );
3098 if ( !$statusMove->isGood() ) {
3099 // Delete any files copied over (while the destination is still locked)
3100 $this->cleanupTarget( $triplets );
3101 $destFile->unlock();
3102 $this->file
->unlock();
3103 wfDebugLog( 'imagemove', "Error in moving files: "
3104 . $statusMove->getWikiText( false, false, 'en' ) );
3105 $statusMove->setOK( false );
3109 $status->merge( $statusMove );
3112 // Rename the file versions metadata in the DB.
3113 $this->doDBUpdates();
3115 wfDebugLog( 'imagemove', "Renamed {$this->file->getName()} in database: " .
3116 "{$statusDb->successCount} successes, {$statusDb->failCount} failures" );
3118 $destFile->unlock();
3119 $this->file
->unlock(); // done
3121 // Everything went ok, remove the source files
3122 $this->cleanupSource( $triplets );
3124 $status->merge( $statusDb );
3130 * Verify the database updates and return a new Status indicating how
3131 * many rows would be updated.
3135 protected function verifyDBUpdates() {
3136 $repo = $this->file
->repo
;
3137 $status = $repo->newGood();
3140 $hasCurrent = $dbw->selectField(
3143 [ 'img_name' => $this->oldName
],
3147 $oldRowCount = $dbw->selectField(
3150 [ 'oi_name' => $this->oldName
],
3155 if ( $hasCurrent ) {
3156 $status->successCount++
;
3158 $status->failCount++
;
3160 $status->successCount +
= $oldRowCount;
3161 // T36934: oldCount is based on files that actually exist.
3162 // There may be more DB rows than such files, in which case $affected
3163 // can be greater than $total. We use max() to avoid negatives here.
3164 $status->failCount +
= max( 0, $this->oldCount
- $oldRowCount );
3165 if ( $status->failCount
) {
3166 $status->error( 'imageinvalidfilename' );
3173 * Do the database updates and return a new Status indicating how
3174 * many rows where updated.
3176 protected function doDBUpdates() {
3179 // Update current image
3182 [ 'img_name' => $this->newName
],
3183 [ 'img_name' => $this->oldName
],
3186 // Update old images
3190 'oi_name' => $this->newName
,
3191 'oi_archive_name = ' . $dbw->strreplace( 'oi_archive_name',
3192 $dbw->addQuotes( $this->oldName
), $dbw->addQuotes( $this->newName
) ),
3194 [ 'oi_name' => $this->oldName
],
3200 * Generate triplets for FileRepo::storeBatch().
3203 protected function getMoveTriplets() {
3204 $moves = array_merge( [ $this->cur
], $this->olds
);
3205 $triplets = []; // The format is: (srcUrl, destZone, destUrl)
3207 foreach ( $moves as $move ) {
3208 // $move: (oldRelativePath, newRelativePath)
3209 $srcUrl = $this->file
->repo
->getVirtualUrl() . '/public/' . rawurlencode( $move[0] );
3210 $triplets[] = [ $srcUrl, 'public', $move[1] ];
3213 "Generated move triplet for {$this->file->getName()}: {$srcUrl} :: public :: {$move[1]}"
3221 * Removes non-existent files from move batch.
3222 * @param array $triplets
3225 protected function removeNonexistentFiles( $triplets ) {
3228 foreach ( $triplets as $file ) {
3229 $files[$file[0]] = $file[0];
3232 $result = $this->file
->repo
->fileExistsBatch( $files );
3233 if ( in_array( null, $result, true ) ) {
3234 return Status
::newFatal( 'backend-fail-internal',
3235 $this->file
->repo
->getBackend()->getName() );
3238 $filteredTriplets = [];
3239 foreach ( $triplets as $file ) {
3240 if ( $result[$file[0]] ) {
3241 $filteredTriplets[] = $file;
3243 wfDebugLog( 'imagemove', "File {$file[0]} does not exist" );
3247 return Status
::newGood( $filteredTriplets );
3251 * Cleanup a partially moved array of triplets by deleting the target
3252 * files. Called if something went wrong half way.
3253 * @param array $triplets
3255 protected function cleanupTarget( $triplets ) {
3256 // Create dest pairs from the triplets
3258 foreach ( $triplets as $triplet ) {
3259 // $triplet: (old source virtual URL, dst zone, dest rel)
3260 $pairs[] = [ $triplet[1], $triplet[2] ];
3263 $this->file
->repo
->cleanupBatch( $pairs );
3267 * Cleanup a fully moved array of triplets by deleting the source files.
3268 * Called at the end of the move process if everything else went ok.
3269 * @param array $triplets
3271 protected function cleanupSource( $triplets ) {
3272 // Create source file names from the triplets
3274 foreach ( $triplets as $triplet ) {
3275 $files[] = $triplet[0];
3278 $this->file
->repo
->cleanupBatch( $files );
3282 class LocalFileLockError
extends ErrorPageError
{
3283 public function __construct( Status
$status ) {
3284 parent
::__construct(
3286 $status->getMessage()
3290 public function report() {
3292 $wgOut->setStatusCode( 429 );