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', 9 );
  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         /** @var bool Does the file exist on disk? (loadFromXxx) */
  50         protected $fileExists;
  51
  52         /** @var int Image width */
  53         protected $width;
  54
  55         /** @var int Image height */
  56         protected $height;
  57
  58         /** @var int Returned by getimagesize (loadFromXxx) */
  59         protected $bits;
  60
  61         /** @var string MEDIATYPE_xxx (bitmap, drawing, audio...) */
  62         protected $media_type;
  63
  64         /** @var string MIME type, determined by MimeMagic::guessMimeType */
  65         protected $mime;
  66
  67         /** @var int Size in bytes (loadFromXxx) */
  68         protected $size;
  69
  70         /** @var string Handler-specific metadata */
  71         protected $metadata;
  72
  73         /** @var string SHA-1 base 36 content hash */
  74         protected $sha1;
  75
  76         /** @var bool Whether or not core data has been loaded from the database (loadFromXxx) */
  77         protected $dataLoaded;
  78
  79         /** @var bool Whether or not lazy-loaded data has been loaded from the database */
  80         protected $extraDataLoaded;
  81
  82         /** @var int Bitfield akin to rev_deleted */
  83         protected $deleted;
  84
  85         /** @var string */
  86         protected $repoClass = 'LocalRepo';
  87
  88         /** @var int Number of line to return by nextHistoryLine() (constructor) */
  89         private $historyLine;
  90
  91         /** @var int Result of the query for the file's history (nextHistoryLine) */
  92         private $historyRes;
  93
  94         /** @var string Major MIME type */
  95         private $major_mime;
  96
  97         /** @var string Minor MIME type */
  98         private $minor_mime;
  99
 100         /** @var string Upload timestamp */
 101         private $timestamp;
 102
 103         /** @var int User ID of uploader */
 104         private $user;
 105
 106         /** @var string User name of uploader */
 107         private $user_text;
 108
 109         /** @var string Description of current revision of the file */
 110         private $description;
 111
 112         /** @var string TS_MW timestamp of the last change of the file description */
 113         private $descriptionTouched;
 114
 115         /** @var bool Whether the row was upgraded on load */
 116         private $upgraded;
 117
 118         /** @var bool True if the image row is locked */
 119         private $locked;
 120
 121         /** @var bool True if the image row is locked with a lock initiated transaction */
 122         private $lockedOwnTrx;
 123
 124         /** @var bool True if file is not present in file system. Not to be cached in memcached */
 125         private $missing;
 126
 127         // @note: higher than IDBAccessObject constants
 128         const LOAD_ALL = 16; // integer; load all the lazy fields too (like metadata)
 129
 130         /**
 131          * Create a LocalFile from a title
 132          * Do not call this except from inside a repo class.
 133          *
 134          * Note: $unused param is only here to avoid an E_STRICT
 135          *
 136          * @param Title $title
 137          * @param FileRepo $repo
 138          * @param null $unused
 139          *
 140          * @return LocalFile
 141          */
 142         static function newFromTitle( $title, $repo, $unused = null ) {
 143                 return new self( $title, $repo );
 144         }
 145
 146         /**
 147          * Create a LocalFile from a title
 148          * Do not call this except from inside a repo class.
 149          *
 150          * @param stdClass $row
 151          * @param FileRepo $repo
 152          *
 153          * @return LocalFile
 154          */
 155         static function newFromRow( $row, $repo ) {
 156                 $title = Title::makeTitle( NS_FILE, $row->img_name );
 157                 $file = new self( $title, $repo );
 158                 $file->loadFromRow( $row );
 159
 160                 return $file;
 161         }
 162
 163         /**
 164          * Create a LocalFile from a SHA-1 key
 165          * Do not call this except from inside a repo class.
 166          *
 167          * @param string $sha1 Base-36 SHA-1
 168          * @param LocalRepo $repo
 169          * @param string|bool $timestamp MW_timestamp (optional)
 170          * @return bool|LocalFile
 171          */
 172         static function newFromKey( $sha1, $repo, $timestamp = false ) {
 173                 $dbr = $repo->getSlaveDB();
 174
 175                 $conds = array( 'img_sha1' => $sha1 );
 176                 if ( $timestamp ) {
 177                         $conds['img_timestamp'] = $dbr->timestamp( $timestamp );
 178                 }
 179
 180                 $row = $dbr->selectRow( 'image', self::selectFields(), $conds, __METHOD__ );
 181                 if ( $row ) {
 182                         return self::newFromRow( $row, $repo );
 183                 } else {
 184                         return false;
 185                 }
 186         }
 187
 188         /**
 189          * Fields in the image table
 190          * @return array
 191          */
 192         static function selectFields() {
 193                 return array(
 194                         'img_name',
 195                         'img_size',
 196                         'img_width',
 197                         'img_height',
 198                         'img_metadata',
 199                         'img_bits',
 200                         'img_media_type',
 201                         'img_major_mime',
 202                         'img_minor_mime',
 203                         'img_description',
 204                         'img_user',
 205                         'img_user_text',
 206                         'img_timestamp',
 207                         'img_sha1',
 208                 );
 209         }
 210
 211         /**
 212          * Constructor.
 213          * Do not call this except from inside a repo class.
 214          * @param Title $title
 215          * @param FileRepo $repo
 216          */
 217         function __construct( $title, $repo ) {
 218                 parent::__construct( $title, $repo );
 219
 220                 $this->metadata = '';
 221                 $this->historyLine = 0;
 222                 $this->historyRes = null;
 223                 $this->dataLoaded = false;
 224                 $this->extraDataLoaded = false;
 225
 226                 $this->assertRepoDefined();
 227                 $this->assertTitleDefined();
 228         }
 229
 230         /**
 231          * Get the memcached key for the main data for this file, or false if
 232          * there is no access to the shared cache.
 233          * @return string|bool
 234          */
 235         function getCacheKey() {
 236                 $hashedName = md5( $this->getName() );
 237
 238                 return $this->repo->getSharedCacheKey( 'file', $hashedName );
 239         }
 240
 241         /**
 242          * Try to load file metadata from memcached. Returns true on success.
 243          * @return bool
 244          */
 245         function loadFromCache() {
 246                 $this->dataLoaded = false;
 247                 $this->extraDataLoaded = false;
 248                 $key = $this->getCacheKey();
 249
 250                 if ( !$key ) {
 251                         return false;
 252                 }
 253
 254                 $cache = ObjectCache::getMainWANInstance();
 255                 $cachedValues = $cache->get( $key );
 256
 257                 // Check if the key existed and belongs to this version of MediaWiki
 258                 if ( is_array( $cachedValues ) && $cachedValues['version'] == MW_FILE_VERSION ) {
 259                         $this->fileExists = $cachedValues['fileExists'];
 260                         if ( $this->fileExists ) {
 261                                 $this->setProps( $cachedValues );
 262                         }
 263                         $this->dataLoaded = true;
 264                         $this->extraDataLoaded = true;
 265                         foreach ( $this->getLazyCacheFields( '' ) as $field ) {
 266                                 $this->extraDataLoaded = $this->extraDataLoaded && isset( $cachedValues[$field] );
 267                         }
 268                 }
 269
 270                 if ( $this->dataLoaded ) {
 271                         wfIncrStats( 'image_cache.hit' );
 272                 } else {
 273                         wfIncrStats( 'image_cache.miss' );
 274                 }
 275
 276                 return $this->dataLoaded;
 277         }
 278
 279         /**
 280          * Save the file metadata to memcached
 281          */
 282         function saveToCache() {
 283                 $this->load();
 284
 285                 $key = $this->getCacheKey();
 286                 if ( !$key ) {
 287                         return;
 288                 }
 289
 290                 $fields = $this->getCacheFields( '' );
 291                 $cacheVal = array( 'version' => MW_FILE_VERSION );
 292                 $cacheVal['fileExists'] = $this->fileExists;
 293
 294                 if ( $this->fileExists ) {
 295                         foreach ( $fields as $field ) {
 296                                 $cacheVal[$field] = $this->$field;
 297                         }
 298                 }
 299
 300                 // Strip off excessive entries from the subset of fields that can become large.
 301                 // If the cache value gets to large it will not fit in memcached and nothing will
 302                 // get cached at all, causing master queries for any file access.
 303                 foreach ( $this->getLazyCacheFields( '' ) as $field ) {
 304                         if ( isset( $cacheVal[$field] ) && strlen( $cacheVal[$field] ) > 100 * 1024 ) {
 305                                 unset( $cacheVal[$field] ); // don't let the value get too big
 306                         }
 307                 }
 308
 309                 // Cache presence for 1 week and negatives for 1 day
 310                 $ttl = $this->fileExists ? 86400 * 7 : 86400;
 311                 $opts = Database::getCacheSetOptions( $this->repo->getSlaveDB() );
 312                 ObjectCache::getMainWANInstance()->set( $key, $cacheVal, $ttl, $opts );
 313         }
 314
 315         /**
 316          * Purge the file object/metadata cache
 317          */
 318         public function invalidateCache() {
 319                 $key = $this->getCacheKey();
 320                 if ( !$key ) {
 321                         return;
 322                 }
 323
 324                 $this->repo->getMasterDB()->onTransactionPreCommitOrIdle( function() use ( $key ) {
 325                         ObjectCache::getMainWANInstance()->delete( $key );
 326                 } );
 327         }
 328
 329         /**
 330          * Load metadata from the file itself
 331          */
 332         function loadFromFile() {
 333                 $props = $this->repo->getFileProps( $this->getVirtualUrl() );
 334                 $this->setProps( $props );
 335         }
 336
 337         /**
 338          * @param string $prefix
 339          * @return array
 340          */
 341         function getCacheFields( $prefix = 'img_' ) {
 342                 static $fields = array( 'size', 'width', 'height', 'bits', 'media_type',
 343                         'major_mime', 'minor_mime', 'metadata', 'timestamp', 'sha1', 'user',
 344                         'user_text', 'description' );
 345                 static $results = array();
 346
 347                 if ( $prefix == '' ) {
 348                         return $fields;
 349                 }
 350
 351                 if ( !isset( $results[$prefix] ) ) {
 352                         $prefixedFields = array();
 353                         foreach ( $fields as $field ) {
 354                                 $prefixedFields[] = $prefix . $field;
 355                         }
 356                         $results[$prefix] = $prefixedFields;
 357                 }
 358
 359                 return $results[$prefix];
 360         }
 361
 362         /**
 363          * @param string $prefix
 364          * @return array
 365          */
 366         function getLazyCacheFields( $prefix = 'img_' ) {
 367                 static $fields = array( 'metadata' );
 368                 static $results = array();
 369
 370                 if ( $prefix == '' ) {
 371                         return $fields;
 372                 }
 373
 374                 if ( !isset( $results[$prefix] ) ) {
 375                         $prefixedFields = array();
 376                         foreach ( $fields as $field ) {
 377                                 $prefixedFields[] = $prefix . $field;
 378                         }
 379                         $results[$prefix] = $prefixedFields;
 380                 }
 381
 382                 return $results[$prefix];
 383         }
 384
 385         /**
 386          * Load file metadata from the DB
 387          * @param int $flags
 388          */
 389         function loadFromDB( $flags = 0 ) {
 390                 $fname = get_class( $this ) . '::' . __FUNCTION__;
 391
 392                 # Unconditionally set loaded=true, we don't want the accessors constantly rechecking
 393                 $this->dataLoaded = true;
 394                 $this->extraDataLoaded = true;
 395
 396                 $dbr = ( $flags & self::READ_LATEST )
 397                         ? $this->repo->getMasterDB()
 398                         : $this->repo->getSlaveDB();
 399
 400                 $row = $dbr->selectRow( 'image', $this->getCacheFields( 'img_' ),
 401                         array( 'img_name' => $this->getName() ), $fname );
 402
 403                 if ( $row ) {
 404                         $this->loadFromRow( $row );
 405                 } else {
 406                         $this->fileExists = false;
 407                 }
 408         }
 409
 410         /**
 411          * Load lazy file metadata from the DB.
 412          * This covers fields that are sometimes not cached.
 413          */
 414         protected function loadExtraFromDB() {
 415                 $fname = get_class( $this ) . '::' . __FUNCTION__;
 416
 417                 # Unconditionally set loaded=true, we don't want the accessors constantly rechecking
 418                 $this->extraDataLoaded = true;
 419
 420                 $fieldMap = $this->loadFieldsWithTimestamp( $this->repo->getSlaveDB(), $fname );
 421                 if ( !$fieldMap ) {
 422                         $fieldMap = $this->loadFieldsWithTimestamp( $this->repo->getMasterDB(), $fname );
 423                 }
 424
 425                 if ( $fieldMap ) {
 426                         foreach ( $fieldMap as $name => $value ) {
 427                                 $this->$name = $value;
 428                         }
 429                 } else {
 430                         throw new MWException( "Could not find data for image '{$this->getName()}'." );
 431                 }
 432         }
 433
 434         /**
 435          * @param IDatabase $dbr
 436          * @param string $fname
 437          * @return array|bool
 438          */
 439         private function loadFieldsWithTimestamp( $dbr, $fname ) {
 440                 $fieldMap = false;
 441
 442                 $row = $dbr->selectRow( 'image', $this->getLazyCacheFields( 'img_' ),
 443                         array( 'img_name' => $this->getName(), 'img_timestamp' => $this->getTimestamp() ),
 444                         $fname );
 445                 if ( $row ) {
 446                         $fieldMap = $this->unprefixRow( $row, 'img_' );
 447                 } else {
 448                         # File may have been uploaded over in the meantime; check the old versions
 449                         $row = $dbr->selectRow( 'oldimage', $this->getLazyCacheFields( 'oi_' ),
 450                                 array( 'oi_name' => $this->getName(), 'oi_timestamp' => $this->getTimestamp() ),
 451                                 $fname );
 452                         if ( $row ) {
 453                                 $fieldMap = $this->unprefixRow( $row, 'oi_' );
 454                         }
 455                 }
 456
 457                 return $fieldMap;
 458         }
 459
 460         /**
 461          * @param array|object $row
 462          * @param string $prefix
 463          * @throws MWException
 464          * @return array
 465          */
 466         protected function unprefixRow( $row, $prefix = 'img_' ) {
 467                 $array = (array)$row;
 468                 $prefixLength = strlen( $prefix );
 469
 470                 // Sanity check prefix once
 471                 if ( substr( key( $array ), 0, $prefixLength ) !== $prefix ) {
 472                         throw new MWException( __METHOD__ . ': incorrect $prefix parameter' );
 473                 }
 474
 475                 $decoded = array();
 476                 foreach ( $array as $name => $value ) {
 477                         $decoded[substr( $name, $prefixLength )] = $value;
 478                 }
 479
 480                 return $decoded;
 481         }
 482
 483         /**
 484          * Decode a row from the database (either object or array) to an array
 485          * with timestamps and MIME types decoded, and the field prefix removed.
 486          * @param object $row
 487          * @param string $prefix
 488          * @throws MWException
 489          * @return array
 490          */
 491         function decodeRow( $row, $prefix = 'img_' ) {
 492                 $decoded = $this->unprefixRow( $row, $prefix );
 493
 494                 $decoded['timestamp'] = wfTimestamp( TS_MW, $decoded['timestamp'] );
 495
 496                 $decoded['metadata'] = $this->repo->getSlaveDB()->decodeBlob( $decoded['metadata'] );
 497
 498                 if ( empty( $decoded['major_mime'] ) ) {
 499                         $decoded['mime'] = 'unknown/unknown';
 500                 } else {
 501                         if ( !$decoded['minor_mime'] ) {
 502                                 $decoded['minor_mime'] = 'unknown';
 503                         }
 504                         $decoded['mime'] = $decoded['major_mime'] . '/' . $decoded['minor_mime'];
 505                 }
 506
 507                 // Trim zero padding from char/binary field
 508                 $decoded['sha1'] = rtrim( $decoded['sha1'], "\0" );
 509
 510                 // Normalize some fields to integer type, per their database definition.
 511                 // Use unary + so that overflows will be upgraded to double instead of
 512                 // being trucated as with intval(). This is important to allow >2GB
 513                 // files on 32-bit systems.
 514                 foreach ( array( 'size', 'width', 'height', 'bits' ) as $field ) {
 515                         $decoded[$field] = +$decoded[$field];
 516                 }
 517
 518                 return $decoded;
 519         }
 520
 521         /**
 522          * Load file metadata from a DB result row
 523          *
 524          * @param object $row
 525          * @param string $prefix
 526          */
 527         function loadFromRow( $row, $prefix = 'img_' ) {
 528                 $this->dataLoaded = true;
 529                 $this->extraDataLoaded = true;
 530
 531                 $array = $this->decodeRow( $row, $prefix );
 532
 533                 foreach ( $array as $name => $value ) {
 534                         $this->$name = $value;
 535                 }
 536
 537                 $this->fileExists = true;
 538                 $this->maybeUpgradeRow();
 539         }
 540
 541         /**
 542          * Load file metadata from cache or DB, unless already loaded
 543          * @param int $flags
 544          */
 545         function load( $flags = 0 ) {
 546                 if ( !$this->dataLoaded ) {
 547                         if ( ( $flags & self::READ_LATEST ) || !$this->loadFromCache() ) {
 548                                 $this->loadFromDB( $flags );
 549                                 $this->saveToCache();
 550                         }
 551                         $this->dataLoaded = true;
 552                 }
 553                 if ( ( $flags & self::LOAD_ALL ) && !$this->extraDataLoaded ) {
 554                         // @note: loads on name/timestamp to reduce race condition problems
 555                         $this->loadExtraFromDB();
 556                 }
 557         }
 558
 559         /**
 560          * Upgrade a row if it needs it
 561          */
 562         function maybeUpgradeRow() {
 563                 global $wgUpdateCompatibleMetadata;
 564                 if ( wfReadOnly() ) {
 565                         return;
 566                 }
 567
 568                 if ( is_null( $this->media_type ) ||
 569                         $this->mime == 'image/svg'
 570                 ) {
 571                         $this->upgradeRow();
 572                         $this->upgraded = true;
 573                 } else {
 574                         $handler = $this->getHandler();
 575                         if ( $handler ) {
 576                                 $validity = $handler->isMetadataValid( $this, $this->getMetadata() );
 577                                 if ( $validity === MediaHandler::METADATA_BAD
 578                                         || ( $validity === MediaHandler::METADATA_COMPATIBLE && $wgUpdateCompatibleMetadata )
 579                                 ) {
 580                                         $this->upgradeRow();
 581                                         $this->upgraded = true;
 582                                 }
 583                         }
 584                 }
 585         }
 586
 587         function getUpgraded() {
 588                 return $this->upgraded;
 589         }
 590
 591         /**
 592          * Fix assorted version-related problems with the image row by reloading it from the file
 593          */
 594         function upgradeRow() {
 595
 596                 $this->lock(); // begin
 597
 598                 $this->loadFromFile();
 599
 600                 # Don't destroy file info of missing files
 601                 if ( !$this->fileExists ) {
 602                         $this->unlock();
 603                         wfDebug( __METHOD__ . ": file does not exist, aborting\n" );
 604
 605                         return;
 606                 }
 607
 608                 $dbw = $this->repo->getMasterDB();
 609                 list( $major, $minor ) = self::splitMime( $this->mime );
 610
 611                 if ( wfReadOnly() ) {
 612                         $this->unlock();
 613
 614                         return;
 615                 }
 616                 wfDebug( __METHOD__ . ': upgrading ' . $this->getName() . " to the current schema\n" );
 617
 618                 $dbw->update( 'image',
 619                         array(
 620                                 'img_size' => $this->size, // sanity
 621                                 'img_width' => $this->width,
 622                                 'img_height' => $this->height,
 623                                 'img_bits' => $this->bits,
 624                                 'img_media_type' => $this->media_type,
 625                                 'img_major_mime' => $major,
 626                                 'img_minor_mime' => $minor,
 627                                 'img_metadata' => $dbw->encodeBlob( $this->metadata ),
 628                                 'img_sha1' => $this->sha1,
 629                         ),
 630                         array( 'img_name' => $this->getName() ),
 631                         __METHOD__
 632                 );
 633
 634                 $this->invalidateCache();
 635
 636                 $this->unlock(); // done
 637
 638         }
 639
 640         /**
 641          * Set properties in this object to be equal to those given in the
 642          * associative array $info. Only cacheable fields can be set.
 643          * All fields *must* be set in $info except for getLazyCacheFields().
 644          *
 645          * If 'mime' is given, it will be split into major_mime/minor_mime.
 646          * If major_mime/minor_mime are given, $this->mime will also be set.
 647          *
 648          * @param array $info
 649          */
 650         function setProps( $info ) {
 651                 $this->dataLoaded = true;
 652                 $fields = $this->getCacheFields( '' );
 653                 $fields[] = 'fileExists';
 654
 655                 foreach ( $fields as $field ) {
 656                         if ( isset( $info[$field] ) ) {
 657                                 $this->$field = $info[$field];
 658                         }
 659                 }
 660
 661                 // Fix up mime fields
 662                 if ( isset( $info['major_mime'] ) ) {
 663                         $this->mime = "{$info['major_mime']}/{$info['minor_mime']}";
 664                 } elseif ( isset( $info['mime'] ) ) {
 665                         $this->mime = $info['mime'];
 666                         list( $this->major_mime, $this->minor_mime ) = self::splitMime( $this->mime );
 667                 }
 668         }
 669
 670         /** splitMime inherited */
 671         /** getName inherited */
 672         /** getTitle inherited */
 673         /** getURL inherited */
 674         /** getViewURL inherited */
 675         /** getPath inherited */
 676         /** isVisible inherited */
 677
 678         /**
 679          * @return bool
 680          */
 681         function isMissing() {
 682                 if ( $this->missing === null ) {
 683                         list( $fileExists ) = $this->repo->fileExists( $this->getVirtualUrl() );
 684                         $this->missing = !$fileExists;
 685                 }
 686
 687                 return $this->missing;
 688         }
 689
 690         /**
 691          * Return the width of the image
 692          *
 693          * @param int $page
 694          * @return int
 695          */
 696         public function getWidth( $page = 1 ) {
 697                 $this->load();
 698
 699                 if ( $this->isMultipage() ) {
 700                         $handler = $this->getHandler();
 701                         if ( !$handler ) {
 702                                 return 0;
 703                         }
 704                         $dim = $handler->getPageDimensions( $this, $page );
 705                         if ( $dim ) {
 706                                 return $dim['width'];
 707                         } else {
 708                                 // For non-paged media, the false goes through an
 709                                 // intval, turning failure into 0, so do same here.
 710                                 return 0;
 711                         }
 712                 } else {
 713                         return $this->width;
 714                 }
 715         }
 716
 717         /**
 718          * Return the height of the image
 719          *
 720          * @param int $page
 721          * @return int
 722          */
 723         public function getHeight( $page = 1 ) {
 724                 $this->load();
 725
 726                 if ( $this->isMultipage() ) {
 727                         $handler = $this->getHandler();
 728                         if ( !$handler ) {
 729                                 return 0;
 730                         }
 731                         $dim = $handler->getPageDimensions( $this, $page );
 732                         if ( $dim ) {
 733                                 return $dim['height'];
 734                         } else {
 735                                 // For non-paged media, the false goes through an
 736                                 // intval, turning failure into 0, so do same here.
 737                                 return 0;
 738                         }
 739                 } else {
 740                         return $this->height;
 741                 }
 742         }
 743
 744         /**
 745          * Returns ID or name of user who uploaded the file
 746          *
 747          * @param string $type 'text' or 'id'
 748          * @return int|string
 749          */
 750         function getUser( $type = 'text' ) {
 751                 $this->load();
 752
 753                 if ( $type == 'text' ) {
 754                         return $this->user_text;
 755                 } elseif ( $type == 'id' ) {
 756                         return (int)$this->user;
 757                 }
 758         }
 759
 760         /**
 761          * Get short description URL for a file based on the page ID.
 762          *
 763          * @return string|null
 764          * @throws MWException
 765          * @since 1.27
 766          */
 767         public function getDescriptionShortUrl() {
 768                 $pageId = $this->title->getArticleID();
 769
 770                 if ( $pageId !== null ) {
 771                         $url = $this->repo->makeUrl( array( 'curid' => $pageId ) );
 772                         if ( $url !== false ) {
 773                                 return $url;
 774                         }
 775                 }
 776                 return null;
 777         }
 778
 779         /**
 780          * Get handler-specific metadata
 781          * @return string
 782          */
 783         function getMetadata() {
 784                 $this->load( self::LOAD_ALL ); // large metadata is loaded in another step
 785                 return $this->metadata;
 786         }
 787
 788         /**
 789          * @return int
 790          */
 791         function getBitDepth() {
 792                 $this->load();
 793
 794                 return (int)$this->bits;
 795         }
 796
 797         /**
 798          * Returns the size of the image file, in bytes
 799          * @return int
 800          */
 801         public function getSize() {
 802                 $this->load();
 803
 804                 return $this->size;
 805         }
 806
 807         /**
 808          * Returns the MIME type of the file.
 809          * @return string
 810          */
 811         function getMimeType() {
 812                 $this->load();
 813
 814                 return $this->mime;
 815         }
 816
 817         /**
 818          * Returns the type of the media in the file.
 819          * Use the value returned by this function with the MEDIATYPE_xxx constants.
 820          * @return string
 821          */
 822         function getMediaType() {
 823                 $this->load();
 824
 825                 return $this->media_type;
 826         }
 827
 828         /** canRender inherited */
 829         /** mustRender inherited */
 830         /** allowInlineDisplay inherited */
 831         /** isSafeFile inherited */
 832         /** isTrustedFile inherited */
 833
 834         /**
 835          * Returns true if the file exists on disk.
 836          * @return bool Whether file exist on disk.
 837          */
 838         public function exists() {
 839                 $this->load();
 840
 841                 return $this->fileExists;
 842         }
 843
 844         /** getTransformScript inherited */
 845         /** getUnscaledThumb inherited */
 846         /** thumbName inherited */
 847         /** createThumb inherited */
 848         /** transform inherited */
 849
 850         /** getHandler inherited */
 851         /** iconThumb inherited */
 852         /** getLastError inherited */
 853
 854         /**
 855          * Get all thumbnail names previously generated for this file
 856          * @param string|bool $archiveName Name of an archive file, default false
 857          * @return array First element is the base dir, then files in that base dir.
 858          */
 859         function getThumbnails( $archiveName = false ) {
 860                 if ( $archiveName ) {
 861                         $dir = $this->getArchiveThumbPath( $archiveName );
 862                 } else {
 863                         $dir = $this->getThumbPath();
 864                 }
 865
 866                 $backend = $this->repo->getBackend();
 867                 $files = array( $dir );
 868                 try {
 869                         $iterator = $backend->getFileList( array( 'dir' => $dir ) );
 870                         foreach ( $iterator as $file ) {
 871                                 $files[] = $file;
 872                         }
 873                 } catch ( FileBackendError $e ) {
 874                 } // suppress (bug 54674)
 875
 876                 return $files;
 877         }
 878
 879         /**
 880          * Refresh metadata in memcached, but don't touch thumbnails or CDN
 881          */
 882         function purgeMetadataCache() {
 883                 $this->invalidateCache();
 884         }
 885
 886         /**
 887          * Delete all previously generated thumbnails, refresh metadata in memcached and purge the CDN.
 888          *
 889          * @param array $options An array potentially with the key forThumbRefresh.
 890          *
 891          * @note This used to purge old thumbnails by default as well, but doesn't anymore.
 892          */
 893         function purgeCache( $options = array() ) {
 894                 // Refresh metadata cache
 895                 $this->purgeMetadataCache();
 896
 897                 // Delete thumbnails
 898                 $this->purgeThumbnails( $options );
 899
 900                 // Purge CDN cache for this file
 901                 DeferredUpdates::addUpdate(
 902                         new CdnCacheUpdate( array( $this->getUrl() ) ),
 903                         DeferredUpdates::PRESEND
 904                 );
 905         }
 906
 907         /**
 908          * Delete cached transformed files for an archived version only.
 909          * @param string $archiveName Name of the archived file
 910          */
 911         function purgeOldThumbnails( $archiveName ) {
 912                 // Get a list of old thumbnails and URLs
 913                 $files = $this->getThumbnails( $archiveName );
 914
 915                 // Purge any custom thumbnail caches
 916                 Hooks::run( 'LocalFilePurgeThumbnails', array( $this, $archiveName ) );
 917
 918                 $dir = array_shift( $files );
 919                 $this->purgeThumbList( $dir, $files );
 920
 921                 // Purge the CDN
 922                 $urls = array();
 923                 foreach ( $files as $file ) {
 924                         $urls[] = $this->getArchiveThumbUrl( $archiveName, $file );
 925                 }
 926                 DeferredUpdates::addUpdate( new CdnCacheUpdate( $urls ), DeferredUpdates::PRESEND );
 927         }
 928
 929         /**
 930          * Delete cached transformed files for the current version only.
 931          * @param array $options
 932          */
 933         public function purgeThumbnails( $options = array() ) {
 934                 // Delete thumbnails
 935                 $files = $this->getThumbnails();
 936                 // Always purge all files from CDN regardless of handler filters
 937                 $urls = array();
 938                 foreach ( $files as $file ) {
 939                         $urls[] = $this->getThumbUrl( $file );
 940                 }
 941                 array_shift( $urls ); // don't purge directory
 942
 943                 // Give media handler a chance to filter the file purge list
 944                 if ( !empty( $options['forThumbRefresh'] ) ) {
 945                         $handler = $this->getHandler();
 946                         if ( $handler ) {
 947                                 $handler->filterThumbnailPurgeList( $files, $options );
 948                         }
 949                 }
 950
 951                 // Purge any custom thumbnail caches
 952                 Hooks::run( 'LocalFilePurgeThumbnails', array( $this, false ) );
 953
 954                 $dir = array_shift( $files );
 955                 $this->purgeThumbList( $dir, $files );
 956
 957                 // Purge the CDN
 958                 DeferredUpdates::addUpdate( new CdnCacheUpdate( $urls ), DeferredUpdates::PRESEND );
 959         }
 960
 961         /**
 962          * Delete a list of thumbnails visible at urls
 963          * @param string $dir Base dir of the files.
 964          * @param array $files Array of strings: relative filenames (to $dir)
 965          */
 966         protected function purgeThumbList( $dir, $files ) {
 967                 $fileListDebug = strtr(
 968                         var_export( $files, true ),
 969                         array( "\n" => '' )
 970                 );
 971                 wfDebug( __METHOD__ . ": $fileListDebug\n" );
 972
 973                 $purgeList = array();
 974                 foreach ( $files as $file ) {
 975                         # Check that the base file name is part of the thumb name
 976                         # This is a basic sanity check to avoid erasing unrelated directories
 977                         if ( strpos( $file, $this->getName() ) !== false
 978                                 || strpos( $file, "-thumbnail" ) !== false // "short" thumb name
 979                         ) {
 980                                 $purgeList[] = "{$dir}/{$file}";
 981                         }
 982                 }
 983
 984                 # Delete the thumbnails
 985                 $this->repo->quickPurgeBatch( $purgeList );
 986                 # Clear out the thumbnail directory if empty
 987                 $this->repo->quickCleanDir( $dir );
 988         }
 989
 990         /** purgeDescription inherited */
 991         /** purgeEverything inherited */
 992
 993         /**
 994          * @param int $limit Optional: Limit to number of results
 995          * @param int $start Optional: Timestamp, start from
 996          * @param int $end Optional: Timestamp, end at
 997          * @param bool $inc
 998          * @return OldLocalFile[]
 999          */
1000         function getHistory( $limit = null, $start = null, $end = null, $inc = true ) {
1001                 $dbr = $this->repo->getSlaveDB();
1002                 $tables = array( 'oldimage' );
1003                 $fields = OldLocalFile::selectFields();
1004                 $conds = $opts = $join_conds = array();
1005                 $eq = $inc ? '=' : '';
1006                 $conds[] = "oi_name = " . $dbr->addQuotes( $this->title->getDBkey() );
1007
1008                 if ( $start ) {
1009                         $conds[] = "oi_timestamp <$eq " . $dbr->addQuotes( $dbr->timestamp( $start ) );
1010                 }
1011
1012                 if ( $end ) {
1013                         $conds[] = "oi_timestamp >$eq " . $dbr->addQuotes( $dbr->timestamp( $end ) );
1014                 }
1015
1016                 if ( $limit ) {
1017                         $opts['LIMIT'] = $limit;
1018                 }
1019
1020                 // Search backwards for time > x queries
1021                 $order = ( !$start && $end !== null ) ? 'ASC' : 'DESC';
1022                 $opts['ORDER BY'] = "oi_timestamp $order";
1023                 $opts['USE INDEX'] = array( 'oldimage' => 'oi_name_timestamp' );
1024
1025                 Hooks::run( 'LocalFile::getHistory', array( &$this, &$tables, &$fields,
1026                         &$conds, &$opts, &$join_conds ) );
1027
1028                 $res = $dbr->select( $tables, $fields, $conds, __METHOD__, $opts, $join_conds );
1029                 $r = array();
1030
1031                 foreach ( $res as $row ) {
1032                         $r[] = $this->repo->newFileFromRow( $row );
1033                 }
1034
1035                 if ( $order == 'ASC' ) {
1036                         $r = array_reverse( $r ); // make sure it ends up descending
1037                 }
1038
1039                 return $r;
1040         }
1041
1042         /**
1043          * Returns the history of this file, line by line.
1044          * starts with current version, then old versions.
1045          * uses $this->historyLine to check which line to return:
1046          *  0      return line for current version
1047          *  1      query for old versions, return first one
1048          *  2, ... return next old version from above query
1049          * @return bool
1050          */
1051         public function nextHistoryLine() {
1052                 # Polymorphic function name to distinguish foreign and local fetches
1053                 $fname = get_class( $this ) . '::' . __FUNCTION__;
1054
1055                 $dbr = $this->repo->getSlaveDB();
1056
1057                 if ( $this->historyLine == 0 ) { // called for the first time, return line from cur
1058                         $this->historyRes = $dbr->select( 'image',
1059                                 array(
1060                                         '*',
1061                                         "'' AS oi_archive_name",
1062                                         '0 as oi_deleted',
1063                                         'img_sha1'
1064                                 ),
1065                                 array( 'img_name' => $this->title->getDBkey() ),
1066                                 $fname
1067                         );
1068
1069                         if ( 0 == $dbr->numRows( $this->historyRes ) ) {
1070                                 $this->historyRes = null;
1071
1072                                 return false;
1073                         }
1074                 } elseif ( $this->historyLine == 1 ) {
1075                         $this->historyRes = $dbr->select( 'oldimage', '*',
1076                                 array( 'oi_name' => $this->title->getDBkey() ),
1077                                 $fname,
1078                                 array( 'ORDER BY' => 'oi_timestamp DESC' )
1079                         );
1080                 }
1081                 $this->historyLine++;
1082
1083                 return $dbr->fetchObject( $this->historyRes );
1084         }
1085
1086         /**
1087          * Reset the history pointer to the first element of the history
1088          */
1089         public function resetHistory() {
1090                 $this->historyLine = 0;
1091
1092                 if ( !is_null( $this->historyRes ) ) {
1093                         $this->historyRes = null;
1094                 }
1095         }
1096
1097         /** getHashPath inherited */
1098         /** getRel inherited */
1099         /** getUrlRel inherited */
1100         /** getArchiveRel inherited */
1101         /** getArchivePath inherited */
1102         /** getThumbPath inherited */
1103         /** getArchiveUrl inherited */
1104         /** getThumbUrl inherited */
1105         /** getArchiveVirtualUrl inherited */
1106         /** getThumbVirtualUrl inherited */
1107         /** isHashed inherited */
1108
1109         /**
1110          * Upload a file and record it in the DB
1111          * @param string $srcPath Source storage path, virtual URL, or filesystem path
1112          * @param string $comment Upload description
1113          * @param string $pageText Text to use for the new description page,
1114          *   if a new description page is created
1115          * @param int|bool $flags Flags for publish()
1116          * @param array|bool $props File properties, if known. This can be used to
1117          *   reduce the upload time when uploading virtual URLs for which the file
1118          *   info is already known
1119          * @param string|bool $timestamp Timestamp for img_timestamp, or false to use the
1120          *   current time
1121          * @param User|null $user User object or null to use $wgUser
1122          * @param string[] $tags Change tags to add to the log entry and page revision.
1123          * @return FileRepoStatus On success, the value member contains the
1124          *     archive name, or an empty string if it was a new file.
1125          */
1126         function upload( $srcPath, $comment, $pageText, $flags = 0, $props = false,
1127                 $timestamp = false, $user = null, $tags = array()
1128         ) {
1129                 global $wgContLang;
1130
1131                 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
1132                         return $this->readOnlyFatalStatus();
1133                 }
1134
1135                 if ( !$props ) {
1136                         if ( $this->repo->isVirtualUrl( $srcPath )
1137                                 || FileBackend::isStoragePath( $srcPath )
1138                         ) {
1139                                 $props = $this->repo->getFileProps( $srcPath );
1140                         } else {
1141                                 $props = FSFile::getPropsFromPath( $srcPath );
1142                         }
1143                 }
1144
1145                 $options = array();
1146                 $handler = MediaHandler::getHandler( $props['mime'] );
1147                 if ( $handler ) {
1148                         $options['headers'] = $handler->getStreamHeaders( $props['metadata'] );
1149                 } else {
1150                         $options['headers'] = array();
1151                 }
1152
1153                 // Trim spaces on user supplied text
1154                 $comment = trim( $comment );
1155
1156                 // Truncate nicely or the DB will do it for us
1157                 // non-nicely (dangling multi-byte chars, non-truncated version in cache).
1158                 $comment = $wgContLang->truncate( $comment, 255 );
1159                 $this->lock(); // begin
1160                 $status = $this->publish( $srcPath, $flags, $options );
1161
1162                 if ( $status->successCount >= 2 ) {
1163                         // There will be a copy+(one of move,copy,store).
1164                         // The first succeeding does not commit us to updating the DB
1165                         // since it simply copied the current version to a timestamped file name.
1166                         // It is only *preferable* to avoid leaving such files orphaned.
1167                         // Once the second operation goes through, then the current version was
1168                         // updated and we must therefore update the DB too.
1169                         $oldver = $status->value;
1170                         if ( !$this->recordUpload2( $oldver, $comment, $pageText, $props, $timestamp, $user, $tags ) ) {
1171                                 $status->fatal( 'filenotfound', $srcPath );
1172                         }
1173                 }
1174
1175                 $this->unlock(); // done
1176
1177                 return $status;
1178         }
1179
1180         /**
1181          * Record a file upload in the upload log and the image table
1182          * @param string $oldver
1183          * @param string $desc
1184          * @param string $license
1185          * @param string $copyStatus
1186          * @param string $source
1187          * @param bool $watch
1188          * @param string|bool $timestamp
1189          * @param User|null $user User object or null to use $wgUser
1190          * @return bool
1191          */
1192         function recordUpload( $oldver, $desc, $license = '', $copyStatus = '', $source = '',
1193                 $watch = false, $timestamp = false, User $user = null ) {
1194                 if ( !$user ) {
1195                         global $wgUser;
1196                         $user = $wgUser;
1197                 }
1198
1199                 $pageText = SpecialUpload::getInitialPageText( $desc, $license, $copyStatus, $source );
1200
1201                 if ( !$this->recordUpload2( $oldver, $desc, $pageText, false, $timestamp, $user ) ) {
1202                         return false;
1203                 }
1204
1205                 if ( $watch ) {
1206                         $user->addWatch( $this->getTitle() );
1207                 }
1208
1209                 return true;
1210         }
1211
1212         /**
1213          * Record a file upload in the upload log and the image table
1214          * @param string $oldver
1215          * @param string $comment
1216          * @param string $pageText
1217          * @param bool|array $props
1218          * @param string|bool $timestamp
1219          * @param null|User $user
1220          * @param string[] $tags
1221          * @return bool
1222          */
1223         function recordUpload2(
1224                 $oldver, $comment, $pageText, $props = false, $timestamp = false, $user = null, $tags = array()
1225         ) {
1226                 if ( is_null( $user ) ) {
1227                         global $wgUser;
1228                         $user = $wgUser;
1229                 }
1230
1231                 $dbw = $this->repo->getMasterDB();
1232
1233                 # Imports or such might force a certain timestamp; otherwise we generate
1234                 # it and can fudge it slightly to keep (name,timestamp) unique on re-upload.
1235                 if ( $timestamp === false ) {
1236                         $timestamp = $dbw->timestamp();
1237                         $allowTimeKludge = true;
1238                 } else {
1239                         $allowTimeKludge = false;
1240                 }
1241
1242                 $props = $props ?: $this->repo->getFileProps( $this->getVirtualUrl() );
1243                 $props['description'] = $comment;
1244                 $props['user'] = $user->getId();
1245                 $props['user_text'] = $user->getName();
1246                 $props['timestamp'] = wfTimestamp( TS_MW, $timestamp ); // DB -> TS_MW
1247                 $this->setProps( $props );
1248
1249                 # Fail now if the file isn't there
1250                 if ( !$this->fileExists ) {
1251                         wfDebug( __METHOD__ . ": File " . $this->getRel() . " went missing!\n" );
1252
1253                         return false;
1254                 }
1255
1256                 $dbw->startAtomic( __METHOD__ );
1257
1258                 # Test to see if the row exists using INSERT IGNORE
1259                 # This avoids race conditions by locking the row until the commit, and also
1260                 # doesn't deadlock. SELECT FOR UPDATE causes a deadlock for every race condition.
1261                 $dbw->insert( 'image',
1262                         array(
1263                                 'img_name' => $this->getName(),
1264                                 'img_size' => $this->size,
1265                                 'img_width' => intval( $this->width ),
1266                                 'img_height' => intval( $this->height ),
1267                                 'img_bits' => $this->bits,
1268                                 'img_media_type' => $this->media_type,
1269                                 'img_major_mime' => $this->major_mime,
1270                                 'img_minor_mime' => $this->minor_mime,
1271                                 'img_timestamp' => $timestamp,
1272                                 'img_description' => $comment,
1273                                 'img_user' => $user->getId(),
1274                                 'img_user_text' => $user->getName(),
1275                                 'img_metadata' => $dbw->encodeBlob( $this->metadata ),
1276                                 'img_sha1' => $this->sha1
1277                         ),
1278                         __METHOD__,
1279                         'IGNORE'
1280                 );
1281
1282                 $reupload = ( $dbw->affectedRows() == 0 );
1283                 if ( $reupload ) {
1284                         if ( $allowTimeKludge ) {
1285                                 # Use LOCK IN SHARE MODE to ignore any transaction snapshotting
1286                                 $ltimestamp = $dbw->selectField(
1287                                         'image',
1288                                         'img_timestamp',
1289                                         array( 'img_name' => $this->getName() ),
1290                                         __METHOD__,
1291                                         array( 'LOCK IN SHARE MODE' )
1292                                 );
1293                                 $lUnixtime = $ltimestamp ? wfTimestamp( TS_UNIX, $ltimestamp ) : false;
1294                                 # Avoid a timestamp that is not newer than the last version
1295                                 # TODO: the image/oldimage tables should be like page/revision with an ID field
1296                                 if ( $lUnixtime && wfTimestamp( TS_UNIX, $timestamp ) <= $lUnixtime ) {
1297                                         sleep( 1 ); // fast enough re-uploads would go far in the future otherwise
1298                                         $timestamp = $dbw->timestamp( $lUnixtime + 1 );
1299                                         $this->timestamp = wfTimestamp( TS_MW, $timestamp ); // DB -> TS_MW
1300                                 }
1301                         }
1302
1303                         # (bug 34993) Note: $oldver can be empty here, if the previous
1304                         # version of the file was broken. Allow registration of the new
1305                         # version to continue anyway, because that's better than having
1306                         # an image that's not fixable by user operations.
1307                         # Collision, this is an update of a file
1308                         # Insert previous contents into oldimage
1309                         $dbw->insertSelect( 'oldimage', 'image',
1310                                 array(
1311                                         'oi_name' => 'img_name',
1312                                         'oi_archive_name' => $dbw->addQuotes( $oldver ),
1313                                         'oi_size' => 'img_size',
1314                                         'oi_width' => 'img_width',
1315                                         'oi_height' => 'img_height',
1316                                         'oi_bits' => 'img_bits',
1317                                         'oi_timestamp' => 'img_timestamp',
1318                                         'oi_description' => 'img_description',
1319                                         'oi_user' => 'img_user',
1320                                         'oi_user_text' => 'img_user_text',
1321                                         'oi_metadata' => 'img_metadata',
1322                                         'oi_media_type' => 'img_media_type',
1323                                         'oi_major_mime' => 'img_major_mime',
1324                                         'oi_minor_mime' => 'img_minor_mime',
1325                                         'oi_sha1' => 'img_sha1'
1326                                 ),
1327                                 array( 'img_name' => $this->getName() ),
1328                                 __METHOD__
1329                         );
1330
1331                         # Update the current image row
1332                         $dbw->update( 'image',
1333                                 array(
1334                                         'img_size' => $this->size,
1335                                         'img_width' => intval( $this->width ),
1336                                         'img_height' => intval( $this->height ),
1337                                         'img_bits' => $this->bits,
1338                                         'img_media_type' => $this->media_type,
1339                                         'img_major_mime' => $this->major_mime,
1340                                         'img_minor_mime' => $this->minor_mime,
1341                                         'img_timestamp' => $timestamp,
1342                                         'img_description' => $comment,
1343                                         'img_user' => $user->getId(),
1344                                         'img_user_text' => $user->getName(),
1345                                         'img_metadata' => $dbw->encodeBlob( $this->metadata ),
1346                                         'img_sha1' => $this->sha1
1347                                 ),
1348                                 array( 'img_name' => $this->getName() ),
1349                                 __METHOD__
1350                         );
1351                 }
1352
1353                 $descTitle = $this->getTitle();
1354                 $descId = $descTitle->getArticleID();
1355                 $wikiPage = new WikiFilePage( $descTitle );
1356                 $wikiPage->setFile( $this );
1357
1358                 // Add the log entry...
1359                 $logEntry = new ManualLogEntry( 'upload', $reupload ? 'overwrite' : 'upload' );
1360                 $logEntry->setPerformer( $user );
1361                 $logEntry->setComment( $comment );
1362                 $logEntry->setTarget( $descTitle );
1363                 // Allow people using the api to associate log entries with the upload.
1364                 // Log has a timestamp, but sometimes different from upload timestamp.
1365                 $logEntry->setParameters(
1366                         array(
1367                                 'img_sha1' => $this->sha1,
1368                                 'img_timestamp' => $timestamp,
1369                         )
1370                 );
1371                 // Note we keep $logId around since during new image
1372                 // creation, page doesn't exist yet, so log_page = 0
1373                 // but we want it to point to the page we're making,
1374                 // so we later modify the log entry.
1375                 // For a similar reason, we avoid making an RC entry
1376                 // now and wait until the page exists.
1377                 $logId = $logEntry->insert();
1378
1379                 if ( $descTitle->exists() ) {
1380                         // Use own context to get the action text in content language
1381                         $formatter = LogFormatter::newFromEntry( $logEntry );
1382                         $formatter->setContext( RequestContext::newExtraneousContext( $descTitle ) );
1383                         $editSummary = $formatter->getPlainActionText();
1384
1385                         $nullRevision = Revision::newNullRevision(
1386                                 $dbw,
1387                                 $descId,
1388                                 $editSummary,
1389                                 false,
1390                                 $user
1391                         );
1392                         if ( $nullRevision ) {
1393                                 $nullRevision->insertOn( $dbw );
1394                                 Hooks::run(
1395                                         'NewRevisionFromEditComplete',
1396                                         array( $wikiPage, $nullRevision, $nullRevision->getParentId(), $user )
1397                                 );
1398                                 $wikiPage->updateRevisionOn( $dbw, $nullRevision );
1399                                 // Associate null revision id
1400                                 $logEntry->setAssociatedRevId( $nullRevision->getId() );
1401                         }
1402
1403                         $newPageContent = null;
1404                 } else {
1405                         // Make the description page and RC log entry post-commit
1406                         $newPageContent = ContentHandler::makeContent( $pageText, $descTitle );
1407                 }
1408
1409                 # Defer purges, page creation, and link updates in case they error out.
1410                 # The most important thing is that files and the DB registry stay synced.
1411                 $dbw->endAtomic( __METHOD__ );
1412
1413                 # Do some cache purges after final commit so that:
1414                 # a) Changes are more likely to be seen post-purge
1415                 # b) They won't cause rollback of the log publish/update above
1416                 $that = $this;
1417                 $dbw->onTransactionIdle( function () use (
1418                         $that, $reupload, $wikiPage, $newPageContent, $comment, $user, $logEntry, $logId, $descId, $tags
1419                 ) {
1420                         # Update memcache after the commit
1421                         $that->invalidateCache();
1422
1423                         $updateLogPage = false;
1424                         if ( $newPageContent ) {
1425                                 # New file page; create the description page.
1426                                 # There's already a log entry, so don't make a second RC entry
1427                                 # CDN and file cache for the description page are purged by doEditContent.
1428                                 $status = $wikiPage->doEditContent(
1429                                         $newPageContent,
1430                                         $comment,
1431                                         EDIT_NEW | EDIT_SUPPRESS_RC,
1432                                         false,
1433                                         $user
1434                                 );
1435
1436                                 if ( isset( $status->value['revision'] ) ) {
1437                                         // Associate new page revision id
1438                                         $logEntry->setAssociatedRevId( $status->value['revision']->getId() );
1439                                 }
1440                                 // This relies on the resetArticleID() call in WikiPage::insertOn(),
1441                                 // which is triggered on $descTitle by doEditContent() above.
1442                                 if ( isset( $status->value['revision'] ) ) {
1443                                         /** @var $rev Revision */
1444                                         $rev = $status->value['revision'];
1445                                         $updateLogPage = $rev->getPage();
1446                                 }
1447                         } else {
1448                                 # Existing file page: invalidate description page cache
1449                                 $wikiPage->getTitle()->invalidateCache();
1450                                 $wikiPage->getTitle()->purgeSquid();
1451                                 # Allow the new file version to be patrolled from the page footer
1452                                 Article::purgePatrolFooterCache( $descId );
1453                         }
1454
1455                         # Update associated rev id. This should be done by $logEntry->insert() earlier,
1456                         # but setAssociatedRevId() wasn't called at that point yet...
1457                         $logParams = $logEntry->getParameters();
1458                         $logParams['associated_rev_id'] = $logEntry->getAssociatedRevId();
1459                         $update = array( 'log_params' => LogEntryBase::makeParamBlob( $logParams ) );
1460                         if ( $updateLogPage ) {
1461                                 # Also log page, in case where we just created it above
1462                                 $update['log_page'] = $updateLogPage;
1463                         }
1464                         $that->getRepo()->getMasterDB()->update(
1465                                 'logging',
1466                                 $update,
1467                                 array( 'log_id' => $logId ),
1468                                 __METHOD__
1469                         );
1470                         $that->getRepo()->getMasterDB()->insert(
1471                                 'log_search',
1472                                 array(
1473                                         'ls_field' => 'associated_rev_id',
1474                                         'ls_value' => $logEntry->getAssociatedRevId(),
1475                                         'ls_log_id' => $logId,
1476                                 ),
1477                                 __METHOD__
1478                         );
1479
1480                         # Now that the log entry is up-to-date, make an RC entry.
1481                         $recentChange = $logEntry->publish( $logId );
1482
1483                         if ( $tags ) {
1484                                 ChangeTags::addTags(
1485                                         $tags,
1486                                         $recentChange ? $recentChange->getAttribute( 'rc_id' ) : null,
1487                                         $logEntry->getAssociatedRevId(),
1488                                         $logId
1489                                 );
1490                         }
1491
1492                         # Run hook for other updates (typically more cache purging)
1493                         Hooks::run( 'FileUpload', array( $that, $reupload, !$newPageContent ) );
1494
1495                         if ( $reupload ) {
1496                                 # Delete old thumbnails
1497                                 $that->purgeThumbnails();
1498                                 # Remove the old file from the CDN cache
1499                                 DeferredUpdates::addUpdate(
1500                                         new CdnCacheUpdate( array( $that->getUrl() ) ),
1501                                         DeferredUpdates::PRESEND
1502                                 );
1503                         } else {
1504                                 # Update backlink pages pointing to this title if created
1505                                 LinksUpdate::queueRecursiveJobsForTable( $that->getTitle(), 'imagelinks' );
1506                         }
1507                 } );
1508
1509                 if ( !$reupload ) {
1510                         # This is a new file, so update the image count
1511                         DeferredUpdates::addUpdate( SiteStatsUpdate::factory( array( 'images' => 1 ) ) );
1512                 }
1513
1514                 # Invalidate cache for all pages using this file
1515                 DeferredUpdates::addUpdate( new HTMLCacheUpdate( $this->getTitle(), 'imagelinks' ) );
1516
1517                 return true;
1518         }
1519
1520         /**
1521          * Move or copy a file to its public location. If a file exists at the
1522          * destination, move it to an archive. Returns a FileRepoStatus object with
1523          * the archive name in the "value" member on success.
1524          *
1525          * The archive name should be passed through to recordUpload for database
1526          * registration.
1527          *
1528          * @param string $srcPath Local filesystem path or virtual URL to the source image
1529          * @param int $flags A bitwise combination of:
1530          *     File::DELETE_SOURCE    Delete the source file, i.e. move rather than copy
1531          * @param array $options Optional additional parameters
1532          * @return FileRepoStatus On success, the value member contains the
1533          *     archive name, or an empty string if it was a new file.
1534          */
1535         function publish( $srcPath, $flags = 0, array $options = array() ) {
1536                 return $this->publishTo( $srcPath, $this->getRel(), $flags, $options );
1537         }
1538
1539         /**
1540          * Move or copy a file to a specified location. Returns a FileRepoStatus
1541          * object with the archive name in the "value" member on success.
1542          *
1543          * The archive name should be passed through to recordUpload for database
1544          * registration.
1545          *
1546          * @param string $srcPath Local filesystem path or virtual URL to the source image
1547          * @param string $dstRel Target relative path
1548          * @param int $flags A bitwise combination of:
1549          *     File::DELETE_SOURCE    Delete the source file, i.e. move rather than copy
1550          * @param array $options Optional additional parameters
1551          * @return FileRepoStatus On success, the value member contains the
1552          *     archive name, or an empty string if it was a new file.
1553          */
1554         function publishTo( $srcPath, $dstRel, $flags = 0, array $options = array() ) {
1555                 $repo = $this->getRepo();
1556                 if ( $repo->getReadOnlyReason() !== false ) {
1557                         return $this->readOnlyFatalStatus();
1558                 }
1559
1560                 $this->lock(); // begin
1561
1562                 $archiveName = wfTimestamp( TS_MW ) . '!' . $this->getName();
1563                 $archiveRel = 'archive/' . $this->getHashPath() . $archiveName;
1564
1565                 if ( $repo->hasSha1Storage() ) {
1566                         $sha1 = $repo->isVirtualUrl( $srcPath )
1567                                 ? $repo->getFileSha1( $srcPath )
1568                                 : File::sha1Base36( $srcPath );
1569                         $dst = $repo->getBackend()->getPathForSHA1( $sha1 );
1570                         $status = $repo->quickImport( $srcPath, $dst );
1571                         if ( $flags & File::DELETE_SOURCE ) {
1572                                 unlink( $srcPath );
1573                         }
1574
1575                         if ( $this->exists() ) {
1576                                 $status->value = $archiveName;
1577                         }
1578                 } else {
1579                         $flags = $flags & File::DELETE_SOURCE ? LocalRepo::DELETE_SOURCE : 0;
1580                         $status = $repo->publish( $srcPath, $dstRel, $archiveRel, $flags, $options );
1581
1582                         if ( $status->value == 'new' ) {
1583                                 $status->value = '';
1584                         } else {
1585                                 $status->value = $archiveName;
1586                         }
1587                 }
1588
1589                 $this->unlock(); // done
1590
1591                 return $status;
1592         }
1593
1594         /** getLinksTo inherited */
1595         /** getExifData inherited */
1596         /** isLocal inherited */
1597         /** wasDeleted inherited */
1598
1599         /**
1600          * Move file to the new title
1601          *
1602          * Move current, old version and all thumbnails
1603          * to the new filename. Old file is deleted.
1604          *
1605          * Cache purging is done; checks for validity
1606          * and logging are caller's responsibility
1607          *
1608          * @param Title $target New file name
1609          * @return FileRepoStatus
1610          */
1611         function move( $target ) {
1612                 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
1613                         return $this->readOnlyFatalStatus();
1614                 }
1615
1616                 wfDebugLog( 'imagemove', "Got request to move {$this->name} to " . $target->getText() );
1617                 $batch = new LocalFileMoveBatch( $this, $target );
1618
1619                 $this->lock(); // begin
1620                 $batch->addCurrent();
1621                 $archiveNames = $batch->addOlds();
1622                 $status = $batch->execute();
1623                 $this->unlock(); // done
1624
1625                 wfDebugLog( 'imagemove', "Finished moving {$this->name}" );
1626
1627                 // Purge the source and target files...
1628                 $oldTitleFile = wfLocalFile( $this->title );
1629                 $newTitleFile = wfLocalFile( $target );
1630                 // Hack: the lock()/unlock() pair is nested in a transaction so the locking is not
1631                 // tied to BEGIN/COMMIT. To avoid slow purges in the transaction, move them outside.
1632                 $this->getRepo()->getMasterDB()->onTransactionIdle(
1633                         function () use ( $oldTitleFile, $newTitleFile, $archiveNames ) {
1634                                 $oldTitleFile->purgeEverything();
1635                                 foreach ( $archiveNames as $archiveName ) {
1636                                         $oldTitleFile->purgeOldThumbnails( $archiveName );
1637                                 }
1638                                 $newTitleFile->purgeEverything();
1639                         }
1640                 );
1641
1642                 if ( $status->isOK() ) {
1643                         // Now switch the object
1644                         $this->title = $target;
1645                         // Force regeneration of the name and hashpath
1646                         unset( $this->name );
1647                         unset( $this->hashPath );
1648                 }
1649
1650                 return $status;
1651         }
1652
1653         /**
1654          * Delete all versions of the file.
1655          *
1656          * Moves the files into an archive directory (or deletes them)
1657          * and removes the database rows.
1658          *
1659          * Cache purging is done; logging is caller's responsibility.
1660          *
1661          * @param string $reason
1662          * @param bool $suppress
1663          * @param User|null $user
1664          * @return FileRepoStatus
1665          */
1666         function delete( $reason, $suppress = false, $user = null ) {
1667                 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
1668                         return $this->readOnlyFatalStatus();
1669                 }
1670
1671                 $batch = new LocalFileDeleteBatch( $this, $reason, $suppress, $user );
1672
1673                 $this->lock(); // begin
1674                 $batch->addCurrent();
1675                 # Get old version relative paths
1676                 $archiveNames = $batch->addOlds();
1677                 $status = $batch->execute();
1678                 $this->unlock(); // done
1679
1680                 if ( $status->isOK() ) {
1681                         DeferredUpdates::addUpdate( SiteStatsUpdate::factory( array( 'images' => -1 ) ) );
1682                 }
1683
1684                 // Hack: the lock()/unlock() pair is nested in a transaction so the locking is not
1685                 // tied to BEGIN/COMMIT. To avoid slow purges in the transaction, move them outside.
1686                 $that = $this;
1687                 $this->getRepo()->getMasterDB()->onTransactionIdle(
1688                         function () use ( $that, $archiveNames ) {
1689                                 $that->purgeEverything();
1690                                 foreach ( $archiveNames as $archiveName ) {
1691                                         $that->purgeOldThumbnails( $archiveName );
1692                                 }
1693                         }
1694                 );
1695
1696                 // Purge the CDN
1697                 $purgeUrls = array();
1698                 foreach ( $archiveNames as $archiveName ) {
1699                         $purgeUrls[] = $this->getArchiveUrl( $archiveName );
1700                 }
1701                 DeferredUpdates::addUpdate( new CdnCacheUpdate( $purgeUrls ), DeferredUpdates::PRESEND );
1702
1703                 return $status;
1704         }
1705
1706         /**
1707          * Delete an old version of the file.
1708          *
1709          * Moves the file into an archive directory (or deletes it)
1710          * and removes the database row.
1711          *
1712          * Cache purging is done; logging is caller's responsibility.
1713          *
1714          * @param string $archiveName
1715          * @param string $reason
1716          * @param bool $suppress
1717          * @param User|null $user
1718          * @throws MWException Exception on database or file store failure
1719          * @return FileRepoStatus
1720          */
1721         function deleteOld( $archiveName, $reason, $suppress = false, $user = null ) {
1722                 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
1723                         return $this->readOnlyFatalStatus();
1724                 }
1725
1726                 $batch = new LocalFileDeleteBatch( $this, $reason, $suppress, $user );
1727
1728                 $this->lock(); // begin
1729                 $batch->addOld( $archiveName );
1730                 $status = $batch->execute();
1731                 $this->unlock(); // done
1732
1733                 $this->purgeOldThumbnails( $archiveName );
1734                 if ( $status->isOK() ) {
1735                         $this->purgeDescription();
1736                 }
1737
1738                 DeferredUpdates::addUpdate(
1739                         new CdnCacheUpdate( array( $this->getArchiveUrl( $archiveName ) ) ),
1740                         DeferredUpdates::PRESEND
1741                 );
1742
1743                 return $status;
1744         }
1745
1746         /**
1747          * Restore all or specified deleted revisions to the given file.
1748          * Permissions and logging are left to the caller.
1749          *
1750          * May throw database exceptions on error.
1751          *
1752          * @param array $versions Set of record ids of deleted items to restore,
1753          *   or empty to restore all revisions.
1754          * @param bool $unsuppress
1755          * @return FileRepoStatus
1756          */
1757         function restore( $versions = array(), $unsuppress = false ) {
1758                 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
1759                         return $this->readOnlyFatalStatus();
1760                 }
1761
1762                 $batch = new LocalFileRestoreBatch( $this, $unsuppress );
1763
1764                 $this->lock(); // begin
1765                 if ( !$versions ) {
1766                         $batch->addAll();
1767                 } else {
1768                         $batch->addIds( $versions );
1769                 }
1770                 $status = $batch->execute();
1771                 if ( $status->isGood() ) {
1772                         $cleanupStatus = $batch->cleanup();
1773                         $cleanupStatus->successCount = 0;
1774                         $cleanupStatus->failCount = 0;
1775                         $status->merge( $cleanupStatus );
1776                 }
1777                 $this->unlock(); // done
1778
1779                 return $status;
1780         }
1781
1782         /** isMultipage inherited */
1783         /** pageCount inherited */
1784         /** scaleHeight inherited */
1785         /** getImageSize inherited */
1786
1787         /**
1788          * Get the URL of the file description page.
1789          * @return string
1790          */
1791         function getDescriptionUrl() {
1792                 return $this->title->getLocalURL();
1793         }
1794
1795         /**
1796          * Get the HTML text of the description page
1797          * This is not used by ImagePage for local files, since (among other things)
1798          * it skips the parser cache.
1799          *
1800          * @param Language $lang What language to get description in (Optional)
1801          * @return bool|mixed
1802          */
1803         function getDescriptionText( $lang = null ) {
1804                 $revision = Revision::newFromTitle( $this->title, false, Revision::READ_NORMAL );
1805                 if ( !$revision ) {
1806                         return false;
1807                 }
1808                 $content = $revision->getContent();
1809                 if ( !$content ) {
1810                         return false;
1811                 }
1812                 $pout = $content->getParserOutput( $this->title, null, new ParserOptions( null, $lang ) );
1813
1814                 return $pout->getText();
1815         }
1816
1817         /**
1818          * @param int $audience
1819          * @param User $user
1820          * @return string
1821          */
1822         function getDescription( $audience = self::FOR_PUBLIC, User $user = null ) {
1823                 $this->load();
1824                 if ( $audience == self::FOR_PUBLIC && $this->isDeleted( self::DELETED_COMMENT ) ) {
1825                         return '';
1826                 } elseif ( $audience == self::FOR_THIS_USER
1827                         && !$this->userCan( self::DELETED_COMMENT, $user )
1828                 ) {
1829                         return '';
1830                 } else {
1831                         return $this->description;
1832                 }
1833         }
1834
1835         /**
1836          * @return bool|string
1837          */
1838         function getTimestamp() {
1839                 $this->load();
1840
1841                 return $this->timestamp;
1842         }
1843
1844         /**
1845          * @return bool|string
1846          */
1847         public function getDescriptionTouched() {
1848                 // The DB lookup might return false, e.g. if the file was just deleted, or the shared DB repo
1849                 // itself gets it from elsewhere. To avoid repeating the DB lookups in such a case, we
1850                 // need to differentiate between null (uninitialized) and false (failed to load).
1851                 if ( $this->descriptionTouched === null ) {
1852                         $cond = array(
1853                                 'page_namespace' => $this->title->getNamespace(),
1854                                 'page_title' => $this->title->getDBkey()
1855                         );
1856                         $touched = $this->repo->getSlaveDB()->selectField( 'page', 'page_touched', $cond, __METHOD__ );
1857                         $this->descriptionTouched = $touched ? wfTimestamp( TS_MW, $touched ) : false;
1858                 }
1859
1860                 return $this->descriptionTouched;
1861         }
1862
1863         /**
1864          * @return string
1865          */
1866         function getSha1() {
1867                 $this->load();
1868                 // Initialise now if necessary
1869                 if ( $this->sha1 == '' && $this->fileExists ) {
1870                         $this->lock(); // begin
1871
1872                         $this->sha1 = $this->repo->getFileSha1( $this->getPath() );
1873                         if ( !wfReadOnly() && strval( $this->sha1 ) != '' ) {
1874                                 $dbw = $this->repo->getMasterDB();
1875                                 $dbw->update( 'image',
1876                                         array( 'img_sha1' => $this->sha1 ),
1877                                         array( 'img_name' => $this->getName() ),
1878                                         __METHOD__ );
1879                                 $this->invalidateCache();
1880                         }
1881
1882                         $this->unlock(); // done
1883                 }
1884
1885                 return $this->sha1;
1886         }
1887
1888         /**
1889          * @return bool Whether to cache in RepoGroup (this avoids OOMs)
1890          */
1891         function isCacheable() {
1892                 $this->load();
1893
1894                 // If extra data (metadata) was not loaded then it must have been large
1895                 return $this->extraDataLoaded
1896                 && strlen( serialize( $this->metadata ) ) <= self::CACHE_FIELD_MAX_LEN;
1897         }
1898
1899         /**
1900          * Start a transaction and lock the image for update
1901          * Increments a reference counter if the lock is already held
1902          * @throws MWException Throws an error if the lock was not acquired
1903          * @return bool Whether the file lock owns/spawned the DB transaction
1904          */
1905         function lock() {
1906                 $dbw = $this->repo->getMasterDB();
1907
1908                 if ( !$this->locked ) {
1909                         if ( !$dbw->trxLevel() ) {
1910                                 $dbw->begin( __METHOD__ );
1911                                 $this->lockedOwnTrx = true;
1912                         }
1913                         $this->locked++;
1914                         // Bug 54736: use simple lock to handle when the file does not exist.
1915                         // SELECT FOR UPDATE prevents changes, not other SELECTs with FOR UPDATE.
1916                         // Also, that would cause contention on INSERT of similarly named rows.
1917                         $backend = $this->getRepo()->getBackend();
1918                         $lockPaths = array( $this->getPath() ); // represents all versions of the file
1919                         $status = $backend->lockFiles( $lockPaths, LockManager::LOCK_EX, 5 );
1920                         if ( !$status->isGood() ) {
1921                                 throw new MWException( "Could not acquire lock for '{$this->getName()}.'" );
1922                         }
1923                         $dbw->onTransactionIdle( function () use ( $backend, $lockPaths ) {
1924                                 $backend->unlockFiles( $lockPaths, LockManager::LOCK_EX ); // release on commit
1925                         } );
1926                 }
1927
1928                 return $this->lockedOwnTrx;
1929         }
1930
1931         /**
1932          * Decrement the lock reference count. If the reference count is reduced to zero, commits
1933          * the transaction and thereby releases the image lock.
1934          */
1935         function unlock() {
1936                 if ( $this->locked ) {
1937                         --$this->locked;
1938                         if ( !$this->locked && $this->lockedOwnTrx ) {
1939                                 $dbw = $this->repo->getMasterDB();
1940                                 $dbw->commit( __METHOD__ );
1941                                 $this->lockedOwnTrx = false;
1942                         }
1943                 }
1944         }
1945
1946         /**
1947          * Roll back the DB transaction and mark the image unlocked
1948          */
1949         function unlockAndRollback() {
1950                 $this->locked = false;
1951                 $dbw = $this->repo->getMasterDB();
1952                 $dbw->rollback( __METHOD__ );
1953                 $this->lockedOwnTrx = false;
1954         }
1955
1956         /**
1957          * @return Status
1958          */
1959         protected function readOnlyFatalStatus() {
1960                 return $this->getRepo()->newFatal( 'filereadonlyerror', $this->getName(),
1961                         $this->getRepo()->getName(), $this->getRepo()->getReadOnlyReason() );
1962         }
1963
1964         /**
1965          * Clean up any dangling locks
1966          */
1967         function __destruct() {
1968                 $this->unlock();
1969         }
1970 } // LocalFile class
1971
1972 # ------------------------------------------------------------------------------
1973
1974 /**
1975  * Helper class for file deletion
1976  * @ingroup FileAbstraction
1977  */
1978 class LocalFileDeleteBatch {
1979         /** @var LocalFile */
1980         private $file;
1981
1982         /** @var string */
1983         private $reason;
1984
1985         /** @var array */
1986         private $srcRels = array();
1987
1988         /** @var array */
1989         private $archiveUrls = array();
1990
1991         /** @var array Items to be processed in the deletion batch */
1992         private $deletionBatch;
1993
1994         /** @var bool Whether to suppress all suppressable fields when deleting */
1995         private $suppress;
1996
1997         /** @var FileRepoStatus */
1998         private $status;
1999
2000         /** @var User */
2001         private $user;
2002
2003         /**
2004          * @param File $file
2005          * @param string $reason
2006          * @param bool $suppress
2007          * @param User|null $user
2008          */
2009         function __construct( File $file, $reason = '', $suppress = false, $user = null ) {
2010                 $this->file = $file;
2011                 $this->reason = $reason;
2012                 $this->suppress = $suppress;
2013                 if ( $user ) {
2014                         $this->user = $user;
2015                 } else {
2016                         global $wgUser;
2017                         $this->user = $wgUser;
2018                 }
2019                 $this->status = $file->repo->newGood();
2020         }
2021
2022         public function addCurrent() {
2023                 $this->srcRels['.'] = $this->file->getRel();
2024         }
2025
2026         /**
2027          * @param string $oldName
2028          */
2029         public function addOld( $oldName ) {
2030                 $this->srcRels[$oldName] = $this->file->getArchiveRel( $oldName );
2031                 $this->archiveUrls[] = $this->file->getArchiveUrl( $oldName );
2032         }
2033
2034         /**
2035          * Add the old versions of the image to the batch
2036          * @return array List of archive names from old versions
2037          */
2038         public function addOlds() {
2039                 $archiveNames = array();
2040
2041                 $dbw = $this->file->repo->getMasterDB();
2042                 $result = $dbw->select( 'oldimage',
2043                         array( 'oi_archive_name' ),
2044                         array( 'oi_name' => $this->file->getName() ),
2045                         __METHOD__
2046                 );
2047
2048                 foreach ( $result as $row ) {
2049                         $this->addOld( $row->oi_archive_name );
2050                         $archiveNames[] = $row->oi_archive_name;
2051                 }
2052
2053                 return $archiveNames;
2054         }
2055
2056         /**
2057          * @return array
2058          */
2059         protected function getOldRels() {
2060                 if ( !isset( $this->srcRels['.'] ) ) {
2061                         $oldRels =& $this->srcRels;
2062                         $deleteCurrent = false;
2063                 } else {
2064                         $oldRels = $this->srcRels;
2065                         unset( $oldRels['.'] );
2066                         $deleteCurrent = true;
2067                 }
2068
2069                 return array( $oldRels, $deleteCurrent );
2070         }
2071
2072         /**
2073          * @return array
2074          */
2075         protected function getHashes() {
2076                 $hashes = array();
2077                 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
2078
2079                 if ( $deleteCurrent ) {
2080                         $hashes['.'] = $this->file->getSha1();
2081                 }
2082
2083                 if ( count( $oldRels ) ) {
2084                         $dbw = $this->file->repo->getMasterDB();
2085                         $res = $dbw->select(
2086                                 'oldimage',
2087                                 array( 'oi_archive_name', 'oi_sha1' ),
2088                                 array( 'oi_archive_name' => array_keys( $oldRels ),
2089                                         'oi_name' => $this->file->getName() ), // performance
2090                                 __METHOD__
2091                         );
2092
2093                         foreach ( $res as $row ) {
2094                                 if ( rtrim( $row->oi_sha1, "\0" ) === '' ) {
2095                                         // Get the hash from the file
2096                                         $oldUrl = $this->file->getArchiveVirtualUrl( $row->oi_archive_name );
2097                                         $props = $this->file->repo->getFileProps( $oldUrl );
2098
2099                                         if ( $props['fileExists'] ) {
2100                                                 // Upgrade the oldimage row
2101                                                 $dbw->update( 'oldimage',
2102                                                         array( 'oi_sha1' => $props['sha1'] ),
2103                                                         array( 'oi_name' => $this->file->getName(), 'oi_archive_name' => $row->oi_archive_name ),
2104                                                         __METHOD__ );
2105                                                 $hashes[$row->oi_archive_name] = $props['sha1'];
2106                                         } else {
2107                                                 $hashes[$row->oi_archive_name] = false;
2108                                         }
2109                                 } else {
2110                                         $hashes[$row->oi_archive_name] = $row->oi_sha1;
2111                                 }
2112                         }
2113                 }
2114
2115                 $missing = array_diff_key( $this->srcRels, $hashes );
2116
2117                 foreach ( $missing as $name => $rel ) {
2118                         $this->status->error( 'filedelete-old-unregistered', $name );
2119                 }
2120
2121                 foreach ( $hashes as $name => $hash ) {
2122                         if ( !$hash ) {
2123                                 $this->status->error( 'filedelete-missing', $this->srcRels[$name] );
2124                                 unset( $hashes[$name] );
2125                         }
2126                 }
2127
2128                 return $hashes;
2129         }
2130
2131         protected function doDBInserts() {
2132                 $dbw = $this->file->repo->getMasterDB();
2133                 $encTimestamp = $dbw->addQuotes( $dbw->timestamp() );
2134                 $encUserId = $dbw->addQuotes( $this->user->getId() );
2135                 $encReason = $dbw->addQuotes( $this->reason );
2136                 $encGroup = $dbw->addQuotes( 'deleted' );
2137                 $ext = $this->file->getExtension();
2138                 $dotExt = $ext === '' ? '' : ".$ext";
2139                 $encExt = $dbw->addQuotes( $dotExt );
2140                 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
2141
2142                 // Bitfields to further suppress the content
2143                 if ( $this->suppress ) {
2144                         $bitfield = 0;
2145                         // This should be 15...
2146                         $bitfield |= Revision::DELETED_TEXT;
2147                         $bitfield |= Revision::DELETED_COMMENT;
2148                         $bitfield |= Revision::DELETED_USER;
2149                         $bitfield |= Revision::DELETED_RESTRICTED;
2150                 } else {
2151                         $bitfield = 'oi_deleted';
2152                 }
2153
2154                 if ( $deleteCurrent ) {
2155                         $concat = $dbw->buildConcat( array( "img_sha1", $encExt ) );
2156                         $where = array( 'img_name' => $this->file->getName() );
2157                         $dbw->insertSelect( 'filearchive', 'image',
2158                                 array(
2159                                         'fa_storage_group' => $encGroup,
2160                                         'fa_storage_key' => $dbw->conditional(
2161                                                 array( 'img_sha1' => '' ),
2162                                                 $dbw->addQuotes( '' ),
2163                                                 $concat
2164                                         ),
2165                                         'fa_deleted_user' => $encUserId,
2166                                         'fa_deleted_timestamp' => $encTimestamp,
2167                                         'fa_deleted_reason' => $encReason,
2168                                         'fa_deleted' => $this->suppress ? $bitfield : 0,
2169
2170                                         'fa_name' => 'img_name',
2171                                         'fa_archive_name' => 'NULL',
2172                                         'fa_size' => 'img_size',
2173                                         'fa_width' => 'img_width',
2174                                         'fa_height' => 'img_height',
2175                                         'fa_metadata' => 'img_metadata',
2176                                         'fa_bits' => 'img_bits',
2177                                         'fa_media_type' => 'img_media_type',
2178                                         'fa_major_mime' => 'img_major_mime',
2179                                         'fa_minor_mime' => 'img_minor_mime',
2180                                         'fa_description' => 'img_description',
2181                                         'fa_user' => 'img_user',
2182                                         'fa_user_text' => 'img_user_text',
2183                                         'fa_timestamp' => 'img_timestamp',
2184                                         'fa_sha1' => 'img_sha1',
2185                                 ), $where, __METHOD__ );
2186                 }
2187
2188                 if ( count( $oldRels ) ) {
2189                         $concat = $dbw->buildConcat( array( "oi_sha1", $encExt ) );
2190                         $where = array(
2191                                 'oi_name' => $this->file->getName(),
2192                                 'oi_archive_name' => array_keys( $oldRels ) );
2193                         $dbw->insertSelect( 'filearchive', 'oldimage',
2194                                 array(
2195                                         'fa_storage_group' => $encGroup,
2196                                         'fa_storage_key' => $dbw->conditional(
2197                                                 array( 'oi_sha1' => '' ),
2198                                                 $dbw->addQuotes( '' ),
2199                                                 $concat
2200                                         ),
2201                                         'fa_deleted_user' => $encUserId,
2202                                         'fa_deleted_timestamp' => $encTimestamp,
2203                                         'fa_deleted_reason' => $encReason,
2204                                         'fa_deleted' => $this->suppress ? $bitfield : 'oi_deleted',
2205
2206                                         'fa_name' => 'oi_name',
2207                                         'fa_archive_name' => 'oi_archive_name',
2208                                         'fa_size' => 'oi_size',
2209                                         'fa_width' => 'oi_width',
2210                                         'fa_height' => 'oi_height',
2211                                         'fa_metadata' => 'oi_metadata',
2212                                         'fa_bits' => 'oi_bits',
2213                                         'fa_media_type' => 'oi_media_type',
2214                                         'fa_major_mime' => 'oi_major_mime',
2215                                         'fa_minor_mime' => 'oi_minor_mime',
2216                                         'fa_description' => 'oi_description',
2217                                         'fa_user' => 'oi_user',
2218                                         'fa_user_text' => 'oi_user_text',
2219                                         'fa_timestamp' => 'oi_timestamp',
2220                                         'fa_sha1' => 'oi_sha1',
2221                                 ), $where, __METHOD__ );
2222                 }
2223         }
2224
2225         function doDBDeletes() {
2226                 $dbw = $this->file->repo->getMasterDB();
2227                 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
2228
2229                 if ( count( $oldRels ) ) {
2230                         $dbw->delete( 'oldimage',
2231                                 array(
2232                                         'oi_name' => $this->file->getName(),
2233                                         'oi_archive_name' => array_keys( $oldRels )
2234                                 ), __METHOD__ );
2235                 }
2236
2237                 if ( $deleteCurrent ) {
2238                         $dbw->delete( 'image', array( 'img_name' => $this->file->getName() ), __METHOD__ );
2239                 }
2240         }
2241
2242         /**
2243          * Run the transaction
2244          * @return FileRepoStatus
2245          */
2246         public function execute() {
2247                 $repo = $this->file->getRepo();
2248                 $this->file->lock();
2249
2250                 // Prepare deletion batch
2251                 $hashes = $this->getHashes();
2252                 $this->deletionBatch = array();
2253                 $ext = $this->file->getExtension();
2254                 $dotExt = $ext === '' ? '' : ".$ext";
2255
2256                 foreach ( $this->srcRels as $name => $srcRel ) {
2257                         // Skip files that have no hash (e.g. missing DB record, or sha1 field and file source)
2258                         if ( isset( $hashes[$name] ) ) {
2259                                 $hash = $hashes[$name];
2260                                 $key = $hash . $dotExt;
2261                                 $dstRel = $repo->getDeletedHashPath( $key ) . $key;
2262                                 $this->deletionBatch[$name] = array( $srcRel, $dstRel );
2263                         }
2264                 }
2265
2266                 // Lock the filearchive rows so that the files don't get deleted by a cleanup operation
2267                 // We acquire this lock by running the inserts now, before the file operations.
2268                 // This potentially has poor lock contention characteristics -- an alternative
2269                 // scheme would be to insert stub filearchive entries with no fa_name and commit
2270                 // them in a separate transaction, then run the file ops, then update the fa_name fields.
2271                 $this->doDBInserts();
2272
2273                 if ( !$repo->hasSha1Storage() ) {
2274                         // Removes non-existent file from the batch, so we don't get errors.
2275                         // This also handles files in the 'deleted' zone deleted via revision deletion.
2276                         $checkStatus = $this->removeNonexistentFiles( $this->deletionBatch );
2277                         if ( !$checkStatus->isGood() ) {
2278                                 $this->status->merge( $checkStatus );
2279                                 return $this->status;
2280                         }
2281                         $this->deletionBatch = $checkStatus->value;
2282
2283                         // Execute the file deletion batch
2284                         $status = $this->file->repo->deleteBatch( $this->deletionBatch );
2285
2286                         if ( !$status->isGood() ) {
2287                                 $this->status->merge( $status );
2288                         }
2289                 }
2290
2291                 if ( !$this->status->isOK() ) {
2292                         // Critical file deletion error
2293                         // Roll back inserts, release lock and abort
2294                         // TODO: delete the defunct filearchive rows if we are using a non-transactional DB
2295                         $this->file->unlockAndRollback();
2296
2297                         return $this->status;
2298                 }
2299
2300                 // Delete image/oldimage rows
2301                 $this->doDBDeletes();
2302
2303                 // Commit and return
2304                 $this->file->unlock();
2305
2306                 return $this->status;
2307         }
2308
2309         /**
2310          * Removes non-existent files from a deletion batch.
2311          * @param array $batch
2312          * @return Status
2313          */
2314         protected function removeNonexistentFiles( $batch ) {
2315                 $files = $newBatch = array();
2316
2317                 foreach ( $batch as $batchItem ) {
2318                         list( $src, ) = $batchItem;
2319                         $files[$src] = $this->file->repo->getVirtualUrl( 'public' ) . '/' . rawurlencode( $src );
2320                 }
2321
2322                 $result = $this->file->repo->fileExistsBatch( $files );
2323                 if ( in_array( null, $result, true ) ) {
2324                         return Status::newFatal( 'backend-fail-internal',
2325                                 $this->file->repo->getBackend()->getName() );
2326                 }
2327
2328                 foreach ( $batch as $batchItem ) {
2329                         if ( $result[$batchItem[0]] ) {
2330                                 $newBatch[] = $batchItem;
2331                         }
2332                 }
2333
2334                 return Status::newGood( $newBatch );
2335         }
2336 }
2337
2338 # ------------------------------------------------------------------------------
2339
2340 /**
2341  * Helper class for file undeletion
2342  * @ingroup FileAbstraction
2343  */
2344 class LocalFileRestoreBatch {
2345         /** @var LocalFile */
2346         private $file;
2347
2348         /** @var array List of file IDs to restore */
2349         private $cleanupBatch;
2350
2351         /** @var array List of file IDs to restore */
2352         private $ids;
2353
2354         /** @var bool Add all revisions of the file */
2355         private $all;
2356
2357         /** @var bool Whether to remove all settings for suppressed fields */
2358         private $unsuppress = false;
2359
2360         /**
2361          * @param File $file
2362          * @param bool $unsuppress
2363          */
2364         function __construct( File $file, $unsuppress = false ) {
2365                 $this->file = $file;
2366                 $this->cleanupBatch = $this->ids = array();
2367                 $this->ids = array();
2368                 $this->unsuppress = $unsuppress;
2369         }
2370
2371         /**
2372          * Add a file by ID
2373          * @param int $fa_id
2374          */
2375         public function addId( $fa_id ) {
2376                 $this->ids[] = $fa_id;
2377         }
2378
2379         /**
2380          * Add a whole lot of files by ID
2381          * @param int[] $ids
2382          */
2383         public function addIds( $ids ) {
2384                 $this->ids = array_merge( $this->ids, $ids );
2385         }
2386
2387         /**
2388          * Add all revisions of the file
2389          */
2390         public function addAll() {
2391                 $this->all = true;
2392         }
2393
2394         /**
2395          * Run the transaction, except the cleanup batch.
2396          * The cleanup batch should be run in a separate transaction, because it locks different
2397          * rows and there's no need to keep the image row locked while it's acquiring those locks
2398          * The caller may have its own transaction open.
2399          * So we save the batch and let the caller call cleanup()
2400          * @return FileRepoStatus
2401          */
2402         public function execute() {
2403                 global $wgLang;
2404
2405                 $repo = $this->file->getRepo();
2406                 if ( !$this->all && !$this->ids ) {
2407                         // Do nothing
2408                         return $repo->newGood();
2409                 }
2410
2411                 $lockOwnsTrx = $this->file->lock();
2412
2413                 $dbw = $this->file->repo->getMasterDB();
2414                 $status = $this->file->repo->newGood();
2415
2416                 $exists = (bool)$dbw->selectField( 'image', '1',
2417                         array( 'img_name' => $this->file->getName() ),
2418                         __METHOD__,
2419                         // The lock() should already prevents changes, but this still may need
2420                         // to bypass any transaction snapshot. However, if lock() started the
2421                         // trx (which it probably did) then snapshot is post-lock and up-to-date.
2422                         $lockOwnsTrx ? array() : array( 'LOCK IN SHARE MODE' )
2423                 );
2424
2425                 // Fetch all or selected archived revisions for the file,
2426                 // sorted from the most recent to the oldest.
2427                 $conditions = array( 'fa_name' => $this->file->getName() );
2428
2429                 if ( !$this->all ) {
2430                         $conditions['fa_id'] = $this->ids;
2431                 }
2432
2433                 $result = $dbw->select(
2434                         'filearchive',
2435                         ArchivedFile::selectFields(),
2436                         $conditions,
2437                         __METHOD__,
2438                         array( 'ORDER BY' => 'fa_timestamp DESC' )
2439                 );
2440
2441                 $idsPresent = array();
2442                 $storeBatch = array();
2443                 $insertBatch = array();
2444                 $insertCurrent = false;
2445                 $deleteIds = array();
2446                 $first = true;
2447                 $archiveNames = array();
2448
2449                 foreach ( $result as $row ) {
2450                         $idsPresent[] = $row->fa_id;
2451
2452                         if ( $row->fa_name != $this->file->getName() ) {
2453                                 $status->error( 'undelete-filename-mismatch', $wgLang->timeanddate( $row->fa_timestamp ) );
2454                                 $status->failCount++;
2455                                 continue;
2456                         }
2457
2458                         if ( $row->fa_storage_key == '' ) {
2459                                 // Revision was missing pre-deletion
2460                                 $status->error( 'undelete-bad-store-key', $wgLang->timeanddate( $row->fa_timestamp ) );
2461                                 $status->failCount++;
2462                                 continue;
2463                         }
2464
2465                         $deletedRel = $repo->getDeletedHashPath( $row->fa_storage_key ) .
2466                                 $row->fa_storage_key;
2467                         $deletedUrl = $repo->getVirtualUrl() . '/deleted/' . $deletedRel;
2468
2469                         if ( isset( $row->fa_sha1 ) ) {
2470                                 $sha1 = $row->fa_sha1;
2471                         } else {
2472                                 // old row, populate from key
2473                                 $sha1 = LocalRepo::getHashFromKey( $row->fa_storage_key );
2474                         }
2475
2476                         # Fix leading zero
2477                         if ( strlen( $sha1 ) == 32 && $sha1[0] == '0' ) {
2478                                 $sha1 = substr( $sha1, 1 );
2479                         }
2480
2481                         if ( is_null( $row->fa_major_mime ) || $row->fa_major_mime == 'unknown'
2482                                 || is_null( $row->fa_minor_mime ) || $row->fa_minor_mime == 'unknown'
2483                                 || is_null( $row->fa_media_type ) || $row->fa_media_type == 'UNKNOWN'
2484                                 || is_null( $row->fa_metadata )
2485                         ) {
2486                                 // Refresh our metadata
2487                                 // Required for a new current revision; nice for older ones too. :)
2488                                 $props = RepoGroup::singleton()->getFileProps( $deletedUrl );
2489                         } else {
2490                                 $props = array(
2491                                         'minor_mime' => $row->fa_minor_mime,
2492                                         'major_mime' => $row->fa_major_mime,
2493                                         'media_type' => $row->fa_media_type,
2494                                         'metadata' => $row->fa_metadata
2495                                 );
2496                         }
2497
2498                         if ( $first && !$exists ) {
2499                                 // This revision will be published as the new current version
2500                                 $destRel = $this->file->getRel();
2501                                 $insertCurrent = array(
2502                                         'img_name' => $row->fa_name,
2503                                         'img_size' => $row->fa_size,
2504                                         'img_width' => $row->fa_width,
2505                                         'img_height' => $row->fa_height,
2506                                         'img_metadata' => $props['metadata'],
2507                                         'img_bits' => $row->fa_bits,
2508                                         'img_media_type' => $props['media_type'],
2509                                         'img_major_mime' => $props['major_mime'],
2510                                         'img_minor_mime' => $props['minor_mime'],
2511                                         'img_description' => $row->fa_description,
2512                                         'img_user' => $row->fa_user,
2513                                         'img_user_text' => $row->fa_user_text,
2514                                         'img_timestamp' => $row->fa_timestamp,
2515                                         'img_sha1' => $sha1
2516                                 );
2517
2518                                 // The live (current) version cannot be hidden!
2519                                 if ( !$this->unsuppress && $row->fa_deleted ) {
2520                                         $storeBatch[] = array( $deletedUrl, 'public', $destRel );
2521                                         $this->cleanupBatch[] = $row->fa_storage_key;
2522                                 }
2523                         } else {
2524                                 $archiveName = $row->fa_archive_name;
2525
2526                                 if ( $archiveName == '' ) {
2527                                         // This was originally a current version; we
2528                                         // have to devise a new archive name for it.
2529                                         // Format is <timestamp of archiving>!<name>
2530                                         $timestamp = wfTimestamp( TS_UNIX, $row->fa_deleted_timestamp );
2531
2532                                         do {
2533                                                 $archiveName = wfTimestamp( TS_MW, $timestamp ) . '!' . $row->fa_name;
2534                                                 $timestamp++;
2535                                         } while ( isset( $archiveNames[$archiveName] ) );
2536                                 }
2537
2538                                 $archiveNames[$archiveName] = true;
2539                                 $destRel = $this->file->getArchiveRel( $archiveName );
2540                                 $insertBatch[] = array(
2541                                         'oi_name' => $row->fa_name,
2542                                         'oi_archive_name' => $archiveName,
2543                                         'oi_size' => $row->fa_size,
2544                                         'oi_width' => $row->fa_width,
2545                                         'oi_height' => $row->fa_height,
2546                                         'oi_bits' => $row->fa_bits,
2547                                         'oi_description' => $row->fa_description,
2548                                         'oi_user' => $row->fa_user,
2549                                         'oi_user_text' => $row->fa_user_text,
2550                                         'oi_timestamp' => $row->fa_timestamp,
2551                                         'oi_metadata' => $props['metadata'],
2552                                         'oi_media_type' => $props['media_type'],
2553                                         'oi_major_mime' => $props['major_mime'],
2554                                         'oi_minor_mime' => $props['minor_mime'],
2555                                         'oi_deleted' => $this->unsuppress ? 0 : $row->fa_deleted,
2556                                         'oi_sha1' => $sha1 );
2557                         }
2558
2559                         $deleteIds[] = $row->fa_id;
2560
2561                         if ( !$this->unsuppress && $row->fa_deleted & File::DELETED_FILE ) {
2562                                 // private files can stay where they are
2563                                 $status->successCount++;
2564                         } else {
2565                                 $storeBatch[] = array( $deletedUrl, 'public', $destRel );
2566                                 $this->cleanupBatch[] = $row->fa_storage_key;
2567                         }
2568
2569                         $first = false;
2570                 }
2571
2572                 unset( $result );
2573
2574                 // Add a warning to the status object for missing IDs
2575                 $missingIds = array_diff( $this->ids, $idsPresent );
2576
2577                 foreach ( $missingIds as $id ) {
2578                         $status->error( 'undelete-missing-filearchive', $id );
2579                 }
2580
2581                 if ( !$repo->hasSha1Storage() ) {
2582                         // Remove missing files from batch, so we don't get errors when undeleting them
2583                         $checkStatus = $this->removeNonexistentFiles( $storeBatch );
2584                         if ( !$checkStatus->isGood() ) {
2585                                 $status->merge( $checkStatus );
2586                                 return $status;
2587                         }
2588                         $storeBatch = $checkStatus->value;
2589
2590                         // Run the store batch
2591                         // Use the OVERWRITE_SAME flag to smooth over a common error
2592                         $storeStatus = $this->file->repo->storeBatch( $storeBatch, FileRepo::OVERWRITE_SAME );
2593                         $status->merge( $storeStatus );
2594
2595                         if ( !$status->isGood() ) {
2596                                 // Even if some files could be copied, fail entirely as that is the
2597                                 // easiest thing to do without data loss
2598                                 $this->cleanupFailedBatch( $storeStatus, $storeBatch );
2599                                 $status->ok = false;
2600                                 $this->file->unlock();
2601
2602                                 return $status;
2603                         }
2604                 }
2605
2606                 // Run the DB updates
2607                 // Because we have locked the image row, key conflicts should be rare.
2608                 // If they do occur, we can roll back the transaction at this time with
2609                 // no data loss, but leaving unregistered files scattered throughout the
2610                 // public zone.
2611                 // This is not ideal, which is why it's important to lock the image row.
2612                 if ( $insertCurrent ) {
2613                         $dbw->insert( 'image', $insertCurrent, __METHOD__ );
2614                 }
2615
2616                 if ( $insertBatch ) {
2617                         $dbw->insert( 'oldimage', $insertBatch, __METHOD__ );
2618                 }
2619
2620                 if ( $deleteIds ) {
2621                         $dbw->delete( 'filearchive',
2622                                 array( 'fa_id' => $deleteIds ),
2623                                 __METHOD__ );
2624                 }
2625
2626                 // If store batch is empty (all files are missing), deletion is to be considered successful
2627                 if ( $status->successCount > 0 || !$storeBatch || $repo->hasSha1Storage() ) {
2628                         if ( !$exists ) {
2629                                 wfDebug( __METHOD__ . " restored {$status->successCount} items, creating a new current\n" );
2630
2631                                 DeferredUpdates::addUpdate( SiteStatsUpdate::factory( array( 'images' => 1 ) ) );
2632
2633                                 $this->file->purgeEverything();
2634                         } else {
2635                                 wfDebug( __METHOD__ . " restored {$status->successCount} as archived versions\n" );
2636                                 $this->file->purgeDescription();
2637                         }
2638                 }
2639
2640                 $this->file->unlock();
2641
2642                 return $status;
2643         }
2644
2645         /**
2646          * Removes non-existent files from a store batch.
2647          * @param array $triplets
2648          * @return Status
2649          */
2650         protected function removeNonexistentFiles( $triplets ) {
2651                 $files = $filteredTriplets = array();
2652                 foreach ( $triplets as $file ) {
2653                         $files[$file[0]] = $file[0];
2654                 }
2655
2656                 $result = $this->file->repo->fileExistsBatch( $files );
2657                 if ( in_array( null, $result, true ) ) {
2658                         return Status::newFatal( 'backend-fail-internal',
2659                                 $this->file->repo->getBackend()->getName() );
2660                 }
2661
2662                 foreach ( $triplets as $file ) {
2663                         if ( $result[$file[0]] ) {
2664                                 $filteredTriplets[] = $file;
2665                         }
2666                 }
2667
2668                 return Status::newGood( $filteredTriplets );
2669         }
2670
2671         /**
2672          * Removes non-existent files from a cleanup batch.
2673          * @param array $batch
2674          * @return array
2675          */
2676         protected function removeNonexistentFromCleanup( $batch ) {
2677                 $files = $newBatch = array();
2678                 $repo = $this->file->repo;
2679
2680                 foreach ( $batch as $file ) {
2681                         $files[$file] = $repo->getVirtualUrl( 'deleted' ) . '/' .
2682                                 rawurlencode( $repo->getDeletedHashPath( $file ) . $file );
2683                 }
2684
2685                 $result = $repo->fileExistsBatch( $files );
2686
2687                 foreach ( $batch as $file ) {
2688                         if ( $result[$file] ) {
2689                                 $newBatch[] = $file;
2690                         }
2691                 }
2692
2693                 return $newBatch;
2694         }
2695
2696         /**
2697          * Delete unused files in the deleted zone.
2698          * This should be called from outside the transaction in which execute() was called.
2699          * @return FileRepoStatus
2700          */
2701         public function cleanup() {
2702                 if ( !$this->cleanupBatch ) {
2703                         return $this->file->repo->newGood();
2704                 }
2705
2706                 $this->cleanupBatch = $this->removeNonexistentFromCleanup( $this->cleanupBatch );
2707
2708                 $status = $this->file->repo->cleanupDeletedBatch( $this->cleanupBatch );
2709
2710                 return $status;
2711         }
2712
2713         /**
2714          * Cleanup a failed batch. The batch was only partially successful, so
2715          * rollback by removing all items that were succesfully copied.
2716          *
2717          * @param Status $storeStatus
2718          * @param array $storeBatch
2719          */
2720         protected function cleanupFailedBatch( $storeStatus, $storeBatch ) {
2721                 $cleanupBatch = array();
2722
2723                 foreach ( $storeStatus->success as $i => $success ) {
2724                         // Check if this item of the batch was successfully copied
2725                         if ( $success ) {
2726                                 // Item was successfully copied and needs to be removed again
2727                                 // Extract ($dstZone, $dstRel) from the batch
2728                                 $cleanupBatch[] = array( $storeBatch[$i][1], $storeBatch[$i][2] );
2729                         }
2730                 }
2731                 $this->file->repo->cleanupBatch( $cleanupBatch );
2732         }
2733 }
2734
2735 # ------------------------------------------------------------------------------
2736
2737 /**
2738  * Helper class for file movement
2739  * @ingroup FileAbstraction
2740  */
2741 class LocalFileMoveBatch {
2742         /** @var LocalFile */
2743         protected $file;
2744
2745         /** @var Title */
2746         protected $target;
2747
2748         protected $cur;
2749
2750         protected $olds;
2751
2752         protected $oldCount;
2753
2754         protected $archive;
2755
2756         /** @var DatabaseBase */
2757         protected $db;
2758
2759         /**
2760          * @param File $file
2761          * @param Title $target
2762          */
2763         function __construct( File $file, Title $target ) {
2764                 $this->file = $file;
2765                 $this->target = $target;
2766                 $this->oldHash = $this->file->repo->getHashPath( $this->file->getName() );
2767                 $this->newHash = $this->file->repo->getHashPath( $this->target->getDBkey() );
2768                 $this->oldName = $this->file->getName();
2769                 $this->newName = $this->file->repo->getNameFromTitle( $this->target );
2770                 $this->oldRel = $this->oldHash . $this->oldName;
2771                 $this->newRel = $this->newHash . $this->newName;
2772                 $this->db = $file->getRepo()->getMasterDb();
2773         }
2774
2775         /**
2776          * Add the current image to the batch
2777          */
2778         public function addCurrent() {
2779                 $this->cur = array( $this->oldRel, $this->newRel );
2780         }
2781
2782         /**
2783          * Add the old versions of the image to the batch
2784          * @return array List of archive names from old versions
2785          */
2786         public function addOlds() {
2787                 $archiveBase = 'archive';
2788                 $this->olds = array();
2789                 $this->oldCount = 0;
2790                 $archiveNames = array();
2791
2792                 $result = $this->db->select( 'oldimage',
2793                         array( 'oi_archive_name', 'oi_deleted' ),
2794                         array( 'oi_name' => $this->oldName ),
2795                         __METHOD__,
2796                         array( 'LOCK IN SHARE MODE' ) // ignore snapshot
2797                 );
2798
2799                 foreach ( $result as $row ) {
2800                         $archiveNames[] = $row->oi_archive_name;
2801                         $oldName = $row->oi_archive_name;
2802                         $bits = explode( '!', $oldName, 2 );
2803
2804                         if ( count( $bits ) != 2 ) {
2805                                 wfDebug( "Old file name missing !: '$oldName' \n" );
2806                                 continue;
2807                         }
2808
2809                         list( $timestamp, $filename ) = $bits;
2810
2811                         if ( $this->oldName != $filename ) {
2812                                 wfDebug( "Old file name doesn't match: '$oldName' \n" );
2813                                 continue;
2814                         }
2815
2816                         $this->oldCount++;
2817
2818                         // Do we want to add those to oldCount?
2819                         if ( $row->oi_deleted & File::DELETED_FILE ) {
2820                                 continue;
2821                         }
2822
2823                         $this->olds[] = array(
2824                                 "{$archiveBase}/{$this->oldHash}{$oldName}",
2825                                 "{$archiveBase}/{$this->newHash}{$timestamp}!{$this->newName}"
2826                         );
2827                 }
2828
2829                 return $archiveNames;
2830         }
2831
2832         /**
2833          * Perform the move.
2834          * @return FileRepoStatus
2835          */
2836         public function execute() {
2837                 $repo = $this->file->repo;
2838                 $status = $repo->newGood();
2839
2840                 $triplets = $this->getMoveTriplets();
2841                 $checkStatus = $this->removeNonexistentFiles( $triplets );
2842                 if ( !$checkStatus->isGood() ) {
2843                         $status->merge( $checkStatus );
2844                         return $status;
2845                 }
2846                 $triplets = $checkStatus->value;
2847                 $destFile = wfLocalFile( $this->target );
2848
2849                 $this->file->lock(); // begin
2850                 $destFile->lock(); // quickly fail if destination is not available
2851                 // Rename the file versions metadata in the DB.
2852                 // This implicitly locks the destination file, which avoids race conditions.
2853                 // If we moved the files from A -> C before DB updates, another process could
2854                 // move files from B -> C at this point, causing storeBatch() to fail and thus
2855                 // cleanupTarget() to trigger. It would delete the C files and cause data loss.
2856                 $statusDb = $this->doDBUpdates();
2857                 if ( !$statusDb->isGood() ) {
2858                         $destFile->unlock();
2859                         $this->file->unlockAndRollback();
2860                         $statusDb->ok = false;
2861
2862                         return $statusDb;
2863                 }
2864                 wfDebugLog( 'imagemove', "Renamed {$this->file->getName()} in database: " .
2865                         "{$statusDb->successCount} successes, {$statusDb->failCount} failures" );
2866
2867                 if ( !$repo->hasSha1Storage() ) {
2868                         // Copy the files into their new location.
2869                         // If a prior process fataled copying or cleaning up files we tolerate any
2870                         // of the existing files if they are identical to the ones being stored.
2871                         $statusMove = $repo->storeBatch( $triplets, FileRepo::OVERWRITE_SAME );
2872                         wfDebugLog( 'imagemove', "Moved files for {$this->file->getName()}: " .
2873                                 "{$statusMove->successCount} successes, {$statusMove->failCount} failures" );
2874                         if ( !$statusMove->isGood() ) {
2875                                 // Delete any files copied over (while the destination is still locked)
2876                                 $this->cleanupTarget( $triplets );
2877                                 $destFile->unlock();
2878                                 $this->file->unlockAndRollback(); // unlocks the destination
2879                                 wfDebugLog( 'imagemove', "Error in moving files: " . $statusMove->getWikiText() );
2880                                 $statusMove->ok = false;
2881
2882                                 return $statusMove;
2883                         }
2884                         $status->merge( $statusMove );
2885                 }
2886
2887                 $destFile->unlock();
2888                 $this->file->unlock(); // done
2889
2890                 // Everything went ok, remove the source files
2891                 $this->cleanupSource( $triplets );
2892
2893                 $status->merge( $statusDb );
2894
2895                 return $status;
2896         }
2897
2898         /**
2899          * Do the database updates and return a new FileRepoStatus indicating how
2900          * many rows where updated.
2901          *
2902          * @return FileRepoStatus
2903          */
2904         protected function doDBUpdates() {
2905                 $repo = $this->file->repo;
2906                 $status = $repo->newGood();
2907                 $dbw = $this->db;
2908
2909                 // Update current image
2910                 $dbw->update(
2911                         'image',
2912                         array( 'img_name' => $this->newName ),
2913                         array( 'img_name' => $this->oldName ),
2914                         __METHOD__
2915                 );
2916
2917                 if ( $dbw->affectedRows() ) {
2918                         $status->successCount++;
2919                 } else {
2920                         $status->failCount++;
2921                         $status->fatal( 'imageinvalidfilename' );
2922
2923                         return $status;
2924                 }
2925
2926                 // Update old images
2927                 $dbw->update(
2928                         'oldimage',
2929                         array(
2930                                 'oi_name' => $this->newName,
2931                                 'oi_archive_name = ' . $dbw->strreplace( 'oi_archive_name',
2932                                         $dbw->addQuotes( $this->oldName ), $dbw->addQuotes( $this->newName ) ),
2933                         ),
2934                         array( 'oi_name' => $this->oldName ),
2935                         __METHOD__
2936                 );
2937
2938                 $affected = $dbw->affectedRows();
2939                 $total = $this->oldCount;
2940                 $status->successCount += $affected;
2941                 // Bug 34934: $total is based on files that actually exist.
2942                 // There may be more DB rows than such files, in which case $affected
2943                 // can be greater than $total. We use max() to avoid negatives here.
2944                 $status->failCount += max( 0, $total - $affected );
2945                 if ( $status->failCount ) {
2946                         $status->error( 'imageinvalidfilename' );
2947                 }
2948
2949                 return $status;
2950         }
2951
2952         /**
2953          * Generate triplets for FileRepo::storeBatch().
2954          * @return array
2955          */
2956         protected function getMoveTriplets() {
2957                 $moves = array_merge( array( $this->cur ), $this->olds );
2958                 $triplets = array(); // The format is: (srcUrl, destZone, destUrl)
2959
2960                 foreach ( $moves as $move ) {
2961                         // $move: (oldRelativePath, newRelativePath)
2962                         $srcUrl = $this->file->repo->getVirtualUrl() . '/public/' . rawurlencode( $move[0] );
2963                         $triplets[] = array( $srcUrl, 'public', $move[1] );
2964                         wfDebugLog(
2965                                 'imagemove',
2966                                 "Generated move triplet for {$this->file->getName()}: {$srcUrl} :: public :: {$move[1]}"
2967                         );
2968                 }
2969
2970                 return $triplets;
2971         }
2972
2973         /**
2974          * Removes non-existent files from move batch.
2975          * @param array $triplets
2976          * @return Status
2977          */
2978         protected function removeNonexistentFiles( $triplets ) {
2979                 $files = array();
2980
2981                 foreach ( $triplets as $file ) {
2982                         $files[$file[0]] = $file[0];
2983                 }
2984
2985                 $result = $this->file->repo->fileExistsBatch( $files );
2986                 if ( in_array( null, $result, true ) ) {
2987                         return Status::newFatal( 'backend-fail-internal',
2988                                 $this->file->repo->getBackend()->getName() );
2989                 }
2990
2991                 $filteredTriplets = array();
2992                 foreach ( $triplets as $file ) {
2993                         if ( $result[$file[0]] ) {
2994                                 $filteredTriplets[] = $file;
2995                         } else {
2996                                 wfDebugLog( 'imagemove', "File {$file[0]} does not exist" );
2997                         }
2998                 }
2999
3000                 return Status::newGood( $filteredTriplets );
3001         }
3002
3003         /**
3004          * Cleanup a partially moved array of triplets by deleting the target
3005          * files. Called if something went wrong half way.
3006          * @param array $triplets
3007          */
3008         protected function cleanupTarget( $triplets ) {
3009                 // Create dest pairs from the triplets
3010                 $pairs = array();
3011                 foreach ( $triplets as $triplet ) {
3012                         // $triplet: (old source virtual URL, dst zone, dest rel)
3013                         $pairs[] = array( $triplet[1], $triplet[2] );
3014                 }
3015
3016                 $this->file->repo->cleanupBatch( $pairs );
3017         }
3018
3019         /**
3020          * Cleanup a fully moved array of triplets by deleting the source files.
3021          * Called at the end of the move process if everything else went ok.
3022          * @param array $triplets
3023          */
3024         protected function cleanupSource( $triplets ) {
3025                 // Create source file names from the triplets
3026                 $files = array();
3027                 foreach ( $triplets as $triplet ) {
3028                         $files[] = $triplet[0];
3029                 }
3030
3031                 $this->file->repo->cleanupBatch( $files );
3032         }
3033 }