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