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' => $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 );
791 $iterator = $backend->getFileList( array( 'dir' => $dir ) );
792 foreach ( $iterator as $file ) {
800 * Refresh metadata in memcached, but don't touch thumbnails or squid
802 function purgeMetadataCache() {
804 $this->saveToCache();
805 $this->purgeHistory();
809 * Purge the shared history (OldLocalFile) cache.
811 * @note This used to purge old thumbnails as well.
813 function purgeHistory() {
816 $hashedName = md5( $this->getName() );
817 $oldKey = $this->repo
->getSharedCacheKey( 'oldfile', $hashedName );
820 $wgMemc->delete( $oldKey );
825 * Delete all previously generated thumbnails, refresh metadata in memcached and purge the squid.
827 * @param Array $options An array potentially with the key forThumbRefresh.
829 * @note This used to purge old thumbnails by default as well, but doesn't anymore.
831 function purgeCache( $options = array() ) {
832 wfProfileIn( __METHOD__
);
833 // Refresh metadata cache
834 $this->purgeMetadataCache();
837 $this->purgeThumbnails( $options );
839 // Purge squid cache for this file
840 SquidUpdate
::purge( array( $this->getURL() ) );
841 wfProfileOut( __METHOD__
);
845 * Delete cached transformed files for an archived version only.
846 * @param string $archiveName name of the archived file
848 function purgeOldThumbnails( $archiveName ) {
850 wfProfileIn( __METHOD__
);
852 // Get a list of old thumbnails and URLs
853 $files = $this->getThumbnails( $archiveName );
854 $dir = array_shift( $files );
855 $this->purgeThumbList( $dir, $files );
857 // Purge any custom thumbnail caches
858 wfRunHooks( 'LocalFilePurgeThumbnails', array( $this, $archiveName ) );
863 foreach ( $files as $file ) {
864 $urls[] = $this->getArchiveThumbUrl( $archiveName, $file );
866 SquidUpdate
::purge( $urls );
869 wfProfileOut( __METHOD__
);
873 * Delete cached transformed files for the current version only.
875 function purgeThumbnails( $options = array() ) {
877 wfProfileIn( __METHOD__
);
880 $files = $this->getThumbnails();
881 // Always purge all files from squid regardless of handler filters
884 foreach ( $files as $file ) {
885 $urls[] = $this->getThumbUrl( $file );
887 array_shift( $urls ); // don't purge directory
890 // Give media handler a chance to filter the file purge list
891 if ( !empty( $options['forThumbRefresh'] ) ) {
892 $handler = $this->getHandler();
894 $handler->filterThumbnailPurgeList( $files, $options );
898 $dir = array_shift( $files );
899 $this->purgeThumbList( $dir, $files );
901 // Purge any custom thumbnail caches
902 wfRunHooks( 'LocalFilePurgeThumbnails', array( $this, false ) );
906 SquidUpdate
::purge( $urls );
909 wfProfileOut( __METHOD__
);
913 * Delete a list of thumbnails visible at urls
914 * @param string $dir base dir of the files.
915 * @param array $files of strings: relative filenames (to $dir)
917 protected function purgeThumbList( $dir, $files ) {
918 $fileListDebug = strtr(
919 var_export( $files, true ),
922 wfDebug( __METHOD__
. ": $fileListDebug\n" );
924 $purgeList = array();
925 foreach ( $files as $file ) {
926 # Check that the base file name is part of the thumb name
927 # This is a basic sanity check to avoid erasing unrelated directories
928 if ( strpos( $file, $this->getName() ) !== false
929 ||
strpos( $file, "-thumbnail" ) !== false // "short" thumb name
931 $purgeList[] = "{$dir}/{$file}";
935 # Delete the thumbnails
936 $this->repo
->quickPurgeBatch( $purgeList );
937 # Clear out the thumbnail directory if empty
938 $this->repo
->quickCleanDir( $dir );
941 /** purgeDescription inherited */
942 /** purgeEverything inherited */
951 function getHistory( $limit = null, $start = null, $end = null, $inc = true ) {
952 $dbr = $this->repo
->getSlaveDB();
953 $tables = array( 'oldimage' );
954 $fields = OldLocalFile
::selectFields();
955 $conds = $opts = $join_conds = array();
956 $eq = $inc ?
'=' : '';
957 $conds[] = "oi_name = " . $dbr->addQuotes( $this->title
->getDBkey() );
960 $conds[] = "oi_timestamp <$eq " . $dbr->addQuotes( $dbr->timestamp( $start ) );
964 $conds[] = "oi_timestamp >$eq " . $dbr->addQuotes( $dbr->timestamp( $end ) );
968 $opts['LIMIT'] = $limit;
971 // Search backwards for time > x queries
972 $order = ( !$start && $end !== null ) ?
'ASC' : 'DESC';
973 $opts['ORDER BY'] = "oi_timestamp $order";
974 $opts['USE INDEX'] = array( 'oldimage' => 'oi_name_timestamp' );
976 wfRunHooks( 'LocalFile::getHistory', array( &$this, &$tables, &$fields,
977 &$conds, &$opts, &$join_conds ) );
979 $res = $dbr->select( $tables, $fields, $conds, __METHOD__
, $opts, $join_conds );
982 foreach ( $res as $row ) {
983 if ( $this->repo
->oldFileFromRowFactory
) {
984 $r[] = call_user_func( $this->repo
->oldFileFromRowFactory
, $row, $this->repo
);
986 $r[] = OldLocalFile
::newFromRow( $row, $this->repo
);
990 if ( $order == 'ASC' ) {
991 $r = array_reverse( $r ); // make sure it ends up descending
998 * Return the history of this file, line by line.
999 * starts with current version, then old versions.
1000 * uses $this->historyLine to check which line to return:
1001 * 0 return line for current version
1002 * 1 query for old versions, return first one
1003 * 2, ... return next old version from above query
1006 public function nextHistoryLine() {
1007 # Polymorphic function name to distinguish foreign and local fetches
1008 $fname = get_class( $this ) . '::' . __FUNCTION__
;
1010 $dbr = $this->repo
->getSlaveDB();
1012 if ( $this->historyLine
== 0 ) {// called for the first time, return line from cur
1013 $this->historyRes
= $dbr->select( 'image',
1016 "'' AS oi_archive_name",
1020 array( 'img_name' => $this->title
->getDBkey() ),
1024 if ( 0 == $dbr->numRows( $this->historyRes
) ) {
1025 $this->historyRes
= null;
1028 } elseif ( $this->historyLine
== 1 ) {
1029 $this->historyRes
= $dbr->select( 'oldimage', '*',
1030 array( 'oi_name' => $this->title
->getDBkey() ),
1032 array( 'ORDER BY' => 'oi_timestamp DESC' )
1035 $this->historyLine ++
;
1037 return $dbr->fetchObject( $this->historyRes
);
1041 * Reset the history pointer to the first element of the history
1043 public function resetHistory() {
1044 $this->historyLine
= 0;
1046 if ( !is_null( $this->historyRes
) ) {
1047 $this->historyRes
= null;
1051 /** getHashPath inherited */
1052 /** getRel inherited */
1053 /** getUrlRel inherited */
1054 /** getArchiveRel inherited */
1055 /** getArchivePath inherited */
1056 /** getThumbPath inherited */
1057 /** getArchiveUrl inherited */
1058 /** getThumbUrl inherited */
1059 /** getArchiveVirtualUrl inherited */
1060 /** getThumbVirtualUrl inherited */
1061 /** isHashed inherited */
1064 * Upload a file and record it in the DB
1065 * @param string $srcPath source storage path, virtual URL, or filesystem path
1066 * @param string $comment upload description
1067 * @param string $pageText text to use for the new description page,
1068 * if a new description page is created
1069 * @param $flags Integer|bool: flags for publish()
1070 * @param array|bool $props File properties, if known. This can be used to reduce the
1071 * upload time when uploading virtual URLs for which the file info
1073 * @param string|bool $timestamp timestamp for img_timestamp, or false to use the current time
1074 * @param $user User|null: User object or null to use $wgUser
1076 * @return FileRepoStatus object. On success, the value member contains the
1077 * archive name, or an empty string if it was a new file.
1079 function upload( $srcPath, $comment, $pageText, $flags = 0, $props = false, $timestamp = false, $user = null ) {
1082 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
1083 return $this->readOnlyFatalStatus();
1087 wfProfileIn( __METHOD__
. '-getProps' );
1088 if ( $this->repo
->isVirtualUrl( $srcPath )
1089 || FileBackend
::isStoragePath( $srcPath ) )
1091 $props = $this->repo
->getFileProps( $srcPath );
1093 $props = FSFile
::getPropsFromPath( $srcPath );
1095 wfProfileOut( __METHOD__
. '-getProps' );
1099 $handler = MediaHandler
::getHandler( $props['mime'] );
1101 $options['headers'] = $handler->getStreamHeaders( $props['metadata'] );
1103 $options['headers'] = array();
1106 // Trim spaces on user supplied text
1107 $comment = trim( $comment );
1109 // truncate nicely or the DB will do it for us
1110 // non-nicely (dangling multi-byte chars, non-truncated version in cache).
1111 $comment = $wgContLang->truncate( $comment, 255 );
1112 $this->lock(); // begin
1113 $status = $this->publish( $srcPath, $flags, $options );
1115 if ( $status->successCount
> 0 ) {
1116 # Essentially we are displacing any existing current file and saving
1117 # a new current file at the old location. If just the first succeeded,
1118 # we still need to displace the current DB entry and put in a new one.
1119 if ( !$this->recordUpload2( $status->value
, $comment, $pageText, $props, $timestamp, $user ) ) {
1120 $status->fatal( 'filenotfound', $srcPath );
1124 $this->unlock(); // done
1130 * Record a file upload in the upload log and the image table
1132 * @param $desc string
1133 * @param $license string
1134 * @param $copyStatus string
1135 * @param $source string
1136 * @param $watch bool
1137 * @param $timestamp string|bool
1138 * @param $user User object or null to use $wgUser
1141 function recordUpload( $oldver, $desc, $license = '', $copyStatus = '', $source = '',
1142 $watch = false, $timestamp = false, User
$user = null )
1149 $pageText = SpecialUpload
::getInitialPageText( $desc, $license, $copyStatus, $source );
1151 if ( !$this->recordUpload2( $oldver, $desc, $pageText, false, $timestamp, $user ) ) {
1156 $user->addWatch( $this->getTitle() );
1162 * Record a file upload in the upload log and the image table
1164 * @param $comment string
1165 * @param $pageText string
1166 * @param $props bool|array
1167 * @param $timestamp bool|string
1168 * @param $user null|User
1171 function recordUpload2(
1172 $oldver, $comment, $pageText, $props = false, $timestamp = false, $user = null
1174 wfProfileIn( __METHOD__
);
1176 if ( is_null( $user ) ) {
1181 $dbw = $this->repo
->getMasterDB();
1182 $dbw->begin( __METHOD__
);
1185 wfProfileIn( __METHOD__
. '-getProps' );
1186 $props = $this->repo
->getFileProps( $this->getVirtualUrl() );
1187 wfProfileOut( __METHOD__
. '-getProps' );
1190 if ( $timestamp === false ) {
1191 $timestamp = $dbw->timestamp();
1194 $props['description'] = $comment;
1195 $props['user'] = $user->getId();
1196 $props['user_text'] = $user->getName();
1197 $props['timestamp'] = wfTimestamp( TS_MW
, $timestamp ); // DB -> TS_MW
1198 $this->setProps( $props );
1200 # Fail now if the file isn't there
1201 if ( !$this->fileExists
) {
1202 wfDebug( __METHOD__
. ": File " . $this->getRel() . " went missing!\n" );
1203 wfProfileOut( __METHOD__
);
1209 # Test to see if the row exists using INSERT IGNORE
1210 # This avoids race conditions by locking the row until the commit, and also
1211 # doesn't deadlock. SELECT FOR UPDATE causes a deadlock for every race condition.
1212 $dbw->insert( 'image',
1214 'img_name' => $this->getName(),
1215 'img_size' => $this->size
,
1216 'img_width' => intval( $this->width
),
1217 'img_height' => intval( $this->height
),
1218 'img_bits' => $this->bits
,
1219 'img_media_type' => $this->media_type
,
1220 'img_major_mime' => $this->major_mime
,
1221 'img_minor_mime' => $this->minor_mime
,
1222 'img_timestamp' => $timestamp,
1223 'img_description' => $comment,
1224 'img_user' => $user->getId(),
1225 'img_user_text' => $user->getName(),
1226 'img_metadata' => $this->metadata
,
1227 'img_sha1' => $this->sha1
1232 if ( $dbw->affectedRows() == 0 ) {
1233 # (bug 34993) Note: $oldver can be empty here, if the previous
1234 # version of the file was broken. Allow registration of the new
1235 # version to continue anyway, because that's better than having
1236 # an image that's not fixable by user operations.
1239 # Collision, this is an update of a file
1240 # Insert previous contents into oldimage
1241 $dbw->insertSelect( 'oldimage', 'image',
1243 'oi_name' => 'img_name',
1244 'oi_archive_name' => $dbw->addQuotes( $oldver ),
1245 'oi_size' => 'img_size',
1246 'oi_width' => 'img_width',
1247 'oi_height' => 'img_height',
1248 'oi_bits' => 'img_bits',
1249 'oi_timestamp' => 'img_timestamp',
1250 'oi_description' => 'img_description',
1251 'oi_user' => 'img_user',
1252 'oi_user_text' => 'img_user_text',
1253 'oi_metadata' => 'img_metadata',
1254 'oi_media_type' => 'img_media_type',
1255 'oi_major_mime' => 'img_major_mime',
1256 'oi_minor_mime' => 'img_minor_mime',
1257 'oi_sha1' => 'img_sha1'
1259 array( 'img_name' => $this->getName() ),
1263 # Update the current image row
1264 $dbw->update( 'image',
1266 'img_size' => $this->size
,
1267 'img_width' => intval( $this->width
),
1268 'img_height' => intval( $this->height
),
1269 'img_bits' => $this->bits
,
1270 'img_media_type' => $this->media_type
,
1271 'img_major_mime' => $this->major_mime
,
1272 'img_minor_mime' => $this->minor_mime
,
1273 'img_timestamp' => $timestamp,
1274 'img_description' => $comment,
1275 'img_user' => $user->getId(),
1276 'img_user_text' => $user->getName(),
1277 'img_metadata' => $this->metadata
,
1278 'img_sha1' => $this->sha1
1280 array( 'img_name' => $this->getName() ),
1284 # This is a new file, so update the image count
1285 DeferredUpdates
::addUpdate( SiteStatsUpdate
::factory( array( 'images' => 1 ) ) );
1288 $descTitle = $this->getTitle();
1289 $wikiPage = new WikiFilePage( $descTitle );
1290 $wikiPage->setFile( $this );
1293 $action = $reupload ?
'overwrite' : 'upload';
1295 $logEntry = new ManualLogEntry( 'upload', $action );
1296 $logEntry->setPerformer( $user );
1297 $logEntry->setComment( $comment );
1298 $logEntry->setTarget( $descTitle );
1300 // Allow people using the api to associate log entries with the upload.
1301 // Log has a timestamp, but sometimes different from upload timestamp.
1302 $logEntry->setParameters(
1304 'img_sha1' => $this->sha1
,
1305 'img_timestamp' => $timestamp,
1308 // Note we keep $logId around since during new image
1309 // creation, page doesn't exist yet, so log_page = 0
1310 // but we want it to point to the page we're making,
1311 // so we later modify the log entry.
1312 // For a similar reason, we avoid making an RC entry
1313 // now and wait until the page exists.
1314 $logId = $logEntry->insert();
1316 $exists = $descTitle->exists();
1318 // Page exists, do RC entry now (otherwise we wait for later).
1319 $logEntry->publish( $logId );
1321 wfProfileIn( __METHOD__
. '-edit' );
1324 # Create a null revision
1325 $latest = $descTitle->getLatestRevID();
1326 $editSummary = LogFormatter
::newFromEntry( $logEntry )->getPlainActionText();
1328 $nullRevision = Revision
::newNullRevision(
1330 $descTitle->getArticleID(),
1334 if ( !is_null( $nullRevision ) ) {
1335 $nullRevision->insertOn( $dbw );
1337 wfRunHooks( 'NewRevisionFromEditComplete', array( $wikiPage, $nullRevision, $latest, $user ) );
1338 $wikiPage->updateRevisionOn( $dbw, $nullRevision );
1342 # Commit the transaction now, in case something goes wrong later
1343 # The most important thing is that files don't get lost, especially archives
1344 # NOTE: once we have support for nested transactions, the commit may be moved
1345 # to after $wikiPage->doEdit has been called.
1346 $dbw->commit( __METHOD__
);
1349 # Invalidate the cache for the description page
1350 $descTitle->invalidateCache();
1351 $descTitle->purgeSquid();
1353 # New file; create the description page.
1354 # There's already a log entry, so don't make a second RC entry
1355 # Squid and file cache for the description page are purged by doEditContent.
1356 $content = ContentHandler
::makeContent( $pageText, $descTitle );
1357 $status = $wikiPage->doEditContent( $content, $comment, EDIT_NEW | EDIT_SUPPRESS_RC
, false, $user );
1359 $dbw->begin( __METHOD__
); // XXX; doEdit() uses a transaction
1360 // Now that the page exists, make an RC entry.
1361 $logEntry->publish( $logId );
1362 if ( isset( $status->value
['revision'] ) ) {
1363 $dbw->update( 'logging',
1364 array( 'log_page' => $status->value
['revision']->getPage() ),
1365 array( 'log_id' => $logId ),
1369 $dbw->commit( __METHOD__
); // commit before anything bad can happen
1373 wfProfileOut( __METHOD__
. '-edit' );
1375 # Save to cache and purge the squid
1376 # We shall not saveToCache before the commit since otherwise
1377 # in case of a rollback there is an usable file from memcached
1378 # which in fact doesn't really exist (bug 24978)
1379 $this->saveToCache();
1382 # Delete old thumbnails
1383 wfProfileIn( __METHOD__
. '-purge' );
1384 $this->purgeThumbnails();
1385 wfProfileOut( __METHOD__
. '-purge' );
1387 # Remove the old file from the squid cache
1388 SquidUpdate
::purge( array( $this->getURL() ) );
1391 # Hooks, hooks, the magic of hooks...
1392 wfProfileIn( __METHOD__
. '-hooks' );
1393 wfRunHooks( 'FileUpload', array( $this, $reupload, $descTitle->exists() ) );
1394 wfProfileOut( __METHOD__
. '-hooks' );
1396 # Invalidate cache for all pages using this file
1397 $update = new HTMLCacheUpdate( $this->getTitle(), 'imagelinks' );
1398 $update->doUpdate();
1400 LinksUpdate
::queueRecursiveJobsForTable( $this->getTitle(), 'imagelinks' );
1403 # Invalidate cache for all pages that redirects on this page
1404 $redirs = $this->getTitle()->getRedirectsHere();
1406 foreach ( $redirs as $redir ) {
1407 if ( !$reupload && $redir->getNamespace() === NS_FILE
) {
1408 LinksUpdate
::queueRecursiveJobsForTable( $redir, 'imagelinks' );
1410 $update = new HTMLCacheUpdate( $redir, 'imagelinks' );
1411 $update->doUpdate();
1414 wfProfileOut( __METHOD__
);
1419 * Move or copy a file to its public location. If a file exists at the
1420 * destination, move it to an archive. Returns a FileRepoStatus object with
1421 * the archive name in the "value" member on success.
1423 * The archive name should be passed through to recordUpload for database
1426 * @param string $srcPath local filesystem path to the source image
1427 * @param $flags Integer: a bitwise combination of:
1428 * File::DELETE_SOURCE Delete the source file, i.e. move rather than copy
1429 * @param array $options Optional additional parameters
1430 * @return FileRepoStatus object. On success, the value member contains the
1431 * archive name, or an empty string if it was a new file.
1433 function publish( $srcPath, $flags = 0, array $options = array() ) {
1434 return $this->publishTo( $srcPath, $this->getRel(), $flags, $options );
1438 * Move or copy a file to a specified location. Returns a FileRepoStatus
1439 * object with the archive name in the "value" member on success.
1441 * The archive name should be passed through to recordUpload for database
1444 * @param string $srcPath local filesystem path to the source image
1445 * @param string $dstRel target relative path
1446 * @param $flags Integer: a bitwise combination of:
1447 * File::DELETE_SOURCE Delete the source file, i.e. move rather than copy
1448 * @param array $options Optional additional parameters
1449 * @return FileRepoStatus object. On success, the value member contains the
1450 * archive name, or an empty string if it was a new file.
1452 function publishTo( $srcPath, $dstRel, $flags = 0, array $options = array() ) {
1453 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
1454 return $this->readOnlyFatalStatus();
1457 $this->lock(); // begin
1459 $archiveName = wfTimestamp( TS_MW
) . '!' . $this->getName();
1460 $archiveRel = 'archive/' . $this->getHashPath() . $archiveName;
1461 $flags = $flags & File
::DELETE_SOURCE ? LocalRepo
::DELETE_SOURCE
: 0;
1462 $status = $this->repo
->publish( $srcPath, $dstRel, $archiveRel, $flags, $options );
1464 if ( $status->value
== 'new' ) {
1465 $status->value
= '';
1467 $status->value
= $archiveName;
1470 $this->unlock(); // done
1475 /** getLinksTo inherited */
1476 /** getExifData inherited */
1477 /** isLocal inherited */
1478 /** wasDeleted inherited */
1481 * Move file to the new title
1483 * Move current, old version and all thumbnails
1484 * to the new filename. Old file is deleted.
1486 * Cache purging is done; checks for validity
1487 * and logging are caller's responsibility
1489 * @param $target Title New file name
1490 * @return FileRepoStatus object.
1492 function move( $target ) {
1493 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
1494 return $this->readOnlyFatalStatus();
1497 wfDebugLog( 'imagemove', "Got request to move {$this->name} to " . $target->getText() );
1498 $batch = new LocalFileMoveBatch( $this, $target );
1500 $this->lock(); // begin
1501 $batch->addCurrent();
1502 $archiveNames = $batch->addOlds();
1503 $status = $batch->execute();
1504 $this->unlock(); // done
1506 wfDebugLog( 'imagemove', "Finished moving {$this->name}" );
1508 $this->purgeEverything();
1509 foreach ( $archiveNames as $archiveName ) {
1510 $this->purgeOldThumbnails( $archiveName );
1512 if ( $status->isOK() ) {
1513 // Now switch the object
1514 $this->title
= $target;
1515 // Force regeneration of the name and hashpath
1516 unset( $this->name
);
1517 unset( $this->hashPath
);
1518 // Purge the new image
1519 $this->purgeEverything();
1526 * Delete all versions of the file.
1528 * Moves the files into an archive directory (or deletes them)
1529 * and removes the database rows.
1531 * Cache purging is done; logging is caller's responsibility.
1535 * @return FileRepoStatus object.
1537 function delete( $reason, $suppress = false ) {
1538 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
1539 return $this->readOnlyFatalStatus();
1542 $batch = new LocalFileDeleteBatch( $this, $reason, $suppress );
1544 $this->lock(); // begin
1545 $batch->addCurrent();
1546 # Get old version relative paths
1547 $archiveNames = $batch->addOlds();
1548 $status = $batch->execute();
1549 $this->unlock(); // done
1551 if ( $status->isOK() ) {
1552 DeferredUpdates
::addUpdate( SiteStatsUpdate
::factory( array( 'images' => -1 ) ) );
1555 // Hack: the lock()/unlock() pair is nested in a transaction so the locking is not
1556 // tied to BEGIN/COMMIT. To avoid slow purges in the transaction, move them outside.
1558 $this->getRepo()->getMasterDB()->onTransactionIdle(
1559 function() use ( $file, $archiveNames ) {
1562 $file->purgeEverything();
1563 foreach ( $archiveNames as $archiveName ) {
1564 $file->purgeOldThumbnails( $archiveName );
1567 if ( $wgUseSquid ) {
1569 $purgeUrls = array();
1570 foreach ( $archiveNames as $archiveName ) {
1571 $purgeUrls[] = $file->getArchiveUrl( $archiveName );
1573 SquidUpdate
::purge( $purgeUrls );
1582 * Delete an old version of the file.
1584 * Moves the file into an archive directory (or deletes it)
1585 * and removes the database row.
1587 * Cache purging is done; logging is caller's responsibility.
1589 * @param $archiveName String
1590 * @param $reason String
1591 * @param $suppress Boolean
1592 * @throws MWException or FSException on database or file store failure
1593 * @return FileRepoStatus object.
1595 function deleteOld( $archiveName, $reason, $suppress = false ) {
1597 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
1598 return $this->readOnlyFatalStatus();
1601 $batch = new LocalFileDeleteBatch( $this, $reason, $suppress );
1603 $this->lock(); // begin
1604 $batch->addOld( $archiveName );
1605 $status = $batch->execute();
1606 $this->unlock(); // done
1608 $this->purgeOldThumbnails( $archiveName );
1609 if ( $status->isOK() ) {
1610 $this->purgeDescription();
1611 $this->purgeHistory();
1614 if ( $wgUseSquid ) {
1616 SquidUpdate
::purge( array( $this->getArchiveUrl( $archiveName ) ) );
1623 * Restore all or specified deleted revisions to the given file.
1624 * Permissions and logging are left to the caller.
1626 * May throw database exceptions on error.
1628 * @param array $versions set of record ids of deleted items to restore,
1629 * or empty to restore all revisions.
1630 * @param $unsuppress Boolean
1631 * @return FileRepoStatus
1633 function restore( $versions = array(), $unsuppress = false ) {
1634 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
1635 return $this->readOnlyFatalStatus();
1638 $batch = new LocalFileRestoreBatch( $this, $unsuppress );
1640 $this->lock(); // begin
1644 $batch->addIds( $versions );
1646 $status = $batch->execute();
1647 if ( $status->isGood() ) {
1648 $cleanupStatus = $batch->cleanup();
1649 $cleanupStatus->successCount
= 0;
1650 $cleanupStatus->failCount
= 0;
1651 $status->merge( $cleanupStatus );
1653 $this->unlock(); // done
1658 /** isMultipage inherited */
1659 /** pageCount inherited */
1660 /** scaleHeight inherited */
1661 /** getImageSize inherited */
1664 * Get the URL of the file description page.
1667 function getDescriptionUrl() {
1668 return $this->title
->getLocalURL();
1672 * Get the HTML text of the description page
1673 * This is not used by ImagePage for local files, since (among other things)
1674 * it skips the parser cache.
1676 * @param $lang Language What language to get description in (Optional)
1677 * @return bool|mixed
1679 function getDescriptionText( $lang = null ) {
1680 $revision = Revision
::newFromTitle( $this->title
, false, Revision
::READ_NORMAL
);
1684 $content = $revision->getContent();
1688 $pout = $content->getParserOutput( $this->title
, null, new ParserOptions( null, $lang ) );
1689 return $pout->getText();
1695 function getDescription( $audience = self
::FOR_PUBLIC
, User
$user = null ) {
1697 if ( $audience == self
::FOR_PUBLIC
&& $this->isDeleted( self
::DELETED_COMMENT
) ) {
1699 } elseif ( $audience == self
::FOR_THIS_USER
1700 && !$this->userCan( self
::DELETED_COMMENT
, $user ) )
1704 return $this->description
;
1709 * @return bool|string
1711 function getTimestamp() {
1713 return $this->timestamp
;
1719 function getSha1() {
1721 // Initialise now if necessary
1722 if ( $this->sha1
== '' && $this->fileExists
) {
1723 $this->lock(); // begin
1725 $this->sha1
= $this->repo
->getFileSha1( $this->getPath() );
1726 if ( !wfReadOnly() && strval( $this->sha1
) != '' ) {
1727 $dbw = $this->repo
->getMasterDB();
1728 $dbw->update( 'image',
1729 array( 'img_sha1' => $this->sha1
),
1730 array( 'img_name' => $this->getName() ),
1732 $this->saveToCache();
1735 $this->unlock(); // done
1742 * @return bool Whether to cache in RepoGroup (this avoids OOMs)
1744 function isCacheable() {
1746 // If extra data (metadata) was not loaded then it must have been large
1747 return $this->extraDataLoaded
1748 && strlen( serialize( $this->metadata
) ) <= self
::CACHE_FIELD_MAX_LEN
;
1752 * Start a transaction and lock the image for update
1753 * Increments a reference counter if the lock is already held
1754 * @return boolean True if the image exists, false otherwise
1757 $dbw = $this->repo
->getMasterDB();
1759 if ( !$this->locked
) {
1760 if ( !$dbw->trxLevel() ) {
1761 $dbw->begin( __METHOD__
);
1762 $this->lockedOwnTrx
= true;
1767 return $dbw->selectField( 'image', '1',
1768 array( 'img_name' => $this->getName() ), __METHOD__
, array( 'FOR UPDATE' ) );
1772 * Decrement the lock reference count. If the reference count is reduced to zero, commits
1773 * the transaction and thereby releases the image lock.
1776 if ( $this->locked
) {
1778 if ( !$this->locked
&& $this->lockedOwnTrx
) {
1779 $dbw = $this->repo
->getMasterDB();
1780 $dbw->commit( __METHOD__
);
1781 $this->lockedOwnTrx
= false;
1787 * Roll back the DB transaction and mark the image unlocked
1789 function unlockAndRollback() {
1790 $this->locked
= false;
1791 $dbw = $this->repo
->getMasterDB();
1792 $dbw->rollback( __METHOD__
);
1793 $this->lockedOwnTrx
= false;
1799 protected function readOnlyFatalStatus() {
1800 return $this->getRepo()->newFatal( 'filereadonlyerror', $this->getName(),
1801 $this->getRepo()->getName(), $this->getRepo()->getReadOnlyReason() );
1803 } // LocalFile class
1805 # ------------------------------------------------------------------------------
1808 * Helper class for file deletion
1809 * @ingroup FileAbstraction
1811 class LocalFileDeleteBatch
{
1818 var $reason, $srcRels = array(), $archiveUrls = array(), $deletionBatch, $suppress;
1823 * @param $reason string
1824 * @param $suppress bool
1826 function __construct( File
$file, $reason = '', $suppress = false ) {
1827 $this->file
= $file;
1828 $this->reason
= $reason;
1829 $this->suppress
= $suppress;
1830 $this->status
= $file->repo
->newGood();
1833 function addCurrent() {
1834 $this->srcRels
['.'] = $this->file
->getRel();
1838 * @param $oldName string
1840 function addOld( $oldName ) {
1841 $this->srcRels
[$oldName] = $this->file
->getArchiveRel( $oldName );
1842 $this->archiveUrls
[] = $this->file
->getArchiveUrl( $oldName );
1846 * Add the old versions of the image to the batch
1847 * @return Array List of archive names from old versions
1849 function addOlds() {
1850 $archiveNames = array();
1852 $dbw = $this->file
->repo
->getMasterDB();
1853 $result = $dbw->select( 'oldimage',
1854 array( 'oi_archive_name' ),
1855 array( 'oi_name' => $this->file
->getName() ),
1859 foreach ( $result as $row ) {
1860 $this->addOld( $row->oi_archive_name
);
1861 $archiveNames[] = $row->oi_archive_name
;
1864 return $archiveNames;
1870 function getOldRels() {
1871 if ( !isset( $this->srcRels
['.'] ) ) {
1872 $oldRels =& $this->srcRels
;
1873 $deleteCurrent = false;
1875 $oldRels = $this->srcRels
;
1876 unset( $oldRels['.'] );
1877 $deleteCurrent = true;
1880 return array( $oldRels, $deleteCurrent );
1886 protected function getHashes() {
1888 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
1890 if ( $deleteCurrent ) {
1891 $hashes['.'] = $this->file
->getSha1();
1894 if ( count( $oldRels ) ) {
1895 $dbw = $this->file
->repo
->getMasterDB();
1896 $res = $dbw->select(
1898 array( 'oi_archive_name', 'oi_sha1' ),
1899 'oi_archive_name IN (' . $dbw->makeList( array_keys( $oldRels ) ) . ')',
1903 foreach ( $res as $row ) {
1904 if ( rtrim( $row->oi_sha1
, "\0" ) === '' ) {
1905 // Get the hash from the file
1906 $oldUrl = $this->file
->getArchiveVirtualUrl( $row->oi_archive_name
);
1907 $props = $this->file
->repo
->getFileProps( $oldUrl );
1909 if ( $props['fileExists'] ) {
1910 // Upgrade the oldimage row
1911 $dbw->update( 'oldimage',
1912 array( 'oi_sha1' => $props['sha1'] ),
1913 array( 'oi_name' => $this->file
->getName(), 'oi_archive_name' => $row->oi_archive_name
),
1915 $hashes[$row->oi_archive_name
] = $props['sha1'];
1917 $hashes[$row->oi_archive_name
] = false;
1920 $hashes[$row->oi_archive_name
] = $row->oi_sha1
;
1925 $missing = array_diff_key( $this->srcRels
, $hashes );
1927 foreach ( $missing as $name => $rel ) {
1928 $this->status
->error( 'filedelete-old-unregistered', $name );
1931 foreach ( $hashes as $name => $hash ) {
1933 $this->status
->error( 'filedelete-missing', $this->srcRels
[$name] );
1934 unset( $hashes[$name] );
1941 function doDBInserts() {
1944 $dbw = $this->file
->repo
->getMasterDB();
1945 $encTimestamp = $dbw->addQuotes( $dbw->timestamp() );
1946 $encUserId = $dbw->addQuotes( $wgUser->getId() );
1947 $encReason = $dbw->addQuotes( $this->reason
);
1948 $encGroup = $dbw->addQuotes( 'deleted' );
1949 $ext = $this->file
->getExtension();
1950 $dotExt = $ext === '' ?
'' : ".$ext";
1951 $encExt = $dbw->addQuotes( $dotExt );
1952 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
1954 // Bitfields to further suppress the content
1955 if ( $this->suppress
) {
1957 // This should be 15...
1958 $bitfield |
= Revision
::DELETED_TEXT
;
1959 $bitfield |
= Revision
::DELETED_COMMENT
;
1960 $bitfield |
= Revision
::DELETED_USER
;
1961 $bitfield |
= Revision
::DELETED_RESTRICTED
;
1963 $bitfield = 'oi_deleted';
1966 if ( $deleteCurrent ) {
1967 $concat = $dbw->buildConcat( array( "img_sha1", $encExt ) );
1968 $where = array( 'img_name' => $this->file
->getName() );
1969 $dbw->insertSelect( 'filearchive', 'image',
1971 'fa_storage_group' => $encGroup,
1972 'fa_storage_key' => "CASE WHEN img_sha1='' THEN '' ELSE $concat END",
1973 'fa_deleted_user' => $encUserId,
1974 'fa_deleted_timestamp' => $encTimestamp,
1975 'fa_deleted_reason' => $encReason,
1976 'fa_deleted' => $this->suppress ?
$bitfield : 0,
1978 'fa_name' => 'img_name',
1979 'fa_archive_name' => 'NULL',
1980 'fa_size' => 'img_size',
1981 'fa_width' => 'img_width',
1982 'fa_height' => 'img_height',
1983 'fa_metadata' => 'img_metadata',
1984 'fa_bits' => 'img_bits',
1985 'fa_media_type' => 'img_media_type',
1986 'fa_major_mime' => 'img_major_mime',
1987 'fa_minor_mime' => 'img_minor_mime',
1988 'fa_description' => 'img_description',
1989 'fa_user' => 'img_user',
1990 'fa_user_text' => 'img_user_text',
1991 'fa_timestamp' => 'img_timestamp',
1992 'fa_sha1' => 'img_sha1',
1993 ), $where, __METHOD__
);
1996 if ( count( $oldRels ) ) {
1997 $concat = $dbw->buildConcat( array( "oi_sha1", $encExt ) );
1999 'oi_name' => $this->file
->getName(),
2000 'oi_archive_name IN (' . $dbw->makeList( array_keys( $oldRels ) ) . ')' );
2001 $dbw->insertSelect( 'filearchive', 'oldimage',
2003 'fa_storage_group' => $encGroup,
2004 'fa_storage_key' => "CASE WHEN oi_sha1='' THEN '' ELSE $concat END",
2005 'fa_deleted_user' => $encUserId,
2006 'fa_deleted_timestamp' => $encTimestamp,
2007 'fa_deleted_reason' => $encReason,
2008 'fa_deleted' => $this->suppress ?
$bitfield : 'oi_deleted',
2010 'fa_name' => 'oi_name',
2011 'fa_archive_name' => 'oi_archive_name',
2012 'fa_size' => 'oi_size',
2013 'fa_width' => 'oi_width',
2014 'fa_height' => 'oi_height',
2015 'fa_metadata' => 'oi_metadata',
2016 'fa_bits' => 'oi_bits',
2017 'fa_media_type' => 'oi_media_type',
2018 'fa_major_mime' => 'oi_major_mime',
2019 'fa_minor_mime' => 'oi_minor_mime',
2020 'fa_description' => 'oi_description',
2021 'fa_user' => 'oi_user',
2022 'fa_user_text' => 'oi_user_text',
2023 'fa_timestamp' => 'oi_timestamp',
2024 'fa_sha1' => 'oi_sha1',
2025 ), $where, __METHOD__
);
2029 function doDBDeletes() {
2030 $dbw = $this->file
->repo
->getMasterDB();
2031 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
2033 if ( count( $oldRels ) ) {
2034 $dbw->delete( 'oldimage',
2036 'oi_name' => $this->file
->getName(),
2037 'oi_archive_name' => array_keys( $oldRels )
2041 if ( $deleteCurrent ) {
2042 $dbw->delete( 'image', array( 'img_name' => $this->file
->getName() ), __METHOD__
);
2047 * Run the transaction
2048 * @return FileRepoStatus
2050 function execute() {
2051 wfProfileIn( __METHOD__
);
2053 $this->file
->lock();
2054 // Leave private files alone
2055 $privateFiles = array();
2056 list( $oldRels, ) = $this->getOldRels();
2057 $dbw = $this->file
->repo
->getMasterDB();
2059 if ( !empty( $oldRels ) ) {
2060 $res = $dbw->select( 'oldimage',
2061 array( 'oi_archive_name' ),
2062 array( 'oi_name' => $this->file
->getName(),
2063 'oi_archive_name IN (' . $dbw->makeList( array_keys( $oldRels ) ) . ')',
2064 $dbw->bitAnd( 'oi_deleted', File
::DELETED_FILE
) => File
::DELETED_FILE
),
2067 foreach ( $res as $row ) {
2068 $privateFiles[$row->oi_archive_name
] = 1;
2071 // Prepare deletion batch
2072 $hashes = $this->getHashes();
2073 $this->deletionBatch
= array();
2074 $ext = $this->file
->getExtension();
2075 $dotExt = $ext === '' ?
'' : ".$ext";
2077 foreach ( $this->srcRels
as $name => $srcRel ) {
2078 // Skip files that have no hash (missing source).
2079 // Keep private files where they are.
2080 if ( isset( $hashes[$name] ) && !array_key_exists( $name, $privateFiles ) ) {
2081 $hash = $hashes[$name];
2082 $key = $hash . $dotExt;
2083 $dstRel = $this->file
->repo
->getDeletedHashPath( $key ) . $key;
2084 $this->deletionBatch
[$name] = array( $srcRel, $dstRel );
2088 // Lock the filearchive rows so that the files don't get deleted by a cleanup operation
2089 // We acquire this lock by running the inserts now, before the file operations.
2091 // This potentially has poor lock contention characteristics -- an alternative
2092 // scheme would be to insert stub filearchive entries with no fa_name and commit
2093 // them in a separate transaction, then run the file ops, then update the fa_name fields.
2094 $this->doDBInserts();
2096 // Removes non-existent file from the batch, so we don't get errors.
2097 $this->deletionBatch
= $this->removeNonexistentFiles( $this->deletionBatch
);
2099 // Execute the file deletion batch
2100 $status = $this->file
->repo
->deleteBatch( $this->deletionBatch
);
2102 if ( !$status->isGood() ) {
2103 $this->status
->merge( $status );
2106 if ( !$this->status
->isOK() ) {
2107 // Critical file deletion error
2108 // Roll back inserts, release lock and abort
2109 // TODO: delete the defunct filearchive rows if we are using a non-transactional DB
2110 $this->file
->unlockAndRollback();
2111 wfProfileOut( __METHOD__
);
2112 return $this->status
;
2115 // Delete image/oldimage rows
2116 $this->doDBDeletes();
2118 // Commit and return
2119 $this->file
->unlock();
2120 wfProfileOut( __METHOD__
);
2122 return $this->status
;
2126 * Removes non-existent files from a deletion batch.
2127 * @param $batch array
2130 function removeNonexistentFiles( $batch ) {
2131 $files = $newBatch = array();
2133 foreach ( $batch as $batchItem ) {
2134 list( $src, ) = $batchItem;
2135 $files[$src] = $this->file
->repo
->getVirtualUrl( 'public' ) . '/' . rawurlencode( $src );
2138 $result = $this->file
->repo
->fileExistsBatch( $files );
2140 foreach ( $batch as $batchItem ) {
2141 if ( $result[$batchItem[0]] ) {
2142 $newBatch[] = $batchItem;
2150 # ------------------------------------------------------------------------------
2153 * Helper class for file undeletion
2154 * @ingroup FileAbstraction
2156 class LocalFileRestoreBatch
{
2162 var $cleanupBatch, $ids, $all, $unsuppress = false;
2166 * @param $unsuppress bool
2168 function __construct( File
$file, $unsuppress = false ) {
2169 $this->file
= $file;
2170 $this->cleanupBatch
= $this->ids
= array();
2171 $this->ids
= array();
2172 $this->unsuppress
= $unsuppress;
2178 function addId( $fa_id ) {
2179 $this->ids
[] = $fa_id;
2183 * Add a whole lot of files by ID
2185 function addIds( $ids ) {
2186 $this->ids
= array_merge( $this->ids
, $ids );
2190 * Add all revisions of the file
2197 * Run the transaction, except the cleanup batch.
2198 * The cleanup batch should be run in a separate transaction, because it locks different
2199 * rows and there's no need to keep the image row locked while it's acquiring those locks
2200 * The caller may have its own transaction open.
2201 * So we save the batch and let the caller call cleanup()
2202 * @return FileRepoStatus
2204 function execute() {
2207 if ( !$this->all
&& !$this->ids
) {
2209 return $this->file
->repo
->newGood();
2212 $exists = $this->file
->lock();
2213 $dbw = $this->file
->repo
->getMasterDB();
2214 $status = $this->file
->repo
->newGood();
2216 // Fetch all or selected archived revisions for the file,
2217 // sorted from the most recent to the oldest.
2218 $conditions = array( 'fa_name' => $this->file
->getName() );
2220 if ( !$this->all
) {
2221 $conditions[] = 'fa_id IN (' . $dbw->makeList( $this->ids
) . ')';
2224 $result = $dbw->select(
2226 ArchivedFile
::selectFields(),
2229 array( 'ORDER BY' => 'fa_timestamp DESC' )
2232 $idsPresent = array();
2233 $storeBatch = array();
2234 $insertBatch = array();
2235 $insertCurrent = false;
2236 $deleteIds = array();
2238 $archiveNames = array();
2240 foreach ( $result as $row ) {
2241 $idsPresent[] = $row->fa_id
;
2243 if ( $row->fa_name
!= $this->file
->getName() ) {
2244 $status->error( 'undelete-filename-mismatch', $wgLang->timeanddate( $row->fa_timestamp
) );
2245 $status->failCount++
;
2249 if ( $row->fa_storage_key
== '' ) {
2250 // Revision was missing pre-deletion
2251 $status->error( 'undelete-bad-store-key', $wgLang->timeanddate( $row->fa_timestamp
) );
2252 $status->failCount++
;
2256 $deletedRel = $this->file
->repo
->getDeletedHashPath( $row->fa_storage_key
) . $row->fa_storage_key
;
2257 $deletedUrl = $this->file
->repo
->getVirtualUrl() . '/deleted/' . $deletedRel;
2259 if ( isset( $row->fa_sha1
) ) {
2260 $sha1 = $row->fa_sha1
;
2262 // old row, populate from key
2263 $sha1 = LocalRepo
::getHashFromKey( $row->fa_storage_key
);
2267 if ( strlen( $sha1 ) == 32 && $sha1[0] == '0' ) {
2268 $sha1 = substr( $sha1, 1 );
2271 if ( is_null( $row->fa_major_mime
) ||
$row->fa_major_mime
== 'unknown'
2272 ||
is_null( $row->fa_minor_mime
) ||
$row->fa_minor_mime
== 'unknown'
2273 ||
is_null( $row->fa_media_type
) ||
$row->fa_media_type
== 'UNKNOWN'
2274 ||
is_null( $row->fa_metadata
) ) {
2275 // Refresh our metadata
2276 // Required for a new current revision; nice for older ones too. :)
2277 $props = RepoGroup
::singleton()->getFileProps( $deletedUrl );
2280 'minor_mime' => $row->fa_minor_mime
,
2281 'major_mime' => $row->fa_major_mime
,
2282 'media_type' => $row->fa_media_type
,
2283 'metadata' => $row->fa_metadata
2287 if ( $first && !$exists ) {
2288 // This revision will be published as the new current version
2289 $destRel = $this->file
->getRel();
2290 $insertCurrent = array(
2291 'img_name' => $row->fa_name
,
2292 'img_size' => $row->fa_size
,
2293 'img_width' => $row->fa_width
,
2294 'img_height' => $row->fa_height
,
2295 'img_metadata' => $props['metadata'],
2296 'img_bits' => $row->fa_bits
,
2297 'img_media_type' => $props['media_type'],
2298 'img_major_mime' => $props['major_mime'],
2299 'img_minor_mime' => $props['minor_mime'],
2300 'img_description' => $row->fa_description
,
2301 'img_user' => $row->fa_user
,
2302 'img_user_text' => $row->fa_user_text
,
2303 'img_timestamp' => $row->fa_timestamp
,
2307 // The live (current) version cannot be hidden!
2308 if ( !$this->unsuppress
&& $row->fa_deleted
) {
2309 $storeBatch[] = array( $deletedUrl, 'public', $destRel );
2310 $this->cleanupBatch
[] = $row->fa_storage_key
;
2313 $archiveName = $row->fa_archive_name
;
2315 if ( $archiveName == '' ) {
2316 // This was originally a current version; we
2317 // have to devise a new archive name for it.
2318 // Format is <timestamp of archiving>!<name>
2319 $timestamp = wfTimestamp( TS_UNIX
, $row->fa_deleted_timestamp
);
2322 $archiveName = wfTimestamp( TS_MW
, $timestamp ) . '!' . $row->fa_name
;
2324 } while ( isset( $archiveNames[$archiveName] ) );
2327 $archiveNames[$archiveName] = true;
2328 $destRel = $this->file
->getArchiveRel( $archiveName );
2329 $insertBatch[] = array(
2330 'oi_name' => $row->fa_name
,
2331 'oi_archive_name' => $archiveName,
2332 'oi_size' => $row->fa_size
,
2333 'oi_width' => $row->fa_width
,
2334 'oi_height' => $row->fa_height
,
2335 'oi_bits' => $row->fa_bits
,
2336 'oi_description' => $row->fa_description
,
2337 'oi_user' => $row->fa_user
,
2338 'oi_user_text' => $row->fa_user_text
,
2339 'oi_timestamp' => $row->fa_timestamp
,
2340 'oi_metadata' => $props['metadata'],
2341 'oi_media_type' => $props['media_type'],
2342 'oi_major_mime' => $props['major_mime'],
2343 'oi_minor_mime' => $props['minor_mime'],
2344 'oi_deleted' => $this->unsuppress ?
0 : $row->fa_deleted
,
2345 'oi_sha1' => $sha1 );
2348 $deleteIds[] = $row->fa_id
;
2350 if ( !$this->unsuppress
&& $row->fa_deleted
& File
::DELETED_FILE
) {
2351 // private files can stay where they are
2352 $status->successCount++
;
2354 $storeBatch[] = array( $deletedUrl, 'public', $destRel );
2355 $this->cleanupBatch
[] = $row->fa_storage_key
;
2363 // Add a warning to the status object for missing IDs
2364 $missingIds = array_diff( $this->ids
, $idsPresent );
2366 foreach ( $missingIds as $id ) {
2367 $status->error( 'undelete-missing-filearchive', $id );
2370 // Remove missing files from batch, so we don't get errors when undeleting them
2371 $storeBatch = $this->removeNonexistentFiles( $storeBatch );
2373 // Run the store batch
2374 // Use the OVERWRITE_SAME flag to smooth over a common error
2375 $storeStatus = $this->file
->repo
->storeBatch( $storeBatch, FileRepo
::OVERWRITE_SAME
);
2376 $status->merge( $storeStatus );
2378 if ( !$status->isGood() ) {
2379 // Even if some files could be copied, fail entirely as that is the
2380 // easiest thing to do without data loss
2381 $this->cleanupFailedBatch( $storeStatus, $storeBatch );
2382 $status->ok
= false;
2383 $this->file
->unlock();
2388 // Run the DB updates
2389 // Because we have locked the image row, key conflicts should be rare.
2390 // If they do occur, we can roll back the transaction at this time with
2391 // no data loss, but leaving unregistered files scattered throughout the
2393 // This is not ideal, which is why it's important to lock the image row.
2394 if ( $insertCurrent ) {
2395 $dbw->insert( 'image', $insertCurrent, __METHOD__
);
2398 if ( $insertBatch ) {
2399 $dbw->insert( 'oldimage', $insertBatch, __METHOD__
);
2403 $dbw->delete( 'filearchive',
2404 array( 'fa_id IN (' . $dbw->makeList( $deleteIds ) . ')' ),
2408 // If store batch is empty (all files are missing), deletion is to be considered successful
2409 if ( $status->successCount
> 0 ||
!$storeBatch ) {
2411 wfDebug( __METHOD__
. " restored {$status->successCount} items, creating a new current\n" );
2413 DeferredUpdates
::addUpdate( SiteStatsUpdate
::factory( array( 'images' => 1 ) ) );
2415 $this->file
->purgeEverything();
2417 wfDebug( __METHOD__
. " restored {$status->successCount} as archived versions\n" );
2418 $this->file
->purgeDescription();
2419 $this->file
->purgeHistory();
2423 $this->file
->unlock();
2429 * Removes non-existent files from a store batch.
2430 * @param $triplets array
2433 function removeNonexistentFiles( $triplets ) {
2434 $files = $filteredTriplets = array();
2435 foreach ( $triplets as $file ) {
2436 $files[$file[0]] = $file[0];
2439 $result = $this->file
->repo
->fileExistsBatch( $files );
2441 foreach ( $triplets as $file ) {
2442 if ( $result[$file[0]] ) {
2443 $filteredTriplets[] = $file;
2447 return $filteredTriplets;
2451 * Removes non-existent files from a cleanup batch.
2452 * @param $batch array
2455 function removeNonexistentFromCleanup( $batch ) {
2456 $files = $newBatch = array();
2457 $repo = $this->file
->repo
;
2459 foreach ( $batch as $file ) {
2460 $files[$file] = $repo->getVirtualUrl( 'deleted' ) . '/' .
2461 rawurlencode( $repo->getDeletedHashPath( $file ) . $file );
2464 $result = $repo->fileExistsBatch( $files );
2466 foreach ( $batch as $file ) {
2467 if ( $result[$file] ) {
2468 $newBatch[] = $file;
2476 * Delete unused files in the deleted zone.
2477 * This should be called from outside the transaction in which execute() was called.
2478 * @return FileRepoStatus
2480 function cleanup() {
2481 if ( !$this->cleanupBatch
) {
2482 return $this->file
->repo
->newGood();
2485 $this->cleanupBatch
= $this->removeNonexistentFromCleanup( $this->cleanupBatch
);
2487 $status = $this->file
->repo
->cleanupDeletedBatch( $this->cleanupBatch
);
2493 * Cleanup a failed batch. The batch was only partially successful, so
2494 * rollback by removing all items that were succesfully copied.
2496 * @param Status $storeStatus
2497 * @param array $storeBatch
2499 function cleanupFailedBatch( $storeStatus, $storeBatch ) {
2500 $cleanupBatch = array();
2502 foreach ( $storeStatus->success
as $i => $success ) {
2503 // Check if this item of the batch was successfully copied
2505 // Item was successfully copied and needs to be removed again
2506 // Extract ($dstZone, $dstRel) from the batch
2507 $cleanupBatch[] = array( $storeBatch[$i][1], $storeBatch[$i][2] );
2510 $this->file
->repo
->cleanupBatch( $cleanupBatch );
2514 # ------------------------------------------------------------------------------
2517 * Helper class for file movement
2518 * @ingroup FileAbstraction
2520 class LocalFileMoveBatch
{
2532 var $cur, $olds, $oldCount, $archive;
2541 * @param Title $target
2543 function __construct( File
$file, Title
$target ) {
2544 $this->file
= $file;
2545 $this->target
= $target;
2546 $this->oldHash
= $this->file
->repo
->getHashPath( $this->file
->getName() );
2547 $this->newHash
= $this->file
->repo
->getHashPath( $this->target
->getDBkey() );
2548 $this->oldName
= $this->file
->getName();
2549 $this->newName
= $this->file
->repo
->getNameFromTitle( $this->target
);
2550 $this->oldRel
= $this->oldHash
. $this->oldName
;
2551 $this->newRel
= $this->newHash
. $this->newName
;
2552 $this->db
= $file->getRepo()->getMasterDb();
2556 * Add the current image to the batch
2558 function addCurrent() {
2559 $this->cur
= array( $this->oldRel
, $this->newRel
);
2563 * Add the old versions of the image to the batch
2564 * @return Array List of archive names from old versions
2566 function addOlds() {
2567 $archiveBase = 'archive';
2568 $this->olds
= array();
2569 $this->oldCount
= 0;
2570 $archiveNames = array();
2572 $result = $this->db
->select( 'oldimage',
2573 array( 'oi_archive_name', 'oi_deleted' ),
2574 array( 'oi_name' => $this->oldName
),
2578 foreach ( $result as $row ) {
2579 $archiveNames[] = $row->oi_archive_name
;
2580 $oldName = $row->oi_archive_name
;
2581 $bits = explode( '!', $oldName, 2 );
2583 if ( count( $bits ) != 2 ) {
2584 wfDebug( "Old file name missing !: '$oldName' \n" );
2588 list( $timestamp, $filename ) = $bits;
2590 if ( $this->oldName
!= $filename ) {
2591 wfDebug( "Old file name doesn't match: '$oldName' \n" );
2597 // Do we want to add those to oldCount?
2598 if ( $row->oi_deleted
& File
::DELETED_FILE
) {
2602 $this->olds
[] = array(
2603 "{$archiveBase}/{$this->oldHash}{$oldName}",
2604 "{$archiveBase}/{$this->newHash}{$timestamp}!{$this->newName}"
2608 return $archiveNames;
2613 * @return FileRepoStatus
2615 function execute() {
2616 $repo = $this->file
->repo
;
2617 $status = $repo->newGood();
2619 $triplets = $this->getMoveTriplets();
2620 $triplets = $this->removeNonexistentFiles( $triplets );
2622 $this->file
->lock(); // begin
2623 // Rename the file versions metadata in the DB.
2624 // This implicitly locks the destination file, which avoids race conditions.
2625 // If we moved the files from A -> C before DB updates, another process could
2626 // move files from B -> C at this point, causing storeBatch() to fail and thus
2627 // cleanupTarget() to trigger. It would delete the C files and cause data loss.
2628 $statusDb = $this->doDBUpdates();
2629 if ( !$statusDb->isGood() ) {
2630 $this->file
->unlockAndRollback();
2631 $statusDb->ok
= false;
2634 wfDebugLog( 'imagemove', "Renamed {$this->file->getName()} in database: {$statusDb->successCount} successes, {$statusDb->failCount} failures" );
2636 // Copy the files into their new location.
2637 // If a prior process fataled copying or cleaning up files we tolerate any
2638 // of the existing files if they are identical to the ones being stored.
2639 $statusMove = $repo->storeBatch( $triplets, FileRepo
::OVERWRITE_SAME
);
2640 wfDebugLog( 'imagemove', "Moved files for {$this->file->getName()}: {$statusMove->successCount} successes, {$statusMove->failCount} failures" );
2641 if ( !$statusMove->isGood() ) {
2642 // Delete any files copied over (while the destination is still locked)
2643 $this->cleanupTarget( $triplets );
2644 $this->file
->unlockAndRollback(); // unlocks the destination
2645 wfDebugLog( 'imagemove', "Error in moving files: " . $statusMove->getWikiText() );
2646 $statusMove->ok
= false;
2649 $this->file
->unlock(); // done
2651 // Everything went ok, remove the source files
2652 $this->cleanupSource( $triplets );
2654 $status->merge( $statusDb );
2655 $status->merge( $statusMove );
2661 * Do the database updates and return a new FileRepoStatus indicating how
2662 * many rows where updated.
2664 * @return FileRepoStatus
2666 function doDBUpdates() {
2667 $repo = $this->file
->repo
;
2668 $status = $repo->newGood();
2671 // Update current image
2674 array( 'img_name' => $this->newName
),
2675 array( 'img_name' => $this->oldName
),
2679 if ( $dbw->affectedRows() ) {
2680 $status->successCount++
;
2682 $status->failCount++
;
2683 $status->fatal( 'imageinvalidfilename' );
2687 // Update old images
2691 'oi_name' => $this->newName
,
2692 'oi_archive_name = ' . $dbw->strreplace( 'oi_archive_name',
2693 $dbw->addQuotes( $this->oldName
), $dbw->addQuotes( $this->newName
) ),
2695 array( 'oi_name' => $this->oldName
),
2699 $affected = $dbw->affectedRows();
2700 $total = $this->oldCount
;
2701 $status->successCount +
= $affected;
2702 // Bug 34934: $total is based on files that actually exist.
2703 // There may be more DB rows than such files, in which case $affected
2704 // can be greater than $total. We use max() to avoid negatives here.
2705 $status->failCount +
= max( 0, $total - $affected );
2706 if ( $status->failCount
) {
2707 $status->error( 'imageinvalidfilename' );
2714 * Generate triplets for FileRepo::storeBatch().
2717 function getMoveTriplets() {
2718 $moves = array_merge( array( $this->cur
), $this->olds
);
2719 $triplets = array(); // The format is: (srcUrl, destZone, destUrl)
2721 foreach ( $moves as $move ) {
2722 // $move: (oldRelativePath, newRelativePath)
2723 $srcUrl = $this->file
->repo
->getVirtualUrl() . '/public/' . rawurlencode( $move[0] );
2724 $triplets[] = array( $srcUrl, 'public', $move[1] );
2725 wfDebugLog( 'imagemove', "Generated move triplet for {$this->file->getName()}: {$srcUrl} :: public :: {$move[1]}" );
2732 * Removes non-existent files from move batch.
2733 * @param $triplets array
2736 function removeNonexistentFiles( $triplets ) {
2739 foreach ( $triplets as $file ) {
2740 $files[$file[0]] = $file[0];
2743 $result = $this->file
->repo
->fileExistsBatch( $files );
2744 $filteredTriplets = array();
2746 foreach ( $triplets as $file ) {
2747 if ( $result[$file[0]] ) {
2748 $filteredTriplets[] = $file;
2750 wfDebugLog( 'imagemove', "File {$file[0]} does not exist" );
2754 return $filteredTriplets;
2758 * Cleanup a partially moved array of triplets by deleting the target
2759 * files. Called if something went wrong half way.
2761 function cleanupTarget( $triplets ) {
2762 // Create dest pairs from the triplets
2764 foreach ( $triplets as $triplet ) {
2765 // $triplet: (old source virtual URL, dst zone, dest rel)
2766 $pairs[] = array( $triplet[1], $triplet[2] );
2769 $this->file
->repo
->cleanupBatch( $pairs );
2773 * Cleanup a fully moved array of triplets by deleting the source files.
2774 * Called at the end of the move process if everything else went ok.
2776 function cleanupSource( $triplets ) {
2777 // Create source file names from the triplets
2779 foreach ( $triplets as $triplet ) {
2780 $files[] = $triplet[0];
2783 $this->file
->repo
->cleanupBatch( $files );