6 * Bump this number when serialized cache records may be incompatible.
8 define( 'MW_FILE_VERSION', 8 );
11 * Class to represent a local file in the wiki's own database
13 * Provides methods to retrieve paths (physical, logical, URL),
14 * to generate image thumbnails or for uploading.
16 * Note that only the repo object knows what its file class is called. You should
17 * never name a file class explictly outside of the repo class. Instead use the
18 * repo's factory functions to generate file objects, for example:
20 * RepoGroup::singleton()->getLocalRepo()->newFile($title);
22 * The convenience functions wfLocalFile() and wfFindFile() should be sufficient
27 class LocalFile
extends File
32 var $fileExists, # does the file file exist on disk? (loadFromXxx)
33 $historyLine, # Number of line to return by nextHistoryLine() (constructor)
34 $historyRes, # result of the query for the file's history (nextHistoryLine)
37 $bits, # --- returned by getimagesize (loadFromXxx)
39 $media_type, # MEDIATYPE_xxx (bitmap, drawing, audio...)
40 $mime, # MIME type, determined by MimeMagic::guessMimeType
41 $major_mime, # Major mime type
42 $minor_mime, # Minor mime type
43 $size, # Size in bytes (loadFromXxx)
44 $metadata, # Handler-specific metadata
45 $timestamp, # Upload timestamp
46 $sha1, # SHA-1 base 36 content hash
47 $user, $user_text, # User, who uploaded the file
48 $description, # Description of current revision of the file
49 $dataLoaded, # Whether or not all this has been loaded from the database (loadFromXxx)
50 $upgraded, # Whether the row was upgraded on load
51 $locked, # True if the image row is locked
52 $deleted; # Bitfield akin to rev_deleted
57 * Create a LocalFile from a title
58 * Do not call this except from inside a repo class.
60 * Note: $unused param is only here to avoid an E_STRICT
62 static function newFromTitle( $title, $repo, $unused = null ) {
63 return new self( $title, $repo );
67 * Create a LocalFile from a title
68 * Do not call this except from inside a repo class.
70 static function newFromRow( $row, $repo ) {
71 $title = Title
::makeTitle( NS_FILE
, $row->img_name
);
72 $file = new self( $title, $repo );
73 $file->loadFromRow( $row );
78 * Create a LocalFile from a SHA-1 key
79 * Do not call this except from inside a repo class.
81 static function newFromKey( $sha1, $repo, $timestamp = false ) {
82 # Polymorphic function name to distinguish foreign and local fetches
83 $fname = get_class( $this ) . '::' . __FUNCTION__
;
85 $conds = array( 'img_sha1' => $sha1 );
87 $conds['img_timestamp'] = $timestamp;
89 $row = $dbr->selectRow( 'image', $this->getCacheFields( 'img_' ), $conds, $fname );
91 return self
::newFromRow( $row, $repo );
98 * Fields in the image table
100 static function selectFields() {
121 * Do not call this except from inside a repo class.
123 function __construct( $title, $repo ) {
124 if( !is_object( $title ) ) {
125 throw new MWException( __CLASS__
.' constructor given bogus title.' );
127 parent
::__construct( $title, $repo );
128 $this->metadata
= '';
129 $this->historyLine
= 0;
130 $this->historyRes
= null;
131 $this->dataLoaded
= false;
135 * Get the memcached key
137 function getCacheKey() {
138 $hashedName = md5($this->getName());
139 return wfMemcKey( 'file', $hashedName );
143 * Try to load file metadata from memcached. Returns true on success.
145 function loadFromCache() {
147 wfProfileIn( __METHOD__
);
148 $this->dataLoaded
= false;
149 $key = $this->getCacheKey();
153 $cachedValues = $wgMemc->get( $key );
155 // Check if the key existed and belongs to this version of MediaWiki
156 if ( isset($cachedValues['version']) && ( $cachedValues['version'] == MW_FILE_VERSION
) ) {
157 wfDebug( "Pulling file metadata from cache key $key\n" );
158 $this->fileExists
= $cachedValues['fileExists'];
159 if ( $this->fileExists
) {
160 $this->setProps( $cachedValues );
162 $this->dataLoaded
= true;
164 if ( $this->dataLoaded
) {
165 wfIncrStats( 'image_cache_hit' );
167 wfIncrStats( 'image_cache_miss' );
170 wfProfileOut( __METHOD__
);
171 return $this->dataLoaded
;
175 * Save the file metadata to memcached
177 function saveToCache() {
180 $key = $this->getCacheKey();
184 $fields = $this->getCacheFields( '' );
185 $cache = array( 'version' => MW_FILE_VERSION
);
186 $cache['fileExists'] = $this->fileExists
;
187 if ( $this->fileExists
) {
188 foreach ( $fields as $field ) {
189 $cache[$field] = $this->$field;
193 $wgMemc->set( $key, $cache, 60 * 60 * 24 * 7 ); // A week
197 * Load metadata from the file itself
199 function loadFromFile() {
200 $this->setProps( self
::getPropsFromPath( $this->getPath() ) );
203 function getCacheFields( $prefix = 'img_' ) {
204 static $fields = array( 'size', 'width', 'height', 'bits', 'media_type',
205 'major_mime', 'minor_mime', 'metadata', 'timestamp', 'sha1', 'user', 'user_text', 'description' );
206 static $results = array();
207 if ( $prefix == '' ) {
210 if ( !isset( $results[$prefix] ) ) {
211 $prefixedFields = array();
212 foreach ( $fields as $field ) {
213 $prefixedFields[] = $prefix . $field;
215 $results[$prefix] = $prefixedFields;
217 return $results[$prefix];
221 * Load file metadata from the DB
223 function loadFromDB() {
224 # Polymorphic function name to distinguish foreign and local fetches
225 $fname = get_class( $this ) . '::' . __FUNCTION__
;
226 wfProfileIn( $fname );
228 # Unconditionally set loaded=true, we don't want the accessors constantly rechecking
229 $this->dataLoaded
= true;
231 $dbr = $this->repo
->getMasterDB();
233 $row = $dbr->selectRow( 'image', $this->getCacheFields( 'img_' ),
234 array( 'img_name' => $this->getName() ), $fname );
236 $this->loadFromRow( $row );
238 $this->fileExists
= false;
241 wfProfileOut( $fname );
245 * Decode a row from the database (either object or array) to an array
246 * with timestamps and MIME types decoded, and the field prefix removed.
248 function decodeRow( $row, $prefix = 'img_' ) {
249 $array = (array)$row;
250 $prefixLength = strlen( $prefix );
251 // Sanity check prefix once
252 if ( substr( key( $array ), 0, $prefixLength ) !== $prefix ) {
253 throw new MWException( __METHOD__
. ': incorrect $prefix parameter' );
256 foreach ( $array as $name => $value ) {
257 $decoded[substr( $name, $prefixLength )] = $value;
259 $decoded['timestamp'] = wfTimestamp( TS_MW
, $decoded['timestamp'] );
260 if ( empty( $decoded['major_mime'] ) ) {
261 $decoded['mime'] = "unknown/unknown";
263 if (!$decoded['minor_mime']) {
264 $decoded['minor_mime'] = "unknown";
266 $decoded['mime'] = $decoded['major_mime'].'/'.$decoded['minor_mime'];
268 # Trim zero padding from char/binary field
269 $decoded['sha1'] = rtrim( $decoded['sha1'], "\0" );
274 * Load file metadata from a DB result row
276 function loadFromRow( $row, $prefix = 'img_' ) {
277 $this->dataLoaded
= true;
278 $array = $this->decodeRow( $row, $prefix );
279 foreach ( $array as $name => $value ) {
280 $this->$name = $value;
282 $this->fileExists
= true;
283 $this->maybeUpgradeRow();
287 * Load file metadata from cache or DB, unless already loaded
290 if ( !$this->dataLoaded
) {
291 if ( !$this->loadFromCache() ) {
293 $this->saveToCache();
295 $this->dataLoaded
= true;
300 * Upgrade a row if it needs it
302 function maybeUpgradeRow() {
303 if ( wfReadOnly() ) {
306 if ( is_null($this->media_type
) ||
307 $this->mime
== 'image/svg'
310 $this->upgraded
= true;
312 $handler = $this->getHandler();
313 if ( $handler && !$handler->isMetadataValid( $this, $this->metadata
) ) {
315 $this->upgraded
= true;
320 function getUpgraded() {
321 return $this->upgraded
;
325 * Fix assorted version-related problems with the image row by reloading it from the file
327 function upgradeRow() {
328 wfProfileIn( __METHOD__
);
330 $this->loadFromFile();
332 # Don't destroy file info of missing files
333 if ( !$this->fileExists
) {
334 wfDebug( __METHOD__
.": file does not exist, aborting\n" );
337 $dbw = $this->repo
->getMasterDB();
338 list( $major, $minor ) = self
::splitMime( $this->mime
);
340 if ( wfReadOnly() ) {
343 wfDebug(__METHOD__
.': upgrading '.$this->getName()." to the current schema\n");
345 $dbw->update( 'image',
347 'img_width' => $this->width
,
348 'img_height' => $this->height
,
349 'img_bits' => $this->bits
,
350 'img_media_type' => $this->media_type
,
351 'img_major_mime' => $major,
352 'img_minor_mime' => $minor,
353 'img_metadata' => $this->metadata
,
354 'img_sha1' => $this->sha1
,
355 ), array( 'img_name' => $this->getName() ),
358 $this->saveToCache();
359 wfProfileOut( __METHOD__
);
363 * Set properties in this object to be equal to those given in the
364 * associative array $info. Only cacheable fields can be set.
366 * If 'mime' is given, it will be split into major_mime/minor_mime.
367 * If major_mime/minor_mime are given, $this->mime will also be set.
369 function setProps( $info ) {
370 $this->dataLoaded
= true;
371 $fields = $this->getCacheFields( '' );
372 $fields[] = 'fileExists';
373 foreach ( $fields as $field ) {
374 if ( isset( $info[$field] ) ) {
375 $this->$field = $info[$field];
378 // Fix up mime fields
379 if ( isset( $info['major_mime'] ) ) {
380 $this->mime
= "{$info['major_mime']}/{$info['minor_mime']}";
381 } elseif ( isset( $info['mime'] ) ) {
382 list( $this->major_mime
, $this->minor_mime
) = self
::splitMime( $this->mime
);
386 /** splitMime inherited */
387 /** getName inherited */
388 /** getTitle inherited */
389 /** getURL inherited */
390 /** getViewURL inherited */
391 /** getPath inherited */
392 /** isVisible inhereted */
395 * Return the width of the image
397 * Returns false on error
400 function getWidth( $page = 1 ) {
402 if ( $this->isMultipage() ) {
403 $dim = $this->getHandler()->getPageDimensions( $this, $page );
405 return $dim['width'];
415 * Return the height of the image
417 * Returns false on error
420 function getHeight( $page = 1 ) {
422 if ( $this->isMultipage() ) {
423 $dim = $this->getHandler()->getPageDimensions( $this, $page );
425 return $dim['height'];
430 return $this->height
;
435 * Returns ID or name of user who uploaded the file
437 * @param $type string 'text' or 'id'
439 function getUser($type='text') {
441 if( $type == 'text' ) {
442 return $this->user_text
;
443 } elseif( $type == 'id' ) {
449 * Get handler-specific metadata
451 function getMetadata() {
453 return $this->metadata
;
456 function getBitDepth() {
462 * Return the size of the image file, in bytes
471 * Returns the mime type of the file.
473 function getMimeType() {
479 * Return the type of the media in the file.
480 * Use the value returned by this function with the MEDIATYPE_xxx constants.
482 function getMediaType() {
484 return $this->media_type
;
487 /** canRender inherited */
488 /** mustRender inherited */
489 /** allowInlineDisplay inherited */
490 /** isSafeFile inherited */
491 /** isTrustedFile inherited */
494 * Returns true if the file file exists on disk.
495 * @return boolean Whether file file exist on disk.
500 return $this->fileExists
;
503 /** getTransformScript inherited */
504 /** getUnscaledThumb inherited */
505 /** thumbName inherited */
506 /** createThumb inherited */
507 /** getThumbnail inherited */
508 /** transform inherited */
511 * Fix thumbnail files from 1.4 or before, with extreme prejudice
513 function migrateThumbFile( $thumbName ) {
514 $thumbDir = $this->getThumbPath();
515 $thumbPath = "$thumbDir/$thumbName";
516 if ( is_dir( $thumbPath ) ) {
517 // Directory where file should be
518 // This happened occasionally due to broken migration code in 1.5
519 // Rename to broken-*
520 for ( $i = 0; $i < 100 ; $i++
) {
521 $broken = $this->repo
->getZonePath('public') . "/broken-$i-$thumbName";
522 if ( !file_exists( $broken ) ) {
523 rename( $thumbPath, $broken );
527 // Doesn't exist anymore
530 if ( is_file( $thumbDir ) ) {
531 // File where directory should be
533 // Doesn't exist anymore
538 /** getHandler inherited */
539 /** iconThumb inherited */
540 /** getLastError inherited */
543 * Get all thumbnail names previously generated for this file
545 function getThumbnails() {
548 $dir = $this->getThumbPath();
550 if ( is_dir( $dir ) ) {
551 $handle = opendir( $dir );
554 while ( false !== ( $file = readdir($handle) ) ) {
555 if ( $file{0} != '.' ) {
567 * Refresh metadata in memcached, but don't touch thumbnails or squid
569 function purgeMetadataCache() {
571 $this->saveToCache();
572 $this->purgeHistory();
576 * Purge the shared history (OldLocalFile) cache
578 function purgeHistory() {
580 $hashedName = md5($this->getName());
581 $oldKey = wfMemcKey( 'oldfile', $hashedName );
582 $wgMemc->delete( $oldKey );
586 * Delete all previously generated thumbnails, refresh metadata in memcached and purge the squid
588 function purgeCache() {
589 // Refresh metadata cache
590 $this->purgeMetadataCache();
593 $this->purgeThumbnails();
595 // Purge squid cache for this file
596 SquidUpdate
::purge( array( $this->getURL() ) );
600 * Delete cached transformed files
602 function purgeThumbnails() {
605 $files = $this->getThumbnails();
606 $dir = $this->getThumbPath();
608 foreach ( $files as $file ) {
609 # Check that the base file name is part of the thumb name
610 # This is a basic sanity check to avoid erasing unrelated directories
611 if ( strpos( $file, $this->getName() ) !== false ) {
612 $url = $this->getThumbUrl( $file );
614 @unlink
( "$dir/$file" );
620 SquidUpdate
::purge( $urls );
624 /** purgeDescription inherited */
625 /** purgeEverything inherited */
627 function getHistory($limit = null, $start = null, $end = null, $inc = true) {
628 $dbr = $this->repo
->getSlaveDB();
629 $tables = array('oldimage');
630 $fields = OldLocalFile
::selectFields();
631 $conds = $opts = $join_conds = array();
632 $eq = $inc ?
"=" : "";
633 $conds[] = "oi_name = " . $dbr->addQuotes( $this->title
->getDBKey() );
635 $conds[] = "oi_timestamp <$eq " . $dbr->addQuotes( $dbr->timestamp( $start ) );
638 $conds[] = "oi_timestamp >$eq " . $dbr->addQuotes( $dbr->timestamp( $end ) );
641 $opts['LIMIT'] = $limit;
643 // Search backwards for time > x queries
644 $order = (!$start && $end !== null) ?
"ASC" : "DESC";
645 $opts['ORDER BY'] = "oi_timestamp $order";
647 wfRunHooks( 'LocalFile::getHistory', array( &$this, &$tables, &$fields,
648 &$conds, &$opts, &$join_conds ) );
650 $res = $dbr->select( $tables, $fields, $conds, __METHOD__
, $opts, $join_conds );
652 while( $row = $dbr->fetchObject($res) ) {
653 $r[] = OldLocalFile
::newFromRow($row, $this->repo
);
655 if( $order == "ASC" ) {
656 $r = array_reverse( $r ); // make sure it ends up descending
662 * Return the history of this file, line by line.
663 * starts with current version, then old versions.
664 * uses $this->historyLine to check which line to return:
665 * 0 return line for current version
666 * 1 query for old versions, return first one
667 * 2, ... return next old version from above query
671 function nextHistoryLine() {
672 # Polymorphic function name to distinguish foreign and local fetches
673 $fname = get_class( $this ) . '::' . __FUNCTION__
;
675 $dbr = $this->repo
->getSlaveDB();
677 if ( $this->historyLine
== 0 ) {// called for the first time, return line from cur
678 $this->historyRes
= $dbr->select( 'image',
681 "'' AS oi_archive_name",
685 array( 'img_name' => $this->title
->getDBkey() ),
688 if ( 0 == $dbr->numRows( $this->historyRes
) ) {
689 $dbr->freeResult($this->historyRes
);
690 $this->historyRes
= null;
693 } else if ( $this->historyLine
== 1 ) {
694 $dbr->freeResult($this->historyRes
);
695 $this->historyRes
= $dbr->select( 'oldimage', '*',
696 array( 'oi_name' => $this->title
->getDBkey() ),
698 array( 'ORDER BY' => 'oi_timestamp DESC' )
701 $this->historyLine ++
;
703 return $dbr->fetchObject( $this->historyRes
);
707 * Reset the history pointer to the first element of the history
710 function resetHistory() {
711 $this->historyLine
= 0;
712 if (!is_null($this->historyRes
)) {
713 $this->repo
->getSlaveDB()->freeResult($this->historyRes
);
714 $this->historyRes
= null;
718 /** getFullPath inherited */
719 /** getHashPath inherited */
720 /** getRel inherited */
721 /** getUrlRel inherited */
722 /** getArchiveRel inherited */
723 /** getThumbRel inherited */
724 /** getArchivePath inherited */
725 /** getThumbPath inherited */
726 /** getArchiveUrl inherited */
727 /** getThumbUrl inherited */
728 /** getArchiveVirtualUrl inherited */
729 /** getThumbVirtualUrl inherited */
730 /** isHashed inherited */
733 * Upload a file and record it in the DB
734 * @param string $srcPath Source path or virtual URL
735 * @param string $comment Upload description
736 * @param string $pageText Text to use for the new description page, if a new description page is created
737 * @param integer $flags Flags for publish()
738 * @param array $props File properties, if known. This can be used to reduce the
739 * upload time when uploading virtual URLs for which the file info
741 * @param string $timestamp Timestamp for img_timestamp, or false to use the current time
743 * @return FileRepoStatus object. On success, the value member contains the
744 * archive name, or an empty string if it was a new file.
746 function upload( $srcPath, $comment, $pageText, $flags = 0, $props = false, $timestamp = false, $user = null ) {
748 $status = $this->publish( $srcPath, $flags );
750 if ( !$this->recordUpload2( $status->value
, $comment, $pageText, $props, $timestamp, $user ) ) {
751 $status->fatal( 'filenotfound', $srcPath );
759 * Record a file upload in the upload log and the image table
760 * @deprecated use upload()
762 function recordUpload( $oldver, $desc, $license = '', $copyStatus = '', $source = '',
763 $watch = false, $timestamp = false )
765 $pageText = UploadForm
::getInitialPageText( $desc, $license, $copyStatus, $source );
766 if ( !$this->recordUpload2( $oldver, $desc, $pageText ) ) {
771 $wgUser->addWatch( $this->getTitle() );
778 * Record a file upload in the upload log and the image table
780 function recordUpload2( $oldver, $comment, $pageText, $props = false, $timestamp = false, $user = null )
782 if( is_null( $user ) ) {
787 $dbw = $this->repo
->getMasterDB();
791 $props = $this->repo
->getFileProps( $this->getVirtualUrl() );
793 $props['description'] = $comment;
794 $props['user'] = $user->getId();
795 $props['user_text'] = $user->getName();
796 $props['timestamp'] = wfTimestamp( TS_MW
);
797 $this->setProps( $props );
799 // Delete thumbnails and refresh the metadata cache
800 $this->purgeThumbnails();
801 $this->saveToCache();
802 SquidUpdate
::purge( array( $this->getURL() ) );
804 // Fail now if the file isn't there
805 if ( !$this->fileExists
) {
806 wfDebug( __METHOD__
.": File ".$this->getPath()." went missing!\n" );
811 if ( $timestamp === false ) {
812 $timestamp = $dbw->timestamp();
815 # Test to see if the row exists using INSERT IGNORE
816 # This avoids race conditions by locking the row until the commit, and also
817 # doesn't deadlock. SELECT FOR UPDATE causes a deadlock for every race condition.
818 $dbw->insert( 'image',
820 'img_name' => $this->getName(),
821 'img_size'=> $this->size
,
822 'img_width' => intval( $this->width
),
823 'img_height' => intval( $this->height
),
824 'img_bits' => $this->bits
,
825 'img_media_type' => $this->media_type
,
826 'img_major_mime' => $this->major_mime
,
827 'img_minor_mime' => $this->minor_mime
,
828 'img_timestamp' => $timestamp,
829 'img_description' => $comment,
830 'img_user' => $user->getId(),
831 'img_user_text' => $user->getName(),
832 'img_metadata' => $this->metadata
,
833 'img_sha1' => $this->sha1
839 if( $dbw->affectedRows() == 0 ) {
842 # Collision, this is an update of a file
843 # Insert previous contents into oldimage
844 $dbw->insertSelect( 'oldimage', 'image',
846 'oi_name' => 'img_name',
847 'oi_archive_name' => $dbw->addQuotes( $oldver ),
848 'oi_size' => 'img_size',
849 'oi_width' => 'img_width',
850 'oi_height' => 'img_height',
851 'oi_bits' => 'img_bits',
852 'oi_timestamp' => 'img_timestamp',
853 'oi_description' => 'img_description',
854 'oi_user' => 'img_user',
855 'oi_user_text' => 'img_user_text',
856 'oi_metadata' => 'img_metadata',
857 'oi_media_type' => 'img_media_type',
858 'oi_major_mime' => 'img_major_mime',
859 'oi_minor_mime' => 'img_minor_mime',
860 'oi_sha1' => 'img_sha1'
861 ), array( 'img_name' => $this->getName() ), __METHOD__
864 # Update the current image row
865 $dbw->update( 'image',
867 'img_size' => $this->size
,
868 'img_width' => intval( $this->width
),
869 'img_height' => intval( $this->height
),
870 'img_bits' => $this->bits
,
871 'img_media_type' => $this->media_type
,
872 'img_major_mime' => $this->major_mime
,
873 'img_minor_mime' => $this->minor_mime
,
874 'img_timestamp' => $timestamp,
875 'img_description' => $comment,
876 'img_user' => $user->getId(),
877 'img_user_text' => $user->getName(),
878 'img_metadata' => $this->metadata
,
879 'img_sha1' => $this->sha1
880 ), array( /* WHERE */
881 'img_name' => $this->getName()
886 # Update the image count
887 $site_stats = $dbw->tableName( 'site_stats' );
888 $dbw->query( "UPDATE $site_stats SET ss_images=ss_images+1", __METHOD__
);
891 $descTitle = $this->getTitle();
892 $article = new ImagePage( $descTitle );
893 $article->setFile( $this );
896 $log = new LogPage( 'upload' );
897 $action = $reupload ?
'overwrite' : 'upload';
898 $log->addEntry( $action, $descTitle, $comment, array(), $user );
900 if( $descTitle->exists() ) {
901 # Create a null revision
902 $latest = $descTitle->getLatestRevID();
903 $nullRevision = Revision
::newNullRevision( $dbw, $descTitle->getArticleId(),
904 $log->getRcComment(), false );
905 $nullRevision->insertOn( $dbw );
907 wfRunHooks( 'NewRevisionFromEditComplete', array($article, $nullRevision, $latest, $user) );
908 $article->updateRevisionOn( $dbw, $nullRevision );
910 # Invalidate the cache for the description page
911 $descTitle->invalidateCache();
912 $descTitle->purgeSquid();
914 // New file; create the description page.
915 // There's already a log entry, so don't make a second RC entry
916 $article->doEdit( $pageText, $comment, EDIT_NEW | EDIT_SUPPRESS_RC
);
919 # Hooks, hooks, the magic of hooks...
920 wfRunHooks( 'FileUpload', array( $this ) );
922 # Commit the transaction now, in case something goes wrong later
923 # The most important thing is that files don't get lost, especially archives
924 $dbw->immediateCommit();
926 # Invalidate cache for all pages using this file
927 $update = new HTMLCacheUpdate( $this->getTitle(), 'imagelinks' );
929 # Invalidate cache for all pages that redirects on this page
930 $redirs = $this->getTitle()->getRedirectsHere();
931 foreach( $redirs as $redir ) {
932 $update = new HTMLCacheUpdate( $redir, 'imagelinks' );
940 * Move or copy a file to its public location. If a file exists at the
941 * destination, move it to an archive. Returns the archive name on success
942 * or an empty string if it was a new file, and a wikitext-formatted
943 * WikiError object on failure.
945 * The archive name should be passed through to recordUpload for database
948 * @param string $sourcePath Local filesystem path to the source image
949 * @param integer $flags A bitwise combination of:
950 * File::DELETE_SOURCE Delete the source file, i.e. move
952 * @return FileRepoStatus object. On success, the value member contains the
953 * archive name, or an empty string if it was a new file.
955 function publish( $srcPath, $flags = 0 ) {
957 $dstRel = $this->getRel();
958 $archiveName = gmdate( 'YmdHis' ) . '!'. $this->getName();
959 $archiveRel = 'archive/' . $this->getHashPath() . $archiveName;
960 $flags = $flags & File
::DELETE_SOURCE ? LocalRepo
::DELETE_SOURCE
: 0;
961 $status = $this->repo
->publish( $srcPath, $dstRel, $archiveRel, $flags );
962 if ( $status->value
== 'new' ) {
965 $status->value
= $archiveName;
971 /** getLinksTo inherited */
972 /** getExifData inherited */
973 /** isLocal inherited */
974 /** wasDeleted inherited */
977 * Move file to the new title
979 * Move current, old version and all thumbnails
980 * to the new filename. Old file is deleted.
982 * Cache purging is done; checks for validity
983 * and logging are caller's responsibility
985 * @param $target Title New file name
986 * @return FileRepoStatus object.
988 function move( $target ) {
989 wfDebugLog( 'imagemove', "Got request to move {$this->name} to " . $target->getText() );
991 $batch = new LocalFileMoveBatch( $this, $target );
992 $batch->addCurrent();
995 $status = $batch->execute();
996 wfDebugLog( 'imagemove', "Finished moving {$this->name}" );
997 $this->purgeEverything();
1000 if ( $status->isOk() ) {
1001 // Now switch the object
1002 $this->title
= $target;
1003 // Force regeneration of the name and hashpath
1004 unset( $this->name
);
1005 unset( $this->hashPath
);
1006 // Purge the new image
1007 $this->purgeEverything();
1014 * Delete all versions of the file.
1016 * Moves the files into an archive directory (or deletes them)
1017 * and removes the database rows.
1019 * Cache purging is done; logging is caller's responsibility.
1023 * @return FileRepoStatus object.
1025 function delete( $reason, $suppress = false ) {
1027 $batch = new LocalFileDeleteBatch( $this, $reason, $suppress );
1028 $batch->addCurrent();
1030 # Get old version relative paths
1031 $dbw = $this->repo
->getMasterDB();
1032 $result = $dbw->select( 'oldimage',
1033 array( 'oi_archive_name' ),
1034 array( 'oi_name' => $this->getName() ) );
1035 while ( $row = $dbw->fetchObject( $result ) ) {
1036 $batch->addOld( $row->oi_archive_name
);
1038 $status = $batch->execute();
1040 if ( $status->ok
) {
1041 // Update site_stats
1042 $site_stats = $dbw->tableName( 'site_stats' );
1043 $dbw->query( "UPDATE $site_stats SET ss_images=ss_images-1", __METHOD__
);
1044 $this->purgeEverything();
1052 * Delete an old version of the file.
1054 * Moves the file into an archive directory (or deletes it)
1055 * and removes the database row.
1057 * Cache purging is done; logging is caller's responsibility.
1061 * @throws MWException or FSException on database or filestore failure
1062 * @return FileRepoStatus object.
1064 function deleteOld( $archiveName, $reason, $suppress=false ) {
1066 $batch = new LocalFileDeleteBatch( $this, $reason, $suppress );
1067 $batch->addOld( $archiveName );
1068 $status = $batch->execute();
1070 if ( $status->ok
) {
1071 $this->purgeDescription();
1072 $this->purgeHistory();
1078 * Restore all or specified deleted revisions to the given file.
1079 * Permissions and logging are left to the caller.
1081 * May throw database exceptions on error.
1083 * @param $versions set of record ids of deleted items to restore,
1084 * or empty to restore all revisions.
1086 * @return FileRepoStatus
1088 function restore( $versions = array(), $unsuppress = false ) {
1089 $batch = new LocalFileRestoreBatch( $this, $unsuppress );
1093 $batch->addIds( $versions );
1095 $status = $batch->execute();
1096 if ( !$status->ok
) {
1100 $cleanupStatus = $batch->cleanup();
1101 $cleanupStatus->successCount
= 0;
1102 $cleanupStatus->failCount
= 0;
1103 $status->merge( $cleanupStatus );
1107 /** isMultipage inherited */
1108 /** pageCount inherited */
1109 /** scaleHeight inherited */
1110 /** getImageSize inherited */
1113 * Get the URL of the file description page.
1115 function getDescriptionUrl() {
1116 return $this->title
->getLocalUrl();
1120 * Get the HTML text of the description page
1121 * This is not used by ImagePage for local files, since (among other things)
1122 * it skips the parser cache.
1124 function getDescriptionText() {
1126 $revision = Revision
::newFromTitle( $this->title
);
1127 if ( !$revision ) return false;
1128 $text = $revision->getText();
1129 if ( !$text ) return false;
1130 $pout = $wgParser->parse( $text, $this->title
, new ParserOptions() );
1131 return $pout->getText();
1134 function getDescription() {
1136 return $this->description
;
1139 function getTimestamp() {
1141 return $this->timestamp
;
1144 function getSha1() {
1146 // Initialise now if necessary
1147 if ( $this->sha1
== '' && $this->fileExists
) {
1148 $this->sha1
= File
::sha1Base36( $this->getPath() );
1149 if ( !wfReadOnly() && strval( $this->sha1
) != '' ) {
1150 $dbw = $this->repo
->getMasterDB();
1151 $dbw->update( 'image',
1152 array( 'img_sha1' => $this->sha1
),
1153 array( 'img_name' => $this->getName() ),
1155 $this->saveToCache();
1163 * Start a transaction and lock the image for update
1164 * Increments a reference counter if the lock is already held
1165 * @return boolean True if the image exists, false otherwise
1168 $dbw = $this->repo
->getMasterDB();
1169 if ( !$this->locked
) {
1173 return $dbw->selectField( 'image', '1', array( 'img_name' => $this->getName() ), __METHOD__
);
1177 * Decrement the lock reference count. If the reference count is reduced to zero, commits
1178 * the transaction and thereby releases the image lock.
1181 if ( $this->locked
) {
1183 if ( !$this->locked
) {
1184 $dbw = $this->repo
->getMasterDB();
1191 * Roll back the DB transaction and mark the image unlocked
1193 function unlockAndRollback() {
1194 $this->locked
= false;
1195 $dbw = $this->repo
->getMasterDB();
1198 } // LocalFile class
1200 #------------------------------------------------------------------------------
1203 * Helper class for file deletion
1206 class LocalFileDeleteBatch
{
1207 var $file, $reason, $srcRels = array(), $archiveUrls = array(), $deletionBatch, $suppress;
1210 function __construct( File
$file, $reason = '', $suppress = false ) {
1211 $this->file
= $file;
1212 $this->reason
= $reason;
1213 $this->suppress
= $suppress;
1214 $this->status
= $file->repo
->newGood();
1217 function addCurrent() {
1218 $this->srcRels
['.'] = $this->file
->getRel();
1221 function addOld( $oldName ) {
1222 $this->srcRels
[$oldName] = $this->file
->getArchiveRel( $oldName );
1223 $this->archiveUrls
[] = $this->file
->getArchiveUrl( $oldName );
1226 function getOldRels() {
1227 if ( !isset( $this->srcRels
['.'] ) ) {
1228 $oldRels =& $this->srcRels
;
1229 $deleteCurrent = false;
1231 $oldRels = $this->srcRels
;
1232 unset( $oldRels['.'] );
1233 $deleteCurrent = true;
1235 return array( $oldRels, $deleteCurrent );
1238 /*protected*/ function getHashes() {
1240 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
1241 if ( $deleteCurrent ) {
1242 $hashes['.'] = $this->file
->getSha1();
1244 if ( count( $oldRels ) ) {
1245 $dbw = $this->file
->repo
->getMasterDB();
1246 $res = $dbw->select( 'oldimage', array( 'oi_archive_name', 'oi_sha1' ),
1247 'oi_archive_name IN(' . $dbw->makeList( array_keys( $oldRels ) ) . ')',
1249 while ( $row = $dbw->fetchObject( $res ) ) {
1250 if ( rtrim( $row->oi_sha1
, "\0" ) === '' ) {
1251 // Get the hash from the file
1252 $oldUrl = $this->file
->getArchiveVirtualUrl( $row->oi_archive_name
);
1253 $props = $this->file
->repo
->getFileProps( $oldUrl );
1254 if ( $props['fileExists'] ) {
1255 // Upgrade the oldimage row
1256 $dbw->update( 'oldimage',
1257 array( 'oi_sha1' => $props['sha1'] ),
1258 array( 'oi_name' => $this->file
->getName(), 'oi_archive_name' => $row->oi_archive_name
),
1260 $hashes[$row->oi_archive_name
] = $props['sha1'];
1262 $hashes[$row->oi_archive_name
] = false;
1265 $hashes[$row->oi_archive_name
] = $row->oi_sha1
;
1269 $missing = array_diff_key( $this->srcRels
, $hashes );
1270 foreach ( $missing as $name => $rel ) {
1271 $this->status
->error( 'filedelete-old-unregistered', $name );
1273 foreach ( $hashes as $name => $hash ) {
1275 $this->status
->error( 'filedelete-missing', $this->srcRels
[$name] );
1276 unset( $hashes[$name] );
1283 function doDBInserts() {
1285 $dbw = $this->file
->repo
->getMasterDB();
1286 $encTimestamp = $dbw->addQuotes( $dbw->timestamp() );
1287 $encUserId = $dbw->addQuotes( $wgUser->getId() );
1288 $encReason = $dbw->addQuotes( $this->reason
);
1289 $encGroup = $dbw->addQuotes( 'deleted' );
1290 $ext = $this->file
->getExtension();
1291 $dotExt = $ext === '' ?
'' : ".$ext";
1292 $encExt = $dbw->addQuotes( $dotExt );
1293 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
1295 // Bitfields to further suppress the content
1296 if ( $this->suppress
) {
1298 // This should be 15...
1299 $bitfield |
= Revision
::DELETED_TEXT
;
1300 $bitfield |
= Revision
::DELETED_COMMENT
;
1301 $bitfield |
= Revision
::DELETED_USER
;
1302 $bitfield |
= Revision
::DELETED_RESTRICTED
;
1304 $bitfield = 'oi_deleted';
1307 if ( $deleteCurrent ) {
1308 $concat = $dbw->buildConcat( array( "img_sha1", $encExt ) );
1309 $where = array( 'img_name' => $this->file
->getName() );
1310 $dbw->insertSelect( 'filearchive', 'image',
1312 'fa_storage_group' => $encGroup,
1313 'fa_storage_key' => "CASE WHEN img_sha1='' THEN '' ELSE $concat END",
1314 'fa_deleted_user' => $encUserId,
1315 'fa_deleted_timestamp' => $encTimestamp,
1316 'fa_deleted_reason' => $encReason,
1317 'fa_deleted' => $this->suppress ?
$bitfield : 0,
1319 'fa_name' => 'img_name',
1320 'fa_archive_name' => 'NULL',
1321 'fa_size' => 'img_size',
1322 'fa_width' => 'img_width',
1323 'fa_height' => 'img_height',
1324 'fa_metadata' => 'img_metadata',
1325 'fa_bits' => 'img_bits',
1326 'fa_media_type' => 'img_media_type',
1327 'fa_major_mime' => 'img_major_mime',
1328 'fa_minor_mime' => 'img_minor_mime',
1329 'fa_description' => 'img_description',
1330 'fa_user' => 'img_user',
1331 'fa_user_text' => 'img_user_text',
1332 'fa_timestamp' => 'img_timestamp'
1333 ), $where, __METHOD__
);
1336 if ( count( $oldRels ) ) {
1337 $concat = $dbw->buildConcat( array( "oi_sha1", $encExt ) );
1339 'oi_name' => $this->file
->getName(),
1340 'oi_archive_name IN (' . $dbw->makeList( array_keys( $oldRels ) ) . ')' );
1341 $dbw->insertSelect( 'filearchive', 'oldimage',
1343 'fa_storage_group' => $encGroup,
1344 'fa_storage_key' => "CASE WHEN oi_sha1='' THEN '' ELSE $concat END",
1345 'fa_deleted_user' => $encUserId,
1346 'fa_deleted_timestamp' => $encTimestamp,
1347 'fa_deleted_reason' => $encReason,
1348 'fa_deleted' => $this->suppress ?
$bitfield : 'oi_deleted',
1350 'fa_name' => 'oi_name',
1351 'fa_archive_name' => 'oi_archive_name',
1352 'fa_size' => 'oi_size',
1353 'fa_width' => 'oi_width',
1354 'fa_height' => 'oi_height',
1355 'fa_metadata' => 'oi_metadata',
1356 'fa_bits' => 'oi_bits',
1357 'fa_media_type' => 'oi_media_type',
1358 'fa_major_mime' => 'oi_major_mime',
1359 'fa_minor_mime' => 'oi_minor_mime',
1360 'fa_description' => 'oi_description',
1361 'fa_user' => 'oi_user',
1362 'fa_user_text' => 'oi_user_text',
1363 'fa_timestamp' => 'oi_timestamp',
1364 'fa_deleted' => $bitfield
1365 ), $where, __METHOD__
);
1369 function doDBDeletes() {
1370 $dbw = $this->file
->repo
->getMasterDB();
1371 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
1372 if ( count( $oldRels ) ) {
1373 $dbw->delete( 'oldimage',
1375 'oi_name' => $this->file
->getName(),
1376 'oi_archive_name' => array_keys( $oldRels )
1379 if ( $deleteCurrent ) {
1380 $dbw->delete( 'image', array( 'img_name' => $this->file
->getName() ), __METHOD__
);
1385 * Run the transaction
1387 function execute() {
1388 global $wgUser, $wgUseSquid;
1389 wfProfileIn( __METHOD__
);
1391 $this->file
->lock();
1392 // Leave private files alone
1393 $privateFiles = array();
1394 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
1395 $dbw = $this->file
->repo
->getMasterDB();
1396 if( !empty( $oldRels ) ) {
1397 $res = $dbw->select( 'oldimage',
1398 array( 'oi_archive_name' ),
1399 array( 'oi_name' => $this->file
->getName(),
1400 'oi_archive_name IN (' . $dbw->makeList( array_keys($oldRels) ) . ')',
1401 'oi_deleted & ' . File
::DELETED_FILE
=> File
::DELETED_FILE
),
1403 while( $row = $dbw->fetchObject( $res ) ) {
1404 $privateFiles[$row->oi_archive_name
] = 1;
1407 // Prepare deletion batch
1408 $hashes = $this->getHashes();
1409 $this->deletionBatch
= array();
1410 $ext = $this->file
->getExtension();
1411 $dotExt = $ext === '' ?
'' : ".$ext";
1412 foreach ( $this->srcRels
as $name => $srcRel ) {
1413 // Skip files that have no hash (missing source).
1414 // Keep private files where they are.
1415 if ( isset($hashes[$name]) && !array_key_exists($name,$privateFiles) ) {
1416 $hash = $hashes[$name];
1417 $key = $hash . $dotExt;
1418 $dstRel = $this->file
->repo
->getDeletedHashPath( $key ) . $key;
1419 $this->deletionBatch
[$name] = array( $srcRel, $dstRel );
1423 // Lock the filearchive rows so that the files don't get deleted by a cleanup operation
1424 // We acquire this lock by running the inserts now, before the file operations.
1426 // This potentially has poor lock contention characteristics -- an alternative
1427 // scheme would be to insert stub filearchive entries with no fa_name and commit
1428 // them in a separate transaction, then run the file ops, then update the fa_name fields.
1429 $this->doDBInserts();
1431 // Execute the file deletion batch
1432 $status = $this->file
->repo
->deleteBatch( $this->deletionBatch
);
1433 if ( !$status->isGood() ) {
1434 $this->status
->merge( $status );
1437 if ( !$this->status
->ok
) {
1438 // Critical file deletion error
1439 // Roll back inserts, release lock and abort
1440 // TODO: delete the defunct filearchive rows if we are using a non-transactional DB
1441 $this->file
->unlockAndRollback();
1442 return $this->status
;
1446 if ( $wgUseSquid ) {
1448 foreach ( $this->srcRels
as $srcRel ) {
1449 $urlRel = str_replace( '%2F', '/', rawurlencode( $srcRel ) );
1450 $urls[] = $this->file
->repo
->getZoneUrl( 'public' ) . '/' . $urlRel;
1452 SquidUpdate
::purge( $urls );
1455 // Delete image/oldimage rows
1456 $this->doDBDeletes();
1458 // Commit and return
1459 $this->file
->unlock();
1460 wfProfileOut( __METHOD__
);
1461 return $this->status
;
1465 #------------------------------------------------------------------------------
1468 * Helper class for file undeletion
1471 class LocalFileRestoreBatch
{
1472 var $file, $cleanupBatch, $ids, $all, $unsuppress = false;
1474 function __construct( File
$file, $unsuppress = false ) {
1475 $this->file
= $file;
1476 $this->cleanupBatch
= $this->ids
= array();
1477 $this->ids
= array();
1478 $this->unsuppress
= $unsuppress;
1484 function addId( $fa_id ) {
1485 $this->ids
[] = $fa_id;
1489 * Add a whole lot of files by ID
1491 function addIds( $ids ) {
1492 $this->ids
= array_merge( $this->ids
, $ids );
1496 * Add all revisions of the file
1503 * Run the transaction, except the cleanup batch.
1504 * The cleanup batch should be run in a separate transaction, because it locks different
1505 * rows and there's no need to keep the image row locked while it's acquiring those locks
1506 * The caller may have its own transaction open.
1507 * So we save the batch and let the caller call cleanup()
1509 function execute() {
1510 global $wgUser, $wgLang;
1511 if ( !$this->all
&& !$this->ids
) {
1513 return $this->file
->repo
->newGood();
1516 $exists = $this->file
->lock();
1517 $dbw = $this->file
->repo
->getMasterDB();
1518 $status = $this->file
->repo
->newGood();
1520 // Fetch all or selected archived revisions for the file,
1521 // sorted from the most recent to the oldest.
1522 $conditions = array( 'fa_name' => $this->file
->getName() );
1524 $conditions[] = 'fa_id IN (' . $dbw->makeList( $this->ids
) . ')';
1527 $result = $dbw->select( 'filearchive', '*',
1530 array( 'ORDER BY' => 'fa_timestamp DESC' )
1533 $idsPresent = array();
1534 $storeBatch = array();
1535 $insertBatch = array();
1536 $insertCurrent = false;
1537 $deleteIds = array();
1539 $archiveNames = array();
1540 while( $row = $dbw->fetchObject( $result ) ) {
1541 $idsPresent[] = $row->fa_id
;
1543 if ( $row->fa_name
!= $this->file
->getName() ) {
1544 $status->error( 'undelete-filename-mismatch', $wgLang->timeanddate( $row->fa_timestamp
) );
1545 $status->failCount++
;
1548 if ( $row->fa_storage_key
== '' ) {
1549 // Revision was missing pre-deletion
1550 $status->error( 'undelete-bad-store-key', $wgLang->timeanddate( $row->fa_timestamp
) );
1551 $status->failCount++
;
1555 $deletedRel = $this->file
->repo
->getDeletedHashPath( $row->fa_storage_key
) . $row->fa_storage_key
;
1556 $deletedUrl = $this->file
->repo
->getVirtualUrl() . '/deleted/' . $deletedRel;
1558 $sha1 = substr( $row->fa_storage_key
, 0, strcspn( $row->fa_storage_key
, '.' ) );
1560 if ( strlen( $sha1 ) == 32 && $sha1[0] == '0' ) {
1561 $sha1 = substr( $sha1, 1 );
1564 if( is_null( $row->fa_major_mime
) ||
$row->fa_major_mime
== 'unknown'
1565 ||
is_null( $row->fa_minor_mime
) ||
$row->fa_minor_mime
== 'unknown'
1566 ||
is_null( $row->fa_media_type
) ||
$row->fa_media_type
== 'UNKNOWN'
1567 ||
is_null( $row->fa_metadata
) ) {
1568 // Refresh our metadata
1569 // Required for a new current revision; nice for older ones too. :)
1570 $props = RepoGroup
::singleton()->getFileProps( $deletedUrl );
1573 'minor_mime' => $row->fa_minor_mime
,
1574 'major_mime' => $row->fa_major_mime
,
1575 'media_type' => $row->fa_media_type
,
1576 'metadata' => $row->fa_metadata
1580 if ( $first && !$exists ) {
1581 // This revision will be published as the new current version
1582 $destRel = $this->file
->getRel();
1583 $insertCurrent = array(
1584 'img_name' => $row->fa_name
,
1585 'img_size' => $row->fa_size
,
1586 'img_width' => $row->fa_width
,
1587 'img_height' => $row->fa_height
,
1588 'img_metadata' => $props['metadata'],
1589 'img_bits' => $row->fa_bits
,
1590 'img_media_type' => $props['media_type'],
1591 'img_major_mime' => $props['major_mime'],
1592 'img_minor_mime' => $props['minor_mime'],
1593 'img_description' => $row->fa_description
,
1594 'img_user' => $row->fa_user
,
1595 'img_user_text' => $row->fa_user_text
,
1596 'img_timestamp' => $row->fa_timestamp
,
1599 // The live (current) version cannot be hidden!
1600 if( !$this->unsuppress
&& $row->fa_deleted
) {
1601 $storeBatch[] = array( $deletedUrl, 'public', $destRel );
1602 $this->cleanupBatch
[] = $row->fa_storage_key
;
1605 $archiveName = $row->fa_archive_name
;
1606 if( $archiveName == '' ) {
1607 // This was originally a current version; we
1608 // have to devise a new archive name for it.
1609 // Format is <timestamp of archiving>!<name>
1610 $timestamp = wfTimestamp( TS_UNIX
, $row->fa_deleted_timestamp
);
1612 $archiveName = wfTimestamp( TS_MW
, $timestamp ) . '!' . $row->fa_name
;
1614 } while ( isset( $archiveNames[$archiveName] ) );
1616 $archiveNames[$archiveName] = true;
1617 $destRel = $this->file
->getArchiveRel( $archiveName );
1618 $insertBatch[] = array(
1619 'oi_name' => $row->fa_name
,
1620 'oi_archive_name' => $archiveName,
1621 'oi_size' => $row->fa_size
,
1622 'oi_width' => $row->fa_width
,
1623 'oi_height' => $row->fa_height
,
1624 'oi_bits' => $row->fa_bits
,
1625 'oi_description' => $row->fa_description
,
1626 'oi_user' => $row->fa_user
,
1627 'oi_user_text' => $row->fa_user_text
,
1628 'oi_timestamp' => $row->fa_timestamp
,
1629 'oi_metadata' => $props['metadata'],
1630 'oi_media_type' => $props['media_type'],
1631 'oi_major_mime' => $props['major_mime'],
1632 'oi_minor_mime' => $props['minor_mime'],
1633 'oi_deleted' => $this->unsuppress ?
0 : $row->fa_deleted
,
1634 'oi_sha1' => $sha1 );
1637 $deleteIds[] = $row->fa_id
;
1638 if( !$this->unsuppress
&& $row->fa_deleted
& File
::DELETED_FILE
) {
1639 // private files can stay where they are
1640 $status->successCount++
;
1642 $storeBatch[] = array( $deletedUrl, 'public', $destRel );
1643 $this->cleanupBatch
[] = $row->fa_storage_key
;
1649 // Add a warning to the status object for missing IDs
1650 $missingIds = array_diff( $this->ids
, $idsPresent );
1651 foreach ( $missingIds as $id ) {
1652 $status->error( 'undelete-missing-filearchive', $id );
1655 // Run the store batch
1656 // Use the OVERWRITE_SAME flag to smooth over a common error
1657 $storeStatus = $this->file
->repo
->storeBatch( $storeBatch, FileRepo
::OVERWRITE_SAME
);
1658 $status->merge( $storeStatus );
1660 if ( !$status->ok
) {
1661 // Store batch returned a critical error -- this usually means nothing was stored
1662 // Stop now and return an error
1663 $this->file
->unlock();
1667 // Run the DB updates
1668 // Because we have locked the image row, key conflicts should be rare.
1669 // If they do occur, we can roll back the transaction at this time with
1670 // no data loss, but leaving unregistered files scattered throughout the
1672 // This is not ideal, which is why it's important to lock the image row.
1673 if ( $insertCurrent ) {
1674 $dbw->insert( 'image', $insertCurrent, __METHOD__
);
1676 if ( $insertBatch ) {
1677 $dbw->insert( 'oldimage', $insertBatch, __METHOD__
);
1680 $dbw->delete( 'filearchive',
1681 array( 'fa_id IN (' . $dbw->makeList( $deleteIds ) . ')' ),
1685 if( $status->successCount
> 0 ) {
1687 wfDebug( __METHOD__
." restored {$status->successCount} items, creating a new current\n" );
1689 // Update site_stats
1690 $site_stats = $dbw->tableName( 'site_stats' );
1691 $dbw->query( "UPDATE $site_stats SET ss_images=ss_images+1", __METHOD__
);
1693 $this->file
->purgeEverything();
1695 wfDebug( __METHOD__
." restored {$status->successCount} as archived versions\n" );
1696 $this->file
->purgeDescription();
1697 $this->file
->purgeHistory();
1700 $this->file
->unlock();
1705 * Delete unused files in the deleted zone.
1706 * This should be called from outside the transaction in which execute() was called.
1708 function cleanup() {
1709 if ( !$this->cleanupBatch
) {
1710 return $this->file
->repo
->newGood();
1712 $status = $this->file
->repo
->cleanupDeletedBatch( $this->cleanupBatch
);
1717 #------------------------------------------------------------------------------
1720 * Helper class for file movement
1723 class LocalFileMoveBatch
{
1724 var $file, $cur, $olds, $oldCount, $archive, $target, $db;
1726 function __construct( File
$file, Title
$target ) {
1727 $this->file
= $file;
1728 $this->target
= $target;
1729 $this->oldHash
= $this->file
->repo
->getHashPath( $this->file
->getName() );
1730 $this->newHash
= $this->file
->repo
->getHashPath( $this->target
->getDBKey() );
1731 $this->oldName
= $this->file
->getName();
1732 $this->newName
= $this->file
->repo
->getNameFromTitle( $this->target
);
1733 $this->oldRel
= $this->oldHash
. $this->oldName
;
1734 $this->newRel
= $this->newHash
. $this->newName
;
1735 $this->db
= $file->repo
->getMasterDb();
1739 * Add the current image to the batch
1741 function addCurrent() {
1742 $this->cur
= array( $this->oldRel
, $this->newRel
);
1746 * Add the old versions of the image to the batch
1748 function addOlds() {
1749 $archiveBase = 'archive';
1750 $this->olds
= array();
1751 $this->oldCount
= 0;
1753 $result = $this->db
->select( 'oldimage',
1754 array( 'oi_archive_name', 'oi_deleted' ),
1755 array( 'oi_name' => $this->oldName
),
1758 while( $row = $this->db
->fetchObject( $result ) ) {
1759 $oldName = $row->oi_archive_name
;
1760 $bits = explode( '!', $oldName, 2 );
1761 if( count( $bits ) != 2 ) {
1762 wfDebug( 'Invalid old file name: ' . $oldName );
1765 list( $timestamp, $filename ) = $bits;
1766 if( $this->oldName
!= $filename ) {
1767 wfDebug( 'Invalid old file name:' . $oldName );
1771 // Do we want to add those to oldCount?
1772 if( $row->oi_deleted
& File
::DELETED_FILE
) {
1775 $this->olds
[] = array(
1776 "{$archiveBase}/{$this->oldHash}{$oldName}",
1777 "{$archiveBase}/{$this->newHash}{$timestamp}!{$this->newName}"
1780 $this->db
->freeResult( $result );
1786 function execute() {
1787 $repo = $this->file
->repo
;
1788 $status = $repo->newGood();
1789 $triplets = $this->getMoveTriplets();
1791 $statusDb = $this->doDBUpdates();
1792 wfDebugLog( 'imagemove', "Renamed {$this->file->name} in database: {$statusDb->successCount} successes, {$statusDb->failCount} failures" );
1793 $statusMove = $repo->storeBatch( $triplets, FSRepo
::DELETE_SOURCE
);
1794 wfDebugLog( 'imagemove', "Moved files for {$this->file->name}: {$statusMove->successCount} successes, {$statusMove->failCount} failures" );
1795 if( !$statusMove->isOk() ) {
1796 wfDebugLog( 'imagemove', "Error in moving files: " . $statusMove->getWikiText() );
1797 $this->db
->rollback();
1799 $status->merge( $statusDb );
1800 $status->merge( $statusMove );
1805 * Do the database updates and return a new WikiError indicating how many
1806 * rows where updated.
1808 function doDBUpdates() {
1809 $repo = $this->file
->repo
;
1810 $status = $repo->newGood();
1813 // Update current image
1816 array( 'img_name' => $this->newName
),
1817 array( 'img_name' => $this->oldName
),
1820 if( $dbw->affectedRows() ) {
1821 $status->successCount++
;
1823 $status->failCount++
;
1826 // Update old images
1830 'oi_name' => $this->newName
,
1831 'oi_archive_name = ' . $dbw->strreplace( 'oi_archive_name', $dbw->addQuotes($this->oldName
), $dbw->addQuotes($this->newName
) ),
1833 array( 'oi_name' => $this->oldName
),
1836 $affected = $dbw->affectedRows();
1837 $total = $this->oldCount
;
1838 $status->successCount +
= $affected;
1839 $status->failCount +
= $total - $affected;
1845 * Generate triplets for FSRepo::storeBatch().
1847 function getMoveTriplets() {
1848 $moves = array_merge( array( $this->cur
), $this->olds
);
1849 $triplets = array(); // The format is: (srcUrl, destZone, destUrl)
1850 foreach( $moves as $move ) {
1851 // $move: (oldRelativePath, newRelativePath)
1852 $srcUrl = $this->file
->repo
->getVirtualUrl() . '/public/' . rawurlencode( $move[0] );
1853 $triplets[] = array( $srcUrl, 'public', $move[1] );
1854 wfDebugLog( 'imagemove', "Generated move triplet for {$this->file->name}: {$srcUrl} :: public :: {$move[1]}" );