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