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 = []
1198 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
1199 return $this->readOnlyFatalStatus();
1202 $srcPath = ( $src instanceof FSFile
) ?
$src->getPath() : $src;
1204 if ( $this->repo
->isVirtualUrl( $srcPath )
1205 || FileBackend
::isStoragePath( $srcPath )
1207 $props = $this->repo
->getFileProps( $srcPath );
1209 $mwProps = new MWFileProps( MimeMagic
::singleton() );
1210 $props = $mwProps->getPropsFromPath( $srcPath, true );
1215 $handler = MediaHandler
::getHandler( $props['mime'] );
1217 $metadata = MediaWiki\
quietCall( 'unserialize', $props['metadata'] );
1219 if ( !is_array( $metadata ) ) {
1223 $options['headers'] = $handler->getContentHeaders( $metadata );
1225 $options['headers'] = [];
1228 // Trim spaces on user supplied text
1229 $comment = trim( $comment );
1231 $this->lock(); // begin
1232 $status = $this->publish( $src, $flags, $options );
1234 if ( $status->successCount
>= 2 ) {
1235 // There will be a copy+(one of move,copy,store).
1236 // The first succeeding does not commit us to updating the DB
1237 // since it simply copied the current version to a timestamped file name.
1238 // It is only *preferable* to avoid leaving such files orphaned.
1239 // Once the second operation goes through, then the current version was
1240 // updated and we must therefore update the DB too.
1241 $oldver = $status->value
;
1242 if ( !$this->recordUpload2( $oldver, $comment, $pageText, $props, $timestamp, $user, $tags ) ) {
1243 $status->fatal( 'filenotfound', $srcPath );
1247 $this->unlock(); // done
1253 * Record a file upload in the upload log and the image table
1254 * @param string $oldver
1255 * @param string $desc
1256 * @param string $license
1257 * @param string $copyStatus
1258 * @param string $source
1259 * @param bool $watch
1260 * @param string|bool $timestamp
1261 * @param User|null $user User object or null to use $wgUser
1264 function recordUpload( $oldver, $desc, $license = '', $copyStatus = '', $source = '',
1265 $watch = false, $timestamp = false, User
$user = null ) {
1271 $pageText = SpecialUpload
::getInitialPageText( $desc, $license, $copyStatus, $source );
1273 if ( !$this->recordUpload2( $oldver, $desc, $pageText, false, $timestamp, $user ) ) {
1278 $user->addWatch( $this->getTitle() );
1285 * Record a file upload in the upload log and the image table
1286 * @param string $oldver
1287 * @param string $comment
1288 * @param string $pageText
1289 * @param bool|array $props
1290 * @param string|bool $timestamp
1291 * @param null|User $user
1292 * @param string[] $tags
1295 function recordUpload2(
1296 $oldver, $comment, $pageText, $props = false, $timestamp = false, $user = null, $tags = []
1298 global $wgCommentTableSchemaMigrationStage;
1300 if ( is_null( $user ) ) {
1305 $dbw = $this->repo
->getMasterDB();
1307 # Imports or such might force a certain timestamp; otherwise we generate
1308 # it and can fudge it slightly to keep (name,timestamp) unique on re-upload.
1309 if ( $timestamp === false ) {
1310 $timestamp = $dbw->timestamp();
1311 $allowTimeKludge = true;
1313 $allowTimeKludge = false;
1316 $props = $props ?
: $this->repo
->getFileProps( $this->getVirtualUrl() );
1317 $props['description'] = $comment;
1318 $props['user'] = $user->getId();
1319 $props['user_text'] = $user->getName();
1320 $props['timestamp'] = wfTimestamp( TS_MW
, $timestamp ); // DB -> TS_MW
1321 $this->setProps( $props );
1323 # Fail now if the file isn't there
1324 if ( !$this->fileExists
) {
1325 wfDebug( __METHOD__
. ": File " . $this->getRel() . " went missing!\n" );
1330 $dbw->startAtomic( __METHOD__
);
1332 # Test to see if the row exists using INSERT IGNORE
1333 # This avoids race conditions by locking the row until the commit, and also
1334 # doesn't deadlock. SELECT FOR UPDATE causes a deadlock for every race condition.
1335 $commentStore = new CommentStore( 'img_description' );
1336 list( $commentFields, $commentCallback ) =
1337 $commentStore->insertWithTempTable( $dbw, $comment );
1338 $dbw->insert( 'image',
1340 'img_name' => $this->getName(),
1341 'img_size' => $this->size
,
1342 'img_width' => intval( $this->width
),
1343 'img_height' => intval( $this->height
),
1344 'img_bits' => $this->bits
,
1345 'img_media_type' => $this->media_type
,
1346 'img_major_mime' => $this->major_mime
,
1347 'img_minor_mime' => $this->minor_mime
,
1348 'img_timestamp' => $timestamp,
1349 'img_user' => $user->getId(),
1350 'img_user_text' => $user->getName(),
1351 'img_metadata' => $dbw->encodeBlob( $this->metadata
),
1352 'img_sha1' => $this->sha1
1357 $reupload = ( $dbw->affectedRows() == 0 );
1360 if ( $allowTimeKludge ) {
1361 # Use LOCK IN SHARE MODE to ignore any transaction snapshotting
1362 $ltimestamp = $dbw->selectField(
1365 [ 'img_name' => $this->getName() ],
1367 [ 'LOCK IN SHARE MODE' ]
1369 $lUnixtime = $ltimestamp ?
wfTimestamp( TS_UNIX
, $ltimestamp ) : false;
1370 # Avoid a timestamp that is not newer than the last version
1371 # TODO: the image/oldimage tables should be like page/revision with an ID field
1372 if ( $lUnixtime && wfTimestamp( TS_UNIX
, $timestamp ) <= $lUnixtime ) {
1373 sleep( 1 ); // fast enough re-uploads would go far in the future otherwise
1374 $timestamp = $dbw->timestamp( $lUnixtime +
1 );
1375 $this->timestamp
= wfTimestamp( TS_MW
, $timestamp ); // DB -> TS_MW
1379 $tables = [ 'image' ];
1381 'oi_name' => 'img_name',
1382 'oi_archive_name' => $dbw->addQuotes( $oldver ),
1383 'oi_size' => 'img_size',
1384 'oi_width' => 'img_width',
1385 'oi_height' => 'img_height',
1386 'oi_bits' => 'img_bits',
1387 'oi_timestamp' => 'img_timestamp',
1388 'oi_user' => 'img_user',
1389 'oi_user_text' => 'img_user_text',
1390 'oi_metadata' => 'img_metadata',
1391 'oi_media_type' => 'img_media_type',
1392 'oi_major_mime' => 'img_major_mime',
1393 'oi_minor_mime' => 'img_minor_mime',
1394 'oi_sha1' => 'img_sha1',
1398 if ( $wgCommentTableSchemaMigrationStage <= MIGRATION_WRITE_BOTH
) {
1399 $fields['oi_description'] = 'img_description';
1401 if ( $wgCommentTableSchemaMigrationStage >= MIGRATION_WRITE_BOTH
) {
1402 $tables[] = 'image_comment_temp';
1403 $fields['oi_description_id'] = 'imgcomment_description_id';
1404 $joins['image_comment_temp'] = [
1405 $wgCommentTableSchemaMigrationStage === MIGRATION_NEW ?
'JOIN' : 'LEFT JOIN',
1406 [ 'imgcomment_name = img_name' ]
1410 if ( $wgCommentTableSchemaMigrationStage !== MIGRATION_OLD
&&
1411 $wgCommentTableSchemaMigrationStage !== MIGRATION_NEW
1413 // Upgrade any rows that are still old-style. Otherwise an upgrade
1414 // might be missed if a deletion happens while the migration script
1416 $res = $dbw->select(
1417 [ 'image', 'image_comment_temp' ],
1418 [ 'img_name', 'img_description' ],
1419 [ 'img_name' => $this->getName(), 'imgcomment_name' => null ],
1422 [ 'image_comment_temp' => [ 'LEFT JOIN', [ 'imgcomment_name = img_name' ] ] ]
1424 foreach ( $res as $row ) {
1425 list( , $callback ) = $commentStore->insertWithTempTable( $dbw, $row->img_description
);
1426 $callback( $row->img_name
);
1430 # (T36993) Note: $oldver can be empty here, if the previous
1431 # version of the file was broken. Allow registration of the new
1432 # version to continue anyway, because that's better than having
1433 # an image that's not fixable by user operations.
1434 # Collision, this is an update of a file
1435 # Insert previous contents into oldimage
1436 $dbw->insertSelect( 'oldimage', $tables, $fields,
1437 [ 'img_name' => $this->getName() ], __METHOD__
, [], [], $joins );
1439 # Update the current image row
1440 $dbw->update( 'image',
1442 'img_size' => $this->size
,
1443 'img_width' => intval( $this->width
),
1444 'img_height' => intval( $this->height
),
1445 'img_bits' => $this->bits
,
1446 'img_media_type' => $this->media_type
,
1447 'img_major_mime' => $this->major_mime
,
1448 'img_minor_mime' => $this->minor_mime
,
1449 'img_timestamp' => $timestamp,
1450 'img_user' => $user->getId(),
1451 'img_user_text' => $user->getName(),
1452 'img_metadata' => $dbw->encodeBlob( $this->metadata
),
1453 'img_sha1' => $this->sha1
1455 [ 'img_name' => $this->getName() ],
1458 if ( $wgCommentTableSchemaMigrationStage > MIGRATION_OLD
) {
1459 // So $commentCallback can insert the new row
1460 $dbw->delete( 'image_comment_temp', [ 'imgcomment_name' => $this->getName() ], __METHOD__
);
1463 $commentCallback( $this->getName() );
1465 $descTitle = $this->getTitle();
1466 $descId = $descTitle->getArticleID();
1467 $wikiPage = new WikiFilePage( $descTitle );
1468 $wikiPage->setFile( $this );
1470 // Add the log entry...
1471 $logEntry = new ManualLogEntry( 'upload', $reupload ?
'overwrite' : 'upload' );
1472 $logEntry->setTimestamp( $this->timestamp
);
1473 $logEntry->setPerformer( $user );
1474 $logEntry->setComment( $comment );
1475 $logEntry->setTarget( $descTitle );
1476 // Allow people using the api to associate log entries with the upload.
1477 // Log has a timestamp, but sometimes different from upload timestamp.
1478 $logEntry->setParameters(
1480 'img_sha1' => $this->sha1
,
1481 'img_timestamp' => $timestamp,
1484 // Note we keep $logId around since during new image
1485 // creation, page doesn't exist yet, so log_page = 0
1486 // but we want it to point to the page we're making,
1487 // so we later modify the log entry.
1488 // For a similar reason, we avoid making an RC entry
1489 // now and wait until the page exists.
1490 $logId = $logEntry->insert();
1492 if ( $descTitle->exists() ) {
1493 // Use own context to get the action text in content language
1494 $formatter = LogFormatter
::newFromEntry( $logEntry );
1495 $formatter->setContext( RequestContext
::newExtraneousContext( $descTitle ) );
1496 $editSummary = $formatter->getPlainActionText();
1498 $nullRevision = Revision
::newNullRevision(
1505 if ( $nullRevision ) {
1506 $nullRevision->insertOn( $dbw );
1508 'NewRevisionFromEditComplete',
1509 [ $wikiPage, $nullRevision, $nullRevision->getParentId(), $user ]
1511 $wikiPage->updateRevisionOn( $dbw, $nullRevision );
1512 // Associate null revision id
1513 $logEntry->setAssociatedRevId( $nullRevision->getId() );
1516 $newPageContent = null;
1518 // Make the description page and RC log entry post-commit
1519 $newPageContent = ContentHandler
::makeContent( $pageText, $descTitle );
1522 # Defer purges, page creation, and link updates in case they error out.
1523 # The most important thing is that files and the DB registry stay synced.
1524 $dbw->endAtomic( __METHOD__
);
1526 # Do some cache purges after final commit so that:
1527 # a) Changes are more likely to be seen post-purge
1528 # b) They won't cause rollback of the log publish/update above
1529 DeferredUpdates
::addUpdate(
1530 new AutoCommitUpdate(
1534 $reupload, $wikiPage, $newPageContent, $comment, $user,
1535 $logEntry, $logId, $descId, $tags
1537 # Update memcache after the commit
1538 $this->invalidateCache();
1540 $updateLogPage = false;
1541 if ( $newPageContent ) {
1542 # New file page; create the description page.
1543 # There's already a log entry, so don't make a second RC entry
1544 # CDN and file cache for the description page are purged by doEditContent.
1545 $status = $wikiPage->doEditContent(
1548 EDIT_NEW | EDIT_SUPPRESS_RC
,
1553 if ( isset( $status->value
['revision'] ) ) {
1554 /** @var Revision $rev */
1555 $rev = $status->value
['revision'];
1556 // Associate new page revision id
1557 $logEntry->setAssociatedRevId( $rev->getId() );
1559 // This relies on the resetArticleID() call in WikiPage::insertOn(),
1560 // which is triggered on $descTitle by doEditContent() above.
1561 if ( isset( $status->value
['revision'] ) ) {
1562 /** @var Revision $rev */
1563 $rev = $status->value
['revision'];
1564 $updateLogPage = $rev->getPage();
1567 # Existing file page: invalidate description page cache
1568 $wikiPage->getTitle()->invalidateCache();
1569 $wikiPage->getTitle()->purgeSquid();
1570 # Allow the new file version to be patrolled from the page footer
1571 Article
::purgePatrolFooterCache( $descId );
1574 # Update associated rev id. This should be done by $logEntry->insert() earlier,
1575 # but setAssociatedRevId() wasn't called at that point yet...
1576 $logParams = $logEntry->getParameters();
1577 $logParams['associated_rev_id'] = $logEntry->getAssociatedRevId();
1578 $update = [ 'log_params' => LogEntryBase
::makeParamBlob( $logParams ) ];
1579 if ( $updateLogPage ) {
1580 # Also log page, in case where we just created it above
1581 $update['log_page'] = $updateLogPage;
1583 $this->getRepo()->getMasterDB()->update(
1586 [ 'log_id' => $logId ],
1589 $this->getRepo()->getMasterDB()->insert(
1592 'ls_field' => 'associated_rev_id',
1593 'ls_value' => $logEntry->getAssociatedRevId(),
1594 'ls_log_id' => $logId,
1599 # Add change tags, if any
1601 $logEntry->setTags( $tags );
1604 # Uploads can be patrolled
1605 $logEntry->setIsPatrollable( true );
1607 # Now that the log entry is up-to-date, make an RC entry.
1608 $logEntry->publish( $logId );
1610 # Run hook for other updates (typically more cache purging)
1611 Hooks
::run( 'FileUpload', [ $this, $reupload, !$newPageContent ] );
1614 # Delete old thumbnails
1615 $this->purgeThumbnails();
1616 # Remove the old file from the CDN cache
1617 DeferredUpdates
::addUpdate(
1618 new CdnCacheUpdate( [ $this->getUrl() ] ),
1619 DeferredUpdates
::PRESEND
1622 # Update backlink pages pointing to this title if created
1623 LinksUpdate
::queueRecursiveJobsForTable( $this->getTitle(), 'imagelinks' );
1626 $this->prerenderThumbnails();
1629 DeferredUpdates
::PRESEND
1633 # This is a new file, so update the image count
1634 DeferredUpdates
::addUpdate( SiteStatsUpdate
::factory( [ 'images' => 1 ] ) );
1637 # Invalidate cache for all pages using this file
1638 DeferredUpdates
::addUpdate( new HTMLCacheUpdate( $this->getTitle(), 'imagelinks' ) );
1644 * Move or copy a file to its public location. If a file exists at the
1645 * destination, move it to an archive. Returns a Status object with
1646 * the archive name in the "value" member on success.
1648 * The archive name should be passed through to recordUpload for database
1651 * @param string|FSFile $src Local filesystem path or virtual URL to the source image
1652 * @param int $flags A bitwise combination of:
1653 * File::DELETE_SOURCE Delete the source file, i.e. move rather than copy
1654 * @param array $options Optional additional parameters
1655 * @return Status On success, the value member contains the
1656 * archive name, or an empty string if it was a new file.
1658 function publish( $src, $flags = 0, array $options = [] ) {
1659 return $this->publishTo( $src, $this->getRel(), $flags, $options );
1663 * Move or copy a file to a specified location. Returns a Status
1664 * object with the archive name in the "value" member on success.
1666 * The archive name should be passed through to recordUpload for database
1669 * @param string|FSFile $src Local filesystem path or virtual URL to the source image
1670 * @param string $dstRel Target relative path
1671 * @param int $flags A bitwise combination of:
1672 * File::DELETE_SOURCE Delete the source file, i.e. move rather than copy
1673 * @param array $options Optional additional parameters
1674 * @return Status On success, the value member contains the
1675 * archive name, or an empty string if it was a new file.
1677 function publishTo( $src, $dstRel, $flags = 0, array $options = [] ) {
1678 $srcPath = ( $src instanceof FSFile
) ?
$src->getPath() : $src;
1680 $repo = $this->getRepo();
1681 if ( $repo->getReadOnlyReason() !== false ) {
1682 return $this->readOnlyFatalStatus();
1685 $this->lock(); // begin
1687 $archiveName = wfTimestamp( TS_MW
) . '!' . $this->getName();
1688 $archiveRel = 'archive/' . $this->getHashPath() . $archiveName;
1690 if ( $repo->hasSha1Storage() ) {
1691 $sha1 = $repo->isVirtualUrl( $srcPath )
1692 ?
$repo->getFileSha1( $srcPath )
1693 : FSFile
::getSha1Base36FromPath( $srcPath );
1694 /** @var FileBackendDBRepoWrapper $wrapperBackend */
1695 $wrapperBackend = $repo->getBackend();
1696 $dst = $wrapperBackend->getPathForSHA1( $sha1 );
1697 $status = $repo->quickImport( $src, $dst );
1698 if ( $flags & File
::DELETE_SOURCE
) {
1702 if ( $this->exists() ) {
1703 $status->value
= $archiveName;
1706 $flags = $flags & File
::DELETE_SOURCE ? LocalRepo
::DELETE_SOURCE
: 0;
1707 $status = $repo->publish( $srcPath, $dstRel, $archiveRel, $flags, $options );
1709 if ( $status->value
== 'new' ) {
1710 $status->value
= '';
1712 $status->value
= $archiveName;
1716 $this->unlock(); // done
1721 /** getLinksTo inherited */
1722 /** getExifData inherited */
1723 /** isLocal inherited */
1724 /** wasDeleted inherited */
1727 * Move file to the new title
1729 * Move current, old version and all thumbnails
1730 * to the new filename. Old file is deleted.
1732 * Cache purging is done; checks for validity
1733 * and logging are caller's responsibility
1735 * @param Title $target New file name
1738 function move( $target ) {
1739 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
1740 return $this->readOnlyFatalStatus();
1743 wfDebugLog( 'imagemove', "Got request to move {$this->name} to " . $target->getText() );
1744 $batch = new LocalFileMoveBatch( $this, $target );
1746 $this->lock(); // begin
1747 $batch->addCurrent();
1748 $archiveNames = $batch->addOlds();
1749 $status = $batch->execute();
1750 $this->unlock(); // done
1752 wfDebugLog( 'imagemove', "Finished moving {$this->name}" );
1754 // Purge the source and target files...
1755 $oldTitleFile = wfLocalFile( $this->title
);
1756 $newTitleFile = wfLocalFile( $target );
1757 // To avoid slow purges in the transaction, move them outside...
1758 DeferredUpdates
::addUpdate(
1759 new AutoCommitUpdate(
1760 $this->getRepo()->getMasterDB(),
1762 function () use ( $oldTitleFile, $newTitleFile, $archiveNames ) {
1763 $oldTitleFile->purgeEverything();
1764 foreach ( $archiveNames as $archiveName ) {
1765 $oldTitleFile->purgeOldThumbnails( $archiveName );
1767 $newTitleFile->purgeEverything();
1770 DeferredUpdates
::PRESEND
1773 if ( $status->isOK() ) {
1774 // Now switch the object
1775 $this->title
= $target;
1776 // Force regeneration of the name and hashpath
1777 unset( $this->name
);
1778 unset( $this->hashPath
);
1785 * Delete all versions of the file.
1787 * Moves the files into an archive directory (or deletes them)
1788 * and removes the database rows.
1790 * Cache purging is done; logging is caller's responsibility.
1792 * @param string $reason
1793 * @param bool $suppress
1794 * @param User|null $user
1797 function delete( $reason, $suppress = false, $user = null ) {
1798 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
1799 return $this->readOnlyFatalStatus();
1802 $batch = new LocalFileDeleteBatch( $this, $reason, $suppress, $user );
1804 $this->lock(); // begin
1805 $batch->addCurrent();
1806 // Get old version relative paths
1807 $archiveNames = $batch->addOlds();
1808 $status = $batch->execute();
1809 $this->unlock(); // done
1811 if ( $status->isOK() ) {
1812 DeferredUpdates
::addUpdate( SiteStatsUpdate
::factory( [ 'images' => -1 ] ) );
1815 // To avoid slow purges in the transaction, move them outside...
1816 DeferredUpdates
::addUpdate(
1817 new AutoCommitUpdate(
1818 $this->getRepo()->getMasterDB(),
1820 function () use ( $archiveNames ) {
1821 $this->purgeEverything();
1822 foreach ( $archiveNames as $archiveName ) {
1823 $this->purgeOldThumbnails( $archiveName );
1827 DeferredUpdates
::PRESEND
1832 foreach ( $archiveNames as $archiveName ) {
1833 $purgeUrls[] = $this->getArchiveUrl( $archiveName );
1835 DeferredUpdates
::addUpdate( new CdnCacheUpdate( $purgeUrls ), DeferredUpdates
::PRESEND
);
1841 * Delete an old version of the file.
1843 * Moves the file into an archive directory (or deletes it)
1844 * and removes the database row.
1846 * Cache purging is done; logging is caller's responsibility.
1848 * @param string $archiveName
1849 * @param string $reason
1850 * @param bool $suppress
1851 * @param User|null $user
1852 * @throws MWException Exception on database or file store failure
1855 function deleteOld( $archiveName, $reason, $suppress = false, $user = null ) {
1856 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
1857 return $this->readOnlyFatalStatus();
1860 $batch = new LocalFileDeleteBatch( $this, $reason, $suppress, $user );
1862 $this->lock(); // begin
1863 $batch->addOld( $archiveName );
1864 $status = $batch->execute();
1865 $this->unlock(); // done
1867 $this->purgeOldThumbnails( $archiveName );
1868 if ( $status->isOK() ) {
1869 $this->purgeDescription();
1872 DeferredUpdates
::addUpdate(
1873 new CdnCacheUpdate( [ $this->getArchiveUrl( $archiveName ) ] ),
1874 DeferredUpdates
::PRESEND
1881 * Restore all or specified deleted revisions to the given file.
1882 * Permissions and logging are left to the caller.
1884 * May throw database exceptions on error.
1886 * @param array $versions Set of record ids of deleted items to restore,
1887 * or empty to restore all revisions.
1888 * @param bool $unsuppress
1891 function restore( $versions = [], $unsuppress = false ) {
1892 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
1893 return $this->readOnlyFatalStatus();
1896 $batch = new LocalFileRestoreBatch( $this, $unsuppress );
1898 $this->lock(); // begin
1902 $batch->addIds( $versions );
1904 $status = $batch->execute();
1905 if ( $status->isGood() ) {
1906 $cleanupStatus = $batch->cleanup();
1907 $cleanupStatus->successCount
= 0;
1908 $cleanupStatus->failCount
= 0;
1909 $status->merge( $cleanupStatus );
1911 $this->unlock(); // done
1916 /** isMultipage inherited */
1917 /** pageCount inherited */
1918 /** scaleHeight inherited */
1919 /** getImageSize inherited */
1922 * Get the URL of the file description page.
1925 function getDescriptionUrl() {
1926 return $this->title
->getLocalURL();
1930 * Get the HTML text of the description page
1931 * This is not used by ImagePage for local files, since (among other things)
1932 * it skips the parser cache.
1934 * @param Language $lang What language to get description in (Optional)
1935 * @return bool|mixed
1937 function getDescriptionText( $lang = null ) {
1938 $revision = Revision
::newFromTitle( $this->title
, false, Revision
::READ_NORMAL
);
1942 $content = $revision->getContent();
1946 $pout = $content->getParserOutput( $this->title
, null, new ParserOptions( null, $lang ) );
1948 return $pout->getText();
1952 * @param int $audience
1956 function getDescription( $audience = self
::FOR_PUBLIC
, User
$user = null ) {
1958 if ( $audience == self
::FOR_PUBLIC
&& $this->isDeleted( self
::DELETED_COMMENT
) ) {
1960 } elseif ( $audience == self
::FOR_THIS_USER
1961 && !$this->userCan( self
::DELETED_COMMENT
, $user )
1965 return $this->description
;
1970 * @return bool|string
1972 function getTimestamp() {
1975 return $this->timestamp
;
1979 * @return bool|string
1981 public function getDescriptionTouched() {
1982 // The DB lookup might return false, e.g. if the file was just deleted, or the shared DB repo
1983 // itself gets it from elsewhere. To avoid repeating the DB lookups in such a case, we
1984 // need to differentiate between null (uninitialized) and false (failed to load).
1985 if ( $this->descriptionTouched
=== null ) {
1987 'page_namespace' => $this->title
->getNamespace(),
1988 'page_title' => $this->title
->getDBkey()
1990 $touched = $this->repo
->getReplicaDB()->selectField( 'page', 'page_touched', $cond, __METHOD__
);
1991 $this->descriptionTouched
= $touched ?
wfTimestamp( TS_MW
, $touched ) : false;
1994 return $this->descriptionTouched
;
2000 function getSha1() {
2002 // Initialise now if necessary
2003 if ( $this->sha1
== '' && $this->fileExists
) {
2004 $this->lock(); // begin
2006 $this->sha1
= $this->repo
->getFileSha1( $this->getPath() );
2007 if ( !wfReadOnly() && strval( $this->sha1
) != '' ) {
2008 $dbw = $this->repo
->getMasterDB();
2009 $dbw->update( 'image',
2010 [ 'img_sha1' => $this->sha1
],
2011 [ 'img_name' => $this->getName() ],
2013 $this->invalidateCache();
2016 $this->unlock(); // done
2023 * @return bool Whether to cache in RepoGroup (this avoids OOMs)
2025 function isCacheable() {
2028 // If extra data (metadata) was not loaded then it must have been large
2029 return $this->extraDataLoaded
2030 && strlen( serialize( $this->metadata
) ) <= self
::CACHE_FIELD_MAX_LEN
;
2037 public function acquireFileLock() {
2038 return $this->getRepo()->getBackend()->lockFiles(
2039 [ $this->getPath() ], LockManager
::LOCK_EX
, 10
2047 public function releaseFileLock() {
2048 return $this->getRepo()->getBackend()->unlockFiles(
2049 [ $this->getPath() ], LockManager
::LOCK_EX
2054 * Start an atomic DB section and lock the image for update
2055 * or increments a reference counter if the lock is already held
2057 * This method should not be used outside of LocalFile/LocalFile*Batch
2059 * @throws LocalFileLockError Throws an error if the lock was not acquired
2060 * @return bool Whether the file lock owns/spawned the DB transaction
2062 public function lock() {
2063 if ( !$this->locked
) {
2064 $logger = LoggerFactory
::getInstance( 'LocalFile' );
2066 $dbw = $this->repo
->getMasterDB();
2067 $makesTransaction = !$dbw->trxLevel();
2068 $dbw->startAtomic( self
::ATOMIC_SECTION_LOCK
);
2069 // T56736: use simple lock to handle when the file does not exist.
2070 // SELECT FOR UPDATE prevents changes, not other SELECTs with FOR UPDATE.
2071 // Also, that would cause contention on INSERT of similarly named rows.
2072 $status = $this->acquireFileLock(); // represents all versions of the file
2073 if ( !$status->isGood() ) {
2074 $dbw->endAtomic( self
::ATOMIC_SECTION_LOCK
);
2075 $logger->warning( "Failed to lock '{file}'", [ 'file' => $this->name
] );
2077 throw new LocalFileLockError( $status );
2079 // Release the lock *after* commit to avoid row-level contention.
2080 // Make sure it triggers on rollback() as well as commit() (T132921).
2081 $dbw->onTransactionResolution(
2082 function () use ( $logger ) {
2083 $status = $this->releaseFileLock();
2084 if ( !$status->isGood() ) {
2085 $logger->error( "Failed to unlock '{file}'", [ 'file' => $this->name
] );
2090 // Callers might care if the SELECT snapshot is safely fresh
2091 $this->lockedOwnTrx
= $makesTransaction;
2096 return $this->lockedOwnTrx
;
2100 * Decrement the lock reference count and end the atomic section if it reaches zero
2102 * This method should not be used outside of LocalFile/LocalFile*Batch
2104 * The commit and loc release will happen when no atomic sections are active, which
2105 * may happen immediately or at some point after calling this
2107 public function unlock() {
2108 if ( $this->locked
) {
2110 if ( !$this->locked
) {
2111 $dbw = $this->repo
->getMasterDB();
2112 $dbw->endAtomic( self
::ATOMIC_SECTION_LOCK
);
2113 $this->lockedOwnTrx
= false;
2121 protected function readOnlyFatalStatus() {
2122 return $this->getRepo()->newFatal( 'filereadonlyerror', $this->getName(),
2123 $this->getRepo()->getName(), $this->getRepo()->getReadOnlyReason() );
2127 * Clean up any dangling locks
2129 function __destruct() {
2132 } // LocalFile class
2134 # ------------------------------------------------------------------------------
2137 * Helper class for file deletion
2138 * @ingroup FileAbstraction
2140 class LocalFileDeleteBatch
{
2141 /** @var LocalFile */
2148 private $srcRels = [];
2151 private $archiveUrls = [];
2153 /** @var array Items to be processed in the deletion batch */
2154 private $deletionBatch;
2156 /** @var bool Whether to suppress all suppressable fields when deleting */
2167 * @param string $reason
2168 * @param bool $suppress
2169 * @param User|null $user
2171 function __construct( File
$file, $reason = '', $suppress = false, $user = null ) {
2172 $this->file
= $file;
2173 $this->reason
= $reason;
2174 $this->suppress
= $suppress;
2176 $this->user
= $user;
2179 $this->user
= $wgUser;
2181 $this->status
= $file->repo
->newGood();
2184 public function addCurrent() {
2185 $this->srcRels
['.'] = $this->file
->getRel();
2189 * @param string $oldName
2191 public function addOld( $oldName ) {
2192 $this->srcRels
[$oldName] = $this->file
->getArchiveRel( $oldName );
2193 $this->archiveUrls
[] = $this->file
->getArchiveUrl( $oldName );
2197 * Add the old versions of the image to the batch
2198 * @return array List of archive names from old versions
2200 public function addOlds() {
2203 $dbw = $this->file
->repo
->getMasterDB();
2204 $result = $dbw->select( 'oldimage',
2205 [ 'oi_archive_name' ],
2206 [ 'oi_name' => $this->file
->getName() ],
2210 foreach ( $result as $row ) {
2211 $this->addOld( $row->oi_archive_name
);
2212 $archiveNames[] = $row->oi_archive_name
;
2215 return $archiveNames;
2221 protected function getOldRels() {
2222 if ( !isset( $this->srcRels
['.'] ) ) {
2223 $oldRels =& $this->srcRels
;
2224 $deleteCurrent = false;
2226 $oldRels = $this->srcRels
;
2227 unset( $oldRels['.'] );
2228 $deleteCurrent = true;
2231 return [ $oldRels, $deleteCurrent ];
2237 protected function getHashes() {
2239 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
2241 if ( $deleteCurrent ) {
2242 $hashes['.'] = $this->file
->getSha1();
2245 if ( count( $oldRels ) ) {
2246 $dbw = $this->file
->repo
->getMasterDB();
2247 $res = $dbw->select(
2249 [ 'oi_archive_name', 'oi_sha1' ],
2250 [ 'oi_archive_name' => array_keys( $oldRels ),
2251 'oi_name' => $this->file
->getName() ], // performance
2255 foreach ( $res as $row ) {
2256 if ( rtrim( $row->oi_sha1
, "\0" ) === '' ) {
2257 // Get the hash from the file
2258 $oldUrl = $this->file
->getArchiveVirtualUrl( $row->oi_archive_name
);
2259 $props = $this->file
->repo
->getFileProps( $oldUrl );
2261 if ( $props['fileExists'] ) {
2262 // Upgrade the oldimage row
2263 $dbw->update( 'oldimage',
2264 [ 'oi_sha1' => $props['sha1'] ],
2265 [ 'oi_name' => $this->file
->getName(), 'oi_archive_name' => $row->oi_archive_name
],
2267 $hashes[$row->oi_archive_name
] = $props['sha1'];
2269 $hashes[$row->oi_archive_name
] = false;
2272 $hashes[$row->oi_archive_name
] = $row->oi_sha1
;
2277 $missing = array_diff_key( $this->srcRels
, $hashes );
2279 foreach ( $missing as $name => $rel ) {
2280 $this->status
->error( 'filedelete-old-unregistered', $name );
2283 foreach ( $hashes as $name => $hash ) {
2285 $this->status
->error( 'filedelete-missing', $this->srcRels
[$name] );
2286 unset( $hashes[$name] );
2293 protected function doDBInserts() {
2294 global $wgCommentTableSchemaMigrationStage;
2297 $dbw = $this->file
->repo
->getMasterDB();
2299 $commentStoreImgDesc = new CommentStore( 'img_description' );
2300 $commentStoreOiDesc = new CommentStore( 'oi_description' );
2301 $commentStoreFaDesc = new CommentStore( 'fa_description' );
2302 $commentStoreFaReason = new CommentStore( 'fa_deleted_reason' );
2304 $encTimestamp = $dbw->addQuotes( $dbw->timestamp( $now ) );
2305 $encUserId = $dbw->addQuotes( $this->user
->getId() );
2306 $encReason = $dbw->addQuotes( $this->reason
);
2307 $encGroup = $dbw->addQuotes( 'deleted' );
2308 $ext = $this->file
->getExtension();
2309 $dotExt = $ext === '' ?
'' : ".$ext";
2310 $encExt = $dbw->addQuotes( $dotExt );
2311 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
2313 // Bitfields to further suppress the content
2314 if ( $this->suppress
) {
2315 $bitfield = Revision
::SUPPRESSED_ALL
;
2317 $bitfield = 'oi_deleted';
2320 if ( $deleteCurrent ) {
2321 $tables = [ 'image' ];
2323 'fa_storage_group' => $encGroup,
2324 'fa_storage_key' => $dbw->conditional(
2325 [ 'img_sha1' => '' ],
2326 $dbw->addQuotes( '' ),
2327 $dbw->buildConcat( [ "img_sha1", $encExt ] )
2329 'fa_deleted_user' => $encUserId,
2330 'fa_deleted_timestamp' => $encTimestamp,
2331 'fa_deleted' => $this->suppress ?
$bitfield : 0,
2332 'fa_name' => 'img_name',
2333 'fa_archive_name' => 'NULL',
2334 'fa_size' => 'img_size',
2335 'fa_width' => 'img_width',
2336 'fa_height' => 'img_height',
2337 'fa_metadata' => 'img_metadata',
2338 'fa_bits' => 'img_bits',
2339 'fa_media_type' => 'img_media_type',
2340 'fa_major_mime' => 'img_major_mime',
2341 'fa_minor_mime' => 'img_minor_mime',
2342 'fa_user' => 'img_user',
2343 'fa_user_text' => 'img_user_text',
2344 'fa_timestamp' => 'img_timestamp',
2345 'fa_sha1' => 'img_sha1'
2349 $fields +
= $commentStoreFaReason->insert( $dbw, $encReason );
2351 if ( $wgCommentTableSchemaMigrationStage <= MIGRATION_WRITE_BOTH
) {
2352 $fields['fa_description'] = 'img_description';
2354 if ( $wgCommentTableSchemaMigrationStage >= MIGRATION_WRITE_BOTH
) {
2355 $tables[] = 'image_comment_temp';
2356 $fields['fa_description_id'] = 'imgcomment_description_id';
2357 $joins['image_comment_temp'] = [
2358 $wgCommentTableSchemaMigrationStage === MIGRATION_NEW ?
'JOIN' : 'LEFT JOIN',
2359 [ 'imgcomment_name = img_name' ]
2363 if ( $wgCommentTableSchemaMigrationStage !== MIGRATION_OLD
&&
2364 $wgCommentTableSchemaMigrationStage !== MIGRATION_NEW
2366 // Upgrade any rows that are still old-style. Otherwise an upgrade
2367 // might be missed if a deletion happens while the migration script
2369 $res = $dbw->select(
2370 [ 'image', 'image_comment_temp' ],
2371 [ 'img_name', 'img_description' ],
2372 [ 'img_name' => $this->file
->getName(), 'imgcomment_name' => null ],
2375 [ 'image_comment_temp' => [ 'LEFT JOIN', [ 'imgcomment_name = img_name' ] ] ]
2377 foreach ( $res as $row ) {
2378 list( , $callback ) = $commentStoreImgDesc->insertWithTempTable( $dbw, $row->img_description
);
2379 $callback( $row->img_name
);
2383 $dbw->insertSelect( 'filearchive', $tables, $fields,
2384 [ 'img_name' => $this->file
->getName() ], __METHOD__
, [], [], $joins );
2387 if ( count( $oldRels ) ) {
2388 $res = $dbw->select(
2390 OldLocalFile
::selectFields(),
2392 'oi_name' => $this->file
->getName(),
2393 'oi_archive_name' => array_keys( $oldRels )
2399 if ( $res->numRows() ) {
2400 $reason = $commentStoreFaReason->createComment( $dbw, $this->reason
);
2401 foreach ( $res as $row ) {
2402 // Legacy from OldLocalFile::selectFields() just above
2403 $comment = $commentStoreOiDesc->getCommentLegacy( $dbw, $row );
2405 // Deletion-specific fields
2406 'fa_storage_group' => 'deleted',
2407 'fa_storage_key' => ( $row->oi_sha1
=== '' )
2409 : "{$row->oi_sha1}{$dotExt}",
2410 'fa_deleted_user' => $this->user
->getId(),
2411 'fa_deleted_timestamp' => $dbw->timestamp( $now ),
2412 // Counterpart fields
2413 'fa_deleted' => $this->suppress ?
$bitfield : $row->oi_deleted
,
2414 'fa_name' => $row->oi_name
,
2415 'fa_archive_name' => $row->oi_archive_name
,
2416 'fa_size' => $row->oi_size
,
2417 'fa_width' => $row->oi_width
,
2418 'fa_height' => $row->oi_height
,
2419 'fa_metadata' => $row->oi_metadata
,
2420 'fa_bits' => $row->oi_bits
,
2421 'fa_media_type' => $row->oi_media_type
,
2422 'fa_major_mime' => $row->oi_major_mime
,
2423 'fa_minor_mime' => $row->oi_minor_mime
,
2424 'fa_user' => $row->oi_user
,
2425 'fa_user_text' => $row->oi_user_text
,
2426 'fa_timestamp' => $row->oi_timestamp
,
2427 'fa_sha1' => $row->oi_sha1
2428 ] +
$commentStoreFaReason->insert( $dbw, $reason )
2429 +
$commentStoreFaDesc->insert( $dbw, $comment );
2433 $dbw->insert( 'filearchive', $rowsInsert, __METHOD__
);
2437 function doDBDeletes() {
2438 global $wgUpdateCompatibleMetadata;
2440 $dbw = $this->file
->repo
->getMasterDB();
2441 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
2443 if ( count( $oldRels ) ) {
2444 $dbw->delete( 'oldimage',
2446 'oi_name' => $this->file
->getName(),
2447 'oi_archive_name' => array_keys( $oldRels )
2451 if ( $deleteCurrent ) {
2452 $dbw->delete( 'image', [ 'img_name' => $this->file
->getName() ], __METHOD__
);
2453 if ( $wgUpdateCompatibleMetadata > MIGRATION_OLD
) {
2455 'image_comment_temp', [ 'imgcomment_name' => $this->file
->getName() ], __METHOD__
2462 * Run the transaction
2465 public function execute() {
2466 $repo = $this->file
->getRepo();
2467 $this->file
->lock();
2469 // Prepare deletion batch
2470 $hashes = $this->getHashes();
2471 $this->deletionBatch
= [];
2472 $ext = $this->file
->getExtension();
2473 $dotExt = $ext === '' ?
'' : ".$ext";
2475 foreach ( $this->srcRels
as $name => $srcRel ) {
2476 // Skip files that have no hash (e.g. missing DB record, or sha1 field and file source)
2477 if ( isset( $hashes[$name] ) ) {
2478 $hash = $hashes[$name];
2479 $key = $hash . $dotExt;
2480 $dstRel = $repo->getDeletedHashPath( $key ) . $key;
2481 $this->deletionBatch
[$name] = [ $srcRel, $dstRel ];
2485 if ( !$repo->hasSha1Storage() ) {
2486 // Removes non-existent file from the batch, so we don't get errors.
2487 // This also handles files in the 'deleted' zone deleted via revision deletion.
2488 $checkStatus = $this->removeNonexistentFiles( $this->deletionBatch
);
2489 if ( !$checkStatus->isGood() ) {
2490 $this->status
->merge( $checkStatus );
2491 return $this->status
;
2493 $this->deletionBatch
= $checkStatus->value
;
2495 // Execute the file deletion batch
2496 $status = $this->file
->repo
->deleteBatch( $this->deletionBatch
);
2497 if ( !$status->isGood() ) {
2498 $this->status
->merge( $status );
2502 if ( !$this->status
->isOK() ) {
2503 // Critical file deletion error; abort
2504 $this->file
->unlock();
2506 return $this->status
;
2509 // Copy the image/oldimage rows to filearchive
2510 $this->doDBInserts();
2511 // Delete image/oldimage rows
2512 $this->doDBDeletes();
2514 // Commit and return
2515 $this->file
->unlock();
2517 return $this->status
;
2521 * Removes non-existent files from a deletion batch.
2522 * @param array $batch
2525 protected function removeNonexistentFiles( $batch ) {
2526 $files = $newBatch = [];
2528 foreach ( $batch as $batchItem ) {
2529 list( $src, ) = $batchItem;
2530 $files[$src] = $this->file
->repo
->getVirtualUrl( 'public' ) . '/' . rawurlencode( $src );
2533 $result = $this->file
->repo
->fileExistsBatch( $files );
2534 if ( in_array( null, $result, true ) ) {
2535 return Status
::newFatal( 'backend-fail-internal',
2536 $this->file
->repo
->getBackend()->getName() );
2539 foreach ( $batch as $batchItem ) {
2540 if ( $result[$batchItem[0]] ) {
2541 $newBatch[] = $batchItem;
2545 return Status
::newGood( $newBatch );
2549 # ------------------------------------------------------------------------------
2552 * Helper class for file undeletion
2553 * @ingroup FileAbstraction
2555 class LocalFileRestoreBatch
{
2556 /** @var LocalFile */
2559 /** @var array List of file IDs to restore */
2560 private $cleanupBatch;
2562 /** @var array List of file IDs to restore */
2565 /** @var bool Add all revisions of the file */
2568 /** @var bool Whether to remove all settings for suppressed fields */
2569 private $unsuppress = false;
2573 * @param bool $unsuppress
2575 function __construct( File
$file, $unsuppress = false ) {
2576 $this->file
= $file;
2577 $this->cleanupBatch
= $this->ids
= [];
2579 $this->unsuppress
= $unsuppress;
2586 public function addId( $fa_id ) {
2587 $this->ids
[] = $fa_id;
2591 * Add a whole lot of files by ID
2594 public function addIds( $ids ) {
2595 $this->ids
= array_merge( $this->ids
, $ids );
2599 * Add all revisions of the file
2601 public function addAll() {
2606 * Run the transaction, except the cleanup batch.
2607 * The cleanup batch should be run in a separate transaction, because it locks different
2608 * rows and there's no need to keep the image row locked while it's acquiring those locks
2609 * The caller may have its own transaction open.
2610 * So we save the batch and let the caller call cleanup()
2613 public function execute() {
2614 /** @var Language */
2617 $repo = $this->file
->getRepo();
2618 if ( !$this->all
&& !$this->ids
) {
2620 return $repo->newGood();
2623 $lockOwnsTrx = $this->file
->lock();
2625 $dbw = $this->file
->repo
->getMasterDB();
2627 $commentStoreImgDesc = new CommentStore( 'img_description' );
2628 $commentStoreOiDesc = new CommentStore( 'oi_description' );
2629 $commentStoreFaDesc = new CommentStore( 'fa_description' );
2631 $status = $this->file
->repo
->newGood();
2633 $exists = (bool)$dbw->selectField( 'image', '1',
2634 [ 'img_name' => $this->file
->getName() ],
2636 // The lock() should already prevents changes, but this still may need
2637 // to bypass any transaction snapshot. However, if lock() started the
2638 // trx (which it probably did) then snapshot is post-lock and up-to-date.
2639 $lockOwnsTrx ?
[] : [ 'LOCK IN SHARE MODE' ]
2642 // Fetch all or selected archived revisions for the file,
2643 // sorted from the most recent to the oldest.
2644 $conditions = [ 'fa_name' => $this->file
->getName() ];
2646 if ( !$this->all
) {
2647 $conditions['fa_id'] = $this->ids
;
2650 $result = $dbw->select(
2652 ArchivedFile
::selectFields(),
2655 [ 'ORDER BY' => 'fa_timestamp DESC' ]
2661 $insertCurrent = false;
2666 foreach ( $result as $row ) {
2667 $idsPresent[] = $row->fa_id
;
2669 if ( $row->fa_name
!= $this->file
->getName() ) {
2670 $status->error( 'undelete-filename-mismatch', $wgLang->timeanddate( $row->fa_timestamp
) );
2671 $status->failCount++
;
2675 if ( $row->fa_storage_key
== '' ) {
2676 // Revision was missing pre-deletion
2677 $status->error( 'undelete-bad-store-key', $wgLang->timeanddate( $row->fa_timestamp
) );
2678 $status->failCount++
;
2682 $deletedRel = $repo->getDeletedHashPath( $row->fa_storage_key
) .
2683 $row->fa_storage_key
;
2684 $deletedUrl = $repo->getVirtualUrl() . '/deleted/' . $deletedRel;
2686 if ( isset( $row->fa_sha1
) ) {
2687 $sha1 = $row->fa_sha1
;
2689 // old row, populate from key
2690 $sha1 = LocalRepo
::getHashFromKey( $row->fa_storage_key
);
2694 if ( strlen( $sha1 ) == 32 && $sha1[0] == '0' ) {
2695 $sha1 = substr( $sha1, 1 );
2698 if ( is_null( $row->fa_major_mime
) ||
$row->fa_major_mime
== 'unknown'
2699 ||
is_null( $row->fa_minor_mime
) ||
$row->fa_minor_mime
== 'unknown'
2700 ||
is_null( $row->fa_media_type
) ||
$row->fa_media_type
== 'UNKNOWN'
2701 ||
is_null( $row->fa_metadata
)
2703 // Refresh our metadata
2704 // Required for a new current revision; nice for older ones too. :)
2705 $props = RepoGroup
::singleton()->getFileProps( $deletedUrl );
2708 'minor_mime' => $row->fa_minor_mime
,
2709 'major_mime' => $row->fa_major_mime
,
2710 'media_type' => $row->fa_media_type
,
2711 'metadata' => $row->fa_metadata
2715 // Legacy from ArchivedFile::selectFields() just above
2716 $comment = $commentStoreFaDesc->getCommentLegacy( $dbw, $row );
2717 if ( $first && !$exists ) {
2718 // This revision will be published as the new current version
2719 $destRel = $this->file
->getRel();
2720 list( $commentFields, $commentCallback ) =
2721 $commentStoreImgDesc->insertWithTempTable( $dbw, $comment );
2723 'img_name' => $row->fa_name
,
2724 'img_size' => $row->fa_size
,
2725 'img_width' => $row->fa_width
,
2726 'img_height' => $row->fa_height
,
2727 'img_metadata' => $props['metadata'],
2728 'img_bits' => $row->fa_bits
,
2729 'img_media_type' => $props['media_type'],
2730 'img_major_mime' => $props['major_mime'],
2731 'img_minor_mime' => $props['minor_mime'],
2732 'img_user' => $row->fa_user
,
2733 'img_user_text' => $row->fa_user_text
,
2734 'img_timestamp' => $row->fa_timestamp
,
2738 // The live (current) version cannot be hidden!
2739 if ( !$this->unsuppress
&& $row->fa_deleted
) {
2740 $status->fatal( 'undeleterevdel' );
2741 $this->file
->unlock();
2745 $archiveName = $row->fa_archive_name
;
2747 if ( $archiveName == '' ) {
2748 // This was originally a current version; we
2749 // have to devise a new archive name for it.
2750 // Format is <timestamp of archiving>!<name>
2751 $timestamp = wfTimestamp( TS_UNIX
, $row->fa_deleted_timestamp
);
2754 $archiveName = wfTimestamp( TS_MW
, $timestamp ) . '!' . $row->fa_name
;
2756 } while ( isset( $archiveNames[$archiveName] ) );
2759 $archiveNames[$archiveName] = true;
2760 $destRel = $this->file
->getArchiveRel( $archiveName );
2762 'oi_name' => $row->fa_name
,
2763 'oi_archive_name' => $archiveName,
2764 'oi_size' => $row->fa_size
,
2765 'oi_width' => $row->fa_width
,
2766 'oi_height' => $row->fa_height
,
2767 'oi_bits' => $row->fa_bits
,
2768 'oi_user' => $row->fa_user
,
2769 'oi_user_text' => $row->fa_user_text
,
2770 'oi_timestamp' => $row->fa_timestamp
,
2771 'oi_metadata' => $props['metadata'],
2772 'oi_media_type' => $props['media_type'],
2773 'oi_major_mime' => $props['major_mime'],
2774 'oi_minor_mime' => $props['minor_mime'],
2775 'oi_deleted' => $this->unsuppress ?
0 : $row->fa_deleted
,
2777 ] +
$commentStoreOiDesc->insert( $dbw, $comment );
2780 $deleteIds[] = $row->fa_id
;
2782 if ( !$this->unsuppress
&& $row->fa_deleted
& File
::DELETED_FILE
) {
2783 // private files can stay where they are
2784 $status->successCount++
;
2786 $storeBatch[] = [ $deletedUrl, 'public', $destRel ];
2787 $this->cleanupBatch
[] = $row->fa_storage_key
;
2795 // Add a warning to the status object for missing IDs
2796 $missingIds = array_diff( $this->ids
, $idsPresent );
2798 foreach ( $missingIds as $id ) {
2799 $status->error( 'undelete-missing-filearchive', $id );
2802 if ( !$repo->hasSha1Storage() ) {
2803 // Remove missing files from batch, so we don't get errors when undeleting them
2804 $checkStatus = $this->removeNonexistentFiles( $storeBatch );
2805 if ( !$checkStatus->isGood() ) {
2806 $status->merge( $checkStatus );
2809 $storeBatch = $checkStatus->value
;
2811 // Run the store batch
2812 // Use the OVERWRITE_SAME flag to smooth over a common error
2813 $storeStatus = $this->file
->repo
->storeBatch( $storeBatch, FileRepo
::OVERWRITE_SAME
);
2814 $status->merge( $storeStatus );
2816 if ( !$status->isGood() ) {
2817 // Even if some files could be copied, fail entirely as that is the
2818 // easiest thing to do without data loss
2819 $this->cleanupFailedBatch( $storeStatus, $storeBatch );
2820 $status->setOK( false );
2821 $this->file
->unlock();
2827 // Run the DB updates
2828 // Because we have locked the image row, key conflicts should be rare.
2829 // If they do occur, we can roll back the transaction at this time with
2830 // no data loss, but leaving unregistered files scattered throughout the
2832 // This is not ideal, which is why it's important to lock the image row.
2833 if ( $insertCurrent ) {
2834 $dbw->insert( 'image', $insertCurrent, __METHOD__
);
2835 $commentCallback( $insertCurrent['img_name'] );
2838 if ( $insertBatch ) {
2839 $dbw->insert( 'oldimage', $insertBatch, __METHOD__
);
2843 $dbw->delete( 'filearchive',
2844 [ 'fa_id' => $deleteIds ],
2848 // If store batch is empty (all files are missing), deletion is to be considered successful
2849 if ( $status->successCount
> 0 ||
!$storeBatch ||
$repo->hasSha1Storage() ) {
2851 wfDebug( __METHOD__
. " restored {$status->successCount} items, creating a new current\n" );
2853 DeferredUpdates
::addUpdate( SiteStatsUpdate
::factory( [ 'images' => 1 ] ) );
2855 $this->file
->purgeEverything();
2857 wfDebug( __METHOD__
. " restored {$status->successCount} as archived versions\n" );
2858 $this->file
->purgeDescription();
2862 $this->file
->unlock();
2868 * Removes non-existent files from a store batch.
2869 * @param array $triplets
2872 protected function removeNonexistentFiles( $triplets ) {
2873 $files = $filteredTriplets = [];
2874 foreach ( $triplets as $file ) {
2875 $files[$file[0]] = $file[0];
2878 $result = $this->file
->repo
->fileExistsBatch( $files );
2879 if ( in_array( null, $result, true ) ) {
2880 return Status
::newFatal( 'backend-fail-internal',
2881 $this->file
->repo
->getBackend()->getName() );
2884 foreach ( $triplets as $file ) {
2885 if ( $result[$file[0]] ) {
2886 $filteredTriplets[] = $file;
2890 return Status
::newGood( $filteredTriplets );
2894 * Removes non-existent files from a cleanup batch.
2895 * @param array $batch
2898 protected function removeNonexistentFromCleanup( $batch ) {
2899 $files = $newBatch = [];
2900 $repo = $this->file
->repo
;
2902 foreach ( $batch as $file ) {
2903 $files[$file] = $repo->getVirtualUrl( 'deleted' ) . '/' .
2904 rawurlencode( $repo->getDeletedHashPath( $file ) . $file );
2907 $result = $repo->fileExistsBatch( $files );
2909 foreach ( $batch as $file ) {
2910 if ( $result[$file] ) {
2911 $newBatch[] = $file;
2919 * Delete unused files in the deleted zone.
2920 * This should be called from outside the transaction in which execute() was called.
2923 public function cleanup() {
2924 if ( !$this->cleanupBatch
) {
2925 return $this->file
->repo
->newGood();
2928 $this->cleanupBatch
= $this->removeNonexistentFromCleanup( $this->cleanupBatch
);
2930 $status = $this->file
->repo
->cleanupDeletedBatch( $this->cleanupBatch
);
2936 * Cleanup a failed batch. The batch was only partially successful, so
2937 * rollback by removing all items that were succesfully copied.
2939 * @param Status $storeStatus
2940 * @param array $storeBatch
2942 protected function cleanupFailedBatch( $storeStatus, $storeBatch ) {
2945 foreach ( $storeStatus->success
as $i => $success ) {
2946 // Check if this item of the batch was successfully copied
2948 // Item was successfully copied and needs to be removed again
2949 // Extract ($dstZone, $dstRel) from the batch
2950 $cleanupBatch[] = [ $storeBatch[$i][1], $storeBatch[$i][2] ];
2953 $this->file
->repo
->cleanupBatch( $cleanupBatch );
2957 # ------------------------------------------------------------------------------
2960 * Helper class for file movement
2961 * @ingroup FileAbstraction
2963 class LocalFileMoveBatch
{
2964 /** @var LocalFile */
2974 protected $oldCount;
2978 /** @var IDatabase */
2983 * @param Title $target
2985 function __construct( File
$file, Title
$target ) {
2986 $this->file
= $file;
2987 $this->target
= $target;
2988 $this->oldHash
= $this->file
->repo
->getHashPath( $this->file
->getName() );
2989 $this->newHash
= $this->file
->repo
->getHashPath( $this->target
->getDBkey() );
2990 $this->oldName
= $this->file
->getName();
2991 $this->newName
= $this->file
->repo
->getNameFromTitle( $this->target
);
2992 $this->oldRel
= $this->oldHash
. $this->oldName
;
2993 $this->newRel
= $this->newHash
. $this->newName
;
2994 $this->db
= $file->getRepo()->getMasterDB();
2998 * Add the current image to the batch
3000 public function addCurrent() {
3001 $this->cur
= [ $this->oldRel
, $this->newRel
];
3005 * Add the old versions of the image to the batch
3006 * @return array List of archive names from old versions
3008 public function addOlds() {
3009 $archiveBase = 'archive';
3011 $this->oldCount
= 0;
3014 $result = $this->db
->select( 'oldimage',
3015 [ 'oi_archive_name', 'oi_deleted' ],
3016 [ 'oi_name' => $this->oldName
],
3018 [ 'LOCK IN SHARE MODE' ] // ignore snapshot
3021 foreach ( $result as $row ) {
3022 $archiveNames[] = $row->oi_archive_name
;
3023 $oldName = $row->oi_archive_name
;
3024 $bits = explode( '!', $oldName, 2 );
3026 if ( count( $bits ) != 2 ) {
3027 wfDebug( "Old file name missing !: '$oldName' \n" );
3031 list( $timestamp, $filename ) = $bits;
3033 if ( $this->oldName
!= $filename ) {
3034 wfDebug( "Old file name doesn't match: '$oldName' \n" );
3040 // Do we want to add those to oldCount?
3041 if ( $row->oi_deleted
& File
::DELETED_FILE
) {
3046 "{$archiveBase}/{$this->oldHash}{$oldName}",
3047 "{$archiveBase}/{$this->newHash}{$timestamp}!{$this->newName}"
3051 return $archiveNames;
3058 public function execute() {
3059 $repo = $this->file
->repo
;
3060 $status = $repo->newGood();
3061 $destFile = wfLocalFile( $this->target
);
3063 $this->file
->lock(); // begin
3064 $destFile->lock(); // quickly fail if destination is not available
3066 $triplets = $this->getMoveTriplets();
3067 $checkStatus = $this->removeNonexistentFiles( $triplets );
3068 if ( !$checkStatus->isGood() ) {
3069 $destFile->unlock();
3070 $this->file
->unlock();
3071 $status->merge( $checkStatus ); // couldn't talk to file backend
3074 $triplets = $checkStatus->value
;
3076 // Verify the file versions metadata in the DB.
3077 $statusDb = $this->verifyDBUpdates();
3078 if ( !$statusDb->isGood() ) {
3079 $destFile->unlock();
3080 $this->file
->unlock();
3081 $statusDb->setOK( false );
3086 if ( !$repo->hasSha1Storage() ) {
3087 // Copy the files into their new location.
3088 // If a prior process fataled copying or cleaning up files we tolerate any
3089 // of the existing files if they are identical to the ones being stored.
3090 $statusMove = $repo->storeBatch( $triplets, FileRepo
::OVERWRITE_SAME
);
3091 wfDebugLog( 'imagemove', "Moved files for {$this->file->getName()}: " .
3092 "{$statusMove->successCount} successes, {$statusMove->failCount} failures" );
3093 if ( !$statusMove->isGood() ) {
3094 // Delete any files copied over (while the destination is still locked)
3095 $this->cleanupTarget( $triplets );
3096 $destFile->unlock();
3097 $this->file
->unlock();
3098 wfDebugLog( 'imagemove', "Error in moving files: "
3099 . $statusMove->getWikiText( false, false, 'en' ) );
3100 $statusMove->setOK( false );
3104 $status->merge( $statusMove );
3107 // Rename the file versions metadata in the DB.
3108 $this->doDBUpdates();
3110 wfDebugLog( 'imagemove', "Renamed {$this->file->getName()} in database: " .
3111 "{$statusDb->successCount} successes, {$statusDb->failCount} failures" );
3113 $destFile->unlock();
3114 $this->file
->unlock(); // done
3116 // Everything went ok, remove the source files
3117 $this->cleanupSource( $triplets );
3119 $status->merge( $statusDb );
3125 * Verify the database updates and return a new Status indicating how
3126 * many rows would be updated.
3130 protected function verifyDBUpdates() {
3131 $repo = $this->file
->repo
;
3132 $status = $repo->newGood();
3135 $hasCurrent = $dbw->selectField(
3138 [ 'img_name' => $this->oldName
],
3142 $oldRowCount = $dbw->selectField(
3145 [ 'oi_name' => $this->oldName
],
3150 if ( $hasCurrent ) {
3151 $status->successCount++
;
3153 $status->failCount++
;
3155 $status->successCount +
= $oldRowCount;
3156 // T36934: oldCount is based on files that actually exist.
3157 // There may be more DB rows than such files, in which case $affected
3158 // can be greater than $total. We use max() to avoid negatives here.
3159 $status->failCount +
= max( 0, $this->oldCount
- $oldRowCount );
3160 if ( $status->failCount
) {
3161 $status->error( 'imageinvalidfilename' );
3168 * Do the database updates and return a new Status indicating how
3169 * many rows where updated.
3171 protected function doDBUpdates() {
3174 // Update current image
3177 [ 'img_name' => $this->newName
],
3178 [ 'img_name' => $this->oldName
],
3181 // Update old images
3185 'oi_name' => $this->newName
,
3186 'oi_archive_name = ' . $dbw->strreplace( 'oi_archive_name',
3187 $dbw->addQuotes( $this->oldName
), $dbw->addQuotes( $this->newName
) ),
3189 [ 'oi_name' => $this->oldName
],
3195 * Generate triplets for FileRepo::storeBatch().
3198 protected function getMoveTriplets() {
3199 $moves = array_merge( [ $this->cur
], $this->olds
);
3200 $triplets = []; // The format is: (srcUrl, destZone, destUrl)
3202 foreach ( $moves as $move ) {
3203 // $move: (oldRelativePath, newRelativePath)
3204 $srcUrl = $this->file
->repo
->getVirtualUrl() . '/public/' . rawurlencode( $move[0] );
3205 $triplets[] = [ $srcUrl, 'public', $move[1] ];
3208 "Generated move triplet for {$this->file->getName()}: {$srcUrl} :: public :: {$move[1]}"
3216 * Removes non-existent files from move batch.
3217 * @param array $triplets
3220 protected function removeNonexistentFiles( $triplets ) {
3223 foreach ( $triplets as $file ) {
3224 $files[$file[0]] = $file[0];
3227 $result = $this->file
->repo
->fileExistsBatch( $files );
3228 if ( in_array( null, $result, true ) ) {
3229 return Status
::newFatal( 'backend-fail-internal',
3230 $this->file
->repo
->getBackend()->getName() );
3233 $filteredTriplets = [];
3234 foreach ( $triplets as $file ) {
3235 if ( $result[$file[0]] ) {
3236 $filteredTriplets[] = $file;
3238 wfDebugLog( 'imagemove', "File {$file[0]} does not exist" );
3242 return Status
::newGood( $filteredTriplets );
3246 * Cleanup a partially moved array of triplets by deleting the target
3247 * files. Called if something went wrong half way.
3248 * @param array $triplets
3250 protected function cleanupTarget( $triplets ) {
3251 // Create dest pairs from the triplets
3253 foreach ( $triplets as $triplet ) {
3254 // $triplet: (old source virtual URL, dst zone, dest rel)
3255 $pairs[] = [ $triplet[1], $triplet[2] ];
3258 $this->file
->repo
->cleanupBatch( $pairs );
3262 * Cleanup a fully moved array of triplets by deleting the source files.
3263 * Called at the end of the move process if everything else went ok.
3264 * @param array $triplets
3266 protected function cleanupSource( $triplets ) {
3267 // Create source file names from the triplets
3269 foreach ( $triplets as $triplet ) {
3270 $files[] = $triplet[0];
3273 $this->file
->repo
->cleanupBatch( $files );
3277 class LocalFileLockError
extends ErrorPageError
{
3278 public function __construct( Status
$status ) {
3279 parent
::__construct(
3281 $status->getMessage()
3285 public function report() {
3287 $wgOut->setStatusCode( 429 );