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;
53 $fileExists, # does the file exist on disk? (loadFromXxx)
54 $historyLine, # Number of line to return by nextHistoryLine() (constructor)
55 $historyRes, # result of the query for the file's history (nextHistoryLine)
58 $bits, # --- returned by getimagesize (loadFromXxx)
60 $media_type, # MEDIATYPE_xxx (bitmap, drawing, audio...)
61 $mime, # MIME type, determined by MimeMagic::guessMimeType
62 $major_mime, # Major mime type
63 $minor_mime, # Minor mime type
64 $size, # Size in bytes (loadFromXxx)
65 $metadata, # Handler-specific metadata
66 $timestamp, # Upload timestamp
67 $sha1, # SHA-1 base 36 content hash
68 $user, $user_text, # User, who uploaded the file
69 $description, # Description of current revision of the file
70 $dataLoaded, # Whether or not core data has been loaded from the database (loadFromXxx)
71 $extraDataLoaded, # Whether or not lazy-loaded data has been loaded from the database
72 $upgraded, # Whether the row was upgraded on load
73 $locked, # True if the image row is locked
74 $lockedOwnTrx, # True if the image row is locked with a lock initiated transaction
75 $missing, # True if file is not present in file system. Not to be cached in memcached
76 $deleted; # Bitfield akin to rev_deleted
85 protected $repoClass = 'LocalRepo';
87 const LOAD_ALL
= 1; // integer; load all the lazy fields too (like metadata)
90 * Create a LocalFile from a title
91 * Do not call this except from inside a repo class.
93 * Note: $unused param is only here to avoid an E_STRICT
101 static function newFromTitle( $title, $repo, $unused = null ) {
102 return new self( $title, $repo );
106 * Create a LocalFile from a title
107 * Do not call this except from inside a repo class.
114 static function newFromRow( $row, $repo ) {
115 $title = Title
::makeTitle( NS_FILE
, $row->img_name
);
116 $file = new self( $title, $repo );
117 $file->loadFromRow( $row );
123 * Create a LocalFile from a SHA-1 key
124 * Do not call this except from inside a repo class.
126 * @param string $sha1 base-36 SHA-1
127 * @param $repo LocalRepo
128 * @param string|bool $timestamp MW_timestamp (optional)
130 * @return bool|LocalFile
132 static function newFromKey( $sha1, $repo, $timestamp = false ) {
133 $dbr = $repo->getSlaveDB();
135 $conds = array( 'img_sha1' => $sha1 );
137 $conds['img_timestamp'] = $dbr->timestamp( $timestamp );
140 $row = $dbr->selectRow( 'image', self
::selectFields(), $conds, __METHOD__
);
142 return self
::newFromRow( $row, $repo );
149 * Fields in the image table
152 static function selectFields() {
173 * Do not call this except from inside a repo class.
175 function __construct( $title, $repo ) {
176 parent
::__construct( $title, $repo );
178 $this->metadata
= '';
179 $this->historyLine
= 0;
180 $this->historyRes
= null;
181 $this->dataLoaded
= false;
182 $this->extraDataLoaded
= false;
184 $this->assertRepoDefined();
185 $this->assertTitleDefined();
189 * Get the memcached key for the main data for this file, or false if
190 * there is no access to the shared cache.
193 function getCacheKey() {
194 $hashedName = md5( $this->getName() );
196 return $this->repo
->getSharedCacheKey( 'file', $hashedName );
200 * Try to load file metadata from memcached. Returns true on success.
203 function loadFromCache() {
206 wfProfileIn( __METHOD__
);
207 $this->dataLoaded
= false;
208 $this->extraDataLoaded
= false;
209 $key = $this->getCacheKey();
212 wfProfileOut( __METHOD__
);
216 $cachedValues = $wgMemc->get( $key );
218 // Check if the key existed and belongs to this version of MediaWiki
219 if ( isset( $cachedValues['version'] ) && $cachedValues['version'] == MW_FILE_VERSION
) {
220 wfDebug( "Pulling file metadata from cache key $key\n" );
221 $this->fileExists
= $cachedValues['fileExists'];
222 if ( $this->fileExists
) {
223 $this->setProps( $cachedValues );
225 $this->dataLoaded
= true;
226 $this->extraDataLoaded
= true;
227 foreach ( $this->getLazyCacheFields( '' ) as $field ) {
228 $this->extraDataLoaded
= $this->extraDataLoaded
&& isset( $cachedValues[$field] );
232 if ( $this->dataLoaded
) {
233 wfIncrStats( 'image_cache_hit' );
235 wfIncrStats( 'image_cache_miss' );
238 wfProfileOut( __METHOD__
);
239 return $this->dataLoaded
;
243 * Save the file metadata to memcached
245 function saveToCache() {
249 $key = $this->getCacheKey();
255 $fields = $this->getCacheFields( '' );
256 $cache = array( 'version' => MW_FILE_VERSION
);
257 $cache['fileExists'] = $this->fileExists
;
259 if ( $this->fileExists
) {
260 foreach ( $fields as $field ) {
261 $cache[$field] = $this->$field;
265 // Strip off excessive entries from the subset of fields that can become large.
266 // If the cache value gets to large it will not fit in memcached and nothing will
267 // get cached at all, causing master queries for any file access.
268 foreach ( $this->getLazyCacheFields( '' ) as $field ) {
269 if ( isset( $cache[$field] ) && strlen( $cache[$field] ) > 100 * 1024 ) {
270 unset( $cache[$field] ); // don't let the value get too big
274 // Cache presence for 1 week and negatives for 1 day
275 $wgMemc->set( $key, $cache, $this->fileExists ?
86400 * 7 : 86400 );
279 * Load metadata from the file itself
281 function loadFromFile() {
282 $props = $this->repo
->getFileProps( $this->getVirtualUrl() );
283 $this->setProps( $props );
287 * @param $prefix string
290 function getCacheFields( $prefix = 'img_' ) {
291 static $fields = array( 'size', 'width', 'height', 'bits', 'media_type',
292 'major_mime', 'minor_mime', 'metadata', 'timestamp', 'sha1', 'user', 'user_text', 'description' );
293 static $results = array();
295 if ( $prefix == '' ) {
299 if ( !isset( $results[$prefix] ) ) {
300 $prefixedFields = array();
301 foreach ( $fields as $field ) {
302 $prefixedFields[] = $prefix . $field;
304 $results[$prefix] = $prefixedFields;
307 return $results[$prefix];
313 function getLazyCacheFields( $prefix = 'img_' ) {
314 static $fields = array( 'metadata' );
315 static $results = array();
317 if ( $prefix == '' ) {
321 if ( !isset( $results[$prefix] ) ) {
322 $prefixedFields = array();
323 foreach ( $fields as $field ) {
324 $prefixedFields[] = $prefix . $field;
326 $results[$prefix] = $prefixedFields;
329 return $results[$prefix];
333 * Load file metadata from the DB
335 function loadFromDB() {
336 # Polymorphic function name to distinguish foreign and local fetches
337 $fname = get_class( $this ) . '::' . __FUNCTION__
;
338 wfProfileIn( $fname );
340 # Unconditionally set loaded=true, we don't want the accessors constantly rechecking
341 $this->dataLoaded
= true;
342 $this->extraDataLoaded
= true;
344 $dbr = $this->repo
->getMasterDB();
345 $row = $dbr->selectRow( 'image', $this->getCacheFields( 'img_' ),
346 array( 'img_name' => $this->getName() ), $fname );
349 $this->loadFromRow( $row );
351 $this->fileExists
= false;
354 wfProfileOut( $fname );
358 * Load lazy file metadata from the DB.
359 * This covers fields that are sometimes not cached.
361 protected function loadExtraFromDB() {
362 # Polymorphic function name to distinguish foreign and local fetches
363 $fname = get_class( $this ) . '::' . __FUNCTION__
;
364 wfProfileIn( $fname );
366 # Unconditionally set loaded=true, we don't want the accessors constantly rechecking
367 $this->extraDataLoaded
= true;
369 $dbr = $this->repo
->getSlaveDB();
370 // In theory the file could have just been renamed/deleted...oh well
371 $row = $dbr->selectRow( 'image', $this->getLazyCacheFields( 'img_' ),
372 array( 'img_name' => $this->getName() ), $fname );
374 if ( !$row ) { // fallback to master
375 $dbr = $this->repo
->getMasterDB();
376 $row = $dbr->selectRow( 'image', $this->getLazyCacheFields( 'img_' ),
377 array( 'img_name' => $this->getName() ), $fname );
381 foreach ( $this->unprefixRow( $row, 'img_' ) as $name => $value ) {
382 $this->$name = $value;
385 wfProfileOut( $fname );
386 throw new MWException( "Could not find data for image '{$this->getName()}'." );
389 wfProfileOut( $fname );
394 * @param $prefix string
397 protected function unprefixRow( $row, $prefix = 'img_' ) {
398 $array = (array)$row;
399 $prefixLength = strlen( $prefix );
401 // Sanity check prefix once
402 if ( substr( key( $array ), 0, $prefixLength ) !== $prefix ) {
403 throw new MWException( __METHOD__
. ': incorrect $prefix parameter' );
407 foreach ( $array as $name => $value ) {
408 $decoded[substr( $name, $prefixLength )] = $value;
414 * Decode a row from the database (either object or array) to an array
415 * with timestamps and MIME types decoded, and the field prefix removed.
417 * @param $prefix string
418 * @throws MWException
421 function decodeRow( $row, $prefix = 'img_' ) {
422 $decoded = $this->unprefixRow( $row, $prefix );
424 $decoded['timestamp'] = wfTimestamp( TS_MW
, $decoded['timestamp'] );
426 if ( empty( $decoded['major_mime'] ) ) {
427 $decoded['mime'] = 'unknown/unknown';
429 if ( !$decoded['minor_mime'] ) {
430 $decoded['minor_mime'] = 'unknown';
432 $decoded['mime'] = $decoded['major_mime'] . '/' . $decoded['minor_mime'];
435 # Trim zero padding from char/binary field
436 $decoded['sha1'] = rtrim( $decoded['sha1'], "\0" );
442 * Load file metadata from a DB result row
444 function loadFromRow( $row, $prefix = 'img_' ) {
445 $this->dataLoaded
= true;
446 $this->extraDataLoaded
= true;
448 $array = $this->decodeRow( $row, $prefix );
450 foreach ( $array as $name => $value ) {
451 $this->$name = $value;
454 $this->fileExists
= true;
455 $this->maybeUpgradeRow();
459 * Load file metadata from cache or DB, unless already loaded
460 * @param integer $flags
462 function load( $flags = 0 ) {
463 if ( !$this->dataLoaded
) {
464 if ( !$this->loadFromCache() ) {
466 $this->saveToCache();
468 $this->dataLoaded
= true;
470 if ( ( $flags & self
::LOAD_ALL
) && !$this->extraDataLoaded
) {
471 $this->loadExtraFromDB();
476 * Upgrade a row if it needs it
478 function maybeUpgradeRow() {
479 global $wgUpdateCompatibleMetadata;
480 if ( wfReadOnly() ) {
484 if ( is_null( $this->media_type
) ||
485 $this->mime
== 'image/svg'
488 $this->upgraded
= true;
490 $handler = $this->getHandler();
492 $validity = $handler->isMetadataValid( $this, $this->getMetadata() );
493 if ( $validity === MediaHandler
::METADATA_BAD
494 ||
( $validity === MediaHandler
::METADATA_COMPATIBLE
&& $wgUpdateCompatibleMetadata )
497 $this->upgraded
= true;
503 function getUpgraded() {
504 return $this->upgraded
;
508 * Fix assorted version-related problems with the image row by reloading it from the file
510 function upgradeRow() {
511 wfProfileIn( __METHOD__
);
513 $this->lock(); // begin
515 $this->loadFromFile();
517 # Don't destroy file info of missing files
518 if ( !$this->fileExists
) {
519 wfDebug( __METHOD__
. ": file does not exist, aborting\n" );
520 wfProfileOut( __METHOD__
);
524 $dbw = $this->repo
->getMasterDB();
525 list( $major, $minor ) = self
::splitMime( $this->mime
);
527 if ( wfReadOnly() ) {
528 wfProfileOut( __METHOD__
);
531 wfDebug( __METHOD__
. ': upgrading ' . $this->getName() . " to the current schema\n" );
533 $dbw->update( 'image',
535 'img_size' => $this->size
, // sanity
536 'img_width' => $this->width
,
537 'img_height' => $this->height
,
538 'img_bits' => $this->bits
,
539 'img_media_type' => $this->media_type
,
540 'img_major_mime' => $major,
541 'img_minor_mime' => $minor,
542 'img_metadata' => $dbw->encodeBlob($this->metadata
),
543 'img_sha1' => $this->sha1
,
545 array( 'img_name' => $this->getName() ),
549 $this->saveToCache();
551 $this->unlock(); // done
553 wfProfileOut( __METHOD__
);
557 * Set properties in this object to be equal to those given in the
558 * associative array $info. Only cacheable fields can be set.
559 * All fields *must* be set in $info except for getLazyCacheFields().
561 * If 'mime' is given, it will be split into major_mime/minor_mime.
562 * If major_mime/minor_mime are given, $this->mime will also be set.
564 function setProps( $info ) {
565 $this->dataLoaded
= true;
566 $fields = $this->getCacheFields( '' );
567 $fields[] = 'fileExists';
569 foreach ( $fields as $field ) {
570 if ( isset( $info[$field] ) ) {
571 $this->$field = $info[$field];
575 // Fix up mime fields
576 if ( isset( $info['major_mime'] ) ) {
577 $this->mime
= "{$info['major_mime']}/{$info['minor_mime']}";
578 } elseif ( isset( $info['mime'] ) ) {
579 $this->mime
= $info['mime'];
580 list( $this->major_mime
, $this->minor_mime
) = self
::splitMime( $this->mime
);
584 /** splitMime inherited */
585 /** getName inherited */
586 /** getTitle inherited */
587 /** getURL inherited */
588 /** getViewURL inherited */
589 /** getPath inherited */
590 /** isVisible inhereted */
595 function isMissing() {
596 if ( $this->missing
=== null ) {
597 list( $fileExists ) = $this->repo
->fileExists( $this->getVirtualUrl() );
598 $this->missing
= !$fileExists;
600 return $this->missing
;
604 * Return the width of the image
609 public function getWidth( $page = 1 ) {
612 if ( $this->isMultipage() ) {
613 $handler = $this->getHandler();
617 $dim = $handler->getPageDimensions( $this, $page );
619 return $dim['width'];
621 // For non-paged media, the false goes through an
622 // intval, turning failure into 0, so do same here.
631 * Return the height of the image
636 public function getHeight( $page = 1 ) {
639 if ( $this->isMultipage() ) {
640 $handler = $this->getHandler();
644 $dim = $handler->getPageDimensions( $this, $page );
646 return $dim['height'];
648 // For non-paged media, the false goes through an
649 // intval, turning failure into 0, so do same here.
653 return $this->height
;
658 * Returns ID or name of user who uploaded the file
660 * @param string $type 'text' or 'id'
663 function getUser( $type = 'text' ) {
666 if ( $type == 'text' ) {
667 return $this->user_text
;
668 } elseif ( $type == 'id' ) {
674 * Get handler-specific metadata
677 function getMetadata() {
678 $this->load( self
::LOAD_ALL
); // large metadata is loaded in another step
679 return $this->metadata
;
685 function getBitDepth() {
691 * Return the size of the image file, in bytes
694 public function getSize() {
700 * Returns the mime type of the file.
703 function getMimeType() {
709 * Return the type of the media in the file.
710 * Use the value returned by this function with the MEDIATYPE_xxx constants.
713 function getMediaType() {
715 return $this->media_type
;
718 /** canRender inherited */
719 /** mustRender inherited */
720 /** allowInlineDisplay inherited */
721 /** isSafeFile inherited */
722 /** isTrustedFile inherited */
725 * Returns true if the file exists on disk.
726 * @return boolean Whether file exist on disk.
728 public function exists() {
730 return $this->fileExists
;
733 /** getTransformScript inherited */
734 /** getUnscaledThumb inherited */
735 /** thumbName inherited */
736 /** createThumb inherited */
737 /** transform inherited */
740 * Fix thumbnail files from 1.4 or before, with extreme prejudice
741 * @todo : do we still care about this? Perhaps a maintenance script
742 * can be made instead. Enabling this code results in a serious
743 * RTT regression for wikis without 404 handling.
745 function migrateThumbFile( $thumbName ) {
746 /* Old code for bug 2532
747 $thumbDir = $this->getThumbPath();
748 $thumbPath = "$thumbDir/$thumbName";
749 if ( is_dir( $thumbPath ) ) {
750 // Directory where file should be
751 // This happened occasionally due to broken migration code in 1.5
752 // Rename to broken-*
753 for ( $i = 0; $i < 100; $i++ ) {
754 $broken = $this->repo->getZonePath( 'public' ) . "/broken-$i-$thumbName";
755 if ( !file_exists( $broken ) ) {
756 rename( $thumbPath, $broken );
760 // Doesn't exist anymore
766 if ( $this->repo->fileExists( $thumbDir ) ) {
767 // Delete file where directory should be
768 $this->repo->cleanupBatch( array( $thumbDir ) );
773 /** getHandler inherited */
774 /** iconThumb inherited */
775 /** getLastError inherited */
778 * Get all thumbnail names previously generated for this file
779 * @param string|bool $archiveName Name of an archive file, default false
780 * @return array first element is the base dir, then files in that base dir.
782 function getThumbnails( $archiveName = false ) {
783 if ( $archiveName ) {
784 $dir = $this->getArchiveThumbPath( $archiveName );
786 $dir = $this->getThumbPath();
789 $backend = $this->repo
->getBackend();
790 $files = array( $dir );
792 $iterator = $backend->getFileList( array( 'dir' => $dir ) );
793 foreach ( $iterator as $file ) {
796 } catch ( FileBackendError
$e ) {} // suppress (bug 54674)
802 * Refresh metadata in memcached, but don't touch thumbnails or squid
804 function purgeMetadataCache() {
806 $this->saveToCache();
807 $this->purgeHistory();
811 * Purge the shared history (OldLocalFile) cache.
813 * @note This used to purge old thumbnails as well.
815 function purgeHistory() {
818 $hashedName = md5( $this->getName() );
819 $oldKey = $this->repo
->getSharedCacheKey( 'oldfile', $hashedName );
822 $wgMemc->delete( $oldKey );
827 * Delete all previously generated thumbnails, refresh metadata in memcached and purge the squid.
829 * @param Array $options An array potentially with the key forThumbRefresh.
831 * @note This used to purge old thumbnails by default as well, but doesn't anymore.
833 function purgeCache( $options = array() ) {
834 wfProfileIn( __METHOD__
);
835 // Refresh metadata cache
836 $this->purgeMetadataCache();
839 $this->purgeThumbnails( $options );
841 // Purge squid cache for this file
842 SquidUpdate
::purge( array( $this->getURL() ) );
843 wfProfileOut( __METHOD__
);
847 * Delete cached transformed files for an archived version only.
848 * @param string $archiveName name of the archived file
850 function purgeOldThumbnails( $archiveName ) {
852 wfProfileIn( __METHOD__
);
854 // Get a list of old thumbnails and URLs
855 $files = $this->getThumbnails( $archiveName );
856 $dir = array_shift( $files );
857 $this->purgeThumbList( $dir, $files );
859 // Purge any custom thumbnail caches
860 wfRunHooks( 'LocalFilePurgeThumbnails', array( $this, $archiveName ) );
865 foreach ( $files as $file ) {
866 $urls[] = $this->getArchiveThumbUrl( $archiveName, $file );
868 SquidUpdate
::purge( $urls );
871 wfProfileOut( __METHOD__
);
875 * Delete cached transformed files for the current version only.
877 function purgeThumbnails( $options = array() ) {
879 wfProfileIn( __METHOD__
);
882 $files = $this->getThumbnails();
883 // Always purge all files from squid regardless of handler filters
886 foreach ( $files as $file ) {
887 $urls[] = $this->getThumbUrl( $file );
889 array_shift( $urls ); // don't purge directory
892 // Give media handler a chance to filter the file purge list
893 if ( !empty( $options['forThumbRefresh'] ) ) {
894 $handler = $this->getHandler();
896 $handler->filterThumbnailPurgeList( $files, $options );
900 $dir = array_shift( $files );
901 $this->purgeThumbList( $dir, $files );
903 // Purge any custom thumbnail caches
904 wfRunHooks( 'LocalFilePurgeThumbnails', array( $this, false ) );
908 SquidUpdate
::purge( $urls );
911 wfProfileOut( __METHOD__
);
915 * Delete a list of thumbnails visible at urls
916 * @param string $dir base dir of the files.
917 * @param array $files of strings: relative filenames (to $dir)
919 protected function purgeThumbList( $dir, $files ) {
920 $fileListDebug = strtr(
921 var_export( $files, true ),
924 wfDebug( __METHOD__
. ": $fileListDebug\n" );
926 $purgeList = array();
927 foreach ( $files as $file ) {
928 # Check that the base file name is part of the thumb name
929 # This is a basic sanity check to avoid erasing unrelated directories
930 if ( strpos( $file, $this->getName() ) !== false
931 ||
strpos( $file, "-thumbnail" ) !== false // "short" thumb name
933 $purgeList[] = "{$dir}/{$file}";
937 # Delete the thumbnails
938 $this->repo
->quickPurgeBatch( $purgeList );
939 # Clear out the thumbnail directory if empty
940 $this->repo
->quickCleanDir( $dir );
943 /** purgeDescription inherited */
944 /** purgeEverything inherited */
953 function getHistory( $limit = null, $start = null, $end = null, $inc = true ) {
954 $dbr = $this->repo
->getSlaveDB();
955 $tables = array( 'oldimage' );
956 $fields = OldLocalFile
::selectFields();
957 $conds = $opts = $join_conds = array();
958 $eq = $inc ?
'=' : '';
959 $conds[] = "oi_name = " . $dbr->addQuotes( $this->title
->getDBkey() );
962 $conds[] = "oi_timestamp <$eq " . $dbr->addQuotes( $dbr->timestamp( $start ) );
966 $conds[] = "oi_timestamp >$eq " . $dbr->addQuotes( $dbr->timestamp( $end ) );
970 $opts['LIMIT'] = $limit;
973 // Search backwards for time > x queries
974 $order = ( !$start && $end !== null ) ?
'ASC' : 'DESC';
975 $opts['ORDER BY'] = "oi_timestamp $order";
976 $opts['USE INDEX'] = array( 'oldimage' => 'oi_name_timestamp' );
978 wfRunHooks( 'LocalFile::getHistory', array( &$this, &$tables, &$fields,
979 &$conds, &$opts, &$join_conds ) );
981 $res = $dbr->select( $tables, $fields, $conds, __METHOD__
, $opts, $join_conds );
984 foreach ( $res as $row ) {
985 if ( $this->repo
->oldFileFromRowFactory
) {
986 $r[] = call_user_func( $this->repo
->oldFileFromRowFactory
, $row, $this->repo
);
988 $r[] = OldLocalFile
::newFromRow( $row, $this->repo
);
992 if ( $order == 'ASC' ) {
993 $r = array_reverse( $r ); // make sure it ends up descending
1000 * Return the history of this file, line by line.
1001 * starts with current version, then old versions.
1002 * uses $this->historyLine to check which line to return:
1003 * 0 return line for current version
1004 * 1 query for old versions, return first one
1005 * 2, ... return next old version from above query
1008 public function nextHistoryLine() {
1009 # Polymorphic function name to distinguish foreign and local fetches
1010 $fname = get_class( $this ) . '::' . __FUNCTION__
;
1012 $dbr = $this->repo
->getSlaveDB();
1014 if ( $this->historyLine
== 0 ) {// called for the first time, return line from cur
1015 $this->historyRes
= $dbr->select( 'image',
1018 "'' AS oi_archive_name",
1022 array( 'img_name' => $this->title
->getDBkey() ),
1026 if ( 0 == $dbr->numRows( $this->historyRes
) ) {
1027 $this->historyRes
= null;
1030 } elseif ( $this->historyLine
== 1 ) {
1031 $this->historyRes
= $dbr->select( 'oldimage', '*',
1032 array( 'oi_name' => $this->title
->getDBkey() ),
1034 array( 'ORDER BY' => 'oi_timestamp DESC' )
1037 $this->historyLine ++
;
1039 return $dbr->fetchObject( $this->historyRes
);
1043 * Reset the history pointer to the first element of the history
1045 public function resetHistory() {
1046 $this->historyLine
= 0;
1048 if ( !is_null( $this->historyRes
) ) {
1049 $this->historyRes
= null;
1053 /** getHashPath inherited */
1054 /** getRel inherited */
1055 /** getUrlRel inherited */
1056 /** getArchiveRel inherited */
1057 /** getArchivePath inherited */
1058 /** getThumbPath inherited */
1059 /** getArchiveUrl inherited */
1060 /** getThumbUrl inherited */
1061 /** getArchiveVirtualUrl inherited */
1062 /** getThumbVirtualUrl inherited */
1063 /** isHashed inherited */
1066 * Upload a file and record it in the DB
1067 * @param string $srcPath source storage path, virtual URL, or filesystem path
1068 * @param string $comment upload description
1069 * @param string $pageText text to use for the new description page,
1070 * if a new description page is created
1071 * @param $flags Integer|bool: flags for publish()
1072 * @param array|bool $props File properties, if known. This can be used to reduce the
1073 * upload time when uploading virtual URLs for which the file info
1075 * @param string|bool $timestamp timestamp for img_timestamp, or false to use the current time
1076 * @param $user User|null: User object or null to use $wgUser
1078 * @return FileRepoStatus object. On success, the value member contains the
1079 * archive name, or an empty string if it was a new file.
1081 function upload( $srcPath, $comment, $pageText, $flags = 0, $props = false, $timestamp = false, $user = null ) {
1084 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
1085 return $this->readOnlyFatalStatus();
1089 wfProfileIn( __METHOD__
. '-getProps' );
1090 if ( $this->repo
->isVirtualUrl( $srcPath )
1091 || FileBackend
::isStoragePath( $srcPath ) )
1093 $props = $this->repo
->getFileProps( $srcPath );
1095 $props = FSFile
::getPropsFromPath( $srcPath );
1097 wfProfileOut( __METHOD__
. '-getProps' );
1101 $handler = MediaHandler
::getHandler( $props['mime'] );
1103 $options['headers'] = $handler->getStreamHeaders( $props['metadata'] );
1105 $options['headers'] = array();
1108 // Trim spaces on user supplied text
1109 $comment = trim( $comment );
1111 // truncate nicely or the DB will do it for us
1112 // non-nicely (dangling multi-byte chars, non-truncated version in cache).
1113 $comment = $wgContLang->truncate( $comment, 255 );
1114 $this->lock(); // begin
1115 $status = $this->publish( $srcPath, $flags, $options );
1117 if ( $status->successCount
> 0 ) {
1118 # Essentially we are displacing any existing current file and saving
1119 # a new current file at the old location. If just the first succeeded,
1120 # we still need to displace the current DB entry and put in a new one.
1121 if ( !$this->recordUpload2( $status->value
, $comment, $pageText, $props, $timestamp, $user ) ) {
1122 $status->fatal( 'filenotfound', $srcPath );
1126 $this->unlock(); // done
1132 * Record a file upload in the upload log and the image table
1134 * @param $desc string
1135 * @param $license string
1136 * @param $copyStatus string
1137 * @param $source string
1138 * @param $watch bool
1139 * @param $timestamp string|bool
1140 * @param $user User object or null to use $wgUser
1143 function recordUpload( $oldver, $desc, $license = '', $copyStatus = '', $source = '',
1144 $watch = false, $timestamp = false, User
$user = null )
1151 $pageText = SpecialUpload
::getInitialPageText( $desc, $license, $copyStatus, $source );
1153 if ( !$this->recordUpload2( $oldver, $desc, $pageText, false, $timestamp, $user ) ) {
1158 $user->addWatch( $this->getTitle() );
1164 * Record a file upload in the upload log and the image table
1166 * @param $comment string
1167 * @param $pageText string
1168 * @param $props bool|array
1169 * @param $timestamp bool|string
1170 * @param $user null|User
1173 function recordUpload2(
1174 $oldver, $comment, $pageText, $props = false, $timestamp = false, $user = null
1176 wfProfileIn( __METHOD__
);
1178 if ( is_null( $user ) ) {
1183 $dbw = $this->repo
->getMasterDB();
1184 $dbw->begin( __METHOD__
);
1187 wfProfileIn( __METHOD__
. '-getProps' );
1188 $props = $this->repo
->getFileProps( $this->getVirtualUrl() );
1189 wfProfileOut( __METHOD__
. '-getProps' );
1192 if ( $timestamp === false ) {
1193 $timestamp = $dbw->timestamp();
1196 $props['description'] = $comment;
1197 $props['user'] = $user->getId();
1198 $props['user_text'] = $user->getName();
1199 $props['timestamp'] = wfTimestamp( TS_MW
, $timestamp ); // DB -> TS_MW
1200 $this->setProps( $props );
1202 # Fail now if the file isn't there
1203 if ( !$this->fileExists
) {
1204 wfDebug( __METHOD__
. ": File " . $this->getRel() . " went missing!\n" );
1205 wfProfileOut( __METHOD__
);
1211 # Test to see if the row exists using INSERT IGNORE
1212 # This avoids race conditions by locking the row until the commit, and also
1213 # doesn't deadlock. SELECT FOR UPDATE causes a deadlock for every race condition.
1214 $dbw->insert( 'image',
1216 'img_name' => $this->getName(),
1217 'img_size' => $this->size
,
1218 'img_width' => intval( $this->width
),
1219 'img_height' => intval( $this->height
),
1220 'img_bits' => $this->bits
,
1221 'img_media_type' => $this->media_type
,
1222 'img_major_mime' => $this->major_mime
,
1223 'img_minor_mime' => $this->minor_mime
,
1224 'img_timestamp' => $timestamp,
1225 'img_description' => $comment,
1226 'img_user' => $user->getId(),
1227 'img_user_text' => $user->getName(),
1228 'img_metadata' => $dbw->encodeBlob($this->metadata
),
1229 'img_sha1' => $this->sha1
1234 if ( $dbw->affectedRows() == 0 ) {
1235 # (bug 34993) Note: $oldver can be empty here, if the previous
1236 # version of the file was broken. Allow registration of the new
1237 # version to continue anyway, because that's better than having
1238 # an image that's not fixable by user operations.
1241 # Collision, this is an update of a file
1242 # Insert previous contents into oldimage
1243 $dbw->insertSelect( 'oldimage', 'image',
1245 'oi_name' => 'img_name',
1246 'oi_archive_name' => $dbw->addQuotes( $oldver ),
1247 'oi_size' => 'img_size',
1248 'oi_width' => 'img_width',
1249 'oi_height' => 'img_height',
1250 'oi_bits' => 'img_bits',
1251 'oi_timestamp' => 'img_timestamp',
1252 'oi_description' => 'img_description',
1253 'oi_user' => 'img_user',
1254 'oi_user_text' => 'img_user_text',
1255 'oi_metadata' => 'img_metadata',
1256 'oi_media_type' => 'img_media_type',
1257 'oi_major_mime' => 'img_major_mime',
1258 'oi_minor_mime' => 'img_minor_mime',
1259 'oi_sha1' => 'img_sha1'
1261 array( 'img_name' => $this->getName() ),
1265 # Update the current image row
1266 $dbw->update( 'image',
1268 'img_size' => $this->size
,
1269 'img_width' => intval( $this->width
),
1270 'img_height' => intval( $this->height
),
1271 'img_bits' => $this->bits
,
1272 'img_media_type' => $this->media_type
,
1273 'img_major_mime' => $this->major_mime
,
1274 'img_minor_mime' => $this->minor_mime
,
1275 'img_timestamp' => $timestamp,
1276 'img_description' => $comment,
1277 'img_user' => $user->getId(),
1278 'img_user_text' => $user->getName(),
1279 'img_metadata' => $dbw->encodeBlob($this->metadata
),
1280 'img_sha1' => $this->sha1
1282 array( 'img_name' => $this->getName() ),
1286 # This is a new file, so update the image count
1287 DeferredUpdates
::addUpdate( SiteStatsUpdate
::factory( array( 'images' => 1 ) ) );
1290 $descTitle = $this->getTitle();
1291 $wikiPage = new WikiFilePage( $descTitle );
1292 $wikiPage->setFile( $this );
1295 $action = $reupload ?
'overwrite' : 'upload';
1297 $logEntry = new ManualLogEntry( 'upload', $action );
1298 $logEntry->setPerformer( $user );
1299 $logEntry->setComment( $comment );
1300 $logEntry->setTarget( $descTitle );
1302 // Allow people using the api to associate log entries with the upload.
1303 // Log has a timestamp, but sometimes different from upload timestamp.
1304 $logEntry->setParameters(
1306 'img_sha1' => $this->sha1
,
1307 'img_timestamp' => $timestamp,
1310 // Note we keep $logId around since during new image
1311 // creation, page doesn't exist yet, so log_page = 0
1312 // but we want it to point to the page we're making,
1313 // so we later modify the log entry.
1314 // For a similar reason, we avoid making an RC entry
1315 // now and wait until the page exists.
1316 $logId = $logEntry->insert();
1318 $exists = $descTitle->exists();
1320 // Page exists, do RC entry now (otherwise we wait for later).
1321 $logEntry->publish( $logId );
1323 wfProfileIn( __METHOD__
. '-edit' );
1326 # Create a null revision
1327 $latest = $descTitle->getLatestRevID();
1328 $editSummary = LogFormatter
::newFromEntry( $logEntry )->getPlainActionText();
1330 $nullRevision = Revision
::newNullRevision(
1332 $descTitle->getArticleID(),
1336 if ( !is_null( $nullRevision ) ) {
1337 $nullRevision->insertOn( $dbw );
1339 wfRunHooks( 'NewRevisionFromEditComplete', array( $wikiPage, $nullRevision, $latest, $user ) );
1340 $wikiPage->updateRevisionOn( $dbw, $nullRevision );
1344 # Commit the transaction now, in case something goes wrong later
1345 # The most important thing is that files don't get lost, especially archives
1346 # NOTE: once we have support for nested transactions, the commit may be moved
1347 # to after $wikiPage->doEdit has been called.
1348 $dbw->commit( __METHOD__
);
1351 # Invalidate the cache for the description page
1352 $descTitle->invalidateCache();
1353 $descTitle->purgeSquid();
1355 # New file; create the description page.
1356 # There's already a log entry, so don't make a second RC entry
1357 # Squid and file cache for the description page are purged by doEditContent.
1358 $content = ContentHandler
::makeContent( $pageText, $descTitle );
1359 $status = $wikiPage->doEditContent( $content, $comment, EDIT_NEW | EDIT_SUPPRESS_RC
, false, $user );
1361 $dbw->begin( __METHOD__
); // XXX; doEdit() uses a transaction
1362 // Now that the page exists, make an RC entry.
1363 $logEntry->publish( $logId );
1364 if ( isset( $status->value
['revision'] ) ) {
1365 $dbw->update( 'logging',
1366 array( 'log_page' => $status->value
['revision']->getPage() ),
1367 array( 'log_id' => $logId ),
1371 $dbw->commit( __METHOD__
); // commit before anything bad can happen
1375 wfProfileOut( __METHOD__
. '-edit' );
1377 # Save to cache and purge the squid
1378 # We shall not saveToCache before the commit since otherwise
1379 # in case of a rollback there is an usable file from memcached
1380 # which in fact doesn't really exist (bug 24978)
1381 $this->saveToCache();
1384 # Delete old thumbnails
1385 wfProfileIn( __METHOD__
. '-purge' );
1386 $this->purgeThumbnails();
1387 wfProfileOut( __METHOD__
. '-purge' );
1389 # Remove the old file from the squid cache
1390 SquidUpdate
::purge( array( $this->getURL() ) );
1393 # Hooks, hooks, the magic of hooks...
1394 wfProfileIn( __METHOD__
. '-hooks' );
1395 wfRunHooks( 'FileUpload', array( $this, $reupload, $descTitle->exists() ) );
1396 wfProfileOut( __METHOD__
. '-hooks' );
1398 # Invalidate cache for all pages using this file
1399 $update = new HTMLCacheUpdate( $this->getTitle(), 'imagelinks' );
1400 $update->doUpdate();
1402 LinksUpdate
::queueRecursiveJobsForTable( $this->getTitle(), 'imagelinks' );
1405 # Invalidate cache for all pages that redirects on this page
1406 $redirs = $this->getTitle()->getRedirectsHere();
1408 foreach ( $redirs as $redir ) {
1409 if ( !$reupload && $redir->getNamespace() === NS_FILE
) {
1410 LinksUpdate
::queueRecursiveJobsForTable( $redir, 'imagelinks' );
1412 $update = new HTMLCacheUpdate( $redir, 'imagelinks' );
1413 $update->doUpdate();
1416 wfProfileOut( __METHOD__
);
1421 * Move or copy a file to its public location. If a file exists at the
1422 * destination, move it to an archive. Returns a FileRepoStatus object with
1423 * the archive name in the "value" member on success.
1425 * The archive name should be passed through to recordUpload for database
1428 * @param string $srcPath local filesystem path to the source image
1429 * @param $flags Integer: a bitwise combination of:
1430 * File::DELETE_SOURCE Delete the source file, i.e. move rather than copy
1431 * @param array $options Optional additional parameters
1432 * @return FileRepoStatus object. On success, the value member contains the
1433 * archive name, or an empty string if it was a new file.
1435 function publish( $srcPath, $flags = 0, array $options = array() ) {
1436 return $this->publishTo( $srcPath, $this->getRel(), $flags, $options );
1440 * Move or copy a file to a specified location. Returns a FileRepoStatus
1441 * object with the archive name in the "value" member on success.
1443 * The archive name should be passed through to recordUpload for database
1446 * @param string $srcPath local filesystem path to the source image
1447 * @param string $dstRel target relative path
1448 * @param $flags Integer: a bitwise combination of:
1449 * File::DELETE_SOURCE Delete the source file, i.e. move rather than copy
1450 * @param array $options Optional additional parameters
1451 * @return FileRepoStatus object. On success, the value member contains the
1452 * archive name, or an empty string if it was a new file.
1454 function publishTo( $srcPath, $dstRel, $flags = 0, array $options = array() ) {
1455 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
1456 return $this->readOnlyFatalStatus();
1459 $this->lock(); // begin
1461 $archiveName = wfTimestamp( TS_MW
) . '!' . $this->getName();
1462 $archiveRel = 'archive/' . $this->getHashPath() . $archiveName;
1463 $flags = $flags & File
::DELETE_SOURCE ? LocalRepo
::DELETE_SOURCE
: 0;
1464 $status = $this->repo
->publish( $srcPath, $dstRel, $archiveRel, $flags, $options );
1466 if ( $status->value
== 'new' ) {
1467 $status->value
= '';
1469 $status->value
= $archiveName;
1472 $this->unlock(); // done
1477 /** getLinksTo inherited */
1478 /** getExifData inherited */
1479 /** isLocal inherited */
1480 /** wasDeleted inherited */
1483 * Move file to the new title
1485 * Move current, old version and all thumbnails
1486 * to the new filename. Old file is deleted.
1488 * Cache purging is done; checks for validity
1489 * and logging are caller's responsibility
1491 * @param $target Title New file name
1492 * @return FileRepoStatus object.
1494 function move( $target ) {
1495 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
1496 return $this->readOnlyFatalStatus();
1499 wfDebugLog( 'imagemove', "Got request to move {$this->name} to " . $target->getText() );
1500 $batch = new LocalFileMoveBatch( $this, $target );
1502 $this->lock(); // begin
1503 $batch->addCurrent();
1504 $archiveNames = $batch->addOlds();
1505 $status = $batch->execute();
1506 $this->unlock(); // done
1508 wfDebugLog( 'imagemove', "Finished moving {$this->name}" );
1510 // Purge the source and target files...
1511 $oldTitleFile = wfLocalFile( $this->title
);
1512 $newTitleFile = wfLocalFile( $target );
1513 // Hack: the lock()/unlock() pair is nested in a transaction so the locking is not
1514 // tied to BEGIN/COMMIT. To avoid slow purges in the transaction, move them outside.
1515 $this->getRepo()->getMasterDB()->onTransactionIdle(
1516 function() use ( $oldTitleFile, $newTitleFile, $archiveNames ) {
1517 $oldTitleFile->purgeEverything();
1518 foreach ( $archiveNames as $archiveName ) {
1519 $oldTitleFile->purgeOldThumbnails( $archiveName );
1521 $newTitleFile->purgeEverything();
1525 if ( $status->isOK() ) {
1526 // Now switch the object
1527 $this->title
= $target;
1528 // Force regeneration of the name and hashpath
1529 unset( $this->name
);
1530 unset( $this->hashPath
);
1537 * Delete all versions of the file.
1539 * Moves the files into an archive directory (or deletes them)
1540 * and removes the database rows.
1542 * Cache purging is done; logging is caller's responsibility.
1546 * @return FileRepoStatus object.
1548 function delete( $reason, $suppress = false ) {
1549 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
1550 return $this->readOnlyFatalStatus();
1553 $batch = new LocalFileDeleteBatch( $this, $reason, $suppress );
1555 $this->lock(); // begin
1556 $batch->addCurrent();
1557 # Get old version relative paths
1558 $archiveNames = $batch->addOlds();
1559 $status = $batch->execute();
1560 $this->unlock(); // done
1562 if ( $status->isOK() ) {
1563 DeferredUpdates
::addUpdate( SiteStatsUpdate
::factory( array( 'images' => -1 ) ) );
1566 // Hack: the lock()/unlock() pair is nested in a transaction so the locking is not
1567 // tied to BEGIN/COMMIT. To avoid slow purges in the transaction, move them outside.
1569 $this->getRepo()->getMasterDB()->onTransactionIdle(
1570 function() use ( $file, $archiveNames ) {
1573 $file->purgeEverything();
1574 foreach ( $archiveNames as $archiveName ) {
1575 $file->purgeOldThumbnails( $archiveName );
1578 if ( $wgUseSquid ) {
1580 $purgeUrls = array();
1581 foreach ( $archiveNames as $archiveName ) {
1582 $purgeUrls[] = $file->getArchiveUrl( $archiveName );
1584 SquidUpdate
::purge( $purgeUrls );
1593 * Delete an old version of the file.
1595 * Moves the file into an archive directory (or deletes it)
1596 * and removes the database row.
1598 * Cache purging is done; logging is caller's responsibility.
1600 * @param $archiveName String
1601 * @param $reason String
1602 * @param $suppress Boolean
1603 * @throws MWException or FSException on database or file store failure
1604 * @return FileRepoStatus object.
1606 function deleteOld( $archiveName, $reason, $suppress = false ) {
1608 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
1609 return $this->readOnlyFatalStatus();
1612 $batch = new LocalFileDeleteBatch( $this, $reason, $suppress );
1614 $this->lock(); // begin
1615 $batch->addOld( $archiveName );
1616 $status = $batch->execute();
1617 $this->unlock(); // done
1619 $this->purgeOldThumbnails( $archiveName );
1620 if ( $status->isOK() ) {
1621 $this->purgeDescription();
1622 $this->purgeHistory();
1625 if ( $wgUseSquid ) {
1627 SquidUpdate
::purge( array( $this->getArchiveUrl( $archiveName ) ) );
1634 * Restore all or specified deleted revisions to the given file.
1635 * Permissions and logging are left to the caller.
1637 * May throw database exceptions on error.
1639 * @param array $versions set of record ids of deleted items to restore,
1640 * or empty to restore all revisions.
1641 * @param $unsuppress Boolean
1642 * @return FileRepoStatus
1644 function restore( $versions = array(), $unsuppress = false ) {
1645 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
1646 return $this->readOnlyFatalStatus();
1649 $batch = new LocalFileRestoreBatch( $this, $unsuppress );
1651 $this->lock(); // begin
1655 $batch->addIds( $versions );
1657 $status = $batch->execute();
1658 if ( $status->isGood() ) {
1659 $cleanupStatus = $batch->cleanup();
1660 $cleanupStatus->successCount
= 0;
1661 $cleanupStatus->failCount
= 0;
1662 $status->merge( $cleanupStatus );
1664 $this->unlock(); // done
1669 /** isMultipage inherited */
1670 /** pageCount inherited */
1671 /** scaleHeight inherited */
1672 /** getImageSize inherited */
1675 * Get the URL of the file description page.
1678 function getDescriptionUrl() {
1679 return $this->title
->getLocalURL();
1683 * Get the HTML text of the description page
1684 * This is not used by ImagePage for local files, since (among other things)
1685 * it skips the parser cache.
1687 * @param $lang Language What language to get description in (Optional)
1688 * @return bool|mixed
1690 function getDescriptionText( $lang = null ) {
1691 $revision = Revision
::newFromTitle( $this->title
, false, Revision
::READ_NORMAL
);
1695 $content = $revision->getContent();
1699 $pout = $content->getParserOutput( $this->title
, null, new ParserOptions( null, $lang ) );
1700 return $pout->getText();
1706 function getDescription( $audience = self
::FOR_PUBLIC
, User
$user = null ) {
1708 if ( $audience == self
::FOR_PUBLIC
&& $this->isDeleted( self
::DELETED_COMMENT
) ) {
1710 } elseif ( $audience == self
::FOR_THIS_USER
1711 && !$this->userCan( self
::DELETED_COMMENT
, $user ) )
1715 return $this->description
;
1720 * @return bool|string
1722 function getTimestamp() {
1724 return $this->timestamp
;
1730 function getSha1() {
1732 // Initialise now if necessary
1733 if ( $this->sha1
== '' && $this->fileExists
) {
1734 $this->lock(); // begin
1736 $this->sha1
= $this->repo
->getFileSha1( $this->getPath() );
1737 if ( !wfReadOnly() && strval( $this->sha1
) != '' ) {
1738 $dbw = $this->repo
->getMasterDB();
1739 $dbw->update( 'image',
1740 array( 'img_sha1' => $this->sha1
),
1741 array( 'img_name' => $this->getName() ),
1743 $this->saveToCache();
1746 $this->unlock(); // done
1753 * @return bool Whether to cache in RepoGroup (this avoids OOMs)
1755 function isCacheable() {
1757 // If extra data (metadata) was not loaded then it must have been large
1758 return $this->extraDataLoaded
1759 && strlen( serialize( $this->metadata
) ) <= self
::CACHE_FIELD_MAX_LEN
;
1763 * Start a transaction and lock the image for update
1764 * Increments a reference counter if the lock is already held
1765 * @return boolean True if the image exists, false otherwise
1768 $dbw = $this->repo
->getMasterDB();
1770 if ( !$this->locked
) {
1771 if ( !$dbw->trxLevel() ) {
1772 $dbw->begin( __METHOD__
);
1773 $this->lockedOwnTrx
= true;
1776 // Bug 54736: use simple lock to handle when the file does not exist.
1777 // SELECT FOR UPDATE only locks records not the gaps where there are none.
1778 $cache = wfGetMainCache();
1779 $key = $this->getCacheKey();
1780 if ( !$cache->lock( $key, 60 ) ) {
1781 throw new MWException( "Could not acquire lock for '{$this->getName()}.'" );
1783 $dbw->onTransactionIdle( function() use ( $cache, $key ) {
1784 $cache->unlock( $key ); // release on commit
1788 return $dbw->selectField( 'image', '1',
1789 array( 'img_name' => $this->getName() ), __METHOD__
, array( 'FOR UPDATE' ) );
1793 * Decrement the lock reference count. If the reference count is reduced to zero, commits
1794 * the transaction and thereby releases the image lock.
1797 if ( $this->locked
) {
1799 if ( !$this->locked
&& $this->lockedOwnTrx
) {
1800 $dbw = $this->repo
->getMasterDB();
1801 $dbw->commit( __METHOD__
);
1802 $this->lockedOwnTrx
= false;
1808 * Roll back the DB transaction and mark the image unlocked
1810 function unlockAndRollback() {
1811 $this->locked
= false;
1812 $dbw = $this->repo
->getMasterDB();
1813 $dbw->rollback( __METHOD__
);
1814 $this->lockedOwnTrx
= false;
1820 protected function readOnlyFatalStatus() {
1821 return $this->getRepo()->newFatal( 'filereadonlyerror', $this->getName(),
1822 $this->getRepo()->getName(), $this->getRepo()->getReadOnlyReason() );
1824 } // LocalFile class
1826 # ------------------------------------------------------------------------------
1829 * Helper class for file deletion
1830 * @ingroup FileAbstraction
1832 class LocalFileDeleteBatch
{
1839 var $reason, $srcRels = array(), $archiveUrls = array(), $deletionBatch, $suppress;
1844 * @param $reason string
1845 * @param $suppress bool
1847 function __construct( File
$file, $reason = '', $suppress = false ) {
1848 $this->file
= $file;
1849 $this->reason
= $reason;
1850 $this->suppress
= $suppress;
1851 $this->status
= $file->repo
->newGood();
1854 function addCurrent() {
1855 $this->srcRels
['.'] = $this->file
->getRel();
1859 * @param $oldName string
1861 function addOld( $oldName ) {
1862 $this->srcRels
[$oldName] = $this->file
->getArchiveRel( $oldName );
1863 $this->archiveUrls
[] = $this->file
->getArchiveUrl( $oldName );
1867 * Add the old versions of the image to the batch
1868 * @return Array List of archive names from old versions
1870 function addOlds() {
1871 $archiveNames = array();
1873 $dbw = $this->file
->repo
->getMasterDB();
1874 $result = $dbw->select( 'oldimage',
1875 array( 'oi_archive_name' ),
1876 array( 'oi_name' => $this->file
->getName() ),
1880 foreach ( $result as $row ) {
1881 $this->addOld( $row->oi_archive_name
);
1882 $archiveNames[] = $row->oi_archive_name
;
1885 return $archiveNames;
1891 function getOldRels() {
1892 if ( !isset( $this->srcRels
['.'] ) ) {
1893 $oldRels =& $this->srcRels
;
1894 $deleteCurrent = false;
1896 $oldRels = $this->srcRels
;
1897 unset( $oldRels['.'] );
1898 $deleteCurrent = true;
1901 return array( $oldRels, $deleteCurrent );
1907 protected function getHashes() {
1909 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
1911 if ( $deleteCurrent ) {
1912 $hashes['.'] = $this->file
->getSha1();
1915 if ( count( $oldRels ) ) {
1916 $dbw = $this->file
->repo
->getMasterDB();
1917 $res = $dbw->select(
1919 array( 'oi_archive_name', 'oi_sha1' ),
1920 'oi_archive_name IN (' . $dbw->makeList( array_keys( $oldRels ) ) . ')',
1924 foreach ( $res as $row ) {
1925 if ( rtrim( $row->oi_sha1
, "\0" ) === '' ) {
1926 // Get the hash from the file
1927 $oldUrl = $this->file
->getArchiveVirtualUrl( $row->oi_archive_name
);
1928 $props = $this->file
->repo
->getFileProps( $oldUrl );
1930 if ( $props['fileExists'] ) {
1931 // Upgrade the oldimage row
1932 $dbw->update( 'oldimage',
1933 array( 'oi_sha1' => $props['sha1'] ),
1934 array( 'oi_name' => $this->file
->getName(), 'oi_archive_name' => $row->oi_archive_name
),
1936 $hashes[$row->oi_archive_name
] = $props['sha1'];
1938 $hashes[$row->oi_archive_name
] = false;
1941 $hashes[$row->oi_archive_name
] = $row->oi_sha1
;
1946 $missing = array_diff_key( $this->srcRels
, $hashes );
1948 foreach ( $missing as $name => $rel ) {
1949 $this->status
->error( 'filedelete-old-unregistered', $name );
1952 foreach ( $hashes as $name => $hash ) {
1954 $this->status
->error( 'filedelete-missing', $this->srcRels
[$name] );
1955 unset( $hashes[$name] );
1962 function doDBInserts() {
1965 $dbw = $this->file
->repo
->getMasterDB();
1966 $encTimestamp = $dbw->addQuotes( $dbw->timestamp() );
1967 $encUserId = $dbw->addQuotes( $wgUser->getId() );
1968 $encReason = $dbw->addQuotes( $this->reason
);
1969 $encGroup = $dbw->addQuotes( 'deleted' );
1970 $ext = $this->file
->getExtension();
1971 $dotExt = $ext === '' ?
'' : ".$ext";
1972 $encExt = $dbw->addQuotes( $dotExt );
1973 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
1975 // Bitfields to further suppress the content
1976 if ( $this->suppress
) {
1978 // This should be 15...
1979 $bitfield |
= Revision
::DELETED_TEXT
;
1980 $bitfield |
= Revision
::DELETED_COMMENT
;
1981 $bitfield |
= Revision
::DELETED_USER
;
1982 $bitfield |
= Revision
::DELETED_RESTRICTED
;
1984 $bitfield = 'oi_deleted';
1987 if ( $deleteCurrent ) {
1988 $concat = $dbw->buildConcat( array( "img_sha1", $encExt ) );
1989 $where = array( 'img_name' => $this->file
->getName() );
1990 $dbw->insertSelect( 'filearchive', 'image',
1992 'fa_storage_group' => $encGroup,
1993 'fa_storage_key' => "CASE WHEN img_sha1='' THEN '' ELSE $concat END",
1994 'fa_deleted_user' => $encUserId,
1995 'fa_deleted_timestamp' => $encTimestamp,
1996 'fa_deleted_reason' => $encReason,
1997 'fa_deleted' => $this->suppress ?
$bitfield : 0,
1999 'fa_name' => 'img_name',
2000 'fa_archive_name' => 'NULL',
2001 'fa_size' => 'img_size',
2002 'fa_width' => 'img_width',
2003 'fa_height' => 'img_height',
2004 'fa_metadata' => 'img_metadata',
2005 'fa_bits' => 'img_bits',
2006 'fa_media_type' => 'img_media_type',
2007 'fa_major_mime' => 'img_major_mime',
2008 'fa_minor_mime' => 'img_minor_mime',
2009 'fa_description' => 'img_description',
2010 'fa_user' => 'img_user',
2011 'fa_user_text' => 'img_user_text',
2012 'fa_timestamp' => 'img_timestamp',
2013 'fa_sha1' => 'img_sha1',
2014 ), $where, __METHOD__
);
2017 if ( count( $oldRels ) ) {
2018 $concat = $dbw->buildConcat( array( "oi_sha1", $encExt ) );
2020 'oi_name' => $this->file
->getName(),
2021 'oi_archive_name IN (' . $dbw->makeList( array_keys( $oldRels ) ) . ')' );
2022 $dbw->insertSelect( 'filearchive', 'oldimage',
2024 'fa_storage_group' => $encGroup,
2025 'fa_storage_key' => "CASE WHEN oi_sha1='' THEN '' ELSE $concat END",
2026 'fa_deleted_user' => $encUserId,
2027 'fa_deleted_timestamp' => $encTimestamp,
2028 'fa_deleted_reason' => $encReason,
2029 'fa_deleted' => $this->suppress ?
$bitfield : 'oi_deleted',
2031 'fa_name' => 'oi_name',
2032 'fa_archive_name' => 'oi_archive_name',
2033 'fa_size' => 'oi_size',
2034 'fa_width' => 'oi_width',
2035 'fa_height' => 'oi_height',
2036 'fa_metadata' => 'oi_metadata',
2037 'fa_bits' => 'oi_bits',
2038 'fa_media_type' => 'oi_media_type',
2039 'fa_major_mime' => 'oi_major_mime',
2040 'fa_minor_mime' => 'oi_minor_mime',
2041 'fa_description' => 'oi_description',
2042 'fa_user' => 'oi_user',
2043 'fa_user_text' => 'oi_user_text',
2044 'fa_timestamp' => 'oi_timestamp',
2045 'fa_sha1' => 'oi_sha1',
2046 ), $where, __METHOD__
);
2050 function doDBDeletes() {
2051 $dbw = $this->file
->repo
->getMasterDB();
2052 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
2054 if ( count( $oldRels ) ) {
2055 $dbw->delete( 'oldimage',
2057 'oi_name' => $this->file
->getName(),
2058 'oi_archive_name' => array_keys( $oldRels )
2062 if ( $deleteCurrent ) {
2063 $dbw->delete( 'image', array( 'img_name' => $this->file
->getName() ), __METHOD__
);
2068 * Run the transaction
2069 * @return FileRepoStatus
2071 function execute() {
2072 wfProfileIn( __METHOD__
);
2074 $this->file
->lock();
2075 // Leave private files alone
2076 $privateFiles = array();
2077 list( $oldRels, ) = $this->getOldRels();
2078 $dbw = $this->file
->repo
->getMasterDB();
2080 if ( !empty( $oldRels ) ) {
2081 $res = $dbw->select( 'oldimage',
2082 array( 'oi_archive_name' ),
2083 array( 'oi_name' => $this->file
->getName(),
2084 'oi_archive_name IN (' . $dbw->makeList( array_keys( $oldRels ) ) . ')',
2085 $dbw->bitAnd( 'oi_deleted', File
::DELETED_FILE
) => File
::DELETED_FILE
),
2088 foreach ( $res as $row ) {
2089 $privateFiles[$row->oi_archive_name
] = 1;
2092 // Prepare deletion batch
2093 $hashes = $this->getHashes();
2094 $this->deletionBatch
= array();
2095 $ext = $this->file
->getExtension();
2096 $dotExt = $ext === '' ?
'' : ".$ext";
2098 foreach ( $this->srcRels
as $name => $srcRel ) {
2099 // Skip files that have no hash (missing source).
2100 // Keep private files where they are.
2101 if ( isset( $hashes[$name] ) && !array_key_exists( $name, $privateFiles ) ) {
2102 $hash = $hashes[$name];
2103 $key = $hash . $dotExt;
2104 $dstRel = $this->file
->repo
->getDeletedHashPath( $key ) . $key;
2105 $this->deletionBatch
[$name] = array( $srcRel, $dstRel );
2109 // Lock the filearchive rows so that the files don't get deleted by a cleanup operation
2110 // We acquire this lock by running the inserts now, before the file operations.
2112 // This potentially has poor lock contention characteristics -- an alternative
2113 // scheme would be to insert stub filearchive entries with no fa_name and commit
2114 // them in a separate transaction, then run the file ops, then update the fa_name fields.
2115 $this->doDBInserts();
2117 // Removes non-existent file from the batch, so we don't get errors.
2118 $this->deletionBatch
= $this->removeNonexistentFiles( $this->deletionBatch
);
2120 // Execute the file deletion batch
2121 $status = $this->file
->repo
->deleteBatch( $this->deletionBatch
);
2123 if ( !$status->isGood() ) {
2124 $this->status
->merge( $status );
2127 if ( !$this->status
->isOK() ) {
2128 // Critical file deletion error
2129 // Roll back inserts, release lock and abort
2130 // TODO: delete the defunct filearchive rows if we are using a non-transactional DB
2131 $this->file
->unlockAndRollback();
2132 wfProfileOut( __METHOD__
);
2133 return $this->status
;
2136 // Delete image/oldimage rows
2137 $this->doDBDeletes();
2139 // Commit and return
2140 $this->file
->unlock();
2141 wfProfileOut( __METHOD__
);
2143 return $this->status
;
2147 * Removes non-existent files from a deletion batch.
2148 * @param $batch array
2151 function removeNonexistentFiles( $batch ) {
2152 $files = $newBatch = array();
2154 foreach ( $batch as $batchItem ) {
2155 list( $src, ) = $batchItem;
2156 $files[$src] = $this->file
->repo
->getVirtualUrl( 'public' ) . '/' . rawurlencode( $src );
2159 $result = $this->file
->repo
->fileExistsBatch( $files );
2161 foreach ( $batch as $batchItem ) {
2162 if ( $result[$batchItem[0]] ) {
2163 $newBatch[] = $batchItem;
2171 # ------------------------------------------------------------------------------
2174 * Helper class for file undeletion
2175 * @ingroup FileAbstraction
2177 class LocalFileRestoreBatch
{
2183 var $cleanupBatch, $ids, $all, $unsuppress = false;
2187 * @param $unsuppress bool
2189 function __construct( File
$file, $unsuppress = false ) {
2190 $this->file
= $file;
2191 $this->cleanupBatch
= $this->ids
= array();
2192 $this->ids
= array();
2193 $this->unsuppress
= $unsuppress;
2199 function addId( $fa_id ) {
2200 $this->ids
[] = $fa_id;
2204 * Add a whole lot of files by ID
2206 function addIds( $ids ) {
2207 $this->ids
= array_merge( $this->ids
, $ids );
2211 * Add all revisions of the file
2218 * Run the transaction, except the cleanup batch.
2219 * The cleanup batch should be run in a separate transaction, because it locks different
2220 * rows and there's no need to keep the image row locked while it's acquiring those locks
2221 * The caller may have its own transaction open.
2222 * So we save the batch and let the caller call cleanup()
2223 * @return FileRepoStatus
2225 function execute() {
2228 if ( !$this->all
&& !$this->ids
) {
2230 return $this->file
->repo
->newGood();
2233 $exists = $this->file
->lock();
2234 $dbw = $this->file
->repo
->getMasterDB();
2235 $status = $this->file
->repo
->newGood();
2237 // Fetch all or selected archived revisions for the file,
2238 // sorted from the most recent to the oldest.
2239 $conditions = array( 'fa_name' => $this->file
->getName() );
2241 if ( !$this->all
) {
2242 $conditions[] = 'fa_id IN (' . $dbw->makeList( $this->ids
) . ')';
2245 $result = $dbw->select(
2247 ArchivedFile
::selectFields(),
2250 array( 'ORDER BY' => 'fa_timestamp DESC' )
2253 $idsPresent = array();
2254 $storeBatch = array();
2255 $insertBatch = array();
2256 $insertCurrent = false;
2257 $deleteIds = array();
2259 $archiveNames = array();
2261 foreach ( $result as $row ) {
2262 $idsPresent[] = $row->fa_id
;
2264 if ( $row->fa_name
!= $this->file
->getName() ) {
2265 $status->error( 'undelete-filename-mismatch', $wgLang->timeanddate( $row->fa_timestamp
) );
2266 $status->failCount++
;
2270 if ( $row->fa_storage_key
== '' ) {
2271 // Revision was missing pre-deletion
2272 $status->error( 'undelete-bad-store-key', $wgLang->timeanddate( $row->fa_timestamp
) );
2273 $status->failCount++
;
2277 $deletedRel = $this->file
->repo
->getDeletedHashPath( $row->fa_storage_key
) . $row->fa_storage_key
;
2278 $deletedUrl = $this->file
->repo
->getVirtualUrl() . '/deleted/' . $deletedRel;
2280 if ( isset( $row->fa_sha1
) ) {
2281 $sha1 = $row->fa_sha1
;
2283 // old row, populate from key
2284 $sha1 = LocalRepo
::getHashFromKey( $row->fa_storage_key
);
2288 if ( strlen( $sha1 ) == 32 && $sha1[0] == '0' ) {
2289 $sha1 = substr( $sha1, 1 );
2292 if ( is_null( $row->fa_major_mime
) ||
$row->fa_major_mime
== 'unknown'
2293 ||
is_null( $row->fa_minor_mime
) ||
$row->fa_minor_mime
== 'unknown'
2294 ||
is_null( $row->fa_media_type
) ||
$row->fa_media_type
== 'UNKNOWN'
2295 ||
is_null( $row->fa_metadata
) ) {
2296 // Refresh our metadata
2297 // Required for a new current revision; nice for older ones too. :)
2298 $props = RepoGroup
::singleton()->getFileProps( $deletedUrl );
2301 'minor_mime' => $row->fa_minor_mime
,
2302 'major_mime' => $row->fa_major_mime
,
2303 'media_type' => $row->fa_media_type
,
2304 'metadata' => $row->fa_metadata
2308 if ( $first && !$exists ) {
2309 // This revision will be published as the new current version
2310 $destRel = $this->file
->getRel();
2311 $insertCurrent = array(
2312 'img_name' => $row->fa_name
,
2313 'img_size' => $row->fa_size
,
2314 'img_width' => $row->fa_width
,
2315 'img_height' => $row->fa_height
,
2316 'img_metadata' => $props['metadata'],
2317 'img_bits' => $row->fa_bits
,
2318 'img_media_type' => $props['media_type'],
2319 'img_major_mime' => $props['major_mime'],
2320 'img_minor_mime' => $props['minor_mime'],
2321 'img_description' => $row->fa_description
,
2322 'img_user' => $row->fa_user
,
2323 'img_user_text' => $row->fa_user_text
,
2324 'img_timestamp' => $row->fa_timestamp
,
2328 // The live (current) version cannot be hidden!
2329 if ( !$this->unsuppress
&& $row->fa_deleted
) {
2330 $storeBatch[] = array( $deletedUrl, 'public', $destRel );
2331 $this->cleanupBatch
[] = $row->fa_storage_key
;
2334 $archiveName = $row->fa_archive_name
;
2336 if ( $archiveName == '' ) {
2337 // This was originally a current version; we
2338 // have to devise a new archive name for it.
2339 // Format is <timestamp of archiving>!<name>
2340 $timestamp = wfTimestamp( TS_UNIX
, $row->fa_deleted_timestamp
);
2343 $archiveName = wfTimestamp( TS_MW
, $timestamp ) . '!' . $row->fa_name
;
2345 } while ( isset( $archiveNames[$archiveName] ) );
2348 $archiveNames[$archiveName] = true;
2349 $destRel = $this->file
->getArchiveRel( $archiveName );
2350 $insertBatch[] = array(
2351 'oi_name' => $row->fa_name
,
2352 'oi_archive_name' => $archiveName,
2353 'oi_size' => $row->fa_size
,
2354 'oi_width' => $row->fa_width
,
2355 'oi_height' => $row->fa_height
,
2356 'oi_bits' => $row->fa_bits
,
2357 'oi_description' => $row->fa_description
,
2358 'oi_user' => $row->fa_user
,
2359 'oi_user_text' => $row->fa_user_text
,
2360 'oi_timestamp' => $row->fa_timestamp
,
2361 'oi_metadata' => $props['metadata'],
2362 'oi_media_type' => $props['media_type'],
2363 'oi_major_mime' => $props['major_mime'],
2364 'oi_minor_mime' => $props['minor_mime'],
2365 'oi_deleted' => $this->unsuppress ?
0 : $row->fa_deleted
,
2366 'oi_sha1' => $sha1 );
2369 $deleteIds[] = $row->fa_id
;
2371 if ( !$this->unsuppress
&& $row->fa_deleted
& File
::DELETED_FILE
) {
2372 // private files can stay where they are
2373 $status->successCount++
;
2375 $storeBatch[] = array( $deletedUrl, 'public', $destRel );
2376 $this->cleanupBatch
[] = $row->fa_storage_key
;
2384 // Add a warning to the status object for missing IDs
2385 $missingIds = array_diff( $this->ids
, $idsPresent );
2387 foreach ( $missingIds as $id ) {
2388 $status->error( 'undelete-missing-filearchive', $id );
2391 // Remove missing files from batch, so we don't get errors when undeleting them
2392 $storeBatch = $this->removeNonexistentFiles( $storeBatch );
2394 // Run the store batch
2395 // Use the OVERWRITE_SAME flag to smooth over a common error
2396 $storeStatus = $this->file
->repo
->storeBatch( $storeBatch, FileRepo
::OVERWRITE_SAME
);
2397 $status->merge( $storeStatus );
2399 if ( !$status->isGood() ) {
2400 // Even if some files could be copied, fail entirely as that is the
2401 // easiest thing to do without data loss
2402 $this->cleanupFailedBatch( $storeStatus, $storeBatch );
2403 $status->ok
= false;
2404 $this->file
->unlock();
2409 // Run the DB updates
2410 // Because we have locked the image row, key conflicts should be rare.
2411 // If they do occur, we can roll back the transaction at this time with
2412 // no data loss, but leaving unregistered files scattered throughout the
2414 // This is not ideal, which is why it's important to lock the image row.
2415 if ( $insertCurrent ) {
2416 $dbw->insert( 'image', $insertCurrent, __METHOD__
);
2419 if ( $insertBatch ) {
2420 $dbw->insert( 'oldimage', $insertBatch, __METHOD__
);
2424 $dbw->delete( 'filearchive',
2425 array( 'fa_id IN (' . $dbw->makeList( $deleteIds ) . ')' ),
2429 // If store batch is empty (all files are missing), deletion is to be considered successful
2430 if ( $status->successCount
> 0 ||
!$storeBatch ) {
2432 wfDebug( __METHOD__
. " restored {$status->successCount} items, creating a new current\n" );
2434 DeferredUpdates
::addUpdate( SiteStatsUpdate
::factory( array( 'images' => 1 ) ) );
2436 $this->file
->purgeEverything();
2438 wfDebug( __METHOD__
. " restored {$status->successCount} as archived versions\n" );
2439 $this->file
->purgeDescription();
2440 $this->file
->purgeHistory();
2444 $this->file
->unlock();
2450 * Removes non-existent files from a store batch.
2451 * @param $triplets array
2454 function removeNonexistentFiles( $triplets ) {
2455 $files = $filteredTriplets = array();
2456 foreach ( $triplets as $file ) {
2457 $files[$file[0]] = $file[0];
2460 $result = $this->file
->repo
->fileExistsBatch( $files );
2462 foreach ( $triplets as $file ) {
2463 if ( $result[$file[0]] ) {
2464 $filteredTriplets[] = $file;
2468 return $filteredTriplets;
2472 * Removes non-existent files from a cleanup batch.
2473 * @param $batch array
2476 function removeNonexistentFromCleanup( $batch ) {
2477 $files = $newBatch = array();
2478 $repo = $this->file
->repo
;
2480 foreach ( $batch as $file ) {
2481 $files[$file] = $repo->getVirtualUrl( 'deleted' ) . '/' .
2482 rawurlencode( $repo->getDeletedHashPath( $file ) . $file );
2485 $result = $repo->fileExistsBatch( $files );
2487 foreach ( $batch as $file ) {
2488 if ( $result[$file] ) {
2489 $newBatch[] = $file;
2497 * Delete unused files in the deleted zone.
2498 * This should be called from outside the transaction in which execute() was called.
2499 * @return FileRepoStatus
2501 function cleanup() {
2502 if ( !$this->cleanupBatch
) {
2503 return $this->file
->repo
->newGood();
2506 $this->cleanupBatch
= $this->removeNonexistentFromCleanup( $this->cleanupBatch
);
2508 $status = $this->file
->repo
->cleanupDeletedBatch( $this->cleanupBatch
);
2514 * Cleanup a failed batch. The batch was only partially successful, so
2515 * rollback by removing all items that were succesfully copied.
2517 * @param Status $storeStatus
2518 * @param array $storeBatch
2520 function cleanupFailedBatch( $storeStatus, $storeBatch ) {
2521 $cleanupBatch = array();
2523 foreach ( $storeStatus->success
as $i => $success ) {
2524 // Check if this item of the batch was successfully copied
2526 // Item was successfully copied and needs to be removed again
2527 // Extract ($dstZone, $dstRel) from the batch
2528 $cleanupBatch[] = array( $storeBatch[$i][1], $storeBatch[$i][2] );
2531 $this->file
->repo
->cleanupBatch( $cleanupBatch );
2535 # ------------------------------------------------------------------------------
2538 * Helper class for file movement
2539 * @ingroup FileAbstraction
2541 class LocalFileMoveBatch
{
2553 var $cur, $olds, $oldCount, $archive;
2562 * @param Title $target
2564 function __construct( File
$file, Title
$target ) {
2565 $this->file
= $file;
2566 $this->target
= $target;
2567 $this->oldHash
= $this->file
->repo
->getHashPath( $this->file
->getName() );
2568 $this->newHash
= $this->file
->repo
->getHashPath( $this->target
->getDBkey() );
2569 $this->oldName
= $this->file
->getName();
2570 $this->newName
= $this->file
->repo
->getNameFromTitle( $this->target
);
2571 $this->oldRel
= $this->oldHash
. $this->oldName
;
2572 $this->newRel
= $this->newHash
. $this->newName
;
2573 $this->db
= $file->getRepo()->getMasterDb();
2577 * Add the current image to the batch
2579 function addCurrent() {
2580 $this->cur
= array( $this->oldRel
, $this->newRel
);
2584 * Add the old versions of the image to the batch
2585 * @return Array List of archive names from old versions
2587 function addOlds() {
2588 $archiveBase = 'archive';
2589 $this->olds
= array();
2590 $this->oldCount
= 0;
2591 $archiveNames = array();
2593 $result = $this->db
->select( 'oldimage',
2594 array( 'oi_archive_name', 'oi_deleted' ),
2595 array( 'oi_name' => $this->oldName
),
2599 foreach ( $result as $row ) {
2600 $archiveNames[] = $row->oi_archive_name
;
2601 $oldName = $row->oi_archive_name
;
2602 $bits = explode( '!', $oldName, 2 );
2604 if ( count( $bits ) != 2 ) {
2605 wfDebug( "Old file name missing !: '$oldName' \n" );
2609 list( $timestamp, $filename ) = $bits;
2611 if ( $this->oldName
!= $filename ) {
2612 wfDebug( "Old file name doesn't match: '$oldName' \n" );
2618 // Do we want to add those to oldCount?
2619 if ( $row->oi_deleted
& File
::DELETED_FILE
) {
2623 $this->olds
[] = array(
2624 "{$archiveBase}/{$this->oldHash}{$oldName}",
2625 "{$archiveBase}/{$this->newHash}{$timestamp}!{$this->newName}"
2629 return $archiveNames;
2634 * @return FileRepoStatus
2636 function execute() {
2637 $repo = $this->file
->repo
;
2638 $status = $repo->newGood();
2640 $triplets = $this->getMoveTriplets();
2641 $triplets = $this->removeNonexistentFiles( $triplets );
2643 $this->file
->lock(); // begin
2644 // Rename the file versions metadata in the DB.
2645 // This implicitly locks the destination file, which avoids race conditions.
2646 // If we moved the files from A -> C before DB updates, another process could
2647 // move files from B -> C at this point, causing storeBatch() to fail and thus
2648 // cleanupTarget() to trigger. It would delete the C files and cause data loss.
2649 $statusDb = $this->doDBUpdates();
2650 if ( !$statusDb->isGood() ) {
2651 $this->file
->unlockAndRollback();
2652 $statusDb->ok
= false;
2655 wfDebugLog( 'imagemove', "Renamed {$this->file->getName()} in database: {$statusDb->successCount} successes, {$statusDb->failCount} failures" );
2657 // Copy the files into their new location.
2658 // If a prior process fataled copying or cleaning up files we tolerate any
2659 // of the existing files if they are identical to the ones being stored.
2660 $statusMove = $repo->storeBatch( $triplets, FileRepo
::OVERWRITE_SAME
);
2661 wfDebugLog( 'imagemove', "Moved files for {$this->file->getName()}: {$statusMove->successCount} successes, {$statusMove->failCount} failures" );
2662 if ( !$statusMove->isGood() ) {
2663 // Delete any files copied over (while the destination is still locked)
2664 $this->cleanupTarget( $triplets );
2665 $this->file
->unlockAndRollback(); // unlocks the destination
2666 wfDebugLog( 'imagemove', "Error in moving files: " . $statusMove->getWikiText() );
2667 $statusMove->ok
= false;
2670 $this->file
->unlock(); // done
2672 // Everything went ok, remove the source files
2673 $this->cleanupSource( $triplets );
2675 $status->merge( $statusDb );
2676 $status->merge( $statusMove );
2682 * Do the database updates and return a new FileRepoStatus indicating how
2683 * many rows where updated.
2685 * @return FileRepoStatus
2687 function doDBUpdates() {
2688 $repo = $this->file
->repo
;
2689 $status = $repo->newGood();
2692 // Update current image
2695 array( 'img_name' => $this->newName
),
2696 array( 'img_name' => $this->oldName
),
2700 if ( $dbw->affectedRows() ) {
2701 $status->successCount++
;
2703 $status->failCount++
;
2704 $status->fatal( 'imageinvalidfilename' );
2708 // Update old images
2712 'oi_name' => $this->newName
,
2713 'oi_archive_name = ' . $dbw->strreplace( 'oi_archive_name',
2714 $dbw->addQuotes( $this->oldName
), $dbw->addQuotes( $this->newName
) ),
2716 array( 'oi_name' => $this->oldName
),
2720 $affected = $dbw->affectedRows();
2721 $total = $this->oldCount
;
2722 $status->successCount +
= $affected;
2723 // Bug 34934: $total is based on files that actually exist.
2724 // There may be more DB rows than such files, in which case $affected
2725 // can be greater than $total. We use max() to avoid negatives here.
2726 $status->failCount +
= max( 0, $total - $affected );
2727 if ( $status->failCount
) {
2728 $status->error( 'imageinvalidfilename' );
2735 * Generate triplets for FileRepo::storeBatch().
2738 function getMoveTriplets() {
2739 $moves = array_merge( array( $this->cur
), $this->olds
);
2740 $triplets = array(); // The format is: (srcUrl, destZone, destUrl)
2742 foreach ( $moves as $move ) {
2743 // $move: (oldRelativePath, newRelativePath)
2744 $srcUrl = $this->file
->repo
->getVirtualUrl() . '/public/' . rawurlencode( $move[0] );
2745 $triplets[] = array( $srcUrl, 'public', $move[1] );
2746 wfDebugLog( 'imagemove', "Generated move triplet for {$this->file->getName()}: {$srcUrl} :: public :: {$move[1]}" );
2753 * Removes non-existent files from move batch.
2754 * @param $triplets array
2757 function removeNonexistentFiles( $triplets ) {
2760 foreach ( $triplets as $file ) {
2761 $files[$file[0]] = $file[0];
2764 $result = $this->file
->repo
->fileExistsBatch( $files );
2765 $filteredTriplets = array();
2767 foreach ( $triplets as $file ) {
2768 if ( $result[$file[0]] ) {
2769 $filteredTriplets[] = $file;
2771 wfDebugLog( 'imagemove', "File {$file[0]} does not exist" );
2775 return $filteredTriplets;
2779 * Cleanup a partially moved array of triplets by deleting the target
2780 * files. Called if something went wrong half way.
2782 function cleanupTarget( $triplets ) {
2783 // Create dest pairs from the triplets
2785 foreach ( $triplets as $triplet ) {
2786 // $triplet: (old source virtual URL, dst zone, dest rel)
2787 $pairs[] = array( $triplet[1], $triplet[2] );
2790 $this->file
->repo
->cleanupBatch( $pairs );
2794 * Cleanup a fully moved array of triplets by deleting the source files.
2795 * Called at the end of the move process if everything else went ok.
2797 function cleanupSource( $triplets ) {
2798 // Create source file names from the triplets
2800 foreach ( $triplets as $triplet ) {
2801 $files[] = $triplet[0];
2804 $this->file
->repo
->cleanupBatch( $files );