includes/filerepo/file/LocalFile.php

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