includes/filerepo/file/LocalFile.php

   1 <?php
   2 /**
   3  * Local file in the wiki's own database.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  * @ingroup FileAbstraction
  22  */
  23
  24 /**
  25  * Bump this number when serialized cache records may be incompatible.
  26  */
  27 define( 'MW_FILE_VERSION', 8 );
  28
  29 /**
  30  * Class to represent a local file in the wiki's own database
  31  *
  32  * Provides methods to retrieve paths (physical, logical, URL),
  33  * to generate image thumbnails or for uploading.
  34  *
  35  * Note that only the repo object knows what its file class is called. You should
  36  * never name a file class explictly outside of the repo class. Instead use the
  37  * repo's factory functions to generate file objects, for example:
  38  *
  39  * RepoGroup::singleton()->getLocalRepo()->newFile($title);
  40  *
  41  * The convenience functions wfLocalFile() and wfFindFile() should be sufficient
  42  * in most cases.
  43  *
  44  * @ingroup FileAbstraction
  45  */
  46 class LocalFile extends File {
  47         const CACHE_FIELD_MAX_LEN = 1000;
  48
  49         /**#@+
  50          * @private
  51          */
  52         var
  53                 $fileExists,       # does the file exist on disk? (loadFromXxx)
  54                 $historyLine,      # Number of line to return by nextHistoryLine() (constructor)
  55                 $historyRes,       # result of the query for the file's history (nextHistoryLine)
  56                 $width,            # \
  57                 $height,           #  |
  58                 $bits,             #   --- returned by getimagesize (loadFromXxx)
  59                 $attr,             # /
  60                 $media_type,       # MEDIATYPE_xxx (bitmap, drawing, audio...)
  61                 $mime,             # MIME type, determined by MimeMagic::guessMimeType
  62                 $major_mime,       # Major mime type
  63                 $minor_mime,       # Minor mime type
  64                 $size,             # Size in bytes (loadFromXxx)
  65                 $metadata,         # Handler-specific metadata
  66                 $timestamp,        # Upload timestamp
  67                 $sha1,             # SHA-1 base 36 content hash
  68                 $user, $user_text, # User, who uploaded the file
  69                 $description,      # Description of current revision of the file
  70                 $dataLoaded,       # Whether or not all this has been loaded from the database (loadFromXxx)
  71                 $upgraded,         # Whether the row was upgraded on load
  72                 $locked,           # True if the image row is locked
  73                 $missing,          # True if file is not present in file system. Not to be cached in memcached
  74                 $deleted;          # Bitfield akin to rev_deleted
  75
  76         /**#@-*/
  77
  78         /**
  79          * @var LocalRepo
  80          */
  81         var $repo;
  82
  83         protected $repoClass = 'LocalRepo';
  84
  85         /**
  86          * Create a LocalFile from a title
  87          * Do not call this except from inside a repo class.
  88          *
  89          * Note: $unused param is only here to avoid an E_STRICT
  90          *
  91          * @param $title
  92          * @param $repo
  93          * @param $unused
  94          *
  95          * @return LocalFile
  96          */
  97         static function newFromTitle( $title, $repo, $unused = null ) {
  98                 return new self( $title, $repo );
  99         }
 100
 101         /**
 102          * Create a LocalFile from a title
 103          * Do not call this except from inside a repo class.
 104          *
 105          * @param $row
 106          * @param $repo
 107          *
 108          * @return LocalFile
 109          */
 110         static function newFromRow( $row, $repo ) {
 111                 $title = Title::makeTitle( NS_FILE, $row->img_name );
 112                 $file = new self( $title, $repo );
 113                 $file->loadFromRow( $row );
 114
 115                 return $file;
 116         }
 117
 118         /**
 119          * Create a LocalFile from a SHA-1 key
 120          * Do not call this except from inside a repo class.
 121          *
 122          * @param $sha1 string base-36 SHA-1
 123          * @param $repo LocalRepo
 124          * @param string|bool $timestamp MW_timestamp (optional)
 125          *
 126          * @return bool|LocalFile
 127          */
 128         static function newFromKey( $sha1, $repo, $timestamp = false ) {
 129                 $dbr = $repo->getSlaveDB();
 130
 131                 $conds = array( 'img_sha1' => $sha1 );
 132                 if ( $timestamp ) {
 133                         $conds['img_timestamp'] = $dbr->timestamp( $timestamp );
 134                 }
 135
 136                 $row = $dbr->selectRow( 'image', self::selectFields(), $conds, __METHOD__ );
 137                 if ( $row ) {
 138                         return self::newFromRow( $row, $repo );
 139                 } else {
 140                         return false;
 141                 }
 142         }
 143
 144         /**
 145          * Fields in the image table
 146          * @return array
 147          */
 148         static function selectFields() {
 149                 return array(
 150                         'img_name',
 151                         'img_size',
 152                         'img_width',
 153                         'img_height',
 154                         'img_metadata',
 155                         'img_bits',
 156                         'img_media_type',
 157                         'img_major_mime',
 158                         'img_minor_mime',
 159                         'img_description',
 160                         'img_user',
 161                         'img_user_text',
 162                         'img_timestamp',
 163                         'img_sha1',
 164                 );
 165         }
 166
 167         /**
 168          * Constructor.
 169          * Do not call this except from inside a repo class.
 170          */
 171         function __construct( $title, $repo ) {
 172                 parent::__construct( $title, $repo );
 173
 174                 $this->metadata = '';
 175                 $this->historyLine = 0;
 176                 $this->historyRes = null;
 177                 $this->dataLoaded = false;
 178
 179                 $this->assertRepoDefined();
 180                 $this->assertTitleDefined();
 181         }
 182
 183         /**
 184          * Get the memcached key for the main data for this file, or false if
 185          * there is no access to the shared cache.
 186          * @return bool
 187          */
 188         function getCacheKey() {
 189                 $hashedName = md5( $this->getName() );
 190
 191                 return $this->repo->getSharedCacheKey( 'file', $hashedName );
 192         }
 193
 194         /**
 195          * Try to load file metadata from memcached. Returns true on success.
 196          * @return bool
 197          */
 198         function loadFromCache() {
 199                 global $wgMemc;
 200
 201                 wfProfileIn( __METHOD__ );
 202                 $this->dataLoaded = false;
 203                 $key = $this->getCacheKey();
 204
 205                 if ( !$key ) {
 206                         wfProfileOut( __METHOD__ );
 207                         return false;
 208                 }
 209
 210                 $cachedValues = $wgMemc->get( $key );
 211
 212                 // Check if the key existed and belongs to this version of MediaWiki
 213                 if ( isset( $cachedValues['version'] ) && ( $cachedValues['version'] == MW_FILE_VERSION ) ) {
 214                         wfDebug( "Pulling file metadata from cache key $key\n" );
 215                         $this->fileExists = $cachedValues['fileExists'];
 216                         if ( $this->fileExists ) {
 217                                 $this->setProps( $cachedValues );
 218                         }
 219                         $this->dataLoaded = true;
 220                 }
 221
 222                 if ( $this->dataLoaded ) {
 223                         wfIncrStats( 'image_cache_hit' );
 224                 } else {
 225                         wfIncrStats( 'image_cache_miss' );
 226                 }
 227
 228                 wfProfileOut( __METHOD__ );
 229                 return $this->dataLoaded;
 230         }
 231
 232         /**
 233          * Save the file metadata to memcached
 234          */
 235         function saveToCache() {
 236                 global $wgMemc;
 237
 238                 $this->load();
 239                 $key = $this->getCacheKey();
 240
 241                 if ( !$key ) {
 242                         return;
 243                 }
 244
 245                 $fields = $this->getCacheFields( '' );
 246                 $cache = array( 'version' => MW_FILE_VERSION );
 247                 $cache['fileExists'] = $this->fileExists;
 248
 249                 if ( $this->fileExists ) {
 250                         foreach ( $fields as $field ) {
 251                                 $cache[$field] = $this->$field;
 252                         }
 253                 }
 254
 255                 $wgMemc->set( $key, $cache, 60 * 60 * 24 * 7 ); // A week
 256         }
 257
 258         /**
 259          * Load metadata from the file itself
 260          */
 261         function loadFromFile() {
 262                 $props = $this->repo->getFileProps( $this->getVirtualUrl() );
 263                 $this->setProps( $props );
 264         }
 265
 266         /**
 267          * @param $prefix string
 268          * @return array
 269          */
 270         function getCacheFields( $prefix = 'img_' ) {
 271                 static $fields = array( 'size', 'width', 'height', 'bits', 'media_type',
 272                         'major_mime', 'minor_mime', 'metadata', 'timestamp', 'sha1', 'user', 'user_text', 'description' );
 273                 static $results = array();
 274
 275                 if ( $prefix == '' ) {
 276                         return $fields;
 277                 }
 278
 279                 if ( !isset( $results[$prefix] ) ) {
 280                         $prefixedFields = array();
 281                         foreach ( $fields as $field ) {
 282                                 $prefixedFields[] = $prefix . $field;
 283                         }
 284                         $results[$prefix] = $prefixedFields;
 285                 }
 286
 287                 return $results[$prefix];
 288         }
 289
 290         /**
 291          * Load file metadata from the DB
 292          */
 293         function loadFromDB() {
 294                 # Polymorphic function name to distinguish foreign and local fetches
 295                 $fname = get_class( $this ) . '::' . __FUNCTION__;
 296                 wfProfileIn( $fname );
 297
 298                 # Unconditionally set loaded=true, we don't want the accessors constantly rechecking
 299                 $this->dataLoaded = true;
 300
 301                 $dbr = $this->repo->getMasterDB();
 302
 303                 $row = $dbr->selectRow( 'image', $this->getCacheFields( 'img_' ),
 304                         array( 'img_name' => $this->getName() ), $fname );
 305
 306                 if ( $row ) {
 307                         $this->loadFromRow( $row );
 308                 } else {
 309                         $this->fileExists = false;
 310                 }
 311
 312                 wfProfileOut( $fname );
 313         }
 314
 315         /**
 316          * Decode a row from the database (either object or array) to an array
 317          * with timestamps and MIME types decoded, and the field prefix removed.
 318          * @param $row
 319          * @param $prefix string
 320          * @throws MWException
 321          * @return array
 322          */
 323         function decodeRow( $row, $prefix = 'img_' ) {
 324                 $array = (array)$row;
 325                 $prefixLength = strlen( $prefix );
 326
 327                 // Sanity check prefix once
 328                 if ( substr( key( $array ), 0, $prefixLength ) !== $prefix ) {
 329                         throw new MWException( __METHOD__ .  ': incorrect $prefix parameter' );
 330                 }
 331
 332                 $decoded = array();
 333
 334                 foreach ( $array as $name => $value ) {
 335                         $decoded[substr( $name, $prefixLength )] = $value;
 336                 }
 337
 338                 $decoded['timestamp'] = wfTimestamp( TS_MW, $decoded['timestamp'] );
 339
 340                 if ( empty( $decoded['major_mime'] ) ) {
 341                         $decoded['mime'] = 'unknown/unknown';
 342                 } else {
 343                         if ( !$decoded['minor_mime'] ) {
 344                                 $decoded['minor_mime'] = 'unknown';
 345                         }
 346                         $decoded['mime'] = $decoded['major_mime'] . '/' . $decoded['minor_mime'];
 347                 }
 348
 349                 # Trim zero padding from char/binary field
 350                 $decoded['sha1'] = rtrim( $decoded['sha1'], "\0" );
 351
 352                 return $decoded;
 353         }
 354
 355         /**
 356          * Load file metadata from a DB result row
 357          */
 358         function loadFromRow( $row, $prefix = 'img_' ) {
 359                 $this->dataLoaded = true;
 360                 $array = $this->decodeRow( $row, $prefix );
 361
 362                 foreach ( $array as $name => $value ) {
 363                         $this->$name = $value;
 364                 }
 365
 366                 $this->fileExists = true;
 367                 $this->maybeUpgradeRow();
 368         }
 369
 370         /**
 371          * Load file metadata from cache or DB, unless already loaded
 372          */
 373         function load() {
 374                 if ( !$this->dataLoaded ) {
 375                         if ( !$this->loadFromCache() ) {
 376                                 $this->loadFromDB();
 377                                 $this->saveToCache();
 378                         }
 379                         $this->dataLoaded = true;
 380                 }
 381         }
 382
 383         /**
 384          * Upgrade a row if it needs it
 385          */
 386         function maybeUpgradeRow() {
 387                 global $wgUpdateCompatibleMetadata;
 388                 if ( wfReadOnly() ) {
 389                         return;
 390                 }
 391
 392                 if ( is_null( $this->media_type ) ||
 393                         $this->mime == 'image/svg'
 394                 ) {
 395                         $this->upgradeRow();
 396                         $this->upgraded = true;
 397                 } else {
 398                         $handler = $this->getHandler();
 399                         if ( $handler ) {
 400                                 $validity = $handler->isMetadataValid( $this, $this->metadata );
 401                                 if ( $validity === MediaHandler::METADATA_BAD
 402                                         || ( $validity === MediaHandler::METADATA_COMPATIBLE && $wgUpdateCompatibleMetadata )
 403                                 ) {
 404                                         $this->upgradeRow();
 405                                         $this->upgraded = true;
 406                                 }
 407                         }
 408                 }
 409         }
 410
 411         function getUpgraded() {
 412                 return $this->upgraded;
 413         }
 414
 415         /**
 416          * Fix assorted version-related problems with the image row by reloading it from the file
 417          */
 418         function upgradeRow() {
 419                 wfProfileIn( __METHOD__ );
 420
 421                 $this->lock(); // begin
 422
 423                 $this->loadFromFile();
 424
 425                 # Don't destroy file info of missing files
 426                 if ( !$this->fileExists ) {
 427                         wfDebug( __METHOD__ . ": file does not exist, aborting\n" );
 428                         wfProfileOut( __METHOD__ );
 429                         return;
 430                 }
 431
 432                 $dbw = $this->repo->getMasterDB();
 433                 list( $major, $minor ) = self::splitMime( $this->mime );
 434
 435                 if ( wfReadOnly() ) {
 436                         wfProfileOut( __METHOD__ );
 437                         return;
 438                 }
 439                 wfDebug( __METHOD__ . ': upgrading ' . $this->getName() . " to the current schema\n" );
 440
 441                 $dbw->update( 'image',
 442                         array(
 443                                 'img_size'       => $this->size, // sanity
 444                                 'img_width'      => $this->width,
 445                                 'img_height'     => $this->height,
 446                                 'img_bits'       => $this->bits,
 447                                 'img_media_type' => $this->media_type,
 448                                 'img_major_mime' => $major,
 449                                 'img_minor_mime' => $minor,
 450                                 'img_metadata'   => $this->metadata,
 451                                 'img_sha1'       => $this->sha1,
 452                         ),
 453                         array( 'img_name' => $this->getName() ),
 454                         __METHOD__
 455                 );
 456
 457                 $this->saveToCache();
 458
 459                 $this->unlock(); // done
 460
 461                 wfProfileOut( __METHOD__ );
 462         }
 463
 464         /**
 465          * Set properties in this object to be equal to those given in the
 466          * associative array $info. Only cacheable fields can be set.
 467          *
 468          * If 'mime' is given, it will be split into major_mime/minor_mime.
 469          * If major_mime/minor_mime are given, $this->mime will also be set.
 470          */
 471         function setProps( $info ) {
 472                 $this->dataLoaded = true;
 473                 $fields = $this->getCacheFields( '' );
 474                 $fields[] = 'fileExists';
 475
 476                 foreach ( $fields as $field ) {
 477                         if ( isset( $info[$field] ) ) {
 478                                 $this->$field = $info[$field];
 479                         }
 480                 }
 481
 482                 // Fix up mime fields
 483                 if ( isset( $info['major_mime'] ) ) {
 484                         $this->mime = "{$info['major_mime']}/{$info['minor_mime']}";
 485                 } elseif ( isset( $info['mime'] ) ) {
 486                         $this->mime = $info['mime'];
 487                         list( $this->major_mime, $this->minor_mime ) = self::splitMime( $this->mime );
 488                 }
 489         }
 490
 491         /** splitMime inherited */
 492         /** getName inherited */
 493         /** getTitle inherited */
 494         /** getURL inherited */
 495         /** getViewURL inherited */
 496         /** getPath inherited */
 497         /** isVisible inhereted */
 498
 499         /**
 500          * @return bool
 501          */
 502         function isMissing() {
 503                 if ( $this->missing === null ) {
 504                         list( $fileExists ) = $this->repo->fileExists( $this->getVirtualUrl() );
 505                         $this->missing = !$fileExists;
 506                 }
 507                 return $this->missing;
 508         }
 509
 510         /**
 511          * Return the width of the image
 512          *
 513          * @param $page int
 514          * @return bool|int Returns false on error
 515          */
 516         public function getWidth( $page = 1 ) {
 517                 $this->load();
 518
 519                 if ( $this->isMultipage() ) {
 520                         $dim = $this->getHandler()->getPageDimensions( $this, $page );
 521                         if ( $dim ) {
 522                                 return $dim['width'];
 523                         } else {
 524                                 return false;
 525                         }
 526                 } else {
 527                         return $this->width;
 528                 }
 529         }
 530
 531         /**
 532          * Return the height of the image
 533          *
 534          * @param $page int
 535          * @return bool|int Returns false on error
 536          */
 537         public function getHeight( $page = 1 ) {
 538                 $this->load();
 539
 540                 if ( $this->isMultipage() ) {
 541                         $dim = $this->getHandler()->getPageDimensions( $this, $page );
 542                         if ( $dim ) {
 543                                 return $dim['height'];
 544                         } else {
 545                                 return false;
 546                         }
 547                 } else {
 548                         return $this->height;
 549                 }
 550         }
 551
 552         /**
 553          * Returns ID or name of user who uploaded the file
 554          *
 555          * @param $type string 'text' or 'id'
 556          * @return int|string
 557          */
 558         function getUser( $type = 'text' ) {
 559                 $this->load();
 560
 561                 if ( $type == 'text' ) {
 562                         return $this->user_text;
 563                 } elseif ( $type == 'id' ) {
 564                         return $this->user;
 565                 }
 566         }
 567
 568         /**
 569          * Get handler-specific metadata
 570          * @return string
 571          */
 572         function getMetadata() {
 573                 $this->load();
 574                 return $this->metadata;
 575         }
 576
 577         /**
 578          * @return int
 579          */
 580         function getBitDepth() {
 581                 $this->load();
 582                 return $this->bits;
 583         }
 584
 585         /**
 586          * Return the size of the image file, in bytes
 587          * @return int
 588          */
 589         public function getSize() {
 590                 $this->load();
 591                 return $this->size;
 592         }
 593
 594         /**
 595          * Returns the mime type of the file.
 596          * @return string
 597          */
 598         function getMimeType() {
 599                 $this->load();
 600                 return $this->mime;
 601         }
 602
 603         /**
 604          * Return the type of the media in the file.
 605          * Use the value returned by this function with the MEDIATYPE_xxx constants.
 606          * @return string
 607          */
 608         function getMediaType() {
 609                 $this->load();
 610                 return $this->media_type;
 611         }
 612
 613         /** canRender inherited */
 614         /** mustRender inherited */
 615         /** allowInlineDisplay inherited */
 616         /** isSafeFile inherited */
 617         /** isTrustedFile inherited */
 618
 619         /**
 620          * Returns true if the file exists on disk.
 621          * @return boolean Whether file exist on disk.
 622          */
 623         public function exists() {
 624                 $this->load();
 625                 return $this->fileExists;
 626         }
 627
 628         /** getTransformScript inherited */
 629         /** getUnscaledThumb inherited */
 630         /** thumbName inherited */
 631         /** createThumb inherited */
 632         /** transform inherited */
 633
 634         /**
 635          * Fix thumbnail files from 1.4 or before, with extreme prejudice
 636          * @todo : do we still care about this? Perhaps a maintenance script
 637          *        can be made instead. Enabling this code results in a serious
 638          *        RTT regression for wikis without 404 handling.
 639          */
 640         function migrateThumbFile( $thumbName ) {
 641                 $thumbDir = $this->getThumbPath();
 642
 643                 /* Old code for bug 2532
 644                 $thumbPath = "$thumbDir/$thumbName";
 645                 if ( is_dir( $thumbPath ) ) {
 646                         // Directory where file should be
 647                         // This happened occasionally due to broken migration code in 1.5
 648                         // Rename to broken-*
 649                         for ( $i = 0; $i < 100 ; $i++ ) {
 650                                 $broken = $this->repo->getZonePath( 'public' ) . "/broken-$i-$thumbName";
 651                                 if ( !file_exists( $broken ) ) {
 652                                         rename( $thumbPath, $broken );
 653                                         break;
 654                                 }
 655                         }
 656                         // Doesn't exist anymore
 657                         clearstatcache();
 658                 }
 659                 */
 660
 661                 /*
 662                 if ( $this->repo->fileExists( $thumbDir ) ) {
 663                         // Delete file where directory should be
 664                         $this->repo->cleanupBatch( array( $thumbDir ) );
 665                 }
 666                 */
 667         }
 668
 669         /** getHandler inherited */
 670         /** iconThumb inherited */
 671         /** getLastError inherited */
 672
 673         /**
 674          * Get all thumbnail names previously generated for this file
 675          * @param $archiveName string|bool Name of an archive file, default false
 676          * @return array first element is the base dir, then files in that base dir.
 677          */
 678         function getThumbnails( $archiveName = false ) {
 679                 if ( $archiveName ) {
 680                         $dir = $this->getArchiveThumbPath( $archiveName );
 681                 } else {
 682                         $dir = $this->getThumbPath();
 683                 }
 684
 685                 $backend = $this->repo->getBackend();
 686                 $files = array( $dir );
 687                 $iterator = $backend->getFileList( array( 'dir' => $dir ) );
 688                 foreach ( $iterator as $file ) {
 689                         $files[] = $file;
 690                 }
 691
 692                 return $files;
 693         }
 694
 695         /**
 696          * Refresh metadata in memcached, but don't touch thumbnails or squid
 697          */
 698         function purgeMetadataCache() {
 699                 $this->loadFromDB();
 700                 $this->saveToCache();
 701                 $this->purgeHistory();
 702         }
 703
 704         /**
 705          * Purge the shared history (OldLocalFile) cache
 706          */
 707         function purgeHistory() {
 708                 global $wgMemc;
 709
 710                 $hashedName = md5( $this->getName() );
 711                 $oldKey = $this->repo->getSharedCacheKey( 'oldfile', $hashedName );
 712
 713                 // Must purge thumbnails for old versions too! bug 30192
 714                 foreach( $this->getHistory() as $oldFile ) {
 715                         $oldFile->purgeThumbnails();
 716                 }
 717
 718                 if ( $oldKey ) {
 719                         $wgMemc->delete( $oldKey );
 720                 }
 721         }
 722
 723         /**
 724          * Delete all previously generated thumbnails, refresh metadata in memcached and purge the squid
 725          */
 726         function purgeCache( $options = array() ) {
 727                 // Refresh metadata cache
 728                 $this->purgeMetadataCache();
 729
 730                 // Delete thumbnails
 731                 $this->purgeThumbnails( $options );
 732
 733                 // Purge squid cache for this file
 734                 SquidUpdate::purge( array( $this->getURL() ) );
 735         }
 736
 737         /**
 738          * Delete cached transformed files for an archived version only.
 739          * @param $archiveName string name of the archived file
 740          */
 741         function purgeOldThumbnails( $archiveName ) {
 742                 global $wgUseSquid;
 743                 wfProfileIn( __METHOD__ );
 744
 745                 // Get a list of old thumbnails and URLs
 746                 $files = $this->getThumbnails( $archiveName );
 747                 $dir = array_shift( $files );
 748                 $this->purgeThumbList( $dir, $files );
 749
 750                 // Purge any custom thumbnail caches
 751                 wfRunHooks( 'LocalFilePurgeThumbnails', array( $this, $archiveName ) );
 752
 753                 // Purge the squid
 754                 if ( $wgUseSquid ) {
 755                         $urls = array();
 756                         foreach( $files as $file ) {
 757                                 $urls[] = $this->getArchiveThumbUrl( $archiveName, $file );
 758                         }
 759                         SquidUpdate::purge( $urls );
 760                 }
 761
 762                 wfProfileOut( __METHOD__ );
 763         }
 764
 765         /**
 766          * Delete cached transformed files for the current version only.
 767          */
 768         function purgeThumbnails( $options = array() ) {
 769                 global $wgUseSquid;
 770                 wfProfileIn( __METHOD__ );
 771
 772                 // Delete thumbnails
 773                 $files = $this->getThumbnails();
 774
 775                 // Give media handler a chance to filter the purge list
 776                 if ( !empty( $options['forThumbRefresh'] ) ) {
 777                         $handler = $this->getHandler();
 778                         if ( $handler ) {
 779                                 $handler->filterThumbnailPurgeList( $files, $options );
 780                         }
 781                 }
 782
 783                 $dir = array_shift( $files );
 784                 $this->purgeThumbList( $dir, $files );
 785
 786                 // Purge any custom thumbnail caches
 787                 wfRunHooks( 'LocalFilePurgeThumbnails', array( $this, false ) );
 788
 789                 // Purge the squid
 790                 if ( $wgUseSquid ) {
 791                         $urls = array();
 792                         foreach( $files as $file ) {
 793                                 $urls[] = $this->getThumbUrl( $file );
 794                         }
 795                         SquidUpdate::purge( $urls );
 796                 }
 797
 798                 wfProfileOut( __METHOD__ );
 799         }
 800
 801         /**
 802          * Delete a list of thumbnails visible at urls
 803          * @param $dir string base dir of the files.
 804          * @param $files array of strings: relative filenames (to $dir)
 805          */
 806         protected function purgeThumbList( $dir, $files ) {
 807                 $fileListDebug = strtr(
 808                         var_export( $files, true ),
 809                         array("\n"=>'')
 810                 );
 811                 wfDebug( __METHOD__ . ": $fileListDebug\n" );
 812
 813                 $purgeList = array();
 814                 foreach ( $files as $file ) {
 815                         # Check that the base file name is part of the thumb name
 816                         # This is a basic sanity check to avoid erasing unrelated directories
 817                         if ( strpos( $file, $this->getName() ) !== false ) {
 818                                 $purgeList[] = "{$dir}/{$file}";
 819                         }
 820                 }
 821
 822                 # Delete the thumbnails
 823                 $this->repo->quickPurgeBatch( $purgeList );
 824                 # Clear out the thumbnail directory if empty
 825                 $this->repo->quickCleanDir( $dir );
 826         }
 827
 828         /** purgeDescription inherited */
 829         /** purgeEverything inherited */
 830
 831         /**
 832          * @param $limit null
 833          * @param $start null
 834          * @param $end null
 835          * @param $inc bool
 836          * @return array
 837          */
 838         function getHistory( $limit = null, $start = null, $end = null, $inc = true ) {
 839                 $dbr = $this->repo->getSlaveDB();
 840                 $tables = array( 'oldimage' );
 841                 $fields = OldLocalFile::selectFields();
 842                 $conds = $opts = $join_conds = array();
 843                 $eq = $inc ? '=' : '';
 844                 $conds[] = "oi_name = " . $dbr->addQuotes( $this->title->getDBkey() );
 845
 846                 if ( $start ) {
 847                         $conds[] = "oi_timestamp <$eq " . $dbr->addQuotes( $dbr->timestamp( $start ) );
 848                 }
 849
 850                 if ( $end ) {
 851                         $conds[] = "oi_timestamp >$eq " . $dbr->addQuotes( $dbr->timestamp( $end ) );
 852                 }
 853
 854                 if ( $limit ) {
 855                         $opts['LIMIT'] = $limit;
 856                 }
 857
 858                 // Search backwards for time > x queries
 859                 $order = ( !$start && $end !== null ) ? 'ASC' : 'DESC';
 860                 $opts['ORDER BY'] = "oi_timestamp $order";
 861                 $opts['USE INDEX'] = array( 'oldimage' => 'oi_name_timestamp' );
 862
 863                 wfRunHooks( 'LocalFile::getHistory', array( &$this, &$tables, &$fields,
 864                         &$conds, &$opts, &$join_conds ) );
 865
 866                 $res = $dbr->select( $tables, $fields, $conds, __METHOD__, $opts, $join_conds );
 867                 $r = array();
 868
 869                 foreach ( $res as $row ) {
 870                         if ( $this->repo->oldFileFromRowFactory ) {
 871                                 $r[] = call_user_func( $this->repo->oldFileFromRowFactory, $row, $this->repo );
 872                         } else {
 873                                 $r[] = OldLocalFile::newFromRow( $row, $this->repo );
 874                         }
 875                 }
 876
 877                 if ( $order == 'ASC' ) {
 878                         $r = array_reverse( $r ); // make sure it ends up descending
 879                 }
 880
 881                 return $r;
 882         }
 883
 884         /**
 885          * Return the history of this file, line by line.
 886          * starts with current version, then old versions.
 887          * uses $this->historyLine to check which line to return:
 888          *  0      return line for current version
 889          *  1      query for old versions, return first one
 890          *  2, ... return next old version from above query
 891          * @return bool
 892          */
 893         public function nextHistoryLine() {
 894                 # Polymorphic function name to distinguish foreign and local fetches
 895                 $fname = get_class( $this ) . '::' . __FUNCTION__;
 896
 897                 $dbr = $this->repo->getSlaveDB();
 898
 899                 if ( $this->historyLine == 0 ) {// called for the first time, return line from cur
 900                         $this->historyRes = $dbr->select( 'image',
 901                                 array(
 902                                         '*',
 903                                         "'' AS oi_archive_name",
 904                                         '0 as oi_deleted',
 905                                         'img_sha1'
 906                                 ),
 907                                 array( 'img_name' => $this->title->getDBkey() ),
 908                                 $fname
 909                         );
 910
 911                         if ( 0 == $dbr->numRows( $this->historyRes ) ) {
 912                                 $this->historyRes = null;
 913                                 return false;
 914                         }
 915                 } elseif ( $this->historyLine == 1 ) {
 916                         $this->historyRes = $dbr->select( 'oldimage', '*',
 917                                 array( 'oi_name' => $this->title->getDBkey() ),
 918                                 $fname,
 919                                 array( 'ORDER BY' => 'oi_timestamp DESC' )
 920                         );
 921                 }
 922                 $this->historyLine ++;
 923
 924                 return $dbr->fetchObject( $this->historyRes );
 925         }
 926
 927         /**
 928          * Reset the history pointer to the first element of the history
 929          */
 930         public function resetHistory() {
 931                 $this->historyLine = 0;
 932
 933                 if ( !is_null( $this->historyRes ) ) {
 934                         $this->historyRes = null;
 935                 }
 936         }
 937
 938         /** getHashPath inherited */
 939         /** getRel inherited */
 940         /** getUrlRel inherited */
 941         /** getArchiveRel inherited */
 942         /** getArchivePath inherited */
 943         /** getThumbPath inherited */
 944         /** getArchiveUrl inherited */
 945         /** getThumbUrl inherited */
 946         /** getArchiveVirtualUrl inherited */
 947         /** getThumbVirtualUrl inherited */
 948         /** isHashed inherited */
 949
 950         /**
 951          * Upload a file and record it in the DB
 952          * @param $srcPath String: source storage path or virtual URL
 953          * @param $comment String: upload description
 954          * @param $pageText String: text to use for the new description page,
 955          *                  if a new description page is created
 956          * @param $flags Integer|bool: flags for publish()
 957          * @param $props Array|bool: File properties, if known. This can be used to reduce the
 958          *               upload time when uploading virtual URLs for which the file info
 959          *               is already known
 960          * @param $timestamp String|bool: timestamp for img_timestamp, or false to use the current time
 961          * @param $user User|null: User object or null to use $wgUser
 962          *
 963          * @return FileRepoStatus object. On success, the value member contains the
 964          *     archive name, or an empty string if it was a new file.
 965          */
 966         function upload( $srcPath, $comment, $pageText, $flags = 0, $props = false, $timestamp = false, $user = null ) {
 967                 global $wgContLang;
 968
 969                 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
 970                         return $this->readOnlyFatalStatus();
 971                 }
 972
 973                 // truncate nicely or the DB will do it for us
 974                 // non-nicely (dangling multi-byte chars, non-truncated version in cache).
 975                 $comment = $wgContLang->truncate( $comment, 255 );
 976                 $this->lock(); // begin
 977                 $status = $this->publish( $srcPath, $flags );
 978
 979                 if ( $status->successCount > 0 ) {
 980                         # Essentially we are displacing any existing current file and saving
 981                         # a new current file at the old location. If just the first succeeded,
 982                         # we still need to displace the current DB entry and put in a new one.
 983                         if ( !$this->recordUpload2( $status->value, $comment, $pageText, $props, $timestamp, $user ) ) {
 984                                 $status->fatal( 'filenotfound', $srcPath );
 985                         }
 986                 }
 987
 988                 $this->unlock(); // done
 989
 990                 return $status;
 991         }
 992
 993         /**
 994          * Record a file upload in the upload log and the image table
 995          * @param $oldver
 996          * @param $desc string
 997          * @param $license string
 998          * @param $copyStatus string
 999          * @param $source string
1000          * @param $watch bool
1001          * @param $timestamp string|bool
1002          * @return bool
1003          */
1004         function recordUpload( $oldver, $desc, $license = '', $copyStatus = '', $source = '',
1005                 $watch = false, $timestamp = false )
1006         {
1007                 $pageText = SpecialUpload::getInitialPageText( $desc, $license, $copyStatus, $source );
1008
1009                 if ( !$this->recordUpload2( $oldver, $desc, $pageText ) ) {
1010                         return false;
1011                 }
1012
1013                 if ( $watch ) {
1014                         global $wgUser;
1015                         $wgUser->addWatch( $this->getTitle() );
1016                 }
1017                 return true;
1018         }
1019
1020         /**
1021          * Record a file upload in the upload log and the image table
1022          * @param $oldver
1023          * @param $comment string
1024          * @param $pageText string
1025          * @param $props bool|array
1026          * @param $timestamp bool|string
1027          * @param $user null|User
1028          * @return bool
1029          */
1030         function recordUpload2(
1031                 $oldver, $comment, $pageText, $props = false, $timestamp = false, $user = null
1032         ) {
1033                 wfProfileIn( __METHOD__ );
1034
1035                 if ( is_null( $user ) ) {
1036                         global $wgUser;
1037                         $user = $wgUser;
1038                 }
1039
1040                 $dbw = $this->repo->getMasterDB();
1041                 $dbw->begin( __METHOD__ );
1042
1043                 if ( !$props ) {
1044                         wfProfileIn( __METHOD__ . '-getProps' );
1045                         $props = $this->repo->getFileProps( $this->getVirtualUrl() );
1046                         wfProfileOut( __METHOD__ . '-getProps' );
1047                 }
1048
1049                 if ( $timestamp === false ) {
1050                         $timestamp = $dbw->timestamp();
1051                 }
1052
1053                 $props['description'] = $comment;
1054                 $props['user'] = $user->getId();
1055                 $props['user_text'] = $user->getName();
1056                 $props['timestamp'] = wfTimestamp( TS_MW, $timestamp ); // DB -> TS_MW
1057                 $this->setProps( $props );
1058
1059                 # Fail now if the file isn't there
1060                 if ( !$this->fileExists ) {
1061                         wfDebug( __METHOD__ . ": File " . $this->getRel() . " went missing!\n" );
1062                         wfProfileOut( __METHOD__ );
1063                         return false;
1064                 }
1065
1066                 $reupload = false;
1067
1068                 # Test to see if the row exists using INSERT IGNORE
1069                 # This avoids race conditions by locking the row until the commit, and also
1070                 # doesn't deadlock. SELECT FOR UPDATE causes a deadlock for every race condition.
1071                 $dbw->insert( 'image',
1072                         array(
1073                                 'img_name'        => $this->getName(),
1074                                 'img_size'        => $this->size,
1075                                 'img_width'       => intval( $this->width ),
1076                                 'img_height'      => intval( $this->height ),
1077                                 'img_bits'        => $this->bits,
1078                                 'img_media_type'  => $this->media_type,
1079                                 'img_major_mime'  => $this->major_mime,
1080                                 'img_minor_mime'  => $this->minor_mime,
1081                                 'img_timestamp'   => $timestamp,
1082                                 'img_description' => $comment,
1083                                 'img_user'        => $user->getId(),
1084                                 'img_user_text'   => $user->getName(),
1085                                 'img_metadata'    => $this->metadata,
1086                                 'img_sha1'        => $this->sha1
1087                         ),
1088                         __METHOD__,
1089                         'IGNORE'
1090                 );
1091                 if ( $dbw->affectedRows() == 0 ) {
1092                         # (bug 34993) Note: $oldver can be empty here, if the previous
1093                         # version of the file was broken. Allow registration of the new
1094                         # version to continue anyway, because that's better than having
1095                         # an image that's not fixable by user operations.
1096
1097                         $reupload = true;
1098                         # Collision, this is an update of a file
1099                         # Insert previous contents into oldimage
1100                         $dbw->insertSelect( 'oldimage', 'image',
1101                                 array(
1102                                         'oi_name'         => 'img_name',
1103                                         'oi_archive_name' => $dbw->addQuotes( $oldver ),
1104                                         'oi_size'         => 'img_size',
1105                                         'oi_width'        => 'img_width',
1106                                         'oi_height'       => 'img_height',
1107                                         'oi_bits'         => 'img_bits',
1108                                         'oi_timestamp'    => 'img_timestamp',
1109                                         'oi_description'  => 'img_description',
1110                                         'oi_user'         => 'img_user',
1111                                         'oi_user_text'    => 'img_user_text',
1112                                         'oi_metadata'     => 'img_metadata',
1113                                         'oi_media_type'   => 'img_media_type',
1114                                         'oi_major_mime'   => 'img_major_mime',
1115                                         'oi_minor_mime'   => 'img_minor_mime',
1116                                         'oi_sha1'         => 'img_sha1'
1117                                 ),
1118                                 array( 'img_name' => $this->getName() ),
1119                                 __METHOD__
1120                         );
1121
1122                         # Update the current image row
1123                         $dbw->update( 'image',
1124                                 array( /* SET */
1125                                         'img_size'        => $this->size,
1126                                         'img_width'       => intval( $this->width ),
1127                                         'img_height'      => intval( $this->height ),
1128                                         'img_bits'        => $this->bits,
1129                                         'img_media_type'  => $this->media_type,
1130                                         'img_major_mime'  => $this->major_mime,
1131                                         'img_minor_mime'  => $this->minor_mime,
1132                                         'img_timestamp'   => $timestamp,
1133                                         'img_description' => $comment,
1134                                         'img_user'        => $user->getId(),
1135                                         'img_user_text'   => $user->getName(),
1136                                         'img_metadata'    => $this->metadata,
1137                                         'img_sha1'        => $this->sha1
1138                                 ),
1139                                 array( 'img_name' => $this->getName() ),
1140                                 __METHOD__
1141                         );
1142                 } else {
1143                         # This is a new file, so update the image count
1144                         DeferredUpdates::addUpdate( SiteStatsUpdate::factory( array( 'images' => 1 ) ) );
1145                 }
1146
1147                 $descTitle = $this->getTitle();
1148                 $wikiPage = new WikiFilePage( $descTitle );
1149                 $wikiPage->setFile( $this );
1150
1151                 # Add the log entry
1152                 $log = new LogPage( 'upload' );
1153                 $action = $reupload ? 'overwrite' : 'upload';
1154                 $logId = $log->addEntry( $action, $descTitle, $comment, array(), $user );
1155
1156                 wfProfileIn( __METHOD__ . '-edit' );
1157                 if ( $descTitle->exists() ) {
1158                         # Create a null revision
1159                         $latest = $descTitle->getLatestRevID();
1160                         $nullRevision = Revision::newNullRevision(
1161                                 $dbw,
1162                                 $descTitle->getArticleID(),
1163                                 $log->getRcComment(),
1164                                 false
1165                         );
1166                         if (!is_null($nullRevision)) {
1167                                 $nullRevision->insertOn( $dbw );
1168
1169                                 wfRunHooks( 'NewRevisionFromEditComplete', array( $wikiPage, $nullRevision, $latest, $user ) );
1170                                 $wikiPage->updateRevisionOn( $dbw, $nullRevision );
1171                         }
1172                         $dbw->update( 'logging', array( 'log_page' => $descTitle->getArticleID() ), array( 'log_id' => $logId ), __METHOD__ );
1173
1174                         # Invalidate the cache for the description page
1175                         $descTitle->invalidateCache();
1176                         $descTitle->purgeSquid();
1177                 } else {
1178                         # New file; create the description page.
1179                         # There's already a log entry, so don't make a second RC entry
1180                         # Squid and file cache for the description page are purged by doEditContent.
1181                         $content = ContentHandler::makeContent( $pageText, $descTitle );
1182                         $status = $wikiPage->doEditContent( $content, $comment, EDIT_NEW | EDIT_SUPPRESS_RC, false, $user );
1183
1184                         if ( isset( $status->value['revision'] ) ) {
1185                                 $dbw->update( 'logging', array( 'log_page' => $status->value['revision']->getPage() ), array( 'log_id' => $logId ), __METHOD__ );
1186                         }
1187                 }
1188                 wfProfileOut( __METHOD__ . '-edit' );
1189
1190                 # Commit the transaction now, in case something goes wrong later
1191                 # The most important thing is that files don't get lost, especially archives
1192                 $dbw->commit( __METHOD__ );
1193
1194                 # Save to cache and purge the squid
1195                 # We shall not saveToCache before the commit since otherwise
1196                 # in case of a rollback there is an usable file from memcached
1197                 # which in fact doesn't really exist (bug 24978)
1198                 $this->saveToCache();
1199
1200                 if ( $reupload ) {
1201                         # Delete old thumbnails
1202                         wfProfileIn( __METHOD__ . '-purge' );
1203                         $this->purgeThumbnails();
1204                         wfProfileOut( __METHOD__ . '-purge' );
1205
1206                         # Remove the old file from the squid cache
1207                         SquidUpdate::purge( array( $this->getURL() ) );
1208                 }
1209
1210                 # Hooks, hooks, the magic of hooks...
1211                 wfProfileIn( __METHOD__ . '-hooks' );
1212                 wfRunHooks( 'FileUpload', array( $this, $reupload, $descTitle->exists() ) );
1213                 wfProfileOut( __METHOD__ . '-hooks' );
1214
1215                 # Invalidate cache for all pages using this file
1216                 $update = new HTMLCacheUpdate( $this->getTitle(), 'imagelinks' );
1217                 $update->doUpdate();
1218
1219                 # Invalidate cache for all pages that redirects on this page
1220                 $redirs = $this->getTitle()->getRedirectsHere();
1221
1222                 foreach ( $redirs as $redir ) {
1223                         $update = new HTMLCacheUpdate( $redir, 'imagelinks' );
1224                         $update->doUpdate();
1225                 }
1226
1227                 wfProfileOut( __METHOD__ );
1228                 return true;
1229         }
1230
1231         /**
1232          * Move or copy a file to its public location. If a file exists at the
1233          * destination, move it to an archive. Returns a FileRepoStatus object with
1234          * the archive name in the "value" member on success.
1235          *
1236          * The archive name should be passed through to recordUpload for database
1237          * registration.
1238          *
1239          * @param $srcPath String: local filesystem path to the source image
1240          * @param $flags Integer: a bitwise combination of:
1241          *     File::DELETE_SOURCE      Delete the source file, i.e. move rather than copy
1242          * @return FileRepoStatus object. On success, the value member contains the
1243          *     archive name, or an empty string if it was a new file.
1244          */
1245         function publish( $srcPath, $flags = 0 ) {
1246                 return $this->publishTo( $srcPath, $this->getRel(), $flags );
1247         }
1248
1249         /**
1250          * Move or copy a file to a specified location. Returns a FileRepoStatus
1251          * object with the archive name in the "value" member on success.
1252          *
1253          * The archive name should be passed through to recordUpload for database
1254          * registration.
1255          *
1256          * @param $srcPath String: local filesystem path to the source image
1257          * @param $dstRel String: target relative path
1258          * @param $flags Integer: a bitwise combination of:
1259          *     File::DELETE_SOURCE      Delete the source file, i.e. move rather than copy
1260          * @return FileRepoStatus object. On success, the value member contains the
1261          *     archive name, or an empty string if it was a new file.
1262          */
1263         function publishTo( $srcPath, $dstRel, $flags = 0 ) {
1264                 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
1265                         return $this->readOnlyFatalStatus();
1266                 }
1267
1268                 $this->lock(); // begin
1269
1270                 $archiveName = wfTimestamp( TS_MW ) . '!'. $this->getName();
1271                 $archiveRel = 'archive/' . $this->getHashPath() . $archiveName;
1272                 $flags = $flags & File::DELETE_SOURCE ? LocalRepo::DELETE_SOURCE : 0;
1273                 $status = $this->repo->publish( $srcPath, $dstRel, $archiveRel, $flags );
1274
1275                 if ( $status->value == 'new' ) {
1276                         $status->value = '';
1277                 } else {
1278                         $status->value = $archiveName;
1279                 }
1280
1281                 $this->unlock(); // done
1282
1283                 return $status;
1284         }
1285
1286         /** getLinksTo inherited */
1287         /** getExifData inherited */
1288         /** isLocal inherited */
1289         /** wasDeleted inherited */
1290
1291         /**
1292          * Move file to the new title
1293          *
1294          * Move current, old version and all thumbnails
1295          * to the new filename. Old file is deleted.
1296          *
1297          * Cache purging is done; checks for validity
1298          * and logging are caller's responsibility
1299          *
1300          * @param $target Title New file name
1301          * @return FileRepoStatus object.
1302          */
1303         function move( $target ) {
1304                 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
1305                         return $this->readOnlyFatalStatus();
1306                 }
1307
1308                 wfDebugLog( 'imagemove', "Got request to move {$this->name} to " . $target->getText() );
1309                 $batch = new LocalFileMoveBatch( $this, $target );
1310
1311                 $this->lock(); // begin
1312                 $batch->addCurrent();
1313                 $archiveNames = $batch->addOlds();
1314                 $status = $batch->execute();
1315                 $this->unlock(); // done
1316
1317                 wfDebugLog( 'imagemove', "Finished moving {$this->name}" );
1318
1319                 $this->purgeEverything();
1320                 foreach ( $archiveNames as $archiveName ) {
1321                         $this->purgeOldThumbnails( $archiveName );
1322                 }
1323                 if ( $status->isOK() ) {
1324                         // Now switch the object
1325                         $this->title = $target;
1326                         // Force regeneration of the name and hashpath
1327                         unset( $this->name );
1328                         unset( $this->hashPath );
1329                         // Purge the new image
1330                         $this->purgeEverything();
1331                 }
1332
1333                 return $status;
1334         }
1335
1336         /**
1337          * Delete all versions of the file.
1338          *
1339          * Moves the files into an archive directory (or deletes them)
1340          * and removes the database rows.
1341          *
1342          * Cache purging is done; logging is caller's responsibility.
1343          *
1344          * @param $reason
1345          * @param $suppress
1346          * @return FileRepoStatus object.
1347          */
1348         function delete( $reason, $suppress = false ) {
1349                 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
1350                         return $this->readOnlyFatalStatus();
1351                 }
1352
1353                 $batch = new LocalFileDeleteBatch( $this, $reason, $suppress );
1354
1355                 $this->lock(); // begin
1356                 $batch->addCurrent();
1357                 # Get old version relative paths
1358                 $archiveNames = $batch->addOlds();
1359                 $status = $batch->execute();
1360                 $this->unlock(); // done
1361
1362                 if ( $status->isOK() ) {
1363                         DeferredUpdates::addUpdate( SiteStatsUpdate::factory( array( 'images' => -1 ) ) );
1364                 }
1365
1366                 $this->purgeEverything();
1367                 foreach ( $archiveNames as $archiveName ) {
1368                         $this->purgeOldThumbnails( $archiveName );
1369                 }
1370
1371                 return $status;
1372         }
1373
1374         /**
1375          * Delete an old version of the file.
1376          *
1377          * Moves the file into an archive directory (or deletes it)
1378          * and removes the database row.
1379          *
1380          * Cache purging is done; logging is caller's responsibility.
1381          *
1382          * @param $archiveName String
1383          * @param $reason String
1384          * @param $suppress Boolean
1385          * @throws MWException or FSException on database or file store failure
1386          * @return FileRepoStatus object.
1387          */
1388         function deleteOld( $archiveName, $reason, $suppress = false ) {
1389                 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
1390                         return $this->readOnlyFatalStatus();
1391                 }
1392
1393                 $batch = new LocalFileDeleteBatch( $this, $reason, $suppress );
1394
1395                 $this->lock(); // begin
1396                 $batch->addOld( $archiveName );
1397                 $status = $batch->execute();
1398                 $this->unlock(); // done
1399
1400                 $this->purgeOldThumbnails( $archiveName );
1401                 if ( $status->isOK() ) {
1402                         $this->purgeDescription();
1403                         $this->purgeHistory();
1404                 }
1405
1406                 return $status;
1407         }
1408
1409         /**
1410          * Restore all or specified deleted revisions to the given file.
1411          * Permissions and logging are left to the caller.
1412          *
1413          * May throw database exceptions on error.
1414          *
1415          * @param $versions array set of record ids of deleted items to restore,
1416          *                    or empty to restore all revisions.
1417          * @param $unsuppress Boolean
1418          * @return FileRepoStatus
1419          */
1420         function restore( $versions = array(), $unsuppress = false ) {
1421                 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
1422                         return $this->readOnlyFatalStatus();
1423                 }
1424
1425                 $batch = new LocalFileRestoreBatch( $this, $unsuppress );
1426
1427                 $this->lock(); // begin
1428                 if ( !$versions ) {
1429                         $batch->addAll();
1430                 } else {
1431                         $batch->addIds( $versions );
1432                 }
1433                 $status = $batch->execute();
1434                 if ( $status->isGood() ) {
1435                         $cleanupStatus = $batch->cleanup();
1436                         $cleanupStatus->successCount = 0;
1437                         $cleanupStatus->failCount = 0;
1438                         $status->merge( $cleanupStatus );
1439                 }
1440                 $this->unlock(); // done
1441
1442                 return $status;
1443         }
1444
1445         /** isMultipage inherited */
1446         /** pageCount inherited */
1447         /** scaleHeight inherited */
1448         /** getImageSize inherited */
1449
1450         /**
1451          * Get the URL of the file description page.
1452          * @return String
1453          */
1454         function getDescriptionUrl() {
1455                 return $this->title->getLocalUrl();
1456         }
1457
1458         /**
1459          * Get the HTML text of the description page
1460          * This is not used by ImagePage for local files, since (among other things)
1461          * it skips the parser cache.
1462          * @return bool|mixed
1463          */
1464         function getDescriptionText() {
1465                 global $wgParser;
1466                 $revision = Revision::newFromTitle( $this->title, false, Revision::READ_NORMAL );
1467                 if ( !$revision ) return false;
1468                 $content = $revision->getContent();
1469                 if ( !$content ) return false;
1470                 $pout = $content->getParserOutput( $this->title, null, new ParserOptions() );
1471                 return $pout->getText();
1472         }
1473
1474         /**
1475          * @return string
1476          */
1477         function getDescription( $audience = self::FOR_PUBLIC, User $user = null ) {
1478                 $this->load();
1479                 if ( $audience == self::FOR_PUBLIC && $this->isDeleted( self::DELETED_COMMENT ) ) {
1480                         return '';
1481                 } elseif ( $audience == self::FOR_THIS_USER
1482                         && !$this->userCan( self::DELETED_COMMENT, $user ) )
1483                 {
1484                         return '';
1485                 } else {
1486                         return $this->description;
1487                 }
1488         }
1489
1490         /**
1491          * @return bool|string
1492          */
1493         function getTimestamp() {
1494                 $this->load();
1495                 return $this->timestamp;
1496         }
1497
1498         /**
1499          * @return string
1500          */
1501         function getSha1() {
1502                 $this->load();
1503                 // Initialise now if necessary
1504                 if ( $this->sha1 == '' && $this->fileExists ) {
1505                         $this->lock(); // begin
1506
1507                         $this->sha1 = $this->repo->getFileSha1( $this->getPath() );
1508                         if ( !wfReadOnly() && strval( $this->sha1 ) != '' ) {
1509                                 $dbw = $this->repo->getMasterDB();
1510                                 $dbw->update( 'image',
1511                                         array( 'img_sha1' => $this->sha1 ),
1512                                         array( 'img_name' => $this->getName() ),
1513                                         __METHOD__ );
1514                                 $this->saveToCache();
1515                         }
1516
1517                         $this->unlock(); // done
1518                 }
1519
1520                 return $this->sha1;
1521         }
1522
1523         /**
1524          * @return bool
1525          */
1526         function isCacheable() {
1527                 $this->load();
1528                 return strlen( $this->metadata ) <= self::CACHE_FIELD_MAX_LEN; // avoid OOMs
1529         }
1530
1531         /**
1532          * Start a transaction and lock the image for update
1533          * Increments a reference counter if the lock is already held
1534          * @return boolean True if the image exists, false otherwise
1535          */
1536         function lock() {
1537                 $dbw = $this->repo->getMasterDB();
1538
1539                 if ( !$this->locked ) {
1540                         $dbw->begin( __METHOD__ );
1541                         $this->locked++;
1542                 }
1543
1544                 return $dbw->selectField( 'image', '1',
1545                         array( 'img_name' => $this->getName() ), __METHOD__, array( 'FOR UPDATE' ) );
1546         }
1547
1548         /**
1549          * Decrement the lock reference count. If the reference count is reduced to zero, commits
1550          * the transaction and thereby releases the image lock.
1551          */
1552         function unlock() {
1553                 if ( $this->locked ) {
1554                         --$this->locked;
1555                         if ( !$this->locked ) {
1556                                 $dbw = $this->repo->getMasterDB();
1557                                 $dbw->commit( __METHOD__ );
1558                         }
1559                 }
1560         }
1561
1562         /**
1563          * Roll back the DB transaction and mark the image unlocked
1564          */
1565         function unlockAndRollback() {
1566                 $this->locked = false;
1567                 $dbw = $this->repo->getMasterDB();
1568                 $dbw->rollback( __METHOD__ );
1569         }
1570
1571         /**
1572          * @return Status
1573          */
1574         protected function readOnlyFatalStatus() {
1575                 return $this->getRepo()->newFatal( 'filereadonlyerror', $this->getName(),
1576                         $this->getRepo()->getName(), $this->getRepo()->getReadOnlyReason() );
1577         }
1578 } // LocalFile class
1579
1580 # ------------------------------------------------------------------------------
1581
1582 /**
1583  * Helper class for file deletion
1584  * @ingroup FileAbstraction
1585  */
1586 class LocalFileDeleteBatch {
1587
1588         /**
1589          * @var LocalFile
1590          */
1591         var $file;
1592
1593         var $reason, $srcRels = array(), $archiveUrls = array(), $deletionBatch, $suppress;
1594         var $status;
1595
1596         /**
1597          * @param $file File
1598          * @param $reason string
1599          * @param $suppress bool
1600          */
1601         function __construct( File $file, $reason = '', $suppress = false ) {
1602                 $this->file = $file;
1603                 $this->reason = $reason;
1604                 $this->suppress = $suppress;
1605                 $this->status = $file->repo->newGood();
1606         }
1607
1608         function addCurrent() {
1609                 $this->srcRels['.'] = $this->file->getRel();
1610         }
1611
1612         /**
1613          * @param $oldName string
1614          */
1615         function addOld( $oldName ) {
1616                 $this->srcRels[$oldName] = $this->file->getArchiveRel( $oldName );
1617                 $this->archiveUrls[] = $this->file->getArchiveUrl( $oldName );
1618         }
1619
1620         /**
1621          * Add the old versions of the image to the batch
1622          * @return Array List of archive names from old versions
1623          */
1624         function addOlds() {
1625                 $archiveNames = array();
1626
1627                 $dbw = $this->file->repo->getMasterDB();
1628                 $result = $dbw->select( 'oldimage',
1629                         array( 'oi_archive_name' ),
1630                         array( 'oi_name' => $this->file->getName() ),
1631                         __METHOD__
1632                 );
1633
1634                 foreach ( $result as $row ) {
1635                         $this->addOld( $row->oi_archive_name );
1636                         $archiveNames[] = $row->oi_archive_name;
1637                 }
1638
1639                 return $archiveNames;
1640         }
1641
1642         /**
1643          * @return array
1644          */
1645         function getOldRels() {
1646                 if ( !isset( $this->srcRels['.'] ) ) {
1647                         $oldRels =& $this->srcRels;
1648                         $deleteCurrent = false;
1649                 } else {
1650                         $oldRels = $this->srcRels;
1651                         unset( $oldRels['.'] );
1652                         $deleteCurrent = true;
1653                 }
1654
1655                 return array( $oldRels, $deleteCurrent );
1656         }
1657
1658         /**
1659          * @return array
1660          */
1661         protected function getHashes() {
1662                 $hashes = array();
1663                 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
1664
1665                 if ( $deleteCurrent ) {
1666                         $hashes['.'] = $this->file->getSha1();
1667                 }
1668
1669                 if ( count( $oldRels ) ) {
1670                         $dbw = $this->file->repo->getMasterDB();
1671                         $res = $dbw->select(
1672                                 'oldimage',
1673                                 array( 'oi_archive_name', 'oi_sha1' ),
1674                                 'oi_archive_name IN (' . $dbw->makeList( array_keys( $oldRels ) ) . ')',
1675                                 __METHOD__
1676                         );
1677
1678                         foreach ( $res as $row ) {
1679                                 if ( rtrim( $row->oi_sha1, "\0" ) === '' ) {
1680                                         // Get the hash from the file
1681                                         $oldUrl = $this->file->getArchiveVirtualUrl( $row->oi_archive_name );
1682                                         $props = $this->file->repo->getFileProps( $oldUrl );
1683
1684                                         if ( $props['fileExists'] ) {
1685                                                 // Upgrade the oldimage row
1686                                                 $dbw->update( 'oldimage',
1687                                                         array( 'oi_sha1' => $props['sha1'] ),
1688                                                         array( 'oi_name' => $this->file->getName(), 'oi_archive_name' => $row->oi_archive_name ),
1689                                                         __METHOD__ );
1690                                                 $hashes[$row->oi_archive_name] = $props['sha1'];
1691                                         } else {
1692                                                 $hashes[$row->oi_archive_name] = false;
1693                                         }
1694                                 } else {
1695                                         $hashes[$row->oi_archive_name] = $row->oi_sha1;
1696                                 }
1697                         }
1698                 }
1699
1700                 $missing = array_diff_key( $this->srcRels, $hashes );
1701
1702                 foreach ( $missing as $name => $rel ) {
1703                         $this->status->error( 'filedelete-old-unregistered', $name );
1704                 }
1705
1706                 foreach ( $hashes as $name => $hash ) {
1707                         if ( !$hash ) {
1708                                 $this->status->error( 'filedelete-missing', $this->srcRels[$name] );
1709                                 unset( $hashes[$name] );
1710                         }
1711                 }
1712
1713                 return $hashes;
1714         }
1715
1716         function doDBInserts() {
1717                 global $wgUser;
1718
1719                 $dbw = $this->file->repo->getMasterDB();
1720                 $encTimestamp = $dbw->addQuotes( $dbw->timestamp() );
1721                 $encUserId = $dbw->addQuotes( $wgUser->getId() );
1722                 $encReason = $dbw->addQuotes( $this->reason );
1723                 $encGroup = $dbw->addQuotes( 'deleted' );
1724                 $ext = $this->file->getExtension();
1725                 $dotExt = $ext === '' ? '' : ".$ext";
1726                 $encExt = $dbw->addQuotes( $dotExt );
1727                 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
1728
1729                 // Bitfields to further suppress the content
1730                 if ( $this->suppress ) {
1731                         $bitfield = 0;
1732                         // This should be 15...
1733                         $bitfield |= Revision::DELETED_TEXT;
1734                         $bitfield |= Revision::DELETED_COMMENT;
1735                         $bitfield |= Revision::DELETED_USER;
1736                         $bitfield |= Revision::DELETED_RESTRICTED;
1737                 } else {
1738                         $bitfield = 'oi_deleted';
1739                 }
1740
1741                 if ( $deleteCurrent ) {
1742                         $concat = $dbw->buildConcat( array( "img_sha1", $encExt ) );
1743                         $where = array( 'img_name' => $this->file->getName() );
1744                         $dbw->insertSelect( 'filearchive', 'image',
1745                                 array(
1746                                         'fa_storage_group' => $encGroup,
1747                                         'fa_storage_key'   => "CASE WHEN img_sha1='' THEN '' ELSE $concat END",
1748                                         'fa_deleted_user'      => $encUserId,
1749                                         'fa_deleted_timestamp' => $encTimestamp,
1750                                         'fa_deleted_reason'    => $encReason,
1751                                         'fa_deleted'               => $this->suppress ? $bitfield : 0,
1752
1753                                         'fa_name'         => 'img_name',
1754                                         'fa_archive_name' => 'NULL',
1755                                         'fa_size'         => 'img_size',
1756                                         'fa_width'        => 'img_width',
1757                                         'fa_height'       => 'img_height',
1758                                         'fa_metadata'     => 'img_metadata',
1759                                         'fa_bits'         => 'img_bits',
1760                                         'fa_media_type'   => 'img_media_type',
1761                                         'fa_major_mime'   => 'img_major_mime',
1762                                         'fa_minor_mime'   => 'img_minor_mime',
1763                                         'fa_description'  => 'img_description',
1764                                         'fa_user'         => 'img_user',
1765                                         'fa_user_text'    => 'img_user_text',
1766                                         'fa_timestamp'    => 'img_timestamp'
1767                                 ), $where, __METHOD__ );
1768                 }
1769
1770                 if ( count( $oldRels ) ) {
1771                         $concat = $dbw->buildConcat( array( "oi_sha1", $encExt ) );
1772                         $where = array(
1773                                 'oi_name' => $this->file->getName(),
1774                                 'oi_archive_name IN (' . $dbw->makeList( array_keys( $oldRels ) ) . ')' );
1775                         $dbw->insertSelect( 'filearchive', 'oldimage',
1776                                 array(
1777                                         'fa_storage_group' => $encGroup,
1778                                         'fa_storage_key'   => "CASE WHEN oi_sha1='' THEN '' ELSE $concat END",
1779                                         'fa_deleted_user'      => $encUserId,
1780                                         'fa_deleted_timestamp' => $encTimestamp,
1781                                         'fa_deleted_reason'    => $encReason,
1782                                         'fa_deleted'           => $this->suppress ? $bitfield : 'oi_deleted',
1783
1784                                         'fa_name'         => 'oi_name',
1785                                         'fa_archive_name' => 'oi_archive_name',
1786                                         'fa_size'         => 'oi_size',
1787                                         'fa_width'        => 'oi_width',
1788                                         'fa_height'       => 'oi_height',
1789                                         'fa_metadata'     => 'oi_metadata',
1790                                         'fa_bits'         => 'oi_bits',
1791                                         'fa_media_type'   => 'oi_media_type',
1792                                         'fa_major_mime'   => 'oi_major_mime',
1793                                         'fa_minor_mime'   => 'oi_minor_mime',
1794                                         'fa_description'  => 'oi_description',
1795                                         'fa_user'         => 'oi_user',
1796                                         'fa_user_text'    => 'oi_user_text',
1797                                         'fa_timestamp'    => 'oi_timestamp',
1798                                 ), $where, __METHOD__ );
1799                 }
1800         }
1801
1802         function doDBDeletes() {
1803                 $dbw = $this->file->repo->getMasterDB();
1804                 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
1805
1806                 if ( count( $oldRels ) ) {
1807                         $dbw->delete( 'oldimage',
1808                                 array(
1809                                         'oi_name' => $this->file->getName(),
1810                                         'oi_archive_name' => array_keys( $oldRels )
1811                                 ), __METHOD__ );
1812                 }
1813
1814                 if ( $deleteCurrent ) {
1815                         $dbw->delete( 'image', array( 'img_name' => $this->file->getName() ), __METHOD__ );
1816                 }
1817         }
1818
1819         /**
1820          * Run the transaction
1821          * @return FileRepoStatus
1822          */
1823         function execute() {
1824                 wfProfileIn( __METHOD__ );
1825
1826                 $this->file->lock();
1827                 // Leave private files alone
1828                 $privateFiles = array();
1829                 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
1830                 $dbw = $this->file->repo->getMasterDB();
1831
1832                 if ( !empty( $oldRels ) ) {
1833                         $res = $dbw->select( 'oldimage',
1834                                 array( 'oi_archive_name' ),
1835                                 array( 'oi_name' => $this->file->getName(),
1836                                         'oi_archive_name IN (' . $dbw->makeList( array_keys( $oldRels ) ) . ')',
1837                                         $dbw->bitAnd( 'oi_deleted', File::DELETED_FILE ) => File::DELETED_FILE ),
1838                                 __METHOD__ );
1839
1840                         foreach ( $res as $row ) {
1841                                 $privateFiles[$row->oi_archive_name] = 1;
1842                         }
1843                 }
1844                 // Prepare deletion batch
1845                 $hashes = $this->getHashes();
1846                 $this->deletionBatch = array();
1847                 $ext = $this->file->getExtension();
1848                 $dotExt = $ext === '' ? '' : ".$ext";
1849
1850                 foreach ( $this->srcRels as $name => $srcRel ) {
1851                         // Skip files that have no hash (missing source).
1852                         // Keep private files where they are.
1853                         if ( isset( $hashes[$name] ) && !array_key_exists( $name, $privateFiles ) ) {
1854                                 $hash = $hashes[$name];
1855                                 $key = $hash . $dotExt;
1856                                 $dstRel = $this->file->repo->getDeletedHashPath( $key ) . $key;
1857                                 $this->deletionBatch[$name] = array( $srcRel, $dstRel );
1858                         }
1859                 }
1860
1861                 // Lock the filearchive rows so that the files don't get deleted by a cleanup operation
1862                 // We acquire this lock by running the inserts now, before the file operations.
1863                 //
1864                 // This potentially has poor lock contention characteristics -- an alternative
1865                 // scheme would be to insert stub filearchive entries with no fa_name and commit
1866                 // them in a separate transaction, then run the file ops, then update the fa_name fields.
1867                 $this->doDBInserts();
1868
1869                 // Removes non-existent file from the batch, so we don't get errors.
1870                 $this->deletionBatch = $this->removeNonexistentFiles( $this->deletionBatch );
1871
1872                 // Execute the file deletion batch
1873                 $status = $this->file->repo->deleteBatch( $this->deletionBatch );
1874
1875                 if ( !$status->isGood() ) {
1876                         $this->status->merge( $status );
1877                 }
1878
1879                 if ( !$this->status->isOK() ) {
1880                         // Critical file deletion error
1881                         // Roll back inserts, release lock and abort
1882                         // TODO: delete the defunct filearchive rows if we are using a non-transactional DB
1883                         $this->file->unlockAndRollback();
1884                         wfProfileOut( __METHOD__ );
1885                         return $this->status;
1886                 }
1887
1888                 // Delete image/oldimage rows
1889                 $this->doDBDeletes();
1890
1891                 // Commit and return
1892                 $this->file->unlock();
1893                 wfProfileOut( __METHOD__ );
1894
1895                 return $this->status;
1896         }
1897
1898         /**
1899          * Removes non-existent files from a deletion batch.
1900          * @param $batch array
1901          * @return array
1902          */
1903         function removeNonexistentFiles( $batch ) {
1904                 $files = $newBatch = array();
1905
1906                 foreach ( $batch as $batchItem ) {
1907                         list( $src, $dest ) = $batchItem;
1908                         $files[$src] = $this->file->repo->getVirtualUrl( 'public' ) . '/' . rawurlencode( $src );
1909                 }
1910
1911                 $result = $this->file->repo->fileExistsBatch( $files );
1912
1913                 foreach ( $batch as $batchItem ) {
1914                         if ( $result[$batchItem[0]] ) {
1915                                 $newBatch[] = $batchItem;
1916                         }
1917                 }
1918
1919                 return $newBatch;
1920         }
1921 }
1922
1923 # ------------------------------------------------------------------------------
1924
1925 /**
1926  * Helper class for file undeletion
1927  * @ingroup FileAbstraction
1928  */
1929 class LocalFileRestoreBatch {
1930         /**
1931          * @var LocalFile
1932          */
1933         var $file;
1934
1935         var $cleanupBatch, $ids, $all, $unsuppress = false;
1936
1937         /**
1938          * @param $file File
1939          * @param $unsuppress bool
1940          */
1941         function __construct( File $file, $unsuppress = false ) {
1942                 $this->file = $file;
1943                 $this->cleanupBatch = $this->ids = array();
1944                 $this->ids = array();
1945                 $this->unsuppress = $unsuppress;
1946         }
1947
1948         /**
1949          * Add a file by ID
1950          */
1951         function addId( $fa_id ) {
1952                 $this->ids[] = $fa_id;
1953         }
1954
1955         /**
1956          * Add a whole lot of files by ID
1957          */
1958         function addIds( $ids ) {
1959                 $this->ids = array_merge( $this->ids, $ids );
1960         }
1961
1962         /**
1963          * Add all revisions of the file
1964          */
1965         function addAll() {
1966                 $this->all = true;
1967         }
1968
1969         /**
1970          * Run the transaction, except the cleanup batch.
1971          * The cleanup batch should be run in a separate transaction, because it locks different
1972          * rows and there's no need to keep the image row locked while it's acquiring those locks
1973          * The caller may have its own transaction open.
1974          * So we save the batch and let the caller call cleanup()
1975          * @return FileRepoStatus
1976          */
1977         function execute() {
1978                 global $wgLang;
1979
1980                 if ( !$this->all && !$this->ids ) {
1981                         // Do nothing
1982                         return $this->file->repo->newGood();
1983                 }
1984
1985                 $exists = $this->file->lock();
1986                 $dbw = $this->file->repo->getMasterDB();
1987                 $status = $this->file->repo->newGood();
1988
1989                 // Fetch all or selected archived revisions for the file,
1990                 // sorted from the most recent to the oldest.
1991                 $conditions = array( 'fa_name' => $this->file->getName() );
1992
1993                 if ( !$this->all ) {
1994                         $conditions[] = 'fa_id IN (' . $dbw->makeList( $this->ids ) . ')';
1995                 }
1996
1997                 $result = $dbw->select( 'filearchive', '*',
1998                         $conditions,
1999                         __METHOD__,
2000                         array( 'ORDER BY' => 'fa_timestamp DESC' )
2001                 );
2002
2003                 $idsPresent = array();
2004                 $storeBatch = array();
2005                 $insertBatch = array();
2006                 $insertCurrent = false;
2007                 $deleteIds = array();
2008                 $first = true;
2009                 $archiveNames = array();
2010
2011                 foreach ( $result as $row ) {
2012                         $idsPresent[] = $row->fa_id;
2013
2014                         if ( $row->fa_name != $this->file->getName() ) {
2015                                 $status->error( 'undelete-filename-mismatch', $wgLang->timeanddate( $row->fa_timestamp ) );
2016                                 $status->failCount++;
2017                                 continue;
2018                         }
2019
2020                         if ( $row->fa_storage_key == '' ) {
2021                                 // Revision was missing pre-deletion
2022                                 $status->error( 'undelete-bad-store-key', $wgLang->timeanddate( $row->fa_timestamp ) );
2023                                 $status->failCount++;
2024                                 continue;
2025                         }
2026
2027                         $deletedRel = $this->file->repo->getDeletedHashPath( $row->fa_storage_key ) . $row->fa_storage_key;
2028                         $deletedUrl = $this->file->repo->getVirtualUrl() . '/deleted/' . $deletedRel;
2029
2030                         $sha1 = substr( $row->fa_storage_key, 0, strcspn( $row->fa_storage_key, '.' ) );
2031
2032                         # Fix leading zero
2033                         if ( strlen( $sha1 ) == 32 && $sha1[0] == '0' ) {
2034                                 $sha1 = substr( $sha1, 1 );
2035                         }
2036
2037                         if ( is_null( $row->fa_major_mime ) || $row->fa_major_mime == 'unknown'
2038                                 || is_null( $row->fa_minor_mime ) || $row->fa_minor_mime == 'unknown'
2039                                 || is_null( $row->fa_media_type ) || $row->fa_media_type == 'UNKNOWN'
2040                                 || is_null( $row->fa_metadata ) ) {
2041                                 // Refresh our metadata
2042                                 // Required for a new current revision; nice for older ones too. :)
2043                                 $props = RepoGroup::singleton()->getFileProps( $deletedUrl );
2044                         } else {
2045                                 $props = array(
2046                                         'minor_mime' => $row->fa_minor_mime,
2047                                         'major_mime' => $row->fa_major_mime,
2048                                         'media_type' => $row->fa_media_type,
2049                                         'metadata'   => $row->fa_metadata
2050                                 );
2051                         }
2052
2053                         if ( $first && !$exists ) {
2054                                 // This revision will be published as the new current version
2055                                 $destRel = $this->file->getRel();
2056                                 $insertCurrent = array(
2057                                         'img_name'        => $row->fa_name,
2058                                         'img_size'        => $row->fa_size,
2059                                         'img_width'       => $row->fa_width,
2060                                         'img_height'      => $row->fa_height,
2061                                         'img_metadata'    => $props['metadata'],
2062                                         'img_bits'        => $row->fa_bits,
2063                                         'img_media_type'  => $props['media_type'],
2064                                         'img_major_mime'  => $props['major_mime'],
2065                                         'img_minor_mime'  => $props['minor_mime'],
2066                                         'img_description' => $row->fa_description,
2067                                         'img_user'        => $row->fa_user,
2068                                         'img_user_text'   => $row->fa_user_text,
2069                                         'img_timestamp'   => $row->fa_timestamp,
2070                                         'img_sha1'        => $sha1
2071                                 );
2072
2073                                 // The live (current) version cannot be hidden!
2074                                 if ( !$this->unsuppress && $row->fa_deleted ) {
2075                                         $storeBatch[] = array( $deletedUrl, 'public', $destRel );
2076                                         $this->cleanupBatch[] = $row->fa_storage_key;
2077                                 }
2078                         } else {
2079                                 $archiveName = $row->fa_archive_name;
2080
2081                                 if ( $archiveName == '' ) {
2082                                         // This was originally a current version; we
2083                                         // have to devise a new archive name for it.
2084                                         // Format is <timestamp of archiving>!<name>
2085                                         $timestamp = wfTimestamp( TS_UNIX, $row->fa_deleted_timestamp );
2086
2087                                         do {
2088                                                 $archiveName = wfTimestamp( TS_MW, $timestamp ) . '!' . $row->fa_name;
2089                                                 $timestamp++;
2090                                         } while ( isset( $archiveNames[$archiveName] ) );
2091                                 }
2092
2093                                 $archiveNames[$archiveName] = true;
2094                                 $destRel = $this->file->getArchiveRel( $archiveName );
2095                                 $insertBatch[] = array(
2096                                         'oi_name'         => $row->fa_name,
2097                                         'oi_archive_name' => $archiveName,
2098                                         'oi_size'         => $row->fa_size,
2099                                         'oi_width'        => $row->fa_width,
2100                                         'oi_height'       => $row->fa_height,
2101                                         'oi_bits'         => $row->fa_bits,
2102                                         'oi_description'  => $row->fa_description,
2103                                         'oi_user'         => $row->fa_user,
2104                                         'oi_user_text'    => $row->fa_user_text,
2105                                         'oi_timestamp'    => $row->fa_timestamp,
2106                                         'oi_metadata'     => $props['metadata'],
2107                                         'oi_media_type'   => $props['media_type'],
2108                                         'oi_major_mime'   => $props['major_mime'],
2109                                         'oi_minor_mime'   => $props['minor_mime'],
2110                                         'oi_deleted'      => $this->unsuppress ? 0 : $row->fa_deleted,
2111                                         'oi_sha1'         => $sha1 );
2112                         }
2113
2114                         $deleteIds[] = $row->fa_id;
2115
2116                         if ( !$this->unsuppress && $row->fa_deleted & File::DELETED_FILE ) {
2117                                 // private files can stay where they are
2118                                 $status->successCount++;
2119                         } else {
2120                                 $storeBatch[] = array( $deletedUrl, 'public', $destRel );
2121                                 $this->cleanupBatch[] = $row->fa_storage_key;
2122                         }
2123
2124                         $first = false;
2125                 }
2126
2127                 unset( $result );
2128
2129                 // Add a warning to the status object for missing IDs
2130                 $missingIds = array_diff( $this->ids, $idsPresent );
2131
2132                 foreach ( $missingIds as $id ) {
2133                         $status->error( 'undelete-missing-filearchive', $id );
2134                 }
2135
2136                 // Remove missing files from batch, so we don't get errors when undeleting them
2137                 $storeBatch = $this->removeNonexistentFiles( $storeBatch );
2138
2139                 // Run the store batch
2140                 // Use the OVERWRITE_SAME flag to smooth over a common error
2141                 $storeStatus = $this->file->repo->storeBatch( $storeBatch, FileRepo::OVERWRITE_SAME );
2142                 $status->merge( $storeStatus );
2143
2144                 if ( !$status->isGood() ) {
2145                         // Even if some files could be copied, fail entirely as that is the
2146                         // easiest thing to do without data loss
2147                         $this->cleanupFailedBatch( $storeStatus, $storeBatch );
2148                         $status->ok = false;
2149                         $this->file->unlock();
2150
2151                         return $status;
2152                 }
2153
2154                 // Run the DB updates
2155                 // Because we have locked the image row, key conflicts should be rare.
2156                 // If they do occur, we can roll back the transaction at this time with
2157                 // no data loss, but leaving unregistered files scattered throughout the
2158                 // public zone.
2159                 // This is not ideal, which is why it's important to lock the image row.
2160                 if ( $insertCurrent ) {
2161                         $dbw->insert( 'image', $insertCurrent, __METHOD__ );
2162                 }
2163
2164                 if ( $insertBatch ) {
2165                         $dbw->insert( 'oldimage', $insertBatch, __METHOD__ );
2166                 }
2167
2168                 if ( $deleteIds ) {
2169                         $dbw->delete( 'filearchive',
2170                                 array( 'fa_id IN (' . $dbw->makeList( $deleteIds ) . ')' ),
2171                                 __METHOD__ );
2172                 }
2173
2174                 // If store batch is empty (all files are missing), deletion is to be considered successful
2175                 if ( $status->successCount > 0 || !$storeBatch ) {
2176                         if ( !$exists ) {
2177                                 wfDebug( __METHOD__ . " restored {$status->successCount} items, creating a new current\n" );
2178
2179                                 DeferredUpdates::addUpdate( SiteStatsUpdate::factory( array( 'images' => 1 ) ) );
2180
2181                                 $this->file->purgeEverything();
2182                         } else {
2183                                 wfDebug( __METHOD__ . " restored {$status->successCount} as archived versions\n" );
2184                                 $this->file->purgeDescription();
2185                                 $this->file->purgeHistory();
2186                         }
2187                 }
2188
2189                 $this->file->unlock();
2190
2191                 return $status;
2192         }
2193
2194         /**
2195          * Removes non-existent files from a store batch.
2196          * @param $triplets array
2197          * @return array
2198          */
2199         function removeNonexistentFiles( $triplets ) {
2200                 $files = $filteredTriplets = array();
2201                 foreach ( $triplets as $file ) {
2202                         $files[$file[0]] = $file[0];
2203                 }
2204
2205                 $result = $this->file->repo->fileExistsBatch( $files );
2206
2207                 foreach ( $triplets as $file ) {
2208                         if ( $result[$file[0]] ) {
2209                                 $filteredTriplets[] = $file;
2210                         }
2211                 }
2212
2213                 return $filteredTriplets;
2214         }
2215
2216         /**
2217          * Removes non-existent files from a cleanup batch.
2218          * @param $batch array
2219          * @return array
2220          */
2221         function removeNonexistentFromCleanup( $batch ) {
2222                 $files = $newBatch = array();
2223                 $repo = $this->file->repo;
2224
2225                 foreach ( $batch as $file ) {
2226                         $files[$file] = $repo->getVirtualUrl( 'deleted' ) . '/' .
2227                                 rawurlencode( $repo->getDeletedHashPath( $file ) . $file );
2228                 }
2229
2230                 $result = $repo->fileExistsBatch( $files );
2231
2232                 foreach ( $batch as $file ) {
2233                         if ( $result[$file] ) {
2234                                 $newBatch[] = $file;
2235                         }
2236                 }
2237
2238                 return $newBatch;
2239         }
2240
2241         /**
2242          * Delete unused files in the deleted zone.
2243          * This should be called from outside the transaction in which execute() was called.
2244          * @return FileRepoStatus|void
2245          */
2246         function cleanup() {
2247                 if ( !$this->cleanupBatch ) {
2248                         return $this->file->repo->newGood();
2249                 }
2250
2251                 $this->cleanupBatch = $this->removeNonexistentFromCleanup( $this->cleanupBatch );
2252
2253                 $status = $this->file->repo->cleanupDeletedBatch( $this->cleanupBatch );
2254
2255                 return $status;
2256         }
2257
2258         /**
2259          * Cleanup a failed batch. The batch was only partially successful, so
2260          * rollback by removing all items that were succesfully copied.
2261          *
2262          * @param Status $storeStatus
2263          * @param array $storeBatch
2264          */
2265         function cleanupFailedBatch( $storeStatus, $storeBatch ) {
2266                 $cleanupBatch = array();
2267
2268                 foreach ( $storeStatus->success as $i => $success ) {
2269                         // Check if this item of the batch was successfully copied
2270                         if ( $success ) {
2271                                 // Item was successfully copied and needs to be removed again
2272                                 // Extract ($dstZone, $dstRel) from the batch
2273                                 $cleanupBatch[] = array( $storeBatch[$i][1], $storeBatch[$i][2] );
2274                         }
2275                 }
2276                 $this->file->repo->cleanupBatch( $cleanupBatch );
2277         }
2278 }
2279
2280 # ------------------------------------------------------------------------------
2281
2282 /**
2283  * Helper class for file movement
2284  * @ingroup FileAbstraction
2285  */
2286 class LocalFileMoveBatch {
2287
2288         /**
2289          * @var LocalFile
2290          */
2291         var $file;
2292
2293         /**
2294          * @var Title
2295          */
2296         var $target;
2297
2298         var $cur, $olds, $oldCount, $archive;
2299
2300         /**
2301          * @var DatabaseBase
2302          */
2303         var $db;
2304
2305         /**
2306          * @param File $file
2307          * @param Title $target
2308          */
2309         function __construct( File $file, Title $target ) {
2310                 $this->file = $file;
2311                 $this->target = $target;
2312                 $this->oldHash = $this->file->repo->getHashPath( $this->file->getName() );
2313                 $this->newHash = $this->file->repo->getHashPath( $this->target->getDBkey() );
2314                 $this->oldName = $this->file->getName();
2315                 $this->newName = $this->file->repo->getNameFromTitle( $this->target );
2316                 $this->oldRel = $this->oldHash . $this->oldName;
2317                 $this->newRel = $this->newHash . $this->newName;
2318                 $this->db = $file->getRepo()->getMasterDb();
2319         }
2320
2321         /**
2322          * Add the current image to the batch
2323          */
2324         function addCurrent() {
2325                 $this->cur = array( $this->oldRel, $this->newRel );
2326         }
2327
2328         /**
2329          * Add the old versions of the image to the batch
2330          * @return Array List of archive names from old versions
2331          */
2332         function addOlds() {
2333                 $archiveBase = 'archive';
2334                 $this->olds = array();
2335                 $this->oldCount = 0;
2336                 $archiveNames = array();
2337
2338                 $result = $this->db->select( 'oldimage',
2339                         array( 'oi_archive_name', 'oi_deleted' ),
2340                         array( 'oi_name' => $this->oldName ),
2341                         __METHOD__
2342                 );
2343
2344                 foreach ( $result as $row ) {
2345                         $archiveNames[] = $row->oi_archive_name;
2346                         $oldName = $row->oi_archive_name;
2347                         $bits = explode( '!', $oldName, 2 );
2348
2349                         if ( count( $bits ) != 2 ) {
2350                                 wfDebug( "Old file name missing !: '$oldName' \n" );
2351                                 continue;
2352                         }
2353
2354                         list( $timestamp, $filename ) = $bits;
2355
2356                         if ( $this->oldName != $filename ) {
2357                                 wfDebug( "Old file name doesn't match: '$oldName' \n" );
2358                                 continue;
2359                         }
2360
2361                         $this->oldCount++;
2362
2363                         // Do we want to add those to oldCount?
2364                         if ( $row->oi_deleted & File::DELETED_FILE ) {
2365                                 continue;
2366                         }
2367
2368                         $this->olds[] = array(
2369                                 "{$archiveBase}/{$this->oldHash}{$oldName}",
2370                                 "{$archiveBase}/{$this->newHash}{$timestamp}!{$this->newName}"
2371                         );
2372                 }
2373
2374                 return $archiveNames;
2375         }
2376
2377         /**
2378          * Perform the move.
2379          * @return FileRepoStatus
2380          */
2381         function execute() {
2382                 $repo = $this->file->repo;
2383                 $status = $repo->newGood();
2384
2385                 $triplets = $this->getMoveTriplets();
2386                 $triplets = $this->removeNonexistentFiles( $triplets );
2387
2388                 $this->file->lock(); // begin
2389                 // Rename the file versions metadata in the DB.
2390                 // This implicitly locks the destination file, which avoids race conditions.
2391                 // If we moved the files from A -> C before DB updates, another process could
2392                 // move files from B -> C at this point, causing storeBatch() to fail and thus
2393                 // cleanupTarget() to trigger. It would delete the C files and cause data loss.
2394                 $statusDb = $this->doDBUpdates();
2395                 if ( !$statusDb->isGood() ) {
2396                         $this->file->unlockAndRollback();
2397                         $statusDb->ok = false;
2398                         return $statusDb;
2399                 }
2400                 wfDebugLog( 'imagemove', "Renamed {$this->file->getName()} in database: {$statusDb->successCount} successes, {$statusDb->failCount} failures" );
2401
2402                 // Copy the files into their new location.
2403                 // If a prior process fataled copying or cleaning up files we tolerate any
2404                 // of the existing files if they are identical to the ones being stored.
2405                 $statusMove = $repo->storeBatch( $triplets, FileRepo::OVERWRITE_SAME );
2406                 wfDebugLog( 'imagemove', "Moved files for {$this->file->getName()}: {$statusMove->successCount} successes, {$statusMove->failCount} failures" );
2407                 if ( !$statusMove->isGood() ) {
2408                         // Delete any files copied over (while the destination is still locked)
2409                         $this->cleanupTarget( $triplets );
2410                         $this->file->unlockAndRollback(); // unlocks the destination
2411                         wfDebugLog( 'imagemove', "Error in moving files: " . $statusMove->getWikiText() );
2412                         $statusMove->ok = false;
2413                         return $statusMove;
2414                 }
2415                 $this->file->unlock(); // done
2416
2417                 // Everything went ok, remove the source files
2418                 $this->cleanupSource( $triplets );
2419
2420                 $status->merge( $statusDb );
2421                 $status->merge( $statusMove );
2422
2423                 return $status;
2424         }
2425
2426         /**
2427          * Do the database updates and return a new FileRepoStatus indicating how
2428          * many rows where updated.
2429          *
2430          * @return FileRepoStatus
2431          */
2432         function doDBUpdates() {
2433                 $repo = $this->file->repo;
2434                 $status = $repo->newGood();
2435                 $dbw = $this->db;
2436
2437                 // Update current image
2438                 $dbw->update(
2439                         'image',
2440                         array( 'img_name' => $this->newName ),
2441                         array( 'img_name' => $this->oldName ),
2442                         __METHOD__
2443                 );
2444
2445                 if ( $dbw->affectedRows() ) {
2446                         $status->successCount++;
2447                 } else {
2448                         $status->failCount++;
2449                         $status->fatal( 'imageinvalidfilename' );
2450                         return $status;
2451                 }
2452
2453                 // Update old images
2454                 $dbw->update(
2455                         'oldimage',
2456                         array(
2457                                 'oi_name' => $this->newName,
2458                                 'oi_archive_name = ' . $dbw->strreplace( 'oi_archive_name',
2459                                         $dbw->addQuotes( $this->oldName ), $dbw->addQuotes( $this->newName ) ),
2460                         ),
2461                         array( 'oi_name' => $this->oldName ),
2462                         __METHOD__
2463                 );
2464
2465                 $affected = $dbw->affectedRows();
2466                 $total = $this->oldCount;
2467                 $status->successCount += $affected;
2468                 // Bug 34934: $total is based on files that actually exist.
2469                 // There may be more DB rows than such files, in which case $affected
2470                 // can be greater than $total. We use max() to avoid negatives here.
2471                 $status->failCount += max( 0, $total - $affected );
2472                 if ( $status->failCount ) {
2473                         $status->error( 'imageinvalidfilename' );
2474                 }
2475
2476                 return $status;
2477         }
2478
2479         /**
2480          * Generate triplets for FileRepo::storeBatch().
2481          * @return array
2482          */
2483         function getMoveTriplets() {
2484                 $moves = array_merge( array( $this->cur ), $this->olds );
2485                 $triplets = array();    // The format is: (srcUrl, destZone, destUrl)
2486
2487                 foreach ( $moves as $move ) {
2488                         // $move: (oldRelativePath, newRelativePath)
2489                         $srcUrl = $this->file->repo->getVirtualUrl() . '/public/' . rawurlencode( $move[0] );
2490                         $triplets[] = array( $srcUrl, 'public', $move[1] );
2491                         wfDebugLog( 'imagemove', "Generated move triplet for {$this->file->getName()}: {$srcUrl} :: public :: {$move[1]}" );
2492                 }
2493
2494                 return $triplets;
2495         }
2496
2497         /**
2498          * Removes non-existent files from move batch.
2499          * @param $triplets array
2500          * @return array
2501          */
2502         function removeNonexistentFiles( $triplets ) {
2503                 $files = array();
2504
2505                 foreach ( $triplets as $file ) {
2506                         $files[$file[0]] = $file[0];
2507                 }
2508
2509                 $result = $this->file->repo->fileExistsBatch( $files );
2510                 $filteredTriplets = array();
2511
2512                 foreach ( $triplets as $file ) {
2513                         if ( $result[$file[0]] ) {
2514                                 $filteredTriplets[] = $file;
2515                         } else {
2516                                 wfDebugLog( 'imagemove', "File {$file[0]} does not exist" );
2517                         }
2518                 }
2519
2520                 return $filteredTriplets;
2521         }
2522
2523         /**
2524          * Cleanup a partially moved array of triplets by deleting the target
2525          * files. Called if something went wrong half way.
2526          */
2527         function cleanupTarget( $triplets ) {
2528                 // Create dest pairs from the triplets
2529                 $pairs = array();
2530                 foreach ( $triplets as $triplet ) {
2531                         // $triplet: (old source virtual URL, dst zone, dest rel)
2532                         $pairs[] = array( $triplet[1], $triplet[2] );
2533                 }
2534
2535                 $this->file->repo->cleanupBatch( $pairs );
2536         }
2537
2538         /**
2539          * Cleanup a fully moved array of triplets by deleting the source files.
2540          * Called at the end of the move process if everything else went ok.
2541          */
2542         function cleanupSource( $triplets ) {
2543                 // Create source file names from the triplets
2544                 $files = array();
2545                 foreach ( $triplets as $triplet ) {
2546                         $files[] = $triplet[0];
2547                 }
2548
2549                 $this->file->repo->cleanupBatch( $files );
2550         }
2551 }