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