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
;
27 use MediaWiki\MediaWikiServices
;
30 * Class to represent a local file in the wiki's own database
32 * Provides methods to retrieve paths (physical, logical, URL),
33 * to generate image thumbnails or for uploading.
35 * Note that only the repo object knows what its file class is called. You should
36 * never name a file class explictly outside of the repo class. Instead use the
37 * repo's factory functions to generate file objects, for example:
39 * RepoGroup::singleton()->getLocalRepo()->newFile( $title );
41 * The convenience functions wfLocalFile() and wfFindFile() should be sufficient
44 * @ingroup FileAbstraction
46 class LocalFile
extends File
{
47 const VERSION
= 11; // cache version
49 const CACHE_FIELD_MAX_LEN
= 1000;
51 /** @var bool Does the file exist on disk? (loadFromXxx) */
52 protected $fileExists;
54 /** @var int Image width */
57 /** @var int Image height */
60 /** @var int Returned by getimagesize (loadFromXxx) */
63 /** @var string MEDIATYPE_xxx (bitmap, drawing, audio...) */
64 protected $media_type;
66 /** @var string MIME type, determined by MimeAnalyzer::guessMimeType */
69 /** @var int Size in bytes (loadFromXxx) */
72 /** @var string Handler-specific metadata */
75 /** @var string SHA-1 base 36 content hash */
78 /** @var bool Whether or not core data has been loaded from the database (loadFromXxx) */
79 protected $dataLoaded;
81 /** @var bool Whether or not lazy-loaded data has been loaded from the database */
82 protected $extraDataLoaded;
84 /** @var int Bitfield akin to rev_deleted */
88 protected $repoClass = LocalRepo
::class;
90 /** @var int Number of line to return by nextHistoryLine() (constructor) */
93 /** @var int Result of the query for the file's history (nextHistoryLine) */
96 /** @var string Major MIME type */
99 /** @var string Minor MIME type */
102 /** @var string Upload timestamp */
105 /** @var User Uploader */
108 /** @var string Description of current revision of the file */
109 private $description;
111 /** @var string TS_MW timestamp of the last change of the file description */
112 private $descriptionTouched;
114 /** @var bool Whether the row was upgraded on load */
117 /** @var bool Whether the row was scheduled to upgrade on load */
120 /** @var bool True if the image row is locked */
123 /** @var bool True if the image row is locked with a lock initiated transaction */
124 private $lockedOwnTrx;
126 /** @var bool True if file is not present in file system. Not to be cached in memcached */
129 // @note: higher than IDBAccessObject constants
130 const LOAD_ALL
= 16; // integer; load all the lazy fields too (like metadata)
132 const ATOMIC_SECTION_LOCK
= 'LocalFile::lockingTransaction';
135 * Create a LocalFile from a title
136 * Do not call this except from inside a repo class.
138 * Note: $unused param is only here to avoid an E_STRICT
140 * @param Title $title
141 * @param FileRepo $repo
142 * @param null $unused
146 static function newFromTitle( $title, $repo, $unused = null ) {
147 return new self( $title, $repo );
151 * Create a LocalFile from a title
152 * Do not call this except from inside a repo class.
154 * @param stdClass $row
155 * @param FileRepo $repo
159 static function newFromRow( $row, $repo ) {
160 $title = Title
::makeTitle( NS_FILE
, $row->img_name
);
161 $file = new self( $title, $repo );
162 $file->loadFromRow( $row );
168 * Create a LocalFile from a SHA-1 key
169 * Do not call this except from inside a repo class.
171 * @param string $sha1 Base-36 SHA-1
172 * @param LocalRepo $repo
173 * @param string|bool $timestamp MW_timestamp (optional)
174 * @return bool|LocalFile
176 static function newFromKey( $sha1, $repo, $timestamp = false ) {
177 $dbr = $repo->getReplicaDB();
179 $conds = [ 'img_sha1' => $sha1 ];
181 $conds['img_timestamp'] = $dbr->timestamp( $timestamp );
184 $fileQuery = self
::getQueryInfo();
185 $row = $dbr->selectRow(
186 $fileQuery['tables'], $fileQuery['fields'], $conds, __METHOD__
, [], $fileQuery['joins']
189 return self
::newFromRow( $row, $repo );
196 * Fields in the image table
197 * @deprecated since 1.31, use self::getQueryInfo() instead.
200 static function selectFields() {
201 global $wgActorTableSchemaMigrationStage;
203 wfDeprecated( __METHOD__
, '1.31' );
204 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_READ_NEW
) {
205 // If code is using this instead of self::getQueryInfo(), there's a
206 // decent chance it's going to try to directly access
207 // $row->img_user or $row->img_user_text and we can't give it
208 // useful values here once those aren't being used anymore.
209 throw new BadMethodCallException(
210 'Cannot use ' . __METHOD__
211 . ' when $wgActorTableSchemaMigrationStage has SCHEMA_COMPAT_READ_NEW'
227 'img_actor' => 'NULL',
230 ] + MediaWikiServices
::getInstance()->getCommentStore()->getFields( 'img_description' );
234 * Return the tables, fields, and join conditions to be selected to create
235 * a new localfile object.
237 * @param string[] $options
238 * - omit-lazy: Omit fields that are lazily cached.
239 * @return array[] With three keys:
240 * - tables: (string[]) to include in the `$table` to `IDatabase->select()`
241 * - fields: (string[]) to include in the `$vars` to `IDatabase->select()`
242 * - joins: (array) to include in the `$join_conds` to `IDatabase->select()`
244 public static function getQueryInfo( array $options = [] ) {
245 $commentQuery = MediaWikiServices
::getInstance()->getCommentStore()->getJoin( 'img_description' );
246 $actorQuery = ActorMigration
::newMigration()->getJoin( 'img_user' );
248 'tables' => [ 'image' ] +
$commentQuery['tables'] +
$actorQuery['tables'],
261 ] +
$commentQuery['fields'] +
$actorQuery['fields'],
262 'joins' => $commentQuery['joins'] +
$actorQuery['joins'],
265 if ( in_array( 'omit-nonlazy', $options, true ) ) {
266 // Internal use only for getting only the lazy fields
269 if ( !in_array( 'omit-lazy', $options, true ) ) {
270 // Note: Keep this in sync with self::getLazyCacheFields()
271 $ret['fields'][] = 'img_metadata';
278 * Do not call this except from inside a repo class.
279 * @param Title $title
280 * @param FileRepo $repo
282 function __construct( $title, $repo ) {
283 parent
::__construct( $title, $repo );
285 $this->metadata
= '';
286 $this->historyLine
= 0;
287 $this->historyRes
= null;
288 $this->dataLoaded
= false;
289 $this->extraDataLoaded
= false;
291 $this->assertRepoDefined();
292 $this->assertTitleDefined();
296 * Get the memcached key for the main data for this file, or false if
297 * there is no access to the shared cache.
298 * @return string|bool
300 function getCacheKey() {
301 return $this->repo
->getSharedCacheKey( 'file', sha1( $this->getName() ) );
305 * @param WANObjectCache $cache
309 public function getMutableCacheKeys( WANObjectCache
$cache ) {
310 return [ $this->getCacheKey() ];
314 * Try to load file metadata from memcached, falling back to the database
316 private function loadFromCache() {
317 $this->dataLoaded
= false;
318 $this->extraDataLoaded
= false;
320 $key = $this->getCacheKey();
322 $this->loadFromDB( self
::READ_NORMAL
);
327 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
328 $cachedValues = $cache->getWithSetCallback(
331 function ( $oldValue, &$ttl, array &$setOpts ) use ( $cache ) {
332 $setOpts +
= Database
::getCacheSetOptions( $this->repo
->getReplicaDB() );
334 $this->loadFromDB( self
::READ_NORMAL
);
336 $fields = $this->getCacheFields( '' );
337 $cacheVal['fileExists'] = $this->fileExists
;
338 if ( $this->fileExists
) {
339 foreach ( $fields as $field ) {
340 $cacheVal[$field] = $this->$field;
343 $cacheVal['user'] = $this->user ?
$this->user
->getId() : 0;
344 $cacheVal['user_text'] = $this->user ?
$this->user
->getName() : '';
345 $cacheVal['actor'] = $this->user ?
$this->user
->getActorId() : null;
347 // Strip off excessive entries from the subset of fields that can become large.
348 // If the cache value gets to large it will not fit in memcached and nothing will
349 // get cached at all, causing master queries for any file access.
350 foreach ( $this->getLazyCacheFields( '' ) as $field ) {
351 if ( isset( $cacheVal[$field] )
352 && strlen( $cacheVal[$field] ) > 100 * 1024
354 unset( $cacheVal[$field] ); // don't let the value get too big
358 if ( $this->fileExists
) {
359 $ttl = $cache->adaptiveTTL( wfTimestamp( TS_UNIX
, $this->timestamp
), $ttl );
361 $ttl = $cache::TTL_DAY
;
366 [ 'version' => self
::VERSION
]
369 $this->fileExists
= $cachedValues['fileExists'];
370 if ( $this->fileExists
) {
371 $this->setProps( $cachedValues );
374 $this->dataLoaded
= true;
375 $this->extraDataLoaded
= true;
376 foreach ( $this->getLazyCacheFields( '' ) as $field ) {
377 $this->extraDataLoaded
= $this->extraDataLoaded
&& isset( $cachedValues[$field] );
382 * Purge the file object/metadata cache
384 public function invalidateCache() {
385 $key = $this->getCacheKey();
390 $this->repo
->getMasterDB()->onTransactionPreCommitOrIdle(
391 function () use ( $key ) {
392 MediaWikiServices
::getInstance()->getMainWANObjectCache()->delete( $key );
399 * Load metadata from the file itself
401 function loadFromFile() {
402 $props = $this->repo
->getFileProps( $this->getVirtualUrl() );
403 $this->setProps( $props );
407 * Returns the list of object properties that are included as-is in the cache.
408 * @param string $prefix Must be the empty string
410 * @since 1.31 No longer accepts a non-empty $prefix
412 protected function getCacheFields( $prefix = 'img_' ) {
413 if ( $prefix !== '' ) {
414 throw new InvalidArgumentException(
415 __METHOD__
. ' with a non-empty prefix is no longer supported.'
419 // See self::getQueryInfo() for the fetching of the data from the DB,
420 // self::loadFromRow() for the loading of the object from the DB row,
421 // and self::loadFromCache() for the caching, and self::setProps() for
422 // populating the object from an array of data.
423 return [ 'size', 'width', 'height', 'bits', 'media_type',
424 'major_mime', 'minor_mime', 'metadata', 'timestamp', 'sha1', 'description' ];
428 * Returns the list of object properties that are included as-is in the
429 * cache, only when they're not too big, and are lazily loaded by self::loadExtraFromDB().
430 * @param string $prefix Must be the empty string
432 * @since 1.31 No longer accepts a non-empty $prefix
434 protected function getLazyCacheFields( $prefix = 'img_' ) {
435 if ( $prefix !== '' ) {
436 throw new InvalidArgumentException(
437 __METHOD__
. ' with a non-empty prefix is no longer supported.'
441 // Keep this in sync with the omit-lazy option in self::getQueryInfo().
442 return [ 'metadata' ];
446 * Load file metadata from the DB
449 function loadFromDB( $flags = 0 ) {
450 $fname = static::class . '::' . __FUNCTION__
;
452 # Unconditionally set loaded=true, we don't want the accessors constantly rechecking
453 $this->dataLoaded
= true;
454 $this->extraDataLoaded
= true;
456 $dbr = ( $flags & self
::READ_LATEST
)
457 ?
$this->repo
->getMasterDB()
458 : $this->repo
->getReplicaDB();
460 $fileQuery = static::getQueryInfo();
461 $row = $dbr->selectRow(
462 $fileQuery['tables'],
463 $fileQuery['fields'],
464 [ 'img_name' => $this->getName() ],
471 $this->loadFromRow( $row );
473 $this->fileExists
= false;
478 * Load lazy file metadata from the DB.
479 * This covers fields that are sometimes not cached.
481 protected function loadExtraFromDB() {
482 $fname = static::class . '::' . __FUNCTION__
;
484 # Unconditionally set loaded=true, we don't want the accessors constantly rechecking
485 $this->extraDataLoaded
= true;
487 $fieldMap = $this->loadExtraFieldsWithTimestamp( $this->repo
->getReplicaDB(), $fname );
489 $fieldMap = $this->loadExtraFieldsWithTimestamp( $this->repo
->getMasterDB(), $fname );
493 foreach ( $fieldMap as $name => $value ) {
494 $this->$name = $value;
497 throw new MWException( "Could not find data for image '{$this->getName()}'." );
502 * @param IDatabase $dbr
503 * @param string $fname
504 * @return string[]|bool
506 private function loadExtraFieldsWithTimestamp( $dbr, $fname ) {
509 $fileQuery = self
::getQueryInfo( [ 'omit-nonlazy' ] );
510 $row = $dbr->selectRow(
511 $fileQuery['tables'],
512 $fileQuery['fields'],
514 'img_name' => $this->getName(),
515 'img_timestamp' => $dbr->timestamp( $this->getTimestamp() ),
522 $fieldMap = $this->unprefixRow( $row, 'img_' );
524 # File may have been uploaded over in the meantime; check the old versions
525 $fileQuery = OldLocalFile
::getQueryInfo( [ 'omit-nonlazy' ] );
526 $row = $dbr->selectRow(
527 $fileQuery['tables'],
528 $fileQuery['fields'],
530 'oi_name' => $this->getName(),
531 'oi_timestamp' => $dbr->timestamp( $this->getTimestamp() ),
538 $fieldMap = $this->unprefixRow( $row, 'oi_' );
542 if ( isset( $fieldMap['metadata'] ) ) {
543 $fieldMap['metadata'] = $this->repo
->getReplicaDB()->decodeBlob( $fieldMap['metadata'] );
550 * @param array|object $row
551 * @param string $prefix
552 * @throws MWException
555 protected function unprefixRow( $row, $prefix = 'img_' ) {
556 $array = (array)$row;
557 $prefixLength = strlen( $prefix );
559 // Sanity check prefix once
560 if ( substr( key( $array ), 0, $prefixLength ) !== $prefix ) {
561 throw new MWException( __METHOD__
. ': incorrect $prefix parameter' );
565 foreach ( $array as $name => $value ) {
566 $decoded[substr( $name, $prefixLength )] = $value;
573 * Decode a row from the database (either object or array) to an array
574 * with timestamps and MIME types decoded, and the field prefix removed.
576 * @param string $prefix
577 * @throws MWException
580 function decodeRow( $row, $prefix = 'img_' ) {
581 $decoded = $this->unprefixRow( $row, $prefix );
583 $decoded['description'] = MediaWikiServices
::getInstance()->getCommentStore()
584 ->getComment( 'description', (object)$decoded )->text
;
586 $decoded['user'] = User
::newFromAnyId(
587 $decoded['user'] ??
null,
588 $decoded['user_text'] ??
null,
589 $decoded['actor'] ??
null
591 unset( $decoded['user_text'], $decoded['actor'] );
593 $decoded['timestamp'] = wfTimestamp( TS_MW
, $decoded['timestamp'] );
595 $decoded['metadata'] = $this->repo
->getReplicaDB()->decodeBlob( $decoded['metadata'] );
597 if ( empty( $decoded['major_mime'] ) ) {
598 $decoded['mime'] = 'unknown/unknown';
600 if ( !$decoded['minor_mime'] ) {
601 $decoded['minor_mime'] = 'unknown';
603 $decoded['mime'] = $decoded['major_mime'] . '/' . $decoded['minor_mime'];
606 // Trim zero padding from char/binary field
607 $decoded['sha1'] = rtrim( $decoded['sha1'], "\0" );
609 // Normalize some fields to integer type, per their database definition.
610 // Use unary + so that overflows will be upgraded to double instead of
611 // being trucated as with intval(). This is important to allow >2GB
612 // files on 32-bit systems.
613 foreach ( [ 'size', 'width', 'height', 'bits' ] as $field ) {
614 $decoded[$field] = +
$decoded[$field];
621 * Load file metadata from a DB result row
624 * @param string $prefix
626 function loadFromRow( $row, $prefix = 'img_' ) {
627 $this->dataLoaded
= true;
628 $this->extraDataLoaded
= true;
630 $array = $this->decodeRow( $row, $prefix );
632 foreach ( $array as $name => $value ) {
633 $this->$name = $value;
636 $this->fileExists
= true;
637 $this->maybeUpgradeRow();
641 * Load file metadata from cache or DB, unless already loaded
644 function load( $flags = 0 ) {
645 if ( !$this->dataLoaded
) {
646 if ( $flags & self
::READ_LATEST
) {
647 $this->loadFromDB( $flags );
649 $this->loadFromCache();
653 if ( ( $flags & self
::LOAD_ALL
) && !$this->extraDataLoaded
) {
654 // @note: loads on name/timestamp to reduce race condition problems
655 $this->loadExtraFromDB();
660 * Upgrade a row if it needs it
662 function maybeUpgradeRow() {
663 global $wgUpdateCompatibleMetadata;
665 if ( wfReadOnly() ||
$this->upgrading
) {
670 if ( is_null( $this->media_type
) ||
$this->mime
== 'image/svg' ) {
673 $handler = $this->getHandler();
675 $validity = $handler->isMetadataValid( $this, $this->getMetadata() );
676 if ( $validity === MediaHandler
::METADATA_BAD
) {
678 } elseif ( $validity === MediaHandler
::METADATA_COMPATIBLE
) {
679 $upgrade = $wgUpdateCompatibleMetadata;
685 $this->upgrading
= true;
686 // Defer updates unless in auto-commit CLI mode
687 DeferredUpdates
::addCallableUpdate( function () {
688 $this->upgrading
= false; // avoid duplicate updates
691 } catch ( LocalFileLockError
$e ) {
692 // let the other process handle it (or do it next time)
699 * @return bool Whether upgradeRow() ran for this object
701 function getUpgraded() {
702 return $this->upgraded
;
706 * Fix assorted version-related problems with the image row by reloading it from the file
708 function upgradeRow() {
711 $this->loadFromFile();
713 # Don't destroy file info of missing files
714 if ( !$this->fileExists
) {
716 wfDebug( __METHOD__
. ": file does not exist, aborting\n" );
721 $dbw = $this->repo
->getMasterDB();
722 list( $major, $minor ) = self
::splitMime( $this->mime
);
724 if ( wfReadOnly() ) {
729 wfDebug( __METHOD__
. ': upgrading ' . $this->getName() . " to the current schema\n" );
731 $dbw->update( 'image',
733 'img_size' => $this->size
, // sanity
734 'img_width' => $this->width
,
735 'img_height' => $this->height
,
736 'img_bits' => $this->bits
,
737 'img_media_type' => $this->media_type
,
738 'img_major_mime' => $major,
739 'img_minor_mime' => $minor,
740 'img_metadata' => $dbw->encodeBlob( $this->metadata
),
741 'img_sha1' => $this->sha1
,
743 [ 'img_name' => $this->getName() ],
747 $this->invalidateCache();
750 $this->upgraded
= true; // avoid rework/retries
754 * Set properties in this object to be equal to those given in the
755 * associative array $info. Only cacheable fields can be set.
756 * All fields *must* be set in $info except for getLazyCacheFields().
758 * If 'mime' is given, it will be split into major_mime/minor_mime.
759 * If major_mime/minor_mime are given, $this->mime will also be set.
763 function setProps( $info ) {
764 $this->dataLoaded
= true;
765 $fields = $this->getCacheFields( '' );
766 $fields[] = 'fileExists';
768 foreach ( $fields as $field ) {
769 if ( isset( $info[$field] ) ) {
770 $this->$field = $info[$field];
774 if ( isset( $info['user'] ) ||
isset( $info['user_text'] ) ||
isset( $info['actor'] ) ) {
775 $this->user
= User
::newFromAnyId(
776 $info['user'] ??
null,
777 $info['user_text'] ??
null,
778 $info['actor'] ??
null
782 // Fix up mime fields
783 if ( isset( $info['major_mime'] ) ) {
784 $this->mime
= "{$info['major_mime']}/{$info['minor_mime']}";
785 } elseif ( isset( $info['mime'] ) ) {
786 $this->mime
= $info['mime'];
787 list( $this->major_mime
, $this->minor_mime
) = self
::splitMime( $this->mime
);
791 /** splitMime inherited */
792 /** getName inherited */
793 /** getTitle inherited */
794 /** getURL inherited */
795 /** getViewURL inherited */
796 /** getPath inherited */
797 /** isVisible inherited */
802 function isMissing() {
803 if ( $this->missing
=== null ) {
804 list( $fileExists ) = $this->repo
->fileExists( $this->getVirtualUrl() );
805 $this->missing
= !$fileExists;
808 return $this->missing
;
812 * Return the width of the image
817 public function getWidth( $page = 1 ) {
825 if ( $this->isMultipage() ) {
826 $handler = $this->getHandler();
830 $dim = $handler->getPageDimensions( $this, $page );
832 return $dim['width'];
834 // For non-paged media, the false goes through an
835 // intval, turning failure into 0, so do same here.
844 * Return the height of the image
849 public function getHeight( $page = 1 ) {
857 if ( $this->isMultipage() ) {
858 $handler = $this->getHandler();
862 $dim = $handler->getPageDimensions( $this, $page );
864 return $dim['height'];
866 // For non-paged media, the false goes through an
867 // intval, turning failure into 0, so do same here.
871 return $this->height
;
876 * Returns user who uploaded the file
878 * @param string $type 'text', 'id', or 'object'
879 * @return int|string|User
880 * @since 1.31 Added 'object'
882 function getUser( $type = 'text' ) {
885 if ( $type === 'object' ) {
887 } elseif ( $type === 'text' ) {
888 return $this->user
->getName();
889 } elseif ( $type === 'id' ) {
890 return $this->user
->getId();
893 throw new MWException( "Unknown type '$type'." );
897 * Get short description URL for a file based on the page ID.
899 * @return string|null
900 * @throws MWException
903 public function getDescriptionShortUrl() {
904 $pageId = $this->title
->getArticleID();
906 if ( $pageId !== null ) {
907 $url = $this->repo
->makeUrl( [ 'curid' => $pageId ] );
908 if ( $url !== false ) {
916 * Get handler-specific metadata
919 function getMetadata() {
920 $this->load( self
::LOAD_ALL
); // large metadata is loaded in another step
921 return $this->metadata
;
927 function getBitDepth() {
930 return (int)$this->bits
;
934 * Returns the size of the image file, in bytes
937 public function getSize() {
944 * Returns the MIME type of the file.
947 function getMimeType() {
954 * Returns the type of the media in the file.
955 * Use the value returned by this function with the MEDIATYPE_xxx constants.
958 function getMediaType() {
961 return $this->media_type
;
964 /** canRender inherited */
965 /** mustRender inherited */
966 /** allowInlineDisplay inherited */
967 /** isSafeFile inherited */
968 /** isTrustedFile inherited */
971 * Returns true if the file exists on disk.
972 * @return bool Whether file exist on disk.
974 public function exists() {
977 return $this->fileExists
;
980 /** getTransformScript inherited */
981 /** getUnscaledThumb inherited */
982 /** thumbName inherited */
983 /** createThumb inherited */
984 /** transform inherited */
986 /** getHandler inherited */
987 /** iconThumb inherited */
988 /** getLastError inherited */
991 * Get all thumbnail names previously generated for this file
992 * @param string|bool $archiveName Name of an archive file, default false
993 * @return array First element is the base dir, then files in that base dir.
995 function getThumbnails( $archiveName = false ) {
996 if ( $archiveName ) {
997 $dir = $this->getArchiveThumbPath( $archiveName );
999 $dir = $this->getThumbPath();
1002 $backend = $this->repo
->getBackend();
1005 $iterator = $backend->getFileList( [ 'dir' => $dir ] );
1006 foreach ( $iterator as $file ) {
1009 } catch ( FileBackendError
$e ) {
1010 } // suppress (T56674)
1016 * Refresh metadata in memcached, but don't touch thumbnails or CDN
1018 function purgeMetadataCache() {
1019 $this->invalidateCache();
1023 * Delete all previously generated thumbnails, refresh metadata in memcached and purge the CDN.
1025 * @param array $options An array potentially with the key forThumbRefresh.
1027 * @note This used to purge old thumbnails by default as well, but doesn't anymore.
1029 function purgeCache( $options = [] ) {
1030 // Refresh metadata cache
1031 $this->purgeMetadataCache();
1033 // Delete thumbnails
1034 $this->purgeThumbnails( $options );
1036 // Purge CDN cache for this file
1037 DeferredUpdates
::addUpdate(
1038 new CdnCacheUpdate( [ $this->getUrl() ] ),
1039 DeferredUpdates
::PRESEND
1044 * Delete cached transformed files for an archived version only.
1045 * @param string $archiveName Name of the archived file
1047 function purgeOldThumbnails( $archiveName ) {
1048 // Get a list of old thumbnails and URLs
1049 $files = $this->getThumbnails( $archiveName );
1051 // Purge any custom thumbnail caches
1052 Hooks
::run( 'LocalFilePurgeThumbnails', [ $this, $archiveName ] );
1054 // Delete thumbnails
1055 $dir = array_shift( $files );
1056 $this->purgeThumbList( $dir, $files );
1060 foreach ( $files as $file ) {
1061 $urls[] = $this->getArchiveThumbUrl( $archiveName, $file );
1063 DeferredUpdates
::addUpdate( new CdnCacheUpdate( $urls ), DeferredUpdates
::PRESEND
);
1067 * Delete cached transformed files for the current version only.
1068 * @param array $options
1070 public function purgeThumbnails( $options = [] ) {
1071 $files = $this->getThumbnails();
1072 // Always purge all files from CDN regardless of handler filters
1074 foreach ( $files as $file ) {
1075 $urls[] = $this->getThumbUrl( $file );
1077 array_shift( $urls ); // don't purge directory
1079 // Give media handler a chance to filter the file purge list
1080 if ( !empty( $options['forThumbRefresh'] ) ) {
1081 $handler = $this->getHandler();
1083 $handler->filterThumbnailPurgeList( $files, $options );
1087 // Purge any custom thumbnail caches
1088 Hooks
::run( 'LocalFilePurgeThumbnails', [ $this, false ] );
1090 // Delete thumbnails
1091 $dir = array_shift( $files );
1092 $this->purgeThumbList( $dir, $files );
1095 DeferredUpdates
::addUpdate( new CdnCacheUpdate( $urls ), DeferredUpdates
::PRESEND
);
1099 * Prerenders a configurable set of thumbnails
1103 public function prerenderThumbnails() {
1104 global $wgUploadThumbnailRenderMap;
1108 $sizes = $wgUploadThumbnailRenderMap;
1111 foreach ( $sizes as $size ) {
1112 if ( $this->isVectorized() ||
$this->getWidth() > $size ) {
1113 $jobs[] = new ThumbnailRenderJob(
1115 [ 'transformParams' => [ 'width' => $size ] ]
1121 JobQueueGroup
::singleton()->lazyPush( $jobs );
1126 * Delete a list of thumbnails visible at urls
1127 * @param string $dir Base dir of the files.
1128 * @param array $files Array of strings: relative filenames (to $dir)
1130 protected function purgeThumbList( $dir, $files ) {
1131 $fileListDebug = strtr(
1132 var_export( $files, true ),
1135 wfDebug( __METHOD__
. ": $fileListDebug\n" );
1138 foreach ( $files as $file ) {
1139 if ( $this->repo
->supportsSha1URLs() ) {
1140 $reference = $this->getSha1();
1142 $reference = $this->getName();
1145 # Check that the reference (filename or sha1) is part of the thumb name
1146 # This is a basic sanity check to avoid erasing unrelated directories
1147 if ( strpos( $file, $reference ) !== false
1148 ||
strpos( $file, "-thumbnail" ) !== false // "short" thumb name
1150 $purgeList[] = "{$dir}/{$file}";
1154 # Delete the thumbnails
1155 $this->repo
->quickPurgeBatch( $purgeList );
1156 # Clear out the thumbnail directory if empty
1157 $this->repo
->quickCleanDir( $dir );
1160 /** purgeDescription inherited */
1161 /** purgeEverything inherited */
1164 * @param int|null $limit Optional: Limit to number of results
1165 * @param string|int|null $start Optional: Timestamp, start from
1166 * @param string|int|null $end Optional: Timestamp, end at
1168 * @return OldLocalFile[]
1170 function getHistory( $limit = null, $start = null, $end = null, $inc = true ) {
1171 $dbr = $this->repo
->getReplicaDB();
1172 $oldFileQuery = OldLocalFile
::getQueryInfo();
1174 $tables = $oldFileQuery['tables'];
1175 $fields = $oldFileQuery['fields'];
1176 $join_conds = $oldFileQuery['joins'];
1177 $conds = $opts = [];
1178 $eq = $inc ?
'=' : '';
1179 $conds[] = "oi_name = " . $dbr->addQuotes( $this->title
->getDBkey() );
1182 $conds[] = "oi_timestamp <$eq " . $dbr->addQuotes( $dbr->timestamp( $start ) );
1186 $conds[] = "oi_timestamp >$eq " . $dbr->addQuotes( $dbr->timestamp( $end ) );
1190 $opts['LIMIT'] = $limit;
1193 // Search backwards for time > x queries
1194 $order = ( !$start && $end !== null ) ?
'ASC' : 'DESC';
1195 $opts['ORDER BY'] = "oi_timestamp $order";
1196 $opts['USE INDEX'] = [ 'oldimage' => 'oi_name_timestamp' ];
1198 // Avoid PHP 7.1 warning from passing $this by reference
1200 Hooks
::run( 'LocalFile::getHistory', [ &$localFile, &$tables, &$fields,
1201 &$conds, &$opts, &$join_conds ] );
1203 $res = $dbr->select( $tables, $fields, $conds, __METHOD__
, $opts, $join_conds );
1206 foreach ( $res as $row ) {
1207 $r[] = $this->repo
->newFileFromRow( $row );
1210 if ( $order == 'ASC' ) {
1211 $r = array_reverse( $r ); // make sure it ends up descending
1218 * Returns the history of this file, line by line.
1219 * starts with current version, then old versions.
1220 * uses $this->historyLine to check which line to return:
1221 * 0 return line for current version
1222 * 1 query for old versions, return first one
1223 * 2, ... return next old version from above query
1226 public function nextHistoryLine() {
1227 # Polymorphic function name to distinguish foreign and local fetches
1228 $fname = static::class . '::' . __FUNCTION__
;
1230 $dbr = $this->repo
->getReplicaDB();
1232 if ( $this->historyLine
== 0 ) { // called for the first time, return line from cur
1233 $fileQuery = self
::getQueryInfo();
1234 $this->historyRes
= $dbr->select( $fileQuery['tables'],
1235 $fileQuery['fields'] +
[
1236 'oi_archive_name' => $dbr->addQuotes( '' ),
1239 [ 'img_name' => $this->title
->getDBkey() ],
1245 if ( $dbr->numRows( $this->historyRes
) == 0 ) {
1246 $this->historyRes
= null;
1250 } elseif ( $this->historyLine
== 1 ) {
1251 $fileQuery = OldLocalFile
::getQueryInfo();
1252 $this->historyRes
= $dbr->select(
1253 $fileQuery['tables'],
1254 $fileQuery['fields'],
1255 [ 'oi_name' => $this->title
->getDBkey() ],
1257 [ 'ORDER BY' => 'oi_timestamp DESC' ],
1261 $this->historyLine++
;
1263 return $dbr->fetchObject( $this->historyRes
);
1267 * Reset the history pointer to the first element of the history
1269 public function resetHistory() {
1270 $this->historyLine
= 0;
1272 if ( !is_null( $this->historyRes
) ) {
1273 $this->historyRes
= null;
1277 /** getHashPath inherited */
1278 /** getRel inherited */
1279 /** getUrlRel inherited */
1280 /** getArchiveRel inherited */
1281 /** getArchivePath inherited */
1282 /** getThumbPath inherited */
1283 /** getArchiveUrl inherited */
1284 /** getThumbUrl inherited */
1285 /** getArchiveVirtualUrl inherited */
1286 /** getThumbVirtualUrl inherited */
1287 /** isHashed inherited */
1290 * Upload a file and record it in the DB
1291 * @param string|FSFile $src Source storage path, virtual URL, or filesystem path
1292 * @param string $comment Upload description
1293 * @param string $pageText Text to use for the new description page,
1294 * if a new description page is created
1295 * @param int|bool $flags Flags for publish()
1296 * @param array|bool $props File properties, if known. This can be used to
1297 * reduce the upload time when uploading virtual URLs for which the file
1298 * info is already known
1299 * @param string|bool $timestamp Timestamp for img_timestamp, or false to use the
1301 * @param User|null $user User object or null to use $wgUser
1302 * @param string[] $tags Change tags to add to the log entry and page revision.
1303 * (This doesn't check $user's permissions.)
1304 * @param bool $createNullRevision Set to false to avoid creation of a null revision on file
1305 * upload, see T193621
1306 * @param bool $revert If this file upload is a revert
1307 * @return Status On success, the value member contains the
1308 * archive name, or an empty string if it was a new file.
1310 function upload( $src, $comment, $pageText, $flags = 0, $props = false,
1311 $timestamp = false, $user = null, $tags = [],
1312 $createNullRevision = true, $revert = false
1314 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
1315 return $this->readOnlyFatalStatus();
1316 } elseif ( MediaWikiServices
::getInstance()->getRevisionStore()->isReadOnly() ) {
1317 // Check this in advance to avoid writing to FileBackend and the file tables,
1318 // only to fail on insert the revision due to the text store being unavailable.
1319 return $this->readOnlyFatalStatus();
1322 $srcPath = ( $src instanceof FSFile
) ?
$src->getPath() : $src;
1324 if ( FileRepo
::isVirtualUrl( $srcPath )
1325 || FileBackend
::isStoragePath( $srcPath )
1327 $props = $this->repo
->getFileProps( $srcPath );
1329 $mwProps = new MWFileProps( MediaWikiServices
::getInstance()->getMimeAnalyzer() );
1330 $props = $mwProps->getPropsFromPath( $srcPath, true );
1335 $handler = MediaHandler
::getHandler( $props['mime'] );
1337 $metadata = Wikimedia\
quietCall( 'unserialize', $props['metadata'] );
1339 if ( !is_array( $metadata ) ) {
1343 $options['headers'] = $handler->getContentHeaders( $metadata );
1345 $options['headers'] = [];
1348 // Trim spaces on user supplied text
1349 $comment = trim( $comment );
1352 $status = $this->publish( $src, $flags, $options );
1354 if ( $status->successCount
>= 2 ) {
1355 // There will be a copy+(one of move,copy,store).
1356 // The first succeeding does not commit us to updating the DB
1357 // since it simply copied the current version to a timestamped file name.
1358 // It is only *preferable* to avoid leaving such files orphaned.
1359 // Once the second operation goes through, then the current version was
1360 // updated and we must therefore update the DB too.
1361 $oldver = $status->value
;
1362 $uploadStatus = $this->recordUpload2(
1370 $createNullRevision,
1373 if ( !$uploadStatus->isOK() ) {
1374 if ( $uploadStatus->hasMessage( 'filenotfound' ) ) {
1375 // update filenotfound error with more specific path
1376 $status->fatal( 'filenotfound', $srcPath );
1378 $status->merge( $uploadStatus );
1388 * Record a file upload in the upload log and the image table
1389 * @param string $oldver
1390 * @param string $desc
1391 * @param string $license
1392 * @param string $copyStatus
1393 * @param string $source
1394 * @param bool $watch
1395 * @param string|bool $timestamp
1396 * @param User|null $user User object or null to use $wgUser
1399 function recordUpload( $oldver, $desc, $license = '', $copyStatus = '', $source = '',
1400 $watch = false, $timestamp = false, User
$user = null ) {
1406 $pageText = SpecialUpload
::getInitialPageText( $desc, $license, $copyStatus, $source );
1408 if ( !$this->recordUpload2( $oldver, $desc, $pageText, false, $timestamp, $user )->isOK() ) {
1413 $user->addWatch( $this->getTitle() );
1420 * Record a file upload in the upload log and the image table
1421 * @param string $oldver
1422 * @param string $comment
1423 * @param string $pageText
1424 * @param bool|array $props
1425 * @param string|bool $timestamp
1426 * @param null|User $user
1427 * @param string[] $tags
1428 * @param bool $createNullRevision Set to false to avoid creation of a null revision on file
1429 * upload, see T193621
1430 * @param bool $revert If this file upload is a revert
1433 function recordUpload2(
1434 $oldver, $comment, $pageText, $props = false, $timestamp = false, $user = null, $tags = [],
1435 $createNullRevision = true, $revert = false
1437 global $wgActorTableSchemaMigrationStage;
1439 if ( is_null( $user ) ) {
1444 $dbw = $this->repo
->getMasterDB();
1446 # Imports or such might force a certain timestamp; otherwise we generate
1447 # it and can fudge it slightly to keep (name,timestamp) unique on re-upload.
1448 if ( $timestamp === false ) {
1449 $timestamp = $dbw->timestamp();
1450 $allowTimeKludge = true;
1452 $allowTimeKludge = false;
1455 $props = $props ?
: $this->repo
->getFileProps( $this->getVirtualUrl() );
1456 $props['description'] = $comment;
1457 $props['user'] = $user->getId();
1458 $props['user_text'] = $user->getName();
1459 $props['actor'] = $user->getActorId( $dbw );
1460 $props['timestamp'] = wfTimestamp( TS_MW
, $timestamp ); // DB -> TS_MW
1461 $this->setProps( $props );
1463 # Fail now if the file isn't there
1464 if ( !$this->fileExists
) {
1465 wfDebug( __METHOD__
. ": File " . $this->getRel() . " went missing!\n" );
1467 return Status
::newFatal( 'filenotfound', $this->getRel() );
1470 $dbw->startAtomic( __METHOD__
);
1472 # Test to see if the row exists using INSERT IGNORE
1473 # This avoids race conditions by locking the row until the commit, and also
1474 # doesn't deadlock. SELECT FOR UPDATE causes a deadlock for every race condition.
1475 $commentStore = MediaWikiServices
::getInstance()->getCommentStore();
1476 $commentFields = $commentStore->insert( $dbw, 'img_description', $comment );
1477 $actorMigration = ActorMigration
::newMigration();
1478 $actorFields = $actorMigration->getInsertValues( $dbw, 'img_user', $user );
1479 $dbw->insert( 'image',
1481 'img_name' => $this->getName(),
1482 'img_size' => $this->size
,
1483 'img_width' => intval( $this->width
),
1484 'img_height' => intval( $this->height
),
1485 'img_bits' => $this->bits
,
1486 'img_media_type' => $this->media_type
,
1487 'img_major_mime' => $this->major_mime
,
1488 'img_minor_mime' => $this->minor_mime
,
1489 'img_timestamp' => $timestamp,
1490 'img_metadata' => $dbw->encodeBlob( $this->metadata
),
1491 'img_sha1' => $this->sha1
1492 ] +
$commentFields +
$actorFields,
1496 $reupload = ( $dbw->affectedRows() == 0 );
1499 $row = $dbw->selectRow(
1501 [ 'img_timestamp', 'img_sha1' ],
1502 [ 'img_name' => $this->getName() ],
1504 [ 'LOCK IN SHARE MODE' ]
1507 if ( $row && $row->img_sha1
=== $this->sha1
) {
1508 $dbw->endAtomic( __METHOD__
);
1509 wfDebug( __METHOD__
. ": File " . $this->getRel() . " already exists!\n" );
1510 $title = Title
::newFromText( $this->getName(), NS_FILE
);
1511 return Status
::newFatal( 'fileexists-no-change', $title->getPrefixedText() );
1514 if ( $allowTimeKludge ) {
1515 # Use LOCK IN SHARE MODE to ignore any transaction snapshotting
1516 $lUnixtime = $row ?
wfTimestamp( TS_UNIX
, $row->img_timestamp
) : false;
1517 # Avoid a timestamp that is not newer than the last version
1518 # TODO: the image/oldimage tables should be like page/revision with an ID field
1519 if ( $lUnixtime && wfTimestamp( TS_UNIX
, $timestamp ) <= $lUnixtime ) {
1520 sleep( 1 ); // fast enough re-uploads would go far in the future otherwise
1521 $timestamp = $dbw->timestamp( $lUnixtime +
1 );
1522 $this->timestamp
= wfTimestamp( TS_MW
, $timestamp ); // DB -> TS_MW
1526 $tables = [ 'image' ];
1528 'oi_name' => 'img_name',
1529 'oi_archive_name' => $dbw->addQuotes( $oldver ),
1530 'oi_size' => 'img_size',
1531 'oi_width' => 'img_width',
1532 'oi_height' => 'img_height',
1533 'oi_bits' => 'img_bits',
1534 'oi_description_id' => 'img_description_id',
1535 'oi_timestamp' => 'img_timestamp',
1536 'oi_metadata' => 'img_metadata',
1537 'oi_media_type' => 'img_media_type',
1538 'oi_major_mime' => 'img_major_mime',
1539 'oi_minor_mime' => 'img_minor_mime',
1540 'oi_sha1' => 'img_sha1',
1544 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_OLD
) {
1545 $fields['oi_user'] = 'img_user';
1546 $fields['oi_user_text'] = 'img_user_text';
1548 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_NEW
) {
1549 $fields['oi_actor'] = 'img_actor';
1553 ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_BOTH
) === SCHEMA_COMPAT_WRITE_BOTH
1555 // Upgrade any rows that are still old-style. Otherwise an upgrade
1556 // might be missed if a deletion happens while the migration script
1558 $res = $dbw->select(
1560 [ 'img_name', 'img_user', 'img_user_text' ],
1561 [ 'img_name' => $this->getName(), 'img_actor' => 0 ],
1564 foreach ( $res as $row ) {
1565 $actorId = User
::newFromAnyId( $row->img_user
, $row->img_user_text
, null )->getActorId( $dbw );
1568 [ 'img_actor' => $actorId ],
1569 [ 'img_name' => $row->img_name
, 'img_actor' => 0 ],
1575 # (T36993) Note: $oldver can be empty here, if the previous
1576 # version of the file was broken. Allow registration of the new
1577 # version to continue anyway, because that's better than having
1578 # an image that's not fixable by user operations.
1579 # Collision, this is an update of a file
1580 # Insert previous contents into oldimage
1581 $dbw->insertSelect( 'oldimage', $tables, $fields,
1582 [ 'img_name' => $this->getName() ], __METHOD__
, [], [], $joins );
1584 # Update the current image row
1585 $dbw->update( 'image',
1587 'img_size' => $this->size
,
1588 'img_width' => intval( $this->width
),
1589 'img_height' => intval( $this->height
),
1590 'img_bits' => $this->bits
,
1591 'img_media_type' => $this->media_type
,
1592 'img_major_mime' => $this->major_mime
,
1593 'img_minor_mime' => $this->minor_mime
,
1594 'img_timestamp' => $timestamp,
1595 'img_metadata' => $dbw->encodeBlob( $this->metadata
),
1596 'img_sha1' => $this->sha1
1597 ] +
$commentFields +
$actorFields,
1598 [ 'img_name' => $this->getName() ],
1603 $descTitle = $this->getTitle();
1604 $descId = $descTitle->getArticleID();
1605 $wikiPage = new WikiFilePage( $descTitle );
1606 $wikiPage->setFile( $this );
1608 // Determine log action. If reupload is done by reverting, use a special log_action.
1609 if ( $revert === true ) {
1610 $logAction = 'revert';
1611 } elseif ( $reupload === true ) {
1612 $logAction = 'overwrite';
1614 $logAction = 'upload';
1616 // Add the log entry...
1617 $logEntry = new ManualLogEntry( 'upload', $logAction );
1618 $logEntry->setTimestamp( $this->timestamp
);
1619 $logEntry->setPerformer( $user );
1620 $logEntry->setComment( $comment );
1621 $logEntry->setTarget( $descTitle );
1622 // Allow people using the api to associate log entries with the upload.
1623 // Log has a timestamp, but sometimes different from upload timestamp.
1624 $logEntry->setParameters(
1626 'img_sha1' => $this->sha1
,
1627 'img_timestamp' => $timestamp,
1630 // Note we keep $logId around since during new image
1631 // creation, page doesn't exist yet, so log_page = 0
1632 // but we want it to point to the page we're making,
1633 // so we later modify the log entry.
1634 // For a similar reason, we avoid making an RC entry
1635 // now and wait until the page exists.
1636 $logId = $logEntry->insert();
1638 if ( $descTitle->exists() ) {
1639 // Use own context to get the action text in content language
1640 $formatter = LogFormatter
::newFromEntry( $logEntry );
1641 $formatter->setContext( RequestContext
::newExtraneousContext( $descTitle ) );
1642 $editSummary = $formatter->getPlainActionText();
1644 $nullRevision = $createNullRevision === false ?
null : Revision
::newNullRevision(
1651 if ( $nullRevision ) {
1652 $nullRevision->insertOn( $dbw );
1654 'NewRevisionFromEditComplete',
1655 [ $wikiPage, $nullRevision, $nullRevision->getParentId(), $user ]
1657 $wikiPage->updateRevisionOn( $dbw, $nullRevision );
1658 // Associate null revision id
1659 $logEntry->setAssociatedRevId( $nullRevision->getId() );
1662 $newPageContent = null;
1664 // Make the description page and RC log entry post-commit
1665 $newPageContent = ContentHandler
::makeContent( $pageText, $descTitle );
1668 # Defer purges, page creation, and link updates in case they error out.
1669 # The most important thing is that files and the DB registry stay synced.
1670 $dbw->endAtomic( __METHOD__
);
1671 $fname = __METHOD__
;
1673 # Do some cache purges after final commit so that:
1674 # a) Changes are more likely to be seen post-purge
1675 # b) They won't cause rollback of the log publish/update above
1676 DeferredUpdates
::addUpdate(
1677 new AutoCommitUpdate(
1681 $reupload, $wikiPage, $newPageContent, $comment, $user,
1682 $logEntry, $logId, $descId, $tags, $fname
1684 # Update memcache after the commit
1685 $this->invalidateCache();
1687 $updateLogPage = false;
1688 if ( $newPageContent ) {
1689 # New file page; create the description page.
1690 # There's already a log entry, so don't make a second RC entry
1691 # CDN and file cache for the description page are purged by doEditContent.
1692 $status = $wikiPage->doEditContent(
1695 EDIT_NEW | EDIT_SUPPRESS_RC
,
1700 if ( isset( $status->value
['revision'] ) ) {
1701 /** @var Revision $rev */
1702 $rev = $status->value
['revision'];
1703 // Associate new page revision id
1704 $logEntry->setAssociatedRevId( $rev->getId() );
1706 // This relies on the resetArticleID() call in WikiPage::insertOn(),
1707 // which is triggered on $descTitle by doEditContent() above.
1708 if ( isset( $status->value
['revision'] ) ) {
1709 /** @var Revision $rev */
1710 $rev = $status->value
['revision'];
1711 $updateLogPage = $rev->getPage();
1714 # Existing file page: invalidate description page cache
1715 $wikiPage->getTitle()->invalidateCache();
1716 $wikiPage->getTitle()->purgeSquid();
1717 # Allow the new file version to be patrolled from the page footer
1718 Article
::purgePatrolFooterCache( $descId );
1721 # Update associated rev id. This should be done by $logEntry->insert() earlier,
1722 # but setAssociatedRevId() wasn't called at that point yet...
1723 $logParams = $logEntry->getParameters();
1724 $logParams['associated_rev_id'] = $logEntry->getAssociatedRevId();
1725 $update = [ 'log_params' => LogEntryBase
::makeParamBlob( $logParams ) ];
1726 if ( $updateLogPage ) {
1727 # Also log page, in case where we just created it above
1728 $update['log_page'] = $updateLogPage;
1730 $this->getRepo()->getMasterDB()->update(
1733 [ 'log_id' => $logId ],
1736 $this->getRepo()->getMasterDB()->insert(
1739 'ls_field' => 'associated_rev_id',
1740 'ls_value' => $logEntry->getAssociatedRevId(),
1741 'ls_log_id' => $logId,
1746 # Add change tags, if any
1748 $logEntry->setTags( $tags );
1751 # Uploads can be patrolled
1752 $logEntry->setIsPatrollable( true );
1754 # Now that the log entry is up-to-date, make an RC entry.
1755 $logEntry->publish( $logId );
1757 # Run hook for other updates (typically more cache purging)
1758 Hooks
::run( 'FileUpload', [ $this, $reupload, !$newPageContent ] );
1761 # Delete old thumbnails
1762 $this->purgeThumbnails();
1763 # Remove the old file from the CDN cache
1764 DeferredUpdates
::addUpdate(
1765 new CdnCacheUpdate( [ $this->getUrl() ] ),
1766 DeferredUpdates
::PRESEND
1769 # Update backlink pages pointing to this title if created
1770 LinksUpdate
::queueRecursiveJobsForTable(
1778 $this->prerenderThumbnails();
1781 DeferredUpdates
::PRESEND
1785 # This is a new file, so update the image count
1786 DeferredUpdates
::addUpdate( SiteStatsUpdate
::factory( [ 'images' => 1 ] ) );
1789 # Invalidate cache for all pages using this file
1790 DeferredUpdates
::addUpdate(
1791 new HTMLCacheUpdate( $this->getTitle(), 'imagelinks', 'file-upload' )
1794 return Status
::newGood();
1798 * Move or copy a file to its public location. If a file exists at the
1799 * destination, move it to an archive. Returns a Status object with
1800 * the archive name in the "value" member on success.
1802 * The archive name should be passed through to recordUpload for database
1805 * @param string|FSFile $src Local filesystem path or virtual URL to the source image
1806 * @param int $flags A bitwise combination of:
1807 * File::DELETE_SOURCE Delete the source file, i.e. move rather than copy
1808 * @param array $options Optional additional parameters
1809 * @return Status On success, the value member contains the
1810 * archive name, or an empty string if it was a new file.
1812 function publish( $src, $flags = 0, array $options = [] ) {
1813 return $this->publishTo( $src, $this->getRel(), $flags, $options );
1817 * Move or copy a file to a specified location. Returns a Status
1818 * object with the archive name in the "value" member on success.
1820 * The archive name should be passed through to recordUpload for database
1823 * @param string|FSFile $src Local filesystem path or virtual URL to the source image
1824 * @param string $dstRel Target relative path
1825 * @param int $flags A bitwise combination of:
1826 * File::DELETE_SOURCE Delete the source file, i.e. move rather than copy
1827 * @param array $options Optional additional parameters
1828 * @return Status On success, the value member contains the
1829 * archive name, or an empty string if it was a new file.
1831 function publishTo( $src, $dstRel, $flags = 0, array $options = [] ) {
1832 $srcPath = ( $src instanceof FSFile
) ?
$src->getPath() : $src;
1834 $repo = $this->getRepo();
1835 if ( $repo->getReadOnlyReason() !== false ) {
1836 return $this->readOnlyFatalStatus();
1841 $archiveName = wfTimestamp( TS_MW
) . '!' . $this->getName();
1842 $archiveRel = $this->getArchiveRel( $archiveName );
1844 if ( $repo->hasSha1Storage() ) {
1845 $sha1 = FileRepo
::isVirtualUrl( $srcPath )
1846 ?
$repo->getFileSha1( $srcPath )
1847 : FSFile
::getSha1Base36FromPath( $srcPath );
1848 /** @var FileBackendDBRepoWrapper $wrapperBackend */
1849 $wrapperBackend = $repo->getBackend();
1850 $dst = $wrapperBackend->getPathForSHA1( $sha1 );
1851 $status = $repo->quickImport( $src, $dst );
1852 if ( $flags & File
::DELETE_SOURCE
) {
1856 if ( $this->exists() ) {
1857 $status->value
= $archiveName;
1860 $flags = $flags & File
::DELETE_SOURCE ? LocalRepo
::DELETE_SOURCE
: 0;
1861 $status = $repo->publish( $srcPath, $dstRel, $archiveRel, $flags, $options );
1863 if ( $status->value
== 'new' ) {
1864 $status->value
= '';
1866 $status->value
= $archiveName;
1874 /** getLinksTo inherited */
1875 /** getExifData inherited */
1876 /** isLocal inherited */
1877 /** wasDeleted inherited */
1880 * Move file to the new title
1882 * Move current, old version and all thumbnails
1883 * to the new filename. Old file is deleted.
1885 * Cache purging is done; checks for validity
1886 * and logging are caller's responsibility
1888 * @param Title $target New file name
1891 function move( $target ) {
1892 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
1893 return $this->readOnlyFatalStatus();
1896 wfDebugLog( 'imagemove', "Got request to move {$this->name} to " . $target->getText() );
1897 $batch = new LocalFileMoveBatch( $this, $target );
1900 $batch->addCurrent();
1901 $archiveNames = $batch->addOlds();
1902 $status = $batch->execute();
1905 wfDebugLog( 'imagemove', "Finished moving {$this->name}" );
1907 // Purge the source and target files...
1908 $oldTitleFile = wfLocalFile( $this->title
);
1909 $newTitleFile = wfLocalFile( $target );
1910 // To avoid slow purges in the transaction, move them outside...
1911 DeferredUpdates
::addUpdate(
1912 new AutoCommitUpdate(
1913 $this->getRepo()->getMasterDB(),
1915 function () use ( $oldTitleFile, $newTitleFile, $archiveNames ) {
1916 $oldTitleFile->purgeEverything();
1917 foreach ( $archiveNames as $archiveName ) {
1918 $oldTitleFile->purgeOldThumbnails( $archiveName );
1920 $newTitleFile->purgeEverything();
1923 DeferredUpdates
::PRESEND
1926 if ( $status->isOK() ) {
1927 // Now switch the object
1928 $this->title
= $target;
1929 // Force regeneration of the name and hashpath
1930 unset( $this->name
);
1931 unset( $this->hashPath
);
1938 * Delete all versions of the file.
1940 * Moves the files into an archive directory (or deletes them)
1941 * and removes the database rows.
1943 * Cache purging is done; logging is caller's responsibility.
1945 * @param string $reason
1946 * @param bool $suppress
1947 * @param User|null $user
1950 function delete( $reason, $suppress = false, $user = null ) {
1951 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
1952 return $this->readOnlyFatalStatus();
1955 $batch = new LocalFileDeleteBatch( $this, $reason, $suppress, $user );
1958 $batch->addCurrent();
1959 // Get old version relative paths
1960 $archiveNames = $batch->addOlds();
1961 $status = $batch->execute();
1964 if ( $status->isOK() ) {
1965 DeferredUpdates
::addUpdate( SiteStatsUpdate
::factory( [ 'images' => -1 ] ) );
1968 // To avoid slow purges in the transaction, move them outside...
1969 DeferredUpdates
::addUpdate(
1970 new AutoCommitUpdate(
1971 $this->getRepo()->getMasterDB(),
1973 function () use ( $archiveNames ) {
1974 $this->purgeEverything();
1975 foreach ( $archiveNames as $archiveName ) {
1976 $this->purgeOldThumbnails( $archiveName );
1980 DeferredUpdates
::PRESEND
1985 foreach ( $archiveNames as $archiveName ) {
1986 $purgeUrls[] = $this->getArchiveUrl( $archiveName );
1988 DeferredUpdates
::addUpdate( new CdnCacheUpdate( $purgeUrls ), DeferredUpdates
::PRESEND
);
1994 * Delete an old version of the file.
1996 * Moves the file into an archive directory (or deletes it)
1997 * and removes the database row.
1999 * Cache purging is done; logging is caller's responsibility.
2001 * @param string $archiveName
2002 * @param string $reason
2003 * @param bool $suppress
2004 * @param User|null $user
2005 * @throws MWException Exception on database or file store failure
2008 function deleteOld( $archiveName, $reason, $suppress = false, $user = null ) {
2009 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
2010 return $this->readOnlyFatalStatus();
2013 $batch = new LocalFileDeleteBatch( $this, $reason, $suppress, $user );
2016 $batch->addOld( $archiveName );
2017 $status = $batch->execute();
2020 $this->purgeOldThumbnails( $archiveName );
2021 if ( $status->isOK() ) {
2022 $this->purgeDescription();
2025 DeferredUpdates
::addUpdate(
2026 new CdnCacheUpdate( [ $this->getArchiveUrl( $archiveName ) ] ),
2027 DeferredUpdates
::PRESEND
2034 * Restore all or specified deleted revisions to the given file.
2035 * Permissions and logging are left to the caller.
2037 * May throw database exceptions on error.
2039 * @param array $versions Set of record ids of deleted items to restore,
2040 * or empty to restore all revisions.
2041 * @param bool $unsuppress
2044 function restore( $versions = [], $unsuppress = false ) {
2045 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
2046 return $this->readOnlyFatalStatus();
2049 $batch = new LocalFileRestoreBatch( $this, $unsuppress );
2055 $batch->addIds( $versions );
2057 $status = $batch->execute();
2058 if ( $status->isGood() ) {
2059 $cleanupStatus = $batch->cleanup();
2060 $cleanupStatus->successCount
= 0;
2061 $cleanupStatus->failCount
= 0;
2062 $status->merge( $cleanupStatus );
2069 /** isMultipage inherited */
2070 /** pageCount inherited */
2071 /** scaleHeight inherited */
2072 /** getImageSize inherited */
2075 * Get the URL of the file description page.
2078 function getDescriptionUrl() {
2079 return $this->title
->getLocalURL();
2083 * Get the HTML text of the description page
2084 * This is not used by ImagePage for local files, since (among other things)
2085 * it skips the parser cache.
2087 * @param Language|null $lang What language to get description in (Optional)
2088 * @return string|false
2090 function getDescriptionText( Language
$lang = null ) {
2091 $store = MediaWikiServices
::getInstance()->getRevisionStore();
2092 $revision = $store->getRevisionByTitle( $this->title
, 0, Revision
::READ_NORMAL
);
2097 $renderer = MediaWikiServices
::getInstance()->getRevisionRenderer();
2098 $rendered = $renderer->getRenderedRevision( $revision, new ParserOptions( null, $lang ) );
2101 // audience check failed
2105 $pout = $rendered->getRevisionParserOutput();
2106 return $pout->getText();
2110 * @param int $audience
2111 * @param User|null $user
2114 function getDescription( $audience = self
::FOR_PUBLIC
, User
$user = null ) {
2116 if ( $audience == self
::FOR_PUBLIC
&& $this->isDeleted( self
::DELETED_COMMENT
) ) {
2118 } elseif ( $audience == self
::FOR_THIS_USER
2119 && !$this->userCan( self
::DELETED_COMMENT
, $user )
2123 return $this->description
;
2128 * @return bool|string
2130 function getTimestamp() {
2133 return $this->timestamp
;
2137 * @return bool|string
2139 public function getDescriptionTouched() {
2140 // The DB lookup might return false, e.g. if the file was just deleted, or the shared DB repo
2141 // itself gets it from elsewhere. To avoid repeating the DB lookups in such a case, we
2142 // need to differentiate between null (uninitialized) and false (failed to load).
2143 if ( $this->descriptionTouched
=== null ) {
2145 'page_namespace' => $this->title
->getNamespace(),
2146 'page_title' => $this->title
->getDBkey()
2148 $touched = $this->repo
->getReplicaDB()->selectField( 'page', 'page_touched', $cond, __METHOD__
);
2149 $this->descriptionTouched
= $touched ?
wfTimestamp( TS_MW
, $touched ) : false;
2152 return $this->descriptionTouched
;
2158 function getSha1() {
2160 // Initialise now if necessary
2161 if ( $this->sha1
== '' && $this->fileExists
) {
2164 $this->sha1
= $this->repo
->getFileSha1( $this->getPath() );
2165 if ( !wfReadOnly() && strval( $this->sha1
) != '' ) {
2166 $dbw = $this->repo
->getMasterDB();
2167 $dbw->update( 'image',
2168 [ 'img_sha1' => $this->sha1
],
2169 [ 'img_name' => $this->getName() ],
2171 $this->invalidateCache();
2181 * @return bool Whether to cache in RepoGroup (this avoids OOMs)
2183 function isCacheable() {
2186 // If extra data (metadata) was not loaded then it must have been large
2187 return $this->extraDataLoaded
2188 && strlen( serialize( $this->metadata
) ) <= self
::CACHE_FIELD_MAX_LEN
;
2195 public function acquireFileLock() {
2196 return Status
::wrap( $this->getRepo()->getBackend()->lockFiles(
2197 [ $this->getPath() ], LockManager
::LOCK_EX
, 10
2205 public function releaseFileLock() {
2206 return Status
::wrap( $this->getRepo()->getBackend()->unlockFiles(
2207 [ $this->getPath() ], LockManager
::LOCK_EX
2212 * Start an atomic DB section and lock the image for update
2213 * or increments a reference counter if the lock is already held
2215 * This method should not be used outside of LocalFile/LocalFile*Batch
2217 * @throws LocalFileLockError Throws an error if the lock was not acquired
2218 * @return bool Whether the file lock owns/spawned the DB transaction
2220 public function lock() {
2221 if ( !$this->locked
) {
2222 $logger = LoggerFactory
::getInstance( 'LocalFile' );
2224 $dbw = $this->repo
->getMasterDB();
2225 $makesTransaction = !$dbw->trxLevel();
2226 $dbw->startAtomic( self
::ATOMIC_SECTION_LOCK
);
2227 // T56736: use simple lock to handle when the file does not exist.
2228 // SELECT FOR UPDATE prevents changes, not other SELECTs with FOR UPDATE.
2229 // Also, that would cause contention on INSERT of similarly named rows.
2230 $status = $this->acquireFileLock(); // represents all versions of the file
2231 if ( !$status->isGood() ) {
2232 $dbw->endAtomic( self
::ATOMIC_SECTION_LOCK
);
2233 $logger->warning( "Failed to lock '{file}'", [ 'file' => $this->name
] );
2235 throw new LocalFileLockError( $status );
2237 // Release the lock *after* commit to avoid row-level contention.
2238 // Make sure it triggers on rollback() as well as commit() (T132921).
2239 $dbw->onTransactionResolution(
2240 function () use ( $logger ) {
2241 $status = $this->releaseFileLock();
2242 if ( !$status->isGood() ) {
2243 $logger->error( "Failed to unlock '{file}'", [ 'file' => $this->name
] );
2248 // Callers might care if the SELECT snapshot is safely fresh
2249 $this->lockedOwnTrx
= $makesTransaction;
2254 return $this->lockedOwnTrx
;
2258 * Decrement the lock reference count and end the atomic section if it reaches zero
2260 * This method should not be used outside of LocalFile/LocalFile*Batch
2262 * The commit and loc release will happen when no atomic sections are active, which
2263 * may happen immediately or at some point after calling this
2265 public function unlock() {
2266 if ( $this->locked
) {
2268 if ( !$this->locked
) {
2269 $dbw = $this->repo
->getMasterDB();
2270 $dbw->endAtomic( self
::ATOMIC_SECTION_LOCK
);
2271 $this->lockedOwnTrx
= false;
2279 protected function readOnlyFatalStatus() {
2280 return $this->getRepo()->newFatal( 'filereadonlyerror', $this->getName(),
2281 $this->getRepo()->getName(), $this->getRepo()->getReadOnlyReason() );
2285 * Clean up any dangling locks
2287 function __destruct() {
2290 } // LocalFile class
2292 # ------------------------------------------------------------------------------
2295 * Helper class for file deletion
2296 * @ingroup FileAbstraction
2298 class LocalFileDeleteBatch
{
2299 /** @var LocalFile */
2306 private $srcRels = [];
2309 private $archiveUrls = [];
2311 /** @var array Items to be processed in the deletion batch */
2312 private $deletionBatch;
2314 /** @var bool Whether to suppress all suppressable fields when deleting */
2325 * @param string $reason
2326 * @param bool $suppress
2327 * @param User|null $user
2329 function __construct( File
$file, $reason = '', $suppress = false, $user = null ) {
2330 $this->file
= $file;
2331 $this->reason
= $reason;
2332 $this->suppress
= $suppress;
2334 $this->user
= $user;
2337 $this->user
= $wgUser;
2339 $this->status
= $file->repo
->newGood();
2342 public function addCurrent() {
2343 $this->srcRels
['.'] = $this->file
->getRel();
2347 * @param string $oldName
2349 public function addOld( $oldName ) {
2350 $this->srcRels
[$oldName] = $this->file
->getArchiveRel( $oldName );
2351 $this->archiveUrls
[] = $this->file
->getArchiveUrl( $oldName );
2355 * Add the old versions of the image to the batch
2356 * @return string[] List of archive names from old versions
2358 public function addOlds() {
2361 $dbw = $this->file
->repo
->getMasterDB();
2362 $result = $dbw->select( 'oldimage',
2363 [ 'oi_archive_name' ],
2364 [ 'oi_name' => $this->file
->getName() ],
2368 foreach ( $result as $row ) {
2369 $this->addOld( $row->oi_archive_name
);
2370 $archiveNames[] = $row->oi_archive_name
;
2373 return $archiveNames;
2379 protected function getOldRels() {
2380 if ( !isset( $this->srcRels
['.'] ) ) {
2381 $oldRels =& $this->srcRels
;
2382 $deleteCurrent = false;
2384 $oldRels = $this->srcRels
;
2385 unset( $oldRels['.'] );
2386 $deleteCurrent = true;
2389 return [ $oldRels, $deleteCurrent ];
2395 protected function getHashes() {
2397 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
2399 if ( $deleteCurrent ) {
2400 $hashes['.'] = $this->file
->getSha1();
2403 if ( count( $oldRels ) ) {
2404 $dbw = $this->file
->repo
->getMasterDB();
2405 $res = $dbw->select(
2407 [ 'oi_archive_name', 'oi_sha1' ],
2408 [ 'oi_archive_name' => array_keys( $oldRels ),
2409 'oi_name' => $this->file
->getName() ], // performance
2413 foreach ( $res as $row ) {
2414 if ( rtrim( $row->oi_sha1
, "\0" ) === '' ) {
2415 // Get the hash from the file
2416 $oldUrl = $this->file
->getArchiveVirtualUrl( $row->oi_archive_name
);
2417 $props = $this->file
->repo
->getFileProps( $oldUrl );
2419 if ( $props['fileExists'] ) {
2420 // Upgrade the oldimage row
2421 $dbw->update( 'oldimage',
2422 [ 'oi_sha1' => $props['sha1'] ],
2423 [ 'oi_name' => $this->file
->getName(), 'oi_archive_name' => $row->oi_archive_name
],
2425 $hashes[$row->oi_archive_name
] = $props['sha1'];
2427 $hashes[$row->oi_archive_name
] = false;
2430 $hashes[$row->oi_archive_name
] = $row->oi_sha1
;
2435 $missing = array_diff_key( $this->srcRels
, $hashes );
2437 foreach ( $missing as $name => $rel ) {
2438 $this->status
->error( 'filedelete-old-unregistered', $name );
2441 foreach ( $hashes as $name => $hash ) {
2443 $this->status
->error( 'filedelete-missing', $this->srcRels
[$name] );
2444 unset( $hashes[$name] );
2451 protected function doDBInserts() {
2452 global $wgActorTableSchemaMigrationStage;
2455 $dbw = $this->file
->repo
->getMasterDB();
2457 $commentStore = MediaWikiServices
::getInstance()->getCommentStore();
2458 $actorMigration = ActorMigration
::newMigration();
2460 $encTimestamp = $dbw->addQuotes( $dbw->timestamp( $now ) );
2461 $encUserId = $dbw->addQuotes( $this->user
->getId() );
2462 $encGroup = $dbw->addQuotes( 'deleted' );
2463 $ext = $this->file
->getExtension();
2464 $dotExt = $ext === '' ?
'' : ".$ext";
2465 $encExt = $dbw->addQuotes( $dotExt );
2466 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
2468 // Bitfields to further suppress the content
2469 if ( $this->suppress
) {
2470 $bitfield = Revision
::SUPPRESSED_ALL
;
2472 $bitfield = 'oi_deleted';
2475 if ( $deleteCurrent ) {
2476 $tables = [ 'image' ];
2478 'fa_storage_group' => $encGroup,
2479 'fa_storage_key' => $dbw->conditional(
2480 [ 'img_sha1' => '' ],
2481 $dbw->addQuotes( '' ),
2482 $dbw->buildConcat( [ "img_sha1", $encExt ] )
2484 'fa_deleted_user' => $encUserId,
2485 'fa_deleted_timestamp' => $encTimestamp,
2486 'fa_deleted' => $this->suppress ?
$bitfield : 0,
2487 'fa_name' => 'img_name',
2488 'fa_archive_name' => 'NULL',
2489 'fa_size' => 'img_size',
2490 'fa_width' => 'img_width',
2491 'fa_height' => 'img_height',
2492 'fa_metadata' => 'img_metadata',
2493 'fa_bits' => 'img_bits',
2494 'fa_media_type' => 'img_media_type',
2495 'fa_major_mime' => 'img_major_mime',
2496 'fa_minor_mime' => 'img_minor_mime',
2497 'fa_description_id' => 'img_description_id',
2498 'fa_timestamp' => 'img_timestamp',
2499 'fa_sha1' => 'img_sha1'
2503 $fields +
= array_map(
2504 [ $dbw, 'addQuotes' ],
2505 $commentStore->insert( $dbw, 'fa_deleted_reason', $this->reason
)
2508 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_OLD
) {
2509 $fields['fa_user'] = 'img_user';
2510 $fields['fa_user_text'] = 'img_user_text';
2512 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_NEW
) {
2513 $fields['fa_actor'] = 'img_actor';
2517 ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_BOTH
) === SCHEMA_COMPAT_WRITE_BOTH
2519 // Upgrade any rows that are still old-style. Otherwise an upgrade
2520 // might be missed if a deletion happens while the migration script
2522 $res = $dbw->select(
2524 [ 'img_name', 'img_user', 'img_user_text' ],
2525 [ 'img_name' => $this->file
->getName(), 'img_actor' => 0 ],
2528 foreach ( $res as $row ) {
2529 $actorId = User
::newFromAnyId( $row->img_user
, $row->img_user_text
, null )->getActorId( $dbw );
2532 [ 'img_actor' => $actorId ],
2533 [ 'img_name' => $row->img_name
, 'img_actor' => 0 ],
2539 $dbw->insertSelect( 'filearchive', $tables, $fields,
2540 [ 'img_name' => $this->file
->getName() ], __METHOD__
, [], [], $joins );
2543 if ( count( $oldRels ) ) {
2544 $fileQuery = OldLocalFile
::getQueryInfo();
2545 $res = $dbw->select(
2546 $fileQuery['tables'],
2547 $fileQuery['fields'],
2549 'oi_name' => $this->file
->getName(),
2550 'oi_archive_name' => array_keys( $oldRels )
2557 if ( $res->numRows() ) {
2558 $reason = $commentStore->createComment( $dbw, $this->reason
);
2559 foreach ( $res as $row ) {
2560 $comment = $commentStore->getComment( 'oi_description', $row );
2561 $user = User
::newFromAnyId( $row->oi_user
, $row->oi_user_text
, $row->oi_actor
);
2563 // Deletion-specific fields
2564 'fa_storage_group' => 'deleted',
2565 'fa_storage_key' => ( $row->oi_sha1
=== '' )
2567 : "{$row->oi_sha1}{$dotExt}",
2568 'fa_deleted_user' => $this->user
->getId(),
2569 'fa_deleted_timestamp' => $dbw->timestamp( $now ),
2570 // Counterpart fields
2571 'fa_deleted' => $this->suppress ?
$bitfield : $row->oi_deleted
,
2572 'fa_name' => $row->oi_name
,
2573 'fa_archive_name' => $row->oi_archive_name
,
2574 'fa_size' => $row->oi_size
,
2575 'fa_width' => $row->oi_width
,
2576 'fa_height' => $row->oi_height
,
2577 'fa_metadata' => $row->oi_metadata
,
2578 'fa_bits' => $row->oi_bits
,
2579 'fa_media_type' => $row->oi_media_type
,
2580 'fa_major_mime' => $row->oi_major_mime
,
2581 'fa_minor_mime' => $row->oi_minor_mime
,
2582 'fa_timestamp' => $row->oi_timestamp
,
2583 'fa_sha1' => $row->oi_sha1
2584 ] +
$commentStore->insert( $dbw, 'fa_deleted_reason', $reason )
2585 +
$commentStore->insert( $dbw, 'fa_description', $comment )
2586 +
$actorMigration->getInsertValues( $dbw, 'fa_user', $user );
2590 $dbw->insert( 'filearchive', $rowsInsert, __METHOD__
);
2594 function doDBDeletes() {
2595 $dbw = $this->file
->repo
->getMasterDB();
2596 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
2598 if ( count( $oldRels ) ) {
2599 $dbw->delete( 'oldimage',
2601 'oi_name' => $this->file
->getName(),
2602 'oi_archive_name' => array_keys( $oldRels )
2606 if ( $deleteCurrent ) {
2607 $dbw->delete( 'image', [ 'img_name' => $this->file
->getName() ], __METHOD__
);
2612 * Run the transaction
2615 public function execute() {
2616 $repo = $this->file
->getRepo();
2617 $this->file
->lock();
2619 // Prepare deletion batch
2620 $hashes = $this->getHashes();
2621 $this->deletionBatch
= [];
2622 $ext = $this->file
->getExtension();
2623 $dotExt = $ext === '' ?
'' : ".$ext";
2625 foreach ( $this->srcRels
as $name => $srcRel ) {
2626 // Skip files that have no hash (e.g. missing DB record, or sha1 field and file source)
2627 if ( isset( $hashes[$name] ) ) {
2628 $hash = $hashes[$name];
2629 $key = $hash . $dotExt;
2630 $dstRel = $repo->getDeletedHashPath( $key ) . $key;
2631 $this->deletionBatch
[$name] = [ $srcRel, $dstRel ];
2635 if ( !$repo->hasSha1Storage() ) {
2636 // Removes non-existent file from the batch, so we don't get errors.
2637 // This also handles files in the 'deleted' zone deleted via revision deletion.
2638 $checkStatus = $this->removeNonexistentFiles( $this->deletionBatch
);
2639 if ( !$checkStatus->isGood() ) {
2640 $this->status
->merge( $checkStatus );
2641 return $this->status
;
2643 $this->deletionBatch
= $checkStatus->value
;
2645 // Execute the file deletion batch
2646 $status = $this->file
->repo
->deleteBatch( $this->deletionBatch
);
2647 if ( !$status->isGood() ) {
2648 $this->status
->merge( $status );
2652 if ( !$this->status
->isOK() ) {
2653 // Critical file deletion error; abort
2654 $this->file
->unlock();
2656 return $this->status
;
2659 // Copy the image/oldimage rows to filearchive
2660 $this->doDBInserts();
2661 // Delete image/oldimage rows
2662 $this->doDBDeletes();
2664 // Commit and return
2665 $this->file
->unlock();
2667 return $this->status
;
2671 * Removes non-existent files from a deletion batch.
2672 * @param array $batch
2675 protected function removeNonexistentFiles( $batch ) {
2676 $files = $newBatch = [];
2678 foreach ( $batch as $batchItem ) {
2679 list( $src, ) = $batchItem;
2680 $files[$src] = $this->file
->repo
->getVirtualUrl( 'public' ) . '/' . rawurlencode( $src );
2683 $result = $this->file
->repo
->fileExistsBatch( $files );
2684 if ( in_array( null, $result, true ) ) {
2685 return Status
::newFatal( 'backend-fail-internal',
2686 $this->file
->repo
->getBackend()->getName() );
2689 foreach ( $batch as $batchItem ) {
2690 if ( $result[$batchItem[0]] ) {
2691 $newBatch[] = $batchItem;
2695 return Status
::newGood( $newBatch );
2699 # ------------------------------------------------------------------------------
2702 * Helper class for file undeletion
2703 * @ingroup FileAbstraction
2705 class LocalFileRestoreBatch
{
2706 /** @var LocalFile */
2709 /** @var string[] List of file IDs to restore */
2710 private $cleanupBatch;
2712 /** @var string[] List of file IDs to restore */
2715 /** @var bool Add all revisions of the file */
2718 /** @var bool Whether to remove all settings for suppressed fields */
2719 private $unsuppress = false;
2723 * @param bool $unsuppress
2725 function __construct( File
$file, $unsuppress = false ) {
2726 $this->file
= $file;
2727 $this->cleanupBatch
= [];
2729 $this->unsuppress
= $unsuppress;
2736 public function addId( $fa_id ) {
2737 $this->ids
[] = $fa_id;
2741 * Add a whole lot of files by ID
2744 public function addIds( $ids ) {
2745 $this->ids
= array_merge( $this->ids
, $ids );
2749 * Add all revisions of the file
2751 public function addAll() {
2756 * Run the transaction, except the cleanup batch.
2757 * The cleanup batch should be run in a separate transaction, because it locks different
2758 * rows and there's no need to keep the image row locked while it's acquiring those locks
2759 * The caller may have its own transaction open.
2760 * So we save the batch and let the caller call cleanup()
2763 public function execute() {
2764 /** @var Language */
2767 $repo = $this->file
->getRepo();
2768 if ( !$this->all
&& !$this->ids
) {
2770 return $repo->newGood();
2773 $lockOwnsTrx = $this->file
->lock();
2775 $dbw = $this->file
->repo
->getMasterDB();
2777 $commentStore = MediaWikiServices
::getInstance()->getCommentStore();
2778 $actorMigration = ActorMigration
::newMigration();
2780 $status = $this->file
->repo
->newGood();
2782 $exists = (bool)$dbw->selectField( 'image', '1',
2783 [ 'img_name' => $this->file
->getName() ],
2785 // The lock() should already prevents changes, but this still may need
2786 // to bypass any transaction snapshot. However, if lock() started the
2787 // trx (which it probably did) then snapshot is post-lock and up-to-date.
2788 $lockOwnsTrx ?
[] : [ 'LOCK IN SHARE MODE' ]
2791 // Fetch all or selected archived revisions for the file,
2792 // sorted from the most recent to the oldest.
2793 $conditions = [ 'fa_name' => $this->file
->getName() ];
2795 if ( !$this->all
) {
2796 $conditions['fa_id'] = $this->ids
;
2799 $arFileQuery = ArchivedFile
::getQueryInfo();
2800 $result = $dbw->select(
2801 $arFileQuery['tables'],
2802 $arFileQuery['fields'],
2805 [ 'ORDER BY' => 'fa_timestamp DESC' ],
2806 $arFileQuery['joins']
2812 $insertCurrent = false;
2817 foreach ( $result as $row ) {
2818 $idsPresent[] = $row->fa_id
;
2820 if ( $row->fa_name
!= $this->file
->getName() ) {
2821 $status->error( 'undelete-filename-mismatch', $wgLang->timeanddate( $row->fa_timestamp
) );
2822 $status->failCount++
;
2826 if ( $row->fa_storage_key
== '' ) {
2827 // Revision was missing pre-deletion
2828 $status->error( 'undelete-bad-store-key', $wgLang->timeanddate( $row->fa_timestamp
) );
2829 $status->failCount++
;
2833 $deletedRel = $repo->getDeletedHashPath( $row->fa_storage_key
) .
2834 $row->fa_storage_key
;
2835 $deletedUrl = $repo->getVirtualUrl() . '/deleted/' . $deletedRel;
2837 if ( isset( $row->fa_sha1
) ) {
2838 $sha1 = $row->fa_sha1
;
2840 // old row, populate from key
2841 $sha1 = LocalRepo
::getHashFromKey( $row->fa_storage_key
);
2845 if ( strlen( $sha1 ) == 32 && $sha1[0] == '0' ) {
2846 $sha1 = substr( $sha1, 1 );
2849 if ( is_null( $row->fa_major_mime
) ||
$row->fa_major_mime
== 'unknown'
2850 ||
is_null( $row->fa_minor_mime
) ||
$row->fa_minor_mime
== 'unknown'
2851 ||
is_null( $row->fa_media_type
) ||
$row->fa_media_type
== 'UNKNOWN'
2852 ||
is_null( $row->fa_metadata
)
2854 // Refresh our metadata
2855 // Required for a new current revision; nice for older ones too. :)
2856 $props = RepoGroup
::singleton()->getFileProps( $deletedUrl );
2859 'minor_mime' => $row->fa_minor_mime
,
2860 'major_mime' => $row->fa_major_mime
,
2861 'media_type' => $row->fa_media_type
,
2862 'metadata' => $row->fa_metadata
2866 $comment = $commentStore->getComment( 'fa_description', $row );
2867 $user = User
::newFromAnyId( $row->fa_user
, $row->fa_user_text
, $row->fa_actor
);
2868 if ( $first && !$exists ) {
2869 // This revision will be published as the new current version
2870 $destRel = $this->file
->getRel();
2871 $commentFields = $commentStore->insert( $dbw, 'img_description', $comment );
2872 $actorFields = $actorMigration->getInsertValues( $dbw, 'img_user', $user );
2874 'img_name' => $row->fa_name
,
2875 'img_size' => $row->fa_size
,
2876 'img_width' => $row->fa_width
,
2877 'img_height' => $row->fa_height
,
2878 'img_metadata' => $props['metadata'],
2879 'img_bits' => $row->fa_bits
,
2880 'img_media_type' => $props['media_type'],
2881 'img_major_mime' => $props['major_mime'],
2882 'img_minor_mime' => $props['minor_mime'],
2883 'img_timestamp' => $row->fa_timestamp
,
2885 ] +
$commentFields +
$actorFields;
2887 // The live (current) version cannot be hidden!
2888 if ( !$this->unsuppress
&& $row->fa_deleted
) {
2889 $status->fatal( 'undeleterevdel' );
2890 $this->file
->unlock();
2894 $archiveName = $row->fa_archive_name
;
2896 if ( $archiveName == '' ) {
2897 // This was originally a current version; we
2898 // have to devise a new archive name for it.
2899 // Format is <timestamp of archiving>!<name>
2900 $timestamp = wfTimestamp( TS_UNIX
, $row->fa_deleted_timestamp
);
2903 $archiveName = wfTimestamp( TS_MW
, $timestamp ) . '!' . $row->fa_name
;
2905 } while ( isset( $archiveNames[$archiveName] ) );
2908 $archiveNames[$archiveName] = true;
2909 $destRel = $this->file
->getArchiveRel( $archiveName );
2911 'oi_name' => $row->fa_name
,
2912 'oi_archive_name' => $archiveName,
2913 'oi_size' => $row->fa_size
,
2914 'oi_width' => $row->fa_width
,
2915 'oi_height' => $row->fa_height
,
2916 'oi_bits' => $row->fa_bits
,
2917 'oi_timestamp' => $row->fa_timestamp
,
2918 'oi_metadata' => $props['metadata'],
2919 'oi_media_type' => $props['media_type'],
2920 'oi_major_mime' => $props['major_mime'],
2921 'oi_minor_mime' => $props['minor_mime'],
2922 'oi_deleted' => $this->unsuppress ?
0 : $row->fa_deleted
,
2924 ] +
$commentStore->insert( $dbw, 'oi_description', $comment )
2925 +
$actorMigration->getInsertValues( $dbw, 'oi_user', $user );
2928 $deleteIds[] = $row->fa_id
;
2930 if ( !$this->unsuppress
&& $row->fa_deleted
& File
::DELETED_FILE
) {
2931 // private files can stay where they are
2932 $status->successCount++
;
2934 $storeBatch[] = [ $deletedUrl, 'public', $destRel ];
2935 $this->cleanupBatch
[] = $row->fa_storage_key
;
2943 // Add a warning to the status object for missing IDs
2944 $missingIds = array_diff( $this->ids
, $idsPresent );
2946 foreach ( $missingIds as $id ) {
2947 $status->error( 'undelete-missing-filearchive', $id );
2950 if ( !$repo->hasSha1Storage() ) {
2951 // Remove missing files from batch, so we don't get errors when undeleting them
2952 $checkStatus = $this->removeNonexistentFiles( $storeBatch );
2953 if ( !$checkStatus->isGood() ) {
2954 $status->merge( $checkStatus );
2957 $storeBatch = $checkStatus->value
;
2959 // Run the store batch
2960 // Use the OVERWRITE_SAME flag to smooth over a common error
2961 $storeStatus = $this->file
->repo
->storeBatch( $storeBatch, FileRepo
::OVERWRITE_SAME
);
2962 $status->merge( $storeStatus );
2964 if ( !$status->isGood() ) {
2965 // Even if some files could be copied, fail entirely as that is the
2966 // easiest thing to do without data loss
2967 $this->cleanupFailedBatch( $storeStatus, $storeBatch );
2968 $status->setOK( false );
2969 $this->file
->unlock();
2975 // Run the DB updates
2976 // Because we have locked the image row, key conflicts should be rare.
2977 // If they do occur, we can roll back the transaction at this time with
2978 // no data loss, but leaving unregistered files scattered throughout the
2980 // This is not ideal, which is why it's important to lock the image row.
2981 if ( $insertCurrent ) {
2982 $dbw->insert( 'image', $insertCurrent, __METHOD__
);
2985 if ( $insertBatch ) {
2986 $dbw->insert( 'oldimage', $insertBatch, __METHOD__
);
2990 $dbw->delete( 'filearchive',
2991 [ 'fa_id' => $deleteIds ],
2995 // If store batch is empty (all files are missing), deletion is to be considered successful
2996 if ( $status->successCount
> 0 ||
!$storeBatch ||
$repo->hasSha1Storage() ) {
2998 wfDebug( __METHOD__
. " restored {$status->successCount} items, creating a new current\n" );
3000 DeferredUpdates
::addUpdate( SiteStatsUpdate
::factory( [ 'images' => 1 ] ) );
3002 $this->file
->purgeEverything();
3004 wfDebug( __METHOD__
. " restored {$status->successCount} as archived versions\n" );
3005 $this->file
->purgeDescription();
3009 $this->file
->unlock();
3015 * Removes non-existent files from a store batch.
3016 * @param array $triplets
3019 protected function removeNonexistentFiles( $triplets ) {
3020 $files = $filteredTriplets = [];
3021 foreach ( $triplets as $file ) {
3022 $files[$file[0]] = $file[0];
3025 $result = $this->file
->repo
->fileExistsBatch( $files );
3026 if ( in_array( null, $result, true ) ) {
3027 return Status
::newFatal( 'backend-fail-internal',
3028 $this->file
->repo
->getBackend()->getName() );
3031 foreach ( $triplets as $file ) {
3032 if ( $result[$file[0]] ) {
3033 $filteredTriplets[] = $file;
3037 return Status
::newGood( $filteredTriplets );
3041 * Removes non-existent files from a cleanup batch.
3042 * @param string[] $batch
3045 protected function removeNonexistentFromCleanup( $batch ) {
3046 $files = $newBatch = [];
3047 $repo = $this->file
->repo
;
3049 foreach ( $batch as $file ) {
3050 $files[$file] = $repo->getVirtualUrl( 'deleted' ) . '/' .
3051 rawurlencode( $repo->getDeletedHashPath( $file ) . $file );
3054 $result = $repo->fileExistsBatch( $files );
3056 foreach ( $batch as $file ) {
3057 if ( $result[$file] ) {
3058 $newBatch[] = $file;
3066 * Delete unused files in the deleted zone.
3067 * This should be called from outside the transaction in which execute() was called.
3070 public function cleanup() {
3071 if ( !$this->cleanupBatch
) {
3072 return $this->file
->repo
->newGood();
3075 $this->cleanupBatch
= $this->removeNonexistentFromCleanup( $this->cleanupBatch
);
3077 $status = $this->file
->repo
->cleanupDeletedBatch( $this->cleanupBatch
);
3083 * Cleanup a failed batch. The batch was only partially successful, so
3084 * rollback by removing all items that were successfully copied.
3086 * @param Status $storeStatus
3087 * @param array[] $storeBatch
3089 protected function cleanupFailedBatch( $storeStatus, $storeBatch ) {
3092 foreach ( $storeStatus->success
as $i => $success ) {
3093 // Check if this item of the batch was successfully copied
3095 // Item was successfully copied and needs to be removed again
3096 // Extract ($dstZone, $dstRel) from the batch
3097 $cleanupBatch[] = [ $storeBatch[$i][1], $storeBatch[$i][2] ];
3100 $this->file
->repo
->cleanupBatch( $cleanupBatch );
3104 # ------------------------------------------------------------------------------
3107 * Helper class for file movement
3108 * @ingroup FileAbstraction
3110 class LocalFileMoveBatch
{
3111 /** @var LocalFile */
3121 protected $oldCount;
3125 /** @var IDatabase */
3130 * @param Title $target
3132 function __construct( File
$file, Title
$target ) {
3133 $this->file
= $file;
3134 $this->target
= $target;
3135 $this->oldHash
= $this->file
->repo
->getHashPath( $this->file
->getName() );
3136 $this->newHash
= $this->file
->repo
->getHashPath( $this->target
->getDBkey() );
3137 $this->oldName
= $this->file
->getName();
3138 $this->newName
= $this->file
->repo
->getNameFromTitle( $this->target
);
3139 $this->oldRel
= $this->oldHash
. $this->oldName
;
3140 $this->newRel
= $this->newHash
. $this->newName
;
3141 $this->db
= $file->getRepo()->getMasterDB();
3145 * Add the current image to the batch
3147 public function addCurrent() {
3148 $this->cur
= [ $this->oldRel
, $this->newRel
];
3152 * Add the old versions of the image to the batch
3153 * @return string[] List of archive names from old versions
3155 public function addOlds() {
3156 $archiveBase = 'archive';
3158 $this->oldCount
= 0;
3161 $result = $this->db
->select( 'oldimage',
3162 [ 'oi_archive_name', 'oi_deleted' ],
3163 [ 'oi_name' => $this->oldName
],
3165 [ 'LOCK IN SHARE MODE' ] // ignore snapshot
3168 foreach ( $result as $row ) {
3169 $archiveNames[] = $row->oi_archive_name
;
3170 $oldName = $row->oi_archive_name
;
3171 $bits = explode( '!', $oldName, 2 );
3173 if ( count( $bits ) != 2 ) {
3174 wfDebug( "Old file name missing !: '$oldName' \n" );
3178 list( $timestamp, $filename ) = $bits;
3180 if ( $this->oldName
!= $filename ) {
3181 wfDebug( "Old file name doesn't match: '$oldName' \n" );
3187 // Do we want to add those to oldCount?
3188 if ( $row->oi_deleted
& File
::DELETED_FILE
) {
3193 "{$archiveBase}/{$this->oldHash}{$oldName}",
3194 "{$archiveBase}/{$this->newHash}{$timestamp}!{$this->newName}"
3198 return $archiveNames;
3205 public function execute() {
3206 $repo = $this->file
->repo
;
3207 $status = $repo->newGood();
3208 $destFile = wfLocalFile( $this->target
);
3210 $this->file
->lock();
3211 $destFile->lock(); // quickly fail if destination is not available
3213 $triplets = $this->getMoveTriplets();
3214 $checkStatus = $this->removeNonexistentFiles( $triplets );
3215 if ( !$checkStatus->isGood() ) {
3216 $destFile->unlock();
3217 $this->file
->unlock();
3218 $status->merge( $checkStatus ); // couldn't talk to file backend
3221 $triplets = $checkStatus->value
;
3223 // Verify the file versions metadata in the DB.
3224 $statusDb = $this->verifyDBUpdates();
3225 if ( !$statusDb->isGood() ) {
3226 $destFile->unlock();
3227 $this->file
->unlock();
3228 $statusDb->setOK( false );
3233 if ( !$repo->hasSha1Storage() ) {
3234 // Copy the files into their new location.
3235 // If a prior process fataled copying or cleaning up files we tolerate any
3236 // of the existing files if they are identical to the ones being stored.
3237 $statusMove = $repo->storeBatch( $triplets, FileRepo
::OVERWRITE_SAME
);
3238 wfDebugLog( 'imagemove', "Moved files for {$this->file->getName()}: " .
3239 "{$statusMove->successCount} successes, {$statusMove->failCount} failures" );
3240 if ( !$statusMove->isGood() ) {
3241 // Delete any files copied over (while the destination is still locked)
3242 $this->cleanupTarget( $triplets );
3243 $destFile->unlock();
3244 $this->file
->unlock();
3245 wfDebugLog( 'imagemove', "Error in moving files: "
3246 . $statusMove->getWikiText( false, false, 'en' ) );
3247 $statusMove->setOK( false );
3251 $status->merge( $statusMove );
3254 // Rename the file versions metadata in the DB.
3255 $this->doDBUpdates();
3257 wfDebugLog( 'imagemove', "Renamed {$this->file->getName()} in database: " .
3258 "{$statusDb->successCount} successes, {$statusDb->failCount} failures" );
3260 $destFile->unlock();
3261 $this->file
->unlock();
3263 // Everything went ok, remove the source files
3264 $this->cleanupSource( $triplets );
3266 $status->merge( $statusDb );
3272 * Verify the database updates and return a new Status indicating how
3273 * many rows would be updated.
3277 protected function verifyDBUpdates() {
3278 $repo = $this->file
->repo
;
3279 $status = $repo->newGood();
3282 $hasCurrent = $dbw->lockForUpdate(
3284 [ 'img_name' => $this->oldName
],
3287 $oldRowCount = $dbw->lockForUpdate(
3289 [ 'oi_name' => $this->oldName
],
3293 if ( $hasCurrent ) {
3294 $status->successCount++
;
3296 $status->failCount++
;
3298 $status->successCount +
= $oldRowCount;
3299 // T36934: oldCount is based on files that actually exist.
3300 // There may be more DB rows than such files, in which case $affected
3301 // can be greater than $total. We use max() to avoid negatives here.
3302 $status->failCount +
= max( 0, $this->oldCount
- $oldRowCount );
3303 if ( $status->failCount
) {
3304 $status->error( 'imageinvalidfilename' );
3311 * Do the database updates and return a new Status indicating how
3312 * many rows where updated.
3314 protected function doDBUpdates() {
3317 // Update current image
3320 [ 'img_name' => $this->newName
],
3321 [ 'img_name' => $this->oldName
],
3325 // Update old images
3329 'oi_name' => $this->newName
,
3330 'oi_archive_name = ' . $dbw->strreplace( 'oi_archive_name',
3331 $dbw->addQuotes( $this->oldName
), $dbw->addQuotes( $this->newName
) ),
3333 [ 'oi_name' => $this->oldName
],
3339 * Generate triplets for FileRepo::storeBatch().
3342 protected function getMoveTriplets() {
3343 $moves = array_merge( [ $this->cur
], $this->olds
);
3344 $triplets = []; // The format is: (srcUrl, destZone, destUrl)
3346 foreach ( $moves as $move ) {
3347 // $move: (oldRelativePath, newRelativePath)
3348 $srcUrl = $this->file
->repo
->getVirtualUrl() . '/public/' . rawurlencode( $move[0] );
3349 $triplets[] = [ $srcUrl, 'public', $move[1] ];
3352 "Generated move triplet for {$this->file->getName()}: {$srcUrl} :: public :: {$move[1]}"
3360 * Removes non-existent files from move batch.
3361 * @param array $triplets
3364 protected function removeNonexistentFiles( $triplets ) {
3367 foreach ( $triplets as $file ) {
3368 $files[$file[0]] = $file[0];
3371 $result = $this->file
->repo
->fileExistsBatch( $files );
3372 if ( in_array( null, $result, true ) ) {
3373 return Status
::newFatal( 'backend-fail-internal',
3374 $this->file
->repo
->getBackend()->getName() );
3377 $filteredTriplets = [];
3378 foreach ( $triplets as $file ) {
3379 if ( $result[$file[0]] ) {
3380 $filteredTriplets[] = $file;
3382 wfDebugLog( 'imagemove', "File {$file[0]} does not exist" );
3386 return Status
::newGood( $filteredTriplets );
3390 * Cleanup a partially moved array of triplets by deleting the target
3391 * files. Called if something went wrong half way.
3392 * @param array[] $triplets
3394 protected function cleanupTarget( $triplets ) {
3395 // Create dest pairs from the triplets
3397 foreach ( $triplets as $triplet ) {
3398 // $triplet: (old source virtual URL, dst zone, dest rel)
3399 $pairs[] = [ $triplet[1], $triplet[2] ];
3402 $this->file
->repo
->cleanupBatch( $pairs );
3406 * Cleanup a fully moved array of triplets by deleting the source files.
3407 * Called at the end of the move process if everything else went ok.
3408 * @param array[] $triplets
3410 protected function cleanupSource( $triplets ) {
3411 // Create source file names from the triplets
3413 foreach ( $triplets as $triplet ) {
3414 $files[] = $triplet[0];
3417 $this->file
->repo
->cleanupBatch( $files );
3421 class LocalFileLockError
extends ErrorPageError
{
3422 public function __construct( Status
$status ) {
3423 parent
::__construct(
3425 $status->getMessage()
3429 public function report() {
3431 $wgOut->setStatusCode( 429 );