3 * Local file in the wiki's own database.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
21 * @ingroup FileAbstraction
24 use MediaWiki\Logger\LoggerFactory
;
25 use Wikimedia\Rdbms\Database
;
26 use Wikimedia\Rdbms\IDatabase
;
29 * Class to represent a local file in the wiki's own database
31 * Provides methods to retrieve paths (physical, logical, URL),
32 * to generate image thumbnails or for uploading.
34 * Note that only the repo object knows what its file class is called. You should
35 * never name a file class explictly outside of the repo class. Instead use the
36 * repo's factory functions to generate file objects, for example:
38 * RepoGroup::singleton()->getLocalRepo()->newFile( $title );
40 * The convenience functions wfLocalFile() and wfFindFile() should be sufficient
43 * @ingroup FileAbstraction
45 class LocalFile
extends File
{
46 const VERSION
= 11; // cache version
48 const CACHE_FIELD_MAX_LEN
= 1000;
50 /** @var bool Does the file exist on disk? (loadFromXxx) */
51 protected $fileExists;
53 /** @var int Image width */
56 /** @var int Image height */
59 /** @var int Returned by getimagesize (loadFromXxx) */
62 /** @var string MEDIATYPE_xxx (bitmap, drawing, audio...) */
63 protected $media_type;
65 /** @var string MIME type, determined by MimeMagic::guessMimeType */
68 /** @var int Size in bytes (loadFromXxx) */
71 /** @var string Handler-specific metadata */
74 /** @var string SHA-1 base 36 content hash */
77 /** @var bool Whether or not core data has been loaded from the database (loadFromXxx) */
78 protected $dataLoaded;
80 /** @var bool Whether or not lazy-loaded data has been loaded from the database */
81 protected $extraDataLoaded;
83 /** @var int Bitfield akin to rev_deleted */
87 protected $repoClass = 'LocalRepo';
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',
351 static $results = [];
353 if ( $prefix == '' ) {
354 return array_merge( $fields, [ 'description' ] );
356 if ( !isset( $results[$prefix] ) ) {
357 $prefixedFields = [];
358 foreach ( $fields as $field ) {
359 $prefixedFields[] = $prefix . $field;
361 $prefixedFields +
= CommentStore
::newKey( "{$prefix}description" )->getFields();
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 $this->description
= CommentStore
::newKey( "{$prefix}description" )
540 // $row is probably using getFields() from self::getCacheFields()
541 ->getCommentLegacy( wfGetDB( DB_REPLICA
), $row )->text
;
543 $array = $this->decodeRow( $row, $prefix );
545 foreach ( $array as $name => $value ) {
546 $this->$name = $value;
549 $this->fileExists
= true;
550 $this->maybeUpgradeRow();
554 * Load file metadata from cache or DB, unless already loaded
557 function load( $flags = 0 ) {
558 if ( !$this->dataLoaded
) {
559 if ( $flags & self
::READ_LATEST
) {
560 $this->loadFromDB( $flags );
562 $this->loadFromCache();
566 if ( ( $flags & self
::LOAD_ALL
) && !$this->extraDataLoaded
) {
567 // @note: loads on name/timestamp to reduce race condition problems
568 $this->loadExtraFromDB();
573 * Upgrade a row if it needs it
575 function maybeUpgradeRow() {
576 global $wgUpdateCompatibleMetadata;
578 if ( wfReadOnly() ||
$this->upgrading
) {
583 if ( is_null( $this->media_type
) ||
$this->mime
== 'image/svg' ) {
586 $handler = $this->getHandler();
588 $validity = $handler->isMetadataValid( $this, $this->getMetadata() );
589 if ( $validity === MediaHandler
::METADATA_BAD
) {
591 } elseif ( $validity === MediaHandler
::METADATA_COMPATIBLE
) {
592 $upgrade = $wgUpdateCompatibleMetadata;
598 $this->upgrading
= true;
599 // Defer updates unless in auto-commit CLI mode
600 DeferredUpdates
::addCallableUpdate( function () {
601 $this->upgrading
= false; // avoid duplicate updates
604 } catch ( LocalFileLockError
$e ) {
605 // let the other process handle it (or do it next time)
612 * @return bool Whether upgradeRow() ran for this object
614 function getUpgraded() {
615 return $this->upgraded
;
619 * Fix assorted version-related problems with the image row by reloading it from the file
621 function upgradeRow() {
622 $this->lock(); // begin
624 $this->loadFromFile();
626 # Don't destroy file info of missing files
627 if ( !$this->fileExists
) {
629 wfDebug( __METHOD__
. ": file does not exist, aborting\n" );
634 $dbw = $this->repo
->getMasterDB();
635 list( $major, $minor ) = self
::splitMime( $this->mime
);
637 if ( wfReadOnly() ) {
642 wfDebug( __METHOD__
. ': upgrading ' . $this->getName() . " to the current schema\n" );
644 $dbw->update( 'image',
646 'img_size' => $this->size
, // sanity
647 'img_width' => $this->width
,
648 'img_height' => $this->height
,
649 'img_bits' => $this->bits
,
650 'img_media_type' => $this->media_type
,
651 'img_major_mime' => $major,
652 'img_minor_mime' => $minor,
653 'img_metadata' => $dbw->encodeBlob( $this->metadata
),
654 'img_sha1' => $this->sha1
,
656 [ 'img_name' => $this->getName() ],
660 $this->invalidateCache();
662 $this->unlock(); // done
663 $this->upgraded
= true; // avoid rework/retries
667 * Set properties in this object to be equal to those given in the
668 * associative array $info. Only cacheable fields can be set.
669 * All fields *must* be set in $info except for getLazyCacheFields().
671 * If 'mime' is given, it will be split into major_mime/minor_mime.
672 * If major_mime/minor_mime are given, $this->mime will also be set.
676 function setProps( $info ) {
677 $this->dataLoaded
= true;
678 $fields = $this->getCacheFields( '' );
679 $fields[] = 'fileExists';
681 foreach ( $fields as $field ) {
682 if ( isset( $info[$field] ) ) {
683 $this->$field = $info[$field];
687 // Fix up mime fields
688 if ( isset( $info['major_mime'] ) ) {
689 $this->mime
= "{$info['major_mime']}/{$info['minor_mime']}";
690 } elseif ( isset( $info['mime'] ) ) {
691 $this->mime
= $info['mime'];
692 list( $this->major_mime
, $this->minor_mime
) = self
::splitMime( $this->mime
);
696 /** splitMime inherited */
697 /** getName inherited */
698 /** getTitle inherited */
699 /** getURL inherited */
700 /** getViewURL inherited */
701 /** getPath inherited */
702 /** isVisible inherited */
707 function isMissing() {
708 if ( $this->missing
=== null ) {
709 list( $fileExists ) = $this->repo
->fileExists( $this->getVirtualUrl() );
710 $this->missing
= !$fileExists;
713 return $this->missing
;
717 * Return the width of the image
722 public function getWidth( $page = 1 ) {
730 if ( $this->isMultipage() ) {
731 $handler = $this->getHandler();
735 $dim = $handler->getPageDimensions( $this, $page );
737 return $dim['width'];
739 // For non-paged media, the false goes through an
740 // intval, turning failure into 0, so do same here.
749 * Return the height of the image
754 public function getHeight( $page = 1 ) {
762 if ( $this->isMultipage() ) {
763 $handler = $this->getHandler();
767 $dim = $handler->getPageDimensions( $this, $page );
769 return $dim['height'];
771 // For non-paged media, the false goes through an
772 // intval, turning failure into 0, so do same here.
776 return $this->height
;
781 * Returns ID or name of user who uploaded the file
783 * @param string $type 'text' or 'id'
786 function getUser( $type = 'text' ) {
789 if ( $type == 'text' ) {
790 return $this->user_text
;
792 return (int)$this->user
;
797 * Get short description URL for a file based on the page ID.
799 * @return string|null
800 * @throws MWException
803 public function getDescriptionShortUrl() {
804 $pageId = $this->title
->getArticleID();
806 if ( $pageId !== null ) {
807 $url = $this->repo
->makeUrl( [ 'curid' => $pageId ] );
808 if ( $url !== false ) {
816 * Get handler-specific metadata
819 function getMetadata() {
820 $this->load( self
::LOAD_ALL
); // large metadata is loaded in another step
821 return $this->metadata
;
827 function getBitDepth() {
830 return (int)$this->bits
;
834 * Returns the size of the image file, in bytes
837 public function getSize() {
844 * Returns the MIME type of the file.
847 function getMimeType() {
854 * Returns the type of the media in the file.
855 * Use the value returned by this function with the MEDIATYPE_xxx constants.
858 function getMediaType() {
861 return $this->media_type
;
864 /** canRender inherited */
865 /** mustRender inherited */
866 /** allowInlineDisplay inherited */
867 /** isSafeFile inherited */
868 /** isTrustedFile inherited */
871 * Returns true if the file exists on disk.
872 * @return bool Whether file exist on disk.
874 public function exists() {
877 return $this->fileExists
;
880 /** getTransformScript inherited */
881 /** getUnscaledThumb inherited */
882 /** thumbName inherited */
883 /** createThumb inherited */
884 /** transform inherited */
886 /** getHandler inherited */
887 /** iconThumb inherited */
888 /** getLastError inherited */
891 * Get all thumbnail names previously generated for this file
892 * @param string|bool $archiveName Name of an archive file, default false
893 * @return array First element is the base dir, then files in that base dir.
895 function getThumbnails( $archiveName = false ) {
896 if ( $archiveName ) {
897 $dir = $this->getArchiveThumbPath( $archiveName );
899 $dir = $this->getThumbPath();
902 $backend = $this->repo
->getBackend();
905 $iterator = $backend->getFileList( [ 'dir' => $dir ] );
906 foreach ( $iterator as $file ) {
909 } catch ( FileBackendError
$e ) {
910 } // suppress (T56674)
916 * Refresh metadata in memcached, but don't touch thumbnails or CDN
918 function purgeMetadataCache() {
919 $this->invalidateCache();
923 * Delete all previously generated thumbnails, refresh metadata in memcached and purge the CDN.
925 * @param array $options An array potentially with the key forThumbRefresh.
927 * @note This used to purge old thumbnails by default as well, but doesn't anymore.
929 function purgeCache( $options = [] ) {
930 // Refresh metadata cache
931 $this->purgeMetadataCache();
934 $this->purgeThumbnails( $options );
936 // Purge CDN cache for this file
937 DeferredUpdates
::addUpdate(
938 new CdnCacheUpdate( [ $this->getUrl() ] ),
939 DeferredUpdates
::PRESEND
944 * Delete cached transformed files for an archived version only.
945 * @param string $archiveName Name of the archived file
947 function purgeOldThumbnails( $archiveName ) {
948 // Get a list of old thumbnails and URLs
949 $files = $this->getThumbnails( $archiveName );
951 // Purge any custom thumbnail caches
952 Hooks
::run( 'LocalFilePurgeThumbnails', [ $this, $archiveName ] );
955 $dir = array_shift( $files );
956 $this->purgeThumbList( $dir, $files );
960 foreach ( $files as $file ) {
961 $urls[] = $this->getArchiveThumbUrl( $archiveName, $file );
963 DeferredUpdates
::addUpdate( new CdnCacheUpdate( $urls ), DeferredUpdates
::PRESEND
);
967 * Delete cached transformed files for the current version only.
968 * @param array $options
970 public function purgeThumbnails( $options = [] ) {
971 $files = $this->getThumbnails();
972 // Always purge all files from CDN regardless of handler filters
974 foreach ( $files as $file ) {
975 $urls[] = $this->getThumbUrl( $file );
977 array_shift( $urls ); // don't purge directory
979 // Give media handler a chance to filter the file purge list
980 if ( !empty( $options['forThumbRefresh'] ) ) {
981 $handler = $this->getHandler();
983 $handler->filterThumbnailPurgeList( $files, $options );
987 // Purge any custom thumbnail caches
988 Hooks
::run( 'LocalFilePurgeThumbnails', [ $this, false ] );
991 $dir = array_shift( $files );
992 $this->purgeThumbList( $dir, $files );
995 DeferredUpdates
::addUpdate( new CdnCacheUpdate( $urls ), DeferredUpdates
::PRESEND
);
999 * Prerenders a configurable set of thumbnails
1003 public function prerenderThumbnails() {
1004 global $wgUploadThumbnailRenderMap;
1008 $sizes = $wgUploadThumbnailRenderMap;
1011 foreach ( $sizes as $size ) {
1012 if ( $this->isVectorized() ||
$this->getWidth() > $size ) {
1013 $jobs[] = new ThumbnailRenderJob(
1015 [ 'transformParams' => [ 'width' => $size ] ]
1021 JobQueueGroup
::singleton()->lazyPush( $jobs );
1026 * Delete a list of thumbnails visible at urls
1027 * @param string $dir Base dir of the files.
1028 * @param array $files Array of strings: relative filenames (to $dir)
1030 protected function purgeThumbList( $dir, $files ) {
1031 $fileListDebug = strtr(
1032 var_export( $files, true ),
1035 wfDebug( __METHOD__
. ": $fileListDebug\n" );
1038 foreach ( $files as $file ) {
1039 if ( $this->repo
->supportsSha1URLs() ) {
1040 $reference = $this->getSha1();
1042 $reference = $this->getName();
1045 # Check that the reference (filename or sha1) is part of the thumb name
1046 # This is a basic sanity check to avoid erasing unrelated directories
1047 if ( strpos( $file, $reference ) !== false
1048 ||
strpos( $file, "-thumbnail" ) !== false // "short" thumb name
1050 $purgeList[] = "{$dir}/{$file}";
1054 # Delete the thumbnails
1055 $this->repo
->quickPurgeBatch( $purgeList );
1056 # Clear out the thumbnail directory if empty
1057 $this->repo
->quickCleanDir( $dir );
1060 /** purgeDescription inherited */
1061 /** purgeEverything inherited */
1064 * @param int $limit Optional: Limit to number of results
1065 * @param int $start Optional: Timestamp, start from
1066 * @param int $end Optional: Timestamp, end at
1068 * @return OldLocalFile[]
1070 function getHistory( $limit = null, $start = null, $end = null, $inc = true ) {
1071 $dbr = $this->repo
->getReplicaDB();
1072 $tables = [ 'oldimage' ];
1073 $fields = OldLocalFile
::selectFields();
1074 $conds = $opts = $join_conds = [];
1075 $eq = $inc ?
'=' : '';
1076 $conds[] = "oi_name = " . $dbr->addQuotes( $this->title
->getDBkey() );
1079 $conds[] = "oi_timestamp <$eq " . $dbr->addQuotes( $dbr->timestamp( $start ) );
1083 $conds[] = "oi_timestamp >$eq " . $dbr->addQuotes( $dbr->timestamp( $end ) );
1087 $opts['LIMIT'] = $limit;
1090 // Search backwards for time > x queries
1091 $order = ( !$start && $end !== null ) ?
'ASC' : 'DESC';
1092 $opts['ORDER BY'] = "oi_timestamp $order";
1093 $opts['USE INDEX'] = [ 'oldimage' => 'oi_name_timestamp' ];
1095 // Avoid PHP 7.1 warning from passing $this by reference
1097 Hooks
::run( 'LocalFile::getHistory', [ &$localFile, &$tables, &$fields,
1098 &$conds, &$opts, &$join_conds ] );
1100 $res = $dbr->select( $tables, $fields, $conds, __METHOD__
, $opts, $join_conds );
1103 foreach ( $res as $row ) {
1104 $r[] = $this->repo
->newFileFromRow( $row );
1107 if ( $order == 'ASC' ) {
1108 $r = array_reverse( $r ); // make sure it ends up descending
1115 * Returns the history of this file, line by line.
1116 * starts with current version, then old versions.
1117 * uses $this->historyLine to check which line to return:
1118 * 0 return line for current version
1119 * 1 query for old versions, return first one
1120 * 2, ... return next old version from above query
1123 public function nextHistoryLine() {
1124 # Polymorphic function name to distinguish foreign and local fetches
1125 $fname = static::class . '::' . __FUNCTION__
;
1127 $dbr = $this->repo
->getReplicaDB();
1129 if ( $this->historyLine
== 0 ) { // called for the first time, return line from cur
1130 $this->historyRes
= $dbr->select( 'image',
1131 self
::selectFields() +
[
1132 'oi_archive_name' => $dbr->addQuotes( '' ),
1135 [ 'img_name' => $this->title
->getDBkey() ],
1139 if ( 0 == $dbr->numRows( $this->historyRes
) ) {
1140 $this->historyRes
= null;
1144 } elseif ( $this->historyLine
== 1 ) {
1145 $this->historyRes
= $dbr->select(
1147 OldLocalFile
::selectFields(),
1148 [ 'oi_name' => $this->title
->getDBkey() ],
1150 [ 'ORDER BY' => 'oi_timestamp DESC' ]
1153 $this->historyLine++
;
1155 return $dbr->fetchObject( $this->historyRes
);
1159 * Reset the history pointer to the first element of the history
1161 public function resetHistory() {
1162 $this->historyLine
= 0;
1164 if ( !is_null( $this->historyRes
) ) {
1165 $this->historyRes
= null;
1169 /** getHashPath inherited */
1170 /** getRel inherited */
1171 /** getUrlRel inherited */
1172 /** getArchiveRel inherited */
1173 /** getArchivePath inherited */
1174 /** getThumbPath inherited */
1175 /** getArchiveUrl inherited */
1176 /** getThumbUrl inherited */
1177 /** getArchiveVirtualUrl inherited */
1178 /** getThumbVirtualUrl inherited */
1179 /** isHashed inherited */
1182 * Upload a file and record it in the DB
1183 * @param string|FSFile $src Source storage path, virtual URL, or filesystem path
1184 * @param string $comment Upload description
1185 * @param string $pageText Text to use for the new description page,
1186 * if a new description page is created
1187 * @param int|bool $flags Flags for publish()
1188 * @param array|bool $props File properties, if known. This can be used to
1189 * reduce the upload time when uploading virtual URLs for which the file
1190 * info is already known
1191 * @param string|bool $timestamp Timestamp for img_timestamp, or false to use the
1193 * @param User|null $user User object or null to use $wgUser
1194 * @param string[] $tags Change tags to add to the log entry and page revision.
1195 * (This doesn't check $user's permissions.)
1196 * @return Status On success, the value member contains the
1197 * archive name, or an empty string if it was a new file.
1199 function upload( $src, $comment, $pageText, $flags = 0, $props = false,
1200 $timestamp = false, $user = null, $tags = []
1202 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
1203 return $this->readOnlyFatalStatus();
1206 $srcPath = ( $src instanceof FSFile
) ?
$src->getPath() : $src;
1208 if ( $this->repo
->isVirtualUrl( $srcPath )
1209 || FileBackend
::isStoragePath( $srcPath )
1211 $props = $this->repo
->getFileProps( $srcPath );
1213 $mwProps = new MWFileProps( MimeMagic
::singleton() );
1214 $props = $mwProps->getPropsFromPath( $srcPath, true );
1219 $handler = MediaHandler
::getHandler( $props['mime'] );
1221 $metadata = MediaWiki\
quietCall( 'unserialize', $props['metadata'] );
1223 if ( !is_array( $metadata ) ) {
1227 $options['headers'] = $handler->getContentHeaders( $metadata );
1229 $options['headers'] = [];
1232 // Trim spaces on user supplied text
1233 $comment = trim( $comment );
1235 $this->lock(); // begin
1236 $status = $this->publish( $src, $flags, $options );
1238 if ( $status->successCount
>= 2 ) {
1239 // There will be a copy+(one of move,copy,store).
1240 // The first succeeding does not commit us to updating the DB
1241 // since it simply copied the current version to a timestamped file name.
1242 // It is only *preferable* to avoid leaving such files orphaned.
1243 // Once the second operation goes through, then the current version was
1244 // updated and we must therefore update the DB too.
1245 $oldver = $status->value
;
1246 $uploadStatus = $this->recordUpload2(
1255 if ( !$uploadStatus->isOK() ) {
1256 if ( $uploadStatus->hasMessage( 'filenotfound' ) ) {
1257 // update filenotfound error with more specific path
1258 $status->fatal( 'filenotfound', $srcPath );
1260 $status->merge( $uploadStatus );
1265 $this->unlock(); // done
1271 * Record a file upload in the upload log and the image table
1272 * @param string $oldver
1273 * @param string $desc
1274 * @param string $license
1275 * @param string $copyStatus
1276 * @param string $source
1277 * @param bool $watch
1278 * @param string|bool $timestamp
1279 * @param User|null $user User object or null to use $wgUser
1282 function recordUpload( $oldver, $desc, $license = '', $copyStatus = '', $source = '',
1283 $watch = false, $timestamp = false, User
$user = null ) {
1289 $pageText = SpecialUpload
::getInitialPageText( $desc, $license, $copyStatus, $source );
1291 if ( !$this->recordUpload2( $oldver, $desc, $pageText, false, $timestamp, $user )->isOK() ) {
1296 $user->addWatch( $this->getTitle() );
1303 * Record a file upload in the upload log and the image table
1304 * @param string $oldver
1305 * @param string $comment
1306 * @param string $pageText
1307 * @param bool|array $props
1308 * @param string|bool $timestamp
1309 * @param null|User $user
1310 * @param string[] $tags
1313 function recordUpload2(
1314 $oldver, $comment, $pageText, $props = false, $timestamp = false, $user = null, $tags = []
1316 global $wgCommentTableSchemaMigrationStage;
1318 if ( is_null( $user ) ) {
1323 $dbw = $this->repo
->getMasterDB();
1325 # Imports or such might force a certain timestamp; otherwise we generate
1326 # it and can fudge it slightly to keep (name,timestamp) unique on re-upload.
1327 if ( $timestamp === false ) {
1328 $timestamp = $dbw->timestamp();
1329 $allowTimeKludge = true;
1331 $allowTimeKludge = false;
1334 $props = $props ?
: $this->repo
->getFileProps( $this->getVirtualUrl() );
1335 $props['description'] = $comment;
1336 $props['user'] = $user->getId();
1337 $props['user_text'] = $user->getName();
1338 $props['timestamp'] = wfTimestamp( TS_MW
, $timestamp ); // DB -> TS_MW
1339 $this->setProps( $props );
1341 # Fail now if the file isn't there
1342 if ( !$this->fileExists
) {
1343 wfDebug( __METHOD__
. ": File " . $this->getRel() . " went missing!\n" );
1345 return Status
::newFatal( 'filenotfound', $this->getRel() );
1348 $dbw->startAtomic( __METHOD__
);
1350 # Test to see if the row exists using INSERT IGNORE
1351 # This avoids race conditions by locking the row until the commit, and also
1352 # doesn't deadlock. SELECT FOR UPDATE causes a deadlock for every race condition.
1353 $commentStore = new CommentStore( 'img_description' );
1354 list( $commentFields, $commentCallback ) =
1355 $commentStore->insertWithTempTable( $dbw, $comment );
1356 $dbw->insert( 'image',
1358 'img_name' => $this->getName(),
1359 'img_size' => $this->size
,
1360 'img_width' => intval( $this->width
),
1361 'img_height' => intval( $this->height
),
1362 'img_bits' => $this->bits
,
1363 'img_media_type' => $this->media_type
,
1364 'img_major_mime' => $this->major_mime
,
1365 'img_minor_mime' => $this->minor_mime
,
1366 'img_timestamp' => $timestamp,
1367 'img_user' => $user->getId(),
1368 'img_user_text' => $user->getName(),
1369 'img_metadata' => $dbw->encodeBlob( $this->metadata
),
1370 'img_sha1' => $this->sha1
1375 $reupload = ( $dbw->affectedRows() == 0 );
1378 $row = $dbw->selectRow(
1380 [ 'img_timestamp', 'img_sha1' ],
1381 [ 'img_name' => $this->getName() ],
1383 [ 'LOCK IN SHARE MODE' ]
1386 if ( $row && $row->img_sha1
=== $this->sha1
) {
1387 $dbw->endAtomic( __METHOD__
);
1388 wfDebug( __METHOD__
. ": File " . $this->getRel() . " already exists!\n" );
1389 $title = Title
::newFromText( $this->getName(), NS_FILE
);
1390 return Status
::newFatal( 'fileexists-no-change', $title->getPrefixedText() );
1393 if ( $allowTimeKludge ) {
1394 # Use LOCK IN SHARE MODE to ignore any transaction snapshotting
1395 $lUnixtime = $row ?
wfTimestamp( TS_UNIX
, $row->img_timestamp
) : false;
1396 # Avoid a timestamp that is not newer than the last version
1397 # TODO: the image/oldimage tables should be like page/revision with an ID field
1398 if ( $lUnixtime && wfTimestamp( TS_UNIX
, $timestamp ) <= $lUnixtime ) {
1399 sleep( 1 ); // fast enough re-uploads would go far in the future otherwise
1400 $timestamp = $dbw->timestamp( $lUnixtime +
1 );
1401 $this->timestamp
= wfTimestamp( TS_MW
, $timestamp ); // DB -> TS_MW
1405 $tables = [ 'image' ];
1407 'oi_name' => 'img_name',
1408 'oi_archive_name' => $dbw->addQuotes( $oldver ),
1409 'oi_size' => 'img_size',
1410 'oi_width' => 'img_width',
1411 'oi_height' => 'img_height',
1412 'oi_bits' => 'img_bits',
1413 'oi_timestamp' => 'img_timestamp',
1414 'oi_user' => 'img_user',
1415 'oi_user_text' => 'img_user_text',
1416 'oi_metadata' => 'img_metadata',
1417 'oi_media_type' => 'img_media_type',
1418 'oi_major_mime' => 'img_major_mime',
1419 'oi_minor_mime' => 'img_minor_mime',
1420 'oi_sha1' => 'img_sha1',
1424 if ( $wgCommentTableSchemaMigrationStage <= MIGRATION_WRITE_BOTH
) {
1425 $fields['oi_description'] = 'img_description';
1427 if ( $wgCommentTableSchemaMigrationStage >= MIGRATION_WRITE_BOTH
) {
1428 $tables[] = 'image_comment_temp';
1429 $fields['oi_description_id'] = 'imgcomment_description_id';
1430 $joins['image_comment_temp'] = [
1431 $wgCommentTableSchemaMigrationStage === MIGRATION_NEW ?
'JOIN' : 'LEFT JOIN',
1432 [ 'imgcomment_name = img_name' ]
1436 if ( $wgCommentTableSchemaMigrationStage !== MIGRATION_OLD
&&
1437 $wgCommentTableSchemaMigrationStage !== MIGRATION_NEW
1439 // Upgrade any rows that are still old-style. Otherwise an upgrade
1440 // might be missed if a deletion happens while the migration script
1442 $res = $dbw->select(
1443 [ 'image', 'image_comment_temp' ],
1444 [ 'img_name', 'img_description' ],
1445 [ 'img_name' => $this->getName(), 'imgcomment_name' => null ],
1448 [ 'image_comment_temp' => [ 'LEFT JOIN', [ 'imgcomment_name = img_name' ] ] ]
1450 foreach ( $res as $row ) {
1451 list( , $callback ) = $commentStore->insertWithTempTable( $dbw, $row->img_description
);
1452 $callback( $row->img_name
);
1456 # (T36993) Note: $oldver can be empty here, if the previous
1457 # version of the file was broken. Allow registration of the new
1458 # version to continue anyway, because that's better than having
1459 # an image that's not fixable by user operations.
1460 # Collision, this is an update of a file
1461 # Insert previous contents into oldimage
1462 $dbw->insertSelect( 'oldimage', $tables, $fields,
1463 [ 'img_name' => $this->getName() ], __METHOD__
, [], [], $joins );
1465 # Update the current image row
1466 $dbw->update( 'image',
1468 'img_size' => $this->size
,
1469 'img_width' => intval( $this->width
),
1470 'img_height' => intval( $this->height
),
1471 'img_bits' => $this->bits
,
1472 'img_media_type' => $this->media_type
,
1473 'img_major_mime' => $this->major_mime
,
1474 'img_minor_mime' => $this->minor_mime
,
1475 'img_timestamp' => $timestamp,
1476 'img_user' => $user->getId(),
1477 'img_user_text' => $user->getName(),
1478 'img_metadata' => $dbw->encodeBlob( $this->metadata
),
1479 'img_sha1' => $this->sha1
1481 [ 'img_name' => $this->getName() ],
1484 if ( $wgCommentTableSchemaMigrationStage > MIGRATION_OLD
) {
1485 // So $commentCallback can insert the new row
1486 $dbw->delete( 'image_comment_temp', [ 'imgcomment_name' => $this->getName() ], __METHOD__
);
1489 $commentCallback( $this->getName() );
1491 $descTitle = $this->getTitle();
1492 $descId = $descTitle->getArticleID();
1493 $wikiPage = new WikiFilePage( $descTitle );
1494 $wikiPage->setFile( $this );
1496 // Add the log entry...
1497 $logEntry = new ManualLogEntry( 'upload', $reupload ?
'overwrite' : 'upload' );
1498 $logEntry->setTimestamp( $this->timestamp
);
1499 $logEntry->setPerformer( $user );
1500 $logEntry->setComment( $comment );
1501 $logEntry->setTarget( $descTitle );
1502 // Allow people using the api to associate log entries with the upload.
1503 // Log has a timestamp, but sometimes different from upload timestamp.
1504 $logEntry->setParameters(
1506 'img_sha1' => $this->sha1
,
1507 'img_timestamp' => $timestamp,
1510 // Note we keep $logId around since during new image
1511 // creation, page doesn't exist yet, so log_page = 0
1512 // but we want it to point to the page we're making,
1513 // so we later modify the log entry.
1514 // For a similar reason, we avoid making an RC entry
1515 // now and wait until the page exists.
1516 $logId = $logEntry->insert();
1518 if ( $descTitle->exists() ) {
1519 // Use own context to get the action text in content language
1520 $formatter = LogFormatter
::newFromEntry( $logEntry );
1521 $formatter->setContext( RequestContext
::newExtraneousContext( $descTitle ) );
1522 $editSummary = $formatter->getPlainActionText();
1524 $nullRevision = Revision
::newNullRevision(
1531 if ( $nullRevision ) {
1532 $nullRevision->insertOn( $dbw );
1534 'NewRevisionFromEditComplete',
1535 [ $wikiPage, $nullRevision, $nullRevision->getParentId(), $user ]
1537 $wikiPage->updateRevisionOn( $dbw, $nullRevision );
1538 // Associate null revision id
1539 $logEntry->setAssociatedRevId( $nullRevision->getId() );
1542 $newPageContent = null;
1544 // Make the description page and RC log entry post-commit
1545 $newPageContent = ContentHandler
::makeContent( $pageText, $descTitle );
1548 # Defer purges, page creation, and link updates in case they error out.
1549 # The most important thing is that files and the DB registry stay synced.
1550 $dbw->endAtomic( __METHOD__
);
1552 # Do some cache purges after final commit so that:
1553 # a) Changes are more likely to be seen post-purge
1554 # b) They won't cause rollback of the log publish/update above
1555 DeferredUpdates
::addUpdate(
1556 new AutoCommitUpdate(
1560 $reupload, $wikiPage, $newPageContent, $comment, $user,
1561 $logEntry, $logId, $descId, $tags
1563 # Update memcache after the commit
1564 $this->invalidateCache();
1566 $updateLogPage = false;
1567 if ( $newPageContent ) {
1568 # New file page; create the description page.
1569 # There's already a log entry, so don't make a second RC entry
1570 # CDN and file cache for the description page are purged by doEditContent.
1571 $status = $wikiPage->doEditContent(
1574 EDIT_NEW | EDIT_SUPPRESS_RC
,
1579 if ( isset( $status->value
['revision'] ) ) {
1580 /** @var Revision $rev */
1581 $rev = $status->value
['revision'];
1582 // Associate new page revision id
1583 $logEntry->setAssociatedRevId( $rev->getId() );
1585 // This relies on the resetArticleID() call in WikiPage::insertOn(),
1586 // which is triggered on $descTitle by doEditContent() above.
1587 if ( isset( $status->value
['revision'] ) ) {
1588 /** @var Revision $rev */
1589 $rev = $status->value
['revision'];
1590 $updateLogPage = $rev->getPage();
1593 # Existing file page: invalidate description page cache
1594 $wikiPage->getTitle()->invalidateCache();
1595 $wikiPage->getTitle()->purgeSquid();
1596 # Allow the new file version to be patrolled from the page footer
1597 Article
::purgePatrolFooterCache( $descId );
1600 # Update associated rev id. This should be done by $logEntry->insert() earlier,
1601 # but setAssociatedRevId() wasn't called at that point yet...
1602 $logParams = $logEntry->getParameters();
1603 $logParams['associated_rev_id'] = $logEntry->getAssociatedRevId();
1604 $update = [ 'log_params' => LogEntryBase
::makeParamBlob( $logParams ) ];
1605 if ( $updateLogPage ) {
1606 # Also log page, in case where we just created it above
1607 $update['log_page'] = $updateLogPage;
1609 $this->getRepo()->getMasterDB()->update(
1612 [ 'log_id' => $logId ],
1615 $this->getRepo()->getMasterDB()->insert(
1618 'ls_field' => 'associated_rev_id',
1619 'ls_value' => $logEntry->getAssociatedRevId(),
1620 'ls_log_id' => $logId,
1625 # Add change tags, if any
1627 $logEntry->setTags( $tags );
1630 # Uploads can be patrolled
1631 $logEntry->setIsPatrollable( true );
1633 # Now that the log entry is up-to-date, make an RC entry.
1634 $logEntry->publish( $logId );
1636 # Run hook for other updates (typically more cache purging)
1637 Hooks
::run( 'FileUpload', [ $this, $reupload, !$newPageContent ] );
1640 # Delete old thumbnails
1641 $this->purgeThumbnails();
1642 # Remove the old file from the CDN cache
1643 DeferredUpdates
::addUpdate(
1644 new CdnCacheUpdate( [ $this->getUrl() ] ),
1645 DeferredUpdates
::PRESEND
1648 # Update backlink pages pointing to this title if created
1649 LinksUpdate
::queueRecursiveJobsForTable(
1657 $this->prerenderThumbnails();
1660 DeferredUpdates
::PRESEND
1664 # This is a new file, so update the image count
1665 DeferredUpdates
::addUpdate( SiteStatsUpdate
::factory( [ 'images' => 1 ] ) );
1668 # Invalidate cache for all pages using this file
1669 DeferredUpdates
::addUpdate( new HTMLCacheUpdate( $this->getTitle(), 'imagelinks' ) );
1671 return Status
::newGood();
1675 * Move or copy a file to its public location. If a file exists at the
1676 * destination, move it to an archive. Returns a Status object with
1677 * the archive name in the "value" member on success.
1679 * The archive name should be passed through to recordUpload for database
1682 * @param string|FSFile $src Local filesystem path or virtual URL to the source image
1683 * @param int $flags A bitwise combination of:
1684 * File::DELETE_SOURCE Delete the source file, i.e. move rather than copy
1685 * @param array $options Optional additional parameters
1686 * @return Status On success, the value member contains the
1687 * archive name, or an empty string if it was a new file.
1689 function publish( $src, $flags = 0, array $options = [] ) {
1690 return $this->publishTo( $src, $this->getRel(), $flags, $options );
1694 * Move or copy a file to a specified location. Returns a Status
1695 * object with the archive name in the "value" member on success.
1697 * The archive name should be passed through to recordUpload for database
1700 * @param string|FSFile $src Local filesystem path or virtual URL to the source image
1701 * @param string $dstRel Target relative path
1702 * @param int $flags A bitwise combination of:
1703 * File::DELETE_SOURCE Delete the source file, i.e. move rather than copy
1704 * @param array $options Optional additional parameters
1705 * @return Status On success, the value member contains the
1706 * archive name, or an empty string if it was a new file.
1708 function publishTo( $src, $dstRel, $flags = 0, array $options = [] ) {
1709 $srcPath = ( $src instanceof FSFile
) ?
$src->getPath() : $src;
1711 $repo = $this->getRepo();
1712 if ( $repo->getReadOnlyReason() !== false ) {
1713 return $this->readOnlyFatalStatus();
1716 $this->lock(); // begin
1718 $archiveName = wfTimestamp( TS_MW
) . '!' . $this->getName();
1719 $archiveRel = 'archive/' . $this->getHashPath() . $archiveName;
1721 if ( $repo->hasSha1Storage() ) {
1722 $sha1 = $repo->isVirtualUrl( $srcPath )
1723 ?
$repo->getFileSha1( $srcPath )
1724 : FSFile
::getSha1Base36FromPath( $srcPath );
1725 /** @var FileBackendDBRepoWrapper $wrapperBackend */
1726 $wrapperBackend = $repo->getBackend();
1727 $dst = $wrapperBackend->getPathForSHA1( $sha1 );
1728 $status = $repo->quickImport( $src, $dst );
1729 if ( $flags & File
::DELETE_SOURCE
) {
1733 if ( $this->exists() ) {
1734 $status->value
= $archiveName;
1737 $flags = $flags & File
::DELETE_SOURCE ? LocalRepo
::DELETE_SOURCE
: 0;
1738 $status = $repo->publish( $srcPath, $dstRel, $archiveRel, $flags, $options );
1740 if ( $status->value
== 'new' ) {
1741 $status->value
= '';
1743 $status->value
= $archiveName;
1747 $this->unlock(); // done
1752 /** getLinksTo inherited */
1753 /** getExifData inherited */
1754 /** isLocal inherited */
1755 /** wasDeleted inherited */
1758 * Move file to the new title
1760 * Move current, old version and all thumbnails
1761 * to the new filename. Old file is deleted.
1763 * Cache purging is done; checks for validity
1764 * and logging are caller's responsibility
1766 * @param Title $target New file name
1769 function move( $target ) {
1770 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
1771 return $this->readOnlyFatalStatus();
1774 wfDebugLog( 'imagemove', "Got request to move {$this->name} to " . $target->getText() );
1775 $batch = new LocalFileMoveBatch( $this, $target );
1777 $this->lock(); // begin
1778 $batch->addCurrent();
1779 $archiveNames = $batch->addOlds();
1780 $status = $batch->execute();
1781 $this->unlock(); // done
1783 wfDebugLog( 'imagemove', "Finished moving {$this->name}" );
1785 // Purge the source and target files...
1786 $oldTitleFile = wfLocalFile( $this->title
);
1787 $newTitleFile = wfLocalFile( $target );
1788 // To avoid slow purges in the transaction, move them outside...
1789 DeferredUpdates
::addUpdate(
1790 new AutoCommitUpdate(
1791 $this->getRepo()->getMasterDB(),
1793 function () use ( $oldTitleFile, $newTitleFile, $archiveNames ) {
1794 $oldTitleFile->purgeEverything();
1795 foreach ( $archiveNames as $archiveName ) {
1796 $oldTitleFile->purgeOldThumbnails( $archiveName );
1798 $newTitleFile->purgeEverything();
1801 DeferredUpdates
::PRESEND
1804 if ( $status->isOK() ) {
1805 // Now switch the object
1806 $this->title
= $target;
1807 // Force regeneration of the name and hashpath
1808 unset( $this->name
);
1809 unset( $this->hashPath
);
1816 * Delete all versions of the file.
1818 * Moves the files into an archive directory (or deletes them)
1819 * and removes the database rows.
1821 * Cache purging is done; logging is caller's responsibility.
1823 * @param string $reason
1824 * @param bool $suppress
1825 * @param User|null $user
1828 function delete( $reason, $suppress = false, $user = null ) {
1829 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
1830 return $this->readOnlyFatalStatus();
1833 $batch = new LocalFileDeleteBatch( $this, $reason, $suppress, $user );
1835 $this->lock(); // begin
1836 $batch->addCurrent();
1837 // Get old version relative paths
1838 $archiveNames = $batch->addOlds();
1839 $status = $batch->execute();
1840 $this->unlock(); // done
1842 if ( $status->isOK() ) {
1843 DeferredUpdates
::addUpdate( SiteStatsUpdate
::factory( [ 'images' => -1 ] ) );
1846 // To avoid slow purges in the transaction, move them outside...
1847 DeferredUpdates
::addUpdate(
1848 new AutoCommitUpdate(
1849 $this->getRepo()->getMasterDB(),
1851 function () use ( $archiveNames ) {
1852 $this->purgeEverything();
1853 foreach ( $archiveNames as $archiveName ) {
1854 $this->purgeOldThumbnails( $archiveName );
1858 DeferredUpdates
::PRESEND
1863 foreach ( $archiveNames as $archiveName ) {
1864 $purgeUrls[] = $this->getArchiveUrl( $archiveName );
1866 DeferredUpdates
::addUpdate( new CdnCacheUpdate( $purgeUrls ), DeferredUpdates
::PRESEND
);
1872 * Delete an old version of the file.
1874 * Moves the file into an archive directory (or deletes it)
1875 * and removes the database row.
1877 * Cache purging is done; logging is caller's responsibility.
1879 * @param string $archiveName
1880 * @param string $reason
1881 * @param bool $suppress
1882 * @param User|null $user
1883 * @throws MWException Exception on database or file store failure
1886 function deleteOld( $archiveName, $reason, $suppress = false, $user = null ) {
1887 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
1888 return $this->readOnlyFatalStatus();
1891 $batch = new LocalFileDeleteBatch( $this, $reason, $suppress, $user );
1893 $this->lock(); // begin
1894 $batch->addOld( $archiveName );
1895 $status = $batch->execute();
1896 $this->unlock(); // done
1898 $this->purgeOldThumbnails( $archiveName );
1899 if ( $status->isOK() ) {
1900 $this->purgeDescription();
1903 DeferredUpdates
::addUpdate(
1904 new CdnCacheUpdate( [ $this->getArchiveUrl( $archiveName ) ] ),
1905 DeferredUpdates
::PRESEND
1912 * Restore all or specified deleted revisions to the given file.
1913 * Permissions and logging are left to the caller.
1915 * May throw database exceptions on error.
1917 * @param array $versions Set of record ids of deleted items to restore,
1918 * or empty to restore all revisions.
1919 * @param bool $unsuppress
1922 function restore( $versions = [], $unsuppress = false ) {
1923 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
1924 return $this->readOnlyFatalStatus();
1927 $batch = new LocalFileRestoreBatch( $this, $unsuppress );
1929 $this->lock(); // begin
1933 $batch->addIds( $versions );
1935 $status = $batch->execute();
1936 if ( $status->isGood() ) {
1937 $cleanupStatus = $batch->cleanup();
1938 $cleanupStatus->successCount
= 0;
1939 $cleanupStatus->failCount
= 0;
1940 $status->merge( $cleanupStatus );
1942 $this->unlock(); // done
1947 /** isMultipage inherited */
1948 /** pageCount inherited */
1949 /** scaleHeight inherited */
1950 /** getImageSize inherited */
1953 * Get the URL of the file description page.
1956 function getDescriptionUrl() {
1957 return $this->title
->getLocalURL();
1961 * Get the HTML text of the description page
1962 * This is not used by ImagePage for local files, since (among other things)
1963 * it skips the parser cache.
1965 * @param Language $lang What language to get description in (Optional)
1966 * @return bool|mixed
1968 function getDescriptionText( $lang = null ) {
1969 $revision = Revision
::newFromTitle( $this->title
, false, Revision
::READ_NORMAL
);
1973 $content = $revision->getContent();
1977 $pout = $content->getParserOutput( $this->title
, null, new ParserOptions( null, $lang ) );
1979 return $pout->getText();
1983 * @param int $audience
1987 function getDescription( $audience = self
::FOR_PUBLIC
, User
$user = null ) {
1989 if ( $audience == self
::FOR_PUBLIC
&& $this->isDeleted( self
::DELETED_COMMENT
) ) {
1991 } elseif ( $audience == self
::FOR_THIS_USER
1992 && !$this->userCan( self
::DELETED_COMMENT
, $user )
1996 return $this->description
;
2001 * @return bool|string
2003 function getTimestamp() {
2006 return $this->timestamp
;
2010 * @return bool|string
2012 public function getDescriptionTouched() {
2013 // The DB lookup might return false, e.g. if the file was just deleted, or the shared DB repo
2014 // itself gets it from elsewhere. To avoid repeating the DB lookups in such a case, we
2015 // need to differentiate between null (uninitialized) and false (failed to load).
2016 if ( $this->descriptionTouched
=== null ) {
2018 'page_namespace' => $this->title
->getNamespace(),
2019 'page_title' => $this->title
->getDBkey()
2021 $touched = $this->repo
->getReplicaDB()->selectField( 'page', 'page_touched', $cond, __METHOD__
);
2022 $this->descriptionTouched
= $touched ?
wfTimestamp( TS_MW
, $touched ) : false;
2025 return $this->descriptionTouched
;
2031 function getSha1() {
2033 // Initialise now if necessary
2034 if ( $this->sha1
== '' && $this->fileExists
) {
2035 $this->lock(); // begin
2037 $this->sha1
= $this->repo
->getFileSha1( $this->getPath() );
2038 if ( !wfReadOnly() && strval( $this->sha1
) != '' ) {
2039 $dbw = $this->repo
->getMasterDB();
2040 $dbw->update( 'image',
2041 [ 'img_sha1' => $this->sha1
],
2042 [ 'img_name' => $this->getName() ],
2044 $this->invalidateCache();
2047 $this->unlock(); // done
2054 * @return bool Whether to cache in RepoGroup (this avoids OOMs)
2056 function isCacheable() {
2059 // If extra data (metadata) was not loaded then it must have been large
2060 return $this->extraDataLoaded
2061 && strlen( serialize( $this->metadata
) ) <= self
::CACHE_FIELD_MAX_LEN
;
2068 public function acquireFileLock() {
2069 return $this->getRepo()->getBackend()->lockFiles(
2070 [ $this->getPath() ], LockManager
::LOCK_EX
, 10
2078 public function releaseFileLock() {
2079 return $this->getRepo()->getBackend()->unlockFiles(
2080 [ $this->getPath() ], LockManager
::LOCK_EX
2085 * Start an atomic DB section and lock the image for update
2086 * or increments a reference counter if the lock is already held
2088 * This method should not be used outside of LocalFile/LocalFile*Batch
2090 * @throws LocalFileLockError Throws an error if the lock was not acquired
2091 * @return bool Whether the file lock owns/spawned the DB transaction
2093 public function lock() {
2094 if ( !$this->locked
) {
2095 $logger = LoggerFactory
::getInstance( 'LocalFile' );
2097 $dbw = $this->repo
->getMasterDB();
2098 $makesTransaction = !$dbw->trxLevel();
2099 $dbw->startAtomic( self
::ATOMIC_SECTION_LOCK
);
2100 // T56736: use simple lock to handle when the file does not exist.
2101 // SELECT FOR UPDATE prevents changes, not other SELECTs with FOR UPDATE.
2102 // Also, that would cause contention on INSERT of similarly named rows.
2103 $status = $this->acquireFileLock(); // represents all versions of the file
2104 if ( !$status->isGood() ) {
2105 $dbw->endAtomic( self
::ATOMIC_SECTION_LOCK
);
2106 $logger->warning( "Failed to lock '{file}'", [ 'file' => $this->name
] );
2108 throw new LocalFileLockError( $status );
2110 // Release the lock *after* commit to avoid row-level contention.
2111 // Make sure it triggers on rollback() as well as commit() (T132921).
2112 $dbw->onTransactionResolution(
2113 function () use ( $logger ) {
2114 $status = $this->releaseFileLock();
2115 if ( !$status->isGood() ) {
2116 $logger->error( "Failed to unlock '{file}'", [ 'file' => $this->name
] );
2121 // Callers might care if the SELECT snapshot is safely fresh
2122 $this->lockedOwnTrx
= $makesTransaction;
2127 return $this->lockedOwnTrx
;
2131 * Decrement the lock reference count and end the atomic section if it reaches zero
2133 * This method should not be used outside of LocalFile/LocalFile*Batch
2135 * The commit and loc release will happen when no atomic sections are active, which
2136 * may happen immediately or at some point after calling this
2138 public function unlock() {
2139 if ( $this->locked
) {
2141 if ( !$this->locked
) {
2142 $dbw = $this->repo
->getMasterDB();
2143 $dbw->endAtomic( self
::ATOMIC_SECTION_LOCK
);
2144 $this->lockedOwnTrx
= false;
2152 protected function readOnlyFatalStatus() {
2153 return $this->getRepo()->newFatal( 'filereadonlyerror', $this->getName(),
2154 $this->getRepo()->getName(), $this->getRepo()->getReadOnlyReason() );
2158 * Clean up any dangling locks
2160 function __destruct() {
2163 } // LocalFile class
2165 # ------------------------------------------------------------------------------
2168 * Helper class for file deletion
2169 * @ingroup FileAbstraction
2171 class LocalFileDeleteBatch
{
2172 /** @var LocalFile */
2179 private $srcRels = [];
2182 private $archiveUrls = [];
2184 /** @var array Items to be processed in the deletion batch */
2185 private $deletionBatch;
2187 /** @var bool Whether to suppress all suppressable fields when deleting */
2198 * @param string $reason
2199 * @param bool $suppress
2200 * @param User|null $user
2202 function __construct( File
$file, $reason = '', $suppress = false, $user = null ) {
2203 $this->file
= $file;
2204 $this->reason
= $reason;
2205 $this->suppress
= $suppress;
2207 $this->user
= $user;
2210 $this->user
= $wgUser;
2212 $this->status
= $file->repo
->newGood();
2215 public function addCurrent() {
2216 $this->srcRels
['.'] = $this->file
->getRel();
2220 * @param string $oldName
2222 public function addOld( $oldName ) {
2223 $this->srcRels
[$oldName] = $this->file
->getArchiveRel( $oldName );
2224 $this->archiveUrls
[] = $this->file
->getArchiveUrl( $oldName );
2228 * Add the old versions of the image to the batch
2229 * @return array List of archive names from old versions
2231 public function addOlds() {
2234 $dbw = $this->file
->repo
->getMasterDB();
2235 $result = $dbw->select( 'oldimage',
2236 [ 'oi_archive_name' ],
2237 [ 'oi_name' => $this->file
->getName() ],
2241 foreach ( $result as $row ) {
2242 $this->addOld( $row->oi_archive_name
);
2243 $archiveNames[] = $row->oi_archive_name
;
2246 return $archiveNames;
2252 protected function getOldRels() {
2253 if ( !isset( $this->srcRels
['.'] ) ) {
2254 $oldRels =& $this->srcRels
;
2255 $deleteCurrent = false;
2257 $oldRels = $this->srcRels
;
2258 unset( $oldRels['.'] );
2259 $deleteCurrent = true;
2262 return [ $oldRels, $deleteCurrent ];
2268 protected function getHashes() {
2270 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
2272 if ( $deleteCurrent ) {
2273 $hashes['.'] = $this->file
->getSha1();
2276 if ( count( $oldRels ) ) {
2277 $dbw = $this->file
->repo
->getMasterDB();
2278 $res = $dbw->select(
2280 [ 'oi_archive_name', 'oi_sha1' ],
2281 [ 'oi_archive_name' => array_keys( $oldRels ),
2282 'oi_name' => $this->file
->getName() ], // performance
2286 foreach ( $res as $row ) {
2287 if ( rtrim( $row->oi_sha1
, "\0" ) === '' ) {
2288 // Get the hash from the file
2289 $oldUrl = $this->file
->getArchiveVirtualUrl( $row->oi_archive_name
);
2290 $props = $this->file
->repo
->getFileProps( $oldUrl );
2292 if ( $props['fileExists'] ) {
2293 // Upgrade the oldimage row
2294 $dbw->update( 'oldimage',
2295 [ 'oi_sha1' => $props['sha1'] ],
2296 [ 'oi_name' => $this->file
->getName(), 'oi_archive_name' => $row->oi_archive_name
],
2298 $hashes[$row->oi_archive_name
] = $props['sha1'];
2300 $hashes[$row->oi_archive_name
] = false;
2303 $hashes[$row->oi_archive_name
] = $row->oi_sha1
;
2308 $missing = array_diff_key( $this->srcRels
, $hashes );
2310 foreach ( $missing as $name => $rel ) {
2311 $this->status
->error( 'filedelete-old-unregistered', $name );
2314 foreach ( $hashes as $name => $hash ) {
2316 $this->status
->error( 'filedelete-missing', $this->srcRels
[$name] );
2317 unset( $hashes[$name] );
2324 protected function doDBInserts() {
2325 global $wgCommentTableSchemaMigrationStage;
2328 $dbw = $this->file
->repo
->getMasterDB();
2330 $commentStoreImgDesc = new CommentStore( 'img_description' );
2331 $commentStoreOiDesc = new CommentStore( 'oi_description' );
2332 $commentStoreFaDesc = new CommentStore( 'fa_description' );
2333 $commentStoreFaReason = new CommentStore( 'fa_deleted_reason' );
2335 $encTimestamp = $dbw->addQuotes( $dbw->timestamp( $now ) );
2336 $encUserId = $dbw->addQuotes( $this->user
->getId() );
2337 $encGroup = $dbw->addQuotes( 'deleted' );
2338 $ext = $this->file
->getExtension();
2339 $dotExt = $ext === '' ?
'' : ".$ext";
2340 $encExt = $dbw->addQuotes( $dotExt );
2341 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
2343 // Bitfields to further suppress the content
2344 if ( $this->suppress
) {
2345 $bitfield = Revision
::SUPPRESSED_ALL
;
2347 $bitfield = 'oi_deleted';
2350 if ( $deleteCurrent ) {
2351 $tables = [ 'image' ];
2353 'fa_storage_group' => $encGroup,
2354 'fa_storage_key' => $dbw->conditional(
2355 [ 'img_sha1' => '' ],
2356 $dbw->addQuotes( '' ),
2357 $dbw->buildConcat( [ "img_sha1", $encExt ] )
2359 'fa_deleted_user' => $encUserId,
2360 'fa_deleted_timestamp' => $encTimestamp,
2361 'fa_deleted' => $this->suppress ?
$bitfield : 0,
2362 'fa_name' => 'img_name',
2363 'fa_archive_name' => 'NULL',
2364 'fa_size' => 'img_size',
2365 'fa_width' => 'img_width',
2366 'fa_height' => 'img_height',
2367 'fa_metadata' => 'img_metadata',
2368 'fa_bits' => 'img_bits',
2369 'fa_media_type' => 'img_media_type',
2370 'fa_major_mime' => 'img_major_mime',
2371 'fa_minor_mime' => 'img_minor_mime',
2372 'fa_user' => 'img_user',
2373 'fa_user_text' => 'img_user_text',
2374 'fa_timestamp' => 'img_timestamp',
2375 'fa_sha1' => 'img_sha1'
2379 $fields +
= array_map(
2380 [ $dbw, 'addQuotes' ],
2381 $commentStoreFaReason->insert( $dbw, $this->reason
)
2384 if ( $wgCommentTableSchemaMigrationStage <= MIGRATION_WRITE_BOTH
) {
2385 $fields['fa_description'] = 'img_description';
2387 if ( $wgCommentTableSchemaMigrationStage >= MIGRATION_WRITE_BOTH
) {
2388 $tables[] = 'image_comment_temp';
2389 $fields['fa_description_id'] = 'imgcomment_description_id';
2390 $joins['image_comment_temp'] = [
2391 $wgCommentTableSchemaMigrationStage === MIGRATION_NEW ?
'JOIN' : 'LEFT JOIN',
2392 [ 'imgcomment_name = img_name' ]
2396 if ( $wgCommentTableSchemaMigrationStage !== MIGRATION_OLD
&&
2397 $wgCommentTableSchemaMigrationStage !== MIGRATION_NEW
2399 // Upgrade any rows that are still old-style. Otherwise an upgrade
2400 // might be missed if a deletion happens while the migration script
2402 $res = $dbw->select(
2403 [ 'image', 'image_comment_temp' ],
2404 [ 'img_name', 'img_description' ],
2405 [ 'img_name' => $this->file
->getName(), 'imgcomment_name' => null ],
2408 [ 'image_comment_temp' => [ 'LEFT JOIN', [ 'imgcomment_name = img_name' ] ] ]
2410 foreach ( $res as $row ) {
2411 list( , $callback ) = $commentStoreImgDesc->insertWithTempTable( $dbw, $row->img_description
);
2412 $callback( $row->img_name
);
2416 $dbw->insertSelect( 'filearchive', $tables, $fields,
2417 [ 'img_name' => $this->file
->getName() ], __METHOD__
, [], [], $joins );
2420 if ( count( $oldRels ) ) {
2421 $res = $dbw->select(
2423 OldLocalFile
::selectFields(),
2425 'oi_name' => $this->file
->getName(),
2426 'oi_archive_name' => array_keys( $oldRels )
2432 if ( $res->numRows() ) {
2433 $reason = $commentStoreFaReason->createComment( $dbw, $this->reason
);
2434 foreach ( $res as $row ) {
2435 // Legacy from OldLocalFile::selectFields() just above
2436 $comment = $commentStoreOiDesc->getCommentLegacy( $dbw, $row );
2438 // Deletion-specific fields
2439 'fa_storage_group' => 'deleted',
2440 'fa_storage_key' => ( $row->oi_sha1
=== '' )
2442 : "{$row->oi_sha1}{$dotExt}",
2443 'fa_deleted_user' => $this->user
->getId(),
2444 'fa_deleted_timestamp' => $dbw->timestamp( $now ),
2445 // Counterpart fields
2446 'fa_deleted' => $this->suppress ?
$bitfield : $row->oi_deleted
,
2447 'fa_name' => $row->oi_name
,
2448 'fa_archive_name' => $row->oi_archive_name
,
2449 'fa_size' => $row->oi_size
,
2450 'fa_width' => $row->oi_width
,
2451 'fa_height' => $row->oi_height
,
2452 'fa_metadata' => $row->oi_metadata
,
2453 'fa_bits' => $row->oi_bits
,
2454 'fa_media_type' => $row->oi_media_type
,
2455 'fa_major_mime' => $row->oi_major_mime
,
2456 'fa_minor_mime' => $row->oi_minor_mime
,
2457 'fa_user' => $row->oi_user
,
2458 'fa_user_text' => $row->oi_user_text
,
2459 'fa_timestamp' => $row->oi_timestamp
,
2460 'fa_sha1' => $row->oi_sha1
2461 ] +
$commentStoreFaReason->insert( $dbw, $reason )
2462 +
$commentStoreFaDesc->insert( $dbw, $comment );
2466 $dbw->insert( 'filearchive', $rowsInsert, __METHOD__
);
2470 function doDBDeletes() {
2471 global $wgCommentTableSchemaMigrationStage;
2473 $dbw = $this->file
->repo
->getMasterDB();
2474 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
2476 if ( count( $oldRels ) ) {
2477 $dbw->delete( 'oldimage',
2479 'oi_name' => $this->file
->getName(),
2480 'oi_archive_name' => array_keys( $oldRels )
2484 if ( $deleteCurrent ) {
2485 $dbw->delete( 'image', [ 'img_name' => $this->file
->getName() ], __METHOD__
);
2486 if ( $wgCommentTableSchemaMigrationStage > MIGRATION_OLD
) {
2488 'image_comment_temp', [ 'imgcomment_name' => $this->file
->getName() ], __METHOD__
2495 * Run the transaction
2498 public function execute() {
2499 $repo = $this->file
->getRepo();
2500 $this->file
->lock();
2502 // Prepare deletion batch
2503 $hashes = $this->getHashes();
2504 $this->deletionBatch
= [];
2505 $ext = $this->file
->getExtension();
2506 $dotExt = $ext === '' ?
'' : ".$ext";
2508 foreach ( $this->srcRels
as $name => $srcRel ) {
2509 // Skip files that have no hash (e.g. missing DB record, or sha1 field and file source)
2510 if ( isset( $hashes[$name] ) ) {
2511 $hash = $hashes[$name];
2512 $key = $hash . $dotExt;
2513 $dstRel = $repo->getDeletedHashPath( $key ) . $key;
2514 $this->deletionBatch
[$name] = [ $srcRel, $dstRel ];
2518 if ( !$repo->hasSha1Storage() ) {
2519 // Removes non-existent file from the batch, so we don't get errors.
2520 // This also handles files in the 'deleted' zone deleted via revision deletion.
2521 $checkStatus = $this->removeNonexistentFiles( $this->deletionBatch
);
2522 if ( !$checkStatus->isGood() ) {
2523 $this->status
->merge( $checkStatus );
2524 return $this->status
;
2526 $this->deletionBatch
= $checkStatus->value
;
2528 // Execute the file deletion batch
2529 $status = $this->file
->repo
->deleteBatch( $this->deletionBatch
);
2530 if ( !$status->isGood() ) {
2531 $this->status
->merge( $status );
2535 if ( !$this->status
->isOK() ) {
2536 // Critical file deletion error; abort
2537 $this->file
->unlock();
2539 return $this->status
;
2542 // Copy the image/oldimage rows to filearchive
2543 $this->doDBInserts();
2544 // Delete image/oldimage rows
2545 $this->doDBDeletes();
2547 // Commit and return
2548 $this->file
->unlock();
2550 return $this->status
;
2554 * Removes non-existent files from a deletion batch.
2555 * @param array $batch
2558 protected function removeNonexistentFiles( $batch ) {
2559 $files = $newBatch = [];
2561 foreach ( $batch as $batchItem ) {
2562 list( $src, ) = $batchItem;
2563 $files[$src] = $this->file
->repo
->getVirtualUrl( 'public' ) . '/' . rawurlencode( $src );
2566 $result = $this->file
->repo
->fileExistsBatch( $files );
2567 if ( in_array( null, $result, true ) ) {
2568 return Status
::newFatal( 'backend-fail-internal',
2569 $this->file
->repo
->getBackend()->getName() );
2572 foreach ( $batch as $batchItem ) {
2573 if ( $result[$batchItem[0]] ) {
2574 $newBatch[] = $batchItem;
2578 return Status
::newGood( $newBatch );
2582 # ------------------------------------------------------------------------------
2585 * Helper class for file undeletion
2586 * @ingroup FileAbstraction
2588 class LocalFileRestoreBatch
{
2589 /** @var LocalFile */
2592 /** @var array List of file IDs to restore */
2593 private $cleanupBatch;
2595 /** @var array List of file IDs to restore */
2598 /** @var bool Add all revisions of the file */
2601 /** @var bool Whether to remove all settings for suppressed fields */
2602 private $unsuppress = false;
2606 * @param bool $unsuppress
2608 function __construct( File
$file, $unsuppress = false ) {
2609 $this->file
= $file;
2610 $this->cleanupBatch
= $this->ids
= [];
2612 $this->unsuppress
= $unsuppress;
2619 public function addId( $fa_id ) {
2620 $this->ids
[] = $fa_id;
2624 * Add a whole lot of files by ID
2627 public function addIds( $ids ) {
2628 $this->ids
= array_merge( $this->ids
, $ids );
2632 * Add all revisions of the file
2634 public function addAll() {
2639 * Run the transaction, except the cleanup batch.
2640 * The cleanup batch should be run in a separate transaction, because it locks different
2641 * rows and there's no need to keep the image row locked while it's acquiring those locks
2642 * The caller may have its own transaction open.
2643 * So we save the batch and let the caller call cleanup()
2646 public function execute() {
2647 /** @var Language */
2650 $repo = $this->file
->getRepo();
2651 if ( !$this->all
&& !$this->ids
) {
2653 return $repo->newGood();
2656 $lockOwnsTrx = $this->file
->lock();
2658 $dbw = $this->file
->repo
->getMasterDB();
2660 $commentStoreImgDesc = new CommentStore( 'img_description' );
2661 $commentStoreOiDesc = new CommentStore( 'oi_description' );
2662 $commentStoreFaDesc = new CommentStore( 'fa_description' );
2664 $status = $this->file
->repo
->newGood();
2666 $exists = (bool)$dbw->selectField( 'image', '1',
2667 [ 'img_name' => $this->file
->getName() ],
2669 // The lock() should already prevents changes, but this still may need
2670 // to bypass any transaction snapshot. However, if lock() started the
2671 // trx (which it probably did) then snapshot is post-lock and up-to-date.
2672 $lockOwnsTrx ?
[] : [ 'LOCK IN SHARE MODE' ]
2675 // Fetch all or selected archived revisions for the file,
2676 // sorted from the most recent to the oldest.
2677 $conditions = [ 'fa_name' => $this->file
->getName() ];
2679 if ( !$this->all
) {
2680 $conditions['fa_id'] = $this->ids
;
2683 $result = $dbw->select(
2685 ArchivedFile
::selectFields(),
2688 [ 'ORDER BY' => 'fa_timestamp DESC' ]
2694 $insertCurrent = false;
2699 foreach ( $result as $row ) {
2700 $idsPresent[] = $row->fa_id
;
2702 if ( $row->fa_name
!= $this->file
->getName() ) {
2703 $status->error( 'undelete-filename-mismatch', $wgLang->timeanddate( $row->fa_timestamp
) );
2704 $status->failCount++
;
2708 if ( $row->fa_storage_key
== '' ) {
2709 // Revision was missing pre-deletion
2710 $status->error( 'undelete-bad-store-key', $wgLang->timeanddate( $row->fa_timestamp
) );
2711 $status->failCount++
;
2715 $deletedRel = $repo->getDeletedHashPath( $row->fa_storage_key
) .
2716 $row->fa_storage_key
;
2717 $deletedUrl = $repo->getVirtualUrl() . '/deleted/' . $deletedRel;
2719 if ( isset( $row->fa_sha1
) ) {
2720 $sha1 = $row->fa_sha1
;
2722 // old row, populate from key
2723 $sha1 = LocalRepo
::getHashFromKey( $row->fa_storage_key
);
2727 if ( strlen( $sha1 ) == 32 && $sha1[0] == '0' ) {
2728 $sha1 = substr( $sha1, 1 );
2731 if ( is_null( $row->fa_major_mime
) ||
$row->fa_major_mime
== 'unknown'
2732 ||
is_null( $row->fa_minor_mime
) ||
$row->fa_minor_mime
== 'unknown'
2733 ||
is_null( $row->fa_media_type
) ||
$row->fa_media_type
== 'UNKNOWN'
2734 ||
is_null( $row->fa_metadata
)
2736 // Refresh our metadata
2737 // Required for a new current revision; nice for older ones too. :)
2738 $props = RepoGroup
::singleton()->getFileProps( $deletedUrl );
2741 'minor_mime' => $row->fa_minor_mime
,
2742 'major_mime' => $row->fa_major_mime
,
2743 'media_type' => $row->fa_media_type
,
2744 'metadata' => $row->fa_metadata
2748 // Legacy from ArchivedFile::selectFields() just above
2749 $comment = $commentStoreFaDesc->getCommentLegacy( $dbw, $row );
2750 if ( $first && !$exists ) {
2751 // This revision will be published as the new current version
2752 $destRel = $this->file
->getRel();
2753 list( $commentFields, $commentCallback ) =
2754 $commentStoreImgDesc->insertWithTempTable( $dbw, $comment );
2756 'img_name' => $row->fa_name
,
2757 'img_size' => $row->fa_size
,
2758 'img_width' => $row->fa_width
,
2759 'img_height' => $row->fa_height
,
2760 'img_metadata' => $props['metadata'],
2761 'img_bits' => $row->fa_bits
,
2762 'img_media_type' => $props['media_type'],
2763 'img_major_mime' => $props['major_mime'],
2764 'img_minor_mime' => $props['minor_mime'],
2765 'img_user' => $row->fa_user
,
2766 'img_user_text' => $row->fa_user_text
,
2767 'img_timestamp' => $row->fa_timestamp
,
2771 // The live (current) version cannot be hidden!
2772 if ( !$this->unsuppress
&& $row->fa_deleted
) {
2773 $status->fatal( 'undeleterevdel' );
2774 $this->file
->unlock();
2778 $archiveName = $row->fa_archive_name
;
2780 if ( $archiveName == '' ) {
2781 // This was originally a current version; we
2782 // have to devise a new archive name for it.
2783 // Format is <timestamp of archiving>!<name>
2784 $timestamp = wfTimestamp( TS_UNIX
, $row->fa_deleted_timestamp
);
2787 $archiveName = wfTimestamp( TS_MW
, $timestamp ) . '!' . $row->fa_name
;
2789 } while ( isset( $archiveNames[$archiveName] ) );
2792 $archiveNames[$archiveName] = true;
2793 $destRel = $this->file
->getArchiveRel( $archiveName );
2795 'oi_name' => $row->fa_name
,
2796 'oi_archive_name' => $archiveName,
2797 'oi_size' => $row->fa_size
,
2798 'oi_width' => $row->fa_width
,
2799 'oi_height' => $row->fa_height
,
2800 'oi_bits' => $row->fa_bits
,
2801 'oi_user' => $row->fa_user
,
2802 'oi_user_text' => $row->fa_user_text
,
2803 'oi_timestamp' => $row->fa_timestamp
,
2804 'oi_metadata' => $props['metadata'],
2805 'oi_media_type' => $props['media_type'],
2806 'oi_major_mime' => $props['major_mime'],
2807 'oi_minor_mime' => $props['minor_mime'],
2808 'oi_deleted' => $this->unsuppress ?
0 : $row->fa_deleted
,
2810 ] +
$commentStoreOiDesc->insert( $dbw, $comment );
2813 $deleteIds[] = $row->fa_id
;
2815 if ( !$this->unsuppress
&& $row->fa_deleted
& File
::DELETED_FILE
) {
2816 // private files can stay where they are
2817 $status->successCount++
;
2819 $storeBatch[] = [ $deletedUrl, 'public', $destRel ];
2820 $this->cleanupBatch
[] = $row->fa_storage_key
;
2828 // Add a warning to the status object for missing IDs
2829 $missingIds = array_diff( $this->ids
, $idsPresent );
2831 foreach ( $missingIds as $id ) {
2832 $status->error( 'undelete-missing-filearchive', $id );
2835 if ( !$repo->hasSha1Storage() ) {
2836 // Remove missing files from batch, so we don't get errors when undeleting them
2837 $checkStatus = $this->removeNonexistentFiles( $storeBatch );
2838 if ( !$checkStatus->isGood() ) {
2839 $status->merge( $checkStatus );
2842 $storeBatch = $checkStatus->value
;
2844 // Run the store batch
2845 // Use the OVERWRITE_SAME flag to smooth over a common error
2846 $storeStatus = $this->file
->repo
->storeBatch( $storeBatch, FileRepo
::OVERWRITE_SAME
);
2847 $status->merge( $storeStatus );
2849 if ( !$status->isGood() ) {
2850 // Even if some files could be copied, fail entirely as that is the
2851 // easiest thing to do without data loss
2852 $this->cleanupFailedBatch( $storeStatus, $storeBatch );
2853 $status->setOK( false );
2854 $this->file
->unlock();
2860 // Run the DB updates
2861 // Because we have locked the image row, key conflicts should be rare.
2862 // If they do occur, we can roll back the transaction at this time with
2863 // no data loss, but leaving unregistered files scattered throughout the
2865 // This is not ideal, which is why it's important to lock the image row.
2866 if ( $insertCurrent ) {
2867 $dbw->insert( 'image', $insertCurrent, __METHOD__
);
2868 $commentCallback( $insertCurrent['img_name'] );
2871 if ( $insertBatch ) {
2872 $dbw->insert( 'oldimage', $insertBatch, __METHOD__
);
2876 $dbw->delete( 'filearchive',
2877 [ 'fa_id' => $deleteIds ],
2881 // If store batch is empty (all files are missing), deletion is to be considered successful
2882 if ( $status->successCount
> 0 ||
!$storeBatch ||
$repo->hasSha1Storage() ) {
2884 wfDebug( __METHOD__
. " restored {$status->successCount} items, creating a new current\n" );
2886 DeferredUpdates
::addUpdate( SiteStatsUpdate
::factory( [ 'images' => 1 ] ) );
2888 $this->file
->purgeEverything();
2890 wfDebug( __METHOD__
. " restored {$status->successCount} as archived versions\n" );
2891 $this->file
->purgeDescription();
2895 $this->file
->unlock();
2901 * Removes non-existent files from a store batch.
2902 * @param array $triplets
2905 protected function removeNonexistentFiles( $triplets ) {
2906 $files = $filteredTriplets = [];
2907 foreach ( $triplets as $file ) {
2908 $files[$file[0]] = $file[0];
2911 $result = $this->file
->repo
->fileExistsBatch( $files );
2912 if ( in_array( null, $result, true ) ) {
2913 return Status
::newFatal( 'backend-fail-internal',
2914 $this->file
->repo
->getBackend()->getName() );
2917 foreach ( $triplets as $file ) {
2918 if ( $result[$file[0]] ) {
2919 $filteredTriplets[] = $file;
2923 return Status
::newGood( $filteredTriplets );
2927 * Removes non-existent files from a cleanup batch.
2928 * @param array $batch
2931 protected function removeNonexistentFromCleanup( $batch ) {
2932 $files = $newBatch = [];
2933 $repo = $this->file
->repo
;
2935 foreach ( $batch as $file ) {
2936 $files[$file] = $repo->getVirtualUrl( 'deleted' ) . '/' .
2937 rawurlencode( $repo->getDeletedHashPath( $file ) . $file );
2940 $result = $repo->fileExistsBatch( $files );
2942 foreach ( $batch as $file ) {
2943 if ( $result[$file] ) {
2944 $newBatch[] = $file;
2952 * Delete unused files in the deleted zone.
2953 * This should be called from outside the transaction in which execute() was called.
2956 public function cleanup() {
2957 if ( !$this->cleanupBatch
) {
2958 return $this->file
->repo
->newGood();
2961 $this->cleanupBatch
= $this->removeNonexistentFromCleanup( $this->cleanupBatch
);
2963 $status = $this->file
->repo
->cleanupDeletedBatch( $this->cleanupBatch
);
2969 * Cleanup a failed batch. The batch was only partially successful, so
2970 * rollback by removing all items that were succesfully copied.
2972 * @param Status $storeStatus
2973 * @param array $storeBatch
2975 protected function cleanupFailedBatch( $storeStatus, $storeBatch ) {
2978 foreach ( $storeStatus->success
as $i => $success ) {
2979 // Check if this item of the batch was successfully copied
2981 // Item was successfully copied and needs to be removed again
2982 // Extract ($dstZone, $dstRel) from the batch
2983 $cleanupBatch[] = [ $storeBatch[$i][1], $storeBatch[$i][2] ];
2986 $this->file
->repo
->cleanupBatch( $cleanupBatch );
2990 # ------------------------------------------------------------------------------
2993 * Helper class for file movement
2994 * @ingroup FileAbstraction
2996 class LocalFileMoveBatch
{
2997 /** @var LocalFile */
3007 protected $oldCount;
3011 /** @var IDatabase */
3016 * @param Title $target
3018 function __construct( File
$file, Title
$target ) {
3019 $this->file
= $file;
3020 $this->target
= $target;
3021 $this->oldHash
= $this->file
->repo
->getHashPath( $this->file
->getName() );
3022 $this->newHash
= $this->file
->repo
->getHashPath( $this->target
->getDBkey() );
3023 $this->oldName
= $this->file
->getName();
3024 $this->newName
= $this->file
->repo
->getNameFromTitle( $this->target
);
3025 $this->oldRel
= $this->oldHash
. $this->oldName
;
3026 $this->newRel
= $this->newHash
. $this->newName
;
3027 $this->db
= $file->getRepo()->getMasterDB();
3031 * Add the current image to the batch
3033 public function addCurrent() {
3034 $this->cur
= [ $this->oldRel
, $this->newRel
];
3038 * Add the old versions of the image to the batch
3039 * @return array List of archive names from old versions
3041 public function addOlds() {
3042 $archiveBase = 'archive';
3044 $this->oldCount
= 0;
3047 $result = $this->db
->select( 'oldimage',
3048 [ 'oi_archive_name', 'oi_deleted' ],
3049 [ 'oi_name' => $this->oldName
],
3051 [ 'LOCK IN SHARE MODE' ] // ignore snapshot
3054 foreach ( $result as $row ) {
3055 $archiveNames[] = $row->oi_archive_name
;
3056 $oldName = $row->oi_archive_name
;
3057 $bits = explode( '!', $oldName, 2 );
3059 if ( count( $bits ) != 2 ) {
3060 wfDebug( "Old file name missing !: '$oldName' \n" );
3064 list( $timestamp, $filename ) = $bits;
3066 if ( $this->oldName
!= $filename ) {
3067 wfDebug( "Old file name doesn't match: '$oldName' \n" );
3073 // Do we want to add those to oldCount?
3074 if ( $row->oi_deleted
& File
::DELETED_FILE
) {
3079 "{$archiveBase}/{$this->oldHash}{$oldName}",
3080 "{$archiveBase}/{$this->newHash}{$timestamp}!{$this->newName}"
3084 return $archiveNames;
3091 public function execute() {
3092 $repo = $this->file
->repo
;
3093 $status = $repo->newGood();
3094 $destFile = wfLocalFile( $this->target
);
3096 $this->file
->lock(); // begin
3097 $destFile->lock(); // quickly fail if destination is not available
3099 $triplets = $this->getMoveTriplets();
3100 $checkStatus = $this->removeNonexistentFiles( $triplets );
3101 if ( !$checkStatus->isGood() ) {
3102 $destFile->unlock();
3103 $this->file
->unlock();
3104 $status->merge( $checkStatus ); // couldn't talk to file backend
3107 $triplets = $checkStatus->value
;
3109 // Verify the file versions metadata in the DB.
3110 $statusDb = $this->verifyDBUpdates();
3111 if ( !$statusDb->isGood() ) {
3112 $destFile->unlock();
3113 $this->file
->unlock();
3114 $statusDb->setOK( false );
3119 if ( !$repo->hasSha1Storage() ) {
3120 // Copy the files into their new location.
3121 // If a prior process fataled copying or cleaning up files we tolerate any
3122 // of the existing files if they are identical to the ones being stored.
3123 $statusMove = $repo->storeBatch( $triplets, FileRepo
::OVERWRITE_SAME
);
3124 wfDebugLog( 'imagemove', "Moved files for {$this->file->getName()}: " .
3125 "{$statusMove->successCount} successes, {$statusMove->failCount} failures" );
3126 if ( !$statusMove->isGood() ) {
3127 // Delete any files copied over (while the destination is still locked)
3128 $this->cleanupTarget( $triplets );
3129 $destFile->unlock();
3130 $this->file
->unlock();
3131 wfDebugLog( 'imagemove', "Error in moving files: "
3132 . $statusMove->getWikiText( false, false, 'en' ) );
3133 $statusMove->setOK( false );
3137 $status->merge( $statusMove );
3140 // Rename the file versions metadata in the DB.
3141 $this->doDBUpdates();
3143 wfDebugLog( 'imagemove', "Renamed {$this->file->getName()} in database: " .
3144 "{$statusDb->successCount} successes, {$statusDb->failCount} failures" );
3146 $destFile->unlock();
3147 $this->file
->unlock(); // done
3149 // Everything went ok, remove the source files
3150 $this->cleanupSource( $triplets );
3152 $status->merge( $statusDb );
3158 * Verify the database updates and return a new Status indicating how
3159 * many rows would be updated.
3163 protected function verifyDBUpdates() {
3164 $repo = $this->file
->repo
;
3165 $status = $repo->newGood();
3168 $hasCurrent = $dbw->selectField(
3171 [ 'img_name' => $this->oldName
],
3175 $oldRowCount = $dbw->selectField(
3178 [ 'oi_name' => $this->oldName
],
3183 if ( $hasCurrent ) {
3184 $status->successCount++
;
3186 $status->failCount++
;
3188 $status->successCount +
= $oldRowCount;
3189 // T36934: oldCount is based on files that actually exist.
3190 // There may be more DB rows than such files, in which case $affected
3191 // can be greater than $total. We use max() to avoid negatives here.
3192 $status->failCount +
= max( 0, $this->oldCount
- $oldRowCount );
3193 if ( $status->failCount
) {
3194 $status->error( 'imageinvalidfilename' );
3201 * Do the database updates and return a new Status indicating how
3202 * many rows where updated.
3204 protected function doDBUpdates() {
3207 // Update current image
3210 [ 'img_name' => $this->newName
],
3211 [ 'img_name' => $this->oldName
],
3214 // Update old images
3218 'oi_name' => $this->newName
,
3219 'oi_archive_name = ' . $dbw->strreplace( 'oi_archive_name',
3220 $dbw->addQuotes( $this->oldName
), $dbw->addQuotes( $this->newName
) ),
3222 [ 'oi_name' => $this->oldName
],
3228 * Generate triplets for FileRepo::storeBatch().
3231 protected function getMoveTriplets() {
3232 $moves = array_merge( [ $this->cur
], $this->olds
);
3233 $triplets = []; // The format is: (srcUrl, destZone, destUrl)
3235 foreach ( $moves as $move ) {
3236 // $move: (oldRelativePath, newRelativePath)
3237 $srcUrl = $this->file
->repo
->getVirtualUrl() . '/public/' . rawurlencode( $move[0] );
3238 $triplets[] = [ $srcUrl, 'public', $move[1] ];
3241 "Generated move triplet for {$this->file->getName()}: {$srcUrl} :: public :: {$move[1]}"
3249 * Removes non-existent files from move batch.
3250 * @param array $triplets
3253 protected function removeNonexistentFiles( $triplets ) {
3256 foreach ( $triplets as $file ) {
3257 $files[$file[0]] = $file[0];
3260 $result = $this->file
->repo
->fileExistsBatch( $files );
3261 if ( in_array( null, $result, true ) ) {
3262 return Status
::newFatal( 'backend-fail-internal',
3263 $this->file
->repo
->getBackend()->getName() );
3266 $filteredTriplets = [];
3267 foreach ( $triplets as $file ) {
3268 if ( $result[$file[0]] ) {
3269 $filteredTriplets[] = $file;
3271 wfDebugLog( 'imagemove', "File {$file[0]} does not exist" );
3275 return Status
::newGood( $filteredTriplets );
3279 * Cleanup a partially moved array of triplets by deleting the target
3280 * files. Called if something went wrong half way.
3281 * @param array $triplets
3283 protected function cleanupTarget( $triplets ) {
3284 // Create dest pairs from the triplets
3286 foreach ( $triplets as $triplet ) {
3287 // $triplet: (old source virtual URL, dst zone, dest rel)
3288 $pairs[] = [ $triplet[1], $triplet[2] ];
3291 $this->file
->repo
->cleanupBatch( $pairs );
3295 * Cleanup a fully moved array of triplets by deleting the source files.
3296 * Called at the end of the move process if everything else went ok.
3297 * @param array $triplets
3299 protected function cleanupSource( $triplets ) {
3300 // Create source file names from the triplets
3302 foreach ( $triplets as $triplet ) {
3303 $files[] = $triplet[0];
3306 $this->file
->repo
->cleanupBatch( $files );
3310 class LocalFileLockError
extends ErrorPageError
{
3311 public function __construct( Status
$status ) {
3312 parent
::__construct(
3314 $status->getMessage()
3318 public function report() {
3320 $wgOut->setStatusCode( 429 );