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 handler-specific metadata
 762          * @return string
 763          */
 764         function getMetadata() {
 765                 $this->load( self::LOAD_ALL ); // large metadata is loaded in another step
 766                 return $this->metadata;
 767         }
 768
 769         /**
 770          * @return int
 771          */
 772         function getBitDepth() {
 773                 $this->load();
 774
 775                 return (int)$this->bits;
 776         }
 777
 778         /**
 779          * Returns the size of the image file, in bytes
 780          * @return int
 781          */
 782         public function getSize() {
 783                 $this->load();
 784
 785                 return $this->size;
 786         }
 787
 788         /**
 789          * Returns the MIME type of the file.
 790          * @return string
 791          */
 792         function getMimeType() {
 793                 $this->load();
 794
 795                 return $this->mime;
 796         }
 797
 798         /**
 799          * Returns the type of the media in the file.
 800          * Use the value returned by this function with the MEDIATYPE_xxx constants.
 801          * @return string
 802          */
 803         function getMediaType() {
 804                 $this->load();
 805
 806                 return $this->media_type;
 807         }
 808
 809         /** canRender inherited */
 810         /** mustRender inherited */
 811         /** allowInlineDisplay inherited */
 812         /** isSafeFile inherited */
 813         /** isTrustedFile inherited */
 814
 815         /**
 816          * Returns true if the file exists on disk.
 817          * @return bool Whether file exist on disk.
 818          */
 819         public function exists() {
 820                 $this->load();
 821
 822                 return $this->fileExists;
 823         }
 824
 825         /** getTransformScript inherited */
 826         /** getUnscaledThumb inherited */
 827         /** thumbName inherited */
 828         /** createThumb inherited */
 829         /** transform inherited */
 830
 831         /** getHandler inherited */
 832         /** iconThumb inherited */
 833         /** getLastError inherited */
 834
 835         /**
 836          * Get all thumbnail names previously generated for this file
 837          * @param string|bool $archiveName Name of an archive file, default false
 838          * @return array First element is the base dir, then files in that base dir.
 839          */
 840         function getThumbnails( $archiveName = false ) {
 841                 if ( $archiveName ) {
 842                         $dir = $this->getArchiveThumbPath( $archiveName );
 843                 } else {
 844                         $dir = $this->getThumbPath();
 845                 }
 846
 847                 $backend = $this->repo->getBackend();
 848                 $files = array( $dir );
 849                 try {
 850                         $iterator = $backend->getFileList( array( 'dir' => $dir ) );
 851                         foreach ( $iterator as $file ) {
 852                                 $files[] = $file;
 853                         }
 854                 } catch ( FileBackendError $e ) {
 855                 } // suppress (bug 54674)
 856
 857                 return $files;
 858         }
 859
 860         /**
 861          * Refresh metadata in memcached, but don't touch thumbnails or CDN
 862          */
 863         function purgeMetadataCache() {
 864                 $this->invalidateCache();
 865         }
 866
 867         /**
 868          * Delete all previously generated thumbnails, refresh metadata in memcached and purge the CDN.
 869          *
 870          * @param array $options An array potentially with the key forThumbRefresh.
 871          *
 872          * @note This used to purge old thumbnails by default as well, but doesn't anymore.
 873          */
 874         function purgeCache( $options = array() ) {
 875                 // Refresh metadata cache
 876                 $this->purgeMetadataCache();
 877
 878                 // Delete thumbnails
 879                 $this->purgeThumbnails( $options );
 880
 881                 // Purge CDN cache for this file
 882                 DeferredUpdates::addUpdate(
 883                         new CdnCacheUpdate( array( $this->getUrl() ) ),
 884                         DeferredUpdates::PRESEND
 885                 );
 886         }
 887
 888         /**
 889          * Delete cached transformed files for an archived version only.
 890          * @param string $archiveName Name of the archived file
 891          */
 892         function purgeOldThumbnails( $archiveName ) {
 893                 // Get a list of old thumbnails and URLs
 894                 $files = $this->getThumbnails( $archiveName );
 895
 896                 // Purge any custom thumbnail caches
 897                 Hooks::run( 'LocalFilePurgeThumbnails', array( $this, $archiveName ) );
 898
 899                 $dir = array_shift( $files );
 900                 $this->purgeThumbList( $dir, $files );
 901
 902                 // Purge the CDN
 903                 $urls = array();
 904                 foreach ( $files as $file ) {
 905                         $urls[] = $this->getArchiveThumbUrl( $archiveName, $file );
 906                 }
 907                 DeferredUpdates::addUpdate( new CdnCacheUpdate( $urls ), DeferredUpdates::PRESEND );
 908         }
 909
 910         /**
 911          * Delete cached transformed files for the current version only.
 912          * @param array $options
 913          */
 914         public function purgeThumbnails( $options = array() ) {
 915                 // Delete thumbnails
 916                 $files = $this->getThumbnails();
 917                 // Always purge all files from CDN regardless of handler filters
 918                 $urls = array();
 919                 foreach ( $files as $file ) {
 920                         $urls[] = $this->getThumbUrl( $file );
 921                 }
 922                 array_shift( $urls ); // don't purge directory
 923
 924                 // Give media handler a chance to filter the file purge list
 925                 if ( !empty( $options['forThumbRefresh'] ) ) {
 926                         $handler = $this->getHandler();
 927                         if ( $handler ) {
 928                                 $handler->filterThumbnailPurgeList( $files, $options );
 929                         }
 930                 }
 931
 932                 // Purge any custom thumbnail caches
 933                 Hooks::run( 'LocalFilePurgeThumbnails', array( $this, false ) );
 934
 935                 $dir = array_shift( $files );
 936                 $this->purgeThumbList( $dir, $files );
 937
 938                 // Purge the CDN
 939                 DeferredUpdates::addUpdate( new CdnCacheUpdate( $urls ), DeferredUpdates::PRESEND );
 940         }
 941
 942         /**
 943          * Delete a list of thumbnails visible at urls
 944          * @param string $dir Base dir of the files.
 945          * @param array $files Array of strings: relative filenames (to $dir)
 946          */
 947         protected function purgeThumbList( $dir, $files ) {
 948                 $fileListDebug = strtr(
 949                         var_export( $files, true ),
 950                         array( "\n" => '' )
 951                 );
 952                 wfDebug( __METHOD__ . ": $fileListDebug\n" );
 953
 954                 $purgeList = array();
 955                 foreach ( $files as $file ) {
 956                         # Check that the base file name is part of the thumb name
 957                         # This is a basic sanity check to avoid erasing unrelated directories
 958                         if ( strpos( $file, $this->getName() ) !== false
 959                                 || strpos( $file, "-thumbnail" ) !== false // "short" thumb name
 960                         ) {
 961                                 $purgeList[] = "{$dir}/{$file}";
 962                         }
 963                 }
 964
 965                 # Delete the thumbnails
 966                 $this->repo->quickPurgeBatch( $purgeList );
 967                 # Clear out the thumbnail directory if empty
 968                 $this->repo->quickCleanDir( $dir );
 969         }
 970
 971         /** purgeDescription inherited */
 972         /** purgeEverything inherited */
 973
 974         /**
 975          * @param int $limit Optional: Limit to number of results
 976          * @param int $start Optional: Timestamp, start from
 977          * @param int $end Optional: Timestamp, end at
 978          * @param bool $inc
 979          * @return OldLocalFile[]
 980          */
 981         function getHistory( $limit = null, $start = null, $end = null, $inc = true ) {
 982                 $dbr = $this->repo->getSlaveDB();
 983                 $tables = array( 'oldimage' );
 984                 $fields = OldLocalFile::selectFields();
 985                 $conds = $opts = $join_conds = array();
 986                 $eq = $inc ? '=' : '';
 987                 $conds[] = "oi_name = " . $dbr->addQuotes( $this->title->getDBkey() );
 988
 989                 if ( $start ) {
 990                         $conds[] = "oi_timestamp <$eq " . $dbr->addQuotes( $dbr->timestamp( $start ) );
 991                 }
 992
 993                 if ( $end ) {
 994                         $conds[] = "oi_timestamp >$eq " . $dbr->addQuotes( $dbr->timestamp( $end ) );
 995                 }
 996
 997                 if ( $limit ) {
 998                         $opts['LIMIT'] = $limit;
 999                 }
1000
1001                 // Search backwards for time > x queries
1002                 $order = ( !$start && $end !== null ) ? 'ASC' : 'DESC';
1003                 $opts['ORDER BY'] = "oi_timestamp $order";
1004                 $opts['USE INDEX'] = array( 'oldimage' => 'oi_name_timestamp' );
1005
1006                 Hooks::run( 'LocalFile::getHistory', array( &$this, &$tables, &$fields,
1007                         &$conds, &$opts, &$join_conds ) );
1008
1009                 $res = $dbr->select( $tables, $fields, $conds, __METHOD__, $opts, $join_conds );
1010                 $r = array();
1011
1012                 foreach ( $res as $row ) {
1013                         $r[] = $this->repo->newFileFromRow( $row );
1014                 }
1015
1016                 if ( $order == 'ASC' ) {
1017                         $r = array_reverse( $r ); // make sure it ends up descending
1018                 }
1019
1020                 return $r;
1021         }
1022
1023         /**
1024          * Returns the history of this file, line by line.
1025          * starts with current version, then old versions.
1026          * uses $this->historyLine to check which line to return:
1027          *  0      return line for current version
1028          *  1      query for old versions, return first one
1029          *  2, ... return next old version from above query
1030          * @return bool
1031          */
1032         public function nextHistoryLine() {
1033                 # Polymorphic function name to distinguish foreign and local fetches
1034                 $fname = get_class( $this ) . '::' . __FUNCTION__;
1035
1036                 $dbr = $this->repo->getSlaveDB();
1037
1038                 if ( $this->historyLine == 0 ) { // called for the first time, return line from cur
1039                         $this->historyRes = $dbr->select( 'image',
1040                                 array(
1041                                         '*',
1042                                         "'' AS oi_archive_name",
1043                                         '0 as oi_deleted',
1044                                         'img_sha1'
1045                                 ),
1046                                 array( 'img_name' => $this->title->getDBkey() ),
1047                                 $fname
1048                         );
1049
1050                         if ( 0 == $dbr->numRows( $this->historyRes ) ) {
1051                                 $this->historyRes = null;
1052
1053                                 return false;
1054                         }
1055                 } elseif ( $this->historyLine == 1 ) {
1056                         $this->historyRes = $dbr->select( 'oldimage', '*',
1057                                 array( 'oi_name' => $this->title->getDBkey() ),
1058                                 $fname,
1059                                 array( 'ORDER BY' => 'oi_timestamp DESC' )
1060                         );
1061                 }
1062                 $this->historyLine++;
1063
1064                 return $dbr->fetchObject( $this->historyRes );
1065         }
1066
1067         /**
1068          * Reset the history pointer to the first element of the history
1069          */
1070         public function resetHistory() {
1071                 $this->historyLine = 0;
1072
1073                 if ( !is_null( $this->historyRes ) ) {
1074                         $this->historyRes = null;
1075                 }
1076         }
1077
1078         /** getHashPath inherited */
1079         /** getRel inherited */
1080         /** getUrlRel inherited */
1081         /** getArchiveRel inherited */
1082         /** getArchivePath inherited */
1083         /** getThumbPath inherited */
1084         /** getArchiveUrl inherited */
1085         /** getThumbUrl inherited */
1086         /** getArchiveVirtualUrl inherited */
1087         /** getThumbVirtualUrl inherited */
1088         /** isHashed inherited */
1089
1090         /**
1091          * Upload a file and record it in the DB
1092          * @param string $srcPath Source storage path, virtual URL, or filesystem path
1093          * @param string $comment Upload description
1094          * @param string $pageText Text to use for the new description page,
1095          *   if a new description page is created
1096          * @param int|bool $flags Flags for publish()
1097          * @param array|bool $props File properties, if known. This can be used to
1098          *   reduce the upload time when uploading virtual URLs for which the file
1099          *   info is already known
1100          * @param string|bool $timestamp Timestamp for img_timestamp, or false to use the
1101          *   current time
1102          * @param User|null $user User object or null to use $wgUser
1103          *
1104          * @return FileRepoStatus On success, the value member contains the
1105          *     archive name, or an empty string if it was a new file.
1106          */
1107         function upload( $srcPath, $comment, $pageText, $flags = 0, $props = false,
1108                 $timestamp = false, $user = null
1109         ) {
1110                 global $wgContLang;
1111
1112                 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
1113                         return $this->readOnlyFatalStatus();
1114                 }
1115
1116                 if ( !$props ) {
1117                         if ( $this->repo->isVirtualUrl( $srcPath )
1118                                 || FileBackend::isStoragePath( $srcPath )
1119                         ) {
1120                                 $props = $this->repo->getFileProps( $srcPath );
1121                         } else {
1122                                 $props = FSFile::getPropsFromPath( $srcPath );
1123                         }
1124                 }
1125
1126                 $options = array();
1127                 $handler = MediaHandler::getHandler( $props['mime'] );
1128                 if ( $handler ) {
1129                         $options['headers'] = $handler->getStreamHeaders( $props['metadata'] );
1130                 } else {
1131                         $options['headers'] = array();
1132                 }
1133
1134                 // Trim spaces on user supplied text
1135                 $comment = trim( $comment );
1136
1137                 // Truncate nicely or the DB will do it for us
1138                 // non-nicely (dangling multi-byte chars, non-truncated version in cache).
1139                 $comment = $wgContLang->truncate( $comment, 255 );
1140                 $this->lock(); // begin
1141                 $status = $this->publish( $srcPath, $flags, $options );
1142
1143                 if ( $status->successCount >= 2 ) {
1144                         // There will be a copy+(one of move,copy,store).
1145                         // The first succeeding does not commit us to updating the DB
1146                         // since it simply copied the current version to a timestamped file name.
1147                         // It is only *preferable* to avoid leaving such files orphaned.
1148                         // Once the second operation goes through, then the current version was
1149                         // updated and we must therefore update the DB too.
1150                         if ( !$this->recordUpload2( $status->value, $comment, $pageText, $props, $timestamp, $user ) ) {
1151                                 $status->fatal( 'filenotfound', $srcPath );
1152                         }
1153                 }
1154
1155                 $this->unlock(); // done
1156
1157                 return $status;
1158         }
1159
1160         /**
1161          * Record a file upload in the upload log and the image table
1162          * @param string $oldver
1163          * @param string $desc
1164          * @param string $license
1165          * @param string $copyStatus
1166          * @param string $source
1167          * @param bool $watch
1168          * @param string|bool $timestamp
1169          * @param User|null $user User object or null to use $wgUser
1170          * @return bool
1171          */
1172         function recordUpload( $oldver, $desc, $license = '', $copyStatus = '', $source = '',
1173                 $watch = false, $timestamp = false, User $user = null ) {
1174                 if ( !$user ) {
1175                         global $wgUser;
1176                         $user = $wgUser;
1177                 }
1178
1179                 $pageText = SpecialUpload::getInitialPageText( $desc, $license, $copyStatus, $source );
1180
1181                 if ( !$this->recordUpload2( $oldver, $desc, $pageText, false, $timestamp, $user ) ) {
1182                         return false;
1183                 }
1184
1185                 if ( $watch ) {
1186                         $user->addWatch( $this->getTitle() );
1187                 }
1188
1189                 return true;
1190         }
1191
1192         /**
1193          * Record a file upload in the upload log and the image table
1194          * @param string $oldver
1195          * @param string $comment
1196          * @param string $pageText
1197          * @param bool|array $props
1198          * @param string|bool $timestamp
1199          * @param null|User $user
1200          * @return bool
1201          */
1202         function recordUpload2(
1203                 $oldver, $comment, $pageText, $props = false, $timestamp = false, $user = null
1204         ) {
1205                 if ( is_null( $user ) ) {
1206                         global $wgUser;
1207                         $user = $wgUser;
1208                 }
1209
1210                 $dbw = $this->repo->getMasterDB();
1211
1212                 # Imports or such might force a certain timestamp; otherwise we generate
1213                 # it and can fudge it slightly to keep (name,timestamp) unique on re-upload.
1214                 if ( $timestamp === false ) {
1215                         $timestamp = $dbw->timestamp();
1216                         $allowTimeKludge = true;
1217                 } else {
1218                         $allowTimeKludge = false;
1219                 }
1220
1221                 $props = $props ?: $this->repo->getFileProps( $this->getVirtualUrl() );
1222                 $props['description'] = $comment;
1223                 $props['user'] = $user->getId();
1224                 $props['user_text'] = $user->getName();
1225                 $props['timestamp'] = wfTimestamp( TS_MW, $timestamp ); // DB -> TS_MW
1226                 $this->setProps( $props );
1227
1228                 # Fail now if the file isn't there
1229                 if ( !$this->fileExists ) {
1230                         wfDebug( __METHOD__ . ": File " . $this->getRel() . " went missing!\n" );
1231
1232                         return false;
1233                 }
1234
1235                 $dbw->startAtomic( __METHOD__ );
1236
1237                 # Test to see if the row exists using INSERT IGNORE
1238                 # This avoids race conditions by locking the row until the commit, and also
1239                 # doesn't deadlock. SELECT FOR UPDATE causes a deadlock for every race condition.
1240                 $dbw->insert( 'image',
1241                         array(
1242                                 'img_name' => $this->getName(),
1243                                 'img_size' => $this->size,
1244                                 'img_width' => intval( $this->width ),
1245                                 'img_height' => intval( $this->height ),
1246                                 'img_bits' => $this->bits,
1247                                 'img_media_type' => $this->media_type,
1248                                 'img_major_mime' => $this->major_mime,
1249                                 'img_minor_mime' => $this->minor_mime,
1250                                 'img_timestamp' => $timestamp,
1251                                 'img_description' => $comment,
1252                                 'img_user' => $user->getId(),
1253                                 'img_user_text' => $user->getName(),
1254                                 'img_metadata' => $dbw->encodeBlob( $this->metadata ),
1255                                 'img_sha1' => $this->sha1
1256                         ),
1257                         __METHOD__,
1258                         'IGNORE'
1259                 );
1260
1261                 $reupload = ( $dbw->affectedRows() == 0 );
1262                 if ( $reupload ) {
1263                         if ( $allowTimeKludge ) {
1264                                 # Use LOCK IN SHARE MODE to ignore any transaction snapshotting
1265                                 $ltimestamp = $dbw->selectField(
1266                                         'image',
1267                                         'img_timestamp',
1268                                         array( 'img_name' => $this->getName() ),
1269                                         __METHOD__,
1270                                         array( 'LOCK IN SHARE MODE' )
1271                                 );
1272                                 $lUnixtime = $ltimestamp ? wfTimestamp( TS_UNIX, $ltimestamp ) : false;
1273                                 # Avoid a timestamp that is not newer than the last version
1274                                 # TODO: the image/oldimage tables should be like page/revision with an ID field
1275                                 if ( $lUnixtime && wfTimestamp( TS_UNIX, $timestamp ) <= $lUnixtime ) {
1276                                         sleep( 1 ); // fast enough re-uploads would go far in the future otherwise
1277                                         $timestamp = $dbw->timestamp( $lUnixtime + 1 );
1278                                         $this->timestamp = wfTimestamp( TS_MW, $timestamp ); // DB -> TS_MW
1279                                 }
1280                         }
1281
1282                         # (bug 34993) Note: $oldver can be empty here, if the previous
1283                         # version of the file was broken. Allow registration of the new
1284                         # version to continue anyway, because that's better than having
1285                         # an image that's not fixable by user operations.
1286                         # Collision, this is an update of a file
1287                         # Insert previous contents into oldimage
1288                         $dbw->insertSelect( 'oldimage', 'image',
1289                                 array(
1290                                         'oi_name' => 'img_name',
1291                                         'oi_archive_name' => $dbw->addQuotes( $oldver ),
1292                                         'oi_size' => 'img_size',
1293                                         'oi_width' => 'img_width',
1294                                         'oi_height' => 'img_height',
1295                                         'oi_bits' => 'img_bits',
1296                                         'oi_timestamp' => 'img_timestamp',
1297                                         'oi_description' => 'img_description',
1298                                         'oi_user' => 'img_user',
1299                                         'oi_user_text' => 'img_user_text',
1300                                         'oi_metadata' => 'img_metadata',
1301                                         'oi_media_type' => 'img_media_type',
1302                                         'oi_major_mime' => 'img_major_mime',
1303                                         'oi_minor_mime' => 'img_minor_mime',
1304                                         'oi_sha1' => 'img_sha1'
1305                                 ),
1306                                 array( 'img_name' => $this->getName() ),
1307                                 __METHOD__
1308                         );
1309
1310                         # Update the current image row
1311                         $dbw->update( 'image',
1312                                 array(
1313                                         'img_size' => $this->size,
1314                                         'img_width' => intval( $this->width ),
1315                                         'img_height' => intval( $this->height ),
1316                                         'img_bits' => $this->bits,
1317                                         'img_media_type' => $this->media_type,
1318                                         'img_major_mime' => $this->major_mime,
1319                                         'img_minor_mime' => $this->minor_mime,
1320                                         'img_timestamp' => $timestamp,
1321                                         'img_description' => $comment,
1322                                         'img_user' => $user->getId(),
1323                                         'img_user_text' => $user->getName(),
1324                                         'img_metadata' => $dbw->encodeBlob( $this->metadata ),
1325                                         'img_sha1' => $this->sha1
1326                                 ),
1327                                 array( 'img_name' => $this->getName() ),
1328                                 __METHOD__
1329                         );
1330                 }
1331
1332                 $descTitle = $this->getTitle();
1333                 $descId = $descTitle->getArticleID();
1334                 $wikiPage = new WikiFilePage( $descTitle );
1335                 $wikiPage->setFile( $this );
1336
1337                 // Add the log entry...
1338                 $logEntry = new ManualLogEntry( 'upload', $reupload ? 'overwrite' : 'upload' );
1339                 $logEntry->setPerformer( $user );
1340                 $logEntry->setComment( $comment );
1341                 $logEntry->setTarget( $descTitle );
1342                 // Allow people using the api to associate log entries with the upload.
1343                 // Log has a timestamp, but sometimes different from upload timestamp.
1344                 $logEntry->setParameters(
1345                         array(
1346                                 'img_sha1' => $this->sha1,
1347                                 'img_timestamp' => $timestamp,
1348                         )
1349                 );
1350                 // Note we keep $logId around since during new image
1351                 // creation, page doesn't exist yet, so log_page = 0
1352                 // but we want it to point to the page we're making,
1353                 // so we later modify the log entry.
1354                 // For a similar reason, we avoid making an RC entry
1355                 // now and wait until the page exists.
1356                 $logId = $logEntry->insert();
1357
1358                 if ( $descTitle->exists() ) {
1359                         // Use own context to get the action text in content language
1360                         $formatter = LogFormatter::newFromEntry( $logEntry );
1361                         $formatter->setContext( RequestContext::newExtraneousContext( $descTitle ) );
1362                         $editSummary = $formatter->getPlainActionText();
1363
1364                         $nullRevision = Revision::newNullRevision(
1365                                 $dbw,
1366                                 $descId,
1367                                 $editSummary,
1368                                 false,
1369                                 $user
1370                         );
1371                         if ( $nullRevision ) {
1372                                 $nullRevision->insertOn( $dbw );
1373                                 Hooks::run(
1374                                         'NewRevisionFromEditComplete',
1375                                         array( $wikiPage, $nullRevision, $nullRevision->getParentId(), $user )
1376                                 );
1377                                 $wikiPage->updateRevisionOn( $dbw, $nullRevision );
1378                                 // Associate null revision id
1379                                 $logEntry->setAssociatedRevId( $nullRevision->getId() );
1380                         }
1381
1382                         $newPageContent = null;
1383                 } else {
1384                         // Make the description page and RC log entry post-commit
1385                         $newPageContent = ContentHandler::makeContent( $pageText, $descTitle );
1386                 }
1387
1388                 # Defer purges, page creation, and link updates in case they error out.
1389                 # The most important thing is that files and the DB registry stay synced.
1390                 $dbw->endAtomic( __METHOD__ );
1391
1392                 # Do some cache purges after final commit so that:
1393                 # a) Changes are more likely to be seen post-purge
1394                 # b) They won't cause rollback of the log publish/update above
1395                 $that = $this;
1396                 $dbw->onTransactionIdle( function () use (
1397                         $that, $reupload, $wikiPage, $newPageContent, $comment, $user, $logEntry, $logId, $descId
1398                 ) {
1399                         # Update memcache after the commit
1400                         $that->invalidateCache();
1401
1402                         $updateLogPage = false;
1403                         if ( $newPageContent ) {
1404                                 # New file page; create the description page.
1405                                 # There's already a log entry, so don't make a second RC entry
1406                                 # CDN and file cache for the description page are purged by doEditContent.
1407                                 $status = $wikiPage->doEditContent(
1408                                         $newPageContent,
1409                                         $comment,
1410                                         EDIT_NEW | EDIT_SUPPRESS_RC,
1411                                         false,
1412                                         $user
1413                                 );
1414
1415                                 if ( isset( $status->value['revision'] ) ) {
1416                                         // Associate new page revision id
1417                                         $logEntry->setAssociatedRevId( $status->value['revision']->getId() );
1418                                 }
1419                                 // This relies on the resetArticleID() call in WikiPage::insertOn(),
1420                                 // which is triggered on $descTitle by doEditContent() above.
1421                                 if ( isset( $status->value['revision'] ) ) {
1422                                         /** @var $rev Revision */
1423                                         $rev = $status->value['revision'];
1424                                         $updateLogPage = $rev->getPage();
1425                                 }
1426                         } else {
1427                                 # Existing file page: invalidate description page cache
1428                                 $wikiPage->getTitle()->invalidateCache();
1429                                 $wikiPage->getTitle()->purgeSquid();
1430                                 # Allow the new file version to be patrolled from the page footer
1431                                 Article::purgePatrolFooterCache( $descId );
1432                         }
1433
1434                         # Update associated rev id. This should be done by $logEntry->insert() earlier,
1435                         # but setAssociatedRevId() wasn't called at that point yet...
1436                         $logParams = $logEntry->getParameters();
1437                         $logParams['associated_rev_id'] = $logEntry->getAssociatedRevId();
1438                         $update = array( 'log_params' => LogEntryBase::makeParamBlob( $logParams ) );
1439                         if ( $updateLogPage ) {
1440                                 # Also log page, in case where we just created it above
1441                                 $update['log_page'] = $updateLogPage;
1442                         }
1443                         $that->getRepo()->getMasterDB()->update(
1444                                 'logging',
1445                                 $update,
1446                                 array( 'log_id' => $logId ),
1447                                 __METHOD__
1448                         );
1449                         $that->getRepo()->getMasterDB()->insert(
1450                                 'log_search',
1451                                 array(
1452                                         'ls_field' => 'associated_rev_id',
1453                                         'ls_value' => $logEntry->getAssociatedRevId(),
1454                                         'ls_log_id' => $logId,
1455                                 ),
1456                                 __METHOD__
1457                         );
1458
1459                         # Now that the log entry is up-to-date, make an RC entry.
1460                         $logEntry->publish( $logId );
1461                         # Run hook for other updates (typically more cache purging)
1462                         Hooks::run( 'FileUpload', array( $that, $reupload, !$newPageContent ) );
1463
1464                         if ( $reupload ) {
1465                                 # Delete old thumbnails
1466                                 $that->purgeThumbnails();
1467                                 # Remove the old file from the CDN cache
1468                                 DeferredUpdates::addUpdate(
1469                                         new CdnCacheUpdate( array( $that->getUrl() ) ),
1470                                         DeferredUpdates::PRESEND
1471                                 );
1472                         } else {
1473                                 # Update backlink pages pointing to this title if created
1474                                 LinksUpdate::queueRecursiveJobsForTable( $that->getTitle(), 'imagelinks' );
1475                         }
1476                 } );
1477
1478                 if ( !$reupload ) {
1479                         # This is a new file, so update the image count
1480                         DeferredUpdates::addUpdate( SiteStatsUpdate::factory( array( 'images' => 1 ) ) );
1481                 }
1482
1483                 # Invalidate cache for all pages using this file
1484                 DeferredUpdates::addUpdate( new HTMLCacheUpdate( $this->getTitle(), 'imagelinks' ) );
1485
1486                 return true;
1487         }
1488
1489         /**
1490          * Move or copy a file to its public location. If a file exists at the
1491          * destination, move it to an archive. Returns a FileRepoStatus object with
1492          * the archive name in the "value" member on success.
1493          *
1494          * The archive name should be passed through to recordUpload for database
1495          * registration.
1496          *
1497          * @param string $srcPath Local filesystem path or virtual URL to the source image
1498          * @param int $flags A bitwise combination of:
1499          *     File::DELETE_SOURCE    Delete the source file, i.e. move rather than copy
1500          * @param array $options Optional additional parameters
1501          * @return FileRepoStatus On success, the value member contains the
1502          *     archive name, or an empty string if it was a new file.
1503          */
1504         function publish( $srcPath, $flags = 0, array $options = array() ) {
1505                 return $this->publishTo( $srcPath, $this->getRel(), $flags, $options );
1506         }
1507
1508         /**
1509          * Move or copy a file to a specified location. Returns a FileRepoStatus
1510          * object with the archive name in the "value" member on success.
1511          *
1512          * The archive name should be passed through to recordUpload for database
1513          * registration.
1514          *
1515          * @param string $srcPath Local filesystem path or virtual URL to the source image
1516          * @param string $dstRel Target relative path
1517          * @param int $flags A bitwise combination of:
1518          *     File::DELETE_SOURCE    Delete the source file, i.e. move rather than copy
1519          * @param array $options Optional additional parameters
1520          * @return FileRepoStatus On success, the value member contains the
1521          *     archive name, or an empty string if it was a new file.
1522          */
1523         function publishTo( $srcPath, $dstRel, $flags = 0, array $options = array() ) {
1524                 $repo = $this->getRepo();
1525                 if ( $repo->getReadOnlyReason() !== false ) {
1526                         return $this->readOnlyFatalStatus();
1527                 }
1528
1529                 $this->lock(); // begin
1530
1531                 $archiveName = wfTimestamp( TS_MW ) . '!' . $this->getName();
1532                 $archiveRel = 'archive/' . $this->getHashPath() . $archiveName;
1533
1534                 if ( $repo->hasSha1Storage() ) {
1535                         $sha1 = $repo->isVirtualUrl( $srcPath )
1536                                 ? $repo->getFileSha1( $srcPath )
1537                                 : File::sha1Base36( $srcPath );
1538                         $dst = $repo->getBackend()->getPathForSHA1( $sha1 );
1539                         $status = $repo->quickImport( $srcPath, $dst );
1540                         if ( $flags & File::DELETE_SOURCE ) {
1541                                 unlink( $srcPath );
1542                         }
1543
1544                         if ( $this->exists() ) {
1545                                 $status->value = $archiveName;
1546                         }
1547                 } else {
1548                         $flags = $flags & File::DELETE_SOURCE ? LocalRepo::DELETE_SOURCE : 0;
1549                         $status = $repo->publish( $srcPath, $dstRel, $archiveRel, $flags, $options );
1550
1551                         if ( $status->value == 'new' ) {
1552                                 $status->value = '';
1553                         } else {
1554                                 $status->value = $archiveName;
1555                         }
1556                 }
1557
1558                 $this->unlock(); // done
1559
1560                 return $status;
1561         }
1562
1563         /** getLinksTo inherited */
1564         /** getExifData inherited */
1565         /** isLocal inherited */
1566         /** wasDeleted inherited */
1567
1568         /**
1569          * Move file to the new title
1570          *
1571          * Move current, old version and all thumbnails
1572          * to the new filename. Old file is deleted.
1573          *
1574          * Cache purging is done; checks for validity
1575          * and logging are caller's responsibility
1576          *
1577          * @param Title $target New file name
1578          * @return FileRepoStatus
1579          */
1580         function move( $target ) {
1581                 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
1582                         return $this->readOnlyFatalStatus();
1583                 }
1584
1585                 wfDebugLog( 'imagemove', "Got request to move {$this->name} to " . $target->getText() );
1586                 $batch = new LocalFileMoveBatch( $this, $target );
1587
1588                 $this->lock(); // begin
1589                 $batch->addCurrent();
1590                 $archiveNames = $batch->addOlds();
1591                 $status = $batch->execute();
1592                 $this->unlock(); // done
1593
1594                 wfDebugLog( 'imagemove', "Finished moving {$this->name}" );
1595
1596                 // Purge the source and target files...
1597                 $oldTitleFile = wfLocalFile( $this->title );
1598                 $newTitleFile = wfLocalFile( $target );
1599                 // Hack: the lock()/unlock() pair is nested in a transaction so the locking is not
1600                 // tied to BEGIN/COMMIT. To avoid slow purges in the transaction, move them outside.
1601                 $this->getRepo()->getMasterDB()->onTransactionIdle(
1602                         function () use ( $oldTitleFile, $newTitleFile, $archiveNames ) {
1603                                 $oldTitleFile->purgeEverything();
1604                                 foreach ( $archiveNames as $archiveName ) {
1605                                         $oldTitleFile->purgeOldThumbnails( $archiveName );
1606                                 }
1607                                 $newTitleFile->purgeEverything();
1608                         }
1609                 );
1610
1611                 if ( $status->isOK() ) {
1612                         // Now switch the object
1613                         $this->title = $target;
1614                         // Force regeneration of the name and hashpath
1615                         unset( $this->name );
1616                         unset( $this->hashPath );
1617                 }
1618
1619                 return $status;
1620         }
1621
1622         /**
1623          * Delete all versions of the file.
1624          *
1625          * Moves the files into an archive directory (or deletes them)
1626          * and removes the database rows.
1627          *
1628          * Cache purging is done; logging is caller's responsibility.
1629          *
1630          * @param string $reason
1631          * @param bool $suppress
1632          * @param User|null $user
1633          * @return FileRepoStatus
1634          */
1635         function delete( $reason, $suppress = false, $user = null ) {
1636                 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
1637                         return $this->readOnlyFatalStatus();
1638                 }
1639
1640                 $batch = new LocalFileDeleteBatch( $this, $reason, $suppress, $user );
1641
1642                 $this->lock(); // begin
1643                 $batch->addCurrent();
1644                 # Get old version relative paths
1645                 $archiveNames = $batch->addOlds();
1646                 $status = $batch->execute();
1647                 $this->unlock(); // done
1648
1649                 if ( $status->isOK() ) {
1650                         DeferredUpdates::addUpdate( SiteStatsUpdate::factory( array( 'images' => -1 ) ) );
1651                 }
1652
1653                 // Hack: the lock()/unlock() pair is nested in a transaction so the locking is not
1654                 // tied to BEGIN/COMMIT. To avoid slow purges in the transaction, move them outside.
1655                 $that = $this;
1656                 $this->getRepo()->getMasterDB()->onTransactionIdle(
1657                         function () use ( $that, $archiveNames ) {
1658                                 $that->purgeEverything();
1659                                 foreach ( $archiveNames as $archiveName ) {
1660                                         $that->purgeOldThumbnails( $archiveName );
1661                                 }
1662                         }
1663                 );
1664
1665                 // Purge the CDN
1666                 $purgeUrls = array();
1667                 foreach ( $archiveNames as $archiveName ) {
1668                         $purgeUrls[] = $this->getArchiveUrl( $archiveName );
1669                 }
1670                 DeferredUpdates::addUpdate( new CdnCacheUpdate( $purgeUrls ), DeferredUpdates::PRESEND );
1671
1672                 return $status;
1673         }
1674
1675         /**
1676          * Delete an old version of the file.
1677          *
1678          * Moves the file into an archive directory (or deletes it)
1679          * and removes the database row.
1680          *
1681          * Cache purging is done; logging is caller's responsibility.
1682          *
1683          * @param string $archiveName
1684          * @param string $reason
1685          * @param bool $suppress
1686          * @param User|null $user
1687          * @throws MWException Exception on database or file store failure
1688          * @return FileRepoStatus
1689          */
1690         function deleteOld( $archiveName, $reason, $suppress = false, $user = null ) {
1691                 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
1692                         return $this->readOnlyFatalStatus();
1693                 }
1694
1695                 $batch = new LocalFileDeleteBatch( $this, $reason, $suppress, $user );
1696
1697                 $this->lock(); // begin
1698                 $batch->addOld( $archiveName );
1699                 $status = $batch->execute();
1700                 $this->unlock(); // done
1701
1702                 $this->purgeOldThumbnails( $archiveName );
1703                 if ( $status->isOK() ) {
1704                         $this->purgeDescription();
1705                 }
1706
1707                 DeferredUpdates::addUpdate(
1708                         new CdnCacheUpdate( array( $this->getArchiveUrl( $archiveName ) ) ),
1709                         DeferredUpdates::PRESEND
1710                 );
1711
1712                 return $status;
1713         }
1714
1715         /**
1716          * Restore all or specified deleted revisions to the given file.
1717          * Permissions and logging are left to the caller.
1718          *
1719          * May throw database exceptions on error.
1720          *
1721          * @param array $versions Set of record ids of deleted items to restore,
1722          *   or empty to restore all revisions.
1723          * @param bool $unsuppress
1724          * @return FileRepoStatus
1725          */
1726         function restore( $versions = array(), $unsuppress = false ) {
1727                 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
1728                         return $this->readOnlyFatalStatus();
1729                 }
1730
1731                 $batch = new LocalFileRestoreBatch( $this, $unsuppress );
1732
1733                 $this->lock(); // begin
1734                 if ( !$versions ) {
1735                         $batch->addAll();
1736                 } else {
1737                         $batch->addIds( $versions );
1738                 }
1739                 $status = $batch->execute();
1740                 if ( $status->isGood() ) {
1741                         $cleanupStatus = $batch->cleanup();
1742                         $cleanupStatus->successCount = 0;
1743                         $cleanupStatus->failCount = 0;
1744                         $status->merge( $cleanupStatus );
1745                 }
1746                 $this->unlock(); // done
1747
1748                 return $status;
1749         }
1750
1751         /** isMultipage inherited */
1752         /** pageCount inherited */
1753         /** scaleHeight inherited */
1754         /** getImageSize inherited */
1755
1756         /**
1757          * Get the URL of the file description page.
1758          * @return string
1759          */
1760         function getDescriptionUrl() {
1761                 return $this->title->getLocalURL();
1762         }
1763
1764         /**
1765          * Get the HTML text of the description page
1766          * This is not used by ImagePage for local files, since (among other things)
1767          * it skips the parser cache.
1768          *
1769          * @param Language $lang What language to get description in (Optional)
1770          * @return bool|mixed
1771          */
1772         function getDescriptionText( $lang = null ) {
1773                 $revision = Revision::newFromTitle( $this->title, false, Revision::READ_NORMAL );
1774                 if ( !$revision ) {
1775                         return false;
1776                 }
1777                 $content = $revision->getContent();
1778                 if ( !$content ) {
1779                         return false;
1780                 }
1781                 $pout = $content->getParserOutput( $this->title, null, new ParserOptions( null, $lang ) );
1782
1783                 return $pout->getText();
1784         }
1785
1786         /**
1787          * @param int $audience
1788          * @param User $user
1789          * @return string
1790          */
1791         function getDescription( $audience = self::FOR_PUBLIC, User $user = null ) {
1792                 $this->load();
1793                 if ( $audience == self::FOR_PUBLIC && $this->isDeleted( self::DELETED_COMMENT ) ) {
1794                         return '';
1795                 } elseif ( $audience == self::FOR_THIS_USER
1796                         && !$this->userCan( self::DELETED_COMMENT, $user )
1797                 ) {
1798                         return '';
1799                 } else {
1800                         return $this->description;
1801                 }
1802         }
1803
1804         /**
1805          * @return bool|string
1806          */
1807         function getTimestamp() {
1808                 $this->load();
1809
1810                 return $this->timestamp;
1811         }
1812
1813         /**
1814          * @return bool|string
1815          */
1816         public function getDescriptionTouched() {
1817                 // The DB lookup might return false, e.g. if the file was just deleted, or the shared DB repo
1818                 // itself gets it from elsewhere. To avoid repeating the DB lookups in such a case, we
1819                 // need to differentiate between null (uninitialized) and false (failed to load).
1820                 if ( $this->descriptionTouched === null ) {
1821                         $cond = array(
1822                                 'page_namespace' => $this->title->getNamespace(),
1823                                 'page_title' => $this->title->getDBkey()
1824                         );
1825                         $touched = $this->repo->getSlaveDB()->selectField( 'page', 'page_touched', $cond, __METHOD__ );
1826                         $this->descriptionTouched = $touched ? wfTimestamp( TS_MW, $touched ) : false;
1827                 }
1828
1829                 return $this->descriptionTouched;
1830         }
1831
1832         /**
1833          * @return string
1834          */
1835         function getSha1() {
1836                 $this->load();
1837                 // Initialise now if necessary
1838                 if ( $this->sha1 == '' && $this->fileExists ) {
1839                         $this->lock(); // begin
1840
1841                         $this->sha1 = $this->repo->getFileSha1( $this->getPath() );
1842                         if ( !wfReadOnly() && strval( $this->sha1 ) != '' ) {
1843                                 $dbw = $this->repo->getMasterDB();
1844                                 $dbw->update( 'image',
1845                                         array( 'img_sha1' => $this->sha1 ),
1846                                         array( 'img_name' => $this->getName() ),
1847                                         __METHOD__ );
1848                                 $this->invalidateCache();
1849                         }
1850
1851                         $this->unlock(); // done
1852                 }
1853
1854                 return $this->sha1;
1855         }
1856
1857         /**
1858          * @return bool Whether to cache in RepoGroup (this avoids OOMs)
1859          */
1860         function isCacheable() {
1861                 $this->load();
1862
1863                 // If extra data (metadata) was not loaded then it must have been large
1864                 return $this->extraDataLoaded
1865                 && strlen( serialize( $this->metadata ) ) <= self::CACHE_FIELD_MAX_LEN;
1866         }
1867
1868         /**
1869          * Start a transaction and lock the image for update
1870          * Increments a reference counter if the lock is already held
1871          * @throws MWException Throws an error if the lock was not acquired
1872          * @return bool Whether the file lock owns/spawned the DB transaction
1873          */
1874         function lock() {
1875                 $dbw = $this->repo->getMasterDB();
1876
1877                 if ( !$this->locked ) {
1878                         if ( !$dbw->trxLevel() ) {
1879                                 $dbw->begin( __METHOD__ );
1880                                 $this->lockedOwnTrx = true;
1881                         }
1882                         $this->locked++;
1883                         // Bug 54736: use simple lock to handle when the file does not exist.
1884                         // SELECT FOR UPDATE prevents changes, not other SELECTs with FOR UPDATE.
1885                         // Also, that would cause contention on INSERT of similarly named rows.
1886                         $backend = $this->getRepo()->getBackend();
1887                         $lockPaths = array( $this->getPath() ); // represents all versions of the file
1888                         $status = $backend->lockFiles( $lockPaths, LockManager::LOCK_EX, 5 );
1889                         if ( !$status->isGood() ) {
1890                                 throw new MWException( "Could not acquire lock for '{$this->getName()}.'" );
1891                         }
1892                         $dbw->onTransactionIdle( function () use ( $backend, $lockPaths ) {
1893                                 $backend->unlockFiles( $lockPaths, LockManager::LOCK_EX ); // release on commit
1894                         } );
1895                 }
1896
1897                 return $this->lockedOwnTrx;
1898         }
1899
1900         /**
1901          * Decrement the lock reference count. If the reference count is reduced to zero, commits
1902          * the transaction and thereby releases the image lock.
1903          */
1904         function unlock() {
1905                 if ( $this->locked ) {
1906                         --$this->locked;
1907                         if ( !$this->locked && $this->lockedOwnTrx ) {
1908                                 $dbw = $this->repo->getMasterDB();
1909                                 $dbw->commit( __METHOD__ );
1910                                 $this->lockedOwnTrx = false;
1911                         }
1912                 }
1913         }
1914
1915         /**
1916          * Roll back the DB transaction and mark the image unlocked
1917          */
1918         function unlockAndRollback() {
1919                 $this->locked = false;
1920                 $dbw = $this->repo->getMasterDB();
1921                 $dbw->rollback( __METHOD__ );
1922                 $this->lockedOwnTrx = false;
1923         }
1924
1925         /**
1926          * @return Status
1927          */
1928         protected function readOnlyFatalStatus() {
1929                 return $this->getRepo()->newFatal( 'filereadonlyerror', $this->getName(),
1930                         $this->getRepo()->getName(), $this->getRepo()->getReadOnlyReason() );
1931         }
1932
1933         /**
1934          * Clean up any dangling locks
1935          */
1936         function __destruct() {
1937                 $this->unlock();
1938         }
1939 } // LocalFile class
1940
1941 # ------------------------------------------------------------------------------
1942
1943 /**
1944  * Helper class for file deletion
1945  * @ingroup FileAbstraction
1946  */
1947 class LocalFileDeleteBatch {
1948         /** @var LocalFile */
1949         private $file;
1950
1951         /** @var string */
1952         private $reason;
1953
1954         /** @var array */
1955         private $srcRels = array();
1956
1957         /** @var array */
1958         private $archiveUrls = array();
1959
1960         /** @var array Items to be processed in the deletion batch */
1961         private $deletionBatch;
1962
1963         /** @var bool Whether to suppress all suppressable fields when deleting */
1964         private $suppress;
1965
1966         /** @var FileRepoStatus */
1967         private $status;
1968
1969         /** @var User */
1970         private $user;
1971
1972         /**
1973          * @param File $file
1974          * @param string $reason
1975          * @param bool $suppress
1976          * @param User|null $user
1977          */
1978         function __construct( File $file, $reason = '', $suppress = false, $user = null ) {
1979                 $this->file = $file;
1980                 $this->reason = $reason;
1981                 $this->suppress = $suppress;
1982                 if ( $user ) {
1983                         $this->user = $user;
1984                 } else {
1985                         global $wgUser;
1986                         $this->user = $wgUser;
1987                 }
1988                 $this->status = $file->repo->newGood();
1989         }
1990
1991         public function addCurrent() {
1992                 $this->srcRels['.'] = $this->file->getRel();
1993         }
1994
1995         /**
1996          * @param string $oldName
1997          */
1998         public function addOld( $oldName ) {
1999                 $this->srcRels[$oldName] = $this->file->getArchiveRel( $oldName );
2000                 $this->archiveUrls[] = $this->file->getArchiveUrl( $oldName );
2001         }
2002
2003         /**
2004          * Add the old versions of the image to the batch
2005          * @return array List of archive names from old versions
2006          */
2007         public function addOlds() {
2008                 $archiveNames = array();
2009
2010                 $dbw = $this->file->repo->getMasterDB();
2011                 $result = $dbw->select( 'oldimage',
2012                         array( 'oi_archive_name' ),
2013                         array( 'oi_name' => $this->file->getName() ),
2014                         __METHOD__
2015                 );
2016
2017                 foreach ( $result as $row ) {
2018                         $this->addOld( $row->oi_archive_name );
2019                         $archiveNames[] = $row->oi_archive_name;
2020                 }
2021
2022                 return $archiveNames;
2023         }
2024
2025         /**
2026          * @return array
2027          */
2028         protected function getOldRels() {
2029                 if ( !isset( $this->srcRels['.'] ) ) {
2030                         $oldRels =& $this->srcRels;
2031                         $deleteCurrent = false;
2032                 } else {
2033                         $oldRels = $this->srcRels;
2034                         unset( $oldRels['.'] );
2035                         $deleteCurrent = true;
2036                 }
2037
2038                 return array( $oldRels, $deleteCurrent );
2039         }
2040
2041         /**
2042          * @return array
2043          */
2044         protected function getHashes() {
2045                 $hashes = array();
2046                 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
2047
2048                 if ( $deleteCurrent ) {
2049                         $hashes['.'] = $this->file->getSha1();
2050                 }
2051
2052                 if ( count( $oldRels ) ) {
2053                         $dbw = $this->file->repo->getMasterDB();
2054                         $res = $dbw->select(
2055                                 'oldimage',
2056                                 array( 'oi_archive_name', 'oi_sha1' ),
2057                                 array( 'oi_archive_name' => array_keys( $oldRels ),
2058                                         'oi_name' => $this->file->getName() ), // performance
2059                                 __METHOD__
2060                         );
2061
2062                         foreach ( $res as $row ) {
2063                                 if ( rtrim( $row->oi_sha1, "\0" ) === '' ) {
2064                                         // Get the hash from the file
2065                                         $oldUrl = $this->file->getArchiveVirtualUrl( $row->oi_archive_name );
2066                                         $props = $this->file->repo->getFileProps( $oldUrl );
2067
2068                                         if ( $props['fileExists'] ) {
2069                                                 // Upgrade the oldimage row
2070                                                 $dbw->update( 'oldimage',
2071                                                         array( 'oi_sha1' => $props['sha1'] ),
2072                                                         array( 'oi_name' => $this->file->getName(), 'oi_archive_name' => $row->oi_archive_name ),
2073                                                         __METHOD__ );
2074                                                 $hashes[$row->oi_archive_name] = $props['sha1'];
2075                                         } else {
2076                                                 $hashes[$row->oi_archive_name] = false;
2077                                         }
2078                                 } else {
2079                                         $hashes[$row->oi_archive_name] = $row->oi_sha1;
2080                                 }
2081                         }
2082                 }
2083
2084                 $missing = array_diff_key( $this->srcRels, $hashes );
2085
2086                 foreach ( $missing as $name => $rel ) {
2087                         $this->status->error( 'filedelete-old-unregistered', $name );
2088                 }
2089
2090                 foreach ( $hashes as $name => $hash ) {
2091                         if ( !$hash ) {
2092                                 $this->status->error( 'filedelete-missing', $this->srcRels[$name] );
2093                                 unset( $hashes[$name] );
2094                         }
2095                 }
2096
2097                 return $hashes;
2098         }
2099
2100         protected function doDBInserts() {
2101                 $dbw = $this->file->repo->getMasterDB();
2102                 $encTimestamp = $dbw->addQuotes( $dbw->timestamp() );
2103                 $encUserId = $dbw->addQuotes( $this->user->getId() );
2104                 $encReason = $dbw->addQuotes( $this->reason );
2105                 $encGroup = $dbw->addQuotes( 'deleted' );
2106                 $ext = $this->file->getExtension();
2107                 $dotExt = $ext === '' ? '' : ".$ext";
2108                 $encExt = $dbw->addQuotes( $dotExt );
2109                 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
2110
2111                 // Bitfields to further suppress the content
2112                 if ( $this->suppress ) {
2113                         $bitfield = 0;
2114                         // This should be 15...
2115                         $bitfield |= Revision::DELETED_TEXT;
2116                         $bitfield |= Revision::DELETED_COMMENT;
2117                         $bitfield |= Revision::DELETED_USER;
2118                         $bitfield |= Revision::DELETED_RESTRICTED;
2119                 } else {
2120                         $bitfield = 'oi_deleted';
2121                 }
2122
2123                 if ( $deleteCurrent ) {
2124                         $concat = $dbw->buildConcat( array( "img_sha1", $encExt ) );
2125                         $where = array( 'img_name' => $this->file->getName() );
2126                         $dbw->insertSelect( 'filearchive', 'image',
2127                                 array(
2128                                         'fa_storage_group' => $encGroup,
2129                                         'fa_storage_key' => $dbw->conditional(
2130                                                 array( 'img_sha1' => '' ),
2131                                                 $dbw->addQuotes( '' ),
2132                                                 $concat
2133                                         ),
2134                                         'fa_deleted_user' => $encUserId,
2135                                         'fa_deleted_timestamp' => $encTimestamp,
2136                                         'fa_deleted_reason' => $encReason,
2137                                         'fa_deleted' => $this->suppress ? $bitfield : 0,
2138
2139                                         'fa_name' => 'img_name',
2140                                         'fa_archive_name' => 'NULL',
2141                                         'fa_size' => 'img_size',
2142                                         'fa_width' => 'img_width',
2143                                         'fa_height' => 'img_height',
2144                                         'fa_metadata' => 'img_metadata',
2145                                         'fa_bits' => 'img_bits',
2146                                         'fa_media_type' => 'img_media_type',
2147                                         'fa_major_mime' => 'img_major_mime',
2148                                         'fa_minor_mime' => 'img_minor_mime',
2149                                         'fa_description' => 'img_description',
2150                                         'fa_user' => 'img_user',
2151                                         'fa_user_text' => 'img_user_text',
2152                                         'fa_timestamp' => 'img_timestamp',
2153                                         'fa_sha1' => 'img_sha1',
2154                                 ), $where, __METHOD__ );
2155                 }
2156
2157                 if ( count( $oldRels ) ) {
2158                         $concat = $dbw->buildConcat( array( "oi_sha1", $encExt ) );
2159                         $where = array(
2160                                 'oi_name' => $this->file->getName(),
2161                                 'oi_archive_name' => array_keys( $oldRels ) );
2162                         $dbw->insertSelect( 'filearchive', 'oldimage',
2163                                 array(
2164                                         'fa_storage_group' => $encGroup,
2165                                         'fa_storage_key' => $dbw->conditional(
2166                                                 array( 'oi_sha1' => '' ),
2167                                                 $dbw->addQuotes( '' ),
2168                                                 $concat
2169                                         ),
2170                                         'fa_deleted_user' => $encUserId,
2171                                         'fa_deleted_timestamp' => $encTimestamp,
2172                                         'fa_deleted_reason' => $encReason,
2173                                         'fa_deleted' => $this->suppress ? $bitfield : 'oi_deleted',
2174
2175                                         'fa_name' => 'oi_name',
2176                                         'fa_archive_name' => 'oi_archive_name',
2177                                         'fa_size' => 'oi_size',
2178                                         'fa_width' => 'oi_width',
2179                                         'fa_height' => 'oi_height',
2180                                         'fa_metadata' => 'oi_metadata',
2181                                         'fa_bits' => 'oi_bits',
2182                                         'fa_media_type' => 'oi_media_type',
2183                                         'fa_major_mime' => 'oi_major_mime',
2184                                         'fa_minor_mime' => 'oi_minor_mime',
2185                                         'fa_description' => 'oi_description',
2186                                         'fa_user' => 'oi_user',
2187                                         'fa_user_text' => 'oi_user_text',
2188                                         'fa_timestamp' => 'oi_timestamp',
2189                                         'fa_sha1' => 'oi_sha1',
2190                                 ), $where, __METHOD__ );
2191                 }
2192         }
2193
2194         function doDBDeletes() {
2195                 $dbw = $this->file->repo->getMasterDB();
2196                 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
2197
2198                 if ( count( $oldRels ) ) {
2199                         $dbw->delete( 'oldimage',
2200                                 array(
2201                                         'oi_name' => $this->file->getName(),
2202                                         'oi_archive_name' => array_keys( $oldRels )
2203                                 ), __METHOD__ );
2204                 }
2205
2206                 if ( $deleteCurrent ) {
2207                         $dbw->delete( 'image', array( 'img_name' => $this->file->getName() ), __METHOD__ );
2208                 }
2209         }
2210
2211         /**
2212          * Run the transaction
2213          * @return FileRepoStatus
2214          */
2215         public function execute() {
2216                 $repo = $this->file->getRepo();
2217                 $this->file->lock();
2218
2219                 // Prepare deletion batch
2220                 $hashes = $this->getHashes();
2221                 $this->deletionBatch = array();
2222                 $ext = $this->file->getExtension();
2223                 $dotExt = $ext === '' ? '' : ".$ext";
2224
2225                 foreach ( $this->srcRels as $name => $srcRel ) {
2226                         // Skip files that have no hash (e.g. missing DB record, or sha1 field and file source)
2227                         if ( isset( $hashes[$name] ) ) {
2228                                 $hash = $hashes[$name];
2229                                 $key = $hash . $dotExt;
2230                                 $dstRel = $repo->getDeletedHashPath( $key ) . $key;
2231                                 $this->deletionBatch[$name] = array( $srcRel, $dstRel );
2232                         }
2233                 }
2234
2235                 // Lock the filearchive rows so that the files don't get deleted by a cleanup operation
2236                 // We acquire this lock by running the inserts now, before the file operations.
2237                 // This potentially has poor lock contention characteristics -- an alternative
2238                 // scheme would be to insert stub filearchive entries with no fa_name and commit
2239                 // them in a separate transaction, then run the file ops, then update the fa_name fields.
2240                 $this->doDBInserts();
2241
2242                 if ( !$repo->hasSha1Storage() ) {
2243                         // Removes non-existent file from the batch, so we don't get errors.
2244                         // This also handles files in the 'deleted' zone deleted via revision deletion.
2245                         $checkStatus = $this->removeNonexistentFiles( $this->deletionBatch );
2246                         if ( !$checkStatus->isGood() ) {
2247                                 $this->status->merge( $checkStatus );
2248                                 return $this->status;
2249                         }
2250                         $this->deletionBatch = $checkStatus->value;
2251
2252                         // Execute the file deletion batch
2253                         $status = $this->file->repo->deleteBatch( $this->deletionBatch );
2254
2255                         if ( !$status->isGood() ) {
2256                                 $this->status->merge( $status );
2257                         }
2258                 }
2259
2260                 if ( !$this->status->isOK() ) {
2261                         // Critical file deletion error
2262                         // Roll back inserts, release lock and abort
2263                         // TODO: delete the defunct filearchive rows if we are using a non-transactional DB
2264                         $this->file->unlockAndRollback();
2265
2266                         return $this->status;
2267                 }
2268
2269                 // Delete image/oldimage rows
2270                 $this->doDBDeletes();
2271
2272                 // Commit and return
2273                 $this->file->unlock();
2274
2275                 return $this->status;
2276         }
2277
2278         /**
2279          * Removes non-existent files from a deletion batch.
2280          * @param array $batch
2281          * @return Status
2282          */
2283         protected function removeNonexistentFiles( $batch ) {
2284                 $files = $newBatch = array();
2285
2286                 foreach ( $batch as $batchItem ) {
2287                         list( $src, ) = $batchItem;
2288                         $files[$src] = $this->file->repo->getVirtualUrl( 'public' ) . '/' . rawurlencode( $src );
2289                 }
2290
2291                 $result = $this->file->repo->fileExistsBatch( $files );
2292                 if ( in_array( null, $result, true ) ) {
2293                         return Status::newFatal( 'backend-fail-internal',
2294                                 $this->file->repo->getBackend()->getName() );
2295                 }
2296
2297                 foreach ( $batch as $batchItem ) {
2298                         if ( $result[$batchItem[0]] ) {
2299                                 $newBatch[] = $batchItem;
2300                         }
2301                 }
2302
2303                 return Status::newGood( $newBatch );
2304         }
2305 }
2306
2307 # ------------------------------------------------------------------------------
2308
2309 /**
2310  * Helper class for file undeletion
2311  * @ingroup FileAbstraction
2312  */
2313 class LocalFileRestoreBatch {
2314         /** @var LocalFile */
2315         private $file;
2316
2317         /** @var array List of file IDs to restore */
2318         private $cleanupBatch;
2319
2320         /** @var array List of file IDs to restore */
2321         private $ids;
2322
2323         /** @var bool Add all revisions of the file */
2324         private $all;
2325
2326         /** @var bool Whether to remove all settings for suppressed fields */
2327         private $unsuppress = false;
2328
2329         /**
2330          * @param File $file
2331          * @param bool $unsuppress
2332          */
2333         function __construct( File $file, $unsuppress = false ) {
2334                 $this->file = $file;
2335                 $this->cleanupBatch = $this->ids = array();
2336                 $this->ids = array();
2337                 $this->unsuppress = $unsuppress;
2338         }
2339
2340         /**
2341          * Add a file by ID
2342          * @param int $fa_id
2343          */
2344         public function addId( $fa_id ) {
2345                 $this->ids[] = $fa_id;
2346         }
2347
2348         /**
2349          * Add a whole lot of files by ID
2350          * @param int[] $ids
2351          */
2352         public function addIds( $ids ) {
2353                 $this->ids = array_merge( $this->ids, $ids );
2354         }
2355
2356         /**
2357          * Add all revisions of the file
2358          */
2359         public function addAll() {
2360                 $this->all = true;
2361         }
2362
2363         /**
2364          * Run the transaction, except the cleanup batch.
2365          * The cleanup batch should be run in a separate transaction, because it locks different
2366          * rows and there's no need to keep the image row locked while it's acquiring those locks
2367          * The caller may have its own transaction open.
2368          * So we save the batch and let the caller call cleanup()
2369          * @return FileRepoStatus
2370          */
2371         public function execute() {
2372                 global $wgLang;
2373
2374                 $repo = $this->file->getRepo();
2375                 if ( !$this->all && !$this->ids ) {
2376                         // Do nothing
2377                         return $repo->newGood();
2378                 }
2379
2380                 $lockOwnsTrx = $this->file->lock();
2381
2382                 $dbw = $this->file->repo->getMasterDB();
2383                 $status = $this->file->repo->newGood();
2384
2385                 $exists = (bool)$dbw->selectField( 'image', '1',
2386                         array( 'img_name' => $this->file->getName() ),
2387                         __METHOD__,
2388                         // The lock() should already prevents changes, but this still may need
2389                         // to bypass any transaction snapshot. However, if lock() started the
2390                         // trx (which it probably did) then snapshot is post-lock and up-to-date.
2391                         $lockOwnsTrx ? array() : array( 'LOCK IN SHARE MODE' )
2392                 );
2393
2394                 // Fetch all or selected archived revisions for the file,
2395                 // sorted from the most recent to the oldest.
2396                 $conditions = array( 'fa_name' => $this->file->getName() );
2397
2398                 if ( !$this->all ) {
2399                         $conditions['fa_id'] = $this->ids;
2400                 }
2401
2402                 $result = $dbw->select(
2403                         'filearchive',
2404                         ArchivedFile::selectFields(),
2405                         $conditions,
2406                         __METHOD__,
2407                         array( 'ORDER BY' => 'fa_timestamp DESC' )
2408                 );
2409
2410                 $idsPresent = array();
2411                 $storeBatch = array();
2412                 $insertBatch = array();
2413                 $insertCurrent = false;
2414                 $deleteIds = array();
2415                 $first = true;
2416                 $archiveNames = array();
2417
2418                 foreach ( $result as $row ) {
2419                         $idsPresent[] = $row->fa_id;
2420
2421                         if ( $row->fa_name != $this->file->getName() ) {
2422                                 $status->error( 'undelete-filename-mismatch', $wgLang->timeanddate( $row->fa_timestamp ) );
2423                                 $status->failCount++;
2424                                 continue;
2425                         }
2426
2427                         if ( $row->fa_storage_key == '' ) {
2428                                 // Revision was missing pre-deletion
2429                                 $status->error( 'undelete-bad-store-key', $wgLang->timeanddate( $row->fa_timestamp ) );
2430                                 $status->failCount++;
2431                                 continue;
2432                         }
2433
2434                         $deletedRel = $repo->getDeletedHashPath( $row->fa_storage_key ) .
2435                                 $row->fa_storage_key;
2436                         $deletedUrl = $repo->getVirtualUrl() . '/deleted/' . $deletedRel;
2437
2438                         if ( isset( $row->fa_sha1 ) ) {
2439                                 $sha1 = $row->fa_sha1;
2440                         } else {
2441                                 // old row, populate from key
2442                                 $sha1 = LocalRepo::getHashFromKey( $row->fa_storage_key );
2443                         }
2444
2445                         # Fix leading zero
2446                         if ( strlen( $sha1 ) == 32 && $sha1[0] == '0' ) {
2447                                 $sha1 = substr( $sha1, 1 );
2448                         }
2449
2450                         if ( is_null( $row->fa_major_mime ) || $row->fa_major_mime == 'unknown'
2451                                 || is_null( $row->fa_minor_mime ) || $row->fa_minor_mime == 'unknown'
2452                                 || is_null( $row->fa_media_type ) || $row->fa_media_type == 'UNKNOWN'
2453                                 || is_null( $row->fa_metadata )
2454                         ) {
2455                                 // Refresh our metadata
2456                                 // Required for a new current revision; nice for older ones too. :)
2457                                 $props = RepoGroup::singleton()->getFileProps( $deletedUrl );
2458                         } else {
2459                                 $props = array(
2460                                         'minor_mime' => $row->fa_minor_mime,
2461                                         'major_mime' => $row->fa_major_mime,
2462                                         'media_type' => $row->fa_media_type,
2463                                         'metadata' => $row->fa_metadata
2464                                 );
2465                         }
2466
2467                         if ( $first && !$exists ) {
2468                                 // This revision will be published as the new current version
2469                                 $destRel = $this->file->getRel();
2470                                 $insertCurrent = array(
2471                                         'img_name' => $row->fa_name,
2472                                         'img_size' => $row->fa_size,
2473                                         'img_width' => $row->fa_width,
2474                                         'img_height' => $row->fa_height,
2475                                         'img_metadata' => $props['metadata'],
2476                                         'img_bits' => $row->fa_bits,
2477                                         'img_media_type' => $props['media_type'],
2478                                         'img_major_mime' => $props['major_mime'],
2479                                         'img_minor_mime' => $props['minor_mime'],
2480                                         'img_description' => $row->fa_description,
2481                                         'img_user' => $row->fa_user,
2482                                         'img_user_text' => $row->fa_user_text,
2483                                         'img_timestamp' => $row->fa_timestamp,
2484                                         'img_sha1' => $sha1
2485                                 );
2486
2487                                 // The live (current) version cannot be hidden!
2488                                 if ( !$this->unsuppress && $row->fa_deleted ) {
2489                                         $storeBatch[] = array( $deletedUrl, 'public', $destRel );
2490                                         $this->cleanupBatch[] = $row->fa_storage_key;
2491                                 }
2492                         } else {
2493                                 $archiveName = $row->fa_archive_name;
2494
2495                                 if ( $archiveName == '' ) {
2496                                         // This was originally a current version; we
2497                                         // have to devise a new archive name for it.
2498                                         // Format is <timestamp of archiving>!<name>
2499                                         $timestamp = wfTimestamp( TS_UNIX, $row->fa_deleted_timestamp );
2500
2501                                         do {
2502                                                 $archiveName = wfTimestamp( TS_MW, $timestamp ) . '!' . $row->fa_name;
2503                                                 $timestamp++;
2504                                         } while ( isset( $archiveNames[$archiveName] ) );
2505                                 }
2506
2507                                 $archiveNames[$archiveName] = true;
2508                                 $destRel = $this->file->getArchiveRel( $archiveName );
2509                                 $insertBatch[] = array(
2510                                         'oi_name' => $row->fa_name,
2511                                         'oi_archive_name' => $archiveName,
2512                                         'oi_size' => $row->fa_size,
2513                                         'oi_width' => $row->fa_width,
2514                                         'oi_height' => $row->fa_height,
2515                                         'oi_bits' => $row->fa_bits,
2516                                         'oi_description' => $row->fa_description,
2517                                         'oi_user' => $row->fa_user,
2518                                         'oi_user_text' => $row->fa_user_text,
2519                                         'oi_timestamp' => $row->fa_timestamp,
2520                                         'oi_metadata' => $props['metadata'],
2521                                         'oi_media_type' => $props['media_type'],
2522                                         'oi_major_mime' => $props['major_mime'],
2523                                         'oi_minor_mime' => $props['minor_mime'],
2524                                         'oi_deleted' => $this->unsuppress ? 0 : $row->fa_deleted,
2525                                         'oi_sha1' => $sha1 );
2526                         }
2527
2528                         $deleteIds[] = $row->fa_id;
2529
2530                         if ( !$this->unsuppress && $row->fa_deleted & File::DELETED_FILE ) {
2531                                 // private files can stay where they are
2532                                 $status->successCount++;
2533                         } else {
2534                                 $storeBatch[] = array( $deletedUrl, 'public', $destRel );
2535                                 $this->cleanupBatch[] = $row->fa_storage_key;
2536                         }
2537
2538                         $first = false;
2539                 }
2540
2541                 unset( $result );
2542
2543                 // Add a warning to the status object for missing IDs
2544                 $missingIds = array_diff( $this->ids, $idsPresent );
2545
2546                 foreach ( $missingIds as $id ) {
2547                         $status->error( 'undelete-missing-filearchive', $id );
2548                 }
2549
2550                 if ( !$repo->hasSha1Storage() ) {
2551                         // Remove missing files from batch, so we don't get errors when undeleting them
2552                         $checkStatus = $this->removeNonexistentFiles( $storeBatch );
2553                         if ( !$checkStatus->isGood() ) {
2554                                 $status->merge( $checkStatus );
2555                                 return $status;
2556                         }
2557                         $storeBatch = $checkStatus->value;
2558
2559                         // Run the store batch
2560                         // Use the OVERWRITE_SAME flag to smooth over a common error
2561                         $storeStatus = $this->file->repo->storeBatch( $storeBatch, FileRepo::OVERWRITE_SAME );
2562                         $status->merge( $storeStatus );
2563
2564                         if ( !$status->isGood() ) {
2565                                 // Even if some files could be copied, fail entirely as that is the
2566                                 // easiest thing to do without data loss
2567                                 $this->cleanupFailedBatch( $storeStatus, $storeBatch );
2568                                 $status->ok = false;
2569                                 $this->file->unlock();
2570
2571                                 return $status;
2572                         }
2573                 }
2574
2575                 // Run the DB updates
2576                 // Because we have locked the image row, key conflicts should be rare.
2577                 // If they do occur, we can roll back the transaction at this time with
2578                 // no data loss, but leaving unregistered files scattered throughout the
2579                 // public zone.
2580                 // This is not ideal, which is why it's important to lock the image row.
2581                 if ( $insertCurrent ) {
2582                         $dbw->insert( 'image', $insertCurrent, __METHOD__ );
2583                 }
2584
2585                 if ( $insertBatch ) {
2586                         $dbw->insert( 'oldimage', $insertBatch, __METHOD__ );
2587                 }
2588
2589                 if ( $deleteIds ) {
2590                         $dbw->delete( 'filearchive',
2591                                 array( 'fa_id' => $deleteIds ),
2592                                 __METHOD__ );
2593                 }
2594
2595                 // If store batch is empty (all files are missing), deletion is to be considered successful
2596                 if ( $status->successCount > 0 || !$storeBatch || $repo->hasSha1Storage() ) {
2597                         if ( !$exists ) {
2598                                 wfDebug( __METHOD__ . " restored {$status->successCount} items, creating a new current\n" );
2599
2600                                 DeferredUpdates::addUpdate( SiteStatsUpdate::factory( array( 'images' => 1 ) ) );
2601
2602                                 $this->file->purgeEverything();
2603                         } else {
2604                                 wfDebug( __METHOD__ . " restored {$status->successCount} as archived versions\n" );
2605                                 $this->file->purgeDescription();
2606                         }
2607                 }
2608
2609                 $this->file->unlock();
2610
2611                 return $status;
2612         }
2613
2614         /**
2615          * Removes non-existent files from a store batch.
2616          * @param array $triplets
2617          * @return Status
2618          */
2619         protected function removeNonexistentFiles( $triplets ) {
2620                 $files = $filteredTriplets = array();
2621                 foreach ( $triplets as $file ) {
2622                         $files[$file[0]] = $file[0];
2623                 }
2624
2625                 $result = $this->file->repo->fileExistsBatch( $files );
2626                 if ( in_array( null, $result, true ) ) {
2627                         return Status::newFatal( 'backend-fail-internal',
2628                                 $this->file->repo->getBackend()->getName() );
2629                 }
2630
2631                 foreach ( $triplets as $file ) {
2632                         if ( $result[$file[0]] ) {
2633                                 $filteredTriplets[] = $file;
2634                         }
2635                 }
2636
2637                 return Status::newGood( $filteredTriplets );
2638         }
2639
2640         /**
2641          * Removes non-existent files from a cleanup batch.
2642          * @param array $batch
2643          * @return array
2644          */
2645         protected function removeNonexistentFromCleanup( $batch ) {
2646                 $files = $newBatch = array();
2647                 $repo = $this->file->repo;
2648
2649                 foreach ( $batch as $file ) {
2650                         $files[$file] = $repo->getVirtualUrl( 'deleted' ) . '/' .
2651                                 rawurlencode( $repo->getDeletedHashPath( $file ) . $file );
2652                 }
2653
2654                 $result = $repo->fileExistsBatch( $files );
2655
2656                 foreach ( $batch as $file ) {
2657                         if ( $result[$file] ) {
2658                                 $newBatch[] = $file;
2659                         }
2660                 }
2661
2662                 return $newBatch;
2663         }
2664
2665         /**
2666          * Delete unused files in the deleted zone.
2667          * This should be called from outside the transaction in which execute() was called.
2668          * @return FileRepoStatus
2669          */
2670         public function cleanup() {
2671                 if ( !$this->cleanupBatch ) {
2672                         return $this->file->repo->newGood();
2673                 }
2674
2675                 $this->cleanupBatch = $this->removeNonexistentFromCleanup( $this->cleanupBatch );
2676
2677                 $status = $this->file->repo->cleanupDeletedBatch( $this->cleanupBatch );
2678
2679                 return $status;
2680         }
2681
2682         /**
2683          * Cleanup a failed batch. The batch was only partially successful, so
2684          * rollback by removing all items that were succesfully copied.
2685          *
2686          * @param Status $storeStatus
2687          * @param array $storeBatch
2688          */
2689         protected function cleanupFailedBatch( $storeStatus, $storeBatch ) {
2690                 $cleanupBatch = array();
2691
2692                 foreach ( $storeStatus->success as $i => $success ) {
2693                         // Check if this item of the batch was successfully copied
2694                         if ( $success ) {
2695                                 // Item was successfully copied and needs to be removed again
2696                                 // Extract ($dstZone, $dstRel) from the batch
2697                                 $cleanupBatch[] = array( $storeBatch[$i][1], $storeBatch[$i][2] );
2698                         }
2699                 }
2700                 $this->file->repo->cleanupBatch( $cleanupBatch );
2701         }
2702 }
2703
2704 # ------------------------------------------------------------------------------
2705
2706 /**
2707  * Helper class for file movement
2708  * @ingroup FileAbstraction
2709  */
2710 class LocalFileMoveBatch {
2711         /** @var LocalFile */
2712         protected $file;
2713
2714         /** @var Title */
2715         protected $target;
2716
2717         protected $cur;
2718
2719         protected $olds;
2720
2721         protected $oldCount;
2722
2723         protected $archive;
2724
2725         /** @var DatabaseBase */
2726         protected $db;
2727
2728         /**
2729          * @param File $file
2730          * @param Title $target
2731          */
2732         function __construct( File $file, Title $target ) {
2733                 $this->file = $file;
2734                 $this->target = $target;
2735                 $this->oldHash = $this->file->repo->getHashPath( $this->file->getName() );
2736                 $this->newHash = $this->file->repo->getHashPath( $this->target->getDBkey() );
2737                 $this->oldName = $this->file->getName();
2738                 $this->newName = $this->file->repo->getNameFromTitle( $this->target );
2739                 $this->oldRel = $this->oldHash . $this->oldName;
2740                 $this->newRel = $this->newHash . $this->newName;
2741                 $this->db = $file->getRepo()->getMasterDb();
2742         }
2743
2744         /**
2745          * Add the current image to the batch
2746          */
2747         public function addCurrent() {
2748                 $this->cur = array( $this->oldRel, $this->newRel );
2749         }
2750
2751         /**
2752          * Add the old versions of the image to the batch
2753          * @return array List of archive names from old versions
2754          */
2755         public function addOlds() {
2756                 $archiveBase = 'archive';
2757                 $this->olds = array();
2758                 $this->oldCount = 0;
2759                 $archiveNames = array();
2760
2761                 $result = $this->db->select( 'oldimage',
2762                         array( 'oi_archive_name', 'oi_deleted' ),
2763                         array( 'oi_name' => $this->oldName ),
2764                         __METHOD__,
2765                         array( 'LOCK IN SHARE MODE' ) // ignore snapshot
2766                 );
2767
2768                 foreach ( $result as $row ) {
2769                         $archiveNames[] = $row->oi_archive_name;
2770                         $oldName = $row->oi_archive_name;
2771                         $bits = explode( '!', $oldName, 2 );
2772
2773                         if ( count( $bits ) != 2 ) {
2774                                 wfDebug( "Old file name missing !: '$oldName' \n" );
2775                                 continue;
2776                         }
2777
2778                         list( $timestamp, $filename ) = $bits;
2779
2780                         if ( $this->oldName != $filename ) {
2781                                 wfDebug( "Old file name doesn't match: '$oldName' \n" );
2782                                 continue;
2783                         }
2784
2785                         $this->oldCount++;
2786
2787                         // Do we want to add those to oldCount?
2788                         if ( $row->oi_deleted & File::DELETED_FILE ) {
2789                                 continue;
2790                         }
2791
2792                         $this->olds[] = array(
2793                                 "{$archiveBase}/{$this->oldHash}{$oldName}",
2794                                 "{$archiveBase}/{$this->newHash}{$timestamp}!{$this->newName}"
2795                         );
2796                 }
2797
2798                 return $archiveNames;
2799         }
2800
2801         /**
2802          * Perform the move.
2803          * @return FileRepoStatus
2804          */
2805         public function execute() {
2806                 $repo = $this->file->repo;
2807                 $status = $repo->newGood();
2808
2809                 $triplets = $this->getMoveTriplets();
2810                 $checkStatus = $this->removeNonexistentFiles( $triplets );
2811                 if ( !$checkStatus->isGood() ) {
2812                         $status->merge( $checkStatus );
2813                         return $status;
2814                 }
2815                 $triplets = $checkStatus->value;
2816                 $destFile = wfLocalFile( $this->target );
2817
2818                 $this->file->lock(); // begin
2819                 $destFile->lock(); // quickly fail if destination is not available
2820                 // Rename the file versions metadata in the DB.
2821                 // This implicitly locks the destination file, which avoids race conditions.
2822                 // If we moved the files from A -> C before DB updates, another process could
2823                 // move files from B -> C at this point, causing storeBatch() to fail and thus
2824                 // cleanupTarget() to trigger. It would delete the C files and cause data loss.
2825                 $statusDb = $this->doDBUpdates();
2826                 if ( !$statusDb->isGood() ) {
2827                         $destFile->unlock();
2828                         $this->file->unlockAndRollback();
2829                         $statusDb->ok = false;
2830
2831                         return $statusDb;
2832                 }
2833                 wfDebugLog( 'imagemove', "Renamed {$this->file->getName()} in database: " .
2834                         "{$statusDb->successCount} successes, {$statusDb->failCount} failures" );
2835
2836                 if ( !$repo->hasSha1Storage() ) {
2837                         // Copy the files into their new location.
2838                         // If a prior process fataled copying or cleaning up files we tolerate any
2839                         // of the existing files if they are identical to the ones being stored.
2840                         $statusMove = $repo->storeBatch( $triplets, FileRepo::OVERWRITE_SAME );
2841                         wfDebugLog( 'imagemove', "Moved files for {$this->file->getName()}: " .
2842                                 "{$statusMove->successCount} successes, {$statusMove->failCount} failures" );
2843                         if ( !$statusMove->isGood() ) {
2844                                 // Delete any files copied over (while the destination is still locked)
2845                                 $this->cleanupTarget( $triplets );
2846                                 $destFile->unlock();
2847                                 $this->file->unlockAndRollback(); // unlocks the destination
2848                                 wfDebugLog( 'imagemove', "Error in moving files: " . $statusMove->getWikiText() );
2849                                 $statusMove->ok = false;
2850
2851                                 return $statusMove;
2852                         }
2853                         $status->merge( $statusMove );
2854                 }
2855
2856                 $destFile->unlock();
2857                 $this->file->unlock(); // done
2858
2859                 // Everything went ok, remove the source files
2860                 $this->cleanupSource( $triplets );
2861
2862                 $status->merge( $statusDb );
2863
2864                 return $status;
2865         }
2866
2867         /**
2868          * Do the database updates and return a new FileRepoStatus indicating how
2869          * many rows where updated.
2870          *
2871          * @return FileRepoStatus
2872          */
2873         protected function doDBUpdates() {
2874                 $repo = $this->file->repo;
2875                 $status = $repo->newGood();
2876                 $dbw = $this->db;
2877
2878                 // Update current image
2879                 $dbw->update(
2880                         'image',
2881                         array( 'img_name' => $this->newName ),
2882                         array( 'img_name' => $this->oldName ),
2883                         __METHOD__
2884                 );
2885
2886                 if ( $dbw->affectedRows() ) {
2887                         $status->successCount++;
2888                 } else {
2889                         $status->failCount++;
2890                         $status->fatal( 'imageinvalidfilename' );
2891
2892                         return $status;
2893                 }
2894
2895                 // Update old images
2896                 $dbw->update(
2897                         'oldimage',
2898                         array(
2899                                 'oi_name' => $this->newName,
2900                                 'oi_archive_name = ' . $dbw->strreplace( 'oi_archive_name',
2901                                         $dbw->addQuotes( $this->oldName ), $dbw->addQuotes( $this->newName ) ),
2902                         ),
2903                         array( 'oi_name' => $this->oldName ),
2904                         __METHOD__
2905                 );
2906
2907                 $affected = $dbw->affectedRows();
2908                 $total = $this->oldCount;
2909                 $status->successCount += $affected;
2910                 // Bug 34934: $total is based on files that actually exist.
2911                 // There may be more DB rows than such files, in which case $affected
2912                 // can be greater than $total. We use max() to avoid negatives here.
2913                 $status->failCount += max( 0, $total - $affected );
2914                 if ( $status->failCount ) {
2915                         $status->error( 'imageinvalidfilename' );
2916                 }
2917
2918                 return $status;
2919         }
2920
2921         /**
2922          * Generate triplets for FileRepo::storeBatch().
2923          * @return array
2924          */
2925         protected function getMoveTriplets() {
2926                 $moves = array_merge( array( $this->cur ), $this->olds );
2927                 $triplets = array(); // The format is: (srcUrl, destZone, destUrl)
2928
2929                 foreach ( $moves as $move ) {
2930                         // $move: (oldRelativePath, newRelativePath)
2931                         $srcUrl = $this->file->repo->getVirtualUrl() . '/public/' . rawurlencode( $move[0] );
2932                         $triplets[] = array( $srcUrl, 'public', $move[1] );
2933                         wfDebugLog(
2934                                 'imagemove',
2935                                 "Generated move triplet for {$this->file->getName()}: {$srcUrl} :: public :: {$move[1]}"
2936                         );
2937                 }
2938
2939                 return $triplets;
2940         }
2941
2942         /**
2943          * Removes non-existent files from move batch.
2944          * @param array $triplets
2945          * @return Status
2946          */
2947         protected function removeNonexistentFiles( $triplets ) {
2948                 $files = array();
2949
2950                 foreach ( $triplets as $file ) {
2951                         $files[$file[0]] = $file[0];
2952                 }
2953
2954                 $result = $this->file->repo->fileExistsBatch( $files );
2955                 if ( in_array( null, $result, true ) ) {
2956                         return Status::newFatal( 'backend-fail-internal',
2957                                 $this->file->repo->getBackend()->getName() );
2958                 }
2959
2960                 $filteredTriplets = array();
2961                 foreach ( $triplets as $file ) {
2962                         if ( $result[$file[0]] ) {
2963                                 $filteredTriplets[] = $file;
2964                         } else {
2965                                 wfDebugLog( 'imagemove', "File {$file[0]} does not exist" );
2966                         }
2967                 }
2968
2969                 return Status::newGood( $filteredTriplets );
2970         }
2971
2972         /**
2973          * Cleanup a partially moved array of triplets by deleting the target
2974          * files. Called if something went wrong half way.
2975          * @param array $triplets
2976          */
2977         protected function cleanupTarget( $triplets ) {
2978                 // Create dest pairs from the triplets
2979                 $pairs = array();
2980                 foreach ( $triplets as $triplet ) {
2981                         // $triplet: (old source virtual URL, dst zone, dest rel)
2982                         $pairs[] = array( $triplet[1], $triplet[2] );
2983                 }
2984
2985                 $this->file->repo->cleanupBatch( $pairs );
2986         }
2987
2988         /**
2989          * Cleanup a fully moved array of triplets by deleting the source files.
2990          * Called at the end of the move process if everything else went ok.
2991          * @param array $triplets
2992          */
2993         protected function cleanupSource( $triplets ) {
2994                 // Create source file names from the triplets
2995                 $files = array();
2996                 foreach ( $triplets as $triplet ) {
2997                         $files[] = $triplet[0];
2998                 }
2999
3000                 $this->file->repo->cleanupBatch( $files );
3001         }
3002 }