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                                 || strpos( $file, "-thumbnail" ) !== false // "short" thumb name
 819                         ) {
 820                                 $purgeList[] = "{$dir}/{$file}";
 821                         }
 822                 }
 823
 824                 # Delete the thumbnails
 825                 $this->repo->quickPurgeBatch( $purgeList );
 826                 # Clear out the thumbnail directory if empty
 827                 $this->repo->quickCleanDir( $dir );
 828         }
 829
 830         /** purgeDescription inherited */
 831         /** purgeEverything inherited */
 832
 833         /**
 834          * @param $limit null
 835          * @param $start null
 836          * @param $end null
 837          * @param $inc bool
 838          * @return array
 839          */
 840         function getHistory( $limit = null, $start = null, $end = null, $inc = true ) {
 841                 $dbr = $this->repo->getSlaveDB();
 842                 $tables = array( 'oldimage' );
 843                 $fields = OldLocalFile::selectFields();
 844                 $conds = $opts = $join_conds = array();
 845                 $eq = $inc ? '=' : '';
 846                 $conds[] = "oi_name = " . $dbr->addQuotes( $this->title->getDBkey() );
 847
 848                 if ( $start ) {
 849                         $conds[] = "oi_timestamp <$eq " . $dbr->addQuotes( $dbr->timestamp( $start ) );
 850                 }
 851
 852                 if ( $end ) {
 853                         $conds[] = "oi_timestamp >$eq " . $dbr->addQuotes( $dbr->timestamp( $end ) );
 854                 }
 855
 856                 if ( $limit ) {
 857                         $opts['LIMIT'] = $limit;
 858                 }
 859
 860                 // Search backwards for time > x queries
 861                 $order = ( !$start && $end !== null ) ? 'ASC' : 'DESC';
 862                 $opts['ORDER BY'] = "oi_timestamp $order";
 863                 $opts['USE INDEX'] = array( 'oldimage' => 'oi_name_timestamp' );
 864
 865                 wfRunHooks( 'LocalFile::getHistory', array( &$this, &$tables, &$fields,
 866                         &$conds, &$opts, &$join_conds ) );
 867
 868                 $res = $dbr->select( $tables, $fields, $conds, __METHOD__, $opts, $join_conds );
 869                 $r = array();
 870
 871                 foreach ( $res as $row ) {
 872                         if ( $this->repo->oldFileFromRowFactory ) {
 873                                 $r[] = call_user_func( $this->repo->oldFileFromRowFactory, $row, $this->repo );
 874                         } else {
 875                                 $r[] = OldLocalFile::newFromRow( $row, $this->repo );
 876                         }
 877                 }
 878
 879                 if ( $order == 'ASC' ) {
 880                         $r = array_reverse( $r ); // make sure it ends up descending
 881                 }
 882
 883                 return $r;
 884         }
 885
 886         /**
 887          * Return the history of this file, line by line.
 888          * starts with current version, then old versions.
 889          * uses $this->historyLine to check which line to return:
 890          *  0      return line for current version
 891          *  1      query for old versions, return first one
 892          *  2, ... return next old version from above query
 893          * @return bool
 894          */
 895         public function nextHistoryLine() {
 896                 # Polymorphic function name to distinguish foreign and local fetches
 897                 $fname = get_class( $this ) . '::' . __FUNCTION__;
 898
 899                 $dbr = $this->repo->getSlaveDB();
 900
 901                 if ( $this->historyLine == 0 ) {// called for the first time, return line from cur
 902                         $this->historyRes = $dbr->select( 'image',
 903                                 array(
 904                                         '*',
 905                                         "'' AS oi_archive_name",
 906                                         '0 as oi_deleted',
 907                                         'img_sha1'
 908                                 ),
 909                                 array( 'img_name' => $this->title->getDBkey() ),
 910                                 $fname
 911                         );
 912
 913                         if ( 0 == $dbr->numRows( $this->historyRes ) ) {
 914                                 $this->historyRes = null;
 915                                 return false;
 916                         }
 917                 } elseif ( $this->historyLine == 1 ) {
 918                         $this->historyRes = $dbr->select( 'oldimage', '*',
 919                                 array( 'oi_name' => $this->title->getDBkey() ),
 920                                 $fname,
 921                                 array( 'ORDER BY' => 'oi_timestamp DESC' )
 922                         );
 923                 }
 924                 $this->historyLine ++;
 925
 926                 return $dbr->fetchObject( $this->historyRes );
 927         }
 928
 929         /**
 930          * Reset the history pointer to the first element of the history
 931          */
 932         public function resetHistory() {
 933                 $this->historyLine = 0;
 934
 935                 if ( !is_null( $this->historyRes ) ) {
 936                         $this->historyRes = null;
 937                 }
 938         }
 939
 940         /** getHashPath inherited */
 941         /** getRel inherited */
 942         /** getUrlRel inherited */
 943         /** getArchiveRel inherited */
 944         /** getArchivePath inherited */
 945         /** getThumbPath inherited */
 946         /** getArchiveUrl inherited */
 947         /** getThumbUrl inherited */
 948         /** getArchiveVirtualUrl inherited */
 949         /** getThumbVirtualUrl inherited */
 950         /** isHashed inherited */
 951
 952         /**
 953          * Upload a file and record it in the DB
 954          * @param $srcPath String: source storage path, virtual URL, or filesystem path
 955          * @param $comment String: upload description
 956          * @param $pageText String: text to use for the new description page,
 957          *                  if a new description page is created
 958          * @param $flags Integer|bool: flags for publish()
 959          * @param $props Array|bool: File properties, if known. This can be used to reduce the
 960          *               upload time when uploading virtual URLs for which the file info
 961          *               is already known
 962          * @param $timestamp String|bool: timestamp for img_timestamp, or false to use the current time
 963          * @param $user User|null: User object or null to use $wgUser
 964          *
 965          * @return FileRepoStatus object. On success, the value member contains the
 966          *     archive name, or an empty string if it was a new file.
 967          */
 968         function upload( $srcPath, $comment, $pageText, $flags = 0, $props = false, $timestamp = false, $user = null ) {
 969                 global $wgContLang;
 970
 971                 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
 972                         return $this->readOnlyFatalStatus();
 973                 }
 974
 975                 if ( !$props ) {
 976                         wfProfileIn( __METHOD__ . '-getProps' );
 977                         $props = FileBackend::isStoragePath( $srcPath )
 978                                 ? $this->repo->getFileProps( $srcPath )
 979                                 : FSFile::getPropsFromPath( $srcPath );
 980                         wfProfileOut( __METHOD__ . '-getProps' );
 981                 }
 982
 983                 $options = array();
 984                 $handler = MediaHandler::getHandler( $props['mime'] );
 985                 if ( $handler ) {
 986                         $options['headers'] = $handler->getStreamHeaders( $props['metadata'] );
 987                 } else {
 988                         $options['headers'] = array();
 989                 }
 990
 991                 // truncate nicely or the DB will do it for us
 992                 // non-nicely (dangling multi-byte chars, non-truncated version in cache).
 993                 $comment = $wgContLang->truncate( $comment, 255 );
 994                 $this->lock(); // begin
 995                 $status = $this->publish( $srcPath, $flags, $options );
 996
 997                 if ( $status->successCount > 0 ) {
 998                         # Essentially we are displacing any existing current file and saving
 999                         # a new current file at the old location. If just the first succeeded,
1000                         # we still need to displace the current DB entry and put in a new one.
1001                         if ( !$this->recordUpload2( $status->value, $comment, $pageText, $props, $timestamp, $user ) ) {
1002                                 $status->fatal( 'filenotfound', $srcPath );
1003                         }
1004                 }
1005
1006                 $this->unlock(); // done
1007
1008                 return $status;
1009         }
1010
1011         /**
1012          * Record a file upload in the upload log and the image table
1013          * @param $oldver
1014          * @param $desc string
1015          * @param $license string
1016          * @param $copyStatus string
1017          * @param $source string
1018          * @param $watch bool
1019          * @param $timestamp string|bool
1020          * @return bool
1021          */
1022         function recordUpload( $oldver, $desc, $license = '', $copyStatus = '', $source = '',
1023                 $watch = false, $timestamp = false )
1024         {
1025                 $pageText = SpecialUpload::getInitialPageText( $desc, $license, $copyStatus, $source );
1026
1027                 if ( !$this->recordUpload2( $oldver, $desc, $pageText, false, $timestamp ) ) {
1028                         return false;
1029                 }
1030
1031                 if ( $watch ) {
1032                         global $wgUser;
1033                         $wgUser->addWatch( $this->getTitle() );
1034                 }
1035                 return true;
1036         }
1037
1038         /**
1039          * Record a file upload in the upload log and the image table
1040          * @param $oldver
1041          * @param $comment string
1042          * @param $pageText string
1043          * @param $props bool|array
1044          * @param $timestamp bool|string
1045          * @param $user null|User
1046          * @return bool
1047          */
1048         function recordUpload2(
1049                 $oldver, $comment, $pageText, $props = false, $timestamp = false, $user = null
1050         ) {
1051                 wfProfileIn( __METHOD__ );
1052
1053                 if ( is_null( $user ) ) {
1054                         global $wgUser;
1055                         $user = $wgUser;
1056                 }
1057
1058                 $dbw = $this->repo->getMasterDB();
1059                 $dbw->begin( __METHOD__ );
1060
1061                 if ( !$props ) {
1062                         wfProfileIn( __METHOD__ . '-getProps' );
1063                         $props = $this->repo->getFileProps( $this->getVirtualUrl() );
1064                         wfProfileOut( __METHOD__ . '-getProps' );
1065                 }
1066
1067                 if ( $timestamp === false ) {
1068                         $timestamp = $dbw->timestamp();
1069                 }
1070
1071                 $props['description'] = $comment;
1072                 $props['user'] = $user->getId();
1073                 $props['user_text'] = $user->getName();
1074                 $props['timestamp'] = wfTimestamp( TS_MW, $timestamp ); // DB -> TS_MW
1075                 $this->setProps( $props );
1076
1077                 # Fail now if the file isn't there
1078                 if ( !$this->fileExists ) {
1079                         wfDebug( __METHOD__ . ": File " . $this->getRel() . " went missing!\n" );
1080                         wfProfileOut( __METHOD__ );
1081                         return false;
1082                 }
1083
1084                 $reupload = false;
1085
1086                 # Test to see if the row exists using INSERT IGNORE
1087                 # This avoids race conditions by locking the row until the commit, and also
1088                 # doesn't deadlock. SELECT FOR UPDATE causes a deadlock for every race condition.
1089                 $dbw->insert( 'image',
1090                         array(
1091                                 'img_name'        => $this->getName(),
1092                                 'img_size'        => $this->size,
1093                                 'img_width'       => intval( $this->width ),
1094                                 'img_height'      => intval( $this->height ),
1095                                 'img_bits'        => $this->bits,
1096                                 'img_media_type'  => $this->media_type,
1097                                 'img_major_mime'  => $this->major_mime,
1098                                 'img_minor_mime'  => $this->minor_mime,
1099                                 'img_timestamp'   => $timestamp,
1100                                 'img_description' => $comment,
1101                                 'img_user'        => $user->getId(),
1102                                 'img_user_text'   => $user->getName(),
1103                                 'img_metadata'    => $this->metadata,
1104                                 'img_sha1'        => $this->sha1
1105                         ),
1106                         __METHOD__,
1107                         'IGNORE'
1108                 );
1109                 if ( $dbw->affectedRows() == 0 ) {
1110                         # (bug 34993) Note: $oldver can be empty here, if the previous
1111                         # version of the file was broken. Allow registration of the new
1112                         # version to continue anyway, because that's better than having
1113                         # an image that's not fixable by user operations.
1114
1115                         $reupload = true;
1116                         # Collision, this is an update of a file
1117                         # Insert previous contents into oldimage
1118                         $dbw->insertSelect( 'oldimage', 'image',
1119                                 array(
1120                                         'oi_name'         => 'img_name',
1121                                         'oi_archive_name' => $dbw->addQuotes( $oldver ),
1122                                         'oi_size'         => 'img_size',
1123                                         'oi_width'        => 'img_width',
1124                                         'oi_height'       => 'img_height',
1125                                         'oi_bits'         => 'img_bits',
1126                                         'oi_timestamp'    => 'img_timestamp',
1127                                         'oi_description'  => 'img_description',
1128                                         'oi_user'         => 'img_user',
1129                                         'oi_user_text'    => 'img_user_text',
1130                                         'oi_metadata'     => 'img_metadata',
1131                                         'oi_media_type'   => 'img_media_type',
1132                                         'oi_major_mime'   => 'img_major_mime',
1133                                         'oi_minor_mime'   => 'img_minor_mime',
1134                                         'oi_sha1'         => 'img_sha1'
1135                                 ),
1136                                 array( 'img_name' => $this->getName() ),
1137                                 __METHOD__
1138                         );
1139
1140                         # Update the current image row
1141                         $dbw->update( 'image',
1142                                 array( /* SET */
1143                                         'img_size'        => $this->size,
1144                                         'img_width'       => intval( $this->width ),
1145                                         'img_height'      => intval( $this->height ),
1146                                         'img_bits'        => $this->bits,
1147                                         'img_media_type'  => $this->media_type,
1148                                         'img_major_mime'  => $this->major_mime,
1149                                         'img_minor_mime'  => $this->minor_mime,
1150                                         'img_timestamp'   => $timestamp,
1151                                         'img_description' => $comment,
1152                                         'img_user'        => $user->getId(),
1153                                         'img_user_text'   => $user->getName(),
1154                                         'img_metadata'    => $this->metadata,
1155                                         'img_sha1'        => $this->sha1
1156                                 ),
1157                                 array( 'img_name' => $this->getName() ),
1158                                 __METHOD__
1159                         );
1160                 } else {
1161                         # This is a new file, so update the image count
1162                         DeferredUpdates::addUpdate( SiteStatsUpdate::factory( array( 'images' => 1 ) ) );
1163                 }
1164
1165                 $descTitle = $this->getTitle();
1166                 $wikiPage = new WikiFilePage( $descTitle );
1167                 $wikiPage->setFile( $this );
1168
1169                 # Add the log entry
1170                 $log = new LogPage( 'upload' );
1171                 $action = $reupload ? 'overwrite' : 'upload';
1172                 $logId = $log->addEntry( $action, $descTitle, $comment, array(), $user );
1173
1174                 wfProfileIn( __METHOD__ . '-edit' );
1175                 $exists = $descTitle->exists();
1176
1177                 if ( $exists ) {
1178                         # Create a null revision
1179                         $latest = $descTitle->getLatestRevID();
1180                         $nullRevision = Revision::newNullRevision(
1181                                 $dbw,
1182                                 $descTitle->getArticleID(),
1183                                 $log->getRcComment(),
1184                                 false
1185                         );
1186                         if (!is_null($nullRevision)) {
1187                                 $nullRevision->insertOn( $dbw );
1188
1189                                 wfRunHooks( 'NewRevisionFromEditComplete', array( $wikiPage, $nullRevision, $latest, $user ) );
1190                                 $wikiPage->updateRevisionOn( $dbw, $nullRevision );
1191                         }
1192                 }
1193
1194                 # Commit the transaction now, in case something goes wrong later
1195                 # The most important thing is that files don't get lost, especially archives
1196                 # NOTE: once we have support for nested transactions, the commit may be moved
1197                 #       to after $wikiPage->doEdit has been called.
1198                 $dbw->commit( __METHOD__ );
1199
1200                 if ( $exists ) {
1201                         # Invalidate the cache for the description page
1202                         $descTitle->invalidateCache();
1203                         $descTitle->purgeSquid();
1204                 } else {
1205                         # New file; create the description page.
1206                         # There's already a log entry, so don't make a second RC entry
1207                         # Squid and file cache for the description page are purged by doEditContent.
1208                         $content = ContentHandler::makeContent( $pageText, $descTitle );
1209                         $status = $wikiPage->doEditContent( $content, $comment, EDIT_NEW | EDIT_SUPPRESS_RC, false, $user );
1210
1211                         if ( isset( $status->value['revision'] ) ) { // XXX; doEdit() uses a transaction
1212                                 $dbw->begin();
1213                                 $dbw->update( 'logging',
1214                                         array( 'log_page' => $status->value['revision']->getPage() ),
1215                                         array( 'log_id' => $logId ),
1216                                         __METHOD__
1217                                 );
1218                                 $dbw->commit(); // commit before anything bad can happen
1219                         }
1220                 }
1221                 wfProfileOut( __METHOD__ . '-edit' );
1222
1223                 # Save to cache and purge the squid
1224                 # We shall not saveToCache before the commit since otherwise
1225                 # in case of a rollback there is an usable file from memcached
1226                 # which in fact doesn't really exist (bug 24978)
1227                 $this->saveToCache();
1228
1229                 if ( $reupload ) {
1230                         # Delete old thumbnails
1231                         wfProfileIn( __METHOD__ . '-purge' );
1232                         $this->purgeThumbnails();
1233                         wfProfileOut( __METHOD__ . '-purge' );
1234
1235                         # Remove the old file from the squid cache
1236                         SquidUpdate::purge( array( $this->getURL() ) );
1237                 }
1238
1239                 # Hooks, hooks, the magic of hooks...
1240                 wfProfileIn( __METHOD__ . '-hooks' );
1241                 wfRunHooks( 'FileUpload', array( $this, $reupload, $descTitle->exists() ) );
1242                 wfProfileOut( __METHOD__ . '-hooks' );
1243
1244                 # Invalidate cache for all pages using this file
1245                 $update = new HTMLCacheUpdate( $this->getTitle(), 'imagelinks' );
1246                 $update->doUpdate();
1247
1248                 # Invalidate cache for all pages that redirects on this page
1249                 $redirs = $this->getTitle()->getRedirectsHere();
1250
1251                 foreach ( $redirs as $redir ) {
1252                         $update = new HTMLCacheUpdate( $redir, 'imagelinks' );
1253                         $update->doUpdate();
1254                 }
1255
1256                 wfProfileOut( __METHOD__ );
1257                 return true;
1258         }
1259
1260         /**
1261          * Move or copy a file to its public location. If a file exists at the
1262          * destination, move it to an archive. Returns a FileRepoStatus object with
1263          * the archive name in the "value" member on success.
1264          *
1265          * The archive name should be passed through to recordUpload for database
1266          * registration.
1267          *
1268          * @param $srcPath String: local filesystem path to the source image
1269          * @param $flags Integer: a bitwise combination of:
1270          *     File::DELETE_SOURCE      Delete the source file, i.e. move rather than copy
1271          * @param $options Array Optional additional parameters
1272          * @return FileRepoStatus object. On success, the value member contains the
1273          *     archive name, or an empty string if it was a new file.
1274          */
1275         function publish( $srcPath, $flags = 0, array $options = array() ) {
1276                 return $this->publishTo( $srcPath, $this->getRel(), $flags, $options );
1277         }
1278
1279         /**
1280          * Move or copy a file to a specified location. Returns a FileRepoStatus
1281          * object with the archive name in the "value" member on success.
1282          *
1283          * The archive name should be passed through to recordUpload for database
1284          * registration.
1285          *
1286          * @param $srcPath String: local filesystem path to the source image
1287          * @param $dstRel String: target relative path
1288          * @param $flags Integer: a bitwise combination of:
1289          *     File::DELETE_SOURCE      Delete the source file, i.e. move rather than copy
1290          * @param $options Array Optional additional parameters
1291          * @return FileRepoStatus object. On success, the value member contains the
1292          *     archive name, or an empty string if it was a new file.
1293          */
1294         function publishTo( $srcPath, $dstRel, $flags = 0, array $options = array() ) {
1295                 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
1296                         return $this->readOnlyFatalStatus();
1297                 }
1298
1299                 $this->lock(); // begin
1300
1301                 $archiveName = wfTimestamp( TS_MW ) . '!'. $this->getName();
1302                 $archiveRel = 'archive/' . $this->getHashPath() . $archiveName;
1303                 $flags = $flags & File::DELETE_SOURCE ? LocalRepo::DELETE_SOURCE : 0;
1304                 $status = $this->repo->publish( $srcPath, $dstRel, $archiveRel, $flags, $options );
1305
1306                 if ( $status->value == 'new' ) {
1307                         $status->value = '';
1308                 } else {
1309                         $status->value = $archiveName;
1310                 }
1311
1312                 $this->unlock(); // done
1313
1314                 return $status;
1315         }
1316
1317         /** getLinksTo inherited */
1318         /** getExifData inherited */
1319         /** isLocal inherited */
1320         /** wasDeleted inherited */
1321
1322         /**
1323          * Move file to the new title
1324          *
1325          * Move current, old version and all thumbnails
1326          * to the new filename. Old file is deleted.
1327          *
1328          * Cache purging is done; checks for validity
1329          * and logging are caller's responsibility
1330          *
1331          * @param $target Title New file name
1332          * @return FileRepoStatus object.
1333          */
1334         function move( $target ) {
1335                 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
1336                         return $this->readOnlyFatalStatus();
1337                 }
1338
1339                 wfDebugLog( 'imagemove', "Got request to move {$this->name} to " . $target->getText() );
1340                 $batch = new LocalFileMoveBatch( $this, $target );
1341
1342                 $this->lock(); // begin
1343                 $batch->addCurrent();
1344                 $archiveNames = $batch->addOlds();
1345                 $status = $batch->execute();
1346                 $this->unlock(); // done
1347
1348                 wfDebugLog( 'imagemove', "Finished moving {$this->name}" );
1349
1350                 $this->purgeEverything();
1351                 foreach ( $archiveNames as $archiveName ) {
1352                         $this->purgeOldThumbnails( $archiveName );
1353                 }
1354                 if ( $status->isOK() ) {
1355                         // Now switch the object
1356                         $this->title = $target;
1357                         // Force regeneration of the name and hashpath
1358                         unset( $this->name );
1359                         unset( $this->hashPath );
1360                         // Purge the new image
1361                         $this->purgeEverything();
1362                 }
1363
1364                 return $status;
1365         }
1366
1367         /**
1368          * Delete all versions of the file.
1369          *
1370          * Moves the files into an archive directory (or deletes them)
1371          * and removes the database rows.
1372          *
1373          * Cache purging is done; logging is caller's responsibility.
1374          *
1375          * @param $reason
1376          * @param $suppress
1377          * @return FileRepoStatus object.
1378          */
1379         function delete( $reason, $suppress = false ) {
1380                 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
1381                         return $this->readOnlyFatalStatus();
1382                 }
1383
1384                 $batch = new LocalFileDeleteBatch( $this, $reason, $suppress );
1385
1386                 $this->lock(); // begin
1387                 $batch->addCurrent();
1388                 # Get old version relative paths
1389                 $archiveNames = $batch->addOlds();
1390                 $status = $batch->execute();
1391                 $this->unlock(); // done
1392
1393                 if ( $status->isOK() ) {
1394                         DeferredUpdates::addUpdate( SiteStatsUpdate::factory( array( 'images' => -1 ) ) );
1395                 }
1396
1397                 $this->purgeEverything();
1398                 foreach ( $archiveNames as $archiveName ) {
1399                         $this->purgeOldThumbnails( $archiveName );
1400                 }
1401
1402                 return $status;
1403         }
1404
1405         /**
1406          * Delete an old version of the file.
1407          *
1408          * Moves the file into an archive directory (or deletes it)
1409          * and removes the database row.
1410          *
1411          * Cache purging is done; logging is caller's responsibility.
1412          *
1413          * @param $archiveName String
1414          * @param $reason String
1415          * @param $suppress Boolean
1416          * @throws MWException or FSException on database or file store failure
1417          * @return FileRepoStatus object.
1418          */
1419         function deleteOld( $archiveName, $reason, $suppress = false ) {
1420                 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
1421                         return $this->readOnlyFatalStatus();
1422                 }
1423
1424                 $batch = new LocalFileDeleteBatch( $this, $reason, $suppress );
1425
1426                 $this->lock(); // begin
1427                 $batch->addOld( $archiveName );
1428                 $status = $batch->execute();
1429                 $this->unlock(); // done
1430
1431                 $this->purgeOldThumbnails( $archiveName );
1432                 if ( $status->isOK() ) {
1433                         $this->purgeDescription();
1434                         $this->purgeHistory();
1435                 }
1436
1437                 return $status;
1438         }
1439
1440         /**
1441          * Restore all or specified deleted revisions to the given file.
1442          * Permissions and logging are left to the caller.
1443          *
1444          * May throw database exceptions on error.
1445          *
1446          * @param $versions array set of record ids of deleted items to restore,
1447          *                    or empty to restore all revisions.
1448          * @param $unsuppress Boolean
1449          * @return FileRepoStatus
1450          */
1451         function restore( $versions = array(), $unsuppress = false ) {
1452                 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
1453                         return $this->readOnlyFatalStatus();
1454                 }
1455
1456                 $batch = new LocalFileRestoreBatch( $this, $unsuppress );
1457
1458                 $this->lock(); // begin
1459                 if ( !$versions ) {
1460                         $batch->addAll();
1461                 } else {
1462                         $batch->addIds( $versions );
1463                 }
1464                 $status = $batch->execute();
1465                 if ( $status->isGood() ) {
1466                         $cleanupStatus = $batch->cleanup();
1467                         $cleanupStatus->successCount = 0;
1468                         $cleanupStatus->failCount = 0;
1469                         $status->merge( $cleanupStatus );
1470                 }
1471                 $this->unlock(); // done
1472
1473                 return $status;
1474         }
1475
1476         /** isMultipage inherited */
1477         /** pageCount inherited */
1478         /** scaleHeight inherited */
1479         /** getImageSize inherited */
1480
1481         /**
1482          * Get the URL of the file description page.
1483          * @return String
1484          */
1485         function getDescriptionUrl() {
1486                 return $this->title->getLocalUrl();
1487         }
1488
1489         /**
1490          * Get the HTML text of the description page
1491          * This is not used by ImagePage for local files, since (among other things)
1492          * it skips the parser cache.
1493          * @return bool|mixed
1494          */
1495         function getDescriptionText() {
1496                 global $wgParser;
1497                 $revision = Revision::newFromTitle( $this->title, false, Revision::READ_NORMAL );
1498                 if ( !$revision ) return false;
1499                 $content = $revision->getContent();
1500                 if ( !$content ) return false;
1501                 $pout = $content->getParserOutput( $this->title, null, new ParserOptions() );
1502                 return $pout->getText();
1503         }
1504
1505         /**
1506          * @return string
1507          */
1508         function getDescription( $audience = self::FOR_PUBLIC, User $user = null ) {
1509                 $this->load();
1510                 if ( $audience == self::FOR_PUBLIC && $this->isDeleted( self::DELETED_COMMENT ) ) {
1511                         return '';
1512                 } elseif ( $audience == self::FOR_THIS_USER
1513                         && !$this->userCan( self::DELETED_COMMENT, $user ) )
1514                 {
1515                         return '';
1516                 } else {
1517                         return $this->description;
1518                 }
1519         }
1520
1521         /**
1522          * @return bool|string
1523          */
1524         function getTimestamp() {
1525                 $this->load();
1526                 return $this->timestamp;
1527         }
1528
1529         /**
1530          * @return string
1531          */
1532         function getSha1() {
1533                 $this->load();
1534                 // Initialise now if necessary
1535                 if ( $this->sha1 == '' && $this->fileExists ) {
1536                         $this->lock(); // begin
1537
1538                         $this->sha1 = $this->repo->getFileSha1( $this->getPath() );
1539                         if ( !wfReadOnly() && strval( $this->sha1 ) != '' ) {
1540                                 $dbw = $this->repo->getMasterDB();
1541                                 $dbw->update( 'image',
1542                                         array( 'img_sha1' => $this->sha1 ),
1543                                         array( 'img_name' => $this->getName() ),
1544                                         __METHOD__ );
1545                                 $this->saveToCache();
1546                         }
1547
1548                         $this->unlock(); // done
1549                 }
1550
1551                 return $this->sha1;
1552         }
1553
1554         /**
1555          * @return bool
1556          */
1557         function isCacheable() {
1558                 $this->load();
1559                 return strlen( $this->metadata ) <= self::CACHE_FIELD_MAX_LEN; // avoid OOMs
1560         }
1561
1562         /**
1563          * Start a transaction and lock the image for update
1564          * Increments a reference counter if the lock is already held
1565          * @return boolean True if the image exists, false otherwise
1566          */
1567         function lock() {
1568                 $dbw = $this->repo->getMasterDB();
1569
1570                 if ( !$this->locked ) {
1571                         $dbw->begin( __METHOD__ );
1572                         $this->locked++;
1573                 }
1574
1575                 return $dbw->selectField( 'image', '1',
1576                         array( 'img_name' => $this->getName() ), __METHOD__, array( 'FOR UPDATE' ) );
1577         }
1578
1579         /**
1580          * Decrement the lock reference count. If the reference count is reduced to zero, commits
1581          * the transaction and thereby releases the image lock.
1582          */
1583         function unlock() {
1584                 if ( $this->locked ) {
1585                         --$this->locked;
1586                         if ( !$this->locked ) {
1587                                 $dbw = $this->repo->getMasterDB();
1588                                 $dbw->commit( __METHOD__ );
1589                         }
1590                 }
1591         }
1592
1593         /**
1594          * Roll back the DB transaction and mark the image unlocked
1595          */
1596         function unlockAndRollback() {
1597                 $this->locked = false;
1598                 $dbw = $this->repo->getMasterDB();
1599                 $dbw->rollback( __METHOD__ );
1600         }
1601
1602         /**
1603          * @return Status
1604          */
1605         protected function readOnlyFatalStatus() {
1606                 return $this->getRepo()->newFatal( 'filereadonlyerror', $this->getName(),
1607                         $this->getRepo()->getName(), $this->getRepo()->getReadOnlyReason() );
1608         }
1609 } // LocalFile class
1610
1611 # ------------------------------------------------------------------------------
1612
1613 /**
1614  * Helper class for file deletion
1615  * @ingroup FileAbstraction
1616  */
1617 class LocalFileDeleteBatch {
1618
1619         /**
1620          * @var LocalFile
1621          */
1622         var $file;
1623
1624         var $reason, $srcRels = array(), $archiveUrls = array(), $deletionBatch, $suppress;
1625         var $status;
1626
1627         /**
1628          * @param $file File
1629          * @param $reason string
1630          * @param $suppress bool
1631          */
1632         function __construct( File $file, $reason = '', $suppress = false ) {
1633                 $this->file = $file;
1634                 $this->reason = $reason;
1635                 $this->suppress = $suppress;
1636                 $this->status = $file->repo->newGood();
1637         }
1638
1639         function addCurrent() {
1640                 $this->srcRels['.'] = $this->file->getRel();
1641         }
1642
1643         /**
1644          * @param $oldName string
1645          */
1646         function addOld( $oldName ) {
1647                 $this->srcRels[$oldName] = $this->file->getArchiveRel( $oldName );
1648                 $this->archiveUrls[] = $this->file->getArchiveUrl( $oldName );
1649         }
1650
1651         /**
1652          * Add the old versions of the image to the batch
1653          * @return Array List of archive names from old versions
1654          */
1655         function addOlds() {
1656                 $archiveNames = array();
1657
1658                 $dbw = $this->file->repo->getMasterDB();
1659                 $result = $dbw->select( 'oldimage',
1660                         array( 'oi_archive_name' ),
1661                         array( 'oi_name' => $this->file->getName() ),
1662                         __METHOD__
1663                 );
1664
1665                 foreach ( $result as $row ) {
1666                         $this->addOld( $row->oi_archive_name );
1667                         $archiveNames[] = $row->oi_archive_name;
1668                 }
1669
1670                 return $archiveNames;
1671         }
1672
1673         /**
1674          * @return array
1675          */
1676         function getOldRels() {
1677                 if ( !isset( $this->srcRels['.'] ) ) {
1678                         $oldRels =& $this->srcRels;
1679                         $deleteCurrent = false;
1680                 } else {
1681                         $oldRels = $this->srcRels;
1682                         unset( $oldRels['.'] );
1683                         $deleteCurrent = true;
1684                 }
1685
1686                 return array( $oldRels, $deleteCurrent );
1687         }
1688
1689         /**
1690          * @return array
1691          */
1692         protected function getHashes() {
1693                 $hashes = array();
1694                 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
1695
1696                 if ( $deleteCurrent ) {
1697                         $hashes['.'] = $this->file->getSha1();
1698                 }
1699
1700                 if ( count( $oldRels ) ) {
1701                         $dbw = $this->file->repo->getMasterDB();
1702                         $res = $dbw->select(
1703                                 'oldimage',
1704                                 array( 'oi_archive_name', 'oi_sha1' ),
1705                                 'oi_archive_name IN (' . $dbw->makeList( array_keys( $oldRels ) ) . ')',
1706                                 __METHOD__
1707                         );
1708
1709                         foreach ( $res as $row ) {
1710                                 if ( rtrim( $row->oi_sha1, "\0" ) === '' ) {
1711                                         // Get the hash from the file
1712                                         $oldUrl = $this->file->getArchiveVirtualUrl( $row->oi_archive_name );
1713                                         $props = $this->file->repo->getFileProps( $oldUrl );
1714
1715                                         if ( $props['fileExists'] ) {
1716                                                 // Upgrade the oldimage row
1717                                                 $dbw->update( 'oldimage',
1718                                                         array( 'oi_sha1' => $props['sha1'] ),
1719                                                         array( 'oi_name' => $this->file->getName(), 'oi_archive_name' => $row->oi_archive_name ),
1720                                                         __METHOD__ );
1721                                                 $hashes[$row->oi_archive_name] = $props['sha1'];
1722                                         } else {
1723                                                 $hashes[$row->oi_archive_name] = false;
1724                                         }
1725                                 } else {
1726                                         $hashes[$row->oi_archive_name] = $row->oi_sha1;
1727                                 }
1728                         }
1729                 }
1730
1731                 $missing = array_diff_key( $this->srcRels, $hashes );
1732
1733                 foreach ( $missing as $name => $rel ) {
1734                         $this->status->error( 'filedelete-old-unregistered', $name );
1735                 }
1736
1737                 foreach ( $hashes as $name => $hash ) {
1738                         if ( !$hash ) {
1739                                 $this->status->error( 'filedelete-missing', $this->srcRels[$name] );
1740                                 unset( $hashes[$name] );
1741                         }
1742                 }
1743
1744                 return $hashes;
1745         }
1746
1747         function doDBInserts() {
1748                 global $wgUser;
1749
1750                 $dbw = $this->file->repo->getMasterDB();
1751                 $encTimestamp = $dbw->addQuotes( $dbw->timestamp() );
1752                 $encUserId = $dbw->addQuotes( $wgUser->getId() );
1753                 $encReason = $dbw->addQuotes( $this->reason );
1754                 $encGroup = $dbw->addQuotes( 'deleted' );
1755                 $ext = $this->file->getExtension();
1756                 $dotExt = $ext === '' ? '' : ".$ext";
1757                 $encExt = $dbw->addQuotes( $dotExt );
1758                 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
1759
1760                 // Bitfields to further suppress the content
1761                 if ( $this->suppress ) {
1762                         $bitfield = 0;
1763                         // This should be 15...
1764                         $bitfield |= Revision::DELETED_TEXT;
1765                         $bitfield |= Revision::DELETED_COMMENT;
1766                         $bitfield |= Revision::DELETED_USER;
1767                         $bitfield |= Revision::DELETED_RESTRICTED;
1768                 } else {
1769                         $bitfield = 'oi_deleted';
1770                 }
1771
1772                 if ( $deleteCurrent ) {
1773                         $concat = $dbw->buildConcat( array( "img_sha1", $encExt ) );
1774                         $where = array( 'img_name' => $this->file->getName() );
1775                         $dbw->insertSelect( 'filearchive', 'image',
1776                                 array(
1777                                         'fa_storage_group' => $encGroup,
1778                                         'fa_storage_key'   => "CASE WHEN img_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 : 0,
1783
1784                                         'fa_name'         => 'img_name',
1785                                         'fa_archive_name' => 'NULL',
1786                                         'fa_size'         => 'img_size',
1787                                         'fa_width'        => 'img_width',
1788                                         'fa_height'       => 'img_height',
1789                                         'fa_metadata'     => 'img_metadata',
1790                                         'fa_bits'         => 'img_bits',
1791                                         'fa_media_type'   => 'img_media_type',
1792                                         'fa_major_mime'   => 'img_major_mime',
1793                                         'fa_minor_mime'   => 'img_minor_mime',
1794                                         'fa_description'  => 'img_description',
1795                                         'fa_user'         => 'img_user',
1796                                         'fa_user_text'    => 'img_user_text',
1797                                         'fa_timestamp'    => 'img_timestamp',
1798                                         'fa_sha1'         => 'img_sha1',
1799                                 ), $where, __METHOD__ );
1800                 }
1801
1802                 if ( count( $oldRels ) ) {
1803                         $concat = $dbw->buildConcat( array( "oi_sha1", $encExt ) );
1804                         $where = array(
1805                                 'oi_name' => $this->file->getName(),
1806                                 'oi_archive_name IN (' . $dbw->makeList( array_keys( $oldRels ) ) . ')' );
1807                         $dbw->insertSelect( 'filearchive', 'oldimage',
1808                                 array(
1809                                         'fa_storage_group' => $encGroup,
1810                                         'fa_storage_key'   => "CASE WHEN oi_sha1='' THEN '' ELSE $concat END",
1811                                         'fa_deleted_user'      => $encUserId,
1812                                         'fa_deleted_timestamp' => $encTimestamp,
1813                                         'fa_deleted_reason'    => $encReason,
1814                                         'fa_deleted'           => $this->suppress ? $bitfield : 'oi_deleted',
1815
1816                                         'fa_name'         => 'oi_name',
1817                                         'fa_archive_name' => 'oi_archive_name',
1818                                         'fa_size'         => 'oi_size',
1819                                         'fa_width'        => 'oi_width',
1820                                         'fa_height'       => 'oi_height',
1821                                         'fa_metadata'     => 'oi_metadata',
1822                                         'fa_bits'         => 'oi_bits',
1823                                         'fa_media_type'   => 'oi_media_type',
1824                                         'fa_major_mime'   => 'oi_major_mime',
1825                                         'fa_minor_mime'   => 'oi_minor_mime',
1826                                         'fa_description'  => 'oi_description',
1827                                         'fa_user'         => 'oi_user',
1828                                         'fa_user_text'    => 'oi_user_text',
1829                                         'fa_timestamp'    => 'oi_timestamp',
1830                                         'fa_sha1'         => 'oi_sha1',
1831                                 ), $where, __METHOD__ );
1832                 }
1833         }
1834
1835         function doDBDeletes() {
1836                 $dbw = $this->file->repo->getMasterDB();
1837                 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
1838
1839                 if ( count( $oldRels ) ) {
1840                         $dbw->delete( 'oldimage',
1841                                 array(
1842                                         'oi_name' => $this->file->getName(),
1843                                         'oi_archive_name' => array_keys( $oldRels )
1844                                 ), __METHOD__ );
1845                 }
1846
1847                 if ( $deleteCurrent ) {
1848                         $dbw->delete( 'image', array( 'img_name' => $this->file->getName() ), __METHOD__ );
1849                 }
1850         }
1851
1852         /**
1853          * Run the transaction
1854          * @return FileRepoStatus
1855          */
1856         function execute() {
1857                 wfProfileIn( __METHOD__ );
1858
1859                 $this->file->lock();
1860                 // Leave private files alone
1861                 $privateFiles = array();
1862                 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
1863                 $dbw = $this->file->repo->getMasterDB();
1864
1865                 if ( !empty( $oldRels ) ) {
1866                         $res = $dbw->select( 'oldimage',
1867                                 array( 'oi_archive_name' ),
1868                                 array( 'oi_name' => $this->file->getName(),
1869                                         'oi_archive_name IN (' . $dbw->makeList( array_keys( $oldRels ) ) . ')',
1870                                         $dbw->bitAnd( 'oi_deleted', File::DELETED_FILE ) => File::DELETED_FILE ),
1871                                 __METHOD__ );
1872
1873                         foreach ( $res as $row ) {
1874                                 $privateFiles[$row->oi_archive_name] = 1;
1875                         }
1876                 }
1877                 // Prepare deletion batch
1878                 $hashes = $this->getHashes();
1879                 $this->deletionBatch = array();
1880                 $ext = $this->file->getExtension();
1881                 $dotExt = $ext === '' ? '' : ".$ext";
1882
1883                 foreach ( $this->srcRels as $name => $srcRel ) {
1884                         // Skip files that have no hash (missing source).
1885                         // Keep private files where they are.
1886                         if ( isset( $hashes[$name] ) && !array_key_exists( $name, $privateFiles ) ) {
1887                                 $hash = $hashes[$name];
1888                                 $key = $hash . $dotExt;
1889                                 $dstRel = $this->file->repo->getDeletedHashPath( $key ) . $key;
1890                                 $this->deletionBatch[$name] = array( $srcRel, $dstRel );
1891                         }
1892                 }
1893
1894                 // Lock the filearchive rows so that the files don't get deleted by a cleanup operation
1895                 // We acquire this lock by running the inserts now, before the file operations.
1896                 //
1897                 // This potentially has poor lock contention characteristics -- an alternative
1898                 // scheme would be to insert stub filearchive entries with no fa_name and commit
1899                 // them in a separate transaction, then run the file ops, then update the fa_name fields.
1900                 $this->doDBInserts();
1901
1902                 // Removes non-existent file from the batch, so we don't get errors.
1903                 $this->deletionBatch = $this->removeNonexistentFiles( $this->deletionBatch );
1904
1905                 // Execute the file deletion batch
1906                 $status = $this->file->repo->deleteBatch( $this->deletionBatch );
1907
1908                 if ( !$status->isGood() ) {
1909                         $this->status->merge( $status );
1910                 }
1911
1912                 if ( !$this->status->isOK() ) {
1913                         // Critical file deletion error
1914                         // Roll back inserts, release lock and abort
1915                         // TODO: delete the defunct filearchive rows if we are using a non-transactional DB
1916                         $this->file->unlockAndRollback();
1917                         wfProfileOut( __METHOD__ );
1918                         return $this->status;
1919                 }
1920
1921                 // Delete image/oldimage rows
1922                 $this->doDBDeletes();
1923
1924                 // Commit and return
1925                 $this->file->unlock();
1926                 wfProfileOut( __METHOD__ );
1927
1928                 return $this->status;
1929         }
1930
1931         /**
1932          * Removes non-existent files from a deletion batch.
1933          * @param $batch array
1934          * @return array
1935          */
1936         function removeNonexistentFiles( $batch ) {
1937                 $files = $newBatch = array();
1938
1939                 foreach ( $batch as $batchItem ) {
1940                         list( $src, $dest ) = $batchItem;
1941                         $files[$src] = $this->file->repo->getVirtualUrl( 'public' ) . '/' . rawurlencode( $src );
1942                 }
1943
1944                 $result = $this->file->repo->fileExistsBatch( $files );
1945
1946                 foreach ( $batch as $batchItem ) {
1947                         if ( $result[$batchItem[0]] ) {
1948                                 $newBatch[] = $batchItem;
1949                         }
1950                 }
1951
1952                 return $newBatch;
1953         }
1954 }
1955
1956 # ------------------------------------------------------------------------------
1957
1958 /**
1959  * Helper class for file undeletion
1960  * @ingroup FileAbstraction
1961  */
1962 class LocalFileRestoreBatch {
1963         /**
1964          * @var LocalFile
1965          */
1966         var $file;
1967
1968         var $cleanupBatch, $ids, $all, $unsuppress = false;
1969
1970         /**
1971          * @param $file File
1972          * @param $unsuppress bool
1973          */
1974         function __construct( File $file, $unsuppress = false ) {
1975                 $this->file = $file;
1976                 $this->cleanupBatch = $this->ids = array();
1977                 $this->ids = array();
1978                 $this->unsuppress = $unsuppress;
1979         }
1980
1981         /**
1982          * Add a file by ID
1983          */
1984         function addId( $fa_id ) {
1985                 $this->ids[] = $fa_id;
1986         }
1987
1988         /**
1989          * Add a whole lot of files by ID
1990          */
1991         function addIds( $ids ) {
1992                 $this->ids = array_merge( $this->ids, $ids );
1993         }
1994
1995         /**
1996          * Add all revisions of the file
1997          */
1998         function addAll() {
1999                 $this->all = true;
2000         }
2001
2002         /**
2003          * Run the transaction, except the cleanup batch.
2004          * The cleanup batch should be run in a separate transaction, because it locks different
2005          * rows and there's no need to keep the image row locked while it's acquiring those locks
2006          * The caller may have its own transaction open.
2007          * So we save the batch and let the caller call cleanup()
2008          * @return FileRepoStatus
2009          */
2010         function execute() {
2011                 global $wgLang;
2012
2013                 if ( !$this->all && !$this->ids ) {
2014                         // Do nothing
2015                         return $this->file->repo->newGood();
2016                 }
2017
2018                 $exists = $this->file->lock();
2019                 $dbw = $this->file->repo->getMasterDB();
2020                 $status = $this->file->repo->newGood();
2021
2022                 // Fetch all or selected archived revisions for the file,
2023                 // sorted from the most recent to the oldest.
2024                 $conditions = array( 'fa_name' => $this->file->getName() );
2025
2026                 if ( !$this->all ) {
2027                         $conditions[] = 'fa_id IN (' . $dbw->makeList( $this->ids ) . ')';
2028                 }
2029
2030                 $result = $dbw->select( 'filearchive', '*',
2031                         $conditions,
2032                         __METHOD__,
2033                         array( 'ORDER BY' => 'fa_timestamp DESC' )
2034                 );
2035
2036                 $idsPresent = array();
2037                 $storeBatch = array();
2038                 $insertBatch = array();
2039                 $insertCurrent = false;
2040                 $deleteIds = array();
2041                 $first = true;
2042                 $archiveNames = array();
2043
2044                 foreach ( $result as $row ) {
2045                         $idsPresent[] = $row->fa_id;
2046
2047                         if ( $row->fa_name != $this->file->getName() ) {
2048                                 $status->error( 'undelete-filename-mismatch', $wgLang->timeanddate( $row->fa_timestamp ) );
2049                                 $status->failCount++;
2050                                 continue;
2051                         }
2052
2053                         if ( $row->fa_storage_key == '' ) {
2054                                 // Revision was missing pre-deletion
2055                                 $status->error( 'undelete-bad-store-key', $wgLang->timeanddate( $row->fa_timestamp ) );
2056                                 $status->failCount++;
2057                                 continue;
2058                         }
2059
2060                         $deletedRel = $this->file->repo->getDeletedHashPath( $row->fa_storage_key ) . $row->fa_storage_key;
2061                         $deletedUrl = $this->file->repo->getVirtualUrl() . '/deleted/' . $deletedRel;
2062
2063                         if( isset( $row->fa_sha1 ) ) {
2064                                 $sha1 = $row->fa_sha1;
2065                         } else {
2066                                 // old row, populate from key
2067                                 $sha1 = LocalRepo::getHashFromKey( $row->fa_storage_key );
2068                         }
2069
2070                         # Fix leading zero
2071                         if ( strlen( $sha1 ) == 32 && $sha1[0] == '0' ) {
2072                                 $sha1 = substr( $sha1, 1 );
2073                         }
2074
2075                         if ( is_null( $row->fa_major_mime ) || $row->fa_major_mime == 'unknown'
2076                                 || is_null( $row->fa_minor_mime ) || $row->fa_minor_mime == 'unknown'
2077                                 || is_null( $row->fa_media_type ) || $row->fa_media_type == 'UNKNOWN'
2078                                 || is_null( $row->fa_metadata ) ) {
2079                                 // Refresh our metadata
2080                                 // Required for a new current revision; nice for older ones too. :)
2081                                 $props = RepoGroup::singleton()->getFileProps( $deletedUrl );
2082                         } else {
2083                                 $props = array(
2084                                         'minor_mime' => $row->fa_minor_mime,
2085                                         'major_mime' => $row->fa_major_mime,
2086                                         'media_type' => $row->fa_media_type,
2087                                         'metadata'   => $row->fa_metadata
2088                                 );
2089                         }
2090
2091                         if ( $first && !$exists ) {
2092                                 // This revision will be published as the new current version
2093                                 $destRel = $this->file->getRel();
2094                                 $insertCurrent = array(
2095                                         'img_name'        => $row->fa_name,
2096                                         'img_size'        => $row->fa_size,
2097                                         'img_width'       => $row->fa_width,
2098                                         'img_height'      => $row->fa_height,
2099                                         'img_metadata'    => $props['metadata'],
2100                                         'img_bits'        => $row->fa_bits,
2101                                         'img_media_type'  => $props['media_type'],
2102                                         'img_major_mime'  => $props['major_mime'],
2103                                         'img_minor_mime'  => $props['minor_mime'],
2104                                         'img_description' => $row->fa_description,
2105                                         'img_user'        => $row->fa_user,
2106                                         'img_user_text'   => $row->fa_user_text,
2107                                         'img_timestamp'   => $row->fa_timestamp,
2108                                         'img_sha1'        => $sha1
2109                                 );
2110
2111                                 // The live (current) version cannot be hidden!
2112                                 if ( !$this->unsuppress && $row->fa_deleted ) {
2113                                         $storeBatch[] = array( $deletedUrl, 'public', $destRel );
2114                                         $this->cleanupBatch[] = $row->fa_storage_key;
2115                                 }
2116                         } else {
2117                                 $archiveName = $row->fa_archive_name;
2118
2119                                 if ( $archiveName == '' ) {
2120                                         // This was originally a current version; we
2121                                         // have to devise a new archive name for it.
2122                                         // Format is <timestamp of archiving>!<name>
2123                                         $timestamp = wfTimestamp( TS_UNIX, $row->fa_deleted_timestamp );
2124
2125                                         do {
2126                                                 $archiveName = wfTimestamp( TS_MW, $timestamp ) . '!' . $row->fa_name;
2127                                                 $timestamp++;
2128                                         } while ( isset( $archiveNames[$archiveName] ) );
2129                                 }
2130
2131                                 $archiveNames[$archiveName] = true;
2132                                 $destRel = $this->file->getArchiveRel( $archiveName );
2133                                 $insertBatch[] = array(
2134                                         'oi_name'         => $row->fa_name,
2135                                         'oi_archive_name' => $archiveName,
2136                                         'oi_size'         => $row->fa_size,
2137                                         'oi_width'        => $row->fa_width,
2138                                         'oi_height'       => $row->fa_height,
2139                                         'oi_bits'         => $row->fa_bits,
2140                                         'oi_description'  => $row->fa_description,
2141                                         'oi_user'         => $row->fa_user,
2142                                         'oi_user_text'    => $row->fa_user_text,
2143                                         'oi_timestamp'    => $row->fa_timestamp,
2144                                         'oi_metadata'     => $props['metadata'],
2145                                         'oi_media_type'   => $props['media_type'],
2146                                         'oi_major_mime'   => $props['major_mime'],
2147                                         'oi_minor_mime'   => $props['minor_mime'],
2148                                         'oi_deleted'      => $this->unsuppress ? 0 : $row->fa_deleted,
2149                                         'oi_sha1'         => $sha1 );
2150                         }
2151
2152                         $deleteIds[] = $row->fa_id;
2153
2154                         if ( !$this->unsuppress && $row->fa_deleted & File::DELETED_FILE ) {
2155                                 // private files can stay where they are
2156                                 $status->successCount++;
2157                         } else {
2158                                 $storeBatch[] = array( $deletedUrl, 'public', $destRel );
2159                                 $this->cleanupBatch[] = $row->fa_storage_key;
2160                         }
2161
2162                         $first = false;
2163                 }
2164
2165                 unset( $result );
2166
2167                 // Add a warning to the status object for missing IDs
2168                 $missingIds = array_diff( $this->ids, $idsPresent );
2169
2170                 foreach ( $missingIds as $id ) {
2171                         $status->error( 'undelete-missing-filearchive', $id );
2172                 }
2173
2174                 // Remove missing files from batch, so we don't get errors when undeleting them
2175                 $storeBatch = $this->removeNonexistentFiles( $storeBatch );
2176
2177                 // Run the store batch
2178                 // Use the OVERWRITE_SAME flag to smooth over a common error
2179                 $storeStatus = $this->file->repo->storeBatch( $storeBatch, FileRepo::OVERWRITE_SAME );
2180                 $status->merge( $storeStatus );
2181
2182                 if ( !$status->isGood() ) {
2183                         // Even if some files could be copied, fail entirely as that is the
2184                         // easiest thing to do without data loss
2185                         $this->cleanupFailedBatch( $storeStatus, $storeBatch );
2186                         $status->ok = false;
2187                         $this->file->unlock();
2188
2189                         return $status;
2190                 }
2191
2192                 // Run the DB updates
2193                 // Because we have locked the image row, key conflicts should be rare.
2194                 // If they do occur, we can roll back the transaction at this time with
2195                 // no data loss, but leaving unregistered files scattered throughout the
2196                 // public zone.
2197                 // This is not ideal, which is why it's important to lock the image row.
2198                 if ( $insertCurrent ) {
2199                         $dbw->insert( 'image', $insertCurrent, __METHOD__ );
2200                 }
2201
2202                 if ( $insertBatch ) {
2203                         $dbw->insert( 'oldimage', $insertBatch, __METHOD__ );
2204                 }
2205
2206                 if ( $deleteIds ) {
2207                         $dbw->delete( 'filearchive',
2208                                 array( 'fa_id IN (' . $dbw->makeList( $deleteIds ) . ')' ),
2209                                 __METHOD__ );
2210                 }
2211
2212                 // If store batch is empty (all files are missing), deletion is to be considered successful
2213                 if ( $status->successCount > 0 || !$storeBatch ) {
2214                         if ( !$exists ) {
2215                                 wfDebug( __METHOD__ . " restored {$status->successCount} items, creating a new current\n" );
2216
2217                                 DeferredUpdates::addUpdate( SiteStatsUpdate::factory( array( 'images' => 1 ) ) );
2218
2219                                 $this->file->purgeEverything();
2220                         } else {
2221                                 wfDebug( __METHOD__ . " restored {$status->successCount} as archived versions\n" );
2222                                 $this->file->purgeDescription();
2223                                 $this->file->purgeHistory();
2224                         }
2225                 }
2226
2227                 $this->file->unlock();
2228
2229                 return $status;
2230         }
2231
2232         /**
2233          * Removes non-existent files from a store batch.
2234          * @param $triplets array
2235          * @return array
2236          */
2237         function removeNonexistentFiles( $triplets ) {
2238                 $files = $filteredTriplets = array();
2239                 foreach ( $triplets as $file ) {
2240                         $files[$file[0]] = $file[0];
2241                 }
2242
2243                 $result = $this->file->repo->fileExistsBatch( $files );
2244
2245                 foreach ( $triplets as $file ) {
2246                         if ( $result[$file[0]] ) {
2247                                 $filteredTriplets[] = $file;
2248                         }
2249                 }
2250
2251                 return $filteredTriplets;
2252         }
2253
2254         /**
2255          * Removes non-existent files from a cleanup batch.
2256          * @param $batch array
2257          * @return array
2258          */
2259         function removeNonexistentFromCleanup( $batch ) {
2260                 $files = $newBatch = array();
2261                 $repo = $this->file->repo;
2262
2263                 foreach ( $batch as $file ) {
2264                         $files[$file] = $repo->getVirtualUrl( 'deleted' ) . '/' .
2265                                 rawurlencode( $repo->getDeletedHashPath( $file ) . $file );
2266                 }
2267
2268                 $result = $repo->fileExistsBatch( $files );
2269
2270                 foreach ( $batch as $file ) {
2271                         if ( $result[$file] ) {
2272                                 $newBatch[] = $file;
2273                         }
2274                 }
2275
2276                 return $newBatch;
2277         }
2278
2279         /**
2280          * Delete unused files in the deleted zone.
2281          * This should be called from outside the transaction in which execute() was called.
2282          * @return FileRepoStatus|void
2283          */
2284         function cleanup() {
2285                 if ( !$this->cleanupBatch ) {
2286                         return $this->file->repo->newGood();
2287                 }
2288
2289                 $this->cleanupBatch = $this->removeNonexistentFromCleanup( $this->cleanupBatch );
2290
2291                 $status = $this->file->repo->cleanupDeletedBatch( $this->cleanupBatch );
2292
2293                 return $status;
2294         }
2295
2296         /**
2297          * Cleanup a failed batch. The batch was only partially successful, so
2298          * rollback by removing all items that were succesfully copied.
2299          *
2300          * @param Status $storeStatus
2301          * @param array $storeBatch
2302          */
2303         function cleanupFailedBatch( $storeStatus, $storeBatch ) {
2304                 $cleanupBatch = array();
2305
2306                 foreach ( $storeStatus->success as $i => $success ) {
2307                         // Check if this item of the batch was successfully copied
2308                         if ( $success ) {
2309                                 // Item was successfully copied and needs to be removed again
2310                                 // Extract ($dstZone, $dstRel) from the batch
2311                                 $cleanupBatch[] = array( $storeBatch[$i][1], $storeBatch[$i][2] );
2312                         }
2313                 }
2314                 $this->file->repo->cleanupBatch( $cleanupBatch );
2315         }
2316 }
2317
2318 # ------------------------------------------------------------------------------
2319
2320 /**
2321  * Helper class for file movement
2322  * @ingroup FileAbstraction
2323  */
2324 class LocalFileMoveBatch {
2325
2326         /**
2327          * @var LocalFile
2328          */
2329         var $file;
2330
2331         /**
2332          * @var Title
2333          */
2334         var $target;
2335
2336         var $cur, $olds, $oldCount, $archive;
2337
2338         /**
2339          * @var DatabaseBase
2340          */
2341         var $db;
2342
2343         /**
2344          * @param File $file
2345          * @param Title $target
2346          */
2347         function __construct( File $file, Title $target ) {
2348                 $this->file = $file;
2349                 $this->target = $target;
2350                 $this->oldHash = $this->file->repo->getHashPath( $this->file->getName() );
2351                 $this->newHash = $this->file->repo->getHashPath( $this->target->getDBkey() );
2352                 $this->oldName = $this->file->getName();
2353                 $this->newName = $this->file->repo->getNameFromTitle( $this->target );
2354                 $this->oldRel = $this->oldHash . $this->oldName;
2355                 $this->newRel = $this->newHash . $this->newName;
2356                 $this->db = $file->getRepo()->getMasterDb();
2357         }
2358
2359         /**
2360          * Add the current image to the batch
2361          */
2362         function addCurrent() {
2363                 $this->cur = array( $this->oldRel, $this->newRel );
2364         }
2365
2366         /**
2367          * Add the old versions of the image to the batch
2368          * @return Array List of archive names from old versions
2369          */
2370         function addOlds() {
2371                 $archiveBase = 'archive';
2372                 $this->olds = array();
2373                 $this->oldCount = 0;
2374                 $archiveNames = array();
2375
2376                 $result = $this->db->select( 'oldimage',
2377                         array( 'oi_archive_name', 'oi_deleted' ),
2378                         array( 'oi_name' => $this->oldName ),
2379                         __METHOD__
2380                 );
2381
2382                 foreach ( $result as $row ) {
2383                         $archiveNames[] = $row->oi_archive_name;
2384                         $oldName = $row->oi_archive_name;
2385                         $bits = explode( '!', $oldName, 2 );
2386
2387                         if ( count( $bits ) != 2 ) {
2388                                 wfDebug( "Old file name missing !: '$oldName' \n" );
2389                                 continue;
2390                         }
2391
2392                         list( $timestamp, $filename ) = $bits;
2393
2394                         if ( $this->oldName != $filename ) {
2395                                 wfDebug( "Old file name doesn't match: '$oldName' \n" );
2396                                 continue;
2397                         }
2398
2399                         $this->oldCount++;
2400
2401                         // Do we want to add those to oldCount?
2402                         if ( $row->oi_deleted & File::DELETED_FILE ) {
2403                                 continue;
2404                         }
2405
2406                         $this->olds[] = array(
2407                                 "{$archiveBase}/{$this->oldHash}{$oldName}",
2408                                 "{$archiveBase}/{$this->newHash}{$timestamp}!{$this->newName}"
2409                         );
2410                 }
2411
2412                 return $archiveNames;
2413         }
2414
2415         /**
2416          * Perform the move.
2417          * @return FileRepoStatus
2418          */
2419         function execute() {
2420                 $repo = $this->file->repo;
2421                 $status = $repo->newGood();
2422
2423                 $triplets = $this->getMoveTriplets();
2424                 $triplets = $this->removeNonexistentFiles( $triplets );
2425
2426                 $this->file->lock(); // begin
2427                 // Rename the file versions metadata in the DB.
2428                 // This implicitly locks the destination file, which avoids race conditions.
2429                 // If we moved the files from A -> C before DB updates, another process could
2430                 // move files from B -> C at this point, causing storeBatch() to fail and thus
2431                 // cleanupTarget() to trigger. It would delete the C files and cause data loss.
2432                 $statusDb = $this->doDBUpdates();
2433                 if ( !$statusDb->isGood() ) {
2434                         $this->file->unlockAndRollback();
2435                         $statusDb->ok = false;
2436                         return $statusDb;
2437                 }
2438                 wfDebugLog( 'imagemove', "Renamed {$this->file->getName()} in database: {$statusDb->successCount} successes, {$statusDb->failCount} failures" );
2439
2440                 // Copy the files into their new location.
2441                 // If a prior process fataled copying or cleaning up files we tolerate any
2442                 // of the existing files if they are identical to the ones being stored.
2443                 $statusMove = $repo->storeBatch( $triplets, FileRepo::OVERWRITE_SAME );
2444                 wfDebugLog( 'imagemove', "Moved files for {$this->file->getName()}: {$statusMove->successCount} successes, {$statusMove->failCount} failures" );
2445                 if ( !$statusMove->isGood() ) {
2446                         // Delete any files copied over (while the destination is still locked)
2447                         $this->cleanupTarget( $triplets );
2448                         $this->file->unlockAndRollback(); // unlocks the destination
2449                         wfDebugLog( 'imagemove', "Error in moving files: " . $statusMove->getWikiText() );
2450                         $statusMove->ok = false;
2451                         return $statusMove;
2452                 }
2453                 $this->file->unlock(); // done
2454
2455                 // Everything went ok, remove the source files
2456                 $this->cleanupSource( $triplets );
2457
2458                 $status->merge( $statusDb );
2459                 $status->merge( $statusMove );
2460
2461                 return $status;
2462         }
2463
2464         /**
2465          * Do the database updates and return a new FileRepoStatus indicating how
2466          * many rows where updated.
2467          *
2468          * @return FileRepoStatus
2469          */
2470         function doDBUpdates() {
2471                 $repo = $this->file->repo;
2472                 $status = $repo->newGood();
2473                 $dbw = $this->db;
2474
2475                 // Update current image
2476                 $dbw->update(
2477                         'image',
2478                         array( 'img_name' => $this->newName ),
2479                         array( 'img_name' => $this->oldName ),
2480                         __METHOD__
2481                 );
2482
2483                 if ( $dbw->affectedRows() ) {
2484                         $status->successCount++;
2485                 } else {
2486                         $status->failCount++;
2487                         $status->fatal( 'imageinvalidfilename' );
2488                         return $status;
2489                 }
2490
2491                 // Update old images
2492                 $dbw->update(
2493                         'oldimage',
2494                         array(
2495                                 'oi_name' => $this->newName,
2496                                 'oi_archive_name = ' . $dbw->strreplace( 'oi_archive_name',
2497                                         $dbw->addQuotes( $this->oldName ), $dbw->addQuotes( $this->newName ) ),
2498                         ),
2499                         array( 'oi_name' => $this->oldName ),
2500                         __METHOD__
2501                 );
2502
2503                 $affected = $dbw->affectedRows();
2504                 $total = $this->oldCount;
2505                 $status->successCount += $affected;
2506                 // Bug 34934: $total is based on files that actually exist.
2507                 // There may be more DB rows than such files, in which case $affected
2508                 // can be greater than $total. We use max() to avoid negatives here.
2509                 $status->failCount += max( 0, $total - $affected );
2510                 if ( $status->failCount ) {
2511                         $status->error( 'imageinvalidfilename' );
2512                 }
2513
2514                 return $status;
2515         }
2516
2517         /**
2518          * Generate triplets for FileRepo::storeBatch().
2519          * @return array
2520          */
2521         function getMoveTriplets() {
2522                 $moves = array_merge( array( $this->cur ), $this->olds );
2523                 $triplets = array();    // The format is: (srcUrl, destZone, destUrl)
2524
2525                 foreach ( $moves as $move ) {
2526                         // $move: (oldRelativePath, newRelativePath)
2527                         $srcUrl = $this->file->repo->getVirtualUrl() . '/public/' . rawurlencode( $move[0] );
2528                         $triplets[] = array( $srcUrl, 'public', $move[1] );
2529                         wfDebugLog( 'imagemove', "Generated move triplet for {$this->file->getName()}: {$srcUrl} :: public :: {$move[1]}" );
2530                 }
2531
2532                 return $triplets;
2533         }
2534
2535         /**
2536          * Removes non-existent files from move batch.
2537          * @param $triplets array
2538          * @return array
2539          */
2540         function removeNonexistentFiles( $triplets ) {
2541                 $files = array();
2542
2543                 foreach ( $triplets as $file ) {
2544                         $files[$file[0]] = $file[0];
2545                 }
2546
2547                 $result = $this->file->repo->fileExistsBatch( $files );
2548                 $filteredTriplets = array();
2549
2550                 foreach ( $triplets as $file ) {
2551                         if ( $result[$file[0]] ) {
2552                                 $filteredTriplets[] = $file;
2553                         } else {
2554                                 wfDebugLog( 'imagemove', "File {$file[0]} does not exist" );
2555                         }
2556                 }
2557
2558                 return $filteredTriplets;
2559         }
2560
2561         /**
2562          * Cleanup a partially moved array of triplets by deleting the target
2563          * files. Called if something went wrong half way.
2564          */
2565         function cleanupTarget( $triplets ) {
2566                 // Create dest pairs from the triplets
2567                 $pairs = array();
2568                 foreach ( $triplets as $triplet ) {
2569                         // $triplet: (old source virtual URL, dst zone, dest rel)
2570                         $pairs[] = array( $triplet[1], $triplet[2] );
2571                 }
2572
2573                 $this->file->repo->cleanupBatch( $pairs );
2574         }
2575
2576         /**
2577          * Cleanup a fully moved array of triplets by deleting the source files.
2578          * Called at the end of the move process if everything else went ok.
2579          */
2580         function cleanupSource( $triplets ) {
2581                 // Create source file names from the triplets
2582                 $files = array();
2583                 foreach ( $triplets as $triplet ) {
2584                         $files[] = $triplet[0];
2585                 }
2586
2587                 $this->file->repo->cleanupBatch( $files );
2588         }
2589 }