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
25 * Bump this number when serialized cache records may be incompatible.
27 define( 'MW_FILE_VERSION', 9 );
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 CACHE_FIELD_MAX_LEN
= 1000;
49 /** @var bool Does the file exist on disk? (loadFromXxx) */
50 protected $fileExists;
52 /** @var int Image width */
55 /** @var int Image height */
58 /** @var int Returned by getimagesize (loadFromXxx) */
61 /** @var string MEDIATYPE_xxx (bitmap, drawing, audio...) */
62 protected $media_type;
64 /** @var string MIME type, determined by MimeMagic::guessMimeType */
67 /** @var int Size in bytes (loadFromXxx) */
70 /** @var string Handler-specific metadata */
73 /** @var string SHA-1 base 36 content hash */
76 /** @var bool Whether or not core data has been loaded from the database (loadFromXxx) */
77 protected $dataLoaded;
79 /** @var bool Whether or not lazy-loaded data has been loaded from the database */
80 protected $extraDataLoaded;
82 /** @var int Bitfield akin to rev_deleted */
86 protected $repoClass = 'LocalRepo';
88 /** @var int Number of line to return by nextHistoryLine() (constructor) */
91 /** @var int Result of the query for the file's history (nextHistoryLine) */
94 /** @var string Major MIME type */
97 /** @var string Minor MIME type */
100 /** @var string Upload timestamp */
103 /** @var int User ID of uploader */
106 /** @var string User name of uploader */
109 /** @var string Description of current revision of the file */
110 private $description;
112 /** @var string TS_MW timestamp of the last change of the file description */
113 private $descriptionTouched;
115 /** @var bool Whether the row was upgraded on load */
118 /** @var bool True if the image row is locked */
121 /** @var bool True if the image row is locked with a lock initiated transaction */
122 private $lockedOwnTrx;
124 /** @var bool True if file is not present in file system. Not to be cached in memcached */
127 // @note: higher than IDBAccessObject constants
128 const LOAD_ALL
= 16; // integer; load all the lazy fields too (like metadata)
131 * Create a LocalFile from a title
132 * Do not call this except from inside a repo class.
134 * Note: $unused param is only here to avoid an E_STRICT
136 * @param Title $title
137 * @param FileRepo $repo
138 * @param null $unused
142 static function newFromTitle( $title, $repo, $unused = null ) {
143 return new self( $title, $repo );
147 * Create a LocalFile from a title
148 * Do not call this except from inside a repo class.
150 * @param stdClass $row
151 * @param FileRepo $repo
155 static function newFromRow( $row, $repo ) {
156 $title = Title
::makeTitle( NS_FILE
, $row->img_name
);
157 $file = new self( $title, $repo );
158 $file->loadFromRow( $row );
164 * Create a LocalFile from a SHA-1 key
165 * Do not call this except from inside a repo class.
167 * @param string $sha1 Base-36 SHA-1
168 * @param LocalRepo $repo
169 * @param string|bool $timestamp MW_timestamp (optional)
170 * @return bool|LocalFile
172 static function newFromKey( $sha1, $repo, $timestamp = false ) {
173 $dbr = $repo->getSlaveDB();
175 $conds = array( 'img_sha1' => $sha1 );
177 $conds['img_timestamp'] = $dbr->timestamp( $timestamp );
180 $row = $dbr->selectRow( 'image', self
::selectFields(), $conds, __METHOD__
);
182 return self
::newFromRow( $row, $repo );
189 * Fields in the image table
192 static function selectFields() {
213 * Do not call this except from inside a repo class.
214 * @param Title $title
215 * @param FileRepo $repo
217 function __construct( $title, $repo ) {
218 parent
::__construct( $title, $repo );
220 $this->metadata
= '';
221 $this->historyLine
= 0;
222 $this->historyRes
= null;
223 $this->dataLoaded
= false;
224 $this->extraDataLoaded
= false;
226 $this->assertRepoDefined();
227 $this->assertTitleDefined();
231 * Get the memcached key for the main data for this file, or false if
232 * there is no access to the shared cache.
233 * @return string|bool
235 function getCacheKey() {
236 $hashedName = md5( $this->getName() );
238 return $this->repo
->getSharedCacheKey( 'file', $hashedName );
242 * Try to load file metadata from memcached. Returns true on success.
245 function loadFromCache() {
246 $this->dataLoaded
= false;
247 $this->extraDataLoaded
= false;
248 $key = $this->getCacheKey();
254 $cache = ObjectCache
::getMainWANInstance();
255 $cachedValues = $cache->get( $key );
257 // Check if the key existed and belongs to this version of MediaWiki
258 if ( is_array( $cachedValues ) && $cachedValues['version'] == MW_FILE_VERSION
) {
259 wfDebug( "Pulling file metadata from cache key $key\n" );
260 $this->fileExists
= $cachedValues['fileExists'];
261 if ( $this->fileExists
) {
262 $this->setProps( $cachedValues );
264 $this->dataLoaded
= true;
265 $this->extraDataLoaded
= true;
266 foreach ( $this->getLazyCacheFields( '' ) as $field ) {
267 $this->extraDataLoaded
= $this->extraDataLoaded
&& isset( $cachedValues[$field] );
271 if ( $this->dataLoaded
) {
272 wfIncrStats( 'image_cache.hit' );
274 wfIncrStats( 'image_cache.miss' );
277 return $this->dataLoaded
;
281 * Save the file metadata to memcached
283 function saveToCache() {
286 $key = $this->getCacheKey();
291 $fields = $this->getCacheFields( '' );
292 $cacheVal = array( 'version' => MW_FILE_VERSION
);
293 $cacheVal['fileExists'] = $this->fileExists
;
295 if ( $this->fileExists
) {
296 foreach ( $fields as $field ) {
297 $cacheVal[$field] = $this->$field;
301 // Strip off excessive entries from the subset of fields that can become large.
302 // If the cache value gets to large it will not fit in memcached and nothing will
303 // get cached at all, causing master queries for any file access.
304 foreach ( $this->getLazyCacheFields( '' ) as $field ) {
305 if ( isset( $cacheVal[$field] ) && strlen( $cacheVal[$field] ) > 100 * 1024 ) {
306 unset( $cacheVal[$field] ); // don't let the value get too big
310 // Cache presence for 1 week and negatives for 1 day
311 $ttl = $this->fileExists ?
86400 * 7 : 86400;
312 $opts = Database
::getCacheSetOptions( $this->repo
->getSlaveDB() );
313 ObjectCache
::getMainWANInstance()->set( $key, $cacheVal, $ttl, $opts );
317 * Purge the file object/metadata cache
319 function invalidateCache() {
320 $key = $this->getCacheKey();
325 $this->repo
->getMasterDB()->onTransactionPreCommitOrIdle( function() use ( $key ) {
326 ObjectCache
::getMainWANInstance()->delete( $key );
331 * Load metadata from the file itself
333 function loadFromFile() {
334 $props = $this->repo
->getFileProps( $this->getVirtualUrl() );
335 $this->setProps( $props );
339 * @param string $prefix
342 function getCacheFields( $prefix = 'img_' ) {
343 static $fields = array( 'size', 'width', 'height', 'bits', 'media_type',
344 'major_mime', 'minor_mime', 'metadata', 'timestamp', 'sha1', 'user',
345 'user_text', 'description' );
346 static $results = array();
348 if ( $prefix == '' ) {
352 if ( !isset( $results[$prefix] ) ) {
353 $prefixedFields = array();
354 foreach ( $fields as $field ) {
355 $prefixedFields[] = $prefix . $field;
357 $results[$prefix] = $prefixedFields;
360 return $results[$prefix];
364 * @param string $prefix
367 function getLazyCacheFields( $prefix = 'img_' ) {
368 static $fields = array( 'metadata' );
369 static $results = array();
371 if ( $prefix == '' ) {
375 if ( !isset( $results[$prefix] ) ) {
376 $prefixedFields = array();
377 foreach ( $fields as $field ) {
378 $prefixedFields[] = $prefix . $field;
380 $results[$prefix] = $prefixedFields;
383 return $results[$prefix];
387 * Load file metadata from the DB
390 function loadFromDB( $flags = 0 ) {
391 $fname = get_class( $this ) . '::' . __FUNCTION__
;
393 # Unconditionally set loaded=true, we don't want the accessors constantly rechecking
394 $this->dataLoaded
= true;
395 $this->extraDataLoaded
= true;
397 $dbr = ( $flags & self
::READ_LATEST
)
398 ?
$this->repo
->getMasterDB()
399 : $this->repo
->getSlaveDB();
401 $row = $dbr->selectRow( 'image', $this->getCacheFields( 'img_' ),
402 array( 'img_name' => $this->getName() ), $fname );
405 $this->loadFromRow( $row );
407 $this->fileExists
= false;
412 * Load lazy file metadata from the DB.
413 * This covers fields that are sometimes not cached.
415 protected function loadExtraFromDB() {
416 $fname = get_class( $this ) . '::' . __FUNCTION__
;
418 # Unconditionally set loaded=true, we don't want the accessors constantly rechecking
419 $this->extraDataLoaded
= true;
421 $fieldMap = $this->loadFieldsWithTimestamp( $this->repo
->getSlaveDB(), $fname );
423 $fieldMap = $this->loadFieldsWithTimestamp( $this->repo
->getMasterDB(), $fname );
427 foreach ( $fieldMap as $name => $value ) {
428 $this->$name = $value;
431 throw new MWException( "Could not find data for image '{$this->getName()}'." );
436 * @param IDatabase $dbr
437 * @param string $fname
440 private function loadFieldsWithTimestamp( $dbr, $fname ) {
443 $row = $dbr->selectRow( 'image', $this->getLazyCacheFields( 'img_' ),
444 array( 'img_name' => $this->getName(), 'img_timestamp' => $this->getTimestamp() ),
447 $fieldMap = $this->unprefixRow( $row, 'img_' );
449 # File may have been uploaded over in the meantime; check the old versions
450 $row = $dbr->selectRow( 'oldimage', $this->getLazyCacheFields( 'oi_' ),
451 array( 'oi_name' => $this->getName(), 'oi_timestamp' => $this->getTimestamp() ),
454 $fieldMap = $this->unprefixRow( $row, 'oi_' );
462 * @param array|object $row
463 * @param string $prefix
464 * @throws MWException
467 protected function unprefixRow( $row, $prefix = 'img_' ) {
468 $array = (array)$row;
469 $prefixLength = strlen( $prefix );
471 // Sanity check prefix once
472 if ( substr( key( $array ), 0, $prefixLength ) !== $prefix ) {
473 throw new MWException( __METHOD__
. ': incorrect $prefix parameter' );
477 foreach ( $array as $name => $value ) {
478 $decoded[substr( $name, $prefixLength )] = $value;
485 * Decode a row from the database (either object or array) to an array
486 * with timestamps and MIME types decoded, and the field prefix removed.
488 * @param string $prefix
489 * @throws MWException
492 function decodeRow( $row, $prefix = 'img_' ) {
493 $decoded = $this->unprefixRow( $row, $prefix );
495 $decoded['timestamp'] = wfTimestamp( TS_MW
, $decoded['timestamp'] );
497 $decoded['metadata'] = $this->repo
->getSlaveDB()->decodeBlob( $decoded['metadata'] );
499 if ( empty( $decoded['major_mime'] ) ) {
500 $decoded['mime'] = 'unknown/unknown';
502 if ( !$decoded['minor_mime'] ) {
503 $decoded['minor_mime'] = 'unknown';
505 $decoded['mime'] = $decoded['major_mime'] . '/' . $decoded['minor_mime'];
508 // Trim zero padding from char/binary field
509 $decoded['sha1'] = rtrim( $decoded['sha1'], "\0" );
511 // Normalize some fields to integer type, per their database definition.
512 // Use unary + so that overflows will be upgraded to double instead of
513 // being trucated as with intval(). This is important to allow >2GB
514 // files on 32-bit systems.
515 foreach ( array( 'size', 'width', 'height', 'bits' ) as $field ) {
516 $decoded[$field] = +
$decoded[$field];
523 * Load file metadata from a DB result row
526 * @param string $prefix
528 function loadFromRow( $row, $prefix = 'img_' ) {
529 $this->dataLoaded
= true;
530 $this->extraDataLoaded
= true;
532 $array = $this->decodeRow( $row, $prefix );
534 foreach ( $array as $name => $value ) {
535 $this->$name = $value;
538 $this->fileExists
= true;
539 $this->maybeUpgradeRow();
543 * Load file metadata from cache or DB, unless already loaded
546 function load( $flags = 0 ) {
547 if ( !$this->dataLoaded
) {
548 if ( ( $flags & self
::READ_LATEST
) ||
!$this->loadFromCache() ) {
549 $this->loadFromDB( $flags );
550 $this->saveToCache();
552 $this->dataLoaded
= true;
554 if ( ( $flags & self
::LOAD_ALL
) && !$this->extraDataLoaded
) {
555 // @note: loads on name/timestamp to reduce race condition problems
556 $this->loadExtraFromDB();
561 * Upgrade a row if it needs it
563 function maybeUpgradeRow() {
564 global $wgUpdateCompatibleMetadata;
565 if ( wfReadOnly() ) {
569 if ( is_null( $this->media_type
) ||
570 $this->mime
== 'image/svg'
573 $this->upgraded
= true;
575 $handler = $this->getHandler();
577 $validity = $handler->isMetadataValid( $this, $this->getMetadata() );
578 if ( $validity === MediaHandler
::METADATA_BAD
579 ||
( $validity === MediaHandler
::METADATA_COMPATIBLE
&& $wgUpdateCompatibleMetadata )
582 $this->upgraded
= true;
588 function getUpgraded() {
589 return $this->upgraded
;
593 * Fix assorted version-related problems with the image row by reloading it from the file
595 function upgradeRow() {
597 $this->lock(); // begin
599 $this->loadFromFile();
601 # Don't destroy file info of missing files
602 if ( !$this->fileExists
) {
604 wfDebug( __METHOD__
. ": file does not exist, aborting\n" );
609 $dbw = $this->repo
->getMasterDB();
610 list( $major, $minor ) = self
::splitMime( $this->mime
);
612 if ( wfReadOnly() ) {
617 wfDebug( __METHOD__
. ': upgrading ' . $this->getName() . " to the current schema\n" );
619 $dbw->update( 'image',
621 'img_size' => $this->size
, // sanity
622 'img_width' => $this->width
,
623 'img_height' => $this->height
,
624 'img_bits' => $this->bits
,
625 'img_media_type' => $this->media_type
,
626 'img_major_mime' => $major,
627 'img_minor_mime' => $minor,
628 'img_metadata' => $dbw->encodeBlob( $this->metadata
),
629 'img_sha1' => $this->sha1
,
631 array( 'img_name' => $this->getName() ),
635 $this->invalidateCache();
637 $this->unlock(); // done
642 * Set properties in this object to be equal to those given in the
643 * associative array $info. Only cacheable fields can be set.
644 * All fields *must* be set in $info except for getLazyCacheFields().
646 * If 'mime' is given, it will be split into major_mime/minor_mime.
647 * If major_mime/minor_mime are given, $this->mime will also be set.
651 function setProps( $info ) {
652 $this->dataLoaded
= true;
653 $fields = $this->getCacheFields( '' );
654 $fields[] = 'fileExists';
656 foreach ( $fields as $field ) {
657 if ( isset( $info[$field] ) ) {
658 $this->$field = $info[$field];
662 // Fix up mime fields
663 if ( isset( $info['major_mime'] ) ) {
664 $this->mime
= "{$info['major_mime']}/{$info['minor_mime']}";
665 } elseif ( isset( $info['mime'] ) ) {
666 $this->mime
= $info['mime'];
667 list( $this->major_mime
, $this->minor_mime
) = self
::splitMime( $this->mime
);
671 /** splitMime inherited */
672 /** getName inherited */
673 /** getTitle inherited */
674 /** getURL inherited */
675 /** getViewURL inherited */
676 /** getPath inherited */
677 /** isVisible inherited */
682 function isMissing() {
683 if ( $this->missing
=== null ) {
684 list( $fileExists ) = $this->repo
->fileExists( $this->getVirtualUrl() );
685 $this->missing
= !$fileExists;
688 return $this->missing
;
692 * Return the width of the image
697 public function getWidth( $page = 1 ) {
700 if ( $this->isMultipage() ) {
701 $handler = $this->getHandler();
705 $dim = $handler->getPageDimensions( $this, $page );
707 return $dim['width'];
709 // For non-paged media, the false goes through an
710 // intval, turning failure into 0, so do same here.
719 * Return the height of the image
724 public function getHeight( $page = 1 ) {
727 if ( $this->isMultipage() ) {
728 $handler = $this->getHandler();
732 $dim = $handler->getPageDimensions( $this, $page );
734 return $dim['height'];
736 // For non-paged media, the false goes through an
737 // intval, turning failure into 0, so do same here.
741 return $this->height
;
746 * Returns ID or name of user who uploaded the file
748 * @param string $type 'text' or 'id'
751 function getUser( $type = 'text' ) {
754 if ( $type == 'text' ) {
755 return $this->user_text
;
756 } elseif ( $type == 'id' ) {
757 return (int)$this->user
;
762 * Get handler-specific metadata
765 function getMetadata() {
766 $this->load( self
::LOAD_ALL
); // large metadata is loaded in another step
767 return $this->metadata
;
773 function getBitDepth() {
776 return (int)$this->bits
;
780 * Returns the size of the image file, in bytes
783 public function getSize() {
790 * Returns the MIME type of the file.
793 function getMimeType() {
800 * Returns the type of the media in the file.
801 * Use the value returned by this function with the MEDIATYPE_xxx constants.
804 function getMediaType() {
807 return $this->media_type
;
810 /** canRender inherited */
811 /** mustRender inherited */
812 /** allowInlineDisplay inherited */
813 /** isSafeFile inherited */
814 /** isTrustedFile inherited */
817 * Returns true if the file exists on disk.
818 * @return bool Whether file exist on disk.
820 public function exists() {
823 return $this->fileExists
;
826 /** getTransformScript inherited */
827 /** getUnscaledThumb inherited */
828 /** thumbName inherited */
829 /** createThumb inherited */
830 /** transform inherited */
832 /** getHandler inherited */
833 /** iconThumb inherited */
834 /** getLastError inherited */
837 * Get all thumbnail names previously generated for this file
838 * @param string|bool $archiveName Name of an archive file, default false
839 * @return array First element is the base dir, then files in that base dir.
841 function getThumbnails( $archiveName = false ) {
842 if ( $archiveName ) {
843 $dir = $this->getArchiveThumbPath( $archiveName );
845 $dir = $this->getThumbPath();
848 $backend = $this->repo
->getBackend();
849 $files = array( $dir );
851 $iterator = $backend->getFileList( array( 'dir' => $dir ) );
852 foreach ( $iterator as $file ) {
855 } catch ( FileBackendError
$e ) {
856 } // suppress (bug 54674)
862 * Refresh metadata in memcached, but don't touch thumbnails or squid
864 function purgeMetadataCache() {
865 $this->invalidateCache();
869 * Delete all previously generated thumbnails, refresh metadata in memcached and purge the squid.
871 * @param array $options An array potentially with the key forThumbRefresh.
873 * @note This used to purge old thumbnails by default as well, but doesn't anymore.
875 function purgeCache( $options = array() ) {
876 // Refresh metadata cache
877 $this->purgeMetadataCache();
880 $this->purgeThumbnails( $options );
882 // Purge squid cache for this file
883 SquidUpdate
::purge( array( $this->getURL() ) );
887 * Delete cached transformed files for an archived version only.
888 * @param string $archiveName Name of the archived file
890 function purgeOldThumbnails( $archiveName ) {
893 // Get a list of old thumbnails and URLs
894 $files = $this->getThumbnails( $archiveName );
896 // Purge any custom thumbnail caches
897 Hooks
::run( 'LocalFilePurgeThumbnails', array( $this, $archiveName ) );
899 $dir = array_shift( $files );
900 $this->purgeThumbList( $dir, $files );
905 foreach ( $files as $file ) {
906 $urls[] = $this->getArchiveThumbUrl( $archiveName, $file );
908 SquidUpdate
::purge( $urls );
914 * Delete cached transformed files for the current version only.
915 * @param array $options
917 public function purgeThumbnails( $options = array() ) {
921 $files = $this->getThumbnails();
922 // Always purge all files from squid regardless of handler filters
925 foreach ( $files as $file ) {
926 $urls[] = $this->getThumbUrl( $file );
928 array_shift( $urls ); // don't purge directory
931 // Give media handler a chance to filter the file purge list
932 if ( !empty( $options['forThumbRefresh'] ) ) {
933 $handler = $this->getHandler();
935 $handler->filterThumbnailPurgeList( $files, $options );
939 // Purge any custom thumbnail caches
940 Hooks
::run( 'LocalFilePurgeThumbnails', array( $this, false ) );
942 $dir = array_shift( $files );
943 $this->purgeThumbList( $dir, $files );
947 SquidUpdate
::purge( $urls );
953 * Delete a list of thumbnails visible at urls
954 * @param string $dir Base dir of the files.
955 * @param array $files Array of strings: relative filenames (to $dir)
957 protected function purgeThumbList( $dir, $files ) {
958 $fileListDebug = strtr(
959 var_export( $files, true ),
962 wfDebug( __METHOD__
. ": $fileListDebug\n" );
964 $purgeList = array();
965 foreach ( $files as $file ) {
966 # Check that the base file name is part of the thumb name
967 # This is a basic sanity check to avoid erasing unrelated directories
968 if ( strpos( $file, $this->getName() ) !== false
969 ||
strpos( $file, "-thumbnail" ) !== false // "short" thumb name
971 $purgeList[] = "{$dir}/{$file}";
975 # Delete the thumbnails
976 $this->repo
->quickPurgeBatch( $purgeList );
977 # Clear out the thumbnail directory if empty
978 $this->repo
->quickCleanDir( $dir );
981 /** purgeDescription inherited */
982 /** purgeEverything inherited */
985 * @param int $limit Optional: Limit to number of results
986 * @param int $start Optional: Timestamp, start from
987 * @param int $end Optional: Timestamp, end at
989 * @return OldLocalFile[]
991 function getHistory( $limit = null, $start = null, $end = null, $inc = true ) {
992 $dbr = $this->repo
->getSlaveDB();
993 $tables = array( 'oldimage' );
994 $fields = OldLocalFile
::selectFields();
995 $conds = $opts = $join_conds = array();
996 $eq = $inc ?
'=' : '';
997 $conds[] = "oi_name = " . $dbr->addQuotes( $this->title
->getDBkey() );
1000 $conds[] = "oi_timestamp <$eq " . $dbr->addQuotes( $dbr->timestamp( $start ) );
1004 $conds[] = "oi_timestamp >$eq " . $dbr->addQuotes( $dbr->timestamp( $end ) );
1008 $opts['LIMIT'] = $limit;
1011 // Search backwards for time > x queries
1012 $order = ( !$start && $end !== null ) ?
'ASC' : 'DESC';
1013 $opts['ORDER BY'] = "oi_timestamp $order";
1014 $opts['USE INDEX'] = array( 'oldimage' => 'oi_name_timestamp' );
1016 Hooks
::run( 'LocalFile::getHistory', array( &$this, &$tables, &$fields,
1017 &$conds, &$opts, &$join_conds ) );
1019 $res = $dbr->select( $tables, $fields, $conds, __METHOD__
, $opts, $join_conds );
1022 foreach ( $res as $row ) {
1023 $r[] = $this->repo
->newFileFromRow( $row );
1026 if ( $order == 'ASC' ) {
1027 $r = array_reverse( $r ); // make sure it ends up descending
1034 * Returns the history of this file, line by line.
1035 * starts with current version, then old versions.
1036 * uses $this->historyLine to check which line to return:
1037 * 0 return line for current version
1038 * 1 query for old versions, return first one
1039 * 2, ... return next old version from above query
1042 public function nextHistoryLine() {
1043 # Polymorphic function name to distinguish foreign and local fetches
1044 $fname = get_class( $this ) . '::' . __FUNCTION__
;
1046 $dbr = $this->repo
->getSlaveDB();
1048 if ( $this->historyLine
== 0 ) { // called for the first time, return line from cur
1049 $this->historyRes
= $dbr->select( 'image',
1052 "'' AS oi_archive_name",
1056 array( 'img_name' => $this->title
->getDBkey() ),
1060 if ( 0 == $dbr->numRows( $this->historyRes
) ) {
1061 $this->historyRes
= null;
1065 } elseif ( $this->historyLine
== 1 ) {
1066 $this->historyRes
= $dbr->select( 'oldimage', '*',
1067 array( 'oi_name' => $this->title
->getDBkey() ),
1069 array( 'ORDER BY' => 'oi_timestamp DESC' )
1072 $this->historyLine++
;
1074 return $dbr->fetchObject( $this->historyRes
);
1078 * Reset the history pointer to the first element of the history
1080 public function resetHistory() {
1081 $this->historyLine
= 0;
1083 if ( !is_null( $this->historyRes
) ) {
1084 $this->historyRes
= null;
1088 /** getHashPath inherited */
1089 /** getRel inherited */
1090 /** getUrlRel inherited */
1091 /** getArchiveRel inherited */
1092 /** getArchivePath inherited */
1093 /** getThumbPath inherited */
1094 /** getArchiveUrl inherited */
1095 /** getThumbUrl inherited */
1096 /** getArchiveVirtualUrl inherited */
1097 /** getThumbVirtualUrl inherited */
1098 /** isHashed inherited */
1101 * Upload a file and record it in the DB
1102 * @param string $srcPath Source storage path, virtual URL, or filesystem path
1103 * @param string $comment Upload description
1104 * @param string $pageText Text to use for the new description page,
1105 * if a new description page is created
1106 * @param int|bool $flags Flags for publish()
1107 * @param array|bool $props File properties, if known. This can be used to
1108 * reduce the upload time when uploading virtual URLs for which the file
1109 * info is already known
1110 * @param string|bool $timestamp Timestamp for img_timestamp, or false to use the
1112 * @param User|null $user User object or null to use $wgUser
1114 * @return FileRepoStatus On success, the value member contains the
1115 * archive name, or an empty string if it was a new file.
1117 function upload( $srcPath, $comment, $pageText, $flags = 0, $props = false,
1118 $timestamp = false, $user = null
1122 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
1123 return $this->readOnlyFatalStatus();
1127 if ( $this->repo
->isVirtualUrl( $srcPath )
1128 || FileBackend
::isStoragePath( $srcPath )
1130 $props = $this->repo
->getFileProps( $srcPath );
1132 $props = FSFile
::getPropsFromPath( $srcPath );
1137 $handler = MediaHandler
::getHandler( $props['mime'] );
1139 $options['headers'] = $handler->getStreamHeaders( $props['metadata'] );
1141 $options['headers'] = array();
1144 // Trim spaces on user supplied text
1145 $comment = trim( $comment );
1147 // Truncate nicely or the DB will do it for us
1148 // non-nicely (dangling multi-byte chars, non-truncated version in cache).
1149 $comment = $wgContLang->truncate( $comment, 255 );
1150 $this->lock(); // begin
1151 $status = $this->publish( $srcPath, $flags, $options );
1153 if ( $status->successCount
>= 2 ) {
1154 // There will be a copy+(one of move,copy,store).
1155 // The first succeeding does not commit us to updating the DB
1156 // since it simply copied the current version to a timestamped file name.
1157 // It is only *preferable* to avoid leaving such files orphaned.
1158 // Once the second operation goes through, then the current version was
1159 // updated and we must therefore update the DB too.
1160 if ( !$this->recordUpload2( $status->value
, $comment, $pageText, $props, $timestamp, $user ) ) {
1161 $status->fatal( 'filenotfound', $srcPath );
1165 $this->unlock(); // done
1171 * Record a file upload in the upload log and the image table
1172 * @param string $oldver
1173 * @param string $desc
1174 * @param string $license
1175 * @param string $copyStatus
1176 * @param string $source
1177 * @param bool $watch
1178 * @param string|bool $timestamp
1179 * @param User|null $user User object or null to use $wgUser
1182 function recordUpload( $oldver, $desc, $license = '', $copyStatus = '', $source = '',
1183 $watch = false, $timestamp = false, User
$user = null ) {
1189 $pageText = SpecialUpload
::getInitialPageText( $desc, $license, $copyStatus, $source );
1191 if ( !$this->recordUpload2( $oldver, $desc, $pageText, false, $timestamp, $user ) ) {
1196 $user->addWatch( $this->getTitle() );
1203 * Record a file upload in the upload log and the image table
1204 * @param string $oldver
1205 * @param string $comment
1206 * @param string $pageText
1207 * @param bool|array $props
1208 * @param string|bool $timestamp
1209 * @param null|User $user
1212 function recordUpload2( $oldver, $comment, $pageText, $props = false, $timestamp = false,
1216 if ( is_null( $user ) ) {
1221 $dbw = $this->repo
->getMasterDB();
1222 $dbw->begin( __METHOD__
);
1225 $props = $this->repo
->getFileProps( $this->getVirtualUrl() );
1228 # Imports or such might force a certain timestamp; otherwise we generate
1229 # it and can fudge it slightly to keep (name,timestamp) unique on re-upload.
1230 if ( $timestamp === false ) {
1231 $timestamp = $dbw->timestamp();
1232 $allowTimeKludge = true;
1234 $allowTimeKludge = false;
1237 $props['description'] = $comment;
1238 $props['user'] = $user->getId();
1239 $props['user_text'] = $user->getName();
1240 $props['timestamp'] = wfTimestamp( TS_MW
, $timestamp ); // DB -> TS_MW
1241 $this->setProps( $props );
1243 # Fail now if the file isn't there
1244 if ( !$this->fileExists
) {
1245 wfDebug( __METHOD__
. ": File " . $this->getRel() . " went missing!\n" );
1246 $dbw->rollback( __METHOD__
);
1253 # Test to see if the row exists using INSERT IGNORE
1254 # This avoids race conditions by locking the row until the commit, and also
1255 # doesn't deadlock. SELECT FOR UPDATE causes a deadlock for every race condition.
1256 $dbw->insert( 'image',
1258 'img_name' => $this->getName(),
1259 'img_size' => $this->size
,
1260 'img_width' => intval( $this->width
),
1261 'img_height' => intval( $this->height
),
1262 'img_bits' => $this->bits
,
1263 'img_media_type' => $this->media_type
,
1264 'img_major_mime' => $this->major_mime
,
1265 'img_minor_mime' => $this->minor_mime
,
1266 'img_timestamp' => $timestamp,
1267 'img_description' => $comment,
1268 'img_user' => $user->getId(),
1269 'img_user_text' => $user->getName(),
1270 'img_metadata' => $dbw->encodeBlob( $this->metadata
),
1271 'img_sha1' => $this->sha1
1276 if ( $dbw->affectedRows() == 0 ) {
1277 if ( $allowTimeKludge ) {
1278 # Use LOCK IN SHARE MODE to ignore any transaction snapshotting
1279 $ltimestamp = $dbw->selectField( 'image', 'img_timestamp',
1280 array( 'img_name' => $this->getName() ),
1282 array( 'LOCK IN SHARE MODE' ) );
1283 $lUnixtime = $ltimestamp ?
wfTimestamp( TS_UNIX
, $ltimestamp ) : false;
1284 # Avoid a timestamp that is not newer than the last version
1285 # TODO: the image/oldimage tables should be like page/revision with an ID field
1286 if ( $lUnixtime && wfTimestamp( TS_UNIX
, $timestamp ) <= $lUnixtime ) {
1287 sleep( 1 ); // fast enough re-uploads would go far in the future otherwise
1288 $timestamp = $dbw->timestamp( $lUnixtime +
1 );
1289 $this->timestamp
= wfTimestamp( TS_MW
, $timestamp ); // DB -> TS_MW
1293 # (bug 34993) Note: $oldver can be empty here, if the previous
1294 # version of the file was broken. Allow registration of the new
1295 # version to continue anyway, because that's better than having
1296 # an image that's not fixable by user operations.
1299 # Collision, this is an update of a file
1300 # Insert previous contents into oldimage
1301 $dbw->insertSelect( 'oldimage', 'image',
1303 'oi_name' => 'img_name',
1304 'oi_archive_name' => $dbw->addQuotes( $oldver ),
1305 'oi_size' => 'img_size',
1306 'oi_width' => 'img_width',
1307 'oi_height' => 'img_height',
1308 'oi_bits' => 'img_bits',
1309 'oi_timestamp' => 'img_timestamp',
1310 'oi_description' => 'img_description',
1311 'oi_user' => 'img_user',
1312 'oi_user_text' => 'img_user_text',
1313 'oi_metadata' => 'img_metadata',
1314 'oi_media_type' => 'img_media_type',
1315 'oi_major_mime' => 'img_major_mime',
1316 'oi_minor_mime' => 'img_minor_mime',
1317 'oi_sha1' => 'img_sha1'
1319 array( 'img_name' => $this->getName() ),
1323 # Update the current image row
1324 $dbw->update( 'image',
1326 'img_size' => $this->size
,
1327 'img_width' => intval( $this->width
),
1328 'img_height' => intval( $this->height
),
1329 'img_bits' => $this->bits
,
1330 'img_media_type' => $this->media_type
,
1331 'img_major_mime' => $this->major_mime
,
1332 'img_minor_mime' => $this->minor_mime
,
1333 'img_timestamp' => $timestamp,
1334 'img_description' => $comment,
1335 'img_user' => $user->getId(),
1336 'img_user_text' => $user->getName(),
1337 'img_metadata' => $dbw->encodeBlob( $this->metadata
),
1338 'img_sha1' => $this->sha1
1340 array( 'img_name' => $this->getName() ),
1344 # This is a new file, so update the image count
1345 DeferredUpdates
::addUpdate( SiteStatsUpdate
::factory( array( 'images' => 1 ) ) );
1348 $descTitle = $this->getTitle();
1349 $wikiPage = new WikiFilePage( $descTitle );
1350 $wikiPage->setFile( $this );
1353 $action = $reupload ?
'overwrite' : 'upload';
1355 $logEntry = new ManualLogEntry( 'upload', $action );
1356 $logEntry->setPerformer( $user );
1357 $logEntry->setComment( $comment );
1358 $logEntry->setTarget( $descTitle );
1360 // Allow people using the api to associate log entries with the upload.
1361 // Log has a timestamp, but sometimes different from upload timestamp.
1362 $logEntry->setParameters(
1364 'img_sha1' => $this->sha1
,
1365 'img_timestamp' => $timestamp,
1368 // Note we keep $logId around since during new image
1369 // creation, page doesn't exist yet, so log_page = 0
1370 // but we want it to point to the page we're making,
1371 // so we later modify the log entry.
1372 // For a similar reason, we avoid making an RC entry
1373 // now and wait until the page exists.
1374 $logId = $logEntry->insert();
1376 $exists = $descTitle->exists();
1378 // Page exists, do RC entry now (otherwise we wait for later).
1379 $logEntry->publish( $logId );
1383 # Create a null revision
1384 $latest = $descTitle->getLatestRevID();
1385 // Use own context to get the action text in content language
1386 $formatter = LogFormatter
::newFromEntry( $logEntry );
1387 $formatter->setContext( RequestContext
::newExtraneousContext( $descTitle ) );
1388 $editSummary = $formatter->getPlainActionText();
1390 $nullRevision = Revision
::newNullRevision(
1392 $descTitle->getArticleID(),
1397 if ( !is_null( $nullRevision ) ) {
1398 $nullRevision->insertOn( $dbw );
1400 Hooks
::run( 'NewRevisionFromEditComplete', array( $wikiPage, $nullRevision, $latest, $user ) );
1401 $wikiPage->updateRevisionOn( $dbw, $nullRevision );
1405 # Commit the transaction now, in case something goes wrong later
1406 # The most important thing is that files don't get lost, especially archives
1407 # NOTE: once we have support for nested transactions, the commit may be moved
1408 # to after $wikiPage->doEdit has been called.
1409 $dbw->commit( __METHOD__
);
1411 # Update memcache after the commit
1412 $this->invalidateCache();
1415 # Invalidate the cache for the description page
1416 $descTitle->invalidateCache();
1417 $descTitle->purgeSquid();
1419 # New file; create the description page.
1420 # There's already a log entry, so don't make a second RC entry
1421 # Squid and file cache for the description page are purged by doEditContent.
1422 $content = ContentHandler
::makeContent( $pageText, $descTitle );
1423 $status = $wikiPage->doEditContent(
1426 EDIT_NEW | EDIT_SUPPRESS_RC
,
1431 // Now that the page exists, make an RC entry.
1432 // This relies on the resetArticleID() call in WikiPage::insertOn(),
1433 // which is triggered on $descTitle by doEditContent() above.
1434 $logEntry->publish( $logId );
1435 if ( isset( $status->value
['revision'] ) ) {
1436 $dbw->update( 'logging',
1437 array( 'log_page' => $status->value
['revision']->getPage() ),
1438 array( 'log_id' => $logId ),
1444 # Do some cache purges after final commit so that:
1445 # a) Changes are more likely to be seen post-purge
1446 # b) They won't cause rollback of the log publish/update above
1448 $dbw->onTransactionIdle( function () use ( $that, $reupload, $descTitle ) {
1449 # Run hook for other updates (typically more cache purging)
1450 Hooks
::run( 'FileUpload', array( $that, $reupload, $descTitle->exists() ) );
1453 # Delete old thumbnails
1454 $that->purgeThumbnails();
1455 # Remove the old file from the squid cache
1456 SquidUpdate
::purge( array( $that->getURL() ) );
1458 # Update backlink pages pointing to this title if created
1459 LinksUpdate
::queueRecursiveJobsForTable( $that->getTitle(), 'imagelinks' );
1463 # Invalidate cache for all pages using this file
1464 DeferredUpdates
::addUpdate( new HTMLCacheUpdate( $this->getTitle(), 'imagelinks' ) );
1470 * Move or copy a file to its public location. If a file exists at the
1471 * destination, move it to an archive. Returns a FileRepoStatus object with
1472 * the archive name in the "value" member on success.
1474 * The archive name should be passed through to recordUpload for database
1477 * @param string $srcPath Local filesystem path or virtual URL to the source image
1478 * @param int $flags A bitwise combination of:
1479 * File::DELETE_SOURCE Delete the source file, i.e. move rather than copy
1480 * @param array $options Optional additional parameters
1481 * @return FileRepoStatus On success, the value member contains the
1482 * archive name, or an empty string if it was a new file.
1484 function publish( $srcPath, $flags = 0, array $options = array() ) {
1485 return $this->publishTo( $srcPath, $this->getRel(), $flags, $options );
1489 * Move or copy a file to a specified location. Returns a FileRepoStatus
1490 * object with the archive name in the "value" member on success.
1492 * The archive name should be passed through to recordUpload for database
1495 * @param string $srcPath Local filesystem path or virtual URL to the source image
1496 * @param string $dstRel Target relative path
1497 * @param int $flags A bitwise combination of:
1498 * File::DELETE_SOURCE Delete the source file, i.e. move rather than copy
1499 * @param array $options Optional additional parameters
1500 * @return FileRepoStatus On success, the value member contains the
1501 * archive name, or an empty string if it was a new file.
1503 function publishTo( $srcPath, $dstRel, $flags = 0, array $options = array() ) {
1504 $repo = $this->getRepo();
1505 if ( $repo->getReadOnlyReason() !== false ) {
1506 return $this->readOnlyFatalStatus();
1509 $this->lock(); // begin
1511 $archiveName = wfTimestamp( TS_MW
) . '!' . $this->getName();
1512 $archiveRel = 'archive/' . $this->getHashPath() . $archiveName;
1514 if ( $repo->hasSha1Storage() ) {
1515 $sha1 = $repo->isVirtualUrl( $srcPath )
1516 ?
$repo->getFileSha1( $srcPath )
1517 : File
::sha1Base36( $srcPath );
1518 $dst = $repo->getBackend()->getPathForSHA1( $sha1 );
1519 $status = $repo->quickImport( $srcPath, $dst );
1520 if ( $flags & File
::DELETE_SOURCE
) {
1524 if ( $this->exists() ) {
1525 $status->value
= $archiveName;
1528 $flags = $flags & File
::DELETE_SOURCE ? LocalRepo
::DELETE_SOURCE
: 0;
1529 $status = $repo->publish( $srcPath, $dstRel, $archiveRel, $flags, $options );
1531 if ( $status->value
== 'new' ) {
1532 $status->value
= '';
1534 $status->value
= $archiveName;
1538 $this->unlock(); // done
1543 /** getLinksTo inherited */
1544 /** getExifData inherited */
1545 /** isLocal inherited */
1546 /** wasDeleted inherited */
1549 * Move file to the new title
1551 * Move current, old version and all thumbnails
1552 * to the new filename. Old file is deleted.
1554 * Cache purging is done; checks for validity
1555 * and logging are caller's responsibility
1557 * @param Title $target New file name
1558 * @return FileRepoStatus
1560 function move( $target ) {
1561 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
1562 return $this->readOnlyFatalStatus();
1565 wfDebugLog( 'imagemove', "Got request to move {$this->name} to " . $target->getText() );
1566 $batch = new LocalFileMoveBatch( $this, $target );
1568 $this->lock(); // begin
1569 $batch->addCurrent();
1570 $archiveNames = $batch->addOlds();
1571 $status = $batch->execute();
1572 $this->unlock(); // done
1574 wfDebugLog( 'imagemove', "Finished moving {$this->name}" );
1576 // Purge the source and target files...
1577 $oldTitleFile = wfLocalFile( $this->title
);
1578 $newTitleFile = wfLocalFile( $target );
1579 // Hack: the lock()/unlock() pair is nested in a transaction so the locking is not
1580 // tied to BEGIN/COMMIT. To avoid slow purges in the transaction, move them outside.
1581 $this->getRepo()->getMasterDB()->onTransactionIdle(
1582 function () use ( $oldTitleFile, $newTitleFile, $archiveNames ) {
1583 $oldTitleFile->purgeEverything();
1584 foreach ( $archiveNames as $archiveName ) {
1585 $oldTitleFile->purgeOldThumbnails( $archiveName );
1587 $newTitleFile->purgeEverything();
1591 if ( $status->isOK() ) {
1592 // Now switch the object
1593 $this->title
= $target;
1594 // Force regeneration of the name and hashpath
1595 unset( $this->name
);
1596 unset( $this->hashPath
);
1603 * Delete all versions of the file.
1605 * Moves the files into an archive directory (or deletes them)
1606 * and removes the database rows.
1608 * Cache purging is done; logging is caller's responsibility.
1610 * @param string $reason
1611 * @param bool $suppress
1612 * @param User|null $user
1613 * @return FileRepoStatus
1615 function delete( $reason, $suppress = false, $user = null ) {
1616 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
1617 return $this->readOnlyFatalStatus();
1620 $batch = new LocalFileDeleteBatch( $this, $reason, $suppress, $user );
1622 $this->lock(); // begin
1623 $batch->addCurrent();
1624 # Get old version relative paths
1625 $archiveNames = $batch->addOlds();
1626 $status = $batch->execute();
1627 $this->unlock(); // done
1629 if ( $status->isOK() ) {
1630 DeferredUpdates
::addUpdate( SiteStatsUpdate
::factory( array( 'images' => -1 ) ) );
1633 // Hack: the lock()/unlock() pair is nested in a transaction so the locking is not
1634 // tied to BEGIN/COMMIT. To avoid slow purges in the transaction, move them outside.
1636 $this->getRepo()->getMasterDB()->onTransactionIdle(
1637 function () use ( $that, $archiveNames ) {
1640 $that->purgeEverything();
1641 foreach ( $archiveNames as $archiveName ) {
1642 $that->purgeOldThumbnails( $archiveName );
1645 if ( $wgUseSquid ) {
1647 $purgeUrls = array();
1648 foreach ( $archiveNames as $archiveName ) {
1649 $purgeUrls[] = $that->getArchiveUrl( $archiveName );
1651 SquidUpdate
::purge( $purgeUrls );
1660 * Delete an old version of the file.
1662 * Moves the file into an archive directory (or deletes it)
1663 * and removes the database row.
1665 * Cache purging is done; logging is caller's responsibility.
1667 * @param string $archiveName
1668 * @param string $reason
1669 * @param bool $suppress
1670 * @param User|null $user
1671 * @throws MWException Exception on database or file store failure
1672 * @return FileRepoStatus
1674 function deleteOld( $archiveName, $reason, $suppress = false, $user = null ) {
1676 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
1677 return $this->readOnlyFatalStatus();
1680 $batch = new LocalFileDeleteBatch( $this, $reason, $suppress, $user );
1682 $this->lock(); // begin
1683 $batch->addOld( $archiveName );
1684 $status = $batch->execute();
1685 $this->unlock(); // done
1687 $this->purgeOldThumbnails( $archiveName );
1688 if ( $status->isOK() ) {
1689 $this->purgeDescription();
1692 if ( $wgUseSquid ) {
1694 SquidUpdate
::purge( array( $this->getArchiveUrl( $archiveName ) ) );
1701 * Restore all or specified deleted revisions to the given file.
1702 * Permissions and logging are left to the caller.
1704 * May throw database exceptions on error.
1706 * @param array $versions Set of record ids of deleted items to restore,
1707 * or empty to restore all revisions.
1708 * @param bool $unsuppress
1709 * @return FileRepoStatus
1711 function restore( $versions = array(), $unsuppress = false ) {
1712 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
1713 return $this->readOnlyFatalStatus();
1716 $batch = new LocalFileRestoreBatch( $this, $unsuppress );
1718 $this->lock(); // begin
1722 $batch->addIds( $versions );
1724 $status = $batch->execute();
1725 if ( $status->isGood() ) {
1726 $cleanupStatus = $batch->cleanup();
1727 $cleanupStatus->successCount
= 0;
1728 $cleanupStatus->failCount
= 0;
1729 $status->merge( $cleanupStatus );
1731 $this->unlock(); // done
1736 /** isMultipage inherited */
1737 /** pageCount inherited */
1738 /** scaleHeight inherited */
1739 /** getImageSize inherited */
1742 * Get the URL of the file description page.
1745 function getDescriptionUrl() {
1746 return $this->title
->getLocalURL();
1750 * Get the HTML text of the description page
1751 * This is not used by ImagePage for local files, since (among other things)
1752 * it skips the parser cache.
1754 * @param Language $lang What language to get description in (Optional)
1755 * @return bool|mixed
1757 function getDescriptionText( $lang = null ) {
1758 $revision = Revision
::newFromTitle( $this->title
, false, Revision
::READ_NORMAL
);
1762 $content = $revision->getContent();
1766 $pout = $content->getParserOutput( $this->title
, null, new ParserOptions( null, $lang ) );
1768 return $pout->getText();
1772 * @param int $audience
1776 function getDescription( $audience = self
::FOR_PUBLIC
, User
$user = null ) {
1778 if ( $audience == self
::FOR_PUBLIC
&& $this->isDeleted( self
::DELETED_COMMENT
) ) {
1780 } elseif ( $audience == self
::FOR_THIS_USER
1781 && !$this->userCan( self
::DELETED_COMMENT
, $user )
1785 return $this->description
;
1790 * @return bool|string
1792 function getTimestamp() {
1795 return $this->timestamp
;
1799 * @return bool|string
1801 public function getDescriptionTouched() {
1802 // The DB lookup might return false, e.g. if the file was just deleted, or the shared DB repo
1803 // itself gets it from elsewhere. To avoid repeating the DB lookups in such a case, we
1804 // need to differentiate between null (uninitialized) and false (failed to load).
1805 if ( $this->descriptionTouched
=== null ) {
1807 'page_namespace' => $this->title
->getNamespace(),
1808 'page_title' => $this->title
->getDBkey()
1810 $touched = $this->repo
->getSlaveDB()->selectField( 'page', 'page_touched', $cond, __METHOD__
);
1811 $this->descriptionTouched
= $touched ?
wfTimestamp( TS_MW
, $touched ) : false;
1814 return $this->descriptionTouched
;
1820 function getSha1() {
1822 // Initialise now if necessary
1823 if ( $this->sha1
== '' && $this->fileExists
) {
1824 $this->lock(); // begin
1826 $this->sha1
= $this->repo
->getFileSha1( $this->getPath() );
1827 if ( !wfReadOnly() && strval( $this->sha1
) != '' ) {
1828 $dbw = $this->repo
->getMasterDB();
1829 $dbw->update( 'image',
1830 array( 'img_sha1' => $this->sha1
),
1831 array( 'img_name' => $this->getName() ),
1833 $this->invalidateCache();
1836 $this->unlock(); // done
1843 * @return bool Whether to cache in RepoGroup (this avoids OOMs)
1845 function isCacheable() {
1848 // If extra data (metadata) was not loaded then it must have been large
1849 return $this->extraDataLoaded
1850 && strlen( serialize( $this->metadata
) ) <= self
::CACHE_FIELD_MAX_LEN
;
1854 * Start a transaction and lock the image for update
1855 * Increments a reference counter if the lock is already held
1856 * @throws MWException Throws an error if the lock was not acquired
1857 * @return bool Whether the file lock owns/spawned the DB transaction
1860 $dbw = $this->repo
->getMasterDB();
1862 if ( !$this->locked
) {
1863 if ( !$dbw->trxLevel() ) {
1864 $dbw->begin( __METHOD__
);
1865 $this->lockedOwnTrx
= true;
1868 // Bug 54736: use simple lock to handle when the file does not exist.
1869 // SELECT FOR UPDATE prevents changes, not other SELECTs with FOR UPDATE.
1870 // Also, that would cause contention on INSERT of similarly named rows.
1871 $backend = $this->getRepo()->getBackend();
1872 $lockPaths = array( $this->getPath() ); // represents all versions of the file
1873 $status = $backend->lockFiles( $lockPaths, LockManager
::LOCK_EX
, 5 );
1874 if ( !$status->isGood() ) {
1875 throw new MWException( "Could not acquire lock for '{$this->getName()}.'" );
1877 $dbw->onTransactionIdle( function () use ( $backend, $lockPaths ) {
1878 $backend->unlockFiles( $lockPaths, LockManager
::LOCK_EX
); // release on commit
1882 return $this->lockedOwnTrx
;
1886 * Decrement the lock reference count. If the reference count is reduced to zero, commits
1887 * the transaction and thereby releases the image lock.
1890 if ( $this->locked
) {
1892 if ( !$this->locked
&& $this->lockedOwnTrx
) {
1893 $dbw = $this->repo
->getMasterDB();
1894 $dbw->commit( __METHOD__
);
1895 $this->lockedOwnTrx
= false;
1901 * Roll back the DB transaction and mark the image unlocked
1903 function unlockAndRollback() {
1904 $this->locked
= false;
1905 $dbw = $this->repo
->getMasterDB();
1906 $dbw->rollback( __METHOD__
);
1907 $this->lockedOwnTrx
= false;
1913 protected function readOnlyFatalStatus() {
1914 return $this->getRepo()->newFatal( 'filereadonlyerror', $this->getName(),
1915 $this->getRepo()->getName(), $this->getRepo()->getReadOnlyReason() );
1919 * Clean up any dangling locks
1921 function __destruct() {
1924 } // LocalFile class
1926 # ------------------------------------------------------------------------------
1929 * Helper class for file deletion
1930 * @ingroup FileAbstraction
1932 class LocalFileDeleteBatch
{
1933 /** @var LocalFile */
1940 private $srcRels = array();
1943 private $archiveUrls = array();
1945 /** @var array Items to be processed in the deletion batch */
1946 private $deletionBatch;
1948 /** @var bool Whether to suppress all suppressable fields when deleting */
1951 /** @var FileRepoStatus */
1959 * @param string $reason
1960 * @param bool $suppress
1961 * @param User|null $user
1963 function __construct( File
$file, $reason = '', $suppress = false, $user = null ) {
1964 $this->file
= $file;
1965 $this->reason
= $reason;
1966 $this->suppress
= $suppress;
1968 $this->user
= $user;
1971 $this->user
= $wgUser;
1973 $this->status
= $file->repo
->newGood();
1976 public function addCurrent() {
1977 $this->srcRels
['.'] = $this->file
->getRel();
1981 * @param string $oldName
1983 public function addOld( $oldName ) {
1984 $this->srcRels
[$oldName] = $this->file
->getArchiveRel( $oldName );
1985 $this->archiveUrls
[] = $this->file
->getArchiveUrl( $oldName );
1989 * Add the old versions of the image to the batch
1990 * @return array List of archive names from old versions
1992 public function addOlds() {
1993 $archiveNames = array();
1995 $dbw = $this->file
->repo
->getMasterDB();
1996 $result = $dbw->select( 'oldimage',
1997 array( 'oi_archive_name' ),
1998 array( 'oi_name' => $this->file
->getName() ),
2002 foreach ( $result as $row ) {
2003 $this->addOld( $row->oi_archive_name
);
2004 $archiveNames[] = $row->oi_archive_name
;
2007 return $archiveNames;
2013 protected function getOldRels() {
2014 if ( !isset( $this->srcRels
['.'] ) ) {
2015 $oldRels =& $this->srcRels
;
2016 $deleteCurrent = false;
2018 $oldRels = $this->srcRels
;
2019 unset( $oldRels['.'] );
2020 $deleteCurrent = true;
2023 return array( $oldRels, $deleteCurrent );
2029 protected function getHashes() {
2031 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
2033 if ( $deleteCurrent ) {
2034 $hashes['.'] = $this->file
->getSha1();
2037 if ( count( $oldRels ) ) {
2038 $dbw = $this->file
->repo
->getMasterDB();
2039 $res = $dbw->select(
2041 array( 'oi_archive_name', 'oi_sha1' ),
2042 array( 'oi_archive_name' => array_keys( $oldRels ),
2043 'oi_name' => $this->file
->getName() ), // performance
2047 foreach ( $res as $row ) {
2048 if ( rtrim( $row->oi_sha1
, "\0" ) === '' ) {
2049 // Get the hash from the file
2050 $oldUrl = $this->file
->getArchiveVirtualUrl( $row->oi_archive_name
);
2051 $props = $this->file
->repo
->getFileProps( $oldUrl );
2053 if ( $props['fileExists'] ) {
2054 // Upgrade the oldimage row
2055 $dbw->update( 'oldimage',
2056 array( 'oi_sha1' => $props['sha1'] ),
2057 array( 'oi_name' => $this->file
->getName(), 'oi_archive_name' => $row->oi_archive_name
),
2059 $hashes[$row->oi_archive_name
] = $props['sha1'];
2061 $hashes[$row->oi_archive_name
] = false;
2064 $hashes[$row->oi_archive_name
] = $row->oi_sha1
;
2069 $missing = array_diff_key( $this->srcRels
, $hashes );
2071 foreach ( $missing as $name => $rel ) {
2072 $this->status
->error( 'filedelete-old-unregistered', $name );
2075 foreach ( $hashes as $name => $hash ) {
2077 $this->status
->error( 'filedelete-missing', $this->srcRels
[$name] );
2078 unset( $hashes[$name] );
2085 protected function doDBInserts() {
2086 $dbw = $this->file
->repo
->getMasterDB();
2087 $encTimestamp = $dbw->addQuotes( $dbw->timestamp() );
2088 $encUserId = $dbw->addQuotes( $this->user
->getId() );
2089 $encReason = $dbw->addQuotes( $this->reason
);
2090 $encGroup = $dbw->addQuotes( 'deleted' );
2091 $ext = $this->file
->getExtension();
2092 $dotExt = $ext === '' ?
'' : ".$ext";
2093 $encExt = $dbw->addQuotes( $dotExt );
2094 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
2096 // Bitfields to further suppress the content
2097 if ( $this->suppress
) {
2099 // This should be 15...
2100 $bitfield |
= Revision
::DELETED_TEXT
;
2101 $bitfield |
= Revision
::DELETED_COMMENT
;
2102 $bitfield |
= Revision
::DELETED_USER
;
2103 $bitfield |
= Revision
::DELETED_RESTRICTED
;
2105 $bitfield = 'oi_deleted';
2108 if ( $deleteCurrent ) {
2109 $concat = $dbw->buildConcat( array( "img_sha1", $encExt ) );
2110 $where = array( 'img_name' => $this->file
->getName() );
2111 $dbw->insertSelect( 'filearchive', 'image',
2113 'fa_storage_group' => $encGroup,
2114 'fa_storage_key' => $dbw->conditional(
2115 array( 'img_sha1' => '' ),
2116 $dbw->addQuotes( '' ),
2119 'fa_deleted_user' => $encUserId,
2120 'fa_deleted_timestamp' => $encTimestamp,
2121 'fa_deleted_reason' => $encReason,
2122 'fa_deleted' => $this->suppress ?
$bitfield : 0,
2124 'fa_name' => 'img_name',
2125 'fa_archive_name' => 'NULL',
2126 'fa_size' => 'img_size',
2127 'fa_width' => 'img_width',
2128 'fa_height' => 'img_height',
2129 'fa_metadata' => 'img_metadata',
2130 'fa_bits' => 'img_bits',
2131 'fa_media_type' => 'img_media_type',
2132 'fa_major_mime' => 'img_major_mime',
2133 'fa_minor_mime' => 'img_minor_mime',
2134 'fa_description' => 'img_description',
2135 'fa_user' => 'img_user',
2136 'fa_user_text' => 'img_user_text',
2137 'fa_timestamp' => 'img_timestamp',
2138 'fa_sha1' => 'img_sha1',
2139 ), $where, __METHOD__
);
2142 if ( count( $oldRels ) ) {
2143 $concat = $dbw->buildConcat( array( "oi_sha1", $encExt ) );
2145 'oi_name' => $this->file
->getName(),
2146 'oi_archive_name' => array_keys( $oldRels ) );
2147 $dbw->insertSelect( 'filearchive', 'oldimage',
2149 'fa_storage_group' => $encGroup,
2150 'fa_storage_key' => $dbw->conditional(
2151 array( 'oi_sha1' => '' ),
2152 $dbw->addQuotes( '' ),
2155 'fa_deleted_user' => $encUserId,
2156 'fa_deleted_timestamp' => $encTimestamp,
2157 'fa_deleted_reason' => $encReason,
2158 'fa_deleted' => $this->suppress ?
$bitfield : 'oi_deleted',
2160 'fa_name' => 'oi_name',
2161 'fa_archive_name' => 'oi_archive_name',
2162 'fa_size' => 'oi_size',
2163 'fa_width' => 'oi_width',
2164 'fa_height' => 'oi_height',
2165 'fa_metadata' => 'oi_metadata',
2166 'fa_bits' => 'oi_bits',
2167 'fa_media_type' => 'oi_media_type',
2168 'fa_major_mime' => 'oi_major_mime',
2169 'fa_minor_mime' => 'oi_minor_mime',
2170 'fa_description' => 'oi_description',
2171 'fa_user' => 'oi_user',
2172 'fa_user_text' => 'oi_user_text',
2173 'fa_timestamp' => 'oi_timestamp',
2174 'fa_sha1' => 'oi_sha1',
2175 ), $where, __METHOD__
);
2179 function doDBDeletes() {
2180 $dbw = $this->file
->repo
->getMasterDB();
2181 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
2183 if ( count( $oldRels ) ) {
2184 $dbw->delete( 'oldimage',
2186 'oi_name' => $this->file
->getName(),
2187 'oi_archive_name' => array_keys( $oldRels )
2191 if ( $deleteCurrent ) {
2192 $dbw->delete( 'image', array( 'img_name' => $this->file
->getName() ), __METHOD__
);
2197 * Run the transaction
2198 * @return FileRepoStatus
2200 public function execute() {
2201 $repo = $this->file
->getRepo();
2202 $this->file
->lock();
2204 // Prepare deletion batch
2205 $hashes = $this->getHashes();
2206 $this->deletionBatch
= array();
2207 $ext = $this->file
->getExtension();
2208 $dotExt = $ext === '' ?
'' : ".$ext";
2210 foreach ( $this->srcRels
as $name => $srcRel ) {
2211 // Skip files that have no hash (e.g. missing DB record, or sha1 field and file source)
2212 if ( isset( $hashes[$name] ) ) {
2213 $hash = $hashes[$name];
2214 $key = $hash . $dotExt;
2215 $dstRel = $repo->getDeletedHashPath( $key ) . $key;
2216 $this->deletionBatch
[$name] = array( $srcRel, $dstRel );
2220 // Lock the filearchive rows so that the files don't get deleted by a cleanup operation
2221 // We acquire this lock by running the inserts now, before the file operations.
2222 // This potentially has poor lock contention characteristics -- an alternative
2223 // scheme would be to insert stub filearchive entries with no fa_name and commit
2224 // them in a separate transaction, then run the file ops, then update the fa_name fields.
2225 $this->doDBInserts();
2227 if ( !$repo->hasSha1Storage() ) {
2228 // Removes non-existent file from the batch, so we don't get errors.
2229 // This also handles files in the 'deleted' zone deleted via revision deletion.
2230 $checkStatus = $this->removeNonexistentFiles( $this->deletionBatch
);
2231 if ( !$checkStatus->isGood() ) {
2232 $this->status
->merge( $checkStatus );
2233 return $this->status
;
2235 $this->deletionBatch
= $checkStatus->value
;
2237 // Execute the file deletion batch
2238 $status = $this->file
->repo
->deleteBatch( $this->deletionBatch
);
2240 if ( !$status->isGood() ) {
2241 $this->status
->merge( $status );
2245 if ( !$this->status
->isOK() ) {
2246 // Critical file deletion error
2247 // Roll back inserts, release lock and abort
2248 // TODO: delete the defunct filearchive rows if we are using a non-transactional DB
2249 $this->file
->unlockAndRollback();
2251 return $this->status
;
2254 // Delete image/oldimage rows
2255 $this->doDBDeletes();
2257 // Commit and return
2258 $this->file
->unlock();
2260 return $this->status
;
2264 * Removes non-existent files from a deletion batch.
2265 * @param array $batch
2268 protected function removeNonexistentFiles( $batch ) {
2269 $files = $newBatch = array();
2271 foreach ( $batch as $batchItem ) {
2272 list( $src, ) = $batchItem;
2273 $files[$src] = $this->file
->repo
->getVirtualUrl( 'public' ) . '/' . rawurlencode( $src );
2276 $result = $this->file
->repo
->fileExistsBatch( $files );
2277 if ( in_array( null, $result, true ) ) {
2278 return Status
::newFatal( 'backend-fail-internal',
2279 $this->file
->repo
->getBackend()->getName() );
2282 foreach ( $batch as $batchItem ) {
2283 if ( $result[$batchItem[0]] ) {
2284 $newBatch[] = $batchItem;
2288 return Status
::newGood( $newBatch );
2292 # ------------------------------------------------------------------------------
2295 * Helper class for file undeletion
2296 * @ingroup FileAbstraction
2298 class LocalFileRestoreBatch
{
2299 /** @var LocalFile */
2302 /** @var array List of file IDs to restore */
2303 private $cleanupBatch;
2305 /** @var array List of file IDs to restore */
2308 /** @var bool Add all revisions of the file */
2311 /** @var bool Whether to remove all settings for suppressed fields */
2312 private $unsuppress = false;
2316 * @param bool $unsuppress
2318 function __construct( File
$file, $unsuppress = false ) {
2319 $this->file
= $file;
2320 $this->cleanupBatch
= $this->ids
= array();
2321 $this->ids
= array();
2322 $this->unsuppress
= $unsuppress;
2329 public function addId( $fa_id ) {
2330 $this->ids
[] = $fa_id;
2334 * Add a whole lot of files by ID
2337 public function addIds( $ids ) {
2338 $this->ids
= array_merge( $this->ids
, $ids );
2342 * Add all revisions of the file
2344 public function addAll() {
2349 * Run the transaction, except the cleanup batch.
2350 * The cleanup batch should be run in a separate transaction, because it locks different
2351 * rows and there's no need to keep the image row locked while it's acquiring those locks
2352 * The caller may have its own transaction open.
2353 * So we save the batch and let the caller call cleanup()
2354 * @return FileRepoStatus
2356 public function execute() {
2359 $repo = $this->file
->getRepo();
2360 if ( !$this->all
&& !$this->ids
) {
2362 return $repo->newGood();
2365 $lockOwnsTrx = $this->file
->lock();
2367 $dbw = $this->file
->repo
->getMasterDB();
2368 $status = $this->file
->repo
->newGood();
2370 $exists = (bool)$dbw->selectField( 'image', '1',
2371 array( 'img_name' => $this->file
->getName() ),
2373 // The lock() should already prevents changes, but this still may need
2374 // to bypass any transaction snapshot. However, if lock() started the
2375 // trx (which it probably did) then snapshot is post-lock and up-to-date.
2376 $lockOwnsTrx ?
array() : array( 'LOCK IN SHARE MODE' )
2379 // Fetch all or selected archived revisions for the file,
2380 // sorted from the most recent to the oldest.
2381 $conditions = array( 'fa_name' => $this->file
->getName() );
2383 if ( !$this->all
) {
2384 $conditions['fa_id'] = $this->ids
;
2387 $result = $dbw->select(
2389 ArchivedFile
::selectFields(),
2392 array( 'ORDER BY' => 'fa_timestamp DESC' )
2395 $idsPresent = array();
2396 $storeBatch = array();
2397 $insertBatch = array();
2398 $insertCurrent = false;
2399 $deleteIds = array();
2401 $archiveNames = array();
2403 foreach ( $result as $row ) {
2404 $idsPresent[] = $row->fa_id
;
2406 if ( $row->fa_name
!= $this->file
->getName() ) {
2407 $status->error( 'undelete-filename-mismatch', $wgLang->timeanddate( $row->fa_timestamp
) );
2408 $status->failCount++
;
2412 if ( $row->fa_storage_key
== '' ) {
2413 // Revision was missing pre-deletion
2414 $status->error( 'undelete-bad-store-key', $wgLang->timeanddate( $row->fa_timestamp
) );
2415 $status->failCount++
;
2419 $deletedRel = $repo->getDeletedHashPath( $row->fa_storage_key
) .
2420 $row->fa_storage_key
;
2421 $deletedUrl = $repo->getVirtualUrl() . '/deleted/' . $deletedRel;
2423 if ( isset( $row->fa_sha1
) ) {
2424 $sha1 = $row->fa_sha1
;
2426 // old row, populate from key
2427 $sha1 = LocalRepo
::getHashFromKey( $row->fa_storage_key
);
2431 if ( strlen( $sha1 ) == 32 && $sha1[0] == '0' ) {
2432 $sha1 = substr( $sha1, 1 );
2435 if ( is_null( $row->fa_major_mime
) ||
$row->fa_major_mime
== 'unknown'
2436 ||
is_null( $row->fa_minor_mime
) ||
$row->fa_minor_mime
== 'unknown'
2437 ||
is_null( $row->fa_media_type
) ||
$row->fa_media_type
== 'UNKNOWN'
2438 ||
is_null( $row->fa_metadata
)
2440 // Refresh our metadata
2441 // Required for a new current revision; nice for older ones too. :)
2442 $props = RepoGroup
::singleton()->getFileProps( $deletedUrl );
2445 'minor_mime' => $row->fa_minor_mime
,
2446 'major_mime' => $row->fa_major_mime
,
2447 'media_type' => $row->fa_media_type
,
2448 'metadata' => $row->fa_metadata
2452 if ( $first && !$exists ) {
2453 // This revision will be published as the new current version
2454 $destRel = $this->file
->getRel();
2455 $insertCurrent = array(
2456 'img_name' => $row->fa_name
,
2457 'img_size' => $row->fa_size
,
2458 'img_width' => $row->fa_width
,
2459 'img_height' => $row->fa_height
,
2460 'img_metadata' => $props['metadata'],
2461 'img_bits' => $row->fa_bits
,
2462 'img_media_type' => $props['media_type'],
2463 'img_major_mime' => $props['major_mime'],
2464 'img_minor_mime' => $props['minor_mime'],
2465 'img_description' => $row->fa_description
,
2466 'img_user' => $row->fa_user
,
2467 'img_user_text' => $row->fa_user_text
,
2468 'img_timestamp' => $row->fa_timestamp
,
2472 // The live (current) version cannot be hidden!
2473 if ( !$this->unsuppress
&& $row->fa_deleted
) {
2474 $storeBatch[] = array( $deletedUrl, 'public', $destRel );
2475 $this->cleanupBatch
[] = $row->fa_storage_key
;
2478 $archiveName = $row->fa_archive_name
;
2480 if ( $archiveName == '' ) {
2481 // This was originally a current version; we
2482 // have to devise a new archive name for it.
2483 // Format is <timestamp of archiving>!<name>
2484 $timestamp = wfTimestamp( TS_UNIX
, $row->fa_deleted_timestamp
);
2487 $archiveName = wfTimestamp( TS_MW
, $timestamp ) . '!' . $row->fa_name
;
2489 } while ( isset( $archiveNames[$archiveName] ) );
2492 $archiveNames[$archiveName] = true;
2493 $destRel = $this->file
->getArchiveRel( $archiveName );
2494 $insertBatch[] = array(
2495 'oi_name' => $row->fa_name
,
2496 'oi_archive_name' => $archiveName,
2497 'oi_size' => $row->fa_size
,
2498 'oi_width' => $row->fa_width
,
2499 'oi_height' => $row->fa_height
,
2500 'oi_bits' => $row->fa_bits
,
2501 'oi_description' => $row->fa_description
,
2502 'oi_user' => $row->fa_user
,
2503 'oi_user_text' => $row->fa_user_text
,
2504 'oi_timestamp' => $row->fa_timestamp
,
2505 'oi_metadata' => $props['metadata'],
2506 'oi_media_type' => $props['media_type'],
2507 'oi_major_mime' => $props['major_mime'],
2508 'oi_minor_mime' => $props['minor_mime'],
2509 'oi_deleted' => $this->unsuppress ?
0 : $row->fa_deleted
,
2510 'oi_sha1' => $sha1 );
2513 $deleteIds[] = $row->fa_id
;
2515 if ( !$this->unsuppress
&& $row->fa_deleted
& File
::DELETED_FILE
) {
2516 // private files can stay where they are
2517 $status->successCount++
;
2519 $storeBatch[] = array( $deletedUrl, 'public', $destRel );
2520 $this->cleanupBatch
[] = $row->fa_storage_key
;
2528 // Add a warning to the status object for missing IDs
2529 $missingIds = array_diff( $this->ids
, $idsPresent );
2531 foreach ( $missingIds as $id ) {
2532 $status->error( 'undelete-missing-filearchive', $id );
2535 if ( !$repo->hasSha1Storage() ) {
2536 // Remove missing files from batch, so we don't get errors when undeleting them
2537 $checkStatus = $this->removeNonexistentFiles( $storeBatch );
2538 if ( !$checkStatus->isGood() ) {
2539 $status->merge( $checkStatus );
2542 $storeBatch = $checkStatus->value
;
2544 // Run the store batch
2545 // Use the OVERWRITE_SAME flag to smooth over a common error
2546 $storeStatus = $this->file
->repo
->storeBatch( $storeBatch, FileRepo
::OVERWRITE_SAME
);
2547 $status->merge( $storeStatus );
2549 if ( !$status->isGood() ) {
2550 // Even if some files could be copied, fail entirely as that is the
2551 // easiest thing to do without data loss
2552 $this->cleanupFailedBatch( $storeStatus, $storeBatch );
2553 $status->ok
= false;
2554 $this->file
->unlock();
2560 // Run the DB updates
2561 // Because we have locked the image row, key conflicts should be rare.
2562 // If they do occur, we can roll back the transaction at this time with
2563 // no data loss, but leaving unregistered files scattered throughout the
2565 // This is not ideal, which is why it's important to lock the image row.
2566 if ( $insertCurrent ) {
2567 $dbw->insert( 'image', $insertCurrent, __METHOD__
);
2570 if ( $insertBatch ) {
2571 $dbw->insert( 'oldimage', $insertBatch, __METHOD__
);
2575 $dbw->delete( 'filearchive',
2576 array( 'fa_id' => $deleteIds ),
2580 // If store batch is empty (all files are missing), deletion is to be considered successful
2581 if ( $status->successCount
> 0 ||
!$storeBatch ||
$repo->hasSha1Storage() ) {
2583 wfDebug( __METHOD__
. " restored {$status->successCount} items, creating a new current\n" );
2585 DeferredUpdates
::addUpdate( SiteStatsUpdate
::factory( array( 'images' => 1 ) ) );
2587 $this->file
->purgeEverything();
2589 wfDebug( __METHOD__
. " restored {$status->successCount} as archived versions\n" );
2590 $this->file
->purgeDescription();
2594 $this->file
->unlock();
2600 * Removes non-existent files from a store batch.
2601 * @param array $triplets
2604 protected function removeNonexistentFiles( $triplets ) {
2605 $files = $filteredTriplets = array();
2606 foreach ( $triplets as $file ) {
2607 $files[$file[0]] = $file[0];
2610 $result = $this->file
->repo
->fileExistsBatch( $files );
2611 if ( in_array( null, $result, true ) ) {
2612 return Status
::newFatal( 'backend-fail-internal',
2613 $this->file
->repo
->getBackend()->getName() );
2616 foreach ( $triplets as $file ) {
2617 if ( $result[$file[0]] ) {
2618 $filteredTriplets[] = $file;
2622 return Status
::newGood( $filteredTriplets );
2626 * Removes non-existent files from a cleanup batch.
2627 * @param array $batch
2630 protected function removeNonexistentFromCleanup( $batch ) {
2631 $files = $newBatch = array();
2632 $repo = $this->file
->repo
;
2634 foreach ( $batch as $file ) {
2635 $files[$file] = $repo->getVirtualUrl( 'deleted' ) . '/' .
2636 rawurlencode( $repo->getDeletedHashPath( $file ) . $file );
2639 $result = $repo->fileExistsBatch( $files );
2641 foreach ( $batch as $file ) {
2642 if ( $result[$file] ) {
2643 $newBatch[] = $file;
2651 * Delete unused files in the deleted zone.
2652 * This should be called from outside the transaction in which execute() was called.
2653 * @return FileRepoStatus
2655 public function cleanup() {
2656 if ( !$this->cleanupBatch
) {
2657 return $this->file
->repo
->newGood();
2660 $this->cleanupBatch
= $this->removeNonexistentFromCleanup( $this->cleanupBatch
);
2662 $status = $this->file
->repo
->cleanupDeletedBatch( $this->cleanupBatch
);
2668 * Cleanup a failed batch. The batch was only partially successful, so
2669 * rollback by removing all items that were succesfully copied.
2671 * @param Status $storeStatus
2672 * @param array $storeBatch
2674 protected function cleanupFailedBatch( $storeStatus, $storeBatch ) {
2675 $cleanupBatch = array();
2677 foreach ( $storeStatus->success
as $i => $success ) {
2678 // Check if this item of the batch was successfully copied
2680 // Item was successfully copied and needs to be removed again
2681 // Extract ($dstZone, $dstRel) from the batch
2682 $cleanupBatch[] = array( $storeBatch[$i][1], $storeBatch[$i][2] );
2685 $this->file
->repo
->cleanupBatch( $cleanupBatch );
2689 # ------------------------------------------------------------------------------
2692 * Helper class for file movement
2693 * @ingroup FileAbstraction
2695 class LocalFileMoveBatch
{
2696 /** @var LocalFile */
2706 protected $oldCount;
2710 /** @var DatabaseBase */
2715 * @param Title $target
2717 function __construct( File
$file, Title
$target ) {
2718 $this->file
= $file;
2719 $this->target
= $target;
2720 $this->oldHash
= $this->file
->repo
->getHashPath( $this->file
->getName() );
2721 $this->newHash
= $this->file
->repo
->getHashPath( $this->target
->getDBkey() );
2722 $this->oldName
= $this->file
->getName();
2723 $this->newName
= $this->file
->repo
->getNameFromTitle( $this->target
);
2724 $this->oldRel
= $this->oldHash
. $this->oldName
;
2725 $this->newRel
= $this->newHash
. $this->newName
;
2726 $this->db
= $file->getRepo()->getMasterDb();
2730 * Add the current image to the batch
2732 public function addCurrent() {
2733 $this->cur
= array( $this->oldRel
, $this->newRel
);
2737 * Add the old versions of the image to the batch
2738 * @return array List of archive names from old versions
2740 public function addOlds() {
2741 $archiveBase = 'archive';
2742 $this->olds
= array();
2743 $this->oldCount
= 0;
2744 $archiveNames = array();
2746 $result = $this->db
->select( 'oldimage',
2747 array( 'oi_archive_name', 'oi_deleted' ),
2748 array( 'oi_name' => $this->oldName
),
2750 array( 'LOCK IN SHARE MODE' ) // ignore snapshot
2753 foreach ( $result as $row ) {
2754 $archiveNames[] = $row->oi_archive_name
;
2755 $oldName = $row->oi_archive_name
;
2756 $bits = explode( '!', $oldName, 2 );
2758 if ( count( $bits ) != 2 ) {
2759 wfDebug( "Old file name missing !: '$oldName' \n" );
2763 list( $timestamp, $filename ) = $bits;
2765 if ( $this->oldName
!= $filename ) {
2766 wfDebug( "Old file name doesn't match: '$oldName' \n" );
2772 // Do we want to add those to oldCount?
2773 if ( $row->oi_deleted
& File
::DELETED_FILE
) {
2777 $this->olds
[] = array(
2778 "{$archiveBase}/{$this->oldHash}{$oldName}",
2779 "{$archiveBase}/{$this->newHash}{$timestamp}!{$this->newName}"
2783 return $archiveNames;
2788 * @return FileRepoStatus
2790 public function execute() {
2791 $repo = $this->file
->repo
;
2792 $status = $repo->newGood();
2794 $triplets = $this->getMoveTriplets();
2795 $checkStatus = $this->removeNonexistentFiles( $triplets );
2796 if ( !$checkStatus->isGood() ) {
2797 $status->merge( $checkStatus );
2800 $triplets = $checkStatus->value
;
2801 $destFile = wfLocalFile( $this->target
);
2803 $this->file
->lock(); // begin
2804 $destFile->lock(); // quickly fail if destination is not available
2805 // Rename the file versions metadata in the DB.
2806 // This implicitly locks the destination file, which avoids race conditions.
2807 // If we moved the files from A -> C before DB updates, another process could
2808 // move files from B -> C at this point, causing storeBatch() to fail and thus
2809 // cleanupTarget() to trigger. It would delete the C files and cause data loss.
2810 $statusDb = $this->doDBUpdates();
2811 if ( !$statusDb->isGood() ) {
2812 $destFile->unlock();
2813 $this->file
->unlockAndRollback();
2814 $statusDb->ok
= false;
2818 wfDebugLog( 'imagemove', "Renamed {$this->file->getName()} in database: " .
2819 "{$statusDb->successCount} successes, {$statusDb->failCount} failures" );
2821 if ( !$repo->hasSha1Storage() ) {
2822 // Copy the files into their new location.
2823 // If a prior process fataled copying or cleaning up files we tolerate any
2824 // of the existing files if they are identical to the ones being stored.
2825 $statusMove = $repo->storeBatch( $triplets, FileRepo
::OVERWRITE_SAME
);
2826 wfDebugLog( 'imagemove', "Moved files for {$this->file->getName()}: " .
2827 "{$statusMove->successCount} successes, {$statusMove->failCount} failures" );
2828 if ( !$statusMove->isGood() ) {
2829 // Delete any files copied over (while the destination is still locked)
2830 $this->cleanupTarget( $triplets );
2831 $destFile->unlock();
2832 $this->file
->unlockAndRollback(); // unlocks the destination
2833 wfDebugLog( 'imagemove', "Error in moving files: " . $statusMove->getWikiText() );
2834 $statusMove->ok
= false;
2838 $status->merge( $statusMove );
2841 $destFile->unlock();
2842 $this->file
->unlock(); // done
2844 // Everything went ok, remove the source files
2845 $this->cleanupSource( $triplets );
2847 $status->merge( $statusDb );
2853 * Do the database updates and return a new FileRepoStatus indicating how
2854 * many rows where updated.
2856 * @return FileRepoStatus
2858 protected function doDBUpdates() {
2859 $repo = $this->file
->repo
;
2860 $status = $repo->newGood();
2863 // Update current image
2866 array( 'img_name' => $this->newName
),
2867 array( 'img_name' => $this->oldName
),
2871 if ( $dbw->affectedRows() ) {
2872 $status->successCount++
;
2874 $status->failCount++
;
2875 $status->fatal( 'imageinvalidfilename' );
2880 // Update old images
2884 'oi_name' => $this->newName
,
2885 'oi_archive_name = ' . $dbw->strreplace( 'oi_archive_name',
2886 $dbw->addQuotes( $this->oldName
), $dbw->addQuotes( $this->newName
) ),
2888 array( 'oi_name' => $this->oldName
),
2892 $affected = $dbw->affectedRows();
2893 $total = $this->oldCount
;
2894 $status->successCount +
= $affected;
2895 // Bug 34934: $total is based on files that actually exist.
2896 // There may be more DB rows than such files, in which case $affected
2897 // can be greater than $total. We use max() to avoid negatives here.
2898 $status->failCount +
= max( 0, $total - $affected );
2899 if ( $status->failCount
) {
2900 $status->error( 'imageinvalidfilename' );
2907 * Generate triplets for FileRepo::storeBatch().
2910 protected function getMoveTriplets() {
2911 $moves = array_merge( array( $this->cur
), $this->olds
);
2912 $triplets = array(); // The format is: (srcUrl, destZone, destUrl)
2914 foreach ( $moves as $move ) {
2915 // $move: (oldRelativePath, newRelativePath)
2916 $srcUrl = $this->file
->repo
->getVirtualUrl() . '/public/' . rawurlencode( $move[0] );
2917 $triplets[] = array( $srcUrl, 'public', $move[1] );
2920 "Generated move triplet for {$this->file->getName()}: {$srcUrl} :: public :: {$move[1]}"
2928 * Removes non-existent files from move batch.
2929 * @param array $triplets
2932 protected function removeNonexistentFiles( $triplets ) {
2935 foreach ( $triplets as $file ) {
2936 $files[$file[0]] = $file[0];
2939 $result = $this->file
->repo
->fileExistsBatch( $files );
2940 if ( in_array( null, $result, true ) ) {
2941 return Status
::newFatal( 'backend-fail-internal',
2942 $this->file
->repo
->getBackend()->getName() );
2945 $filteredTriplets = array();
2946 foreach ( $triplets as $file ) {
2947 if ( $result[$file[0]] ) {
2948 $filteredTriplets[] = $file;
2950 wfDebugLog( 'imagemove', "File {$file[0]} does not exist" );
2954 return Status
::newGood( $filteredTriplets );
2958 * Cleanup a partially moved array of triplets by deleting the target
2959 * files. Called if something went wrong half way.
2960 * @param array $triplets
2962 protected function cleanupTarget( $triplets ) {
2963 // Create dest pairs from the triplets
2965 foreach ( $triplets as $triplet ) {
2966 // $triplet: (old source virtual URL, dst zone, dest rel)
2967 $pairs[] = array( $triplet[1], $triplet[2] );
2970 $this->file
->repo
->cleanupBatch( $pairs );
2974 * Cleanup a fully moved array of triplets by deleting the source files.
2975 * Called at the end of the move process if everything else went ok.
2976 * @param array $triplets
2978 protected function cleanupSource( $triplets ) {
2979 // Create source file names from the triplets
2981 foreach ( $triplets as $triplet ) {
2982 $files[] = $triplet[0];
2985 $this->file
->repo
->cleanupBatch( $files );