6 * Bump this number when serialized cache records may be incompatible.
8 define( 'MW_FILE_VERSION', 7 );
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
25 * @addtogroup FileRepo
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 );
79 * Do not call this except from inside a repo class.
81 function __construct( $title, $repo ) {
82 if( !is_object( $title ) ) {
83 throw new MWException( __CLASS__
.' constructor given bogus title.' );
85 parent
::__construct( $title, $repo );
87 $this->historyLine
= 0;
88 $this->historyRes
= null;
89 $this->dataLoaded
= false;
93 * Get the memcached key
95 function getCacheKey() {
96 $hashedName = md5($this->getName());
97 return wfMemcKey( 'file', $hashedName );
101 * Try to load file metadata from memcached. Returns true on success.
103 function loadFromCache() {
105 wfProfileIn( __METHOD__
);
106 $this->dataLoaded
= false;
107 $key = $this->getCacheKey();
111 $cachedValues = $wgMemc->get( $key );
113 // Check if the key existed and belongs to this version of MediaWiki
114 if ( isset($cachedValues['version']) && ( $cachedValues['version'] == MW_FILE_VERSION
) ) {
115 wfDebug( "Pulling file metadata from cache key $key\n" );
116 $this->fileExists
= $cachedValues['fileExists'];
117 if ( $this->fileExists
) {
118 $this->setProps( $cachedValues );
120 $this->dataLoaded
= true;
122 if ( $this->dataLoaded
) {
123 wfIncrStats( 'image_cache_hit' );
125 wfIncrStats( 'image_cache_miss' );
128 wfProfileOut( __METHOD__
);
129 return $this->dataLoaded
;
133 * Save the file metadata to memcached
135 function saveToCache() {
138 $key = $this->getCacheKey();
142 $fields = $this->getCacheFields( '' );
143 $cache = array( 'version' => MW_FILE_VERSION
);
144 $cache['fileExists'] = $this->fileExists
;
145 if ( $this->fileExists
) {
146 foreach ( $fields as $field ) {
147 $cache[$field] = $this->$field;
151 $wgMemc->set( $key, $cache, 60 * 60 * 24 * 7 ); // A week
155 * Load metadata from the file itself
157 function loadFromFile() {
158 $this->setProps( self
::getPropsFromPath( $this->getPath() ) );
161 function getCacheFields( $prefix = 'img_' ) {
162 static $fields = array( 'size', 'width', 'height', 'bits', 'media_type',
163 'major_mime', 'minor_mime', 'metadata', 'timestamp', 'sha1', 'user', 'user_text', 'description' );
164 static $results = array();
165 if ( $prefix == '' ) {
168 if ( !isset( $results[$prefix] ) ) {
169 $prefixedFields = array();
170 foreach ( $fields as $field ) {
171 $prefixedFields[] = $prefix . $field;
173 $results[$prefix] = $prefixedFields;
175 return $results[$prefix];
179 * Load file metadata from the DB
181 function loadFromDB() {
182 # Polymorphic function name to distinguish foreign and local fetches
183 $fname = get_class( $this ) . '::' . __FUNCTION__
;
184 wfProfileIn( $fname );
186 # Unconditionally set loaded=true, we don't want the accessors constantly rechecking
187 $this->dataLoaded
= true;
189 $dbr = $this->repo
->getMasterDB();
191 $row = $dbr->selectRow( 'image', $this->getCacheFields( 'img_' ),
192 array( 'img_name' => $this->getName() ), $fname );
194 $this->loadFromRow( $row );
196 $this->fileExists
= false;
199 wfProfileOut( $fname );
203 * Decode a row from the database (either object or array) to an array
204 * with timestamps and MIME types decoded, and the field prefix removed.
206 function decodeRow( $row, $prefix = 'img_' ) {
207 $array = (array)$row;
208 $prefixLength = strlen( $prefix );
209 // Sanity check prefix once
210 if ( substr( key( $array ), 0, $prefixLength ) !== $prefix ) {
211 throw new MWException( __METHOD__
. ': incorrect $prefix parameter' );
214 foreach ( $array as $name => $value ) {
215 $decoded[substr( $name, $prefixLength )] = $value;
217 $decoded['timestamp'] = wfTimestamp( TS_MW
, $decoded['timestamp'] );
218 if ( empty( $decoded['major_mime'] ) ) {
219 $decoded['mime'] = "unknown/unknown";
221 if (!$decoded['minor_mime']) {
222 $decoded['minor_mime'] = "unknown";
224 $decoded['mime'] = $decoded['major_mime'].'/'.$decoded['minor_mime'];
226 # Trim zero padding from char/binary field
227 $decoded['sha1'] = rtrim( $decoded['sha1'], "\0" );
232 * Load file metadata from a DB result row
234 function loadFromRow( $row, $prefix = 'img_' ) {
235 $this->dataLoaded
= true;
236 $array = $this->decodeRow( $row, $prefix );
237 foreach ( $array as $name => $value ) {
238 $this->$name = $value;
240 $this->fileExists
= true;
241 $this->maybeUpgradeRow();
245 * Load file metadata from cache or DB, unless already loaded
248 if ( !$this->dataLoaded
) {
249 if ( !$this->loadFromCache() ) {
251 $this->saveToCache();
253 $this->dataLoaded
= true;
258 * Upgrade a row if it needs it
260 function maybeUpgradeRow() {
261 if ( wfReadOnly() ) {
264 if ( is_null($this->media_type
) ||
265 $this->mime
== 'image/svg'
268 $this->upgraded
= true;
270 $handler = $this->getHandler();
271 if ( $handler && !$handler->isMetadataValid( $this, $this->metadata
) ) {
273 $this->upgraded
= true;
278 function getUpgraded() {
279 return $this->upgraded
;
283 * Fix assorted version-related problems with the image row by reloading it from the file
285 function upgradeRow() {
286 wfProfileIn( __METHOD__
);
288 $this->loadFromFile();
290 # Don't destroy file info of missing files
291 if ( !$this->fileExists
) {
292 wfDebug( __METHOD__
.": file does not exist, aborting\n" );
295 $dbw = $this->repo
->getMasterDB();
296 list( $major, $minor ) = self
::splitMime( $this->mime
);
298 if ( wfReadOnly() ) {
301 wfDebug(__METHOD__
.': upgrading '.$this->getName()." to the current schema\n");
303 $dbw->update( 'image',
305 'img_width' => $this->width
,
306 'img_height' => $this->height
,
307 'img_bits' => $this->bits
,
308 'img_media_type' => $this->media_type
,
309 'img_major_mime' => $major,
310 'img_minor_mime' => $minor,
311 'img_metadata' => $this->metadata
,
312 'img_sha1' => $this->sha1
,
313 ), array( 'img_name' => $this->getName() ),
316 $this->saveToCache();
317 wfProfileOut( __METHOD__
);
321 * Set properties in this object to be equal to those given in the
322 * associative array $info. Only cacheable fields can be set.
324 * If 'mime' is given, it will be split into major_mime/minor_mime.
325 * If major_mime/minor_mime are given, $this->mime will also be set.
327 function setProps( $info ) {
328 $this->dataLoaded
= true;
329 $fields = $this->getCacheFields( '' );
330 $fields[] = 'fileExists';
331 foreach ( $fields as $field ) {
332 if ( isset( $info[$field] ) ) {
333 $this->$field = $info[$field];
336 // Fix up mime fields
337 if ( isset( $info['major_mime'] ) ) {
338 $this->mime
= "{$info['major_mime']}/{$info['minor_mime']}";
339 } elseif ( isset( $info['mime'] ) ) {
340 list( $this->major_mime
, $this->minor_mime
) = self
::splitMime( $this->mime
);
344 /** splitMime inherited */
345 /** getName inherited */
346 /** getTitle inherited */
347 /** getURL inherited */
348 /** getViewURL inherited */
349 /** getPath inherited */
350 /** isVisible inhereted */
353 * Return the width of the image
355 * Returns false on error
358 function getWidth( $page = 1 ) {
360 if ( $this->isMultipage() ) {
361 $dim = $this->getHandler()->getPageDimensions( $this, $page );
363 return $dim['width'];
373 * Return the height of the image
375 * Returns false on error
378 function getHeight( $page = 1 ) {
380 if ( $this->isMultipage() ) {
381 $dim = $this->getHandler()->getPageDimensions( $this, $page );
383 return $dim['height'];
388 return $this->height
;
393 * Returns ID or name of user who uploaded the file
395 * @param $type string 'text' or 'id'
397 function getUser($type='text') {
399 if( $type == 'text' ) {
400 return $this->user_text
;
401 } elseif( $type == 'id' ) {
407 * Get handler-specific metadata
409 function getMetadata() {
411 return $this->metadata
;
415 * Return the size of the image file, in bytes
424 * Returns the mime type of the file.
426 function getMimeType() {
432 * Return the type of the media in the file.
433 * Use the value returned by this function with the MEDIATYPE_xxx constants.
435 function getMediaType() {
437 return $this->media_type
;
440 /** canRender inherited */
441 /** mustRender inherited */
442 /** allowInlineDisplay inherited */
443 /** isSafeFile inherited */
444 /** isTrustedFile inherited */
447 * Returns true if the file file exists on disk.
448 * @return boolean Whether file file exist on disk.
453 return $this->fileExists
;
456 /** getTransformScript inherited */
457 /** getUnscaledThumb inherited */
458 /** thumbName inherited */
459 /** createThumb inherited */
460 /** getThumbnail inherited */
461 /** transform inherited */
464 * Fix thumbnail files from 1.4 or before, with extreme prejudice
466 function migrateThumbFile( $thumbName ) {
467 $thumbDir = $this->getThumbPath();
468 $thumbPath = "$thumbDir/$thumbName";
469 if ( is_dir( $thumbPath ) ) {
470 // Directory where file should be
471 // This happened occasionally due to broken migration code in 1.5
472 // Rename to broken-*
473 for ( $i = 0; $i < 100 ; $i++
) {
474 $broken = $this->repo
->getZonePath('public') . "/broken-$i-$thumbName";
475 if ( !file_exists( $broken ) ) {
476 rename( $thumbPath, $broken );
480 // Doesn't exist anymore
483 if ( is_file( $thumbDir ) ) {
484 // File where directory should be
486 // Doesn't exist anymore
491 /** getHandler inherited */
492 /** iconThumb inherited */
493 /** getLastError inherited */
496 * Get all thumbnail names previously generated for this file
498 function getThumbnails() {
499 if ( $this->isHashed() ) {
502 $dir = $this->getThumbPath();
504 if ( is_dir( $dir ) ) {
505 $handle = opendir( $dir );
508 while ( false !== ( $file = readdir($handle) ) ) {
509 if ( $file{0} != '.' ) {
524 * Refresh metadata in memcached, but don't touch thumbnails or squid
526 function purgeMetadataCache() {
528 $this->saveToCache();
529 $this->purgeHistory();
533 * Purge the shared history (OldLocalFile) cache
535 function purgeHistory() {
537 $hashedName = md5($this->getName());
538 $oldKey = wfMemcKey( 'oldfile', $hashedName );
539 $wgMemc->delete( $oldKey );
543 * Delete all previously generated thumbnails, refresh metadata in memcached and purge the squid
545 function purgeCache() {
546 // Refresh metadata cache
547 $this->purgeMetadataCache();
550 $this->purgeThumbnails();
552 // Purge squid cache for this file
553 SquidUpdate
::purge( array( $this->getURL() ) );
557 * Delete cached transformed files
559 function purgeThumbnails() {
562 $files = $this->getThumbnails();
563 $dir = $this->getThumbPath();
565 foreach ( $files as $file ) {
566 # Check that the base file name is part of the thumb name
567 # This is a basic sanity check to avoid erasing unrelated directories
568 if ( strpos( $file, $this->getName() ) !== false ) {
569 $url = $this->getThumbUrl( $file );
571 @unlink
( "$dir/$file" );
577 SquidUpdate
::purge( $urls );
581 /** purgeDescription inherited */
582 /** purgeEverything inherited */
584 function getHistory($limit = null, $start = null, $end = null) {
585 $dbr = $this->repo
->getSlaveDB();
586 $conds = $opts = array();
587 $conds[] = "oi_name = " . $dbr->addQuotes( $this->title
->getDBKey() );
588 if( $start !== null ) {
589 $conds[] = "oi_timestamp <= " . $dbr->addQuotes( $dbr->timestamp( $start ) );
591 if( $end !== null ) {
592 $conds[] = "oi_timestamp >= " . $dbr->addQuotes( $dbr->timestamp( $end ) );
595 $opts['LIMIT'] = $limit;
597 $opts['ORDER BY'] = 'oi_timestamp DESC';
598 $res = $dbr->select('oldimage', '*', $conds, __METHOD__
, $opts);
600 while( $row = $dbr->fetchObject($res) ) {
601 $r[] = OldLocalFile
::newFromRow($row, $this->repo
);
607 * Return the history of this file, line by line.
608 * starts with current version, then old versions.
609 * uses $this->historyLine to check which line to return:
610 * 0 return line for current version
611 * 1 query for old versions, return first one
612 * 2, ... return next old version from above query
616 function nextHistoryLine() {
617 # Polymorphic function name to distinguish foreign and local fetches
618 $fname = get_class( $this ) . '::' . __FUNCTION__
;
620 $dbr = $this->repo
->getSlaveDB();
622 if ( $this->historyLine
== 0 ) {// called for the first time, return line from cur
623 $this->historyRes
= $dbr->select( 'image',
626 "'' AS oi_archive_name",
630 array( 'img_name' => $this->title
->getDBkey() ),
633 if ( 0 == $dbr->numRows( $this->historyRes
) ) {
634 $dbr->freeResult($this->historyRes
);
635 $this->historyRes
= null;
638 } else if ( $this->historyLine
== 1 ) {
639 $dbr->freeResult($this->historyRes
);
640 $this->historyRes
= $dbr->select( 'oldimage', '*',
641 array( 'oi_name' => $this->title
->getDBkey() ),
643 array( 'ORDER BY' => 'oi_timestamp DESC' )
646 $this->historyLine ++
;
648 return $dbr->fetchObject( $this->historyRes
);
652 * Reset the history pointer to the first element of the history
655 function resetHistory() {
656 $this->historyLine
= 0;
657 if (!is_null($this->historyRes
)) {
658 $this->repo
->getSlaveDB()->freeResult($this->historyRes
);
659 $this->historyRes
= null;
663 /** getFullPath inherited */
664 /** getHashPath inherited */
665 /** getRel inherited */
666 /** getUrlRel inherited */
667 /** getArchiveRel inherited */
668 /** getThumbRel inherited */
669 /** getArchivePath inherited */
670 /** getThumbPath inherited */
671 /** getArchiveUrl inherited */
672 /** getThumbUrl inherited */
673 /** getArchiveVirtualUrl inherited */
674 /** getThumbVirtualUrl inherited */
675 /** isHashed inherited */
678 * Upload a file and record it in the DB
679 * @param string $srcPath Source path or virtual URL
680 * @param string $comment Upload description
681 * @param string $pageText Text to use for the new description page, if a new description page is created
682 * @param integer $flags Flags for publish()
683 * @param array $props File properties, if known. This can be used to reduce the
684 * upload time when uploading virtual URLs for which the file info
686 * @param string $timestamp Timestamp for img_timestamp, or false to use the current time
688 * @return FileRepoStatus object. On success, the value member contains the
689 * archive name, or an empty string if it was a new file.
691 function upload( $srcPath, $comment, $pageText, $flags = 0, $props = false, $timestamp = false ) {
693 $status = $this->publish( $srcPath, $flags );
695 if ( !$this->recordUpload2( $status->value
, $comment, $pageText, $props, $timestamp ) ) {
696 $status->fatal( 'filenotfound', $srcPath );
704 * Record a file upload in the upload log and the image table
705 * @deprecated use upload()
707 function recordUpload( $oldver, $desc, $license = '', $copyStatus = '', $source = '',
708 $watch = false, $timestamp = false )
710 $pageText = UploadForm
::getInitialPageText( $desc, $license, $copyStatus, $source );
711 if ( !$this->recordUpload2( $oldver, $desc, $pageText ) ) {
716 $wgUser->addWatch( $this->getTitle() );
723 * Record a file upload in the upload log and the image table
725 function recordUpload2( $oldver, $comment, $pageText, $props = false, $timestamp = false )
729 $dbw = $this->repo
->getMasterDB();
732 $props = $this->repo
->getFileProps( $this->getVirtualUrl() );
734 $props['description'] = $comment;
735 $props['user'] = $wgUser->getID();
736 $props['user_text'] = $wgUser->getName();
737 $props['timestamp'] = wfTimestamp( TS_MW
);
738 $this->setProps( $props );
740 // Delete thumbnails and refresh the metadata cache
741 $this->purgeThumbnails();
742 $this->saveToCache();
743 SquidUpdate
::purge( array( $this->getURL() ) );
745 // Fail now if the file isn't there
746 if ( !$this->fileExists
) {
747 wfDebug( __METHOD__
.": File ".$this->getPath()." went missing!\n" );
752 if ( $timestamp === false ) {
753 $timestamp = $dbw->timestamp();
756 # Test to see if the row exists using INSERT IGNORE
757 # This avoids race conditions by locking the row until the commit, and also
758 # doesn't deadlock. SELECT FOR UPDATE causes a deadlock for every race condition.
759 $dbw->insert( 'image',
761 'img_name' => $this->getName(),
762 'img_size'=> $this->size
,
763 'img_width' => intval( $this->width
),
764 'img_height' => intval( $this->height
),
765 'img_bits' => $this->bits
,
766 'img_media_type' => $this->media_type
,
767 'img_major_mime' => $this->major_mime
,
768 'img_minor_mime' => $this->minor_mime
,
769 'img_timestamp' => $timestamp,
770 'img_description' => $comment,
771 'img_user' => $wgUser->getID(),
772 'img_user_text' => $wgUser->getName(),
773 'img_metadata' => $this->metadata
,
774 'img_sha1' => $this->sha1
780 if( $dbw->affectedRows() == 0 ) {
783 # Collision, this is an update of a file
784 # Insert previous contents into oldimage
785 $dbw->insertSelect( 'oldimage', 'image',
787 'oi_name' => 'img_name',
788 'oi_archive_name' => $dbw->addQuotes( $oldver ),
789 'oi_size' => 'img_size',
790 'oi_width' => 'img_width',
791 'oi_height' => 'img_height',
792 'oi_bits' => 'img_bits',
793 'oi_timestamp' => 'img_timestamp',
794 'oi_description' => 'img_description',
795 'oi_user' => 'img_user',
796 'oi_user_text' => 'img_user_text',
797 'oi_metadata' => 'img_metadata',
798 'oi_media_type' => 'img_media_type',
799 'oi_major_mime' => 'img_major_mime',
800 'oi_minor_mime' => 'img_minor_mime',
801 'oi_sha1' => 'img_sha1'
802 ), array( 'img_name' => $this->getName() ), __METHOD__
805 # Update the current image row
806 $dbw->update( 'image',
808 'img_size' => $this->size
,
809 'img_width' => intval( $this->width
),
810 'img_height' => intval( $this->height
),
811 'img_bits' => $this->bits
,
812 'img_media_type' => $this->media_type
,
813 'img_major_mime' => $this->major_mime
,
814 'img_minor_mime' => $this->minor_mime
,
815 'img_timestamp' => $timestamp,
816 'img_description' => $comment,
817 'img_user' => $wgUser->getID(),
818 'img_user_text' => $wgUser->getName(),
819 'img_metadata' => $this->metadata
,
820 'img_sha1' => $this->sha1
821 ), array( /* WHERE */
822 'img_name' => $this->getName()
827 # Update the image count
828 $site_stats = $dbw->tableName( 'site_stats' );
829 $dbw->query( "UPDATE $site_stats SET ss_images=ss_images+1", __METHOD__
);
832 $descTitle = $this->getTitle();
833 $article = new Article( $descTitle );
836 $log = new LogPage( 'upload' );
837 $action = $reupload ?
'overwrite' : 'upload';
838 $log->addEntry( $action, $descTitle, $comment );
840 if( $descTitle->exists() ) {
841 # Create a null revision
842 $nullRevision = Revision
::newNullRevision( $dbw, $descTitle->getArticleId(), $log->getRcComment(), false );
843 $nullRevision->insertOn( $dbw );
844 $article->updateRevisionOn( $dbw, $nullRevision );
846 # Invalidate the cache for the description page
847 $descTitle->invalidateCache();
848 $descTitle->purgeSquid();
850 // New file; create the description page.
851 // There's already a log entry, so don't make a second RC entry
852 $article->doEdit( $pageText, $comment, EDIT_NEW | EDIT_SUPPRESS_RC
);
855 # Hooks, hooks, the magic of hooks...
856 wfRunHooks( 'FileUpload', array( $this ) );
858 # Commit the transaction now, in case something goes wrong later
859 # The most important thing is that files don't get lost, especially archives
860 $dbw->immediateCommit();
862 # Invalidate cache for all pages using this file
863 $update = new HTMLCacheUpdate( $this->getTitle(), 'imagelinks' );
865 # Invalidate cache for all pages that redirects on this page
866 $redirs = $this->getTitle()->getRedirectsHere();
867 foreach( $redirs as $redir ) {
868 $update = new HTMLCacheUpdate( $redir, 'imagelinks' );
876 * Move or copy a file to its public location. If a file exists at the
877 * destination, move it to an archive. Returns the archive name on success
878 * or an empty string if it was a new file, and a wikitext-formatted
879 * WikiError object on failure.
881 * The archive name should be passed through to recordUpload for database
884 * @param string $sourcePath Local filesystem path to the source image
885 * @param integer $flags A bitwise combination of:
886 * File::DELETE_SOURCE Delete the source file, i.e. move
888 * @return FileRepoStatus object. On success, the value member contains the
889 * archive name, or an empty string if it was a new file.
891 function publish( $srcPath, $flags = 0 ) {
893 $dstRel = $this->getRel();
894 $archiveName = gmdate( 'YmdHis' ) . '!'. $this->getName();
895 $archiveRel = 'archive/' . $this->getHashPath() . $archiveName;
896 $flags = $flags & File
::DELETE_SOURCE ? LocalRepo
::DELETE_SOURCE
: 0;
897 $status = $this->repo
->publish( $srcPath, $dstRel, $archiveRel, $flags );
898 if ( $status->value
== 'new' ) {
901 $status->value
= $archiveName;
907 /** getLinksTo inherited */
908 /** getExifData inherited */
909 /** isLocal inherited */
910 /** wasDeleted inherited */
913 * Delete all versions of the file.
915 * Moves the files into an archive directory (or deletes them)
916 * and removes the database rows.
918 * Cache purging is done; logging is caller's responsibility.
922 * @return FileRepoStatus object.
924 function delete( $reason, $suppress = false ) {
926 $batch = new LocalFileDeleteBatch( $this, $reason, $suppress );
927 $batch->addCurrent();
929 # Get old version relative paths
930 $dbw = $this->repo
->getMasterDB();
931 $result = $dbw->select( 'oldimage',
932 array( 'oi_archive_name' ),
933 array( 'oi_name' => $this->getName() ) );
934 while ( $row = $dbw->fetchObject( $result ) ) {
935 $batch->addOld( $row->oi_archive_name
);
937 $status = $batch->execute();
941 $site_stats = $dbw->tableName( 'site_stats' );
942 $dbw->query( "UPDATE $site_stats SET ss_images=ss_images-1", __METHOD__
);
943 $this->purgeEverything();
951 * Delete an old version of the file.
953 * Moves the file into an archive directory (or deletes it)
954 * and removes the database row.
956 * Cache purging is done; logging is caller's responsibility.
960 * @throws MWException or FSException on database or filestore failure
961 * @return FileRepoStatus object.
963 function deleteOld( $archiveName, $reason, $suppress=false ) {
965 $batch = new LocalFileDeleteBatch( $this, $reason, $suppress );
966 $batch->addOld( $archiveName );
967 $status = $batch->execute();
970 $this->purgeDescription();
971 $this->purgeHistory();
977 * Restore all or specified deleted revisions to the given file.
978 * Permissions and logging are left to the caller.
980 * May throw database exceptions on error.
982 * @param $versions set of record ids of deleted items to restore,
983 * or empty to restore all revisions.
985 * @return FileRepoStatus
987 function restore( $versions = array(), $unsuppress = false ) {
988 $batch = new LocalFileRestoreBatch( $this, $unsuppress );
992 $batch->addIds( $versions );
994 $status = $batch->execute();
995 if ( !$status->ok
) {
999 $cleanupStatus = $batch->cleanup();
1000 $cleanupStatus->successCount
= 0;
1001 $cleanupStatus->failCount
= 0;
1002 $status->merge( $cleanupStatus );
1006 /** isMultipage inherited */
1007 /** pageCount inherited */
1008 /** scaleHeight inherited */
1009 /** getImageSize inherited */
1012 * Get the URL of the file description page.
1014 function getDescriptionUrl() {
1015 return $this->title
->getLocalUrl();
1019 * Get the HTML text of the description page
1020 * This is not used by ImagePage for local files, since (among other things)
1021 * it skips the parser cache.
1023 function getDescriptionText() {
1025 $revision = Revision
::newFromTitle( $this->title
);
1026 if ( !$revision ) return false;
1027 $text = $revision->getText();
1028 if ( !$text ) return false;
1029 $html = $wgParser->parse( $text, new ParserOptions
);
1033 function getDescription() {
1035 return $this->description
;
1038 function getTimestamp() {
1040 return $this->timestamp
;
1043 function getSha1() {
1045 // Initialise now if necessary
1046 if ( $this->sha1
== '' && $this->fileExists
) {
1047 $this->sha1
= File
::sha1Base36( $this->getPath() );
1048 if ( strval( $this->sha1
) != '' ) {
1049 $dbw = $this->repo
->getMasterDB();
1050 $dbw->update( 'image',
1051 array( 'img_sha1' => $this->sha1
),
1052 array( 'img_name' => $this->getName() ),
1054 $this->saveToCache();
1062 * Start a transaction and lock the image for update
1063 * Increments a reference counter if the lock is already held
1064 * @return boolean True if the image exists, false otherwise
1067 $dbw = $this->repo
->getMasterDB();
1068 if ( !$this->locked
) {
1072 return $dbw->selectField( 'image', '1', array( 'img_name' => $this->getName() ), __METHOD__
);
1076 * Decrement the lock reference count. If the reference count is reduced to zero, commits
1077 * the transaction and thereby releases the image lock.
1080 if ( $this->locked
) {
1082 if ( !$this->locked
) {
1083 $dbw = $this->repo
->getMasterDB();
1090 * Roll back the DB transaction and mark the image unlocked
1092 function unlockAndRollback() {
1093 $this->locked
= false;
1094 $dbw = $this->repo
->getMasterDB();
1097 } // LocalFile class
1099 #------------------------------------------------------------------------------
1102 * Helper class for file deletion
1104 class LocalFileDeleteBatch
{
1105 var $file, $reason, $srcRels = array(), $archiveUrls = array(), $deletionBatch, $suppress;
1108 function __construct( File
$file, $reason = '', $suppress = false ) {
1109 $this->file
= $file;
1110 $this->reason
= $reason;
1111 $this->suppress
= $suppress;
1112 $this->status
= $file->repo
->newGood();
1115 function addCurrent() {
1116 $this->srcRels
['.'] = $this->file
->getRel();
1119 function addOld( $oldName ) {
1120 $this->srcRels
[$oldName] = $this->file
->getArchiveRel( $oldName );
1121 $this->archiveUrls
[] = $this->file
->getArchiveUrl( $oldName );
1124 function getOldRels() {
1125 if ( !isset( $this->srcRels
['.'] ) ) {
1126 $oldRels =& $this->srcRels
;
1127 $deleteCurrent = false;
1129 $oldRels = $this->srcRels
;
1130 unset( $oldRels['.'] );
1131 $deleteCurrent = true;
1133 return array( $oldRels, $deleteCurrent );
1136 /*protected*/ function getHashes() {
1138 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
1139 if ( $deleteCurrent ) {
1140 $hashes['.'] = $this->file
->getSha1();
1142 if ( count( $oldRels ) ) {
1143 $dbw = $this->file
->repo
->getMasterDB();
1144 $res = $dbw->select( 'oldimage', array( 'oi_archive_name', 'oi_sha1' ),
1145 'oi_archive_name IN(' . $dbw->makeList( array_keys( $oldRels ) ) . ')',
1147 while ( $row = $dbw->fetchObject( $res ) ) {
1148 if ( rtrim( $row->oi_sha1
, "\0" ) === '' ) {
1149 // Get the hash from the file
1150 $oldUrl = $this->file
->getArchiveVirtualUrl( $row->oi_archive_name
);
1151 $props = $this->file
->repo
->getFileProps( $oldUrl );
1152 if ( $props['fileExists'] ) {
1153 // Upgrade the oldimage row
1154 $dbw->update( 'oldimage',
1155 array( 'oi_sha1' => $props['sha1'] ),
1156 array( 'oi_name' => $this->file
->getName(), 'oi_archive_name' => $row->oi_archive_name
),
1158 $hashes[$row->oi_archive_name
] = $props['sha1'];
1160 $hashes[$row->oi_archive_name
] = false;
1163 $hashes[$row->oi_archive_name
] = $row->oi_sha1
;
1167 $missing = array_diff_key( $this->srcRels
, $hashes );
1168 foreach ( $missing as $name => $rel ) {
1169 $this->status
->error( 'filedelete-old-unregistered', $name );
1171 foreach ( $hashes as $name => $hash ) {
1173 $this->status
->error( 'filedelete-missing', $this->srcRels
[$name] );
1174 unset( $hashes[$name] );
1181 function doDBInserts() {
1183 $dbw = $this->file
->repo
->getMasterDB();
1184 $encTimestamp = $dbw->addQuotes( $dbw->timestamp() );
1185 $encUserId = $dbw->addQuotes( $wgUser->getId() );
1186 $encReason = $dbw->addQuotes( $this->reason
);
1187 $encGroup = $dbw->addQuotes( 'deleted' );
1188 $ext = $this->file
->getExtension();
1189 $dotExt = $ext === '' ?
'' : ".$ext";
1190 $encExt = $dbw->addQuotes( $dotExt );
1191 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
1193 // Bitfields to further suppress the content
1194 if ( $this->suppress
) {
1196 // This should be 15...
1197 $bitfield |
= Revision
::DELETED_TEXT
;
1198 $bitfield |
= Revision
::DELETED_COMMENT
;
1199 $bitfield |
= Revision
::DELETED_USER
;
1200 $bitfield |
= Revision
::DELETED_RESTRICTED
;
1202 $bitfield = 'oi_deleted';
1205 if ( $deleteCurrent ) {
1206 $concat = $dbw->buildConcat( array( "img_sha1", $encExt ) );
1207 $where = array( 'img_name' => $this->file
->getName() );
1208 $dbw->insertSelect( 'filearchive', 'image',
1210 'fa_storage_group' => $encGroup,
1211 'fa_storage_key' => "CASE WHEN img_sha1='' THEN '' ELSE $concat END",
1212 'fa_deleted_user' => $encUserId,
1213 'fa_deleted_timestamp' => $encTimestamp,
1214 'fa_deleted_reason' => $encReason,
1215 'fa_deleted' => $this->suppress ?
$bitfield : 0,
1217 'fa_name' => 'img_name',
1218 'fa_archive_name' => 'NULL',
1219 'fa_size' => 'img_size',
1220 'fa_width' => 'img_width',
1221 'fa_height' => 'img_height',
1222 'fa_metadata' => 'img_metadata',
1223 'fa_bits' => 'img_bits',
1224 'fa_media_type' => 'img_media_type',
1225 'fa_major_mime' => 'img_major_mime',
1226 'fa_minor_mime' => 'img_minor_mime',
1227 'fa_description' => 'img_description',
1228 'fa_user' => 'img_user',
1229 'fa_user_text' => 'img_user_text',
1230 'fa_timestamp' => 'img_timestamp'
1231 ), $where, __METHOD__
);
1234 if ( count( $oldRels ) ) {
1235 $concat = $dbw->buildConcat( array( "oi_sha1", $encExt ) );
1237 'oi_name' => $this->file
->getName(),
1238 'oi_archive_name IN (' . $dbw->makeList( array_keys( $oldRels ) ) . ')' );
1239 $dbw->insertSelect( 'filearchive', 'oldimage',
1241 'fa_storage_group' => $encGroup,
1242 'fa_storage_key' => "CASE WHEN oi_sha1='' THEN '' ELSE $concat END",
1243 'fa_deleted_user' => $encUserId,
1244 'fa_deleted_timestamp' => $encTimestamp,
1245 'fa_deleted_reason' => $encReason,
1246 'fa_deleted' => $this->suppress ?
$bitfield : 'oi_deleted',
1248 'fa_name' => 'oi_name',
1249 'fa_archive_name' => 'oi_archive_name',
1250 'fa_size' => 'oi_size',
1251 'fa_width' => 'oi_width',
1252 'fa_height' => 'oi_height',
1253 'fa_metadata' => 'oi_metadata',
1254 'fa_bits' => 'oi_bits',
1255 'fa_media_type' => 'oi_media_type',
1256 'fa_major_mime' => 'oi_major_mime',
1257 'fa_minor_mime' => 'oi_minor_mime',
1258 'fa_description' => 'oi_description',
1259 'fa_user' => 'oi_user',
1260 'fa_user_text' => 'oi_user_text',
1261 'fa_timestamp' => 'oi_timestamp',
1262 'fa_deleted' => $bitfield
1263 ), $where, __METHOD__
);
1267 function doDBDeletes() {
1268 $dbw = $this->file
->repo
->getMasterDB();
1269 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
1270 if ( count( $oldRels ) ) {
1271 $dbw->delete( 'oldimage',
1273 'oi_name' => $this->file
->getName(),
1274 'oi_archive_name IN (' . $dbw->makeList( array_keys( $oldRels ) ) . ')'
1277 if ( $deleteCurrent ) {
1278 $dbw->delete( 'image', array( 'img_name' => $this->file
->getName() ), __METHOD__
);
1283 * Run the transaction
1285 function execute() {
1286 global $wgUser, $wgUseSquid;
1287 wfProfileIn( __METHOD__
);
1289 $this->file
->lock();
1290 // Leave private files alone
1291 $privateFiles = array();
1292 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
1293 $dbw = $this->file
->repo
->getMasterDB();
1294 if( !empty( $oldRels ) ) {
1295 $res = $dbw->select( 'oldimage',
1296 array( 'oi_archive_name' ),
1297 array( 'oi_name' => $this->file
->getName(),
1298 'oi_archive_name IN (' . $dbw->makeList( array_keys($oldRels) ) . ')',
1299 'oi_deleted & ' . File
::DELETED_FILE
=> File
::DELETED_FILE
),
1301 while( $row = $dbw->fetchObject( $res ) ) {
1302 $privateFiles[$row->oi_archive_name
] = 1;
1305 // Prepare deletion batch
1306 $hashes = $this->getHashes();
1307 $this->deletionBatch
= array();
1308 $ext = $this->file
->getExtension();
1309 $dotExt = $ext === '' ?
'' : ".$ext";
1310 foreach ( $this->srcRels
as $name => $srcRel ) {
1311 // Skip files that have no hash (missing source).
1312 // Keep private files where they are.
1313 if ( isset($hashes[$name]) && !array_key_exists($name,$privateFiles) ) {
1314 $hash = $hashes[$name];
1315 $key = $hash . $dotExt;
1316 $dstRel = $this->file
->repo
->getDeletedHashPath( $key ) . $key;
1317 $this->deletionBatch
[$name] = array( $srcRel, $dstRel );
1321 // Lock the filearchive rows so that the files don't get deleted by a cleanup operation
1322 // We acquire this lock by running the inserts now, before the file operations.
1324 // This potentially has poor lock contention characteristics -- an alternative
1325 // scheme would be to insert stub filearchive entries with no fa_name and commit
1326 // them in a separate transaction, then run the file ops, then update the fa_name fields.
1327 $this->doDBInserts();
1329 // Execute the file deletion batch
1330 $status = $this->file
->repo
->deleteBatch( $this->deletionBatch
);
1331 if ( !$status->isGood() ) {
1332 $this->status
->merge( $status );
1335 if ( !$this->status
->ok
) {
1336 // Critical file deletion error
1337 // Roll back inserts, release lock and abort
1338 // TODO: delete the defunct filearchive rows if we are using a non-transactional DB
1339 $this->file
->unlockAndRollback();
1340 return $this->status
;
1344 if ( $wgUseSquid ) {
1346 foreach ( $this->srcRels
as $srcRel ) {
1347 $urlRel = str_replace( '%2F', '/', rawurlencode( $srcRel ) );
1348 $urls[] = $this->file
->repo
->getZoneUrl( 'public' ) . '/' . $urlRel;
1350 SquidUpdate
::purge( $urls );
1353 // Delete image/oldimage rows
1354 $this->doDBDeletes();
1356 // Commit and return
1357 $this->file
->unlock();
1358 wfProfileOut( __METHOD__
);
1359 return $this->status
;
1363 #------------------------------------------------------------------------------
1366 * Helper class for file undeletion
1368 class LocalFileRestoreBatch
{
1369 var $file, $cleanupBatch, $ids, $all, $unsuppress = false;
1371 function __construct( File
$file, $unsuppress = false ) {
1372 $this->file
= $file;
1373 $this->cleanupBatch
= $this->ids
= array();
1374 $this->ids
= array();
1375 $this->unsuppress
= $unsuppress;
1381 function addId( $fa_id ) {
1382 $this->ids
[] = $fa_id;
1386 * Add a whole lot of files by ID
1388 function addIds( $ids ) {
1389 $this->ids
= array_merge( $this->ids
, $ids );
1393 * Add all revisions of the file
1400 * Run the transaction, except the cleanup batch.
1401 * The cleanup batch should be run in a separate transaction, because it locks different
1402 * rows and there's no need to keep the image row locked while it's acquiring those locks
1403 * The caller may have its own transaction open.
1404 * So we save the batch and let the caller call cleanup()
1406 function execute() {
1407 global $wgUser, $wgLang;
1408 if ( !$this->all
&& !$this->ids
) {
1410 return $this->file
->repo
->newGood();
1413 $exists = $this->file
->lock();
1414 $dbw = $this->file
->repo
->getMasterDB();
1415 $status = $this->file
->repo
->newGood();
1417 // Fetch all or selected archived revisions for the file,
1418 // sorted from the most recent to the oldest.
1419 $conditions = array( 'fa_name' => $this->file
->getName() );
1421 $conditions[] = 'fa_id IN (' . $dbw->makeList( $this->ids
) . ')';
1424 $result = $dbw->select( 'filearchive', '*',
1427 array( 'ORDER BY' => 'fa_timestamp DESC' ) );
1429 $idsPresent = array();
1430 $storeBatch = array();
1431 $insertBatch = array();
1432 $insertCurrent = false;
1433 $deleteIds = array();
1435 $archiveNames = array();
1436 while( $row = $dbw->fetchObject( $result ) ) {
1437 $idsPresent[] = $row->fa_id
;
1439 if ( $row->fa_name
!= $this->file
->getName() ) {
1440 $status->error( 'undelete-filename-mismatch', $wgLang->timeanddate( $row->fa_timestamp
) );
1441 $status->failCount++
;
1444 if ( $row->fa_storage_key
== '' ) {
1445 // Revision was missing pre-deletion
1446 $status->error( 'undelete-bad-store-key', $wgLang->timeanddate( $row->fa_timestamp
) );
1447 $status->failCount++
;
1451 $deletedRel = $this->file
->repo
->getDeletedHashPath( $row->fa_storage_key
) . $row->fa_storage_key
;
1452 $deletedUrl = $this->file
->repo
->getVirtualUrl() . '/deleted/' . $deletedRel;
1454 $sha1 = substr( $row->fa_storage_key
, 0, strcspn( $row->fa_storage_key
, '.' ) );
1456 if ( strlen( $sha1 ) == 32 && $sha1[0] == '0' ) {
1457 $sha1 = substr( $sha1, 1 );
1460 if( is_null( $row->fa_major_mime
) ||
$row->fa_major_mime
== 'unknown'
1461 ||
is_null( $row->fa_minor_mime
) ||
$row->fa_minor_mime
== 'unknown'
1462 ||
is_null( $row->fa_media_type
) ||
$row->fa_media_type
== 'UNKNOWN'
1463 ||
is_null( $row->fa_metadata
) ) {
1464 // Refresh our metadata
1465 // Required for a new current revision; nice for older ones too. :)
1466 $props = RepoGroup
::singleton()->getFileProps( $deletedUrl );
1469 'minor_mime' => $row->fa_minor_mime
,
1470 'major_mime' => $row->fa_major_mime
,
1471 'media_type' => $row->fa_media_type
,
1472 'metadata' => $row->fa_metadata
);
1475 if ( $first && !$exists ) {
1476 // The live (current) version cannot be hidden!
1477 if( !$this->unsuppress
&& $row->fa_deleted
) {
1478 $this->file
->unlock();
1481 // This revision will be published as the new current version
1482 $destRel = $this->file
->getRel();
1483 $insertCurrent = array(
1484 'img_name' => $row->fa_name
,
1485 'img_size' => $row->fa_size
,
1486 'img_width' => $row->fa_width
,
1487 'img_height' => $row->fa_height
,
1488 'img_metadata' => $props['metadata'],
1489 'img_bits' => $row->fa_bits
,
1490 'img_media_type' => $props['media_type'],
1491 'img_major_mime' => $props['major_mime'],
1492 'img_minor_mime' => $props['minor_mime'],
1493 'img_description' => $row->fa_description
,
1494 'img_user' => $row->fa_user
,
1495 'img_user_text' => $row->fa_user_text
,
1496 'img_timestamp' => $row->fa_timestamp
,
1497 'img_sha1' => $sha1);
1499 $archiveName = $row->fa_archive_name
;
1500 if( $archiveName == '' ) {
1501 // This was originally a current version; we
1502 // have to devise a new archive name for it.
1503 // Format is <timestamp of archiving>!<name>
1504 $timestamp = wfTimestamp( TS_UNIX
, $row->fa_deleted_timestamp
);
1506 $archiveName = wfTimestamp( TS_MW
, $timestamp ) . '!' . $row->fa_name
;
1508 } while ( isset( $archiveNames[$archiveName] ) );
1510 $archiveNames[$archiveName] = true;
1511 $destRel = $this->file
->getArchiveRel( $archiveName );
1512 $insertBatch[] = array(
1513 'oi_name' => $row->fa_name
,
1514 'oi_archive_name' => $archiveName,
1515 'oi_size' => $row->fa_size
,
1516 'oi_width' => $row->fa_width
,
1517 'oi_height' => $row->fa_height
,
1518 'oi_bits' => $row->fa_bits
,
1519 'oi_description' => $row->fa_description
,
1520 'oi_user' => $row->fa_user
,
1521 'oi_user_text' => $row->fa_user_text
,
1522 'oi_timestamp' => $row->fa_timestamp
,
1523 'oi_metadata' => $props['metadata'],
1524 'oi_media_type' => $props['media_type'],
1525 'oi_major_mime' => $props['major_mime'],
1526 'oi_minor_mime' => $props['minor_mime'],
1527 'oi_deleted' => $this->unsuppress ?
0 : $row->fa_deleted
,
1528 'oi_sha1' => $sha1 );
1531 $deleteIds[] = $row->fa_id
;
1532 if( !$this->unsuppress
&& $row->fa_deleted
& File
::DELETED_FILE
) {
1533 // private files can stay where they are
1535 $storeBatch[] = array( $deletedUrl, 'public', $destRel );
1536 $this->cleanupBatch
[] = $row->fa_storage_key
;
1542 // Add a warning to the status object for missing IDs
1543 $missingIds = array_diff( $this->ids
, $idsPresent );
1544 foreach ( $missingIds as $id ) {
1545 $status->error( 'undelete-missing-filearchive', $id );
1548 // Run the store batch
1549 // Use the OVERWRITE_SAME flag to smooth over a common error
1550 $storeStatus = $this->file
->repo
->storeBatch( $storeBatch, FileRepo
::OVERWRITE_SAME
);
1551 $status->merge( $storeStatus );
1553 if ( !$status->ok
) {
1554 // Store batch returned a critical error -- this usually means nothing was stored
1555 // Stop now and return an error
1556 $this->file
->unlock();
1560 // Run the DB updates
1561 // Because we have locked the image row, key conflicts should be rare.
1562 // If they do occur, we can roll back the transaction at this time with
1563 // no data loss, but leaving unregistered files scattered throughout the
1565 // This is not ideal, which is why it's important to lock the image row.
1566 if ( $insertCurrent ) {
1567 $dbw->insert( 'image', $insertCurrent, __METHOD__
);
1569 if ( $insertBatch ) {
1570 $dbw->insert( 'oldimage', $insertBatch, __METHOD__
);
1573 $dbw->delete( 'filearchive',
1574 array( 'fa_id IN (' . $dbw->makeList( $deleteIds ) . ')' ),
1578 if( $status->successCount
> 0 ) {
1580 wfDebug( __METHOD__
." restored {$status->successCount} items, creating a new current\n" );
1582 // Update site_stats
1583 $site_stats = $dbw->tableName( 'site_stats' );
1584 $dbw->query( "UPDATE $site_stats SET ss_images=ss_images+1", __METHOD__
);
1586 $this->file
->purgeEverything();
1588 wfDebug( __METHOD__
." restored {$status->successCount} as archived versions\n" );
1589 $this->file
->purgeDescription();
1590 $this->file
->purgeHistory();
1593 $this->file
->unlock();
1598 * Delete unused files in the deleted zone.
1599 * This should be called from outside the transaction in which execute() was called.
1601 function cleanup() {
1602 if ( !$this->cleanupBatch
) {
1603 return $this->file
->repo
->newGood();
1605 $status = $this->file
->repo
->cleanupDeletedBatch( $this->cleanupBatch
);