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) {
628 $dbr = $this->repo
->getSlaveDB();
629 $tables = array('oldimage');
630 $join_conds = array();
631 $fields = OldLocalFile
::selectFields();
632 $conds = $opts = array();
633 $conds[] = "oi_name = " . $dbr->addQuotes( $this->title
->getDBKey() );
634 if( $start !== null ) {
635 $conds[] = "oi_timestamp <= " . $dbr->addQuotes( $dbr->timestamp( $start ) );
637 if( $end !== null ) {
638 $endTS = $end ?
$dbr->timestamp( $end ) : "";
639 $conds[] = "oi_timestamp >= " . $dbr->addQuotes( $endTS );
642 $opts['LIMIT'] = $limit;
644 $opts['ORDER BY'] = 'oi_timestamp DESC';
646 wfRunHooks( 'LocalFile::getHistory', array( &$this, &$tables, &$fields, &$conds, &$opts, &$join_conds ) );
648 $res = $dbr->select( $tables, $fields, $conds, __METHOD__
, $opts, $join_conds );
650 while( $row = $dbr->fetchObject($res) ) {
651 $r[] = OldLocalFile
::newFromRow($row, $this->repo
);
657 * Return the history of this file, line by line.
658 * starts with current version, then old versions.
659 * uses $this->historyLine to check which line to return:
660 * 0 return line for current version
661 * 1 query for old versions, return first one
662 * 2, ... return next old version from above query
666 function nextHistoryLine() {
667 # Polymorphic function name to distinguish foreign and local fetches
668 $fname = get_class( $this ) . '::' . __FUNCTION__
;
670 $dbr = $this->repo
->getSlaveDB();
672 if ( $this->historyLine
== 0 ) {// called for the first time, return line from cur
673 $this->historyRes
= $dbr->select( 'image',
676 "'' AS oi_archive_name",
680 array( 'img_name' => $this->title
->getDBkey() ),
683 if ( 0 == $dbr->numRows( $this->historyRes
) ) {
684 $dbr->freeResult($this->historyRes
);
685 $this->historyRes
= null;
688 } else if ( $this->historyLine
== 1 ) {
689 $dbr->freeResult($this->historyRes
);
690 $this->historyRes
= $dbr->select( 'oldimage', '*',
691 array( 'oi_name' => $this->title
->getDBkey() ),
693 array( 'ORDER BY' => 'oi_timestamp DESC' )
696 $this->historyLine ++
;
698 return $dbr->fetchObject( $this->historyRes
);
702 * Reset the history pointer to the first element of the history
705 function resetHistory() {
706 $this->historyLine
= 0;
707 if (!is_null($this->historyRes
)) {
708 $this->repo
->getSlaveDB()->freeResult($this->historyRes
);
709 $this->historyRes
= null;
713 /** getFullPath inherited */
714 /** getHashPath inherited */
715 /** getRel inherited */
716 /** getUrlRel inherited */
717 /** getArchiveRel inherited */
718 /** getThumbRel inherited */
719 /** getArchivePath inherited */
720 /** getThumbPath inherited */
721 /** getArchiveUrl inherited */
722 /** getThumbUrl inherited */
723 /** getArchiveVirtualUrl inherited */
724 /** getThumbVirtualUrl inherited */
725 /** isHashed inherited */
728 * Upload a file and record it in the DB
729 * @param string $srcPath Source path or virtual URL
730 * @param string $comment Upload description
731 * @param string $pageText Text to use for the new description page, if a new description page is created
732 * @param integer $flags Flags for publish()
733 * @param array $props File properties, if known. This can be used to reduce the
734 * upload time when uploading virtual URLs for which the file info
736 * @param string $timestamp Timestamp for img_timestamp, or false to use the current time
738 * @return FileRepoStatus object. On success, the value member contains the
739 * archive name, or an empty string if it was a new file.
741 function upload( $srcPath, $comment, $pageText, $flags = 0, $props = false, $timestamp = false, $user = null ) {
743 $status = $this->publish( $srcPath, $flags );
745 if ( !$this->recordUpload2( $status->value
, $comment, $pageText, $props, $timestamp, $user ) ) {
746 $status->fatal( 'filenotfound', $srcPath );
754 * Record a file upload in the upload log and the image table
755 * @deprecated use upload()
757 function recordUpload( $oldver, $desc, $license = '', $copyStatus = '', $source = '',
758 $watch = false, $timestamp = false )
760 $pageText = UploadForm
::getInitialPageText( $desc, $license, $copyStatus, $source );
761 if ( !$this->recordUpload2( $oldver, $desc, $pageText ) ) {
766 $wgUser->addWatch( $this->getTitle() );
773 * Record a file upload in the upload log and the image table
775 function recordUpload2( $oldver, $comment, $pageText, $props = false, $timestamp = false, $user = null )
777 if( is_null( $user ) ) {
782 $dbw = $this->repo
->getMasterDB();
786 $props = $this->repo
->getFileProps( $this->getVirtualUrl() );
788 $props['description'] = $comment;
789 $props['user'] = $user->getId();
790 $props['user_text'] = $user->getName();
791 $props['timestamp'] = wfTimestamp( TS_MW
);
792 $this->setProps( $props );
794 // Delete thumbnails and refresh the metadata cache
795 $this->purgeThumbnails();
796 $this->saveToCache();
797 SquidUpdate
::purge( array( $this->getURL() ) );
799 // Fail now if the file isn't there
800 if ( !$this->fileExists
) {
801 wfDebug( __METHOD__
.": File ".$this->getPath()." went missing!\n" );
806 if ( $timestamp === false ) {
807 $timestamp = $dbw->timestamp();
810 # Test to see if the row exists using INSERT IGNORE
811 # This avoids race conditions by locking the row until the commit, and also
812 # doesn't deadlock. SELECT FOR UPDATE causes a deadlock for every race condition.
813 $dbw->insert( 'image',
815 'img_name' => $this->getName(),
816 'img_size'=> $this->size
,
817 'img_width' => intval( $this->width
),
818 'img_height' => intval( $this->height
),
819 'img_bits' => $this->bits
,
820 'img_media_type' => $this->media_type
,
821 'img_major_mime' => $this->major_mime
,
822 'img_minor_mime' => $this->minor_mime
,
823 'img_timestamp' => $timestamp,
824 'img_description' => $comment,
825 'img_user' => $user->getId(),
826 'img_user_text' => $user->getName(),
827 'img_metadata' => $this->metadata
,
828 'img_sha1' => $this->sha1
834 if( $dbw->affectedRows() == 0 ) {
837 # Collision, this is an update of a file
838 # Insert previous contents into oldimage
839 $dbw->insertSelect( 'oldimage', 'image',
841 'oi_name' => 'img_name',
842 'oi_archive_name' => $dbw->addQuotes( $oldver ),
843 'oi_size' => 'img_size',
844 'oi_width' => 'img_width',
845 'oi_height' => 'img_height',
846 'oi_bits' => 'img_bits',
847 'oi_timestamp' => 'img_timestamp',
848 'oi_description' => 'img_description',
849 'oi_user' => 'img_user',
850 'oi_user_text' => 'img_user_text',
851 'oi_metadata' => 'img_metadata',
852 'oi_media_type' => 'img_media_type',
853 'oi_major_mime' => 'img_major_mime',
854 'oi_minor_mime' => 'img_minor_mime',
855 'oi_sha1' => 'img_sha1'
856 ), array( 'img_name' => $this->getName() ), __METHOD__
859 # Update the current image row
860 $dbw->update( 'image',
862 'img_size' => $this->size
,
863 'img_width' => intval( $this->width
),
864 'img_height' => intval( $this->height
),
865 'img_bits' => $this->bits
,
866 'img_media_type' => $this->media_type
,
867 'img_major_mime' => $this->major_mime
,
868 'img_minor_mime' => $this->minor_mime
,
869 'img_timestamp' => $timestamp,
870 'img_description' => $comment,
871 'img_user' => $user->getId(),
872 'img_user_text' => $user->getName(),
873 'img_metadata' => $this->metadata
,
874 'img_sha1' => $this->sha1
875 ), array( /* WHERE */
876 'img_name' => $this->getName()
881 # Update the image count
882 $site_stats = $dbw->tableName( 'site_stats' );
883 $dbw->query( "UPDATE $site_stats SET ss_images=ss_images+1", __METHOD__
);
886 $descTitle = $this->getTitle();
887 $article = new Article( $descTitle );
890 $log = new LogPage( 'upload' );
891 $action = $reupload ?
'overwrite' : 'upload';
892 $log->addEntry( $action, $descTitle, $comment, array(), $user );
894 if( $descTitle->exists() ) {
895 # Create a null revision
896 $latest = $descTitle->getLatestRevID();
897 $nullRevision = Revision
::newNullRevision( $dbw, $descTitle->getArticleId(), $log->getRcComment(), false );
898 $nullRevision->insertOn( $dbw );
900 wfRunHooks( 'NewRevisionFromEditComplete', array($article, $nullRevision, $latest, $user) );
901 $article->updateRevisionOn( $dbw, $nullRevision );
903 # Invalidate the cache for the description page
904 $descTitle->invalidateCache();
905 $descTitle->purgeSquid();
907 // New file; create the description page.
908 // There's already a log entry, so don't make a second RC entry
909 $article->doEdit( $pageText, $comment, EDIT_NEW | EDIT_SUPPRESS_RC
);
912 # Hooks, hooks, the magic of hooks...
913 wfRunHooks( 'FileUpload', array( $this ) );
915 # Commit the transaction now, in case something goes wrong later
916 # The most important thing is that files don't get lost, especially archives
917 $dbw->immediateCommit();
919 # Invalidate cache for all pages using this file
920 $update = new HTMLCacheUpdate( $this->getTitle(), 'imagelinks' );
922 # Invalidate cache for all pages that redirects on this page
923 $redirs = $this->getTitle()->getRedirectsHere();
924 foreach( $redirs as $redir ) {
925 $update = new HTMLCacheUpdate( $redir, 'imagelinks' );
933 * Move or copy a file to its public location. If a file exists at the
934 * destination, move it to an archive. Returns the archive name on success
935 * or an empty string if it was a new file, and a wikitext-formatted
936 * WikiError object on failure.
938 * The archive name should be passed through to recordUpload for database
941 * @param string $sourcePath Local filesystem path to the source image
942 * @param integer $flags A bitwise combination of:
943 * File::DELETE_SOURCE Delete the source file, i.e. move
945 * @return FileRepoStatus object. On success, the value member contains the
946 * archive name, or an empty string if it was a new file.
948 function publish( $srcPath, $flags = 0 ) {
950 $dstRel = $this->getRel();
951 $archiveName = gmdate( 'YmdHis' ) . '!'. $this->getName();
952 $archiveRel = 'archive/' . $this->getHashPath() . $archiveName;
953 $flags = $flags & File
::DELETE_SOURCE ? LocalRepo
::DELETE_SOURCE
: 0;
954 $status = $this->repo
->publish( $srcPath, $dstRel, $archiveRel, $flags );
955 if ( $status->value
== 'new' ) {
958 $status->value
= $archiveName;
964 /** getLinksTo inherited */
965 /** getExifData inherited */
966 /** isLocal inherited */
967 /** wasDeleted inherited */
970 * Move file to the new title
972 * Move current, old version and all thumbnails
973 * to the new filename. Old file is deleted.
975 * Cache purging is done; checks for validity
976 * and logging are caller's responsibility
978 * @param $target Title New file name
979 * @return FileRepoStatus object.
981 function move( $target ) {
982 wfDebugLog( 'imagemove', "Got request to move {$this->name} to " . $target->getText() );
984 $batch = new LocalFileMoveBatch( $this, $target );
985 $batch->addCurrent();
988 $status = $batch->execute();
989 wfDebugLog( 'imagemove', "Finished moving {$this->name}" );
990 $this->purgeEverything();
993 if ( $status->isOk() ) {
994 // Now switch the object
995 $this->title
= $target;
996 // Force regeneration of the name and hashpath
997 unset( $this->name
);
998 unset( $this->hashPath
);
999 // Purge the new image
1000 $this->purgeEverything();
1007 * Delete all versions of the file.
1009 * Moves the files into an archive directory (or deletes them)
1010 * and removes the database rows.
1012 * Cache purging is done; logging is caller's responsibility.
1016 * @return FileRepoStatus object.
1018 function delete( $reason, $suppress = false ) {
1020 $batch = new LocalFileDeleteBatch( $this, $reason, $suppress );
1021 $batch->addCurrent();
1023 # Get old version relative paths
1024 $dbw = $this->repo
->getMasterDB();
1025 $result = $dbw->select( 'oldimage',
1026 array( 'oi_archive_name' ),
1027 array( 'oi_name' => $this->getName() ) );
1028 while ( $row = $dbw->fetchObject( $result ) ) {
1029 $batch->addOld( $row->oi_archive_name
);
1031 $status = $batch->execute();
1033 if ( $status->ok
) {
1034 // Update site_stats
1035 $site_stats = $dbw->tableName( 'site_stats' );
1036 $dbw->query( "UPDATE $site_stats SET ss_images=ss_images-1", __METHOD__
);
1037 $this->purgeEverything();
1045 * Delete an old version of the file.
1047 * Moves the file into an archive directory (or deletes it)
1048 * and removes the database row.
1050 * Cache purging is done; logging is caller's responsibility.
1054 * @throws MWException or FSException on database or filestore failure
1055 * @return FileRepoStatus object.
1057 function deleteOld( $archiveName, $reason, $suppress=false ) {
1059 $batch = new LocalFileDeleteBatch( $this, $reason, $suppress );
1060 $batch->addOld( $archiveName );
1061 $status = $batch->execute();
1063 if ( $status->ok
) {
1064 $this->purgeDescription();
1065 $this->purgeHistory();
1071 * Restore all or specified deleted revisions to the given file.
1072 * Permissions and logging are left to the caller.
1074 * May throw database exceptions on error.
1076 * @param $versions set of record ids of deleted items to restore,
1077 * or empty to restore all revisions.
1079 * @return FileRepoStatus
1081 function restore( $versions = array(), $unsuppress = false ) {
1082 $batch = new LocalFileRestoreBatch( $this, $unsuppress );
1086 $batch->addIds( $versions );
1088 $status = $batch->execute();
1089 if ( !$status->ok
) {
1093 $cleanupStatus = $batch->cleanup();
1094 $cleanupStatus->successCount
= 0;
1095 $cleanupStatus->failCount
= 0;
1096 $status->merge( $cleanupStatus );
1100 /** isMultipage inherited */
1101 /** pageCount inherited */
1102 /** scaleHeight inherited */
1103 /** getImageSize inherited */
1106 * Get the URL of the file description page.
1108 function getDescriptionUrl() {
1109 return $this->title
->getLocalUrl();
1113 * Get the HTML text of the description page
1114 * This is not used by ImagePage for local files, since (among other things)
1115 * it skips the parser cache.
1117 function getDescriptionText() {
1119 $revision = Revision
::newFromTitle( $this->title
);
1120 if ( !$revision ) return false;
1121 $text = $revision->getText();
1122 if ( !$text ) return false;
1123 $pout = $wgParser->parse( $text, $this->title
, new ParserOptions() );
1124 return $pout->getText();
1127 function getDescription() {
1129 return $this->description
;
1132 function getTimestamp() {
1134 return $this->timestamp
;
1137 function getSha1() {
1139 // Initialise now if necessary
1140 if ( $this->sha1
== '' && $this->fileExists
) {
1141 $this->sha1
= File
::sha1Base36( $this->getPath() );
1142 if ( !wfReadOnly() && strval( $this->sha1
) != '' ) {
1143 $dbw = $this->repo
->getMasterDB();
1144 $dbw->update( 'image',
1145 array( 'img_sha1' => $this->sha1
),
1146 array( 'img_name' => $this->getName() ),
1148 $this->saveToCache();
1156 * Start a transaction and lock the image for update
1157 * Increments a reference counter if the lock is already held
1158 * @return boolean True if the image exists, false otherwise
1161 $dbw = $this->repo
->getMasterDB();
1162 if ( !$this->locked
) {
1166 return $dbw->selectField( 'image', '1', array( 'img_name' => $this->getName() ), __METHOD__
);
1170 * Decrement the lock reference count. If the reference count is reduced to zero, commits
1171 * the transaction and thereby releases the image lock.
1174 if ( $this->locked
) {
1176 if ( !$this->locked
) {
1177 $dbw = $this->repo
->getMasterDB();
1184 * Roll back the DB transaction and mark the image unlocked
1186 function unlockAndRollback() {
1187 $this->locked
= false;
1188 $dbw = $this->repo
->getMasterDB();
1191 } // LocalFile class
1193 #------------------------------------------------------------------------------
1196 * Helper class for file deletion
1199 class LocalFileDeleteBatch
{
1200 var $file, $reason, $srcRels = array(), $archiveUrls = array(), $deletionBatch, $suppress;
1203 function __construct( File
$file, $reason = '', $suppress = false ) {
1204 $this->file
= $file;
1205 $this->reason
= $reason;
1206 $this->suppress
= $suppress;
1207 $this->status
= $file->repo
->newGood();
1210 function addCurrent() {
1211 $this->srcRels
['.'] = $this->file
->getRel();
1214 function addOld( $oldName ) {
1215 $this->srcRels
[$oldName] = $this->file
->getArchiveRel( $oldName );
1216 $this->archiveUrls
[] = $this->file
->getArchiveUrl( $oldName );
1219 function getOldRels() {
1220 if ( !isset( $this->srcRels
['.'] ) ) {
1221 $oldRels =& $this->srcRels
;
1222 $deleteCurrent = false;
1224 $oldRels = $this->srcRels
;
1225 unset( $oldRels['.'] );
1226 $deleteCurrent = true;
1228 return array( $oldRels, $deleteCurrent );
1231 /*protected*/ function getHashes() {
1233 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
1234 if ( $deleteCurrent ) {
1235 $hashes['.'] = $this->file
->getSha1();
1237 if ( count( $oldRels ) ) {
1238 $dbw = $this->file
->repo
->getMasterDB();
1239 $res = $dbw->select( 'oldimage', array( 'oi_archive_name', 'oi_sha1' ),
1240 'oi_archive_name IN(' . $dbw->makeList( array_keys( $oldRels ) ) . ')',
1242 while ( $row = $dbw->fetchObject( $res ) ) {
1243 if ( rtrim( $row->oi_sha1
, "\0" ) === '' ) {
1244 // Get the hash from the file
1245 $oldUrl = $this->file
->getArchiveVirtualUrl( $row->oi_archive_name
);
1246 $props = $this->file
->repo
->getFileProps( $oldUrl );
1247 if ( $props['fileExists'] ) {
1248 // Upgrade the oldimage row
1249 $dbw->update( 'oldimage',
1250 array( 'oi_sha1' => $props['sha1'] ),
1251 array( 'oi_name' => $this->file
->getName(), 'oi_archive_name' => $row->oi_archive_name
),
1253 $hashes[$row->oi_archive_name
] = $props['sha1'];
1255 $hashes[$row->oi_archive_name
] = false;
1258 $hashes[$row->oi_archive_name
] = $row->oi_sha1
;
1262 $missing = array_diff_key( $this->srcRels
, $hashes );
1263 foreach ( $missing as $name => $rel ) {
1264 $this->status
->error( 'filedelete-old-unregistered', $name );
1266 foreach ( $hashes as $name => $hash ) {
1268 $this->status
->error( 'filedelete-missing', $this->srcRels
[$name] );
1269 unset( $hashes[$name] );
1276 function doDBInserts() {
1278 $dbw = $this->file
->repo
->getMasterDB();
1279 $encTimestamp = $dbw->addQuotes( $dbw->timestamp() );
1280 $encUserId = $dbw->addQuotes( $wgUser->getId() );
1281 $encReason = $dbw->addQuotes( $this->reason
);
1282 $encGroup = $dbw->addQuotes( 'deleted' );
1283 $ext = $this->file
->getExtension();
1284 $dotExt = $ext === '' ?
'' : ".$ext";
1285 $encExt = $dbw->addQuotes( $dotExt );
1286 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
1288 // Bitfields to further suppress the content
1289 if ( $this->suppress
) {
1291 // This should be 15...
1292 $bitfield |
= Revision
::DELETED_TEXT
;
1293 $bitfield |
= Revision
::DELETED_COMMENT
;
1294 $bitfield |
= Revision
::DELETED_USER
;
1295 $bitfield |
= Revision
::DELETED_RESTRICTED
;
1297 $bitfield = 'oi_deleted';
1300 if ( $deleteCurrent ) {
1301 $concat = $dbw->buildConcat( array( "img_sha1", $encExt ) );
1302 $where = array( 'img_name' => $this->file
->getName() );
1303 $dbw->insertSelect( 'filearchive', 'image',
1305 'fa_storage_group' => $encGroup,
1306 'fa_storage_key' => "CASE WHEN img_sha1='' THEN '' ELSE $concat END",
1307 'fa_deleted_user' => $encUserId,
1308 'fa_deleted_timestamp' => $encTimestamp,
1309 'fa_deleted_reason' => $encReason,
1310 'fa_deleted' => $this->suppress ?
$bitfield : 0,
1312 'fa_name' => 'img_name',
1313 'fa_archive_name' => 'NULL',
1314 'fa_size' => 'img_size',
1315 'fa_width' => 'img_width',
1316 'fa_height' => 'img_height',
1317 'fa_metadata' => 'img_metadata',
1318 'fa_bits' => 'img_bits',
1319 'fa_media_type' => 'img_media_type',
1320 'fa_major_mime' => 'img_major_mime',
1321 'fa_minor_mime' => 'img_minor_mime',
1322 'fa_description' => 'img_description',
1323 'fa_user' => 'img_user',
1324 'fa_user_text' => 'img_user_text',
1325 'fa_timestamp' => 'img_timestamp'
1326 ), $where, __METHOD__
);
1329 if ( count( $oldRels ) ) {
1330 $concat = $dbw->buildConcat( array( "oi_sha1", $encExt ) );
1332 'oi_name' => $this->file
->getName(),
1333 'oi_archive_name IN (' . $dbw->makeList( array_keys( $oldRels ) ) . ')' );
1334 $dbw->insertSelect( 'filearchive', 'oldimage',
1336 'fa_storage_group' => $encGroup,
1337 'fa_storage_key' => "CASE WHEN oi_sha1='' THEN '' ELSE $concat END",
1338 'fa_deleted_user' => $encUserId,
1339 'fa_deleted_timestamp' => $encTimestamp,
1340 'fa_deleted_reason' => $encReason,
1341 'fa_deleted' => $this->suppress ?
$bitfield : 'oi_deleted',
1343 'fa_name' => 'oi_name',
1344 'fa_archive_name' => 'oi_archive_name',
1345 'fa_size' => 'oi_size',
1346 'fa_width' => 'oi_width',
1347 'fa_height' => 'oi_height',
1348 'fa_metadata' => 'oi_metadata',
1349 'fa_bits' => 'oi_bits',
1350 'fa_media_type' => 'oi_media_type',
1351 'fa_major_mime' => 'oi_major_mime',
1352 'fa_minor_mime' => 'oi_minor_mime',
1353 'fa_description' => 'oi_description',
1354 'fa_user' => 'oi_user',
1355 'fa_user_text' => 'oi_user_text',
1356 'fa_timestamp' => 'oi_timestamp',
1357 'fa_deleted' => $bitfield
1358 ), $where, __METHOD__
);
1362 function doDBDeletes() {
1363 $dbw = $this->file
->repo
->getMasterDB();
1364 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
1365 if ( count( $oldRels ) ) {
1366 $dbw->delete( 'oldimage',
1368 'oi_name' => $this->file
->getName(),
1369 'oi_archive_name' => array_keys( $oldRels )
1372 if ( $deleteCurrent ) {
1373 $dbw->delete( 'image', array( 'img_name' => $this->file
->getName() ), __METHOD__
);
1378 * Run the transaction
1380 function execute() {
1381 global $wgUser, $wgUseSquid;
1382 wfProfileIn( __METHOD__
);
1384 $this->file
->lock();
1385 // Leave private files alone
1386 $privateFiles = array();
1387 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
1388 $dbw = $this->file
->repo
->getMasterDB();
1389 if( !empty( $oldRels ) ) {
1390 $res = $dbw->select( 'oldimage',
1391 array( 'oi_archive_name' ),
1392 array( 'oi_name' => $this->file
->getName(),
1393 'oi_archive_name IN (' . $dbw->makeList( array_keys($oldRels) ) . ')',
1394 'oi_deleted & ' . File
::DELETED_FILE
=> File
::DELETED_FILE
),
1396 while( $row = $dbw->fetchObject( $res ) ) {
1397 $privateFiles[$row->oi_archive_name
] = 1;
1400 // Prepare deletion batch
1401 $hashes = $this->getHashes();
1402 $this->deletionBatch
= array();
1403 $ext = $this->file
->getExtension();
1404 $dotExt = $ext === '' ?
'' : ".$ext";
1405 foreach ( $this->srcRels
as $name => $srcRel ) {
1406 // Skip files that have no hash (missing source).
1407 // Keep private files where they are.
1408 if ( isset($hashes[$name]) && !array_key_exists($name,$privateFiles) ) {
1409 $hash = $hashes[$name];
1410 $key = $hash . $dotExt;
1411 $dstRel = $this->file
->repo
->getDeletedHashPath( $key ) . $key;
1412 $this->deletionBatch
[$name] = array( $srcRel, $dstRel );
1416 // Lock the filearchive rows so that the files don't get deleted by a cleanup operation
1417 // We acquire this lock by running the inserts now, before the file operations.
1419 // This potentially has poor lock contention characteristics -- an alternative
1420 // scheme would be to insert stub filearchive entries with no fa_name and commit
1421 // them in a separate transaction, then run the file ops, then update the fa_name fields.
1422 $this->doDBInserts();
1424 // Execute the file deletion batch
1425 $status = $this->file
->repo
->deleteBatch( $this->deletionBatch
);
1426 if ( !$status->isGood() ) {
1427 $this->status
->merge( $status );
1430 if ( !$this->status
->ok
) {
1431 // Critical file deletion error
1432 // Roll back inserts, release lock and abort
1433 // TODO: delete the defunct filearchive rows if we are using a non-transactional DB
1434 $this->file
->unlockAndRollback();
1435 return $this->status
;
1439 if ( $wgUseSquid ) {
1441 foreach ( $this->srcRels
as $srcRel ) {
1442 $urlRel = str_replace( '%2F', '/', rawurlencode( $srcRel ) );
1443 $urls[] = $this->file
->repo
->getZoneUrl( 'public' ) . '/' . $urlRel;
1445 SquidUpdate
::purge( $urls );
1448 // Delete image/oldimage rows
1449 $this->doDBDeletes();
1451 // Commit and return
1452 $this->file
->unlock();
1453 wfProfileOut( __METHOD__
);
1454 return $this->status
;
1458 #------------------------------------------------------------------------------
1461 * Helper class for file undeletion
1464 class LocalFileRestoreBatch
{
1465 var $file, $cleanupBatch, $ids, $all, $unsuppress = false;
1467 function __construct( File
$file, $unsuppress = false ) {
1468 $this->file
= $file;
1469 $this->cleanupBatch
= $this->ids
= array();
1470 $this->ids
= array();
1471 $this->unsuppress
= $unsuppress;
1477 function addId( $fa_id ) {
1478 $this->ids
[] = $fa_id;
1482 * Add a whole lot of files by ID
1484 function addIds( $ids ) {
1485 $this->ids
= array_merge( $this->ids
, $ids );
1489 * Add all revisions of the file
1496 * Run the transaction, except the cleanup batch.
1497 * The cleanup batch should be run in a separate transaction, because it locks different
1498 * rows and there's no need to keep the image row locked while it's acquiring those locks
1499 * The caller may have its own transaction open.
1500 * So we save the batch and let the caller call cleanup()
1502 function execute() {
1503 global $wgUser, $wgLang;
1504 if ( !$this->all
&& !$this->ids
) {
1506 return $this->file
->repo
->newGood();
1509 $exists = $this->file
->lock();
1510 $dbw = $this->file
->repo
->getMasterDB();
1511 $status = $this->file
->repo
->newGood();
1513 // Fetch all or selected archived revisions for the file,
1514 // sorted from the most recent to the oldest.
1515 $conditions = array( 'fa_name' => $this->file
->getName() );
1517 $conditions[] = 'fa_id IN (' . $dbw->makeList( $this->ids
) . ')';
1520 $result = $dbw->select( 'filearchive', '*',
1523 array( 'ORDER BY' => 'fa_timestamp DESC' )
1526 $idsPresent = array();
1527 $storeBatch = array();
1528 $insertBatch = array();
1529 $insertCurrent = false;
1530 $deleteIds = array();
1532 $archiveNames = array();
1533 while( $row = $dbw->fetchObject( $result ) ) {
1534 $idsPresent[] = $row->fa_id
;
1536 if ( $row->fa_name
!= $this->file
->getName() ) {
1537 $status->error( 'undelete-filename-mismatch', $wgLang->timeanddate( $row->fa_timestamp
) );
1538 $status->failCount++
;
1541 if ( $row->fa_storage_key
== '' ) {
1542 // Revision was missing pre-deletion
1543 $status->error( 'undelete-bad-store-key', $wgLang->timeanddate( $row->fa_timestamp
) );
1544 $status->failCount++
;
1548 $deletedRel = $this->file
->repo
->getDeletedHashPath( $row->fa_storage_key
) . $row->fa_storage_key
;
1549 $deletedUrl = $this->file
->repo
->getVirtualUrl() . '/deleted/' . $deletedRel;
1551 $sha1 = substr( $row->fa_storage_key
, 0, strcspn( $row->fa_storage_key
, '.' ) );
1553 if ( strlen( $sha1 ) == 32 && $sha1[0] == '0' ) {
1554 $sha1 = substr( $sha1, 1 );
1557 if( is_null( $row->fa_major_mime
) ||
$row->fa_major_mime
== 'unknown'
1558 ||
is_null( $row->fa_minor_mime
) ||
$row->fa_minor_mime
== 'unknown'
1559 ||
is_null( $row->fa_media_type
) ||
$row->fa_media_type
== 'UNKNOWN'
1560 ||
is_null( $row->fa_metadata
) ) {
1561 // Refresh our metadata
1562 // Required for a new current revision; nice for older ones too. :)
1563 $props = RepoGroup
::singleton()->getFileProps( $deletedUrl );
1566 'minor_mime' => $row->fa_minor_mime
,
1567 'major_mime' => $row->fa_major_mime
,
1568 'media_type' => $row->fa_media_type
,
1569 'metadata' => $row->fa_metadata
1573 if ( $first && !$exists ) {
1574 // This revision will be published as the new current version
1575 $destRel = $this->file
->getRel();
1576 $insertCurrent = array(
1577 'img_name' => $row->fa_name
,
1578 'img_size' => $row->fa_size
,
1579 'img_width' => $row->fa_width
,
1580 'img_height' => $row->fa_height
,
1581 'img_metadata' => $props['metadata'],
1582 'img_bits' => $row->fa_bits
,
1583 'img_media_type' => $props['media_type'],
1584 'img_major_mime' => $props['major_mime'],
1585 'img_minor_mime' => $props['minor_mime'],
1586 'img_description' => $row->fa_description
,
1587 'img_user' => $row->fa_user
,
1588 'img_user_text' => $row->fa_user_text
,
1589 'img_timestamp' => $row->fa_timestamp
,
1592 // The live (current) version cannot be hidden!
1593 if( !$this->unsuppress
&& $row->fa_deleted
) {
1594 $storeBatch[] = array( $deletedUrl, 'public', $destRel );
1595 $this->cleanupBatch
[] = $row->fa_storage_key
;
1598 $archiveName = $row->fa_archive_name
;
1599 if( $archiveName == '' ) {
1600 // This was originally a current version; we
1601 // have to devise a new archive name for it.
1602 // Format is <timestamp of archiving>!<name>
1603 $timestamp = wfTimestamp( TS_UNIX
, $row->fa_deleted_timestamp
);
1605 $archiveName = wfTimestamp( TS_MW
, $timestamp ) . '!' . $row->fa_name
;
1607 } while ( isset( $archiveNames[$archiveName] ) );
1609 $archiveNames[$archiveName] = true;
1610 $destRel = $this->file
->getArchiveRel( $archiveName );
1611 $insertBatch[] = array(
1612 'oi_name' => $row->fa_name
,
1613 'oi_archive_name' => $archiveName,
1614 'oi_size' => $row->fa_size
,
1615 'oi_width' => $row->fa_width
,
1616 'oi_height' => $row->fa_height
,
1617 'oi_bits' => $row->fa_bits
,
1618 'oi_description' => $row->fa_description
,
1619 'oi_user' => $row->fa_user
,
1620 'oi_user_text' => $row->fa_user_text
,
1621 'oi_timestamp' => $row->fa_timestamp
,
1622 'oi_metadata' => $props['metadata'],
1623 'oi_media_type' => $props['media_type'],
1624 'oi_major_mime' => $props['major_mime'],
1625 'oi_minor_mime' => $props['minor_mime'],
1626 'oi_deleted' => $this->unsuppress ?
0 : $row->fa_deleted
,
1627 'oi_sha1' => $sha1 );
1630 $deleteIds[] = $row->fa_id
;
1631 if( !$this->unsuppress
&& $row->fa_deleted
& File
::DELETED_FILE
) {
1632 // private files can stay where they are
1633 $status->successCount++
;
1635 $storeBatch[] = array( $deletedUrl, 'public', $destRel );
1636 $this->cleanupBatch
[] = $row->fa_storage_key
;
1642 // Add a warning to the status object for missing IDs
1643 $missingIds = array_diff( $this->ids
, $idsPresent );
1644 foreach ( $missingIds as $id ) {
1645 $status->error( 'undelete-missing-filearchive', $id );
1648 // Run the store batch
1649 // Use the OVERWRITE_SAME flag to smooth over a common error
1650 $storeStatus = $this->file
->repo
->storeBatch( $storeBatch, FileRepo
::OVERWRITE_SAME
);
1651 $status->merge( $storeStatus );
1653 if ( !$status->ok
) {
1654 // Store batch returned a critical error -- this usually means nothing was stored
1655 // Stop now and return an error
1656 $this->file
->unlock();
1660 // Run the DB updates
1661 // Because we have locked the image row, key conflicts should be rare.
1662 // If they do occur, we can roll back the transaction at this time with
1663 // no data loss, but leaving unregistered files scattered throughout the
1665 // This is not ideal, which is why it's important to lock the image row.
1666 if ( $insertCurrent ) {
1667 $dbw->insert( 'image', $insertCurrent, __METHOD__
);
1669 if ( $insertBatch ) {
1670 $dbw->insert( 'oldimage', $insertBatch, __METHOD__
);
1673 $dbw->delete( 'filearchive',
1674 array( 'fa_id IN (' . $dbw->makeList( $deleteIds ) . ')' ),
1678 if( $status->successCount
> 0 ) {
1680 wfDebug( __METHOD__
." restored {$status->successCount} items, creating a new current\n" );
1682 // Update site_stats
1683 $site_stats = $dbw->tableName( 'site_stats' );
1684 $dbw->query( "UPDATE $site_stats SET ss_images=ss_images+1", __METHOD__
);
1686 $this->file
->purgeEverything();
1688 wfDebug( __METHOD__
." restored {$status->successCount} as archived versions\n" );
1689 $this->file
->purgeDescription();
1690 $this->file
->purgeHistory();
1693 $this->file
->unlock();
1698 * Delete unused files in the deleted zone.
1699 * This should be called from outside the transaction in which execute() was called.
1701 function cleanup() {
1702 if ( !$this->cleanupBatch
) {
1703 return $this->file
->repo
->newGood();
1705 $status = $this->file
->repo
->cleanupDeletedBatch( $this->cleanupBatch
);
1710 #------------------------------------------------------------------------------
1713 * Helper class for file movement
1716 class LocalFileMoveBatch
{
1717 var $file, $cur, $olds, $oldCount, $archive, $target, $db;
1719 function __construct( File
$file, Title
$target ) {
1720 $this->file
= $file;
1721 $this->target
= $target;
1722 $this->oldHash
= $this->file
->repo
->getHashPath( $this->file
->getName() );
1723 $this->newHash
= $this->file
->repo
->getHashPath( $this->target
->getDBKey() );
1724 $this->oldName
= $this->file
->getName();
1725 $this->newName
= $this->file
->repo
->getNameFromTitle( $this->target
);
1726 $this->oldRel
= $this->oldHash
. $this->oldName
;
1727 $this->newRel
= $this->newHash
. $this->newName
;
1728 $this->db
= $file->repo
->getMasterDb();
1732 * Add the current image to the batch
1734 function addCurrent() {
1735 $this->cur
= array( $this->oldRel
, $this->newRel
);
1739 * Add the old versions of the image to the batch
1741 function addOlds() {
1742 $archiveBase = 'archive';
1743 $this->olds
= array();
1744 $this->oldCount
= 0;
1746 $result = $this->db
->select( 'oldimage',
1747 array( 'oi_archive_name', 'oi_deleted' ),
1748 array( 'oi_name' => $this->oldName
),
1751 while( $row = $this->db
->fetchObject( $result ) ) {
1752 $oldName = $row->oi_archive_name
;
1753 $bits = explode( '!', $oldName, 2 );
1754 if( count( $bits ) != 2 ) {
1755 wfDebug( 'Invalid old file name: ' . $oldName );
1758 list( $timestamp, $filename ) = $bits;
1759 if( $this->oldName
!= $filename ) {
1760 wfDebug( 'Invalid old file name:' . $oldName );
1764 // Do we want to add those to oldCount?
1765 if( $row->oi_deleted
& File
::DELETED_FILE
) {
1768 $this->olds
[] = array(
1769 "{$archiveBase}/{$this->oldHash}{$oldName}",
1770 "{$archiveBase}/{$this->newHash}{$timestamp}!{$this->newName}"
1773 $this->db
->freeResult( $result );
1779 function execute() {
1780 $repo = $this->file
->repo
;
1781 $status = $repo->newGood();
1782 $triplets = $this->getMoveTriplets();
1784 $statusDb = $this->doDBUpdates();
1785 wfDebugLog( 'imagemove', "Renamed {$this->file->name} in database: {$statusDb->successCount} successes, {$statusDb->failCount} failures" );
1786 $statusMove = $repo->storeBatch( $triplets, FSRepo
::DELETE_SOURCE
);
1787 wfDebugLog( 'imagemove', "Moved files for {$this->file->name}: {$statusMove->successCount} successes, {$statusMove->failCount} failures" );
1788 if( !$statusMove->isOk() ) {
1789 wfDebugLog( 'imagemove', "Error in moving files: " . $statusMove->getWikiText() );
1790 $this->db
->rollback();
1792 $status->merge( $statusDb );
1793 $status->merge( $statusMove );
1798 * Do the database updates and return a new WikiError indicating how many
1799 * rows where updated.
1801 function doDBUpdates() {
1802 $repo = $this->file
->repo
;
1803 $status = $repo->newGood();
1806 // Update current image
1809 array( 'img_name' => $this->newName
),
1810 array( 'img_name' => $this->oldName
),
1813 if( $dbw->affectedRows() ) {
1814 $status->successCount++
;
1816 $status->failCount++
;
1819 // Update old images
1823 'oi_name' => $this->newName
,
1824 'oi_archive_name = ' . $dbw->strreplace( 'oi_archive_name', $dbw->addQuotes($this->oldName
), $dbw->addQuotes($this->newName
) ),
1826 array( 'oi_name' => $this->oldName
),
1829 $affected = $dbw->affectedRows();
1830 $total = $this->oldCount
;
1831 $status->successCount +
= $affected;
1832 $status->failCount +
= $total - $affected;
1838 * Generate triplets for FSRepo::storeBatch().
1840 function getMoveTriplets() {
1841 $moves = array_merge( array( $this->cur
), $this->olds
);
1842 $triplets = array(); // The format is: (srcUrl, destZone, destUrl)
1843 foreach( $moves as $move ) {
1844 // $move: (oldRelativePath, newRelativePath)
1845 $srcUrl = $this->file
->repo
->getVirtualUrl() . '/public/' . rawurlencode( $move[0] );
1846 $triplets[] = array( $srcUrl, 'public', $move[1] );
1847 wfDebugLog( 'imagemove', "Generated move triplet for {$this->file->name}: {$srcUrl} :: public :: {$move[1]}" );