3 * Local file in the wiki's own database
10 * Bump this number when serialized cache records may be incompatible.
12 define( 'MW_FILE_VERSION', 8 );
15 * Class to represent a local file in the wiki's own database
17 * Provides methods to retrieve paths (physical, logical, URL),
18 * to generate image thumbnails or for uploading.
20 * Note that only the repo object knows what its file class is called. You should
21 * never name a file class explictly outside of the repo class. Instead use the
22 * repo's factory functions to generate file objects, for example:
24 * RepoGroup::singleton()->getLocalRepo()->newFile($title);
26 * The convenience functions wfLocalFile() and wfFindFile() should be sufficient
31 class LocalFile
extends File
{
36 $fileExists, # does the file file exist on disk? (loadFromXxx)
37 $historyLine, # Number of line to return by nextHistoryLine() (constructor)
38 $historyRes, # result of the query for the file's history (nextHistoryLine)
41 $bits, # --- returned by getimagesize (loadFromXxx)
43 $media_type, # MEDIATYPE_xxx (bitmap, drawing, audio...)
44 $mime, # MIME type, determined by MimeMagic::guessMimeType
45 $major_mime, # Major mime type
46 $minor_mime, # Minor mime type
47 $size, # Size in bytes (loadFromXxx)
48 $metadata, # Handler-specific metadata
49 $timestamp, # Upload timestamp
50 $sha1, # SHA-1 base 36 content hash
51 $user, $user_text, # User, who uploaded the file
52 $description, # Description of current revision of the file
53 $dataLoaded, # Whether or not all this has been loaded from the database (loadFromXxx)
54 $upgraded, # Whether the row was upgraded on load
55 $locked, # True if the image row is locked
56 $missing, # True if file is not present in file system. Not to be cached in memcached
57 $deleted; # Bitfield akin to rev_deleted
62 * Create a LocalFile from a title
63 * Do not call this except from inside a repo class.
65 * Note: $unused param is only here to avoid an E_STRICT
67 static function newFromTitle( $title, $repo, $unused = null ) {
68 return new self( $title, $repo );
72 * Create a LocalFile from a title
73 * Do not call this except from inside a repo class.
75 static function newFromRow( $row, $repo ) {
76 $title = Title
::makeTitle( NS_FILE
, $row->img_name
);
77 $file = new self( $title, $repo );
78 $file->loadFromRow( $row );
84 * Create a LocalFile from a SHA-1 key
85 * Do not call this except from inside a repo class.
87 * @param $repo LocalRepo
90 static function newFromKey( $sha1, $repo, $timestamp = false ) {
91 $conds = array( 'img_sha1' => $sha1 );
94 $conds['img_timestamp'] = $timestamp;
97 $dbr = $repo->getSlaveDB();
98 $row = $dbr->selectRow( 'image', self
::selectFields(), $conds, __METHOD__
);
101 return self
::newFromRow( $row, $repo );
108 * Fields in the image table
110 static function selectFields() {
131 * Do not call this except from inside a repo class.
133 function __construct( $title, $repo ) {
134 if ( !is_object( $title ) ) {
135 throw new MWException( __CLASS__
. ' constructor given bogus title.' );
138 parent
::__construct( $title, $repo );
140 $this->metadata
= '';
141 $this->historyLine
= 0;
142 $this->historyRes
= null;
143 $this->dataLoaded
= false;
147 * Get the memcached key for the main data for this file, or false if
148 * there is no access to the shared cache.
150 function getCacheKey() {
151 $hashedName = md5( $this->getName() );
153 return $this->repo
->getSharedCacheKey( 'file', $hashedName );
157 * Try to load file metadata from memcached. Returns true on success.
159 function loadFromCache() {
162 wfProfileIn( __METHOD__
);
163 $this->dataLoaded
= false;
164 $key = $this->getCacheKey();
167 wfProfileOut( __METHOD__
);
171 $cachedValues = $wgMemc->get( $key );
173 // Check if the key existed and belongs to this version of MediaWiki
174 if ( isset( $cachedValues['version'] ) && ( $cachedValues['version'] == MW_FILE_VERSION
) ) {
175 wfDebug( "Pulling file metadata from cache key $key\n" );
176 $this->fileExists
= $cachedValues['fileExists'];
177 if ( $this->fileExists
) {
178 $this->setProps( $cachedValues );
180 $this->dataLoaded
= true;
183 if ( $this->dataLoaded
) {
184 wfIncrStats( 'image_cache_hit' );
186 wfIncrStats( 'image_cache_miss' );
189 wfProfileOut( __METHOD__
);
190 return $this->dataLoaded
;
194 * Save the file metadata to memcached
196 function saveToCache() {
200 $key = $this->getCacheKey();
206 $fields = $this->getCacheFields( '' );
207 $cache = array( 'version' => MW_FILE_VERSION
);
208 $cache['fileExists'] = $this->fileExists
;
210 if ( $this->fileExists
) {
211 foreach ( $fields as $field ) {
212 $cache[$field] = $this->$field;
216 $wgMemc->set( $key, $cache, 60 * 60 * 24 * 7 ); // A week
220 * Load metadata from the file itself
222 function loadFromFile() {
223 $this->setProps( self
::getPropsFromPath( $this->getPath() ) );
226 function getCacheFields( $prefix = 'img_' ) {
227 static $fields = array( 'size', 'width', 'height', 'bits', 'media_type',
228 'major_mime', 'minor_mime', 'metadata', 'timestamp', 'sha1', 'user', 'user_text', 'description' );
229 static $results = array();
231 if ( $prefix == '' ) {
235 if ( !isset( $results[$prefix] ) ) {
236 $prefixedFields = array();
237 foreach ( $fields as $field ) {
238 $prefixedFields[] = $prefix . $field;
240 $results[$prefix] = $prefixedFields;
243 return $results[$prefix];
247 * Load file metadata from the DB
249 function loadFromDB() {
250 # Polymorphic function name to distinguish foreign and local fetches
251 $fname = get_class( $this ) . '::' . __FUNCTION__
;
252 wfProfileIn( $fname );
254 # Unconditionally set loaded=true, we don't want the accessors constantly rechecking
255 $this->dataLoaded
= true;
257 $dbr = $this->repo
->getMasterDB();
259 $row = $dbr->selectRow( 'image', $this->getCacheFields( 'img_' ),
260 array( 'img_name' => $this->getName() ), $fname );
263 $this->loadFromRow( $row );
265 $this->fileExists
= false;
268 wfProfileOut( $fname );
272 * Decode a row from the database (either object or array) to an array
273 * with timestamps and MIME types decoded, and the field prefix removed.
275 function decodeRow( $row, $prefix = 'img_' ) {
276 $array = (array)$row;
277 $prefixLength = strlen( $prefix );
279 // Sanity check prefix once
280 if ( substr( key( $array ), 0, $prefixLength ) !== $prefix ) {
281 throw new MWException( __METHOD__
. ': incorrect $prefix parameter' );
286 foreach ( $array as $name => $value ) {
287 $decoded[substr( $name, $prefixLength )] = $value;
290 $decoded['timestamp'] = wfTimestamp( TS_MW
, $decoded['timestamp'] );
292 if ( empty( $decoded['major_mime'] ) ) {
293 $decoded['mime'] = 'unknown/unknown';
295 if ( !$decoded['minor_mime'] ) {
296 $decoded['minor_mime'] = 'unknown';
298 $decoded['mime'] = $decoded['major_mime'] . '/' . $decoded['minor_mime'];
301 # Trim zero padding from char/binary field
302 $decoded['sha1'] = rtrim( $decoded['sha1'], "\0" );
308 * Load file metadata from a DB result row
310 function loadFromRow( $row, $prefix = 'img_' ) {
311 $this->dataLoaded
= true;
312 $array = $this->decodeRow( $row, $prefix );
314 foreach ( $array as $name => $value ) {
315 $this->$name = $value;
318 $this->fileExists
= true;
319 $this->maybeUpgradeRow();
323 * Load file metadata from cache or DB, unless already loaded
326 if ( !$this->dataLoaded
) {
327 if ( !$this->loadFromCache() ) {
329 $this->saveToCache();
331 $this->dataLoaded
= true;
336 * Upgrade a row if it needs it
338 function maybeUpgradeRow() {
339 if ( wfReadOnly() ) {
343 if ( is_null( $this->media_type
) ||
344 $this->mime
== 'image/svg'
347 $this->upgraded
= true;
349 $handler = $this->getHandler();
350 if ( $handler && !$handler->isMetadataValid( $this, $this->metadata
) ) {
352 $this->upgraded
= true;
357 function getUpgraded() {
358 return $this->upgraded
;
362 * Fix assorted version-related problems with the image row by reloading it from the file
364 function upgradeRow() {
365 wfProfileIn( __METHOD__
);
367 $this->loadFromFile();
369 # Don't destroy file info of missing files
370 if ( !$this->fileExists
) {
371 wfDebug( __METHOD__
. ": file does not exist, aborting\n" );
372 wfProfileOut( __METHOD__
);
376 $dbw = $this->repo
->getMasterDB();
377 list( $major, $minor ) = self
::splitMime( $this->mime
);
379 if ( wfReadOnly() ) {
380 wfProfileOut( __METHOD__
);
383 wfDebug( __METHOD__
. ': upgrading ' . $this->getName() . " to the current schema\n" );
385 $dbw->update( 'image',
387 'img_width' => $this->width
,
388 'img_height' => $this->height
,
389 'img_bits' => $this->bits
,
390 'img_media_type' => $this->media_type
,
391 'img_major_mime' => $major,
392 'img_minor_mime' => $minor,
393 'img_metadata' => $this->metadata
,
394 'img_sha1' => $this->sha1
,
395 ), array( 'img_name' => $this->getName() ),
399 $this->saveToCache();
400 wfProfileOut( __METHOD__
);
404 * Set properties in this object to be equal to those given in the
405 * associative array $info. Only cacheable fields can be set.
407 * If 'mime' is given, it will be split into major_mime/minor_mime.
408 * If major_mime/minor_mime are given, $this->mime will also be set.
410 function setProps( $info ) {
411 $this->dataLoaded
= true;
412 $fields = $this->getCacheFields( '' );
413 $fields[] = 'fileExists';
415 foreach ( $fields as $field ) {
416 if ( isset( $info[$field] ) ) {
417 $this->$field = $info[$field];
421 // Fix up mime fields
422 if ( isset( $info['major_mime'] ) ) {
423 $this->mime
= "{$info['major_mime']}/{$info['minor_mime']}";
424 } elseif ( isset( $info['mime'] ) ) {
425 $this->mime
= $info['mime'];
426 list( $this->major_mime
, $this->minor_mime
) = self
::splitMime( $this->mime
);
430 /** splitMime inherited */
431 /** getName inherited */
432 /** getTitle inherited */
433 /** getURL inherited */
434 /** getViewURL inherited */
435 /** getPath inherited */
436 /** isVisible inhereted */
438 function isMissing() {
439 if ( $this->missing
=== null ) {
440 list( $fileExists ) = $this->repo
->fileExistsBatch( array( $this->getVirtualUrl() ), FileRepo
::FILES_ONLY
);
441 $this->missing
= !$fileExists;
443 return $this->missing
;
447 * Return the width of the image
449 * Returns false on error
451 public function getWidth( $page = 1 ) {
454 if ( $this->isMultipage() ) {
455 $dim = $this->getHandler()->getPageDimensions( $this, $page );
457 return $dim['width'];
467 * Return the height of the image
469 * Returns false on error
471 public function getHeight( $page = 1 ) {
474 if ( $this->isMultipage() ) {
475 $dim = $this->getHandler()->getPageDimensions( $this, $page );
477 return $dim['height'];
482 return $this->height
;
487 * Returns ID or name of user who uploaded the file
489 * @param $type string 'text' or 'id'
491 function getUser( $type = 'text' ) {
494 if ( $type == 'text' ) {
495 return $this->user_text
;
496 } elseif ( $type == 'id' ) {
502 * Get handler-specific metadata
504 function getMetadata() {
506 return $this->metadata
;
509 function getBitDepth() {
515 * Return the size of the image file, in bytes
517 public function getSize() {
523 * Returns the mime type of the file.
525 function getMimeType() {
531 * Return the type of the media in the file.
532 * Use the value returned by this function with the MEDIATYPE_xxx constants.
534 function getMediaType() {
536 return $this->media_type
;
539 /** canRender inherited */
540 /** mustRender inherited */
541 /** allowInlineDisplay inherited */
542 /** isSafeFile inherited */
543 /** isTrustedFile inherited */
546 * Returns true if the file file exists on disk.
547 * @return boolean Whether file file exist on disk.
549 public function exists() {
551 return $this->fileExists
;
554 /** getTransformScript inherited */
555 /** getUnscaledThumb inherited */
556 /** thumbName inherited */
557 /** createThumb inherited */
558 /** getThumbnail inherited */
559 /** transform inherited */
562 * Fix thumbnail files from 1.4 or before, with extreme prejudice
564 function migrateThumbFile( $thumbName ) {
565 $thumbDir = $this->getThumbPath();
566 $thumbPath = "$thumbDir/$thumbName";
568 if ( is_dir( $thumbPath ) ) {
569 // Directory where file should be
570 // This happened occasionally due to broken migration code in 1.5
571 // Rename to broken-*
572 for ( $i = 0; $i < 100 ; $i++
) {
573 $broken = $this->repo
->getZonePath( 'public' ) . "/broken-$i-$thumbName";
574 if ( !file_exists( $broken ) ) {
575 rename( $thumbPath, $broken );
579 // Doesn't exist anymore
583 if ( is_file( $thumbDir ) ) {
584 // File where directory should be
586 // Doesn't exist anymore
591 /** getHandler inherited */
592 /** iconThumb inherited */
593 /** getLastError inherited */
596 * Get all thumbnail names previously generated for this file
598 function getThumbnails() {
602 $dir = $this->getThumbPath();
604 if ( is_dir( $dir ) ) {
605 $handle = opendir( $dir );
608 while ( false !== ( $file = readdir( $handle ) ) ) {
609 if ( $file { 0 } != '.' ) {
622 * Refresh metadata in memcached, but don't touch thumbnails or squid
624 function purgeMetadataCache() {
626 $this->saveToCache();
627 $this->purgeHistory();
631 * Purge the shared history (OldLocalFile) cache
633 function purgeHistory() {
636 $hashedName = md5( $this->getName() );
637 $oldKey = $this->repo
->getSharedCacheKey( 'oldfile', $hashedName );
640 $wgMemc->delete( $oldKey );
645 * Delete all previously generated thumbnails, refresh metadata in memcached and purge the squid
647 function purgeCache() {
648 // Refresh metadata cache
649 $this->purgeMetadataCache();
652 $this->purgeThumbnails();
654 // Purge squid cache for this file
655 SquidUpdate
::purge( array( $this->getURL() ) );
659 * Delete cached transformed files
661 function purgeThumbnails() {
662 global $wgUseSquid, $wgExcludeFromThumbnailPurge;
665 $files = $this->getThumbnails();
666 $dir = $this->getThumbPath();
669 foreach ( $files as $file ) {
670 // Only remove files not in the $wgExcludeFromThumbnailPurge configuration variable
671 $ext = pathinfo( "$dir/$file", PATHINFO_EXTENSION
);
672 if ( in_array( $ext, $wgExcludeFromThumbnailPurge ) ) {
676 # Check that the base file name is part of the thumb name
677 # This is a basic sanity check to avoid erasing unrelated directories
678 if ( strpos( $file, $this->getName() ) !== false ) {
679 $url = $this->getThumbUrl( $file );
681 @unlink
( "$dir/$file" );
687 SquidUpdate
::purge( $urls );
691 /** purgeDescription inherited */
692 /** purgeEverything inherited */
694 function getHistory( $limit = null, $start = null, $end = null, $inc = true ) {
695 $dbr = $this->repo
->getSlaveDB();
696 $tables = array( 'oldimage' );
697 $fields = OldLocalFile
::selectFields();
698 $conds = $opts = $join_conds = array();
699 $eq = $inc ?
'=' : '';
700 $conds[] = "oi_name = " . $dbr->addQuotes( $this->title
->getDBkey() );
703 $conds[] = "oi_timestamp <$eq " . $dbr->addQuotes( $dbr->timestamp( $start ) );
707 $conds[] = "oi_timestamp >$eq " . $dbr->addQuotes( $dbr->timestamp( $end ) );
711 $opts['LIMIT'] = $limit;
714 // Search backwards for time > x queries
715 $order = ( !$start && $end !== null ) ?
'ASC' : 'DESC';
716 $opts['ORDER BY'] = "oi_timestamp $order";
717 $opts['USE INDEX'] = array( 'oldimage' => 'oi_name_timestamp' );
719 wfRunHooks( 'LocalFile::getHistory', array( &$this, &$tables, &$fields,
720 &$conds, &$opts, &$join_conds ) );
722 $res = $dbr->select( $tables, $fields, $conds, __METHOD__
, $opts, $join_conds );
725 foreach ( $res as $row ) {
726 if ( $this->repo
->oldFileFromRowFactory
) {
727 $r[] = call_user_func( $this->repo
->oldFileFromRowFactory
, $row, $this->repo
);
729 $r[] = OldLocalFile
::newFromRow( $row, $this->repo
);
733 if ( $order == 'ASC' ) {
734 $r = array_reverse( $r ); // make sure it ends up descending
741 * Return the history of this file, line by line.
742 * starts with current version, then old versions.
743 * uses $this->historyLine to check which line to return:
744 * 0 return line for current version
745 * 1 query for old versions, return first one
746 * 2, ... return next old version from above query
748 public function nextHistoryLine() {
749 # Polymorphic function name to distinguish foreign and local fetches
750 $fname = get_class( $this ) . '::' . __FUNCTION__
;
752 $dbr = $this->repo
->getSlaveDB();
754 if ( $this->historyLine
== 0 ) {// called for the first time, return line from cur
755 $this->historyRes
= $dbr->select( 'image',
758 "'' AS oi_archive_name",
762 array( 'img_name' => $this->title
->getDBkey() ),
766 if ( 0 == $dbr->numRows( $this->historyRes
) ) {
767 $this->historyRes
= null;
770 } elseif ( $this->historyLine
== 1 ) {
771 $this->historyRes
= $dbr->select( 'oldimage', '*',
772 array( 'oi_name' => $this->title
->getDBkey() ),
774 array( 'ORDER BY' => 'oi_timestamp DESC' )
777 $this->historyLine ++
;
779 return $dbr->fetchObject( $this->historyRes
);
783 * Reset the history pointer to the first element of the history
785 public function resetHistory() {
786 $this->historyLine
= 0;
788 if ( !is_null( $this->historyRes
) ) {
789 $this->historyRes
= null;
793 /** getFullPath inherited */
794 /** getHashPath inherited */
795 /** getRel inherited */
796 /** getUrlRel inherited */
797 /** getArchiveRel inherited */
798 /** getThumbRel inherited */
799 /** getArchivePath inherited */
800 /** getThumbPath inherited */
801 /** getArchiveUrl inherited */
802 /** getThumbUrl inherited */
803 /** getArchiveVirtualUrl inherited */
804 /** getThumbVirtualUrl inherited */
805 /** isHashed inherited */
808 * Upload a file and record it in the DB
809 * @param $srcPath String: source path or virtual URL
810 * @param $comment String: upload description
811 * @param $pageText String: text to use for the new description page,
812 * if a new description page is created
813 * @param $flags Integer: flags for publish()
814 * @param $props Array: File properties, if known. This can be used to reduce the
815 * upload time when uploading virtual URLs for which the file info
817 * @param $timestamp String: timestamp for img_timestamp, or false to use the current time
818 * @param $user Mixed: User object or null to use $wgUser
820 * @return FileRepoStatus object. On success, the value member contains the
821 * archive name, or an empty string if it was a new file.
823 function upload( $srcPath, $comment, $pageText, $flags = 0, $props = false, $timestamp = false, $user = null ) {
825 $status = $this->publish( $srcPath, $flags );
828 if ( !$this->recordUpload2( $status->value
, $comment, $pageText, $props, $timestamp, $user ) ) {
829 $status->fatal( 'filenotfound', $srcPath );
839 * Record a file upload in the upload log and the image table
840 * @deprecated use upload()
842 function recordUpload( $oldver, $desc, $license = '', $copyStatus = '', $source = '',
843 $watch = false, $timestamp = false )
845 $pageText = SpecialUpload
::getInitialPageText( $desc, $license, $copyStatus, $source );
847 if ( !$this->recordUpload2( $oldver, $desc, $pageText ) ) {
853 $wgUser->addWatch( $this->getTitle() );
860 * Record a file upload in the upload log and the image table
862 function recordUpload2(
863 $oldver, $comment, $pageText, $props = false, $timestamp = false, $user = null
865 if ( is_null( $user ) ) {
870 $dbw = $this->repo
->getMasterDB();
874 $props = $this->repo
->getFileProps( $this->getVirtualUrl() );
877 if ( $timestamp === false ) {
878 $timestamp = $dbw->timestamp();
881 $props['description'] = $comment;
882 $props['user'] = $user->getId();
883 $props['user_text'] = $user->getName();
884 $props['timestamp'] = wfTimestamp( TS_MW
, $timestamp ); // DB -> TS_MW
885 $this->setProps( $props );
888 $this->purgeThumbnails();
890 # The file is already on its final location, remove it from the squid cache
891 SquidUpdate
::purge( array( $this->getURL() ) );
893 # Fail now if the file isn't there
894 if ( !$this->fileExists
) {
895 wfDebug( __METHOD__
. ": File " . $this->getPath() . " went missing!\n" );
901 # Test to see if the row exists using INSERT IGNORE
902 # This avoids race conditions by locking the row until the commit, and also
903 # doesn't deadlock. SELECT FOR UPDATE causes a deadlock for every race condition.
904 $dbw->insert( 'image',
906 'img_name' => $this->getName(),
907 'img_size' => $this->size
,
908 'img_width' => intval( $this->width
),
909 'img_height' => intval( $this->height
),
910 'img_bits' => $this->bits
,
911 'img_media_type' => $this->media_type
,
912 'img_major_mime' => $this->major_mime
,
913 'img_minor_mime' => $this->minor_mime
,
914 'img_timestamp' => $timestamp,
915 'img_description' => $comment,
916 'img_user' => $user->getId(),
917 'img_user_text' => $user->getName(),
918 'img_metadata' => $this->metadata
,
919 'img_sha1' => $this->sha1
925 if ( $dbw->affectedRows() == 0 ) {
928 # Collision, this is an update of a file
929 # Insert previous contents into oldimage
930 $dbw->insertSelect( 'oldimage', 'image',
932 'oi_name' => 'img_name',
933 'oi_archive_name' => $dbw->addQuotes( $oldver ),
934 'oi_size' => 'img_size',
935 'oi_width' => 'img_width',
936 'oi_height' => 'img_height',
937 'oi_bits' => 'img_bits',
938 'oi_timestamp' => 'img_timestamp',
939 'oi_description' => 'img_description',
940 'oi_user' => 'img_user',
941 'oi_user_text' => 'img_user_text',
942 'oi_metadata' => 'img_metadata',
943 'oi_media_type' => 'img_media_type',
944 'oi_major_mime' => 'img_major_mime',
945 'oi_minor_mime' => 'img_minor_mime',
946 'oi_sha1' => 'img_sha1'
947 ), array( 'img_name' => $this->getName() ), __METHOD__
950 # Update the current image row
951 $dbw->update( 'image',
953 'img_size' => $this->size
,
954 'img_width' => intval( $this->width
),
955 'img_height' => intval( $this->height
),
956 'img_bits' => $this->bits
,
957 'img_media_type' => $this->media_type
,
958 'img_major_mime' => $this->major_mime
,
959 'img_minor_mime' => $this->minor_mime
,
960 'img_timestamp' => $timestamp,
961 'img_description' => $comment,
962 'img_user' => $user->getId(),
963 'img_user_text' => $user->getName(),
964 'img_metadata' => $this->metadata
,
965 'img_sha1' => $this->sha1
966 ), array( /* WHERE */
967 'img_name' => $this->getName()
972 # Update the image count
973 $site_stats = $dbw->tableName( 'site_stats' );
974 $dbw->query( "UPDATE $site_stats SET ss_images=ss_images+1", __METHOD__
);
977 $descTitle = $this->getTitle();
978 $article = new ImagePage( $descTitle );
979 $article->setFile( $this );
982 $log = new LogPage( 'upload' );
983 $action = $reupload ?
'overwrite' : 'upload';
984 $log->addEntry( $action, $descTitle, $comment, array(), $user );
986 if ( $descTitle->exists() ) {
987 # Create a null revision
988 $latest = $descTitle->getLatestRevID();
989 $nullRevision = Revision
::newNullRevision(
991 $descTitle->getArticleId(),
992 $log->getRcComment(),
995 $nullRevision->insertOn( $dbw );
997 wfRunHooks( 'NewRevisionFromEditComplete', array( $article, $nullRevision, $latest, $user ) );
998 $article->updateRevisionOn( $dbw, $nullRevision );
1000 # Invalidate the cache for the description page
1001 $descTitle->invalidateCache();
1002 $descTitle->purgeSquid();
1004 # New file; create the description page.
1005 # There's already a log entry, so don't make a second RC entry
1006 # Squid and file cache for the description page are purged by doEdit.
1007 $article->doEdit( $pageText, $comment, EDIT_NEW | EDIT_SUPPRESS_RC
);
1010 # Commit the transaction now, in case something goes wrong later
1011 # The most important thing is that files don't get lost, especially archives
1014 # Save to cache and purge the squid
1015 # We shall not saveToCache before the commit since otherwise
1016 # in case of a rollback there is an usable file from memcached
1017 # which in fact doesn't really exist (bug 24978)
1018 $this->saveToCache();
1020 # Hooks, hooks, the magic of hooks...
1021 wfRunHooks( 'FileUpload', array( $this, $reupload, $descTitle->exists() ) );
1023 # Invalidate cache for all pages using this file
1024 $update = new HTMLCacheUpdate( $this->getTitle(), 'imagelinks' );
1025 $update->doUpdate();
1027 # Invalidate cache for all pages that redirects on this page
1028 $redirs = $this->getTitle()->getRedirectsHere();
1030 foreach ( $redirs as $redir ) {
1031 $update = new HTMLCacheUpdate( $redir, 'imagelinks' );
1032 $update->doUpdate();
1039 * Move or copy a file to its public location. If a file exists at the
1040 * destination, move it to an archive. Returns a FileRepoStatus object with
1041 * the archive name in the "value" member on success.
1043 * The archive name should be passed through to recordUpload for database
1046 * @param $srcPath String: local filesystem path to the source image
1047 * @param $flags Integer: a bitwise combination of:
1048 * File::DELETE_SOURCE Delete the source file, i.e. move rather than copy
1049 * @param $dstArchiveName string File name if the file is to be published
1051 * @return FileRepoStatus object. On success, the value member contains the
1052 * archive name, or an empty string if it was a new file.
1054 function publish( $srcPath, $flags = 0, $dstArchiveName = null ) {
1057 if ( $dstArchiveName ) {
1058 $dstRel = 'archive/' . $this->getHashPath() . $dstArchiveName;
1060 $dstRel = $this->getRel();
1063 $archiveName = wfTimestamp( TS_MW
) . '!'. $this->getName();
1064 $archiveRel = 'archive/' . $this->getHashPath() . $archiveName;
1065 $flags = $flags & File
::DELETE_SOURCE ? LocalRepo
::DELETE_SOURCE
: 0;
1066 $status = $this->repo
->publish( $srcPath, $dstRel, $archiveRel, $flags );
1068 if ( $status->value
== 'new' ) {
1069 $status->value
= '';
1071 $status->value
= $archiveName;
1079 /** getLinksTo inherited */
1080 /** getExifData inherited */
1081 /** isLocal inherited */
1082 /** wasDeleted inherited */
1085 * Move file to the new title
1087 * Move current, old version and all thumbnails
1088 * to the new filename. Old file is deleted.
1090 * Cache purging is done; checks for validity
1091 * and logging are caller's responsibility
1093 * @param $target Title New file name
1094 * @return FileRepoStatus object.
1096 function move( $target ) {
1097 wfDebugLog( 'imagemove', "Got request to move {$this->name} to " . $target->getText() );
1100 $batch = new LocalFileMoveBatch( $this, $target );
1101 $batch->addCurrent();
1104 $status = $batch->execute();
1105 wfDebugLog( 'imagemove', "Finished moving {$this->name}" );
1107 $this->purgeEverything();
1110 if ( $status->isOk() ) {
1111 // Now switch the object
1112 $this->title
= $target;
1113 // Force regeneration of the name and hashpath
1114 unset( $this->name
);
1115 unset( $this->hashPath
);
1116 // Purge the new image
1117 $this->purgeEverything();
1124 * Delete all versions of the file.
1126 * Moves the files into an archive directory (or deletes them)
1127 * and removes the database rows.
1129 * Cache purging is done; logging is caller's responsibility.
1133 * @return FileRepoStatus object.
1135 function delete( $reason, $suppress = false ) {
1138 $batch = new LocalFileDeleteBatch( $this, $reason, $suppress );
1139 $batch->addCurrent();
1141 # Get old version relative paths
1142 $dbw = $this->repo
->getMasterDB();
1143 $result = $dbw->select( 'oldimage',
1144 array( 'oi_archive_name' ),
1145 array( 'oi_name' => $this->getName() ) );
1146 foreach ( $result as $row ) {
1147 $batch->addOld( $row->oi_archive_name
);
1149 $status = $batch->execute();
1151 if ( $status->ok
) {
1152 // Update site_stats
1153 $site_stats = $dbw->tableName( 'site_stats' );
1154 $dbw->query( "UPDATE $site_stats SET ss_images=ss_images-1", __METHOD__
);
1155 $this->purgeEverything();
1164 * Delete an old version of the file.
1166 * Moves the file into an archive directory (or deletes it)
1167 * and removes the database row.
1169 * Cache purging is done; logging is caller's responsibility.
1171 * @param $archiveName String
1172 * @param $reason String
1173 * @param $suppress Boolean
1174 * @throws MWException or FSException on database or file store failure
1175 * @return FileRepoStatus object.
1177 function deleteOld( $archiveName, $reason, $suppress = false ) {
1180 $batch = new LocalFileDeleteBatch( $this, $reason, $suppress );
1181 $batch->addOld( $archiveName );
1182 $status = $batch->execute();
1186 if ( $status->ok
) {
1187 $this->purgeDescription();
1188 $this->purgeHistory();
1195 * Restore all or specified deleted revisions to the given file.
1196 * Permissions and logging are left to the caller.
1198 * May throw database exceptions on error.
1200 * @param $versions set of record ids of deleted items to restore,
1201 * or empty to restore all revisions.
1202 * @param $unsuppress Boolean
1203 * @return FileRepoStatus
1205 function restore( $versions = array(), $unsuppress = false ) {
1206 $batch = new LocalFileRestoreBatch( $this, $unsuppress );
1211 $batch->addIds( $versions );
1214 $status = $batch->execute();
1216 if ( !$status->isGood() ) {
1220 $cleanupStatus = $batch->cleanup();
1221 $cleanupStatus->successCount
= 0;
1222 $cleanupStatus->failCount
= 0;
1223 $status->merge( $cleanupStatus );
1228 /** isMultipage inherited */
1229 /** pageCount inherited */
1230 /** scaleHeight inherited */
1231 /** getImageSize inherited */
1234 * Get the URL of the file description page.
1236 function getDescriptionUrl() {
1237 return $this->title
->getLocalUrl();
1241 * Get the HTML text of the description page
1242 * This is not used by ImagePage for local files, since (among other things)
1243 * it skips the parser cache.
1245 function getDescriptionText() {
1247 $revision = Revision
::newFromTitle( $this->title
);
1248 if ( !$revision ) return false;
1249 $text = $revision->getText();
1250 if ( !$text ) return false;
1251 $pout = $wgParser->parse( $text, $this->title
, new ParserOptions() );
1252 return $pout->getText();
1255 function getDescription() {
1257 return $this->description
;
1260 function getTimestamp() {
1262 return $this->timestamp
;
1265 function getSha1() {
1267 // Initialise now if necessary
1268 if ( $this->sha1
== '' && $this->fileExists
) {
1269 $this->sha1
= File
::sha1Base36( $this->getPath() );
1270 if ( !wfReadOnly() && strval( $this->sha1
) != '' ) {
1271 $dbw = $this->repo
->getMasterDB();
1272 $dbw->update( 'image',
1273 array( 'img_sha1' => $this->sha1
),
1274 array( 'img_name' => $this->getName() ),
1276 $this->saveToCache();
1284 * Start a transaction and lock the image for update
1285 * Increments a reference counter if the lock is already held
1286 * @return boolean True if the image exists, false otherwise
1289 $dbw = $this->repo
->getMasterDB();
1291 if ( !$this->locked
) {
1296 return $dbw->selectField( 'image', '1', array( 'img_name' => $this->getName() ), __METHOD__
);
1300 * Decrement the lock reference count. If the reference count is reduced to zero, commits
1301 * the transaction and thereby releases the image lock.
1304 if ( $this->locked
) {
1306 if ( !$this->locked
) {
1307 $dbw = $this->repo
->getMasterDB();
1314 * Roll back the DB transaction and mark the image unlocked
1316 function unlockAndRollback() {
1317 $this->locked
= false;
1318 $dbw = $this->repo
->getMasterDB();
1321 } // LocalFile class
1323 # ------------------------------------------------------------------------------
1326 * Helper class for file deletion
1329 class LocalFileDeleteBatch
{
1336 var $reason, $srcRels = array(), $archiveUrls = array(), $deletionBatch, $suppress;
1339 function __construct( File
$file, $reason = '', $suppress = false ) {
1340 $this->file
= $file;
1341 $this->reason
= $reason;
1342 $this->suppress
= $suppress;
1343 $this->status
= $file->repo
->newGood();
1346 function addCurrent() {
1347 $this->srcRels
['.'] = $this->file
->getRel();
1350 function addOld( $oldName ) {
1351 $this->srcRels
[$oldName] = $this->file
->getArchiveRel( $oldName );
1352 $this->archiveUrls
[] = $this->file
->getArchiveUrl( $oldName );
1355 function getOldRels() {
1356 if ( !isset( $this->srcRels
['.'] ) ) {
1357 $oldRels =& $this->srcRels
;
1358 $deleteCurrent = false;
1360 $oldRels = $this->srcRels
;
1361 unset( $oldRels['.'] );
1362 $deleteCurrent = true;
1365 return array( $oldRels, $deleteCurrent );
1368 /*protected*/ function getHashes() {
1370 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
1372 if ( $deleteCurrent ) {
1373 $hashes['.'] = $this->file
->getSha1();
1376 if ( count( $oldRels ) ) {
1377 $dbw = $this->file
->repo
->getMasterDB();
1378 $res = $dbw->select(
1380 array( 'oi_archive_name', 'oi_sha1' ),
1381 'oi_archive_name IN (' . $dbw->makeList( array_keys( $oldRels ) ) . ')',
1385 foreach ( $res as $row ) {
1386 if ( rtrim( $row->oi_sha1
, "\0" ) === '' ) {
1387 // Get the hash from the file
1388 $oldUrl = $this->file
->getArchiveVirtualUrl( $row->oi_archive_name
);
1389 $props = $this->file
->repo
->getFileProps( $oldUrl );
1391 if ( $props['fileExists'] ) {
1392 // Upgrade the oldimage row
1393 $dbw->update( 'oldimage',
1394 array( 'oi_sha1' => $props['sha1'] ),
1395 array( 'oi_name' => $this->file
->getName(), 'oi_archive_name' => $row->oi_archive_name
),
1397 $hashes[$row->oi_archive_name
] = $props['sha1'];
1399 $hashes[$row->oi_archive_name
] = false;
1402 $hashes[$row->oi_archive_name
] = $row->oi_sha1
;
1407 $missing = array_diff_key( $this->srcRels
, $hashes );
1409 foreach ( $missing as $name => $rel ) {
1410 $this->status
->error( 'filedelete-old-unregistered', $name );
1413 foreach ( $hashes as $name => $hash ) {
1415 $this->status
->error( 'filedelete-missing', $this->srcRels
[$name] );
1416 unset( $hashes[$name] );
1423 function doDBInserts() {
1426 $dbw = $this->file
->repo
->getMasterDB();
1427 $encTimestamp = $dbw->addQuotes( $dbw->timestamp() );
1428 $encUserId = $dbw->addQuotes( $wgUser->getId() );
1429 $encReason = $dbw->addQuotes( $this->reason
);
1430 $encGroup = $dbw->addQuotes( 'deleted' );
1431 $ext = $this->file
->getExtension();
1432 $dotExt = $ext === '' ?
'' : ".$ext";
1433 $encExt = $dbw->addQuotes( $dotExt );
1434 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
1436 // Bitfields to further suppress the content
1437 if ( $this->suppress
) {
1439 // This should be 15...
1440 $bitfield |
= Revision
::DELETED_TEXT
;
1441 $bitfield |
= Revision
::DELETED_COMMENT
;
1442 $bitfield |
= Revision
::DELETED_USER
;
1443 $bitfield |
= Revision
::DELETED_RESTRICTED
;
1445 $bitfield = 'oi_deleted';
1448 if ( $deleteCurrent ) {
1449 $concat = $dbw->buildConcat( array( "img_sha1", $encExt ) );
1450 $where = array( 'img_name' => $this->file
->getName() );
1451 $dbw->insertSelect( 'filearchive', 'image',
1453 'fa_storage_group' => $encGroup,
1454 'fa_storage_key' => "CASE WHEN img_sha1='' THEN '' ELSE $concat END",
1455 'fa_deleted_user' => $encUserId,
1456 'fa_deleted_timestamp' => $encTimestamp,
1457 'fa_deleted_reason' => $encReason,
1458 'fa_deleted' => $this->suppress ?
$bitfield : 0,
1460 'fa_name' => 'img_name',
1461 'fa_archive_name' => 'NULL',
1462 'fa_size' => 'img_size',
1463 'fa_width' => 'img_width',
1464 'fa_height' => 'img_height',
1465 'fa_metadata' => 'img_metadata',
1466 'fa_bits' => 'img_bits',
1467 'fa_media_type' => 'img_media_type',
1468 'fa_major_mime' => 'img_major_mime',
1469 'fa_minor_mime' => 'img_minor_mime',
1470 'fa_description' => 'img_description',
1471 'fa_user' => 'img_user',
1472 'fa_user_text' => 'img_user_text',
1473 'fa_timestamp' => 'img_timestamp'
1474 ), $where, __METHOD__
);
1477 if ( count( $oldRels ) ) {
1478 $concat = $dbw->buildConcat( array( "oi_sha1", $encExt ) );
1480 'oi_name' => $this->file
->getName(),
1481 'oi_archive_name IN (' . $dbw->makeList( array_keys( $oldRels ) ) . ')' );
1482 $dbw->insertSelect( 'filearchive', 'oldimage',
1484 'fa_storage_group' => $encGroup,
1485 'fa_storage_key' => "CASE WHEN oi_sha1='' THEN '' ELSE $concat END",
1486 'fa_deleted_user' => $encUserId,
1487 'fa_deleted_timestamp' => $encTimestamp,
1488 'fa_deleted_reason' => $encReason,
1489 'fa_deleted' => $this->suppress ?
$bitfield : 'oi_deleted',
1491 'fa_name' => 'oi_name',
1492 'fa_archive_name' => 'oi_archive_name',
1493 'fa_size' => 'oi_size',
1494 'fa_width' => 'oi_width',
1495 'fa_height' => 'oi_height',
1496 'fa_metadata' => 'oi_metadata',
1497 'fa_bits' => 'oi_bits',
1498 'fa_media_type' => 'oi_media_type',
1499 'fa_major_mime' => 'oi_major_mime',
1500 'fa_minor_mime' => 'oi_minor_mime',
1501 'fa_description' => 'oi_description',
1502 'fa_user' => 'oi_user',
1503 'fa_user_text' => 'oi_user_text',
1504 'fa_timestamp' => 'oi_timestamp',
1505 'fa_deleted' => $bitfield
1506 ), $where, __METHOD__
);
1510 function doDBDeletes() {
1511 $dbw = $this->file
->repo
->getMasterDB();
1512 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
1514 if ( count( $oldRels ) ) {
1515 $dbw->delete( 'oldimage',
1517 'oi_name' => $this->file
->getName(),
1518 'oi_archive_name' => array_keys( $oldRels )
1522 if ( $deleteCurrent ) {
1523 $dbw->delete( 'image', array( 'img_name' => $this->file
->getName() ), __METHOD__
);
1528 * Run the transaction
1530 function execute() {
1532 wfProfileIn( __METHOD__
);
1534 $this->file
->lock();
1535 // Leave private files alone
1536 $privateFiles = array();
1537 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
1538 $dbw = $this->file
->repo
->getMasterDB();
1540 if ( !empty( $oldRels ) ) {
1541 $res = $dbw->select( 'oldimage',
1542 array( 'oi_archive_name' ),
1543 array( 'oi_name' => $this->file
->getName(),
1544 'oi_archive_name IN (' . $dbw->makeList( array_keys( $oldRels ) ) . ')',
1545 $dbw->bitAnd( 'oi_deleted', File
::DELETED_FILE
) => File
::DELETED_FILE
),
1548 foreach ( $res as $row ) {
1549 $privateFiles[$row->oi_archive_name
] = 1;
1552 // Prepare deletion batch
1553 $hashes = $this->getHashes();
1554 $this->deletionBatch
= array();
1555 $ext = $this->file
->getExtension();
1556 $dotExt = $ext === '' ?
'' : ".$ext";
1558 foreach ( $this->srcRels
as $name => $srcRel ) {
1559 // Skip files that have no hash (missing source).
1560 // Keep private files where they are.
1561 if ( isset( $hashes[$name] ) && !array_key_exists( $name, $privateFiles ) ) {
1562 $hash = $hashes[$name];
1563 $key = $hash . $dotExt;
1564 $dstRel = $this->file
->repo
->getDeletedHashPath( $key ) . $key;
1565 $this->deletionBatch
[$name] = array( $srcRel, $dstRel );
1569 // Lock the filearchive rows so that the files don't get deleted by a cleanup operation
1570 // We acquire this lock by running the inserts now, before the file operations.
1572 // This potentially has poor lock contention characteristics -- an alternative
1573 // scheme would be to insert stub filearchive entries with no fa_name and commit
1574 // them in a separate transaction, then run the file ops, then update the fa_name fields.
1575 $this->doDBInserts();
1577 // Removes non-existent file from the batch, so we don't get errors.
1578 $this->deletionBatch
= $this->removeNonexistentFiles( $this->deletionBatch
);
1580 // Execute the file deletion batch
1581 $status = $this->file
->repo
->deleteBatch( $this->deletionBatch
);
1583 if ( !$status->isGood() ) {
1584 $this->status
->merge( $status );
1587 if ( !$this->status
->ok
) {
1588 // Critical file deletion error
1589 // Roll back inserts, release lock and abort
1590 // TODO: delete the defunct filearchive rows if we are using a non-transactional DB
1591 $this->file
->unlockAndRollback();
1592 wfProfileOut( __METHOD__
);
1593 return $this->status
;
1597 if ( $wgUseSquid ) {
1600 foreach ( $this->srcRels
as $srcRel ) {
1601 $urlRel = str_replace( '%2F', '/', rawurlencode( $srcRel ) );
1602 $urls[] = $this->file
->repo
->getZoneUrl( 'public' ) . '/' . $urlRel;
1604 SquidUpdate
::purge( $urls );
1607 // Delete image/oldimage rows
1608 $this->doDBDeletes();
1610 // Commit and return
1611 $this->file
->unlock();
1612 wfProfileOut( __METHOD__
);
1614 return $this->status
;
1618 * Removes non-existent files from a deletion batch.
1620 function removeNonexistentFiles( $batch ) {
1621 $files = $newBatch = array();
1623 foreach ( $batch as $batchItem ) {
1624 list( $src, $dest ) = $batchItem;
1625 $files[$src] = $this->file
->repo
->getVirtualUrl( 'public' ) . '/' . rawurlencode( $src );
1628 $result = $this->file
->repo
->fileExistsBatch( $files, FSRepo
::FILES_ONLY
);
1630 foreach ( $batch as $batchItem ) {
1631 if ( $result[$batchItem[0]] ) {
1632 $newBatch[] = $batchItem;
1640 # ------------------------------------------------------------------------------
1643 * Helper class for file undeletion
1646 class LocalFileRestoreBatch
{
1652 var $cleanupBatch, $ids, $all, $unsuppress = false;
1654 function __construct( File
$file, $unsuppress = false ) {
1655 $this->file
= $file;
1656 $this->cleanupBatch
= $this->ids
= array();
1657 $this->ids
= array();
1658 $this->unsuppress
= $unsuppress;
1664 function addId( $fa_id ) {
1665 $this->ids
[] = $fa_id;
1669 * Add a whole lot of files by ID
1671 function addIds( $ids ) {
1672 $this->ids
= array_merge( $this->ids
, $ids );
1676 * Add all revisions of the file
1683 * Run the transaction, except the cleanup batch.
1684 * The cleanup batch should be run in a separate transaction, because it locks different
1685 * rows and there's no need to keep the image row locked while it's acquiring those locks
1686 * The caller may have its own transaction open.
1687 * So we save the batch and let the caller call cleanup()
1689 function execute() {
1692 if ( !$this->all
&& !$this->ids
) {
1694 return $this->file
->repo
->newGood();
1697 $exists = $this->file
->lock();
1698 $dbw = $this->file
->repo
->getMasterDB();
1699 $status = $this->file
->repo
->newGood();
1701 // Fetch all or selected archived revisions for the file,
1702 // sorted from the most recent to the oldest.
1703 $conditions = array( 'fa_name' => $this->file
->getName() );
1705 if ( !$this->all
) {
1706 $conditions[] = 'fa_id IN (' . $dbw->makeList( $this->ids
) . ')';
1709 $result = $dbw->select( 'filearchive', '*',
1712 array( 'ORDER BY' => 'fa_timestamp DESC' )
1715 $idsPresent = array();
1716 $storeBatch = array();
1717 $insertBatch = array();
1718 $insertCurrent = false;
1719 $deleteIds = array();
1721 $archiveNames = array();
1723 foreach ( $result as $row ) {
1724 $idsPresent[] = $row->fa_id
;
1726 if ( $row->fa_name
!= $this->file
->getName() ) {
1727 $status->error( 'undelete-filename-mismatch', $wgLang->timeanddate( $row->fa_timestamp
) );
1728 $status->failCount++
;
1732 if ( $row->fa_storage_key
== '' ) {
1733 // Revision was missing pre-deletion
1734 $status->error( 'undelete-bad-store-key', $wgLang->timeanddate( $row->fa_timestamp
) );
1735 $status->failCount++
;
1739 $deletedRel = $this->file
->repo
->getDeletedHashPath( $row->fa_storage_key
) . $row->fa_storage_key
;
1740 $deletedUrl = $this->file
->repo
->getVirtualUrl() . '/deleted/' . $deletedRel;
1742 $sha1 = substr( $row->fa_storage_key
, 0, strcspn( $row->fa_storage_key
, '.' ) );
1745 if ( strlen( $sha1 ) == 32 && $sha1[0] == '0' ) {
1746 $sha1 = substr( $sha1, 1 );
1749 if ( is_null( $row->fa_major_mime
) ||
$row->fa_major_mime
== 'unknown'
1750 ||
is_null( $row->fa_minor_mime
) ||
$row->fa_minor_mime
== 'unknown'
1751 ||
is_null( $row->fa_media_type
) ||
$row->fa_media_type
== 'UNKNOWN'
1752 ||
is_null( $row->fa_metadata
) ) {
1753 // Refresh our metadata
1754 // Required for a new current revision; nice for older ones too. :)
1755 $props = RepoGroup
::singleton()->getFileProps( $deletedUrl );
1758 'minor_mime' => $row->fa_minor_mime
,
1759 'major_mime' => $row->fa_major_mime
,
1760 'media_type' => $row->fa_media_type
,
1761 'metadata' => $row->fa_metadata
1765 if ( $first && !$exists ) {
1766 // This revision will be published as the new current version
1767 $destRel = $this->file
->getRel();
1768 $insertCurrent = array(
1769 'img_name' => $row->fa_name
,
1770 'img_size' => $row->fa_size
,
1771 'img_width' => $row->fa_width
,
1772 'img_height' => $row->fa_height
,
1773 'img_metadata' => $props['metadata'],
1774 'img_bits' => $row->fa_bits
,
1775 'img_media_type' => $props['media_type'],
1776 'img_major_mime' => $props['major_mime'],
1777 'img_minor_mime' => $props['minor_mime'],
1778 'img_description' => $row->fa_description
,
1779 'img_user' => $row->fa_user
,
1780 'img_user_text' => $row->fa_user_text
,
1781 'img_timestamp' => $row->fa_timestamp
,
1785 // The live (current) version cannot be hidden!
1786 if ( !$this->unsuppress
&& $row->fa_deleted
) {
1787 $storeBatch[] = array( $deletedUrl, 'public', $destRel );
1788 $this->cleanupBatch
[] = $row->fa_storage_key
;
1791 $archiveName = $row->fa_archive_name
;
1793 if ( $archiveName == '' ) {
1794 // This was originally a current version; we
1795 // have to devise a new archive name for it.
1796 // Format is <timestamp of archiving>!<name>
1797 $timestamp = wfTimestamp( TS_UNIX
, $row->fa_deleted_timestamp
);
1800 $archiveName = wfTimestamp( TS_MW
, $timestamp ) . '!' . $row->fa_name
;
1802 } while ( isset( $archiveNames[$archiveName] ) );
1805 $archiveNames[$archiveName] = true;
1806 $destRel = $this->file
->getArchiveRel( $archiveName );
1807 $insertBatch[] = array(
1808 'oi_name' => $row->fa_name
,
1809 'oi_archive_name' => $archiveName,
1810 'oi_size' => $row->fa_size
,
1811 'oi_width' => $row->fa_width
,
1812 'oi_height' => $row->fa_height
,
1813 'oi_bits' => $row->fa_bits
,
1814 'oi_description' => $row->fa_description
,
1815 'oi_user' => $row->fa_user
,
1816 'oi_user_text' => $row->fa_user_text
,
1817 'oi_timestamp' => $row->fa_timestamp
,
1818 'oi_metadata' => $props['metadata'],
1819 'oi_media_type' => $props['media_type'],
1820 'oi_major_mime' => $props['major_mime'],
1821 'oi_minor_mime' => $props['minor_mime'],
1822 'oi_deleted' => $this->unsuppress ?
0 : $row->fa_deleted
,
1823 'oi_sha1' => $sha1 );
1826 $deleteIds[] = $row->fa_id
;
1828 if ( !$this->unsuppress
&& $row->fa_deleted
& File
::DELETED_FILE
) {
1829 // private files can stay where they are
1830 $status->successCount++
;
1832 $storeBatch[] = array( $deletedUrl, 'public', $destRel );
1833 $this->cleanupBatch
[] = $row->fa_storage_key
;
1841 // Add a warning to the status object for missing IDs
1842 $missingIds = array_diff( $this->ids
, $idsPresent );
1844 foreach ( $missingIds as $id ) {
1845 $status->error( 'undelete-missing-filearchive', $id );
1848 // Remove missing files from batch, so we don't get errors when undeleting them
1849 $storeBatch = $this->removeNonexistentFiles( $storeBatch );
1851 // Run the store batch
1852 // Use the OVERWRITE_SAME flag to smooth over a common error
1853 $storeStatus = $this->file
->repo
->storeBatch( $storeBatch, FileRepo
::OVERWRITE_SAME
);
1854 $status->merge( $storeStatus );
1856 if ( !$status->isGood() ) {
1857 // Even if some files could be copied, fail entirely as that is the
1858 // easiest thing to do without data loss
1859 $this->cleanupFailedBatch( $storeStatus, $storeBatch );
1860 $status->ok
= false;
1861 $this->file
->unlock();
1866 // Run the DB updates
1867 // Because we have locked the image row, key conflicts should be rare.
1868 // If they do occur, we can roll back the transaction at this time with
1869 // no data loss, but leaving unregistered files scattered throughout the
1871 // This is not ideal, which is why it's important to lock the image row.
1872 if ( $insertCurrent ) {
1873 $dbw->insert( 'image', $insertCurrent, __METHOD__
);
1876 if ( $insertBatch ) {
1877 $dbw->insert( 'oldimage', $insertBatch, __METHOD__
);
1881 $dbw->delete( 'filearchive',
1882 array( 'fa_id IN (' . $dbw->makeList( $deleteIds ) . ')' ),
1886 // If store batch is empty (all files are missing), deletion is to be considered successful
1887 if ( $status->successCount
> 0 ||
!$storeBatch ) {
1889 wfDebug( __METHOD__
. " restored {$status->successCount} items, creating a new current\n" );
1891 // Update site_stats
1892 $site_stats = $dbw->tableName( 'site_stats' );
1893 $dbw->query( "UPDATE $site_stats SET ss_images=ss_images+1", __METHOD__
);
1895 $this->file
->purgeEverything();
1897 wfDebug( __METHOD__
. " restored {$status->successCount} as archived versions\n" );
1898 $this->file
->purgeDescription();
1899 $this->file
->purgeHistory();
1903 $this->file
->unlock();
1909 * Removes non-existent files from a store batch.
1911 function removeNonexistentFiles( $triplets ) {
1912 $files = $filteredTriplets = array();
1913 foreach ( $triplets as $file )
1914 $files[$file[0]] = $file[0];
1916 $result = $this->file
->repo
->fileExistsBatch( $files, FSRepo
::FILES_ONLY
);
1918 foreach ( $triplets as $file ) {
1919 if ( $result[$file[0]] ) {
1920 $filteredTriplets[] = $file;
1924 return $filteredTriplets;
1928 * Removes non-existent files from a cleanup batch.
1930 function removeNonexistentFromCleanup( $batch ) {
1931 $files = $newBatch = array();
1932 $repo = $this->file
->repo
;
1934 foreach ( $batch as $file ) {
1935 $files[$file] = $repo->getVirtualUrl( 'deleted' ) . '/' .
1936 rawurlencode( $repo->getDeletedHashPath( $file ) . $file );
1939 $result = $repo->fileExistsBatch( $files, FSRepo
::FILES_ONLY
);
1941 foreach ( $batch as $file ) {
1942 if ( $result[$file] ) {
1943 $newBatch[] = $file;
1951 * Delete unused files in the deleted zone.
1952 * This should be called from outside the transaction in which execute() was called.
1954 function cleanup() {
1955 if ( !$this->cleanupBatch
) {
1956 return $this->file
->repo
->newGood();
1959 $this->cleanupBatch
= $this->removeNonexistentFromCleanup( $this->cleanupBatch
);
1961 $status = $this->file
->repo
->cleanupDeletedBatch( $this->cleanupBatch
);
1966 function cleanupFailedBatch( $storeStatus, $storeBatch ) {
1967 $cleanupBatch = array();
1969 foreach ( $storeStatus->success
as $i => $success ) {
1971 $cleanupBatch[] = array( $storeBatch[$i][1], $storeBatch[$i][1] );
1974 $this->file
->repo
->cleanupBatch( $cleanupBatch );
1978 # ------------------------------------------------------------------------------
1981 * Helper class for file movement
1984 class LocalFileMoveBatch
{
1985 var $file, $cur, $olds, $oldCount, $archive, $target, $db;
1987 function __construct( File
$file, Title
$target ) {
1988 $this->file
= $file;
1989 $this->target
= $target;
1990 $this->oldHash
= $this->file
->repo
->getHashPath( $this->file
->getName() );
1991 $this->newHash
= $this->file
->repo
->getHashPath( $this->target
->getDBkey() );
1992 $this->oldName
= $this->file
->getName();
1993 $this->newName
= $this->file
->repo
->getNameFromTitle( $this->target
);
1994 $this->oldRel
= $this->oldHash
. $this->oldName
;
1995 $this->newRel
= $this->newHash
. $this->newName
;
1996 $this->db
= $file->repo
->getMasterDb();
2000 * Add the current image to the batch
2002 function addCurrent() {
2003 $this->cur
= array( $this->oldRel
, $this->newRel
);
2007 * Add the old versions of the image to the batch
2009 function addOlds() {
2010 $archiveBase = 'archive';
2011 $this->olds
= array();
2012 $this->oldCount
= 0;
2014 $result = $this->db
->select( 'oldimage',
2015 array( 'oi_archive_name', 'oi_deleted' ),
2016 array( 'oi_name' => $this->oldName
),
2020 foreach ( $result as $row ) {
2021 $oldName = $row->oi_archive_name
;
2022 $bits = explode( '!', $oldName, 2 );
2024 if ( count( $bits ) != 2 ) {
2025 wfDebug( "Invalid old file name: $oldName \n" );
2029 list( $timestamp, $filename ) = $bits;
2031 if ( $this->oldName
!= $filename ) {
2032 wfDebug( "Invalid old file name: $oldName \n" );
2038 // Do we want to add those to oldCount?
2039 if ( $row->oi_deleted
& File
::DELETED_FILE
) {
2043 $this->olds
[] = array(
2044 "{$archiveBase}/{$this->oldHash}{$oldName}",
2045 "{$archiveBase}/{$this->newHash}{$timestamp}!{$this->newName}"
2053 function execute() {
2054 $repo = $this->file
->repo
;
2055 $status = $repo->newGood();
2056 $triplets = $this->getMoveTriplets();
2058 $triplets = $this->removeNonexistentFiles( $triplets );
2060 // Copy the files into their new location
2061 $statusMove = $repo->storeBatch( $triplets );
2062 wfDebugLog( 'imagemove', "Moved files for {$this->file->name}: {$statusMove->successCount} successes, {$statusMove->failCount} failures" );
2063 if ( !$statusMove->isGood() ) {
2064 wfDebugLog( 'imagemove', "Error in moving files: " . $statusMove->getWikiText() );
2065 $this->cleanupTarget( $triplets );
2066 $statusMove->ok
= false;
2071 $statusDb = $this->doDBUpdates();
2072 wfDebugLog( 'imagemove', "Renamed {$this->file->name} in database: {$statusDb->successCount} successes, {$statusDb->failCount} failures" );
2073 if ( !$statusDb->isGood() ) {
2074 $this->db
->rollback();
2075 // Something went wrong with the DB updates, so remove the target files
2076 $this->cleanupTarget( $triplets );
2077 $statusDb->ok
= false;
2080 $this->db
->commit();
2082 // Everything went ok, remove the source files
2083 $this->cleanupSource( $triplets );
2085 $status->merge( $statusDb );
2086 $status->merge( $statusMove );
2092 * Do the database updates and return a new FileRepoStatus indicating how
2093 * many rows where updated.
2095 * @return FileRepoStatus
2097 function doDBUpdates() {
2098 $repo = $this->file
->repo
;
2099 $status = $repo->newGood();
2102 // Update current image
2105 array( 'img_name' => $this->newName
),
2106 array( 'img_name' => $this->oldName
),
2110 if ( $dbw->affectedRows() ) {
2111 $status->successCount++
;
2113 $status->failCount++
;
2114 $status->fatal( 'imageinvalidfilename' );
2118 // Update old images
2122 'oi_name' => $this->newName
,
2123 'oi_archive_name = ' . $dbw->strreplace( 'oi_archive_name', $dbw->addQuotes( $this->oldName
), $dbw->addQuotes( $this->newName
) ),
2125 array( 'oi_name' => $this->oldName
),
2129 $affected = $dbw->affectedRows();
2130 $total = $this->oldCount
;
2131 $status->successCount +
= $affected;
2132 $status->failCount +
= $total - $affected;
2133 if ( $status->failCount
) {
2134 $status->error( 'imageinvalidfilename' );
2141 * Generate triplets for FSRepo::storeBatch().
2143 function getMoveTriplets() {
2144 $moves = array_merge( array( $this->cur
), $this->olds
);
2145 $triplets = array(); // The format is: (srcUrl, destZone, destUrl)
2147 foreach ( $moves as $move ) {
2148 // $move: (oldRelativePath, newRelativePath)
2149 $srcUrl = $this->file
->repo
->getVirtualUrl() . '/public/' . rawurlencode( $move[0] );
2150 $triplets[] = array( $srcUrl, 'public', $move[1] );
2151 wfDebugLog( 'imagemove', "Generated move triplet for {$this->file->name}: {$srcUrl} :: public :: {$move[1]}" );
2158 * Removes non-existent files from move batch.
2160 function removeNonexistentFiles( $triplets ) {
2163 foreach ( $triplets as $file ) {
2164 $files[$file[0]] = $file[0];
2167 $result = $this->file
->repo
->fileExistsBatch( $files, FSRepo
::FILES_ONLY
);
2168 $filteredTriplets = array();
2170 foreach ( $triplets as $file ) {
2171 if ( $result[$file[0]] ) {
2172 $filteredTriplets[] = $file;
2174 wfDebugLog( 'imagemove', "File {$file[0]} does not exist" );
2178 return $filteredTriplets;
2182 * Cleanup a partially moved array of triplets by deleting the target
2183 * files. Called if something went wrong half way.
2185 function cleanupTarget( $triplets ) {
2186 // Create dest pairs from the triplets
2188 foreach ( $triplets as $triplet ) {
2189 $pairs[] = array( $triplet[1], $triplet[2] );
2192 $this->file
->repo
->cleanupBatch( $pairs );
2196 * Cleanup a fully moved array of triplets by deleting the source files.
2197 * Called at the end of the move process if everything else went ok.
2199 function cleanupSource( $triplets ) {
2200 // Create source file names from the triplets
2202 foreach ( $triplets as $triplet ) {
2203 $files[] = $triplet[0];
2206 $this->file
->repo
->cleanupBatch( $files );