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_IMAGE
, $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
;
457 * Return the size of the image file, in bytes
466 * Returns the mime type of the file.
468 function getMimeType() {
474 * Return the type of the media in the file.
475 * Use the value returned by this function with the MEDIATYPE_xxx constants.
477 function getMediaType() {
479 return $this->media_type
;
482 /** canRender inherited */
483 /** mustRender inherited */
484 /** allowInlineDisplay inherited */
485 /** isSafeFile inherited */
486 /** isTrustedFile inherited */
489 * Returns true if the file file exists on disk.
490 * @return boolean Whether file file exist on disk.
495 return $this->fileExists
;
498 /** getTransformScript inherited */
499 /** getUnscaledThumb inherited */
500 /** thumbName inherited */
501 /** createThumb inherited */
502 /** getThumbnail inherited */
503 /** transform inherited */
506 * Fix thumbnail files from 1.4 or before, with extreme prejudice
508 function migrateThumbFile( $thumbName ) {
509 $thumbDir = $this->getThumbPath();
510 $thumbPath = "$thumbDir/$thumbName";
511 if ( is_dir( $thumbPath ) ) {
512 // Directory where file should be
513 // This happened occasionally due to broken migration code in 1.5
514 // Rename to broken-*
515 for ( $i = 0; $i < 100 ; $i++
) {
516 $broken = $this->repo
->getZonePath('public') . "/broken-$i-$thumbName";
517 if ( !file_exists( $broken ) ) {
518 rename( $thumbPath, $broken );
522 // Doesn't exist anymore
525 if ( is_file( $thumbDir ) ) {
526 // File where directory should be
528 // Doesn't exist anymore
533 /** getHandler inherited */
534 /** iconThumb inherited */
535 /** getLastError inherited */
538 * Get all thumbnail names previously generated for this file
540 function getThumbnails() {
543 $dir = $this->getThumbPath();
545 if ( is_dir( $dir ) ) {
546 $handle = opendir( $dir );
549 while ( false !== ( $file = readdir($handle) ) ) {
550 if ( $file{0} != '.' ) {
562 * Refresh metadata in memcached, but don't touch thumbnails or squid
564 function purgeMetadataCache() {
566 $this->saveToCache();
567 $this->purgeHistory();
571 * Purge the shared history (OldLocalFile) cache
573 function purgeHistory() {
575 $hashedName = md5($this->getName());
576 $oldKey = wfMemcKey( 'oldfile', $hashedName );
577 $wgMemc->delete( $oldKey );
581 * Delete all previously generated thumbnails, refresh metadata in memcached and purge the squid
583 function purgeCache() {
584 // Refresh metadata cache
585 $this->purgeMetadataCache();
588 $this->purgeThumbnails();
590 // Purge squid cache for this file
591 SquidUpdate
::purge( array( $this->getURL() ) );
595 * Delete cached transformed files
597 function purgeThumbnails() {
600 $files = $this->getThumbnails();
601 $dir = $this->getThumbPath();
603 foreach ( $files as $file ) {
604 # Check that the base file name is part of the thumb name
605 # This is a basic sanity check to avoid erasing unrelated directories
606 if ( strpos( $file, $this->getName() ) !== false ) {
607 $url = $this->getThumbUrl( $file );
609 @unlink
( "$dir/$file" );
615 SquidUpdate
::purge( $urls );
619 /** purgeDescription inherited */
620 /** purgeEverything inherited */
622 function getHistory($limit = null, $start = null, $end = null) {
623 $dbr = $this->repo
->getSlaveDB();
624 $conds = $opts = array();
625 $conds[] = "oi_name = " . $dbr->addQuotes( $this->title
->getDBKey() );
626 if( $start !== null ) {
627 $conds[] = "oi_timestamp <= " . $dbr->addQuotes( $dbr->timestamp( $start ) );
629 if( $end !== null ) {
630 $conds[] = "oi_timestamp >= " . $dbr->addQuotes( $dbr->timestamp( $end ) );
633 $opts['LIMIT'] = $limit;
635 $opts['ORDER BY'] = 'oi_timestamp DESC';
636 $res = $dbr->select('oldimage', '*', $conds, __METHOD__
, $opts);
638 while( $row = $dbr->fetchObject($res) ) {
639 $r[] = OldLocalFile
::newFromRow($row, $this->repo
);
645 * Return the history of this file, line by line.
646 * starts with current version, then old versions.
647 * uses $this->historyLine to check which line to return:
648 * 0 return line for current version
649 * 1 query for old versions, return first one
650 * 2, ... return next old version from above query
654 function nextHistoryLine() {
655 # Polymorphic function name to distinguish foreign and local fetches
656 $fname = get_class( $this ) . '::' . __FUNCTION__
;
658 $dbr = $this->repo
->getSlaveDB();
660 if ( $this->historyLine
== 0 ) {// called for the first time, return line from cur
661 $this->historyRes
= $dbr->select( 'image',
664 "'' AS oi_archive_name",
668 array( 'img_name' => $this->title
->getDBkey() ),
671 if ( 0 == $dbr->numRows( $this->historyRes
) ) {
672 $dbr->freeResult($this->historyRes
);
673 $this->historyRes
= null;
676 } else if ( $this->historyLine
== 1 ) {
677 $dbr->freeResult($this->historyRes
);
678 $this->historyRes
= $dbr->select( 'oldimage', '*',
679 array( 'oi_name' => $this->title
->getDBkey() ),
681 array( 'ORDER BY' => 'oi_timestamp DESC' )
684 $this->historyLine ++
;
686 return $dbr->fetchObject( $this->historyRes
);
690 * Reset the history pointer to the first element of the history
693 function resetHistory() {
694 $this->historyLine
= 0;
695 if (!is_null($this->historyRes
)) {
696 $this->repo
->getSlaveDB()->freeResult($this->historyRes
);
697 $this->historyRes
= null;
701 /** getFullPath inherited */
702 /** getHashPath inherited */
703 /** getRel inherited */
704 /** getUrlRel inherited */
705 /** getArchiveRel inherited */
706 /** getThumbRel inherited */
707 /** getArchivePath inherited */
708 /** getThumbPath inherited */
709 /** getArchiveUrl inherited */
710 /** getThumbUrl inherited */
711 /** getArchiveVirtualUrl inherited */
712 /** getThumbVirtualUrl inherited */
713 /** isHashed inherited */
716 * Upload a file and record it in the DB
717 * @param string $srcPath Source path or virtual URL
718 * @param string $comment Upload description
719 * @param string $pageText Text to use for the new description page, if a new description page is created
720 * @param integer $flags Flags for publish()
721 * @param array $props File properties, if known. This can be used to reduce the
722 * upload time when uploading virtual URLs for which the file info
724 * @param string $timestamp Timestamp for img_timestamp, or false to use the current time
726 * @return FileRepoStatus object. On success, the value member contains the
727 * archive name, or an empty string if it was a new file.
729 function upload( $srcPath, $comment, $pageText, $flags = 0, $props = false, $timestamp = false ) {
731 $status = $this->publish( $srcPath, $flags );
733 if ( !$this->recordUpload2( $status->value
, $comment, $pageText, $props, $timestamp ) ) {
734 $status->fatal( 'filenotfound', $srcPath );
742 * Record a file upload in the upload log and the image table
743 * @deprecated use upload()
745 function recordUpload( $oldver, $desc, $license = '', $copyStatus = '', $source = '',
746 $watch = false, $timestamp = false )
748 $pageText = UploadForm
::getInitialPageText( $desc, $license, $copyStatus, $source );
749 if ( !$this->recordUpload2( $oldver, $desc, $pageText ) ) {
754 $wgUser->addWatch( $this->getTitle() );
761 * Record a file upload in the upload log and the image table
763 function recordUpload2( $oldver, $comment, $pageText, $props = false, $timestamp = false )
767 $dbw = $this->repo
->getMasterDB();
770 $props = $this->repo
->getFileProps( $this->getVirtualUrl() );
772 $props['description'] = $comment;
773 $props['user'] = $wgUser->getID();
774 $props['user_text'] = $wgUser->getName();
775 $props['timestamp'] = wfTimestamp( TS_MW
);
776 $this->setProps( $props );
778 // Delete thumbnails and refresh the metadata cache
779 $this->purgeThumbnails();
780 $this->saveToCache();
781 SquidUpdate
::purge( array( $this->getURL() ) );
783 // Fail now if the file isn't there
784 if ( !$this->fileExists
) {
785 wfDebug( __METHOD__
.": File ".$this->getPath()." went missing!\n" );
790 if ( $timestamp === false ) {
791 $timestamp = $dbw->timestamp();
794 # Test to see if the row exists using INSERT IGNORE
795 # This avoids race conditions by locking the row until the commit, and also
796 # doesn't deadlock. SELECT FOR UPDATE causes a deadlock for every race condition.
797 $dbw->insert( 'image',
799 'img_name' => $this->getName(),
800 'img_size'=> $this->size
,
801 'img_width' => intval( $this->width
),
802 'img_height' => intval( $this->height
),
803 'img_bits' => $this->bits
,
804 'img_media_type' => $this->media_type
,
805 'img_major_mime' => $this->major_mime
,
806 'img_minor_mime' => $this->minor_mime
,
807 'img_timestamp' => $timestamp,
808 'img_description' => $comment,
809 'img_user' => $wgUser->getID(),
810 'img_user_text' => $wgUser->getName(),
811 'img_metadata' => $this->metadata
,
812 'img_sha1' => $this->sha1
818 if( $dbw->affectedRows() == 0 ) {
821 # Collision, this is an update of a file
822 # Insert previous contents into oldimage
823 $dbw->insertSelect( 'oldimage', 'image',
825 'oi_name' => 'img_name',
826 'oi_archive_name' => $dbw->addQuotes( $oldver ),
827 'oi_size' => 'img_size',
828 'oi_width' => 'img_width',
829 'oi_height' => 'img_height',
830 'oi_bits' => 'img_bits',
831 'oi_timestamp' => 'img_timestamp',
832 'oi_description' => 'img_description',
833 'oi_user' => 'img_user',
834 'oi_user_text' => 'img_user_text',
835 'oi_metadata' => 'img_metadata',
836 'oi_media_type' => 'img_media_type',
837 'oi_major_mime' => 'img_major_mime',
838 'oi_minor_mime' => 'img_minor_mime',
839 'oi_sha1' => 'img_sha1'
840 ), array( 'img_name' => $this->getName() ), __METHOD__
843 # Update the current image row
844 $dbw->update( 'image',
846 'img_size' => $this->size
,
847 'img_width' => intval( $this->width
),
848 'img_height' => intval( $this->height
),
849 'img_bits' => $this->bits
,
850 'img_media_type' => $this->media_type
,
851 'img_major_mime' => $this->major_mime
,
852 'img_minor_mime' => $this->minor_mime
,
853 'img_timestamp' => $timestamp,
854 'img_description' => $comment,
855 'img_user' => $wgUser->getID(),
856 'img_user_text' => $wgUser->getName(),
857 'img_metadata' => $this->metadata
,
858 'img_sha1' => $this->sha1
859 ), array( /* WHERE */
860 'img_name' => $this->getName()
865 # Update the image count
866 $site_stats = $dbw->tableName( 'site_stats' );
867 $dbw->query( "UPDATE $site_stats SET ss_images=ss_images+1", __METHOD__
);
870 $descTitle = $this->getTitle();
871 $article = new Article( $descTitle );
874 $log = new LogPage( 'upload' );
875 $action = $reupload ?
'overwrite' : 'upload';
876 $log->addEntry( $action, $descTitle, $comment );
878 if( $descTitle->exists() ) {
879 # Create a null revision
880 $nullRevision = Revision
::newNullRevision( $dbw, $descTitle->getArticleId(), $log->getRcComment(), false );
881 $nullRevision->insertOn( $dbw );
883 wfRunHooks( 'NewRevisionFromEditComplete', array($article, $nullRevision, false) );
884 $article->updateRevisionOn( $dbw, $nullRevision );
886 # Invalidate the cache for the description page
887 $descTitle->invalidateCache();
888 $descTitle->purgeSquid();
890 // New file; create the description page.
891 // There's already a log entry, so don't make a second RC entry
892 $article->doEdit( $pageText, $comment, EDIT_NEW | EDIT_SUPPRESS_RC
);
895 # Hooks, hooks, the magic of hooks...
896 wfRunHooks( 'FileUpload', array( $this ) );
898 # Commit the transaction now, in case something goes wrong later
899 # The most important thing is that files don't get lost, especially archives
900 $dbw->immediateCommit();
902 # Invalidate cache for all pages using this file
903 $update = new HTMLCacheUpdate( $this->getTitle(), 'imagelinks' );
905 # Invalidate cache for all pages that redirects on this page
906 $redirs = $this->getTitle()->getRedirectsHere();
907 foreach( $redirs as $redir ) {
908 $update = new HTMLCacheUpdate( $redir, 'imagelinks' );
916 * Move or copy a file to its public location. If a file exists at the
917 * destination, move it to an archive. Returns the archive name on success
918 * or an empty string if it was a new file, and a wikitext-formatted
919 * WikiError object on failure.
921 * The archive name should be passed through to recordUpload for database
924 * @param string $sourcePath Local filesystem path to the source image
925 * @param integer $flags A bitwise combination of:
926 * File::DELETE_SOURCE Delete the source file, i.e. move
928 * @return FileRepoStatus object. On success, the value member contains the
929 * archive name, or an empty string if it was a new file.
931 function publish( $srcPath, $flags = 0 ) {
933 $dstRel = $this->getRel();
934 $archiveName = gmdate( 'YmdHis' ) . '!'. $this->getName();
935 $archiveRel = 'archive/' . $this->getHashPath() . $archiveName;
936 $flags = $flags & File
::DELETE_SOURCE ? LocalRepo
::DELETE_SOURCE
: 0;
937 $status = $this->repo
->publish( $srcPath, $dstRel, $archiveRel, $flags );
938 if ( $status->value
== 'new' ) {
941 $status->value
= $archiveName;
947 /** getLinksTo inherited */
948 /** getExifData inherited */
949 /** isLocal inherited */
950 /** wasDeleted inherited */
953 * Move file to the new title
955 * Move current, old version and all thumbnails
956 * to the new filename. Old file is deleted.
958 * Cache purging is done; checks for validity
959 * and logging are caller's responsibility
961 * @param $target Title New file name
962 * @return FileRepoStatus object.
964 function move( $target ) {
966 $dbw = $this->repo
->getMasterDB();
967 $batch = new LocalFileMoveBatch( $this, $target, $dbw );
968 $batch->addCurrent();
970 if( !$this->repo
->canTransformVia404() ) {
974 $status = $batch->execute();
975 $this->purgeEverything();
978 if ( $status->isOk() ) {
979 // Now switch the object
980 $this->title
= $target;
981 // Force regeneration of the name and hashpath
982 unset( $this->name
);
983 unset( $this->hashPath
);
984 // Purge the new image
985 $this->purgeEverything();
992 * Delete all versions of the file.
994 * Moves the files into an archive directory (or deletes them)
995 * and removes the database rows.
997 * Cache purging is done; logging is caller's responsibility.
1001 * @return FileRepoStatus object.
1003 function delete( $reason, $suppress = false ) {
1005 $batch = new LocalFileDeleteBatch( $this, $reason, $suppress );
1006 $batch->addCurrent();
1008 # Get old version relative paths
1009 $dbw = $this->repo
->getMasterDB();
1010 $result = $dbw->select( 'oldimage',
1011 array( 'oi_archive_name' ),
1012 array( 'oi_name' => $this->getName() ) );
1013 while ( $row = $dbw->fetchObject( $result ) ) {
1014 $batch->addOld( $row->oi_archive_name
);
1016 $status = $batch->execute();
1018 if ( $status->ok
) {
1019 // Update site_stats
1020 $site_stats = $dbw->tableName( 'site_stats' );
1021 $dbw->query( "UPDATE $site_stats SET ss_images=ss_images-1", __METHOD__
);
1022 $this->purgeEverything();
1030 * Delete an old version of the file.
1032 * Moves the file into an archive directory (or deletes it)
1033 * and removes the database row.
1035 * Cache purging is done; logging is caller's responsibility.
1039 * @throws MWException or FSException on database or filestore failure
1040 * @return FileRepoStatus object.
1042 function deleteOld( $archiveName, $reason, $suppress=false ) {
1044 $batch = new LocalFileDeleteBatch( $this, $reason, $suppress );
1045 $batch->addOld( $archiveName );
1046 $status = $batch->execute();
1048 if ( $status->ok
) {
1049 $this->purgeDescription();
1050 $this->purgeHistory();
1056 * Restore all or specified deleted revisions to the given file.
1057 * Permissions and logging are left to the caller.
1059 * May throw database exceptions on error.
1061 * @param $versions set of record ids of deleted items to restore,
1062 * or empty to restore all revisions.
1064 * @return FileRepoStatus
1066 function restore( $versions = array(), $unsuppress = false ) {
1067 $batch = new LocalFileRestoreBatch( $this, $unsuppress );
1071 $batch->addIds( $versions );
1073 $status = $batch->execute();
1074 if ( !$status->ok
) {
1078 $cleanupStatus = $batch->cleanup();
1079 $cleanupStatus->successCount
= 0;
1080 $cleanupStatus->failCount
= 0;
1081 $status->merge( $cleanupStatus );
1085 /** isMultipage inherited */
1086 /** pageCount inherited */
1087 /** scaleHeight inherited */
1088 /** getImageSize inherited */
1091 * Get the URL of the file description page.
1093 function getDescriptionUrl() {
1094 return $this->title
->getLocalUrl();
1098 * Get the HTML text of the description page
1099 * This is not used by ImagePage for local files, since (among other things)
1100 * it skips the parser cache.
1102 function getDescriptionText() {
1104 $revision = Revision
::newFromTitle( $this->title
);
1105 if ( !$revision ) return false;
1106 $text = $revision->getText();
1107 if ( !$text ) return false;
1108 $html = $wgParser->parse( $text, new ParserOptions
);
1112 function getDescription() {
1114 return $this->description
;
1117 function getTimestamp() {
1119 return $this->timestamp
;
1122 function getSha1() {
1124 // Initialise now if necessary
1125 if ( $this->sha1
== '' && $this->fileExists
) {
1126 $this->sha1
= File
::sha1Base36( $this->getPath() );
1127 if ( strval( $this->sha1
) != '' ) {
1128 $dbw = $this->repo
->getMasterDB();
1129 $dbw->update( 'image',
1130 array( 'img_sha1' => $this->sha1
),
1131 array( 'img_name' => $this->getName() ),
1133 $this->saveToCache();
1141 * Start a transaction and lock the image for update
1142 * Increments a reference counter if the lock is already held
1143 * @return boolean True if the image exists, false otherwise
1146 $dbw = $this->repo
->getMasterDB();
1147 if ( !$this->locked
) {
1151 return $dbw->selectField( 'image', '1', array( 'img_name' => $this->getName() ), __METHOD__
);
1155 * Decrement the lock reference count. If the reference count is reduced to zero, commits
1156 * the transaction and thereby releases the image lock.
1159 if ( $this->locked
) {
1161 if ( !$this->locked
) {
1162 $dbw = $this->repo
->getMasterDB();
1169 * Roll back the DB transaction and mark the image unlocked
1171 function unlockAndRollback() {
1172 $this->locked
= false;
1173 $dbw = $this->repo
->getMasterDB();
1176 } // LocalFile class
1178 #------------------------------------------------------------------------------
1181 * Helper class for file deletion
1184 class LocalFileDeleteBatch
{
1185 var $file, $reason, $srcRels = array(), $archiveUrls = array(), $deletionBatch, $suppress;
1188 function __construct( File
$file, $reason = '', $suppress = false ) {
1189 $this->file
= $file;
1190 $this->reason
= $reason;
1191 $this->suppress
= $suppress;
1192 $this->status
= $file->repo
->newGood();
1195 function addCurrent() {
1196 $this->srcRels
['.'] = $this->file
->getRel();
1199 function addOld( $oldName ) {
1200 $this->srcRels
[$oldName] = $this->file
->getArchiveRel( $oldName );
1201 $this->archiveUrls
[] = $this->file
->getArchiveUrl( $oldName );
1204 function getOldRels() {
1205 if ( !isset( $this->srcRels
['.'] ) ) {
1206 $oldRels =& $this->srcRels
;
1207 $deleteCurrent = false;
1209 $oldRels = $this->srcRels
;
1210 unset( $oldRels['.'] );
1211 $deleteCurrent = true;
1213 return array( $oldRels, $deleteCurrent );
1216 /*protected*/ function getHashes() {
1218 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
1219 if ( $deleteCurrent ) {
1220 $hashes['.'] = $this->file
->getSha1();
1222 if ( count( $oldRels ) ) {
1223 $dbw = $this->file
->repo
->getMasterDB();
1224 $res = $dbw->select( 'oldimage', array( 'oi_archive_name', 'oi_sha1' ),
1225 'oi_archive_name IN(' . $dbw->makeList( array_keys( $oldRels ) ) . ')',
1227 while ( $row = $dbw->fetchObject( $res ) ) {
1228 if ( rtrim( $row->oi_sha1
, "\0" ) === '' ) {
1229 // Get the hash from the file
1230 $oldUrl = $this->file
->getArchiveVirtualUrl( $row->oi_archive_name
);
1231 $props = $this->file
->repo
->getFileProps( $oldUrl );
1232 if ( $props['fileExists'] ) {
1233 // Upgrade the oldimage row
1234 $dbw->update( 'oldimage',
1235 array( 'oi_sha1' => $props['sha1'] ),
1236 array( 'oi_name' => $this->file
->getName(), 'oi_archive_name' => $row->oi_archive_name
),
1238 $hashes[$row->oi_archive_name
] = $props['sha1'];
1240 $hashes[$row->oi_archive_name
] = false;
1243 $hashes[$row->oi_archive_name
] = $row->oi_sha1
;
1247 $missing = array_diff_key( $this->srcRels
, $hashes );
1248 foreach ( $missing as $name => $rel ) {
1249 $this->status
->error( 'filedelete-old-unregistered', $name );
1251 foreach ( $hashes as $name => $hash ) {
1253 $this->status
->error( 'filedelete-missing', $this->srcRels
[$name] );
1254 unset( $hashes[$name] );
1261 function doDBInserts() {
1263 $dbw = $this->file
->repo
->getMasterDB();
1264 $encTimestamp = $dbw->addQuotes( $dbw->timestamp() );
1265 $encUserId = $dbw->addQuotes( $wgUser->getID() );
1266 $encReason = $dbw->addQuotes( $this->reason
);
1267 $encGroup = $dbw->addQuotes( 'deleted' );
1268 $ext = $this->file
->getExtension();
1269 $dotExt = $ext === '' ?
'' : ".$ext";
1270 $encExt = $dbw->addQuotes( $dotExt );
1271 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
1273 // Bitfields to further suppress the content
1274 if ( $this->suppress
) {
1276 // This should be 15...
1277 $bitfield |
= Revision
::DELETED_TEXT
;
1278 $bitfield |
= Revision
::DELETED_COMMENT
;
1279 $bitfield |
= Revision
::DELETED_USER
;
1280 $bitfield |
= Revision
::DELETED_RESTRICTED
;
1282 $bitfield = 'oi_deleted';
1285 if ( $deleteCurrent ) {
1286 $concat = $dbw->buildConcat( array( "img_sha1", $encExt ) );
1287 $where = array( 'img_name' => $this->file
->getName() );
1288 $dbw->insertSelect( 'filearchive', 'image',
1290 'fa_storage_group' => $encGroup,
1291 'fa_storage_key' => "CASE WHEN img_sha1='' THEN '' ELSE $concat END",
1292 'fa_deleted_user' => $encUserId,
1293 'fa_deleted_timestamp' => $encTimestamp,
1294 'fa_deleted_reason' => $encReason,
1295 'fa_deleted' => $this->suppress ?
$bitfield : 0,
1297 'fa_name' => 'img_name',
1298 'fa_archive_name' => 'NULL',
1299 'fa_size' => 'img_size',
1300 'fa_width' => 'img_width',
1301 'fa_height' => 'img_height',
1302 'fa_metadata' => 'img_metadata',
1303 'fa_bits' => 'img_bits',
1304 'fa_media_type' => 'img_media_type',
1305 'fa_major_mime' => 'img_major_mime',
1306 'fa_minor_mime' => 'img_minor_mime',
1307 'fa_description' => 'img_description',
1308 'fa_user' => 'img_user',
1309 'fa_user_text' => 'img_user_text',
1310 'fa_timestamp' => 'img_timestamp'
1311 ), $where, __METHOD__
);
1314 if ( count( $oldRels ) ) {
1315 $concat = $dbw->buildConcat( array( "oi_sha1", $encExt ) );
1317 'oi_name' => $this->file
->getName(),
1318 'oi_archive_name IN (' . $dbw->makeList( array_keys( $oldRels ) ) . ')' );
1319 $dbw->insertSelect( 'filearchive', 'oldimage',
1321 'fa_storage_group' => $encGroup,
1322 'fa_storage_key' => "CASE WHEN oi_sha1='' THEN '' ELSE $concat END",
1323 'fa_deleted_user' => $encUserId,
1324 'fa_deleted_timestamp' => $encTimestamp,
1325 'fa_deleted_reason' => $encReason,
1326 'fa_deleted' => $this->suppress ?
$bitfield : 'oi_deleted',
1328 'fa_name' => 'oi_name',
1329 'fa_archive_name' => 'oi_archive_name',
1330 'fa_size' => 'oi_size',
1331 'fa_width' => 'oi_width',
1332 'fa_height' => 'oi_height',
1333 'fa_metadata' => 'oi_metadata',
1334 'fa_bits' => 'oi_bits',
1335 'fa_media_type' => 'oi_media_type',
1336 'fa_major_mime' => 'oi_major_mime',
1337 'fa_minor_mime' => 'oi_minor_mime',
1338 'fa_description' => 'oi_description',
1339 'fa_user' => 'oi_user',
1340 'fa_user_text' => 'oi_user_text',
1341 'fa_timestamp' => 'oi_timestamp',
1342 'fa_deleted' => $bitfield
1343 ), $where, __METHOD__
);
1347 function doDBDeletes() {
1348 $dbw = $this->file
->repo
->getMasterDB();
1349 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
1350 if ( count( $oldRels ) ) {
1351 $dbw->delete( 'oldimage',
1353 'oi_name' => $this->file
->getName(),
1354 'oi_archive_name IN (' . $dbw->makeList( array_keys( $oldRels ) ) . ')'
1357 if ( $deleteCurrent ) {
1358 $dbw->delete( 'image', array( 'img_name' => $this->file
->getName() ), __METHOD__
);
1363 * Run the transaction
1365 function execute() {
1366 global $wgUser, $wgUseSquid;
1367 wfProfileIn( __METHOD__
);
1369 $this->file
->lock();
1370 // Leave private files alone
1371 $privateFiles = array();
1372 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
1373 $dbw = $this->file
->repo
->getMasterDB();
1374 if( !empty( $oldRels ) ) {
1375 $res = $dbw->select( 'oldimage',
1376 array( 'oi_archive_name' ),
1377 array( 'oi_name' => $this->file
->getName(),
1378 'oi_archive_name IN (' . $dbw->makeList( array_keys($oldRels) ) . ')',
1379 'oi_deleted & ' . File
::DELETED_FILE
=> File
::DELETED_FILE
),
1381 while( $row = $dbw->fetchObject( $res ) ) {
1382 $privateFiles[$row->oi_archive_name
] = 1;
1385 // Prepare deletion batch
1386 $hashes = $this->getHashes();
1387 $this->deletionBatch
= array();
1388 $ext = $this->file
->getExtension();
1389 $dotExt = $ext === '' ?
'' : ".$ext";
1390 foreach ( $this->srcRels
as $name => $srcRel ) {
1391 // Skip files that have no hash (missing source).
1392 // Keep private files where they are.
1393 if ( isset($hashes[$name]) && !array_key_exists($name,$privateFiles) ) {
1394 $hash = $hashes[$name];
1395 $key = $hash . $dotExt;
1396 $dstRel = $this->file
->repo
->getDeletedHashPath( $key ) . $key;
1397 $this->deletionBatch
[$name] = array( $srcRel, $dstRel );
1401 // Lock the filearchive rows so that the files don't get deleted by a cleanup operation
1402 // We acquire this lock by running the inserts now, before the file operations.
1404 // This potentially has poor lock contention characteristics -- an alternative
1405 // scheme would be to insert stub filearchive entries with no fa_name and commit
1406 // them in a separate transaction, then run the file ops, then update the fa_name fields.
1407 $this->doDBInserts();
1409 // Execute the file deletion batch
1410 $status = $this->file
->repo
->deleteBatch( $this->deletionBatch
);
1411 if ( !$status->isGood() ) {
1412 $this->status
->merge( $status );
1415 if ( !$this->status
->ok
) {
1416 // Critical file deletion error
1417 // Roll back inserts, release lock and abort
1418 // TODO: delete the defunct filearchive rows if we are using a non-transactional DB
1419 $this->file
->unlockAndRollback();
1420 return $this->status
;
1424 if ( $wgUseSquid ) {
1426 foreach ( $this->srcRels
as $srcRel ) {
1427 $urlRel = str_replace( '%2F', '/', rawurlencode( $srcRel ) );
1428 $urls[] = $this->file
->repo
->getZoneUrl( 'public' ) . '/' . $urlRel;
1430 SquidUpdate
::purge( $urls );
1433 // Delete image/oldimage rows
1434 $this->doDBDeletes();
1436 // Commit and return
1437 $this->file
->unlock();
1438 wfProfileOut( __METHOD__
);
1439 return $this->status
;
1443 #------------------------------------------------------------------------------
1446 * Helper class for file undeletion
1449 class LocalFileRestoreBatch
{
1450 var $file, $cleanupBatch, $ids, $all, $unsuppress = false;
1452 function __construct( File
$file, $unsuppress = false ) {
1453 $this->file
= $file;
1454 $this->cleanupBatch
= $this->ids
= array();
1455 $this->ids
= array();
1456 $this->unsuppress
= $unsuppress;
1462 function addId( $fa_id ) {
1463 $this->ids
[] = $fa_id;
1467 * Add a whole lot of files by ID
1469 function addIds( $ids ) {
1470 $this->ids
= array_merge( $this->ids
, $ids );
1474 * Add all revisions of the file
1481 * Run the transaction, except the cleanup batch.
1482 * The cleanup batch should be run in a separate transaction, because it locks different
1483 * rows and there's no need to keep the image row locked while it's acquiring those locks
1484 * The caller may have its own transaction open.
1485 * So we save the batch and let the caller call cleanup()
1487 function execute() {
1488 global $wgUser, $wgLang;
1489 if ( !$this->all
&& !$this->ids
) {
1491 return $this->file
->repo
->newGood();
1494 $exists = $this->file
->lock();
1495 $dbw = $this->file
->repo
->getMasterDB();
1496 $status = $this->file
->repo
->newGood();
1498 // Fetch all or selected archived revisions for the file,
1499 // sorted from the most recent to the oldest.
1500 $conditions = array( 'fa_name' => $this->file
->getName() );
1502 $conditions[] = 'fa_id IN (' . $dbw->makeList( $this->ids
) . ')';
1505 $result = $dbw->select( 'filearchive', '*',
1508 array( 'ORDER BY' => 'fa_timestamp DESC' ) );
1510 $idsPresent = array();
1511 $storeBatch = array();
1512 $insertBatch = array();
1513 $insertCurrent = false;
1514 $deleteIds = array();
1516 $archiveNames = array();
1517 while( $row = $dbw->fetchObject( $result ) ) {
1518 $idsPresent[] = $row->fa_id
;
1520 if ( $row->fa_name
!= $this->file
->getName() ) {
1521 $status->error( 'undelete-filename-mismatch', $wgLang->timeanddate( $row->fa_timestamp
) );
1522 $status->failCount++
;
1525 if ( $row->fa_storage_key
== '' ) {
1526 // Revision was missing pre-deletion
1527 $status->error( 'undelete-bad-store-key', $wgLang->timeanddate( $row->fa_timestamp
) );
1528 $status->failCount++
;
1532 $deletedRel = $this->file
->repo
->getDeletedHashPath( $row->fa_storage_key
) . $row->fa_storage_key
;
1533 $deletedUrl = $this->file
->repo
->getVirtualUrl() . '/deleted/' . $deletedRel;
1535 $sha1 = substr( $row->fa_storage_key
, 0, strcspn( $row->fa_storage_key
, '.' ) );
1537 if ( strlen( $sha1 ) == 32 && $sha1[0] == '0' ) {
1538 $sha1 = substr( $sha1, 1 );
1541 if( is_null( $row->fa_major_mime
) ||
$row->fa_major_mime
== 'unknown'
1542 ||
is_null( $row->fa_minor_mime
) ||
$row->fa_minor_mime
== 'unknown'
1543 ||
is_null( $row->fa_media_type
) ||
$row->fa_media_type
== 'UNKNOWN'
1544 ||
is_null( $row->fa_metadata
) ) {
1545 // Refresh our metadata
1546 // Required for a new current revision; nice for older ones too. :)
1547 $props = RepoGroup
::singleton()->getFileProps( $deletedUrl );
1550 'minor_mime' => $row->fa_minor_mime
,
1551 'major_mime' => $row->fa_major_mime
,
1552 'media_type' => $row->fa_media_type
,
1553 'metadata' => $row->fa_metadata
);
1556 if ( $first && !$exists ) {
1557 // The live (current) version cannot be hidden!
1558 if( !$this->unsuppress
&& $row->fa_deleted
) {
1559 $this->file
->unlock();
1562 // This revision will be published as the new current version
1563 $destRel = $this->file
->getRel();
1564 $insertCurrent = array(
1565 'img_name' => $row->fa_name
,
1566 'img_size' => $row->fa_size
,
1567 'img_width' => $row->fa_width
,
1568 'img_height' => $row->fa_height
,
1569 'img_metadata' => $props['metadata'],
1570 'img_bits' => $row->fa_bits
,
1571 'img_media_type' => $props['media_type'],
1572 'img_major_mime' => $props['major_mime'],
1573 'img_minor_mime' => $props['minor_mime'],
1574 'img_description' => $row->fa_description
,
1575 'img_user' => $row->fa_user
,
1576 'img_user_text' => $row->fa_user_text
,
1577 'img_timestamp' => $row->fa_timestamp
,
1578 'img_sha1' => $sha1);
1580 $archiveName = $row->fa_archive_name
;
1581 if( $archiveName == '' ) {
1582 // This was originally a current version; we
1583 // have to devise a new archive name for it.
1584 // Format is <timestamp of archiving>!<name>
1585 $timestamp = wfTimestamp( TS_UNIX
, $row->fa_deleted_timestamp
);
1587 $archiveName = wfTimestamp( TS_MW
, $timestamp ) . '!' . $row->fa_name
;
1589 } while ( isset( $archiveNames[$archiveName] ) );
1591 $archiveNames[$archiveName] = true;
1592 $destRel = $this->file
->getArchiveRel( $archiveName );
1593 $insertBatch[] = array(
1594 'oi_name' => $row->fa_name
,
1595 'oi_archive_name' => $archiveName,
1596 'oi_size' => $row->fa_size
,
1597 'oi_width' => $row->fa_width
,
1598 'oi_height' => $row->fa_height
,
1599 'oi_bits' => $row->fa_bits
,
1600 'oi_description' => $row->fa_description
,
1601 'oi_user' => $row->fa_user
,
1602 'oi_user_text' => $row->fa_user_text
,
1603 'oi_timestamp' => $row->fa_timestamp
,
1604 'oi_metadata' => $props['metadata'],
1605 'oi_media_type' => $props['media_type'],
1606 'oi_major_mime' => $props['major_mime'],
1607 'oi_minor_mime' => $props['minor_mime'],
1608 'oi_deleted' => $this->unsuppress ?
0 : $row->fa_deleted
,
1609 'oi_sha1' => $sha1 );
1612 $deleteIds[] = $row->fa_id
;
1613 if( !$this->unsuppress
&& $row->fa_deleted
& File
::DELETED_FILE
) {
1614 // private files can stay where they are
1616 $storeBatch[] = array( $deletedUrl, 'public', $destRel );
1617 $this->cleanupBatch
[] = $row->fa_storage_key
;
1623 // Add a warning to the status object for missing IDs
1624 $missingIds = array_diff( $this->ids
, $idsPresent );
1625 foreach ( $missingIds as $id ) {
1626 $status->error( 'undelete-missing-filearchive', $id );
1629 // Run the store batch
1630 // Use the OVERWRITE_SAME flag to smooth over a common error
1631 $storeStatus = $this->file
->repo
->storeBatch( $storeBatch, FileRepo
::OVERWRITE_SAME
);
1632 $status->merge( $storeStatus );
1634 if ( !$status->ok
) {
1635 // Store batch returned a critical error -- this usually means nothing was stored
1636 // Stop now and return an error
1637 $this->file
->unlock();
1641 // Run the DB updates
1642 // Because we have locked the image row, key conflicts should be rare.
1643 // If they do occur, we can roll back the transaction at this time with
1644 // no data loss, but leaving unregistered files scattered throughout the
1646 // This is not ideal, which is why it's important to lock the image row.
1647 if ( $insertCurrent ) {
1648 $dbw->insert( 'image', $insertCurrent, __METHOD__
);
1650 if ( $insertBatch ) {
1651 $dbw->insert( 'oldimage', $insertBatch, __METHOD__
);
1654 $dbw->delete( 'filearchive',
1655 array( 'fa_id IN (' . $dbw->makeList( $deleteIds ) . ')' ),
1659 if( $status->successCount
> 0 ) {
1661 wfDebug( __METHOD__
." restored {$status->successCount} items, creating a new current\n" );
1663 // Update site_stats
1664 $site_stats = $dbw->tableName( 'site_stats' );
1665 $dbw->query( "UPDATE $site_stats SET ss_images=ss_images+1", __METHOD__
);
1667 $this->file
->purgeEverything();
1669 wfDebug( __METHOD__
." restored {$status->successCount} as archived versions\n" );
1670 $this->file
->purgeDescription();
1671 $this->file
->purgeHistory();
1674 $this->file
->unlock();
1679 * Delete unused files in the deleted zone.
1680 * This should be called from outside the transaction in which execute() was called.
1682 function cleanup() {
1683 if ( !$this->cleanupBatch
) {
1684 return $this->file
->repo
->newGood();
1686 $status = $this->file
->repo
->cleanupDeletedBatch( $this->cleanupBatch
);
1691 #------------------------------------------------------------------------------
1694 * Helper class for file movement
1697 class LocalFileMoveBatch
{
1698 var $file, $cur, $olds, $oldcount, $archive, $thumbs, $target, $db;
1700 function __construct( File
$file, Title
$target, Database
$db ) {
1701 $this->file
= $file;
1702 $this->target
= $target;
1703 $this->oldHash
= $this->file
->repo
->getHashPath( $this->file
->getName() );
1704 $this->newHash
= $this->file
->repo
->getHashPath( $this->target
->getDbKey() );
1705 $this->oldName
= $this->file
->getName();
1706 $this->newName
= $this->file
->repo
->getNameFromTitle( $this->target
);
1707 $this->oldRel
= $this->oldHash
. $this->oldName
;
1708 $this->newRel
= $this->newHash
. $this->newName
;
1712 function addCurrent() {
1713 $this->cur
= array( $this->oldRel
, $this->newRel
);
1716 function addThumbs() {
1717 // Thumbnails are purged, so no need to move them
1718 $this->thumbs
= array();
1721 function addOlds() {
1722 $archiveBase = 'archive';
1723 $this->olds
= array();
1724 $this->oldcount
= 0;
1726 $result = $this->db
->select( 'oldimage',
1727 array( 'oi_archive_name', 'oi_deleted' ),
1728 array( 'oi_name' => $this->oldName
),
1731 while( $row = $this->db
->fetchObject( $result ) ) {
1732 $oldname = $row->oi_archive_name
;
1733 $bits = explode( '!', $oldname, 2 );
1734 if( count( $bits ) != 2 ) {
1735 wfDebug( 'Invalid old file name: ' . $oldname );
1738 list( $timestamp, $filename ) = $bits;
1739 if( $this->oldName
!= $filename ) {
1740 wfDebug( 'Invalid old file name:' . $oldName );
1744 // Do we want to add those to oldcount?
1745 if( $row->oi_deleted
& File
::DELETED_FILE
) {
1748 $this->olds
[] = array(
1749 "{$archiveBase}/{$this->oldHash}{$oldname}",
1750 "{$archiveBase}/{$this->newHash}{$timestamp}!{$this->newName}"
1753 $this->db
->freeResult( $result );
1756 function execute() {
1757 $repo = $this->file
->repo
;
1758 $status = $repo->newGood();
1759 $triplets = $this->getMoveTriplets();
1761 $statusDb = $this->doDBUpdates();
1762 $statusMove = $repo->storeBatch( $triplets, FSRepo
::DELETE_SOURCE
);
1763 if( !$statusMove->isOk() ) {
1764 $this->db
->rollback();
1766 $status->merge( $statusDb );
1767 $status->merge( $statusMove );
1771 function doDBUpdates() {
1772 $repo = $this->file
->repo
;
1773 $status = $repo->newGood();
1776 // Update current image
1779 array( 'img_name' => $this->newName
),
1780 array( 'img_name' => $this->oldName
),
1783 if( $dbw->affectedRows() ) {
1784 $status->successCount++
;
1786 $status->failCount++
;
1789 // Update old images
1793 'oi_name' => $this->newName
,
1794 'oi_archive_name = ' . $dbw->strreplace( 'oi_archive_name', $dbw->addQuotes($this->oldName
), $dbw->addQuotes($this->newName
) ),
1796 array( 'oi_name' => $this->oldName
),
1799 $affected = $dbw->affectedRows();
1800 $total = $this->oldcount
;
1801 $status->successCount +
= $affected;
1802 $status->failCount +
= $total - $affected;
1807 // Generates triplets for FSRepo::storeBatch()
1808 function getMoveTriplets() {
1809 $moves = array_merge( array( $this->cur
), $this->olds
, $this->thumbs
);
1810 $triplets = array(); // The format is: (srcUrl, destZone, destUrl)
1811 foreach( $moves as $move ) {
1812 // $move: (oldRelativePath, newRelativePath)
1813 $srcUrl = $this->file
->repo
->getVirtualUrl() . '/public/' . rawurlencode( $move[0] );
1814 $triplets[] = array( $srcUrl, 'public', $move[1] );