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', 8 );
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 all this has been loaded from the database (loadFromXxx)
71 $upgraded, # Whether the row was upgraded on load
72 $locked, # True if the image row is locked
73 $missing, # True if file is not present in file system. Not to be cached in memcached
74 $deleted; # Bitfield akin to rev_deleted
83 protected $repoClass = 'LocalRepo';
86 * Create a LocalFile from a title
87 * Do not call this except from inside a repo class.
89 * Note: $unused param is only here to avoid an E_STRICT
97 static function newFromTitle( $title, $repo, $unused = null ) {
98 return new self( $title, $repo );
102 * Create a LocalFile from a title
103 * Do not call this except from inside a repo class.
110 static function newFromRow( $row, $repo ) {
111 $title = Title
::makeTitle( NS_FILE
, $row->img_name
);
112 $file = new self( $title, $repo );
113 $file->loadFromRow( $row );
119 * Create a LocalFile from a SHA-1 key
120 * Do not call this except from inside a repo class.
122 * @param $sha1 string base-36 SHA-1
123 * @param $repo LocalRepo
124 * @param string|bool $timestamp MW_timestamp (optional)
126 * @return bool|LocalFile
128 static function newFromKey( $sha1, $repo, $timestamp = false ) {
129 $dbr = $repo->getSlaveDB();
131 $conds = array( 'img_sha1' => $sha1 );
133 $conds['img_timestamp'] = $dbr->timestamp( $timestamp );
136 $row = $dbr->selectRow( 'image', self
::selectFields(), $conds, __METHOD__
);
138 return self
::newFromRow( $row, $repo );
145 * Fields in the image table
148 static function selectFields() {
169 * Do not call this except from inside a repo class.
171 function __construct( $title, $repo ) {
172 parent
::__construct( $title, $repo );
174 $this->metadata
= '';
175 $this->historyLine
= 0;
176 $this->historyRes
= null;
177 $this->dataLoaded
= false;
179 $this->assertRepoDefined();
180 $this->assertTitleDefined();
184 * Get the memcached key for the main data for this file, or false if
185 * there is no access to the shared cache.
188 function getCacheKey() {
189 $hashedName = md5( $this->getName() );
191 return $this->repo
->getSharedCacheKey( 'file', $hashedName );
195 * Try to load file metadata from memcached. Returns true on success.
198 function loadFromCache() {
201 wfProfileIn( __METHOD__
);
202 $this->dataLoaded
= false;
203 $key = $this->getCacheKey();
206 wfProfileOut( __METHOD__
);
210 $cachedValues = $wgMemc->get( $key );
212 // Check if the key existed and belongs to this version of MediaWiki
213 if ( isset( $cachedValues['version'] ) && ( $cachedValues['version'] == MW_FILE_VERSION
) ) {
214 wfDebug( "Pulling file metadata from cache key $key\n" );
215 $this->fileExists
= $cachedValues['fileExists'];
216 if ( $this->fileExists
) {
217 $this->setProps( $cachedValues );
219 $this->dataLoaded
= true;
222 if ( $this->dataLoaded
) {
223 wfIncrStats( 'image_cache_hit' );
225 wfIncrStats( 'image_cache_miss' );
228 wfProfileOut( __METHOD__
);
229 return $this->dataLoaded
;
233 * Save the file metadata to memcached
235 function saveToCache() {
239 $key = $this->getCacheKey();
245 $fields = $this->getCacheFields( '' );
246 $cache = array( 'version' => MW_FILE_VERSION
);
247 $cache['fileExists'] = $this->fileExists
;
249 if ( $this->fileExists
) {
250 foreach ( $fields as $field ) {
251 $cache[$field] = $this->$field;
255 $wgMemc->set( $key, $cache, 60 * 60 * 24 * 7 ); // A week
259 * Load metadata from the file itself
261 function loadFromFile() {
262 $props = $this->repo
->getFileProps( $this->getVirtualUrl() );
263 $this->setProps( $props );
266 function getCacheFields( $prefix = 'img_' ) {
267 static $fields = array( 'size', 'width', 'height', 'bits', 'media_type',
268 'major_mime', 'minor_mime', 'metadata', 'timestamp', 'sha1', 'user', 'user_text', 'description' );
269 static $results = array();
271 if ( $prefix == '' ) {
275 if ( !isset( $results[$prefix] ) ) {
276 $prefixedFields = array();
277 foreach ( $fields as $field ) {
278 $prefixedFields[] = $prefix . $field;
280 $results[$prefix] = $prefixedFields;
283 return $results[$prefix];
287 * Load file metadata from the DB
289 function loadFromDB() {
290 # Polymorphic function name to distinguish foreign and local fetches
291 $fname = get_class( $this ) . '::' . __FUNCTION__
;
292 wfProfileIn( $fname );
294 # Unconditionally set loaded=true, we don't want the accessors constantly rechecking
295 $this->dataLoaded
= true;
297 $dbr = $this->repo
->getMasterDB();
299 $row = $dbr->selectRow( 'image', $this->getCacheFields( 'img_' ),
300 array( 'img_name' => $this->getName() ), $fname );
303 $this->loadFromRow( $row );
305 $this->fileExists
= false;
308 wfProfileOut( $fname );
312 * Decode a row from the database (either object or array) to an array
313 * with timestamps and MIME types decoded, and the field prefix removed.
316 function decodeRow( $row, $prefix = 'img_' ) {
317 $array = (array)$row;
318 $prefixLength = strlen( $prefix );
320 // Sanity check prefix once
321 if ( substr( key( $array ), 0, $prefixLength ) !== $prefix ) {
322 throw new MWException( __METHOD__
. ': incorrect $prefix parameter' );
327 foreach ( $array as $name => $value ) {
328 $decoded[substr( $name, $prefixLength )] = $value;
331 $decoded['timestamp'] = wfTimestamp( TS_MW
, $decoded['timestamp'] );
333 if ( empty( $decoded['major_mime'] ) ) {
334 $decoded['mime'] = 'unknown/unknown';
336 if ( !$decoded['minor_mime'] ) {
337 $decoded['minor_mime'] = 'unknown';
339 $decoded['mime'] = $decoded['major_mime'] . '/' . $decoded['minor_mime'];
342 # Trim zero padding from char/binary field
343 $decoded['sha1'] = rtrim( $decoded['sha1'], "\0" );
349 * Load file metadata from a DB result row
351 function loadFromRow( $row, $prefix = 'img_' ) {
352 $this->dataLoaded
= true;
353 $array = $this->decodeRow( $row, $prefix );
355 foreach ( $array as $name => $value ) {
356 $this->$name = $value;
359 $this->fileExists
= true;
360 $this->maybeUpgradeRow();
364 * Load file metadata from cache or DB, unless already loaded
367 if ( !$this->dataLoaded
) {
368 if ( !$this->loadFromCache() ) {
370 $this->saveToCache();
372 $this->dataLoaded
= true;
377 * Upgrade a row if it needs it
379 function maybeUpgradeRow() {
380 global $wgUpdateCompatibleMetadata;
381 if ( wfReadOnly() ) {
385 if ( is_null( $this->media_type
) ||
386 $this->mime
== 'image/svg'
389 $this->upgraded
= true;
391 $handler = $this->getHandler();
393 $validity = $handler->isMetadataValid( $this, $this->metadata
);
394 if ( $validity === MediaHandler
::METADATA_BAD
395 ||
( $validity === MediaHandler
::METADATA_COMPATIBLE
&& $wgUpdateCompatibleMetadata )
398 $this->upgraded
= true;
404 function getUpgraded() {
405 return $this->upgraded
;
409 * Fix assorted version-related problems with the image row by reloading it from the file
411 function upgradeRow() {
412 wfProfileIn( __METHOD__
);
414 $this->lock(); // begin
416 $this->loadFromFile();
418 # Don't destroy file info of missing files
419 if ( !$this->fileExists
) {
420 wfDebug( __METHOD__
. ": file does not exist, aborting\n" );
421 wfProfileOut( __METHOD__
);
425 $dbw = $this->repo
->getMasterDB();
426 list( $major, $minor ) = self
::splitMime( $this->mime
);
428 if ( wfReadOnly() ) {
429 wfProfileOut( __METHOD__
);
432 wfDebug( __METHOD__
. ': upgrading ' . $this->getName() . " to the current schema\n" );
434 $dbw->update( 'image',
436 'img_width' => $this->width
,
437 'img_height' => $this->height
,
438 'img_bits' => $this->bits
,
439 'img_media_type' => $this->media_type
,
440 'img_major_mime' => $major,
441 'img_minor_mime' => $minor,
442 'img_metadata' => $this->metadata
,
443 'img_sha1' => $this->sha1
,
445 array( 'img_name' => $this->getName() ),
449 $this->saveToCache();
451 $this->unlock(); // done
453 wfProfileOut( __METHOD__
);
457 * Set properties in this object to be equal to those given in the
458 * associative array $info. Only cacheable fields can be set.
460 * If 'mime' is given, it will be split into major_mime/minor_mime.
461 * If major_mime/minor_mime are given, $this->mime will also be set.
463 function setProps( $info ) {
464 $this->dataLoaded
= true;
465 $fields = $this->getCacheFields( '' );
466 $fields[] = 'fileExists';
468 foreach ( $fields as $field ) {
469 if ( isset( $info[$field] ) ) {
470 $this->$field = $info[$field];
474 // Fix up mime fields
475 if ( isset( $info['major_mime'] ) ) {
476 $this->mime
= "{$info['major_mime']}/{$info['minor_mime']}";
477 } elseif ( isset( $info['mime'] ) ) {
478 $this->mime
= $info['mime'];
479 list( $this->major_mime
, $this->minor_mime
) = self
::splitMime( $this->mime
);
483 /** splitMime inherited */
484 /** getName inherited */
485 /** getTitle inherited */
486 /** getURL inherited */
487 /** getViewURL inherited */
488 /** getPath inherited */
489 /** isVisible inhereted */
491 function isMissing() {
492 if ( $this->missing
=== null ) {
493 list( $fileExists ) = $this->repo
->fileExists( $this->getVirtualUrl() );
494 $this->missing
= !$fileExists;
496 return $this->missing
;
500 * Return the width of the image
502 * Returns false on error
505 public function getWidth( $page = 1 ) {
508 if ( $this->isMultipage() ) {
509 $dim = $this->getHandler()->getPageDimensions( $this, $page );
511 return $dim['width'];
521 * Return the height of the image
523 * Returns false on error
526 public function getHeight( $page = 1 ) {
529 if ( $this->isMultipage() ) {
530 $dim = $this->getHandler()->getPageDimensions( $this, $page );
532 return $dim['height'];
537 return $this->height
;
542 * Returns ID or name of user who uploaded the file
544 * @param $type string 'text' or 'id'
546 function getUser( $type = 'text' ) {
549 if ( $type == 'text' ) {
550 return $this->user_text
;
551 } elseif ( $type == 'id' ) {
557 * Get handler-specific metadata
560 function getMetadata() {
562 return $this->metadata
;
565 function getBitDepth() {
571 * Return the size of the image file, in bytes
573 public function getSize() {
579 * Returns the mime type of the file.
581 function getMimeType() {
587 * Return the type of the media in the file.
588 * Use the value returned by this function with the MEDIATYPE_xxx constants.
590 function getMediaType() {
592 return $this->media_type
;
595 /** canRender inherited */
596 /** mustRender inherited */
597 /** allowInlineDisplay inherited */
598 /** isSafeFile inherited */
599 /** isTrustedFile inherited */
602 * Returns true if the file exists on disk.
603 * @return boolean Whether file exist on disk.
605 public function exists() {
607 return $this->fileExists
;
610 /** getTransformScript inherited */
611 /** getUnscaledThumb inherited */
612 /** thumbName inherited */
613 /** createThumb inherited */
614 /** transform inherited */
617 * Fix thumbnail files from 1.4 or before, with extreme prejudice
619 function migrateThumbFile( $thumbName ) {
620 $thumbDir = $this->getThumbPath();
622 /* Old code for bug 2532
623 $thumbPath = "$thumbDir/$thumbName";
624 if ( is_dir( $thumbPath ) ) {
625 // Directory where file should be
626 // This happened occasionally due to broken migration code in 1.5
627 // Rename to broken-*
628 for ( $i = 0; $i < 100 ; $i++ ) {
629 $broken = $this->repo->getZonePath( 'public' ) . "/broken-$i-$thumbName";
630 if ( !file_exists( $broken ) ) {
631 rename( $thumbPath, $broken );
635 // Doesn't exist anymore
640 if ( $this->repo
->fileExists( $thumbDir ) ) {
641 // Delete file where directory should be
642 $this->repo
->cleanupBatch( array( $thumbDir ) );
646 /** getHandler inherited */
647 /** iconThumb inherited */
648 /** getLastError inherited */
651 * Get all thumbnail names previously generated for this file
652 * @param $archiveName string|bool Name of an archive file, default false
653 * @return array first element is the base dir, then files in that base dir.
655 function getThumbnails( $archiveName = false ) {
658 if ( $archiveName ) {
659 $dir = $this->getArchiveThumbPath( $archiveName );
661 $dir = $this->getThumbPath();
664 $backend = $this->repo
->getBackend();
665 $files = array( $dir );
666 $iterator = $backend->getFileList( array( 'dir' => $dir ) );
667 foreach ( $iterator as $file ) {
675 * Refresh metadata in memcached, but don't touch thumbnails or squid
677 function purgeMetadataCache() {
679 $this->saveToCache();
680 $this->purgeHistory();
684 * Purge the shared history (OldLocalFile) cache
686 function purgeHistory() {
689 $hashedName = md5( $this->getName() );
690 $oldKey = $this->repo
->getSharedCacheKey( 'oldfile', $hashedName );
692 // Must purge thumbnails for old versions too! bug 30192
693 foreach( $this->getHistory() as $oldFile ) {
694 $oldFile->purgeThumbnails();
698 $wgMemc->delete( $oldKey );
703 * Delete all previously generated thumbnails, refresh metadata in memcached and purge the squid
705 function purgeCache( $options = array() ) {
706 // Refresh metadata cache
707 $this->purgeMetadataCache();
710 $this->purgeThumbnails( $options );
712 // Purge squid cache for this file
713 SquidUpdate
::purge( array( $this->getURL() ) );
717 * Delete cached transformed files for an archived version only.
718 * @param $archiveName string name of the archived file
720 function purgeOldThumbnails( $archiveName ) {
722 // Get a list of old thumbnails and URLs
723 $files = $this->getThumbnails( $archiveName );
724 $dir = array_shift( $files );
725 $this->purgeThumbList( $dir, $files );
727 // Purge any custom thumbnail caches
728 wfRunHooks( 'LocalFilePurgeThumbnails', array( $this, $archiveName ) );
733 foreach( $files as $file ) {
734 $urls[] = $this->getArchiveThumbUrl( $archiveName, $file );
736 SquidUpdate
::purge( $urls );
741 * Delete cached transformed files for the current version only.
743 function purgeThumbnails( $options = array() ) {
747 $files = $this->getThumbnails();
749 // Give media handler a chance to filter the purge list
750 if ( !empty( $options['forThumbRefresh'] ) ) {
751 $handler = $this->getHandler();
753 $handler->filterThumbnailPurgeList( $files, $options );
757 $dir = array_shift( $files );
758 $this->purgeThumbList( $dir, $files );
760 // Purge any custom thumbnail caches
761 wfRunHooks( 'LocalFilePurgeThumbnails', array( $this, false ) );
766 foreach( $files as $file ) {
767 $urls[] = $this->getThumbUrl( $file );
769 SquidUpdate
::purge( $urls );
774 * Delete a list of thumbnails visible at urls
775 * @param $dir string base dir of the files.
776 * @param $files array of strings: relative filenames (to $dir)
778 protected function purgeThumbList( $dir, $files ) {
779 $fileListDebug = strtr(
780 var_export( $files, true ),
783 wfDebug( __METHOD__
. ": $fileListDebug\n" );
785 $purgeList = array();
786 foreach ( $files as $file ) {
787 # Check that the base file name is part of the thumb name
788 # This is a basic sanity check to avoid erasing unrelated directories
789 if ( strpos( $file, $this->getName() ) !== false ) {
790 $purgeList[] = "{$dir}/{$file}";
794 # Delete the thumbnails
795 $this->repo
->quickPurgeBatch( $purgeList );
796 # Clear out the thumbnail directory if empty
797 $this->repo
->quickCleanDir( $dir );
800 /** purgeDescription inherited */
801 /** purgeEverything inherited */
803 function getHistory( $limit = null, $start = null, $end = null, $inc = true ) {
804 $dbr = $this->repo
->getSlaveDB();
805 $tables = array( 'oldimage' );
806 $fields = OldLocalFile
::selectFields();
807 $conds = $opts = $join_conds = array();
808 $eq = $inc ?
'=' : '';
809 $conds[] = "oi_name = " . $dbr->addQuotes( $this->title
->getDBkey() );
812 $conds[] = "oi_timestamp <$eq " . $dbr->addQuotes( $dbr->timestamp( $start ) );
816 $conds[] = "oi_timestamp >$eq " . $dbr->addQuotes( $dbr->timestamp( $end ) );
820 $opts['LIMIT'] = $limit;
823 // Search backwards for time > x queries
824 $order = ( !$start && $end !== null ) ?
'ASC' : 'DESC';
825 $opts['ORDER BY'] = "oi_timestamp $order";
826 $opts['USE INDEX'] = array( 'oldimage' => 'oi_name_timestamp' );
828 wfRunHooks( 'LocalFile::getHistory', array( &$this, &$tables, &$fields,
829 &$conds, &$opts, &$join_conds ) );
831 $res = $dbr->select( $tables, $fields, $conds, __METHOD__
, $opts, $join_conds );
834 foreach ( $res as $row ) {
835 if ( $this->repo
->oldFileFromRowFactory
) {
836 $r[] = call_user_func( $this->repo
->oldFileFromRowFactory
, $row, $this->repo
);
838 $r[] = OldLocalFile
::newFromRow( $row, $this->repo
);
842 if ( $order == 'ASC' ) {
843 $r = array_reverse( $r ); // make sure it ends up descending
850 * Return the history of this file, line by line.
851 * starts with current version, then old versions.
852 * uses $this->historyLine to check which line to return:
853 * 0 return line for current version
854 * 1 query for old versions, return first one
855 * 2, ... return next old version from above query
858 public function nextHistoryLine() {
859 # Polymorphic function name to distinguish foreign and local fetches
860 $fname = get_class( $this ) . '::' . __FUNCTION__
;
862 $dbr = $this->repo
->getSlaveDB();
864 if ( $this->historyLine
== 0 ) {// called for the first time, return line from cur
865 $this->historyRes
= $dbr->select( 'image',
868 "'' AS oi_archive_name",
872 array( 'img_name' => $this->title
->getDBkey() ),
876 if ( 0 == $dbr->numRows( $this->historyRes
) ) {
877 $this->historyRes
= null;
880 } elseif ( $this->historyLine
== 1 ) {
881 $this->historyRes
= $dbr->select( 'oldimage', '*',
882 array( 'oi_name' => $this->title
->getDBkey() ),
884 array( 'ORDER BY' => 'oi_timestamp DESC' )
887 $this->historyLine ++
;
889 return $dbr->fetchObject( $this->historyRes
);
893 * Reset the history pointer to the first element of the history
895 public function resetHistory() {
896 $this->historyLine
= 0;
898 if ( !is_null( $this->historyRes
) ) {
899 $this->historyRes
= null;
903 /** getHashPath inherited */
904 /** getRel inherited */
905 /** getUrlRel inherited */
906 /** getArchiveRel inherited */
907 /** getArchivePath inherited */
908 /** getThumbPath inherited */
909 /** getArchiveUrl inherited */
910 /** getThumbUrl inherited */
911 /** getArchiveVirtualUrl inherited */
912 /** getThumbVirtualUrl inherited */
913 /** isHashed inherited */
916 * Upload a file and record it in the DB
917 * @param $srcPath String: source storage path or virtual URL
918 * @param $comment String: upload description
919 * @param $pageText String: text to use for the new description page,
920 * if a new description page is created
921 * @param $flags Integer: flags for publish()
922 * @param $props Array: File properties, if known. This can be used to reduce the
923 * upload time when uploading virtual URLs for which the file info
925 * @param $timestamp String: timestamp for img_timestamp, or false to use the current time
926 * @param $user Mixed: User object or null to use $wgUser
928 * @return FileRepoStatus object. On success, the value member contains the
929 * archive name, or an empty string if it was a new file.
931 function upload( $srcPath, $comment, $pageText, $flags = 0, $props = false, $timestamp = false, $user = null ) {
934 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
935 return $this->readOnlyFatalStatus();
938 // truncate nicely or the DB will do it for us
939 // non-nicely (dangling multi-byte chars, non-truncated version in cache).
940 $comment = $wgContLang->truncate( $comment, 255 );
941 $this->lock(); // begin
942 $status = $this->publish( $srcPath, $flags );
944 if ( $status->successCount
> 0 ) {
945 # Essentially we are displacing any existing current file and saving
946 # a new current file at the old location. If just the first succeeded,
947 # we still need to displace the current DB entry and put in a new one.
948 if ( !$this->recordUpload2( $status->value
, $comment, $pageText, $props, $timestamp, $user ) ) {
949 $status->fatal( 'filenotfound', $srcPath );
953 $this->unlock(); // done
959 * Record a file upload in the upload log and the image table
962 function recordUpload( $oldver, $desc, $license = '', $copyStatus = '', $source = '',
963 $watch = false, $timestamp = false )
965 $pageText = SpecialUpload
::getInitialPageText( $desc, $license, $copyStatus, $source );
967 if ( !$this->recordUpload2( $oldver, $desc, $pageText ) ) {
973 $wgUser->addWatch( $this->getTitle() );
979 * Record a file upload in the upload log and the image table
982 function recordUpload2(
983 $oldver, $comment, $pageText, $props = false, $timestamp = false, $user = null
985 if ( is_null( $user ) ) {
990 $dbw = $this->repo
->getMasterDB();
991 $dbw->begin( __METHOD__
);
994 $props = $this->repo
->getFileProps( $this->getVirtualUrl() );
997 if ( $timestamp === false ) {
998 $timestamp = $dbw->timestamp();
1001 $props['description'] = $comment;
1002 $props['user'] = $user->getId();
1003 $props['user_text'] = $user->getName();
1004 $props['timestamp'] = wfTimestamp( TS_MW
, $timestamp ); // DB -> TS_MW
1005 $this->setProps( $props );
1008 $this->purgeThumbnails();
1010 # The file is already on its final location, remove it from the squid cache
1011 SquidUpdate
::purge( array( $this->getURL() ) );
1013 # Fail now if the file isn't there
1014 if ( !$this->fileExists
) {
1015 wfDebug( __METHOD__
. ": File " . $this->getRel() . " went missing!\n" );
1021 # Test to see if the row exists using INSERT IGNORE
1022 # This avoids race conditions by locking the row until the commit, and also
1023 # doesn't deadlock. SELECT FOR UPDATE causes a deadlock for every race condition.
1024 $dbw->insert( 'image',
1026 'img_name' => $this->getName(),
1027 'img_size' => $this->size
,
1028 'img_width' => intval( $this->width
),
1029 'img_height' => intval( $this->height
),
1030 'img_bits' => $this->bits
,
1031 'img_media_type' => $this->media_type
,
1032 'img_major_mime' => $this->major_mime
,
1033 'img_minor_mime' => $this->minor_mime
,
1034 'img_timestamp' => $timestamp,
1035 'img_description' => $comment,
1036 'img_user' => $user->getId(),
1037 'img_user_text' => $user->getName(),
1038 'img_metadata' => $this->metadata
,
1039 'img_sha1' => $this->sha1
1045 if ( $dbw->affectedRows() == 0 ) {
1046 # (bug 34993) Note: $oldver can be empty here, if the previous
1047 # version of the file was broken. Allow registration of the new
1048 # version to continue anyway, because that's better than having
1049 # an image that's not fixable by user operations.
1052 # Collision, this is an update of a file
1053 # Insert previous contents into oldimage
1054 $dbw->insertSelect( 'oldimage', 'image',
1056 'oi_name' => 'img_name',
1057 'oi_archive_name' => $dbw->addQuotes( $oldver ),
1058 'oi_size' => 'img_size',
1059 'oi_width' => 'img_width',
1060 'oi_height' => 'img_height',
1061 'oi_bits' => 'img_bits',
1062 'oi_timestamp' => 'img_timestamp',
1063 'oi_description' => 'img_description',
1064 'oi_user' => 'img_user',
1065 'oi_user_text' => 'img_user_text',
1066 'oi_metadata' => 'img_metadata',
1067 'oi_media_type' => 'img_media_type',
1068 'oi_major_mime' => 'img_major_mime',
1069 'oi_minor_mime' => 'img_minor_mime',
1070 'oi_sha1' => 'img_sha1'
1072 array( 'img_name' => $this->getName() ),
1076 # Update the current image row
1077 $dbw->update( 'image',
1079 'img_size' => $this->size
,
1080 'img_width' => intval( $this->width
),
1081 'img_height' => intval( $this->height
),
1082 'img_bits' => $this->bits
,
1083 'img_media_type' => $this->media_type
,
1084 'img_major_mime' => $this->major_mime
,
1085 'img_minor_mime' => $this->minor_mime
,
1086 'img_timestamp' => $timestamp,
1087 'img_description' => $comment,
1088 'img_user' => $user->getId(),
1089 'img_user_text' => $user->getName(),
1090 'img_metadata' => $this->metadata
,
1091 'img_sha1' => $this->sha1
1093 array( 'img_name' => $this->getName() ),
1097 # This is a new file, so update the image count
1098 DeferredUpdates
::addUpdate( SiteStatsUpdate
::factory( array( 'images' => 1 ) ) );
1101 $descTitle = $this->getTitle();
1102 $wikiPage = new WikiFilePage( $descTitle );
1103 $wikiPage->setFile( $this );
1106 $log = new LogPage( 'upload' );
1107 $action = $reupload ?
'overwrite' : 'upload';
1108 $log->addEntry( $action, $descTitle, $comment, array(), $user );
1110 if ( $descTitle->exists() ) {
1111 # Create a null revision
1112 $latest = $descTitle->getLatestRevID();
1113 $nullRevision = Revision
::newNullRevision(
1115 $descTitle->getArticleID(),
1116 $log->getRcComment(),
1119 if (!is_null($nullRevision)) {
1120 $nullRevision->insertOn( $dbw );
1122 wfRunHooks( 'NewRevisionFromEditComplete', array( $wikiPage, $nullRevision, $latest, $user ) );
1123 $wikiPage->updateRevisionOn( $dbw, $nullRevision );
1125 # Invalidate the cache for the description page
1126 $descTitle->invalidateCache();
1127 $descTitle->purgeSquid();
1129 # New file; create the description page.
1130 # There's already a log entry, so don't make a second RC entry
1131 # Squid and file cache for the description page are purged by doEdit.
1132 $wikiPage->doEdit( $pageText, $comment, EDIT_NEW | EDIT_SUPPRESS_RC
, false, $user );
1135 # Commit the transaction now, in case something goes wrong later
1136 # The most important thing is that files don't get lost, especially archives
1137 $dbw->commit( __METHOD__
);
1139 # Save to cache and purge the squid
1140 # We shall not saveToCache before the commit since otherwise
1141 # in case of a rollback there is an usable file from memcached
1142 # which in fact doesn't really exist (bug 24978)
1143 $this->saveToCache();
1145 # Hooks, hooks, the magic of hooks...
1146 wfRunHooks( 'FileUpload', array( $this, $reupload, $descTitle->exists() ) );
1148 # Invalidate cache for all pages using this file
1149 $update = new HTMLCacheUpdate( $this->getTitle(), 'imagelinks' );
1150 $update->doUpdate();
1152 # Invalidate cache for all pages that redirects on this page
1153 $redirs = $this->getTitle()->getRedirectsHere();
1155 foreach ( $redirs as $redir ) {
1156 $update = new HTMLCacheUpdate( $redir, 'imagelinks' );
1157 $update->doUpdate();
1164 * Move or copy a file to its public location. If a file exists at the
1165 * destination, move it to an archive. Returns a FileRepoStatus object with
1166 * the archive name in the "value" member on success.
1168 * The archive name should be passed through to recordUpload for database
1171 * @param $srcPath String: local filesystem path to the source image
1172 * @param $flags Integer: a bitwise combination of:
1173 * File::DELETE_SOURCE Delete the source file, i.e. move rather than copy
1174 * @return FileRepoStatus object. On success, the value member contains the
1175 * archive name, or an empty string if it was a new file.
1177 function publish( $srcPath, $flags = 0 ) {
1178 return $this->publishTo( $srcPath, $this->getRel(), $flags );
1182 * Move or copy a file to a specified location. Returns a FileRepoStatus
1183 * object with the archive name in the "value" member on success.
1185 * The archive name should be passed through to recordUpload for database
1188 * @param $srcPath String: local filesystem path to the source image
1189 * @param $dstRel String: target relative path
1190 * @param $flags Integer: a bitwise combination of:
1191 * File::DELETE_SOURCE Delete the source file, i.e. move rather than copy
1192 * @return FileRepoStatus object. On success, the value member contains the
1193 * archive name, or an empty string if it was a new file.
1195 function publishTo( $srcPath, $dstRel, $flags = 0 ) {
1196 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
1197 return $this->readOnlyFatalStatus();
1200 $this->lock(); // begin
1202 $archiveName = wfTimestamp( TS_MW
) . '!'. $this->getName();
1203 $archiveRel = 'archive/' . $this->getHashPath() . $archiveName;
1204 $flags = $flags & File
::DELETE_SOURCE ? LocalRepo
::DELETE_SOURCE
: 0;
1205 $status = $this->repo
->publish( $srcPath, $dstRel, $archiveRel, $flags );
1207 if ( $status->value
== 'new' ) {
1208 $status->value
= '';
1210 $status->value
= $archiveName;
1213 $this->unlock(); // done
1218 /** getLinksTo inherited */
1219 /** getExifData inherited */
1220 /** isLocal inherited */
1221 /** wasDeleted inherited */
1224 * Move file to the new title
1226 * Move current, old version and all thumbnails
1227 * to the new filename. Old file is deleted.
1229 * Cache purging is done; checks for validity
1230 * and logging are caller's responsibility
1232 * @param $target Title New file name
1233 * @return FileRepoStatus object.
1235 function move( $target ) {
1236 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
1237 return $this->readOnlyFatalStatus();
1240 wfDebugLog( 'imagemove', "Got request to move {$this->name} to " . $target->getText() );
1241 $batch = new LocalFileMoveBatch( $this, $target );
1243 $this->lock(); // begin
1244 $batch->addCurrent();
1245 $archiveNames = $batch->addOlds();
1246 $status = $batch->execute();
1247 $this->unlock(); // done
1249 wfDebugLog( 'imagemove', "Finished moving {$this->name}" );
1251 $this->purgeEverything();
1252 foreach ( $archiveNames as $archiveName ) {
1253 $this->purgeOldThumbnails( $archiveName );
1255 if ( $status->isOK() ) {
1256 // Now switch the object
1257 $this->title
= $target;
1258 // Force regeneration of the name and hashpath
1259 unset( $this->name
);
1260 unset( $this->hashPath
);
1261 // Purge the new image
1262 $this->purgeEverything();
1269 * Delete all versions of the file.
1271 * Moves the files into an archive directory (or deletes them)
1272 * and removes the database rows.
1274 * Cache purging is done; logging is caller's responsibility.
1278 * @return FileRepoStatus object.
1280 function delete( $reason, $suppress = false ) {
1281 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
1282 return $this->readOnlyFatalStatus();
1285 $batch = new LocalFileDeleteBatch( $this, $reason, $suppress );
1287 $this->lock(); // begin
1288 $batch->addCurrent();
1289 # Get old version relative paths
1290 $archiveNames = $batch->addOlds();
1291 $status = $batch->execute();
1292 $this->unlock(); // done
1294 if ( $status->isOK() ) {
1295 DeferredUpdates
::addUpdate( SiteStatsUpdate
::factory( array( 'images' => -1 ) ) );
1298 $this->purgeEverything();
1299 foreach ( $archiveNames as $archiveName ) {
1300 $this->purgeOldThumbnails( $archiveName );
1307 * Delete an old version of the file.
1309 * Moves the file into an archive directory (or deletes it)
1310 * and removes the database row.
1312 * Cache purging is done; logging is caller's responsibility.
1314 * @param $archiveName String
1315 * @param $reason String
1316 * @param $suppress Boolean
1317 * @throws MWException or FSException on database or file store failure
1318 * @return FileRepoStatus object.
1320 function deleteOld( $archiveName, $reason, $suppress = false ) {
1321 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
1322 return $this->readOnlyFatalStatus();
1325 $batch = new LocalFileDeleteBatch( $this, $reason, $suppress );
1327 $this->lock(); // begin
1328 $batch->addOld( $archiveName );
1329 $status = $batch->execute();
1330 $this->unlock(); // done
1332 $this->purgeOldThumbnails( $archiveName );
1333 if ( $status->isOK() ) {
1334 $this->purgeDescription();
1335 $this->purgeHistory();
1342 * Restore all or specified deleted revisions to the given file.
1343 * Permissions and logging are left to the caller.
1345 * May throw database exceptions on error.
1347 * @param $versions array set of record ids of deleted items to restore,
1348 * or empty to restore all revisions.
1349 * @param $unsuppress Boolean
1350 * @return FileRepoStatus
1352 function restore( $versions = array(), $unsuppress = false ) {
1353 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
1354 return $this->readOnlyFatalStatus();
1357 $batch = new LocalFileRestoreBatch( $this, $unsuppress );
1359 $this->lock(); // begin
1363 $batch->addIds( $versions );
1365 $status = $batch->execute();
1366 if ( $status->isGood() ) {
1367 $cleanupStatus = $batch->cleanup();
1368 $cleanupStatus->successCount
= 0;
1369 $cleanupStatus->failCount
= 0;
1370 $status->merge( $cleanupStatus );
1372 $this->unlock(); // done
1377 /** isMultipage inherited */
1378 /** pageCount inherited */
1379 /** scaleHeight inherited */
1380 /** getImageSize inherited */
1383 * Get the URL of the file description page.
1386 function getDescriptionUrl() {
1387 return $this->title
->getLocalUrl();
1391 * Get the HTML text of the description page
1392 * This is not used by ImagePage for local files, since (among other things)
1393 * it skips the parser cache.
1394 * @return bool|mixed
1396 function getDescriptionText() {
1398 $revision = Revision
::newFromTitle( $this->title
);
1399 if ( !$revision ) return false;
1400 $text = $revision->getText();
1401 if ( !$text ) return false;
1402 $pout = $wgParser->parse( $text, $this->title
, new ParserOptions() );
1403 return $pout->getText();
1406 function getDescription() {
1408 return $this->description
;
1411 function getTimestamp() {
1413 return $this->timestamp
;
1416 function getSha1() {
1418 // Initialise now if necessary
1419 if ( $this->sha1
== '' && $this->fileExists
) {
1420 $this->lock(); // begin
1422 $this->sha1
= $this->repo
->getFileSha1( $this->getPath() );
1423 if ( !wfReadOnly() && strval( $this->sha1
) != '' ) {
1424 $dbw = $this->repo
->getMasterDB();
1425 $dbw->update( 'image',
1426 array( 'img_sha1' => $this->sha1
),
1427 array( 'img_name' => $this->getName() ),
1429 $this->saveToCache();
1432 $this->unlock(); // done
1438 function isCacheable() {
1440 return strlen( $this->metadata
) <= self
::CACHE_FIELD_MAX_LEN
; // avoid OOMs
1444 * Start a transaction and lock the image for update
1445 * Increments a reference counter if the lock is already held
1446 * @return boolean True if the image exists, false otherwise
1449 $dbw = $this->repo
->getMasterDB();
1451 if ( !$this->locked
) {
1452 $dbw->begin( __METHOD__
);
1456 return $dbw->selectField( 'image', '1',
1457 array( 'img_name' => $this->getName() ), __METHOD__
, array( 'FOR UPDATE' ) );
1461 * Decrement the lock reference count. If the reference count is reduced to zero, commits
1462 * the transaction and thereby releases the image lock.
1465 if ( $this->locked
) {
1467 if ( !$this->locked
) {
1468 $dbw = $this->repo
->getMasterDB();
1469 $dbw->commit( __METHOD__
);
1475 * Roll back the DB transaction and mark the image unlocked
1477 function unlockAndRollback() {
1478 $this->locked
= false;
1479 $dbw = $this->repo
->getMasterDB();
1480 $dbw->rollback( __METHOD__
);
1486 protected function readOnlyFatalStatus() {
1487 return $this->getRepo()->newFatal( 'filereadonlyerror', $this->getName(),
1488 $this->getRepo()->getName(), $this->getRepo()->getReadOnlyReason() );
1490 } // LocalFile class
1492 # ------------------------------------------------------------------------------
1495 * Helper class for file deletion
1496 * @ingroup FileAbstraction
1498 class LocalFileDeleteBatch
{
1505 var $reason, $srcRels = array(), $archiveUrls = array(), $deletionBatch, $suppress;
1508 function __construct( File
$file, $reason = '', $suppress = false ) {
1509 $this->file
= $file;
1510 $this->reason
= $reason;
1511 $this->suppress
= $suppress;
1512 $this->status
= $file->repo
->newGood();
1515 function addCurrent() {
1516 $this->srcRels
['.'] = $this->file
->getRel();
1519 function addOld( $oldName ) {
1520 $this->srcRels
[$oldName] = $this->file
->getArchiveRel( $oldName );
1521 $this->archiveUrls
[] = $this->file
->getArchiveUrl( $oldName );
1525 * Add the old versions of the image to the batch
1526 * @return Array List of archive names from old versions
1528 function addOlds() {
1529 $archiveNames = array();
1531 $dbw = $this->file
->repo
->getMasterDB();
1532 $result = $dbw->select( 'oldimage',
1533 array( 'oi_archive_name' ),
1534 array( 'oi_name' => $this->file
->getName() ),
1538 foreach ( $result as $row ) {
1539 $this->addOld( $row->oi_archive_name
);
1540 $archiveNames[] = $row->oi_archive_name
;
1543 return $archiveNames;
1546 function getOldRels() {
1547 if ( !isset( $this->srcRels
['.'] ) ) {
1548 $oldRels =& $this->srcRels
;
1549 $deleteCurrent = false;
1551 $oldRels = $this->srcRels
;
1552 unset( $oldRels['.'] );
1553 $deleteCurrent = true;
1556 return array( $oldRels, $deleteCurrent );
1559 protected function getHashes() {
1561 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
1563 if ( $deleteCurrent ) {
1564 $hashes['.'] = $this->file
->getSha1();
1567 if ( count( $oldRels ) ) {
1568 $dbw = $this->file
->repo
->getMasterDB();
1569 $res = $dbw->select(
1571 array( 'oi_archive_name', 'oi_sha1' ),
1572 'oi_archive_name IN (' . $dbw->makeList( array_keys( $oldRels ) ) . ')',
1576 foreach ( $res as $row ) {
1577 if ( rtrim( $row->oi_sha1
, "\0" ) === '' ) {
1578 // Get the hash from the file
1579 $oldUrl = $this->file
->getArchiveVirtualUrl( $row->oi_archive_name
);
1580 $props = $this->file
->repo
->getFileProps( $oldUrl );
1582 if ( $props['fileExists'] ) {
1583 // Upgrade the oldimage row
1584 $dbw->update( 'oldimage',
1585 array( 'oi_sha1' => $props['sha1'] ),
1586 array( 'oi_name' => $this->file
->getName(), 'oi_archive_name' => $row->oi_archive_name
),
1588 $hashes[$row->oi_archive_name
] = $props['sha1'];
1590 $hashes[$row->oi_archive_name
] = false;
1593 $hashes[$row->oi_archive_name
] = $row->oi_sha1
;
1598 $missing = array_diff_key( $this->srcRels
, $hashes );
1600 foreach ( $missing as $name => $rel ) {
1601 $this->status
->error( 'filedelete-old-unregistered', $name );
1604 foreach ( $hashes as $name => $hash ) {
1606 $this->status
->error( 'filedelete-missing', $this->srcRels
[$name] );
1607 unset( $hashes[$name] );
1614 function doDBInserts() {
1617 $dbw = $this->file
->repo
->getMasterDB();
1618 $encTimestamp = $dbw->addQuotes( $dbw->timestamp() );
1619 $encUserId = $dbw->addQuotes( $wgUser->getId() );
1620 $encReason = $dbw->addQuotes( $this->reason
);
1621 $encGroup = $dbw->addQuotes( 'deleted' );
1622 $ext = $this->file
->getExtension();
1623 $dotExt = $ext === '' ?
'' : ".$ext";
1624 $encExt = $dbw->addQuotes( $dotExt );
1625 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
1627 // Bitfields to further suppress the content
1628 if ( $this->suppress
) {
1630 // This should be 15...
1631 $bitfield |
= Revision
::DELETED_TEXT
;
1632 $bitfield |
= Revision
::DELETED_COMMENT
;
1633 $bitfield |
= Revision
::DELETED_USER
;
1634 $bitfield |
= Revision
::DELETED_RESTRICTED
;
1636 $bitfield = 'oi_deleted';
1639 if ( $deleteCurrent ) {
1640 $concat = $dbw->buildConcat( array( "img_sha1", $encExt ) );
1641 $where = array( 'img_name' => $this->file
->getName() );
1642 $dbw->insertSelect( 'filearchive', 'image',
1644 'fa_storage_group' => $encGroup,
1645 'fa_storage_key' => "CASE WHEN img_sha1='' THEN '' ELSE $concat END",
1646 'fa_deleted_user' => $encUserId,
1647 'fa_deleted_timestamp' => $encTimestamp,
1648 'fa_deleted_reason' => $encReason,
1649 'fa_deleted' => $this->suppress ?
$bitfield : 0,
1651 'fa_name' => 'img_name',
1652 'fa_archive_name' => 'NULL',
1653 'fa_size' => 'img_size',
1654 'fa_width' => 'img_width',
1655 'fa_height' => 'img_height',
1656 'fa_metadata' => 'img_metadata',
1657 'fa_bits' => 'img_bits',
1658 'fa_media_type' => 'img_media_type',
1659 'fa_major_mime' => 'img_major_mime',
1660 'fa_minor_mime' => 'img_minor_mime',
1661 'fa_description' => 'img_description',
1662 'fa_user' => 'img_user',
1663 'fa_user_text' => 'img_user_text',
1664 'fa_timestamp' => 'img_timestamp'
1665 ), $where, __METHOD__
);
1668 if ( count( $oldRels ) ) {
1669 $concat = $dbw->buildConcat( array( "oi_sha1", $encExt ) );
1671 'oi_name' => $this->file
->getName(),
1672 'oi_archive_name IN (' . $dbw->makeList( array_keys( $oldRels ) ) . ')' );
1673 $dbw->insertSelect( 'filearchive', 'oldimage',
1675 'fa_storage_group' => $encGroup,
1676 'fa_storage_key' => "CASE WHEN oi_sha1='' THEN '' ELSE $concat END",
1677 'fa_deleted_user' => $encUserId,
1678 'fa_deleted_timestamp' => $encTimestamp,
1679 'fa_deleted_reason' => $encReason,
1680 'fa_deleted' => $this->suppress ?
$bitfield : 'oi_deleted',
1682 'fa_name' => 'oi_name',
1683 'fa_archive_name' => 'oi_archive_name',
1684 'fa_size' => 'oi_size',
1685 'fa_width' => 'oi_width',
1686 'fa_height' => 'oi_height',
1687 'fa_metadata' => 'oi_metadata',
1688 'fa_bits' => 'oi_bits',
1689 'fa_media_type' => 'oi_media_type',
1690 'fa_major_mime' => 'oi_major_mime',
1691 'fa_minor_mime' => 'oi_minor_mime',
1692 'fa_description' => 'oi_description',
1693 'fa_user' => 'oi_user',
1694 'fa_user_text' => 'oi_user_text',
1695 'fa_timestamp' => 'oi_timestamp',
1696 ), $where, __METHOD__
);
1700 function doDBDeletes() {
1701 $dbw = $this->file
->repo
->getMasterDB();
1702 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
1704 if ( count( $oldRels ) ) {
1705 $dbw->delete( 'oldimage',
1707 'oi_name' => $this->file
->getName(),
1708 'oi_archive_name' => array_keys( $oldRels )
1712 if ( $deleteCurrent ) {
1713 $dbw->delete( 'image', array( 'img_name' => $this->file
->getName() ), __METHOD__
);
1718 * Run the transaction
1719 * @return FileRepoStatus
1721 function execute() {
1723 wfProfileIn( __METHOD__
);
1725 $this->file
->lock();
1726 // Leave private files alone
1727 $privateFiles = array();
1728 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
1729 $dbw = $this->file
->repo
->getMasterDB();
1731 if ( !empty( $oldRels ) ) {
1732 $res = $dbw->select( 'oldimage',
1733 array( 'oi_archive_name' ),
1734 array( 'oi_name' => $this->file
->getName(),
1735 'oi_archive_name IN (' . $dbw->makeList( array_keys( $oldRels ) ) . ')',
1736 $dbw->bitAnd( 'oi_deleted', File
::DELETED_FILE
) => File
::DELETED_FILE
),
1739 foreach ( $res as $row ) {
1740 $privateFiles[$row->oi_archive_name
] = 1;
1743 // Prepare deletion batch
1744 $hashes = $this->getHashes();
1745 $this->deletionBatch
= array();
1746 $ext = $this->file
->getExtension();
1747 $dotExt = $ext === '' ?
'' : ".$ext";
1749 foreach ( $this->srcRels
as $name => $srcRel ) {
1750 // Skip files that have no hash (missing source).
1751 // Keep private files where they are.
1752 if ( isset( $hashes[$name] ) && !array_key_exists( $name, $privateFiles ) ) {
1753 $hash = $hashes[$name];
1754 $key = $hash . $dotExt;
1755 $dstRel = $this->file
->repo
->getDeletedHashPath( $key ) . $key;
1756 $this->deletionBatch
[$name] = array( $srcRel, $dstRel );
1760 // Lock the filearchive rows so that the files don't get deleted by a cleanup operation
1761 // We acquire this lock by running the inserts now, before the file operations.
1763 // This potentially has poor lock contention characteristics -- an alternative
1764 // scheme would be to insert stub filearchive entries with no fa_name and commit
1765 // them in a separate transaction, then run the file ops, then update the fa_name fields.
1766 $this->doDBInserts();
1768 // Removes non-existent file from the batch, so we don't get errors.
1769 $this->deletionBatch
= $this->removeNonexistentFiles( $this->deletionBatch
);
1771 // Execute the file deletion batch
1772 $status = $this->file
->repo
->deleteBatch( $this->deletionBatch
);
1774 if ( !$status->isGood() ) {
1775 $this->status
->merge( $status );
1778 if ( !$this->status
->isOK() ) {
1779 // Critical file deletion error
1780 // Roll back inserts, release lock and abort
1781 // TODO: delete the defunct filearchive rows if we are using a non-transactional DB
1782 $this->file
->unlockAndRollback();
1783 wfProfileOut( __METHOD__
);
1784 return $this->status
;
1787 // Delete image/oldimage rows
1788 $this->doDBDeletes();
1790 // Commit and return
1791 $this->file
->unlock();
1792 wfProfileOut( __METHOD__
);
1794 return $this->status
;
1798 * Removes non-existent files from a deletion batch.
1801 function removeNonexistentFiles( $batch ) {
1802 $files = $newBatch = array();
1804 foreach ( $batch as $batchItem ) {
1805 list( $src, $dest ) = $batchItem;
1806 $files[$src] = $this->file
->repo
->getVirtualUrl( 'public' ) . '/' . rawurlencode( $src );
1809 $result = $this->file
->repo
->fileExistsBatch( $files );
1811 foreach ( $batch as $batchItem ) {
1812 if ( $result[$batchItem[0]] ) {
1813 $newBatch[] = $batchItem;
1821 # ------------------------------------------------------------------------------
1824 * Helper class for file undeletion
1825 * @ingroup FileAbstraction
1827 class LocalFileRestoreBatch
{
1833 var $cleanupBatch, $ids, $all, $unsuppress = false;
1835 function __construct( File
$file, $unsuppress = false ) {
1836 $this->file
= $file;
1837 $this->cleanupBatch
= $this->ids
= array();
1838 $this->ids
= array();
1839 $this->unsuppress
= $unsuppress;
1845 function addId( $fa_id ) {
1846 $this->ids
[] = $fa_id;
1850 * Add a whole lot of files by ID
1852 function addIds( $ids ) {
1853 $this->ids
= array_merge( $this->ids
, $ids );
1857 * Add all revisions of the file
1864 * Run the transaction, except the cleanup batch.
1865 * The cleanup batch should be run in a separate transaction, because it locks different
1866 * rows and there's no need to keep the image row locked while it's acquiring those locks
1867 * The caller may have its own transaction open.
1868 * So we save the batch and let the caller call cleanup()
1869 * @return FileRepoStatus
1871 function execute() {
1874 if ( !$this->all
&& !$this->ids
) {
1876 return $this->file
->repo
->newGood();
1879 $exists = $this->file
->lock();
1880 $dbw = $this->file
->repo
->getMasterDB();
1881 $status = $this->file
->repo
->newGood();
1883 // Fetch all or selected archived revisions for the file,
1884 // sorted from the most recent to the oldest.
1885 $conditions = array( 'fa_name' => $this->file
->getName() );
1887 if ( !$this->all
) {
1888 $conditions[] = 'fa_id IN (' . $dbw->makeList( $this->ids
) . ')';
1891 $result = $dbw->select( 'filearchive', '*',
1894 array( 'ORDER BY' => 'fa_timestamp DESC' )
1897 $idsPresent = array();
1898 $storeBatch = array();
1899 $insertBatch = array();
1900 $insertCurrent = false;
1901 $deleteIds = array();
1903 $archiveNames = array();
1905 foreach ( $result as $row ) {
1906 $idsPresent[] = $row->fa_id
;
1908 if ( $row->fa_name
!= $this->file
->getName() ) {
1909 $status->error( 'undelete-filename-mismatch', $wgLang->timeanddate( $row->fa_timestamp
) );
1910 $status->failCount++
;
1914 if ( $row->fa_storage_key
== '' ) {
1915 // Revision was missing pre-deletion
1916 $status->error( 'undelete-bad-store-key', $wgLang->timeanddate( $row->fa_timestamp
) );
1917 $status->failCount++
;
1921 $deletedRel = $this->file
->repo
->getDeletedHashPath( $row->fa_storage_key
) . $row->fa_storage_key
;
1922 $deletedUrl = $this->file
->repo
->getVirtualUrl() . '/deleted/' . $deletedRel;
1924 $sha1 = substr( $row->fa_storage_key
, 0, strcspn( $row->fa_storage_key
, '.' ) );
1927 if ( strlen( $sha1 ) == 32 && $sha1[0] == '0' ) {
1928 $sha1 = substr( $sha1, 1 );
1931 if ( is_null( $row->fa_major_mime
) ||
$row->fa_major_mime
== 'unknown'
1932 ||
is_null( $row->fa_minor_mime
) ||
$row->fa_minor_mime
== 'unknown'
1933 ||
is_null( $row->fa_media_type
) ||
$row->fa_media_type
== 'UNKNOWN'
1934 ||
is_null( $row->fa_metadata
) ) {
1935 // Refresh our metadata
1936 // Required for a new current revision; nice for older ones too. :)
1937 $props = RepoGroup
::singleton()->getFileProps( $deletedUrl );
1940 'minor_mime' => $row->fa_minor_mime
,
1941 'major_mime' => $row->fa_major_mime
,
1942 'media_type' => $row->fa_media_type
,
1943 'metadata' => $row->fa_metadata
1947 if ( $first && !$exists ) {
1948 // This revision will be published as the new current version
1949 $destRel = $this->file
->getRel();
1950 $insertCurrent = array(
1951 'img_name' => $row->fa_name
,
1952 'img_size' => $row->fa_size
,
1953 'img_width' => $row->fa_width
,
1954 'img_height' => $row->fa_height
,
1955 'img_metadata' => $props['metadata'],
1956 'img_bits' => $row->fa_bits
,
1957 'img_media_type' => $props['media_type'],
1958 'img_major_mime' => $props['major_mime'],
1959 'img_minor_mime' => $props['minor_mime'],
1960 'img_description' => $row->fa_description
,
1961 'img_user' => $row->fa_user
,
1962 'img_user_text' => $row->fa_user_text
,
1963 'img_timestamp' => $row->fa_timestamp
,
1967 // The live (current) version cannot be hidden!
1968 if ( !$this->unsuppress
&& $row->fa_deleted
) {
1969 $storeBatch[] = array( $deletedUrl, 'public', $destRel );
1970 $this->cleanupBatch
[] = $row->fa_storage_key
;
1973 $archiveName = $row->fa_archive_name
;
1975 if ( $archiveName == '' ) {
1976 // This was originally a current version; we
1977 // have to devise a new archive name for it.
1978 // Format is <timestamp of archiving>!<name>
1979 $timestamp = wfTimestamp( TS_UNIX
, $row->fa_deleted_timestamp
);
1982 $archiveName = wfTimestamp( TS_MW
, $timestamp ) . '!' . $row->fa_name
;
1984 } while ( isset( $archiveNames[$archiveName] ) );
1987 $archiveNames[$archiveName] = true;
1988 $destRel = $this->file
->getArchiveRel( $archiveName );
1989 $insertBatch[] = array(
1990 'oi_name' => $row->fa_name
,
1991 'oi_archive_name' => $archiveName,
1992 'oi_size' => $row->fa_size
,
1993 'oi_width' => $row->fa_width
,
1994 'oi_height' => $row->fa_height
,
1995 'oi_bits' => $row->fa_bits
,
1996 'oi_description' => $row->fa_description
,
1997 'oi_user' => $row->fa_user
,
1998 'oi_user_text' => $row->fa_user_text
,
1999 'oi_timestamp' => $row->fa_timestamp
,
2000 'oi_metadata' => $props['metadata'],
2001 'oi_media_type' => $props['media_type'],
2002 'oi_major_mime' => $props['major_mime'],
2003 'oi_minor_mime' => $props['minor_mime'],
2004 'oi_deleted' => $this->unsuppress ?
0 : $row->fa_deleted
,
2005 'oi_sha1' => $sha1 );
2008 $deleteIds[] = $row->fa_id
;
2010 if ( !$this->unsuppress
&& $row->fa_deleted
& File
::DELETED_FILE
) {
2011 // private files can stay where they are
2012 $status->successCount++
;
2014 $storeBatch[] = array( $deletedUrl, 'public', $destRel );
2015 $this->cleanupBatch
[] = $row->fa_storage_key
;
2023 // Add a warning to the status object for missing IDs
2024 $missingIds = array_diff( $this->ids
, $idsPresent );
2026 foreach ( $missingIds as $id ) {
2027 $status->error( 'undelete-missing-filearchive', $id );
2030 // Remove missing files from batch, so we don't get errors when undeleting them
2031 $storeBatch = $this->removeNonexistentFiles( $storeBatch );
2033 // Run the store batch
2034 // Use the OVERWRITE_SAME flag to smooth over a common error
2035 $storeStatus = $this->file
->repo
->storeBatch( $storeBatch, FileRepo
::OVERWRITE_SAME
);
2036 $status->merge( $storeStatus );
2038 if ( !$status->isGood() ) {
2039 // Even if some files could be copied, fail entirely as that is the
2040 // easiest thing to do without data loss
2041 $this->cleanupFailedBatch( $storeStatus, $storeBatch );
2042 $status->ok
= false;
2043 $this->file
->unlock();
2048 // Run the DB updates
2049 // Because we have locked the image row, key conflicts should be rare.
2050 // If they do occur, we can roll back the transaction at this time with
2051 // no data loss, but leaving unregistered files scattered throughout the
2053 // This is not ideal, which is why it's important to lock the image row.
2054 if ( $insertCurrent ) {
2055 $dbw->insert( 'image', $insertCurrent, __METHOD__
);
2058 if ( $insertBatch ) {
2059 $dbw->insert( 'oldimage', $insertBatch, __METHOD__
);
2063 $dbw->delete( 'filearchive',
2064 array( 'fa_id IN (' . $dbw->makeList( $deleteIds ) . ')' ),
2068 // If store batch is empty (all files are missing), deletion is to be considered successful
2069 if ( $status->successCount
> 0 ||
!$storeBatch ) {
2071 wfDebug( __METHOD__
. " restored {$status->successCount} items, creating a new current\n" );
2073 DeferredUpdates
::addUpdate( SiteStatsUpdate
::factory( array( 'images' => 1 ) ) );
2075 $this->file
->purgeEverything();
2077 wfDebug( __METHOD__
. " restored {$status->successCount} as archived versions\n" );
2078 $this->file
->purgeDescription();
2079 $this->file
->purgeHistory();
2083 $this->file
->unlock();
2089 * Removes non-existent files from a store batch.
2092 function removeNonexistentFiles( $triplets ) {
2093 $files = $filteredTriplets = array();
2094 foreach ( $triplets as $file )
2095 $files[$file[0]] = $file[0];
2097 $result = $this->file
->repo
->fileExistsBatch( $files );
2099 foreach ( $triplets as $file ) {
2100 if ( $result[$file[0]] ) {
2101 $filteredTriplets[] = $file;
2105 return $filteredTriplets;
2109 * Removes non-existent files from a cleanup batch.
2112 function removeNonexistentFromCleanup( $batch ) {
2113 $files = $newBatch = array();
2114 $repo = $this->file
->repo
;
2116 foreach ( $batch as $file ) {
2117 $files[$file] = $repo->getVirtualUrl( 'deleted' ) . '/' .
2118 rawurlencode( $repo->getDeletedHashPath( $file ) . $file );
2121 $result = $repo->fileExistsBatch( $files );
2123 foreach ( $batch as $file ) {
2124 if ( $result[$file] ) {
2125 $newBatch[] = $file;
2133 * Delete unused files in the deleted zone.
2134 * This should be called from outside the transaction in which execute() was called.
2135 * @return FileRepoStatus|void
2137 function cleanup() {
2138 if ( !$this->cleanupBatch
) {
2139 return $this->file
->repo
->newGood();
2142 $this->cleanupBatch
= $this->removeNonexistentFromCleanup( $this->cleanupBatch
);
2144 $status = $this->file
->repo
->cleanupDeletedBatch( $this->cleanupBatch
);
2150 * Cleanup a failed batch. The batch was only partially successful, so
2151 * rollback by removing all items that were succesfully copied.
2153 * @param Status $storeStatus
2154 * @param array $storeBatch
2156 function cleanupFailedBatch( $storeStatus, $storeBatch ) {
2157 $cleanupBatch = array();
2159 foreach ( $storeStatus->success
as $i => $success ) {
2160 // Check if this item of the batch was successfully copied
2162 // Item was successfully copied and needs to be removed again
2163 // Extract ($dstZone, $dstRel) from the batch
2164 $cleanupBatch[] = array( $storeBatch[$i][1], $storeBatch[$i][2] );
2167 $this->file
->repo
->cleanupBatch( $cleanupBatch );
2171 # ------------------------------------------------------------------------------
2174 * Helper class for file movement
2175 * @ingroup FileAbstraction
2177 class LocalFileMoveBatch
{
2189 var $cur, $olds, $oldCount, $archive, $db;
2191 function __construct( File
$file, Title
$target ) {
2192 $this->file
= $file;
2193 $this->target
= $target;
2194 $this->oldHash
= $this->file
->repo
->getHashPath( $this->file
->getName() );
2195 $this->newHash
= $this->file
->repo
->getHashPath( $this->target
->getDBkey() );
2196 $this->oldName
= $this->file
->getName();
2197 $this->newName
= $this->file
->repo
->getNameFromTitle( $this->target
);
2198 $this->oldRel
= $this->oldHash
. $this->oldName
;
2199 $this->newRel
= $this->newHash
. $this->newName
;
2200 $this->db
= $file->repo
->getMasterDb();
2204 * Add the current image to the batch
2206 function addCurrent() {
2207 $this->cur
= array( $this->oldRel
, $this->newRel
);
2211 * Add the old versions of the image to the batch
2212 * @return Array List of archive names from old versions
2214 function addOlds() {
2215 $archiveBase = 'archive';
2216 $this->olds
= array();
2217 $this->oldCount
= 0;
2218 $archiveNames = array();
2220 $result = $this->db
->select( 'oldimage',
2221 array( 'oi_archive_name', 'oi_deleted' ),
2222 array( 'oi_name' => $this->oldName
),
2226 foreach ( $result as $row ) {
2227 $archiveNames[] = $row->oi_archive_name
;
2228 $oldName = $row->oi_archive_name
;
2229 $bits = explode( '!', $oldName, 2 );
2231 if ( count( $bits ) != 2 ) {
2232 wfDebug( "Old file name missing !: '$oldName' \n" );
2236 list( $timestamp, $filename ) = $bits;
2238 if ( $this->oldName
!= $filename ) {
2239 wfDebug( "Old file name doesn't match: '$oldName' \n" );
2245 // Do we want to add those to oldCount?
2246 if ( $row->oi_deleted
& File
::DELETED_FILE
) {
2250 $this->olds
[] = array(
2251 "{$archiveBase}/{$this->oldHash}{$oldName}",
2252 "{$archiveBase}/{$this->newHash}{$timestamp}!{$this->newName}"
2256 return $archiveNames;
2261 * @return FileRepoStatus
2263 function execute() {
2264 $repo = $this->file
->repo
;
2265 $status = $repo->newGood();
2267 $triplets = $this->getMoveTriplets();
2268 $triplets = $this->removeNonexistentFiles( $triplets );
2270 // Copy the files into their new location
2271 $statusMove = $repo->storeBatch( $triplets );
2272 wfDebugLog( 'imagemove', "Moved files for {$this->file->getName()}: {$statusMove->successCount} successes, {$statusMove->failCount} failures" );
2273 if ( !$statusMove->isGood() ) {
2274 wfDebugLog( 'imagemove', "Error in moving files: " . $statusMove->getWikiText() );
2275 $this->cleanupTarget( $triplets );
2276 $statusMove->ok
= false;
2280 $this->file
->lock(); // begin
2281 $statusDb = $this->doDBUpdates();
2282 wfDebugLog( 'imagemove', "Renamed {$this->file->getName()} in database: {$statusDb->successCount} successes, {$statusDb->failCount} failures" );
2283 if ( !$statusDb->isGood() ) {
2284 $this->file
->unlockAndRollback();
2285 // Something went wrong with the DB updates, so remove the target files
2286 $this->cleanupTarget( $triplets );
2287 $statusDb->ok
= false;
2290 $this->file
->unlock(); // done
2292 // Everything went ok, remove the source files
2293 $this->cleanupSource( $triplets );
2295 $status->merge( $statusDb );
2296 $status->merge( $statusMove );
2302 * Do the database updates and return a new FileRepoStatus indicating how
2303 * many rows where updated.
2305 * @return FileRepoStatus
2307 function doDBUpdates() {
2308 $repo = $this->file
->repo
;
2309 $status = $repo->newGood();
2312 // Update current image
2315 array( 'img_name' => $this->newName
),
2316 array( 'img_name' => $this->oldName
),
2320 if ( $dbw->affectedRows() ) {
2321 $status->successCount++
;
2323 $status->failCount++
;
2324 $status->fatal( 'imageinvalidfilename' );
2328 // Update old images
2332 'oi_name' => $this->newName
,
2333 'oi_archive_name = ' . $dbw->strreplace( 'oi_archive_name',
2334 $dbw->addQuotes( $this->oldName
), $dbw->addQuotes( $this->newName
) ),
2336 array( 'oi_name' => $this->oldName
),
2340 $affected = $dbw->affectedRows();
2341 $total = $this->oldCount
;
2342 $status->successCount +
= $affected;
2343 // Bug 34934: $total is based on files that actually exist.
2344 // There may be more DB rows than such files, in which case $affected
2345 // can be greater than $total. We use max() to avoid negatives here.
2346 $status->failCount +
= max( 0, $total - $affected );
2347 if ( $status->failCount
) {
2348 $status->error( 'imageinvalidfilename' );
2355 * Generate triplets for FileRepo::storeBatch().
2358 function getMoveTriplets() {
2359 $moves = array_merge( array( $this->cur
), $this->olds
);
2360 $triplets = array(); // The format is: (srcUrl, destZone, destUrl)
2362 foreach ( $moves as $move ) {
2363 // $move: (oldRelativePath, newRelativePath)
2364 $srcUrl = $this->file
->repo
->getVirtualUrl() . '/public/' . rawurlencode( $move[0] );
2365 $triplets[] = array( $srcUrl, 'public', $move[1] );
2366 wfDebugLog( 'imagemove', "Generated move triplet for {$this->file->getName()}: {$srcUrl} :: public :: {$move[1]}" );
2373 * Removes non-existent files from move batch.
2376 function removeNonexistentFiles( $triplets ) {
2379 foreach ( $triplets as $file ) {
2380 $files[$file[0]] = $file[0];
2383 $result = $this->file
->repo
->fileExistsBatch( $files );
2384 $filteredTriplets = array();
2386 foreach ( $triplets as $file ) {
2387 if ( $result[$file[0]] ) {
2388 $filteredTriplets[] = $file;
2390 wfDebugLog( 'imagemove', "File {$file[0]} does not exist" );
2394 return $filteredTriplets;
2398 * Cleanup a partially moved array of triplets by deleting the target
2399 * files. Called if something went wrong half way.
2401 function cleanupTarget( $triplets ) {
2402 // Create dest pairs from the triplets
2404 foreach ( $triplets as $triplet ) {
2405 $pairs[] = array( $triplet[1], $triplet[2] );
2408 $this->file
->repo
->cleanupBatch( $pairs );
2412 * Cleanup a fully moved array of triplets by deleting the source files.
2413 * Called at the end of the move process if everything else went ok.
2415 function cleanupSource( $triplets ) {
2416 // Create source file names from the triplets
2418 foreach ( $triplets as $triplet ) {
2419 $files[] = $triplet[0];
2422 $this->file
->repo
->cleanupBatch( $files );