includes/filerepo/file/LocalFile.php

   1 <?php
   2 /**
   3  * Local file in the wiki's own database.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  * @ingroup FileAbstraction
  22  */
  23
  24 /**
  25  * Bump this number when serialized cache records may be incompatible.
  26  */
  27 define( 'MW_FILE_VERSION', 8 );
  28
  29 /**
  30  * Class to represent a local file in the wiki's own database
  31  *
  32  * Provides methods to retrieve paths (physical, logical, URL),
  33  * to generate image thumbnails or for uploading.
  34  *
  35  * Note that only the repo object knows what its file class is called. You should
  36  * never name a file class explictly outside of the repo class. Instead use the
  37  * repo's factory functions to generate file objects, for example:
  38  *
  39  * RepoGroup::singleton()->getLocalRepo()->newFile($title);
  40  *
  41  * The convenience functions wfLocalFile() and wfFindFile() should be sufficient
  42  * in most cases.
  43  *
  44  * @ingroup FileAbstraction
  45  */
  46 class LocalFile extends File {
  47         const CACHE_FIELD_MAX_LEN = 1000;
  48
  49         /**#@+
  50          * @private
  51          */
  52         var
  53                 $fileExists,       # does the file exist on disk? (loadFromXxx)
  54                 $historyLine,      # Number of line to return by nextHistoryLine() (constructor)
  55                 $historyRes,       # result of the query for the file's history (nextHistoryLine)
  56                 $width,            # \
  57                 $height,           #  |
  58                 $bits,             #   --- returned by getimagesize (loadFromXxx)
  59                 $attr,             # /
  60                 $media_type,       # MEDIATYPE_xxx (bitmap, drawing, audio...)
  61                 $mime,             # MIME type, determined by MimeMagic::guessMimeType
  62                 $major_mime,       # Major mime type
  63                 $minor_mime,       # Minor mime type
  64                 $size,             # Size in bytes (loadFromXxx)
  65                 $metadata,         # Handler-specific metadata
  66                 $timestamp,        # Upload timestamp
  67                 $sha1,             # SHA-1 base 36 content hash
  68                 $user, $user_text, # User, who uploaded the file
  69                 $description,      # Description of current revision of the file
  70                 $dataLoaded,       # Whether or not all this has been loaded from the database (loadFromXxx)
  71                 $upgraded,         # Whether the row was upgraded on load
  72                 $locked,           # True if the image row is locked
  73                 $missing,          # True if file is not present in file system. Not to be cached in memcached
  74                 $deleted;          # Bitfield akin to rev_deleted
  75
  76         /**#@-*/
  77
  78         /**
  79          * @var LocalRepo
  80          */
  81         var $repo;
  82
  83         protected $repoClass = 'LocalRepo';
  84
  85         /**
  86          * Create a LocalFile from a title
  87          * Do not call this except from inside a repo class.
  88          *
  89          * Note: $unused param is only here to avoid an E_STRICT
  90          *
  91          * @param $title
  92          * @param $repo
  93          * @param $unused
  94          *
  95          * @return LocalFile
  96          */
  97         static function newFromTitle( $title, $repo, $unused = null ) {
  98                 return new self( $title, $repo );
  99         }
 100
 101         /**
 102          * Create a LocalFile from a title
 103          * Do not call this except from inside a repo class.
 104          *
 105          * @param $row
 106          * @param $repo
 107          *
 108          * @return LocalFile
 109          */
 110         static function newFromRow( $row, $repo ) {
 111                 $title = Title::makeTitle( NS_FILE, $row->img_name );
 112                 $file = new self( $title, $repo );
 113                 $file->loadFromRow( $row );
 114
 115                 return $file;
 116         }
 117
 118         /**
 119          * Create a LocalFile from a SHA-1 key
 120          * Do not call this except from inside a repo class.
 121          *
 122          * @param $sha1 string base-36 SHA-1
 123          * @param $repo LocalRepo
 124          * @param string|bool $timestamp MW_timestamp (optional)
 125          *
 126          * @return bool|LocalFile
 127          */
 128         static function newFromKey( $sha1, $repo, $timestamp = false ) {
 129                 $dbr = $repo->getSlaveDB();
 130
 131                 $conds = array( 'img_sha1' => $sha1 );
 132                 if ( $timestamp ) {
 133                         $conds['img_timestamp'] = $dbr->timestamp( $timestamp );
 134                 }
 135
 136                 $row = $dbr->selectRow( 'image', self::selectFields(), $conds, __METHOD__ );
 137                 if ( $row ) {
 138                         return self::newFromRow( $row, $repo );
 139                 } else {
 140                         return false;
 141                 }
 142         }
 143
 144         /**
 145          * Fields in the image table
 146          * @return array
 147          */
 148         static function selectFields() {
 149                 return array(
 150                         'img_name',
 151                         'img_size',
 152                         'img_width',
 153                         'img_height',
 154                         'img_metadata',
 155                         'img_bits',
 156                         'img_media_type',
 157                         'img_major_mime',
 158                         'img_minor_mime',
 159                         'img_description',
 160                         'img_user',
 161                         'img_user_text',
 162                         'img_timestamp',
 163                         'img_sha1',
 164                 );
 165         }
 166
 167         /**
 168          * Constructor.
 169          * Do not call this except from inside a repo class.
 170          */
 171         function __construct( $title, $repo ) {
 172                 parent::__construct( $title, $repo );
 173
 174                 $this->metadata = '';
 175                 $this->historyLine = 0;
 176                 $this->historyRes = null;
 177                 $this->dataLoaded = false;
 178
 179                 $this->assertRepoDefined();
 180                 $this->assertTitleDefined();
 181         }
 182
 183         /**
 184          * Get the memcached key for the main data for this file, or false if
 185          * there is no access to the shared cache.
 186          * @return bool
 187          */
 188         function getCacheKey() {
 189                 $hashedName = md5( $this->getName() );
 190
 191                 return $this->repo->getSharedCacheKey( 'file', $hashedName );
 192         }
 193
 194         /**
 195          * Try to load file metadata from memcached. Returns true on success.
 196          * @return bool
 197          */
 198         function loadFromCache() {
 199                 global $wgMemc;
 200
 201                 wfProfileIn( __METHOD__ );
 202                 $this->dataLoaded = false;
 203                 $key = $this->getCacheKey();
 204
 205                 if ( !$key ) {
 206                         wfProfileOut( __METHOD__ );
 207                         return false;
 208                 }
 209
 210                 $cachedValues = $wgMemc->get( $key );
 211
 212                 // Check if the key existed and belongs to this version of MediaWiki
 213                 if ( isset( $cachedValues['version'] ) && ( $cachedValues['version'] == MW_FILE_VERSION ) ) {
 214                         wfDebug( "Pulling file metadata from cache key $key\n" );
 215                         $this->fileExists = $cachedValues['fileExists'];
 216                         if ( $this->fileExists ) {
 217                                 $this->setProps( $cachedValues );
 218                         }
 219                         $this->dataLoaded = true;
 220                 }
 221
 222                 if ( $this->dataLoaded ) {
 223                         wfIncrStats( 'image_cache_hit' );
 224                 } else {
 225                         wfIncrStats( 'image_cache_miss' );
 226                 }
 227
 228                 wfProfileOut( __METHOD__ );
 229                 return $this->dataLoaded;
 230         }
 231
 232         /**
 233          * Save the file metadata to memcached
 234          */
 235         function saveToCache() {
 236                 global $wgMemc;
 237
 238                 $this->load();
 239                 $key = $this->getCacheKey();
 240
 241                 if ( !$key ) {
 242                         return;
 243                 }
 244
 245                 $fields = $this->getCacheFields( '' );
 246                 $cache = array( 'version' => MW_FILE_VERSION );
 247                 $cache['fileExists'] = $this->fileExists;
 248
 249                 if ( $this->fileExists ) {
 250                         foreach ( $fields as $field ) {
 251                                 $cache[$field] = $this->$field;
 252                         }
 253                 }
 254
 255                 $wgMemc->set( $key, $cache, 60 * 60 * 24 * 7 ); // A week
 256         }
 257
 258         /**
 259          * Load metadata from the file itself
 260          */
 261         function loadFromFile() {
 262                 $props = $this->repo->getFileProps( $this->getVirtualUrl() );
 263                 $this->setProps( $props );
 264         }
 265
 266         /**
 267          * @param $prefix string
 268          * @return array
 269          */
 270         function getCacheFields( $prefix = 'img_' ) {
 271                 static $fields = array( 'size', 'width', 'height', 'bits', 'media_type',
 272                         'major_mime', 'minor_mime', 'metadata', 'timestamp', 'sha1', 'user', 'user_text', 'description' );
 273                 static $results = array();
 274
 275                 if ( $prefix == '' ) {
 276                         return $fields;
 277                 }
 278
 279                 if ( !isset( $results[$prefix] ) ) {
 280                         $prefixedFields = array();
 281                         foreach ( $fields as $field ) {
 282                                 $prefixedFields[] = $prefix . $field;
 283                         }
 284                         $results[$prefix] = $prefixedFields;
 285                 }
 286
 287                 return $results[$prefix];
 288         }
 289
 290         /**
 291          * Load file metadata from the DB
 292          */
 293         function loadFromDB() {
 294                 # Polymorphic function name to distinguish foreign and local fetches
 295                 $fname = get_class( $this ) . '::' . __FUNCTION__;
 296                 wfProfileIn( $fname );
 297
 298                 # Unconditionally set loaded=true, we don't want the accessors constantly rechecking
 299                 $this->dataLoaded = true;
 300
 301                 $dbr = $this->repo->getMasterDB();
 302
 303                 $row = $dbr->selectRow( 'image', $this->getCacheFields( 'img_' ),
 304                         array( 'img_name' => $this->getName() ), $fname );
 305
 306                 if ( $row ) {
 307                         $this->loadFromRow( $row );
 308                 } else {
 309                         $this->fileExists = false;
 310                 }
 311
 312                 wfProfileOut( $fname );
 313         }
 314
 315         /**
 316          * Decode a row from the database (either object or array) to an array
 317          * with timestamps and MIME types decoded, and the field prefix removed.
 318          * @param $row
 319          * @param $prefix string
 320          * @throws MWException
 321          * @return array
 322          */
 323         function decodeRow( $row, $prefix = 'img_' ) {
 324                 $array = (array)$row;
 325                 $prefixLength = strlen( $prefix );
 326
 327                 // Sanity check prefix once
 328                 if ( substr( key( $array ), 0, $prefixLength ) !== $prefix ) {
 329                         throw new MWException( __METHOD__ .  ': incorrect $prefix parameter' );
 330                 }
 331
 332                 $decoded = array();
 333
 334                 foreach ( $array as $name => $value ) {
 335                         $decoded[substr( $name, $prefixLength )] = $value;
 336                 }
 337
 338                 $decoded['timestamp'] = wfTimestamp( TS_MW, $decoded['timestamp'] );
 339
 340                 if ( empty( $decoded['major_mime'] ) ) {
 341                         $decoded['mime'] = 'unknown/unknown';
 342                 } else {
 343                         if ( !$decoded['minor_mime'] ) {
 344                                 $decoded['minor_mime'] = 'unknown';
 345                         }
 346                         $decoded['mime'] = $decoded['major_mime'] . '/' . $decoded['minor_mime'];
 347                 }
 348
 349                 # Trim zero padding from char/binary field
 350                 $decoded['sha1'] = rtrim( $decoded['sha1'], "\0" );
 351
 352                 return $decoded;
 353         }
 354
 355         /**
 356          * Load file metadata from a DB result row
 357          */
 358         function loadFromRow( $row, $prefix = 'img_' ) {
 359                 $this->dataLoaded = true;
 360                 $array = $this->decodeRow( $row, $prefix );
 361
 362                 foreach ( $array as $name => $value ) {
 363                         $this->$name = $value;
 364                 }
 365
 366                 $this->fileExists = true;
 367                 $this->maybeUpgradeRow();
 368         }
 369
 370         /**
 371          * Load file metadata from cache or DB, unless already loaded
 372          */
 373         function load() {
 374                 if ( !$this->dataLoaded ) {
 375                         if ( !$this->loadFromCache() ) {
 376                                 $this->loadFromDB();
 377                                 $this->saveToCache();
 378                         }
 379                         $this->dataLoaded = true;
 380                 }
 381         }
 382
 383         /**
 384          * Upgrade a row if it needs it
 385          */
 386         function maybeUpgradeRow() {
 387                 global $wgUpdateCompatibleMetadata;
 388                 if ( wfReadOnly() ) {
 389                         return;
 390                 }
 391
 392                 if ( is_null( $this->media_type ) ||
 393                         $this->mime == 'image/svg'
 394                 ) {
 395                         $this->upgradeRow();
 396                         $this->upgraded = true;
 397                 } else {
 398                         $handler = $this->getHandler();
 399                         if ( $handler ) {
 400                                 $validity = $handler->isMetadataValid( $this, $this->metadata );
 401                                 if ( $validity === MediaHandler::METADATA_BAD
 402                                         || ( $validity === MediaHandler::METADATA_COMPATIBLE && $wgUpdateCompatibleMetadata )
 403                                 ) {
 404                                         $this->upgradeRow();
 405                                         $this->upgraded = true;
 406                                 }
 407                         }
 408                 }
 409         }
 410
 411         function getUpgraded() {
 412                 return $this->upgraded;
 413         }
 414
 415         /**
 416          * Fix assorted version-related problems with the image row by reloading it from the file
 417          */
 418         function upgradeRow() {
 419                 wfProfileIn( __METHOD__ );
 420
 421                 $this->lock(); // begin
 422
 423                 $this->loadFromFile();
 424
 425                 # Don't destroy file info of missing files
 426                 if ( !$this->fileExists ) {
 427                         wfDebug( __METHOD__ . ": file does not exist, aborting\n" );
 428                         wfProfileOut( __METHOD__ );
 429                         return;
 430                 }
 431
 432                 $dbw = $this->repo->getMasterDB();
 433                 list( $major, $minor ) = self::splitMime( $this->mime );
 434
 435                 if ( wfReadOnly() ) {
 436                         wfProfileOut( __METHOD__ );
 437                         return;
 438                 }
 439                 wfDebug( __METHOD__ . ': upgrading ' . $this->getName() . " to the current schema\n" );
 440
 441                 $dbw->update( 'image',
 442                         array(
 443                                 'img_size'       => $this->size, // sanity
 444                                 'img_width'      => $this->width,
 445                                 'img_height'     => $this->height,
 446                                 'img_bits'       => $this->bits,
 447                                 'img_media_type' => $this->media_type,
 448                                 'img_major_mime' => $major,
 449                                 'img_minor_mime' => $minor,
 450                                 'img_metadata'   => $this->metadata,
 451                                 'img_sha1'       => $this->sha1,
 452                         ),
 453                         array( 'img_name' => $this->getName() ),
 454                         __METHOD__
 455                 );
 456
 457                 $this->saveToCache();
 458
 459                 $this->unlock(); // done
 460
 461                 wfProfileOut( __METHOD__ );
 462         }
 463
 464         /**
 465          * Set properties in this object to be equal to those given in the
 466          * associative array $info. Only cacheable fields can be set.
 467          *
 468          * If 'mime' is given, it will be split into major_mime/minor_mime.
 469          * If major_mime/minor_mime are given, $this->mime will also be set.
 470          */
 471         function setProps( $info ) {
 472                 $this->dataLoaded = true;
 473                 $fields = $this->getCacheFields( '' );
 474                 $fields[] = 'fileExists';
 475
 476                 foreach ( $fields as $field ) {
 477                         if ( isset( $info[$field] ) ) {
 478                                 $this->$field = $info[$field];
 479                         }
 480                 }
 481
 482                 // Fix up mime fields
 483                 if ( isset( $info['major_mime'] ) ) {
 484                         $this->mime = "{$info['major_mime']}/{$info['minor_mime']}";
 485                 } elseif ( isset( $info['mime'] ) ) {
 486                         $this->mime = $info['mime'];
 487                         list( $this->major_mime, $this->minor_mime ) = self::splitMime( $this->mime );
 488                 }
 489         }
 490
 491         /** splitMime inherited */
 492         /** getName inherited */
 493         /** getTitle inherited */
 494         /** getURL inherited */
 495         /** getViewURL inherited */
 496         /** getPath inherited */
 497         /** isVisible inhereted */
 498
 499         /**
 500          * @return bool
 501          */
 502         function isMissing() {
 503                 if ( $this->missing === null ) {
 504                         list( $fileExists ) = $this->repo->fileExists( $this->getVirtualUrl() );
 505                         $this->missing = !$fileExists;
 506                 }
 507                 return $this->missing;
 508         }
 509
 510         /**
 511          * Return the width of the image
 512          *
 513          * @param $page int
 514          * @return bool|int Returns false on error
 515          */
 516         public function getWidth( $page = 1 ) {
 517                 $this->load();
 518
 519                 if ( $this->isMultipage() ) {
 520                         $dim = $this->getHandler()->getPageDimensions( $this, $page );
 521                         if ( $dim ) {
 522                                 return $dim['width'];
 523                         } else {
 524                                 return false;
 525                         }
 526                 } else {
 527                         return $this->width;
 528                 }
 529         }
 530
 531         /**
 532          * Return the height of the image
 533          *
 534          * @param $page int
 535          * @return bool|int Returns false on error
 536          */
 537         public function getHeight( $page = 1 ) {
 538                 $this->load();
 539
 540                 if ( $this->isMultipage() ) {
 541                         $dim = $this->getHandler()->getPageDimensions( $this, $page );
 542                         if ( $dim ) {
 543                                 return $dim['height'];
 544                         } else {
 545                                 return false;
 546                         }
 547                 } else {
 548                         return $this->height;
 549                 }
 550         }
 551
 552         /**
 553          * Returns ID or name of user who uploaded the file
 554          *
 555          * @param $type string 'text' or 'id'
 556          * @return int|string
 557          */
 558         function getUser( $type = 'text' ) {
 559                 $this->load();
 560
 561                 if ( $type == 'text' ) {
 562                         return $this->user_text;
 563                 } elseif ( $type == 'id' ) {
 564                         return $this->user;
 565                 }
 566         }
 567
 568         /**
 569          * Get handler-specific metadata
 570          * @return string
 571          */
 572         function getMetadata() {
 573                 $this->load();
 574                 return $this->metadata;
 575         }
 576
 577         /**
 578          * @return int
 579          */
 580         function getBitDepth() {
 581                 $this->load();
 582                 return $this->bits;
 583         }
 584
 585         /**
 586          * Return the size of the image file, in bytes
 587          * @return int
 588          */
 589         public function getSize() {
 590                 $this->load();
 591                 return $this->size;
 592         }
 593
 594         /**
 595          * Returns the mime type of the file.
 596          * @return string
 597          */
 598         function getMimeType() {
 599                 $this->load();
 600                 return $this->mime;
 601         }
 602
 603         /**
 604          * Return the type of the media in the file.
 605          * Use the value returned by this function with the MEDIATYPE_xxx constants.
 606          * @return string
 607          */
 608         function getMediaType() {
 609                 $this->load();
 610                 return $this->media_type;
 611         }
 612
 613         /** canRender inherited */
 614         /** mustRender inherited */
 615         /** allowInlineDisplay inherited */
 616         /** isSafeFile inherited */
 617         /** isTrustedFile inherited */
 618
 619         /**
 620          * Returns true if the file exists on disk.
 621          * @return boolean Whether file exist on disk.
 622          */
 623         public function exists() {
 624                 $this->load();
 625                 return $this->fileExists;
 626         }
 627
 628         /** getTransformScript inherited */
 629         /** getUnscaledThumb inherited */
 630         /** thumbName inherited */
 631         /** createThumb inherited */
 632         /** transform inherited */
 633
 634         /**
 635          * Fix thumbnail files from 1.4 or before, with extreme prejudice
 636          * @todo : do we still care about this? Perhaps a maintenance script
 637          *        can be made instead. Enabling this code results in a serious
 638          *        RTT regression for wikis without 404 handling.
 639          */
 640         function migrateThumbFile( $thumbName ) {
 641                 $thumbDir = $this->getThumbPath();
 642
 643                 /* Old code for bug 2532
 644                 $thumbPath = "$thumbDir/$thumbName";
 645                 if ( is_dir( $thumbPath ) ) {
 646                         // Directory where file should be
 647                         // This happened occasionally due to broken migration code in 1.5
 648                         // Rename to broken-*
 649                         for ( $i = 0; $i < 100 ; $i++ ) {
 650                                 $broken = $this->repo->getZonePath( 'public' ) . "/broken-$i-$thumbName";
 651                                 if ( !file_exists( $broken ) ) {
 652                                         rename( $thumbPath, $broken );
 653                                         break;
 654                                 }
 655                         }
 656                         // Doesn't exist anymore
 657                         clearstatcache();
 658                 }
 659                 */
 660
 661                 /*
 662                 if ( $this->repo->fileExists( $thumbDir ) ) {
 663                         // Delete file where directory should be
 664                         $this->repo->cleanupBatch( array( $thumbDir ) );
 665                 }
 666                 */
 667         }
 668
 669         /** getHandler inherited */
 670         /** iconThumb inherited */
 671         /** getLastError inherited */
 672
 673         /**
 674          * Get all thumbnail names previously generated for this file
 675          * @param $archiveName string|bool Name of an archive file, default false
 676          * @return array first element is the base dir, then files in that base dir.
 677          */
 678         function getThumbnails( $archiveName = false ) {
 679                 if ( $archiveName ) {
 680                         $dir = $this->getArchiveThumbPath( $archiveName );
 681                 } else {
 682                         $dir = $this->getThumbPath();
 683                 }
 684
 685                 $backend = $this->repo->getBackend();
 686                 $files = array( $dir );
 687                 $iterator = $backend->getFileList( array( 'dir' => $dir ) );
 688                 foreach ( $iterator as $file ) {
 689                         $files[] = $file;
 690                 }
 691
 692                 return $files;
 693         }
 694
 695         /**
 696          * Refresh metadata in memcached, but don't touch thumbnails or squid
 697          */
 698         function purgeMetadataCache() {
 699                 $this->loadFromDB();
 700                 $this->saveToCache();
 701                 $this->purgeHistory();
 702         }
 703
 704         /**
 705          * Purge the shared history (OldLocalFile) cache
 706          */
 707         function purgeHistory() {
 708                 global $wgMemc;
 709
 710                 $hashedName = md5( $this->getName() );
 711                 $oldKey = $this->repo->getSharedCacheKey( 'oldfile', $hashedName );
 712
 713                 // Must purge thumbnails for old versions too! bug 30192
 714                 foreach( $this->getHistory() as $oldFile ) {
 715                         $oldFile->purgeThumbnails();
 716                 }
 717
 718                 if ( $oldKey ) {
 719                         $wgMemc->delete( $oldKey );
 720                 }
 721         }
 722
 723         /**
 724          * Delete all previously generated thumbnails, refresh metadata in memcached and purge the squid
 725          */
 726         function purgeCache( $options = array() ) {
 727                 // Refresh metadata cache
 728                 $this->purgeMetadataCache();
 729
 730                 // Delete thumbnails
 731                 $this->purgeThumbnails( $options );
 732
 733                 // Purge squid cache for this file
 734                 SquidUpdate::purge( array( $this->getURL() ) );
 735         }
 736
 737         /**
 738          * Delete cached transformed files for an archived version only.
 739          * @param $archiveName string name of the archived file
 740          */
 741         function purgeOldThumbnails( $archiveName ) {
 742                 global $wgUseSquid;
 743                 wfProfileIn( __METHOD__ );
 744
 745                 // Get a list of old thumbnails and URLs
 746                 $files = $this->getThumbnails( $archiveName );
 747                 $dir = array_shift( $files );
 748                 $this->purgeThumbList( $dir, $files );
 749
 750                 // Purge any custom thumbnail caches
 751                 wfRunHooks( 'LocalFilePurgeThumbnails', array( $this, $archiveName ) );
 752
 753                 // Purge the squid
 754                 if ( $wgUseSquid ) {
 755                         $urls = array();
 756                         foreach( $files as $file ) {
 757                                 $urls[] = $this->getArchiveThumbUrl( $archiveName, $file );
 758                         }
 759                         SquidUpdate::purge( $urls );
 760                 }
 761
 762                 wfProfileOut( __METHOD__ );
 763         }
 764
 765         /**
 766          * Delete cached transformed files for the current version only.
 767          */
 768         function purgeThumbnails( $options = array() ) {
 769                 global $wgUseSquid;
 770                 wfProfileIn( __METHOD__ );
 771
 772                 // Delete thumbnails
 773                 $files = $this->getThumbnails();
 774
 775                 // Give media handler a chance to filter the purge list
 776                 if ( !empty( $options['forThumbRefresh'] ) ) {
 777                         $handler = $this->getHandler();
 778                         if ( $handler ) {
 779                                 $handler->filterThumbnailPurgeList( $files, $options );
 780                         }
 781                 }
 782
 783                 $dir = array_shift( $files );
 784                 $this->purgeThumbList( $dir, $files );
 785
 786                 // Purge any custom thumbnail caches
 787                 wfRunHooks( 'LocalFilePurgeThumbnails', array( $this, false ) );
 788
 789                 // Purge the squid
 790                 if ( $wgUseSquid ) {
 791                         $urls = array();
 792                         foreach( $files as $file ) {
 793                                 $urls[] = $this->getThumbUrl( $file );
 794                         }
 795                         SquidUpdate::purge( $urls );
 796                 }
 797
 798                 wfProfileOut( __METHOD__ );
 799         }
 800
 801         /**
 802          * Delete a list of thumbnails visible at urls
 803          * @param $dir string base dir of the files.
 804          * @param $files array of strings: relative filenames (to $dir)
 805          */
 806         protected function purgeThumbList( $dir, $files ) {
 807                 $fileListDebug = strtr(
 808                         var_export( $files, true ),
 809                         array("\n"=>'')
 810                 );
 811                 wfDebug( __METHOD__ . ": $fileListDebug\n" );
 812
 813                 $purgeList = array();
 814                 foreach ( $files as $file ) {
 815                         # Check that the base file name is part of the thumb name
 816                         # This is a basic sanity check to avoid erasing unrelated directories
 817                         if ( strpos( $file, $this->getName() ) !== false ) {
 818                                 $purgeList[] = "{$dir}/{$file}";
 819                         }
 820                 }
 821
 822                 # Delete the thumbnails
 823                 $this->repo->quickPurgeBatch( $purgeList );
 824                 # Clear out the thumbnail directory if empty
 825                 $this->repo->quickCleanDir( $dir );
 826         }
 827
 828         /** purgeDescription inherited */
 829         /** purgeEverything inherited */
 830
 831         /**
 832          * @param $limit null
 833          * @param $start null
 834          * @param $end null
 835          * @param $inc bool
 836          * @return array
 837          */
 838         function getHistory( $limit = null, $start = null, $end = null, $inc = true ) {
 839                 $dbr = $this->repo->getSlaveDB();
 840                 $tables = array( 'oldimage' );
 841                 $fields = OldLocalFile::selectFields();
 842                 $conds = $opts = $join_conds = array();
 843                 $eq = $inc ? '=' : '';
 844                 $conds[] = "oi_name = " . $dbr->addQuotes( $this->title->getDBkey() );
 845
 846                 if ( $start ) {
 847                         $conds[] = "oi_timestamp <$eq " . $dbr->addQuotes( $dbr->timestamp( $start ) );
 848                 }
 849
 850                 if ( $end ) {
 851                         $conds[] = "oi_timestamp >$eq " . $dbr->addQuotes( $dbr->timestamp( $end ) );
 852                 }
 853
 854                 if ( $limit ) {
 855                         $opts['LIMIT'] = $limit;
 856                 }
 857
 858                 // Search backwards for time > x queries
 859                 $order = ( !$start && $end !== null ) ? 'ASC' : 'DESC';
 860                 $opts['ORDER BY'] = "oi_timestamp $order";
 861                 $opts['USE INDEX'] = array( 'oldimage' => 'oi_name_timestamp' );
 862
 863                 wfRunHooks( 'LocalFile::getHistory', array( &$this, &$tables, &$fields,
 864                         &$conds, &$opts, &$join_conds ) );
 865
 866                 $res = $dbr->select( $tables, $fields, $conds, __METHOD__, $opts, $join_conds );
 867                 $r = array();
 868
 869                 foreach ( $res as $row ) {
 870                         if ( $this->repo->oldFileFromRowFactory ) {
 871                                 $r[] = call_user_func( $this->repo->oldFileFromRowFactory, $row, $this->repo );
 872                         } else {
 873                                 $r[] = OldLocalFile::newFromRow( $row, $this->repo );
 874                         }
 875                 }
 876
 877                 if ( $order == 'ASC' ) {
 878                         $r = array_reverse( $r ); // make sure it ends up descending
 879                 }
 880
 881                 return $r;
 882         }
 883
 884         /**
 885          * Return the history of this file, line by line.
 886          * starts with current version, then old versions.
 887          * uses $this->historyLine to check which line to return:
 888          *  0      return line for current version
 889          *  1      query for old versions, return first one
 890          *  2, ... return next old version from above query
 891          * @return bool
 892          */
 893         public function nextHistoryLine() {
 894                 # Polymorphic function name to distinguish foreign and local fetches
 895                 $fname = get_class( $this ) . '::' . __FUNCTION__;
 896
 897                 $dbr = $this->repo->getSlaveDB();
 898
 899                 if ( $this->historyLine == 0 ) {// called for the first time, return line from cur
 900                         $this->historyRes = $dbr->select( 'image',
 901                                 array(
 902                                         '*',
 903                                         "'' AS oi_archive_name",
 904                                         '0 as oi_deleted',
 905                                         'img_sha1'
 906                                 ),
 907                                 array( 'img_name' => $this->title->getDBkey() ),
 908                                 $fname
 909                         );
 910
 911                         if ( 0 == $dbr->numRows( $this->historyRes ) ) {
 912                                 $this->historyRes = null;
 913                                 return false;
 914                         }
 915                 } elseif ( $this->historyLine == 1 ) {
 916                         $this->historyRes = $dbr->select( 'oldimage', '*',
 917                                 array( 'oi_name' => $this->title->getDBkey() ),
 918                                 $fname,
 919                                 array( 'ORDER BY' => 'oi_timestamp DESC' )
 920                         );
 921                 }
 922                 $this->historyLine ++;
 923
 924                 return $dbr->fetchObject( $this->historyRes );
 925         }
 926
 927         /**
 928          * Reset the history pointer to the first element of the history
 929          */
 930         public function resetHistory() {
 931                 $this->historyLine = 0;
 932
 933                 if ( !is_null( $this->historyRes ) ) {
 934                         $this->historyRes = null;
 935                 }
 936         }
 937
 938         /** getHashPath inherited */
 939         /** getRel inherited */
 940         /** getUrlRel inherited */
 941         /** getArchiveRel inherited */
 942         /** getArchivePath inherited */
 943         /** getThumbPath inherited */
 944         /** getArchiveUrl inherited */
 945         /** getThumbUrl inherited */
 946         /** getArchiveVirtualUrl inherited */
 947         /** getThumbVirtualUrl inherited */
 948         /** isHashed inherited */
 949
 950         /**
 951          * Upload a file and record it in the DB
 952          * @param $srcPath String: source storage path or virtual URL
 953          * @param $comment String: upload description
 954          * @param $pageText String: text to use for the new description page,
 955          *                  if a new description page is created
 956          * @param $flags Integer|bool: flags for publish()
 957          * @param $props Array|bool: File properties, if known. This can be used to reduce the
 958          *               upload time when uploading virtual URLs for which the file info
 959          *               is already known
 960          * @param $timestamp String|bool: timestamp for img_timestamp, or false to use the current time
 961          * @param $user User|null: User object or null to use $wgUser
 962          *
 963          * @return FileRepoStatus object. On success, the value member contains the
 964          *     archive name, or an empty string if it was a new file.
 965          */
 966         function upload( $srcPath, $comment, $pageText, $flags = 0, $props = false, $timestamp = false, $user = null ) {
 967                 global $wgContLang;
 968
 969                 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
 970                         return $this->readOnlyFatalStatus();
 971                 }
 972
 973                 // truncate nicely or the DB will do it for us
 974                 // non-nicely (dangling multi-byte chars, non-truncated version in cache).
 975                 $comment = $wgContLang->truncate( $comment, 255 );
 976                 $this->lock(); // begin
 977                 $status = $this->publish( $srcPath, $flags );
 978
 979                 if ( $status->successCount > 0 ) {
 980                         # Essentially we are displacing any existing current file and saving
 981                         # a new current file at the old location. If just the first succeeded,
 982                         # we still need to displace the current DB entry and put in a new one.
 983                         if ( !$this->recordUpload2( $status->value, $comment, $pageText, $props, $timestamp, $user ) ) {
 984                                 $status->fatal( 'filenotfound', $srcPath );
 985                         }
 986                 }
 987
 988                 $this->unlock(); // done
 989
 990                 return $status;
 991         }
 992
 993         /**
 994          * Record a file upload in the upload log and the image table
 995          * @param $oldver
 996          * @param $desc string
 997          * @param $license string
 998          * @param $copyStatus string
 999          * @param $source string
1000          * @param $watch bool
1001          * @param $timestamp string|bool
1002          * @return bool
1003          */
1004         function recordUpload( $oldver, $desc, $license = '', $copyStatus = '', $source = '',
1005                 $watch = false, $timestamp = false )
1006         {
1007                 $pageText = SpecialUpload::getInitialPageText( $desc, $license, $copyStatus, $source );
1008
1009                 if ( !$this->recordUpload2( $oldver, $desc, $pageText, false, $timestamp ) ) {
1010                         return false;
1011                 }
1012
1013                 if ( $watch ) {
1014                         global $wgUser;
1015                         $wgUser->addWatch( $this->getTitle() );
1016                 }
1017                 return true;
1018         }
1019
1020         /**
1021          * Record a file upload in the upload log and the image table
1022          * @param $oldver
1023          * @param $comment string
1024          * @param $pageText string
1025          * @param $props bool|array
1026          * @param $timestamp bool|string
1027          * @param $user null|User
1028          * @return bool
1029          */
1030         function recordUpload2(
1031                 $oldver, $comment, $pageText, $props = false, $timestamp = false, $user = null
1032         ) {
1033                 wfProfileIn( __METHOD__ );
1034
1035                 if ( is_null( $user ) ) {
1036                         global $wgUser;
1037                         $user = $wgUser;
1038                 }
1039
1040                 $dbw = $this->repo->getMasterDB();
1041                 $dbw->begin( __METHOD__ );
1042
1043                 if ( !$props ) {
1044                         wfProfileIn( __METHOD__ . '-getProps' );
1045                         $props = $this->repo->getFileProps( $this->getVirtualUrl() );
1046                         wfProfileOut( __METHOD__ . '-getProps' );
1047                 }
1048
1049                 if ( $timestamp === false ) {
1050                         $timestamp = $dbw->timestamp();
1051                 }
1052
1053                 $props['description'] = $comment;
1054                 $props['user'] = $user->getId();
1055                 $props['user_text'] = $user->getName();
1056                 $props['timestamp'] = wfTimestamp( TS_MW, $timestamp ); // DB -> TS_MW
1057                 $this->setProps( $props );
1058
1059                 # Fail now if the file isn't there
1060                 if ( !$this->fileExists ) {
1061                         wfDebug( __METHOD__ . ": File " . $this->getRel() . " went missing!\n" );
1062                         wfProfileOut( __METHOD__ );
1063                         return false;
1064                 }
1065
1066                 $reupload = false;
1067
1068                 # Test to see if the row exists using INSERT IGNORE
1069                 # This avoids race conditions by locking the row until the commit, and also
1070                 # doesn't deadlock. SELECT FOR UPDATE causes a deadlock for every race condition.
1071                 $dbw->insert( 'image',
1072                         array(
1073                                 'img_name'        => $this->getName(),
1074                                 'img_size'        => $this->size,
1075                                 'img_width'       => intval( $this->width ),
1076                                 'img_height'      => intval( $this->height ),
1077                                 'img_bits'        => $this->bits,
1078                                 'img_media_type'  => $this->media_type,
1079                                 'img_major_mime'  => $this->major_mime,
1080                                 'img_minor_mime'  => $this->minor_mime,
1081                                 'img_timestamp'   => $timestamp,
1082                                 'img_description' => $comment,
1083                                 'img_user'        => $user->getId(),
1084                                 'img_user_text'   => $user->getName(),
1085                                 'img_metadata'    => $this->metadata,
1086                                 'img_sha1'        => $this->sha1
1087                         ),
1088                         __METHOD__,
1089                         'IGNORE'
1090                 );
1091                 if ( $dbw->affectedRows() == 0 ) {
1092                         # (bug 34993) Note: $oldver can be empty here, if the previous
1093                         # version of the file was broken. Allow registration of the new
1094                         # version to continue anyway, because that's better than having
1095                         # an image that's not fixable by user operations.
1096
1097                         $reupload = true;
1098                         # Collision, this is an update of a file
1099                         # Insert previous contents into oldimage
1100                         $dbw->insertSelect( 'oldimage', 'image',
1101                                 array(
1102                                         'oi_name'         => 'img_name',
1103                                         'oi_archive_name' => $dbw->addQuotes( $oldver ),
1104                                         'oi_size'         => 'img_size',
1105                                         'oi_width'        => 'img_width',
1106                                         'oi_height'       => 'img_height',
1107                                         'oi_bits'         => 'img_bits',
1108                                         'oi_timestamp'    => 'img_timestamp',
1109                                         'oi_description'  => 'img_description',
1110                                         'oi_user'         => 'img_user',
1111                                         'oi_user_text'    => 'img_user_text',
1112                                         'oi_metadata'     => 'img_metadata',
1113                                         'oi_media_type'   => 'img_media_type',
1114                                         'oi_major_mime'   => 'img_major_mime',
1115                                         'oi_minor_mime'   => 'img_minor_mime',
1116                                         'oi_sha1'         => 'img_sha1'
1117                                 ),
1118                                 array( 'img_name' => $this->getName() ),
1119                                 __METHOD__
1120                         );
1121
1122                         # Update the current image row
1123                         $dbw->update( 'image',
1124                                 array( /* SET */
1125                                         'img_size'        => $this->size,
1126                                         'img_width'       => intval( $this->width ),
1127                                         'img_height'      => intval( $this->height ),
1128                                         'img_bits'        => $this->bits,
1129                                         'img_media_type'  => $this->media_type,
1130                                         'img_major_mime'  => $this->major_mime,
1131                                         'img_minor_mime'  => $this->minor_mime,
1132                                         'img_timestamp'   => $timestamp,
1133                                         'img_description' => $comment,
1134                                         'img_user'        => $user->getId(),
1135                                         'img_user_text'   => $user->getName(),
1136                                         'img_metadata'    => $this->metadata,
1137                                         'img_sha1'        => $this->sha1
1138                                 ),
1139                                 array( 'img_name' => $this->getName() ),
1140                                 __METHOD__
1141                         );
1142                 } else {
1143                         # This is a new file, so update the image count
1144                         DeferredUpdates::addUpdate( SiteStatsUpdate::factory( array( 'images' => 1 ) ) );
1145                 }
1146
1147                 $descTitle = $this->getTitle();
1148                 $wikiPage = new WikiFilePage( $descTitle );
1149                 $wikiPage->setFile( $this );
1150
1151                 # Add the log entry
1152                 $log = new LogPage( 'upload' );
1153                 $action = $reupload ? 'overwrite' : 'upload';
1154                 $logId = $log->addEntry( $action, $descTitle, $comment, array(), $user );
1155
1156                 wfProfileIn( __METHOD__ . '-edit' );
1157                 $exists = $descTitle->exists();
1158
1159                 if ( $exists ) {
1160                         # Create a null revision
1161                         $latest = $descTitle->getLatestRevID();
1162                         $nullRevision = Revision::newNullRevision(
1163                                 $dbw,
1164                                 $descTitle->getArticleID(),
1165                                 $log->getRcComment(),
1166                                 false
1167                         );
1168                         if (!is_null($nullRevision)) {
1169                                 $nullRevision->insertOn( $dbw );
1170
1171                                 wfRunHooks( 'NewRevisionFromEditComplete', array( $wikiPage, $nullRevision, $latest, $user ) );
1172                                 $wikiPage->updateRevisionOn( $dbw, $nullRevision );
1173                         }
1174                 }
1175
1176                 # Commit the transaction now, in case something goes wrong later
1177                 # The most important thing is that files don't get lost, especially archives
1178                 # NOTE: once we have support for nested transactions, the commit may be moved
1179                 #       to after $wikiPage->doEdit has been called.
1180                 $dbw->commit( __METHOD__ );
1181
1182                 if ( $exists ) {
1183                         # Invalidate the cache for the description page
1184                         $descTitle->invalidateCache();
1185                         $descTitle->purgeSquid();
1186                 } else {
1187                         # New file; create the description page.
1188                         # There's already a log entry, so don't make a second RC entry
1189                         # Squid and file cache for the description page are purged by doEditContent.
1190                         $content = ContentHandler::makeContent( $pageText, $descTitle );
1191                         $status = $wikiPage->doEditContent( $content, $comment, EDIT_NEW | EDIT_SUPPRESS_RC, false, $user );
1192
1193                         if ( isset( $status->value['revision'] ) ) { // XXX; doEdit() uses a transaction
1194                                 $dbw->begin();
1195                                 $dbw->update( 'logging',
1196                                         array( 'log_page' => $status->value['revision']->getPage() ),
1197                                         array( 'log_id' => $logId ),
1198                                         __METHOD__
1199                                 );
1200                                 $dbw->commit(); // commit before anything bad can happen
1201                         }
1202                 }
1203                 wfProfileOut( __METHOD__ . '-edit' );
1204
1205                 # Save to cache and purge the squid
1206                 # We shall not saveToCache before the commit since otherwise
1207                 # in case of a rollback there is an usable file from memcached
1208                 # which in fact doesn't really exist (bug 24978)
1209                 $this->saveToCache();
1210
1211                 if ( $reupload ) {
1212                         # Delete old thumbnails
1213                         wfProfileIn( __METHOD__ . '-purge' );
1214                         $this->purgeThumbnails();
1215                         wfProfileOut( __METHOD__ . '-purge' );
1216
1217                         # Remove the old file from the squid cache
1218                         SquidUpdate::purge( array( $this->getURL() ) );
1219                 }
1220
1221                 # Hooks, hooks, the magic of hooks...
1222                 wfProfileIn( __METHOD__ . '-hooks' );
1223                 wfRunHooks( 'FileUpload', array( $this, $reupload, $descTitle->exists() ) );
1224                 wfProfileOut( __METHOD__ . '-hooks' );
1225
1226                 # Invalidate cache for all pages using this file
1227                 $update = new HTMLCacheUpdate( $this->getTitle(), 'imagelinks' );
1228                 $update->doUpdate();
1229
1230                 # Invalidate cache for all pages that redirects on this page
1231                 $redirs = $this->getTitle()->getRedirectsHere();
1232
1233                 foreach ( $redirs as $redir ) {
1234                         $update = new HTMLCacheUpdate( $redir, 'imagelinks' );
1235                         $update->doUpdate();
1236                 }
1237
1238                 wfProfileOut( __METHOD__ );
1239                 return true;
1240         }
1241
1242         /**
1243          * Move or copy a file to its public location. If a file exists at the
1244          * destination, move it to an archive. Returns a FileRepoStatus object with
1245          * the archive name in the "value" member on success.
1246          *
1247          * The archive name should be passed through to recordUpload for database
1248          * registration.
1249          *
1250          * @param $srcPath String: local filesystem path to the source image
1251          * @param $flags Integer: a bitwise combination of:
1252          *     File::DELETE_SOURCE      Delete the source file, i.e. move rather than copy
1253          * @return FileRepoStatus object. On success, the value member contains the
1254          *     archive name, or an empty string if it was a new file.
1255          */
1256         function publish( $srcPath, $flags = 0 ) {
1257                 return $this->publishTo( $srcPath, $this->getRel(), $flags );
1258         }
1259
1260         /**
1261          * Move or copy a file to a specified location. Returns a FileRepoStatus
1262          * object with the archive name in the "value" member on success.
1263          *
1264          * The archive name should be passed through to recordUpload for database
1265          * registration.
1266          *
1267          * @param $srcPath String: local filesystem path to the source image
1268          * @param $dstRel String: target relative path
1269          * @param $flags Integer: a bitwise combination of:
1270          *     File::DELETE_SOURCE      Delete the source file, i.e. move rather than copy
1271          * @return FileRepoStatus object. On success, the value member contains the
1272          *     archive name, or an empty string if it was a new file.
1273          */
1274         function publishTo( $srcPath, $dstRel, $flags = 0 ) {
1275                 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
1276                         return $this->readOnlyFatalStatus();
1277                 }
1278
1279                 $this->lock(); // begin
1280
1281                 $archiveName = wfTimestamp( TS_MW ) . '!'. $this->getName();
1282                 $archiveRel = 'archive/' . $this->getHashPath() . $archiveName;
1283                 $flags = $flags & File::DELETE_SOURCE ? LocalRepo::DELETE_SOURCE : 0;
1284                 $status = $this->repo->publish( $srcPath, $dstRel, $archiveRel, $flags );
1285
1286                 if ( $status->value == 'new' ) {
1287                         $status->value = '';
1288                 } else {
1289                         $status->value = $archiveName;
1290                 }
1291
1292                 $this->unlock(); // done
1293
1294                 return $status;
1295         }
1296
1297         /** getLinksTo inherited */
1298         /** getExifData inherited */
1299         /** isLocal inherited */
1300         /** wasDeleted inherited */
1301
1302         /**
1303          * Move file to the new title
1304          *
1305          * Move current, old version and all thumbnails
1306          * to the new filename. Old file is deleted.
1307          *
1308          * Cache purging is done; checks for validity
1309          * and logging are caller's responsibility
1310          *
1311          * @param $target Title New file name
1312          * @return FileRepoStatus object.
1313          */
1314         function move( $target ) {
1315                 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
1316                         return $this->readOnlyFatalStatus();
1317                 }
1318
1319                 wfDebugLog( 'imagemove', "Got request to move {$this->name} to " . $target->getText() );
1320                 $batch = new LocalFileMoveBatch( $this, $target );
1321
1322                 $this->lock(); // begin
1323                 $batch->addCurrent();
1324                 $archiveNames = $batch->addOlds();
1325                 $status = $batch->execute();
1326                 $this->unlock(); // done
1327
1328                 wfDebugLog( 'imagemove', "Finished moving {$this->name}" );
1329
1330                 $this->purgeEverything();
1331                 foreach ( $archiveNames as $archiveName ) {
1332                         $this->purgeOldThumbnails( $archiveName );
1333                 }
1334                 if ( $status->isOK() ) {
1335                         // Now switch the object
1336                         $this->title = $target;
1337                         // Force regeneration of the name and hashpath
1338                         unset( $this->name );
1339                         unset( $this->hashPath );
1340                         // Purge the new image
1341                         $this->purgeEverything();
1342                 }
1343
1344                 return $status;
1345         }
1346
1347         /**
1348          * Delete all versions of the file.
1349          *
1350          * Moves the files into an archive directory (or deletes them)
1351          * and removes the database rows.
1352          *
1353          * Cache purging is done; logging is caller's responsibility.
1354          *
1355          * @param $reason
1356          * @param $suppress
1357          * @return FileRepoStatus object.
1358          */
1359         function delete( $reason, $suppress = false ) {
1360                 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
1361                         return $this->readOnlyFatalStatus();
1362                 }
1363
1364                 $batch = new LocalFileDeleteBatch( $this, $reason, $suppress );
1365
1366                 $this->lock(); // begin
1367                 $batch->addCurrent();
1368                 # Get old version relative paths
1369                 $archiveNames = $batch->addOlds();
1370                 $status = $batch->execute();
1371                 $this->unlock(); // done
1372
1373                 if ( $status->isOK() ) {
1374                         DeferredUpdates::addUpdate( SiteStatsUpdate::factory( array( 'images' => -1 ) ) );
1375                 }
1376
1377                 $this->purgeEverything();
1378                 foreach ( $archiveNames as $archiveName ) {
1379                         $this->purgeOldThumbnails( $archiveName );
1380                 }
1381
1382                 return $status;
1383         }
1384
1385         /**
1386          * Delete an old version of the file.
1387          *
1388          * Moves the file into an archive directory (or deletes it)
1389          * and removes the database row.
1390          *
1391          * Cache purging is done; logging is caller's responsibility.
1392          *
1393          * @param $archiveName String
1394          * @param $reason String
1395          * @param $suppress Boolean
1396          * @throws MWException or FSException on database or file store failure
1397          * @return FileRepoStatus object.
1398          */
1399         function deleteOld( $archiveName, $reason, $suppress = false ) {
1400                 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
1401                         return $this->readOnlyFatalStatus();
1402                 }
1403
1404                 $batch = new LocalFileDeleteBatch( $this, $reason, $suppress );
1405
1406                 $this->lock(); // begin
1407                 $batch->addOld( $archiveName );
1408                 $status = $batch->execute();
1409                 $this->unlock(); // done
1410
1411                 $this->purgeOldThumbnails( $archiveName );
1412                 if ( $status->isOK() ) {
1413                         $this->purgeDescription();
1414                         $this->purgeHistory();
1415                 }
1416
1417                 return $status;
1418         }
1419
1420         /**
1421          * Restore all or specified deleted revisions to the given file.
1422          * Permissions and logging are left to the caller.
1423          *
1424          * May throw database exceptions on error.
1425          *
1426          * @param $versions array set of record ids of deleted items to restore,
1427          *                    or empty to restore all revisions.
1428          * @param $unsuppress Boolean
1429          * @return FileRepoStatus
1430          */
1431         function restore( $versions = array(), $unsuppress = false ) {
1432                 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
1433                         return $this->readOnlyFatalStatus();
1434                 }
1435
1436                 $batch = new LocalFileRestoreBatch( $this, $unsuppress );
1437
1438                 $this->lock(); // begin
1439                 if ( !$versions ) {
1440                         $batch->addAll();
1441                 } else {
1442                         $batch->addIds( $versions );
1443                 }
1444                 $status = $batch->execute();
1445                 if ( $status->isGood() ) {
1446                         $cleanupStatus = $batch->cleanup();
1447                         $cleanupStatus->successCount = 0;
1448                         $cleanupStatus->failCount = 0;
1449                         $status->merge( $cleanupStatus );
1450                 }
1451                 $this->unlock(); // done
1452
1453                 return $status;
1454         }
1455
1456         /** isMultipage inherited */
1457         /** pageCount inherited */
1458         /** scaleHeight inherited */
1459         /** getImageSize inherited */
1460
1461         /**
1462          * Get the URL of the file description page.
1463          * @return String
1464          */
1465         function getDescriptionUrl() {
1466                 return $this->title->getLocalUrl();
1467         }
1468
1469         /**
1470          * Get the HTML text of the description page
1471          * This is not used by ImagePage for local files, since (among other things)
1472          * it skips the parser cache.
1473          * @return bool|mixed
1474          */
1475         function getDescriptionText() {
1476                 global $wgParser;
1477                 $revision = Revision::newFromTitle( $this->title, false, Revision::READ_NORMAL );
1478                 if ( !$revision ) return false;
1479                 $content = $revision->getContent();
1480                 if ( !$content ) return false;
1481                 $pout = $content->getParserOutput( $this->title, null, new ParserOptions() );
1482                 return $pout->getText();
1483         }
1484
1485         /**
1486          * @return string
1487          */
1488         function getDescription( $audience = self::FOR_PUBLIC, User $user = null ) {
1489                 $this->load();
1490                 if ( $audience == self::FOR_PUBLIC && $this->isDeleted( self::DELETED_COMMENT ) ) {
1491                         return '';
1492                 } elseif ( $audience == self::FOR_THIS_USER
1493                         && !$this->userCan( self::DELETED_COMMENT, $user ) )
1494                 {
1495                         return '';
1496                 } else {
1497                         return $this->description;
1498                 }
1499         }
1500
1501         /**
1502          * @return bool|string
1503          */
1504         function getTimestamp() {
1505                 $this->load();
1506                 return $this->timestamp;
1507         }
1508
1509         /**
1510          * @return string
1511          */
1512         function getSha1() {
1513                 $this->load();
1514                 // Initialise now if necessary
1515                 if ( $this->sha1 == '' && $this->fileExists ) {
1516                         $this->lock(); // begin
1517
1518                         $this->sha1 = $this->repo->getFileSha1( $this->getPath() );
1519                         if ( !wfReadOnly() && strval( $this->sha1 ) != '' ) {
1520                                 $dbw = $this->repo->getMasterDB();
1521                                 $dbw->update( 'image',
1522                                         array( 'img_sha1' => $this->sha1 ),
1523                                         array( 'img_name' => $this->getName() ),
1524                                         __METHOD__ );
1525                                 $this->saveToCache();
1526                         }
1527
1528                         $this->unlock(); // done
1529                 }
1530
1531                 return $this->sha1;
1532         }
1533
1534         /**
1535          * @return bool
1536          */
1537         function isCacheable() {
1538                 $this->load();
1539                 return strlen( $this->metadata ) <= self::CACHE_FIELD_MAX_LEN; // avoid OOMs
1540         }
1541
1542         /**
1543          * Start a transaction and lock the image for update
1544          * Increments a reference counter if the lock is already held
1545          * @return boolean True if the image exists, false otherwise
1546          */
1547         function lock() {
1548                 $dbw = $this->repo->getMasterDB();
1549
1550                 if ( !$this->locked ) {
1551                         $dbw->begin( __METHOD__ );
1552                         $this->locked++;
1553                 }
1554
1555                 return $dbw->selectField( 'image', '1',
1556                         array( 'img_name' => $this->getName() ), __METHOD__, array( 'FOR UPDATE' ) );
1557         }
1558
1559         /**
1560          * Decrement the lock reference count. If the reference count is reduced to zero, commits
1561          * the transaction and thereby releases the image lock.
1562          */
1563         function unlock() {
1564                 if ( $this->locked ) {
1565                         --$this->locked;
1566                         if ( !$this->locked ) {
1567                                 $dbw = $this->repo->getMasterDB();
1568                                 $dbw->commit( __METHOD__ );
1569                         }
1570                 }
1571         }
1572
1573         /**
1574          * Roll back the DB transaction and mark the image unlocked
1575          */
1576         function unlockAndRollback() {
1577                 $this->locked = false;
1578                 $dbw = $this->repo->getMasterDB();
1579                 $dbw->rollback( __METHOD__ );
1580         }
1581
1582         /**
1583          * @return Status
1584          */
1585         protected function readOnlyFatalStatus() {
1586                 return $this->getRepo()->newFatal( 'filereadonlyerror', $this->getName(),
1587                         $this->getRepo()->getName(), $this->getRepo()->getReadOnlyReason() );
1588         }
1589 } // LocalFile class
1590
1591 # ------------------------------------------------------------------------------
1592
1593 /**
1594  * Helper class for file deletion
1595  * @ingroup FileAbstraction
1596  */
1597 class LocalFileDeleteBatch {
1598
1599         /**
1600          * @var LocalFile
1601          */
1602         var $file;
1603
1604         var $reason, $srcRels = array(), $archiveUrls = array(), $deletionBatch, $suppress;
1605         var $status;
1606
1607         /**
1608          * @param $file File
1609          * @param $reason string
1610          * @param $suppress bool
1611          */
1612         function __construct( File $file, $reason = '', $suppress = false ) {
1613                 $this->file = $file;
1614                 $this->reason = $reason;
1615                 $this->suppress = $suppress;
1616                 $this->status = $file->repo->newGood();
1617         }
1618
1619         function addCurrent() {
1620                 $this->srcRels['.'] = $this->file->getRel();
1621         }
1622
1623         /**
1624          * @param $oldName string
1625          */
1626         function addOld( $oldName ) {
1627                 $this->srcRels[$oldName] = $this->file->getArchiveRel( $oldName );
1628                 $this->archiveUrls[] = $this->file->getArchiveUrl( $oldName );
1629         }
1630
1631         /**
1632          * Add the old versions of the image to the batch
1633          * @return Array List of archive names from old versions
1634          */
1635         function addOlds() {
1636                 $archiveNames = array();
1637
1638                 $dbw = $this->file->repo->getMasterDB();
1639                 $result = $dbw->select( 'oldimage',
1640                         array( 'oi_archive_name' ),
1641                         array( 'oi_name' => $this->file->getName() ),
1642                         __METHOD__
1643                 );
1644
1645                 foreach ( $result as $row ) {
1646                         $this->addOld( $row->oi_archive_name );
1647                         $archiveNames[] = $row->oi_archive_name;
1648                 }
1649
1650                 return $archiveNames;
1651         }
1652
1653         /**
1654          * @return array
1655          */
1656         function getOldRels() {
1657                 if ( !isset( $this->srcRels['.'] ) ) {
1658                         $oldRels =& $this->srcRels;
1659                         $deleteCurrent = false;
1660                 } else {
1661                         $oldRels = $this->srcRels;
1662                         unset( $oldRels['.'] );
1663                         $deleteCurrent = true;
1664                 }
1665
1666                 return array( $oldRels, $deleteCurrent );
1667         }
1668
1669         /**
1670          * @return array
1671          */
1672         protected function getHashes() {
1673                 $hashes = array();
1674                 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
1675
1676                 if ( $deleteCurrent ) {
1677                         $hashes['.'] = $this->file->getSha1();
1678                 }
1679
1680                 if ( count( $oldRels ) ) {
1681                         $dbw = $this->file->repo->getMasterDB();
1682                         $res = $dbw->select(
1683                                 'oldimage',
1684                                 array( 'oi_archive_name', 'oi_sha1' ),
1685                                 'oi_archive_name IN (' . $dbw->makeList( array_keys( $oldRels ) ) . ')',
1686                                 __METHOD__
1687                         );
1688
1689                         foreach ( $res as $row ) {
1690                                 if ( rtrim( $row->oi_sha1, "\0" ) === '' ) {
1691                                         // Get the hash from the file
1692                                         $oldUrl = $this->file->getArchiveVirtualUrl( $row->oi_archive_name );
1693                                         $props = $this->file->repo->getFileProps( $oldUrl );
1694
1695                                         if ( $props['fileExists'] ) {
1696                                                 // Upgrade the oldimage row
1697                                                 $dbw->update( 'oldimage',
1698                                                         array( 'oi_sha1' => $props['sha1'] ),
1699                                                         array( 'oi_name' => $this->file->getName(), 'oi_archive_name' => $row->oi_archive_name ),
1700                                                         __METHOD__ );
1701                                                 $hashes[$row->oi_archive_name] = $props['sha1'];
1702                                         } else {
1703                                                 $hashes[$row->oi_archive_name] = false;
1704                                         }
1705                                 } else {
1706                                         $hashes[$row->oi_archive_name] = $row->oi_sha1;
1707                                 }
1708                         }
1709                 }
1710
1711                 $missing = array_diff_key( $this->srcRels, $hashes );
1712
1713                 foreach ( $missing as $name => $rel ) {
1714                         $this->status->error( 'filedelete-old-unregistered', $name );
1715                 }
1716
1717                 foreach ( $hashes as $name => $hash ) {
1718                         if ( !$hash ) {
1719                                 $this->status->error( 'filedelete-missing', $this->srcRels[$name] );
1720                                 unset( $hashes[$name] );
1721                         }
1722                 }
1723
1724                 return $hashes;
1725         }
1726
1727         function doDBInserts() {
1728                 global $wgUser;
1729
1730                 $dbw = $this->file->repo->getMasterDB();
1731                 $encTimestamp = $dbw->addQuotes( $dbw->timestamp() );
1732                 $encUserId = $dbw->addQuotes( $wgUser->getId() );
1733                 $encReason = $dbw->addQuotes( $this->reason );
1734                 $encGroup = $dbw->addQuotes( 'deleted' );
1735                 $ext = $this->file->getExtension();
1736                 $dotExt = $ext === '' ? '' : ".$ext";
1737                 $encExt = $dbw->addQuotes( $dotExt );
1738                 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
1739
1740                 // Bitfields to further suppress the content
1741                 if ( $this->suppress ) {
1742                         $bitfield = 0;
1743                         // This should be 15...
1744                         $bitfield |= Revision::DELETED_TEXT;
1745                         $bitfield |= Revision::DELETED_COMMENT;
1746                         $bitfield |= Revision::DELETED_USER;
1747                         $bitfield |= Revision::DELETED_RESTRICTED;
1748                 } else {
1749                         $bitfield = 'oi_deleted';
1750                 }
1751
1752                 if ( $deleteCurrent ) {
1753                         $concat = $dbw->buildConcat( array( "img_sha1", $encExt ) );
1754                         $where = array( 'img_name' => $this->file->getName() );
1755                         $dbw->insertSelect( 'filearchive', 'image',
1756                                 array(
1757                                         'fa_storage_group' => $encGroup,
1758                                         'fa_storage_key'   => "CASE WHEN img_sha1='' THEN '' ELSE $concat END",
1759                                         'fa_deleted_user'      => $encUserId,
1760                                         'fa_deleted_timestamp' => $encTimestamp,
1761                                         'fa_deleted_reason'    => $encReason,
1762                                         'fa_deleted'               => $this->suppress ? $bitfield : 0,
1763
1764                                         'fa_name'         => 'img_name',
1765                                         'fa_archive_name' => 'NULL',
1766                                         'fa_size'         => 'img_size',
1767                                         'fa_width'        => 'img_width',
1768                                         'fa_height'       => 'img_height',
1769                                         'fa_metadata'     => 'img_metadata',
1770                                         'fa_bits'         => 'img_bits',
1771                                         'fa_media_type'   => 'img_media_type',
1772                                         'fa_major_mime'   => 'img_major_mime',
1773                                         'fa_minor_mime'   => 'img_minor_mime',
1774                                         'fa_description'  => 'img_description',
1775                                         'fa_user'         => 'img_user',
1776                                         'fa_user_text'    => 'img_user_text',
1777                                         'fa_timestamp'    => 'img_timestamp'
1778                                 ), $where, __METHOD__ );
1779                 }
1780
1781                 if ( count( $oldRels ) ) {
1782                         $concat = $dbw->buildConcat( array( "oi_sha1", $encExt ) );
1783                         $where = array(
1784                                 'oi_name' => $this->file->getName(),
1785                                 'oi_archive_name IN (' . $dbw->makeList( array_keys( $oldRels ) ) . ')' );
1786                         $dbw->insertSelect( 'filearchive', 'oldimage',
1787                                 array(
1788                                         'fa_storage_group' => $encGroup,
1789                                         'fa_storage_key'   => "CASE WHEN oi_sha1='' THEN '' ELSE $concat END",
1790                                         'fa_deleted_user'      => $encUserId,
1791                                         'fa_deleted_timestamp' => $encTimestamp,
1792                                         'fa_deleted_reason'    => $encReason,
1793                                         'fa_deleted'           => $this->suppress ? $bitfield : 'oi_deleted',
1794
1795                                         'fa_name'         => 'oi_name',
1796                                         'fa_archive_name' => 'oi_archive_name',
1797                                         'fa_size'         => 'oi_size',
1798                                         'fa_width'        => 'oi_width',
1799                                         'fa_height'       => 'oi_height',
1800                                         'fa_metadata'     => 'oi_metadata',
1801                                         'fa_bits'         => 'oi_bits',
1802                                         'fa_media_type'   => 'oi_media_type',
1803                                         'fa_major_mime'   => 'oi_major_mime',
1804                                         'fa_minor_mime'   => 'oi_minor_mime',
1805                                         'fa_description'  => 'oi_description',
1806                                         'fa_user'         => 'oi_user',
1807                                         'fa_user_text'    => 'oi_user_text',
1808                                         'fa_timestamp'    => 'oi_timestamp',
1809                                 ), $where, __METHOD__ );
1810                 }
1811         }
1812
1813         function doDBDeletes() {
1814                 $dbw = $this->file->repo->getMasterDB();
1815                 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
1816
1817                 if ( count( $oldRels ) ) {
1818                         $dbw->delete( 'oldimage',
1819                                 array(
1820                                         'oi_name' => $this->file->getName(),
1821                                         'oi_archive_name' => array_keys( $oldRels )
1822                                 ), __METHOD__ );
1823                 }
1824
1825                 if ( $deleteCurrent ) {
1826                         $dbw->delete( 'image', array( 'img_name' => $this->file->getName() ), __METHOD__ );
1827                 }
1828         }
1829
1830         /**
1831          * Run the transaction
1832          * @return FileRepoStatus
1833          */
1834         function execute() {
1835                 wfProfileIn( __METHOD__ );
1836
1837                 $this->file->lock();
1838                 // Leave private files alone
1839                 $privateFiles = array();
1840                 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
1841                 $dbw = $this->file->repo->getMasterDB();
1842
1843                 if ( !empty( $oldRels ) ) {
1844                         $res = $dbw->select( 'oldimage',
1845                                 array( 'oi_archive_name' ),
1846                                 array( 'oi_name' => $this->file->getName(),
1847                                         'oi_archive_name IN (' . $dbw->makeList( array_keys( $oldRels ) ) . ')',
1848                                         $dbw->bitAnd( 'oi_deleted', File::DELETED_FILE ) => File::DELETED_FILE ),
1849                                 __METHOD__ );
1850
1851                         foreach ( $res as $row ) {
1852                                 $privateFiles[$row->oi_archive_name] = 1;
1853                         }
1854                 }
1855                 // Prepare deletion batch
1856                 $hashes = $this->getHashes();
1857                 $this->deletionBatch = array();
1858                 $ext = $this->file->getExtension();
1859                 $dotExt = $ext === '' ? '' : ".$ext";
1860
1861                 foreach ( $this->srcRels as $name => $srcRel ) {
1862                         // Skip files that have no hash (missing source).
1863                         // Keep private files where they are.
1864                         if ( isset( $hashes[$name] ) && !array_key_exists( $name, $privateFiles ) ) {
1865                                 $hash = $hashes[$name];
1866                                 $key = $hash . $dotExt;
1867                                 $dstRel = $this->file->repo->getDeletedHashPath( $key ) . $key;
1868                                 $this->deletionBatch[$name] = array( $srcRel, $dstRel );
1869                         }
1870                 }
1871
1872                 // Lock the filearchive rows so that the files don't get deleted by a cleanup operation
1873                 // We acquire this lock by running the inserts now, before the file operations.
1874                 //
1875                 // This potentially has poor lock contention characteristics -- an alternative
1876                 // scheme would be to insert stub filearchive entries with no fa_name and commit
1877                 // them in a separate transaction, then run the file ops, then update the fa_name fields.
1878                 $this->doDBInserts();
1879
1880                 // Removes non-existent file from the batch, so we don't get errors.
1881                 $this->deletionBatch = $this->removeNonexistentFiles( $this->deletionBatch );
1882
1883                 // Execute the file deletion batch
1884                 $status = $this->file->repo->deleteBatch( $this->deletionBatch );
1885
1886                 if ( !$status->isGood() ) {
1887                         $this->status->merge( $status );
1888                 }
1889
1890                 if ( !$this->status->isOK() ) {
1891                         // Critical file deletion error
1892                         // Roll back inserts, release lock and abort
1893                         // TODO: delete the defunct filearchive rows if we are using a non-transactional DB
1894                         $this->file->unlockAndRollback();
1895                         wfProfileOut( __METHOD__ );
1896                         return $this->status;
1897                 }
1898
1899                 // Delete image/oldimage rows
1900                 $this->doDBDeletes();
1901
1902                 // Commit and return
1903                 $this->file->unlock();
1904                 wfProfileOut( __METHOD__ );
1905
1906                 return $this->status;
1907         }
1908
1909         /**
1910          * Removes non-existent files from a deletion batch.
1911          * @param $batch array
1912          * @return array
1913          */
1914         function removeNonexistentFiles( $batch ) {
1915                 $files = $newBatch = array();
1916
1917                 foreach ( $batch as $batchItem ) {
1918                         list( $src, $dest ) = $batchItem;
1919                         $files[$src] = $this->file->repo->getVirtualUrl( 'public' ) . '/' . rawurlencode( $src );
1920                 }
1921
1922                 $result = $this->file->repo->fileExistsBatch( $files );
1923
1924                 foreach ( $batch as $batchItem ) {
1925                         if ( $result[$batchItem[0]] ) {
1926                                 $newBatch[] = $batchItem;
1927                         }
1928                 }
1929
1930                 return $newBatch;
1931         }
1932 }
1933
1934 # ------------------------------------------------------------------------------
1935
1936 /**
1937  * Helper class for file undeletion
1938  * @ingroup FileAbstraction
1939  */
1940 class LocalFileRestoreBatch {
1941         /**
1942          * @var LocalFile
1943          */
1944         var $file;
1945
1946         var $cleanupBatch, $ids, $all, $unsuppress = false;
1947
1948         /**
1949          * @param $file File
1950          * @param $unsuppress bool
1951          */
1952         function __construct( File $file, $unsuppress = false ) {
1953                 $this->file = $file;
1954                 $this->cleanupBatch = $this->ids = array();
1955                 $this->ids = array();
1956                 $this->unsuppress = $unsuppress;
1957         }
1958
1959         /**
1960          * Add a file by ID
1961          */
1962         function addId( $fa_id ) {
1963                 $this->ids[] = $fa_id;
1964         }
1965
1966         /**
1967          * Add a whole lot of files by ID
1968          */
1969         function addIds( $ids ) {
1970                 $this->ids = array_merge( $this->ids, $ids );
1971         }
1972
1973         /**
1974          * Add all revisions of the file
1975          */
1976         function addAll() {
1977                 $this->all = true;
1978         }
1979
1980         /**
1981          * Run the transaction, except the cleanup batch.
1982          * The cleanup batch should be run in a separate transaction, because it locks different
1983          * rows and there's no need to keep the image row locked while it's acquiring those locks
1984          * The caller may have its own transaction open.
1985          * So we save the batch and let the caller call cleanup()
1986          * @return FileRepoStatus
1987          */
1988         function execute() {
1989                 global $wgLang;
1990
1991                 if ( !$this->all && !$this->ids ) {
1992                         // Do nothing
1993                         return $this->file->repo->newGood();
1994                 }
1995
1996                 $exists = $this->file->lock();
1997                 $dbw = $this->file->repo->getMasterDB();
1998                 $status = $this->file->repo->newGood();
1999
2000                 // Fetch all or selected archived revisions for the file,
2001                 // sorted from the most recent to the oldest.
2002                 $conditions = array( 'fa_name' => $this->file->getName() );
2003
2004                 if ( !$this->all ) {
2005                         $conditions[] = 'fa_id IN (' . $dbw->makeList( $this->ids ) . ')';
2006                 }
2007
2008                 $result = $dbw->select( 'filearchive', '*',
2009                         $conditions,
2010                         __METHOD__,
2011                         array( 'ORDER BY' => 'fa_timestamp DESC' )
2012                 );
2013
2014                 $idsPresent = array();
2015                 $storeBatch = array();
2016                 $insertBatch = array();
2017                 $insertCurrent = false;
2018                 $deleteIds = array();
2019                 $first = true;
2020                 $archiveNames = array();
2021
2022                 foreach ( $result as $row ) {
2023                         $idsPresent[] = $row->fa_id;
2024
2025                         if ( $row->fa_name != $this->file->getName() ) {
2026                                 $status->error( 'undelete-filename-mismatch', $wgLang->timeanddate( $row->fa_timestamp ) );
2027                                 $status->failCount++;
2028                                 continue;
2029                         }
2030
2031                         if ( $row->fa_storage_key == '' ) {
2032                                 // Revision was missing pre-deletion
2033                                 $status->error( 'undelete-bad-store-key', $wgLang->timeanddate( $row->fa_timestamp ) );
2034                                 $status->failCount++;
2035                                 continue;
2036                         }
2037
2038                         $deletedRel = $this->file->repo->getDeletedHashPath( $row->fa_storage_key ) . $row->fa_storage_key;
2039                         $deletedUrl = $this->file->repo->getVirtualUrl() . '/deleted/' . $deletedRel;
2040
2041                         $sha1 = substr( $row->fa_storage_key, 0, strcspn( $row->fa_storage_key, '.' ) );
2042
2043                         # Fix leading zero
2044                         if ( strlen( $sha1 ) == 32 && $sha1[0] == '0' ) {
2045                                 $sha1 = substr( $sha1, 1 );
2046                         }
2047
2048                         if ( is_null( $row->fa_major_mime ) || $row->fa_major_mime == 'unknown'
2049                                 || is_null( $row->fa_minor_mime ) || $row->fa_minor_mime == 'unknown'
2050                                 || is_null( $row->fa_media_type ) || $row->fa_media_type == 'UNKNOWN'
2051                                 || is_null( $row->fa_metadata ) ) {
2052                                 // Refresh our metadata
2053                                 // Required for a new current revision; nice for older ones too. :)
2054                                 $props = RepoGroup::singleton()->getFileProps( $deletedUrl );
2055                         } else {
2056                                 $props = array(
2057                                         'minor_mime' => $row->fa_minor_mime,
2058                                         'major_mime' => $row->fa_major_mime,
2059                                         'media_type' => $row->fa_media_type,
2060                                         'metadata'   => $row->fa_metadata
2061                                 );
2062                         }
2063
2064                         if ( $first && !$exists ) {
2065                                 // This revision will be published as the new current version
2066                                 $destRel = $this->file->getRel();
2067                                 $insertCurrent = array(
2068                                         'img_name'        => $row->fa_name,
2069                                         'img_size'        => $row->fa_size,
2070                                         'img_width'       => $row->fa_width,
2071                                         'img_height'      => $row->fa_height,
2072                                         'img_metadata'    => $props['metadata'],
2073                                         'img_bits'        => $row->fa_bits,
2074                                         'img_media_type'  => $props['media_type'],
2075                                         'img_major_mime'  => $props['major_mime'],
2076                                         'img_minor_mime'  => $props['minor_mime'],
2077                                         'img_description' => $row->fa_description,
2078                                         'img_user'        => $row->fa_user,
2079                                         'img_user_text'   => $row->fa_user_text,
2080                                         'img_timestamp'   => $row->fa_timestamp,
2081                                         'img_sha1'        => $sha1
2082                                 );
2083
2084                                 // The live (current) version cannot be hidden!
2085                                 if ( !$this->unsuppress && $row->fa_deleted ) {
2086                                         $storeBatch[] = array( $deletedUrl, 'public', $destRel );
2087                                         $this->cleanupBatch[] = $row->fa_storage_key;
2088                                 }
2089                         } else {
2090                                 $archiveName = $row->fa_archive_name;
2091
2092                                 if ( $archiveName == '' ) {
2093                                         // This was originally a current version; we
2094                                         // have to devise a new archive name for it.
2095                                         // Format is <timestamp of archiving>!<name>
2096                                         $timestamp = wfTimestamp( TS_UNIX, $row->fa_deleted_timestamp );
2097
2098                                         do {
2099                                                 $archiveName = wfTimestamp( TS_MW, $timestamp ) . '!' . $row->fa_name;
2100                                                 $timestamp++;
2101                                         } while ( isset( $archiveNames[$archiveName] ) );
2102                                 }
2103
2104                                 $archiveNames[$archiveName] = true;
2105                                 $destRel = $this->file->getArchiveRel( $archiveName );
2106                                 $insertBatch[] = array(
2107                                         'oi_name'         => $row->fa_name,
2108                                         'oi_archive_name' => $archiveName,
2109                                         'oi_size'         => $row->fa_size,
2110                                         'oi_width'        => $row->fa_width,
2111                                         'oi_height'       => $row->fa_height,
2112                                         'oi_bits'         => $row->fa_bits,
2113                                         'oi_description'  => $row->fa_description,
2114                                         'oi_user'         => $row->fa_user,
2115                                         'oi_user_text'    => $row->fa_user_text,
2116                                         'oi_timestamp'    => $row->fa_timestamp,
2117                                         'oi_metadata'     => $props['metadata'],
2118                                         'oi_media_type'   => $props['media_type'],
2119                                         'oi_major_mime'   => $props['major_mime'],
2120                                         'oi_minor_mime'   => $props['minor_mime'],
2121                                         'oi_deleted'      => $this->unsuppress ? 0 : $row->fa_deleted,
2122                                         'oi_sha1'         => $sha1 );
2123                         }
2124
2125                         $deleteIds[] = $row->fa_id;
2126
2127                         if ( !$this->unsuppress && $row->fa_deleted & File::DELETED_FILE ) {
2128                                 // private files can stay where they are
2129                                 $status->successCount++;
2130                         } else {
2131                                 $storeBatch[] = array( $deletedUrl, 'public', $destRel );
2132                                 $this->cleanupBatch[] = $row->fa_storage_key;
2133                         }
2134
2135                         $first = false;
2136                 }
2137
2138                 unset( $result );
2139
2140                 // Add a warning to the status object for missing IDs
2141                 $missingIds = array_diff( $this->ids, $idsPresent );
2142
2143                 foreach ( $missingIds as $id ) {
2144                         $status->error( 'undelete-missing-filearchive', $id );
2145                 }
2146
2147                 // Remove missing files from batch, so we don't get errors when undeleting them
2148                 $storeBatch = $this->removeNonexistentFiles( $storeBatch );
2149
2150                 // Run the store batch
2151                 // Use the OVERWRITE_SAME flag to smooth over a common error
2152                 $storeStatus = $this->file->repo->storeBatch( $storeBatch, FileRepo::OVERWRITE_SAME );
2153                 $status->merge( $storeStatus );
2154
2155                 if ( !$status->isGood() ) {
2156                         // Even if some files could be copied, fail entirely as that is the
2157                         // easiest thing to do without data loss
2158                         $this->cleanupFailedBatch( $storeStatus, $storeBatch );
2159                         $status->ok = false;
2160                         $this->file->unlock();
2161
2162                         return $status;
2163                 }
2164
2165                 // Run the DB updates
2166                 // Because we have locked the image row, key conflicts should be rare.
2167                 // If they do occur, we can roll back the transaction at this time with
2168                 // no data loss, but leaving unregistered files scattered throughout the
2169                 // public zone.
2170                 // This is not ideal, which is why it's important to lock the image row.
2171                 if ( $insertCurrent ) {
2172                         $dbw->insert( 'image', $insertCurrent, __METHOD__ );
2173                 }
2174
2175                 if ( $insertBatch ) {
2176                         $dbw->insert( 'oldimage', $insertBatch, __METHOD__ );
2177                 }
2178
2179                 if ( $deleteIds ) {
2180                         $dbw->delete( 'filearchive',
2181                                 array( 'fa_id IN (' . $dbw->makeList( $deleteIds ) . ')' ),
2182                                 __METHOD__ );
2183                 }
2184
2185                 // If store batch is empty (all files are missing), deletion is to be considered successful
2186                 if ( $status->successCount > 0 || !$storeBatch ) {
2187                         if ( !$exists ) {
2188                                 wfDebug( __METHOD__ . " restored {$status->successCount} items, creating a new current\n" );
2189
2190                                 DeferredUpdates::addUpdate( SiteStatsUpdate::factory( array( 'images' => 1 ) ) );
2191
2192                                 $this->file->purgeEverything();
2193                         } else {
2194                                 wfDebug( __METHOD__ . " restored {$status->successCount} as archived versions\n" );
2195                                 $this->file->purgeDescription();
2196                                 $this->file->purgeHistory();
2197                         }
2198                 }
2199
2200                 $this->file->unlock();
2201
2202                 return $status;
2203         }
2204
2205         /**
2206          * Removes non-existent files from a store batch.
2207          * @param $triplets array
2208          * @return array
2209          */
2210         function removeNonexistentFiles( $triplets ) {
2211                 $files = $filteredTriplets = array();
2212                 foreach ( $triplets as $file ) {
2213                         $files[$file[0]] = $file[0];
2214                 }
2215
2216                 $result = $this->file->repo->fileExistsBatch( $files );
2217
2218                 foreach ( $triplets as $file ) {
2219                         if ( $result[$file[0]] ) {
2220                                 $filteredTriplets[] = $file;
2221                         }
2222                 }
2223
2224                 return $filteredTriplets;
2225         }
2226
2227         /**
2228          * Removes non-existent files from a cleanup batch.
2229          * @param $batch array
2230          * @return array
2231          */
2232         function removeNonexistentFromCleanup( $batch ) {
2233                 $files = $newBatch = array();
2234                 $repo = $this->file->repo;
2235
2236                 foreach ( $batch as $file ) {
2237                         $files[$file] = $repo->getVirtualUrl( 'deleted' ) . '/' .
2238                                 rawurlencode( $repo->getDeletedHashPath( $file ) . $file );
2239                 }
2240
2241                 $result = $repo->fileExistsBatch( $files );
2242
2243                 foreach ( $batch as $file ) {
2244                         if ( $result[$file] ) {
2245                                 $newBatch[] = $file;
2246                         }
2247                 }
2248
2249                 return $newBatch;
2250         }
2251
2252         /**
2253          * Delete unused files in the deleted zone.
2254          * This should be called from outside the transaction in which execute() was called.
2255          * @return FileRepoStatus|void
2256          */
2257         function cleanup() {
2258                 if ( !$this->cleanupBatch ) {
2259                         return $this->file->repo->newGood();
2260                 }
2261
2262                 $this->cleanupBatch = $this->removeNonexistentFromCleanup( $this->cleanupBatch );
2263
2264                 $status = $this->file->repo->cleanupDeletedBatch( $this->cleanupBatch );
2265
2266                 return $status;
2267         }
2268
2269         /**
2270          * Cleanup a failed batch. The batch was only partially successful, so
2271          * rollback by removing all items that were succesfully copied.
2272          *
2273          * @param Status $storeStatus
2274          * @param array $storeBatch
2275          */
2276         function cleanupFailedBatch( $storeStatus, $storeBatch ) {
2277                 $cleanupBatch = array();
2278
2279                 foreach ( $storeStatus->success as $i => $success ) {
2280                         // Check if this item of the batch was successfully copied
2281                         if ( $success ) {
2282                                 // Item was successfully copied and needs to be removed again
2283                                 // Extract ($dstZone, $dstRel) from the batch
2284                                 $cleanupBatch[] = array( $storeBatch[$i][1], $storeBatch[$i][2] );
2285                         }
2286                 }
2287                 $this->file->repo->cleanupBatch( $cleanupBatch );
2288         }
2289 }
2290
2291 # ------------------------------------------------------------------------------
2292
2293 /**
2294  * Helper class for file movement
2295  * @ingroup FileAbstraction
2296  */
2297 class LocalFileMoveBatch {
2298
2299         /**
2300          * @var LocalFile
2301          */
2302         var $file;
2303
2304         /**
2305          * @var Title
2306          */
2307         var $target;
2308
2309         var $cur, $olds, $oldCount, $archive;
2310
2311         /**
2312          * @var DatabaseBase
2313          */
2314         var $db;
2315
2316         /**
2317          * @param File $file
2318          * @param Title $target
2319          */
2320         function __construct( File $file, Title $target ) {
2321                 $this->file = $file;
2322                 $this->target = $target;
2323                 $this->oldHash = $this->file->repo->getHashPath( $this->file->getName() );
2324                 $this->newHash = $this->file->repo->getHashPath( $this->target->getDBkey() );
2325                 $this->oldName = $this->file->getName();
2326                 $this->newName = $this->file->repo->getNameFromTitle( $this->target );
2327                 $this->oldRel = $this->oldHash . $this->oldName;
2328                 $this->newRel = $this->newHash . $this->newName;
2329                 $this->db = $file->getRepo()->getMasterDb();
2330         }
2331
2332         /**
2333          * Add the current image to the batch
2334          */
2335         function addCurrent() {
2336                 $this->cur = array( $this->oldRel, $this->newRel );
2337         }
2338
2339         /**
2340          * Add the old versions of the image to the batch
2341          * @return Array List of archive names from old versions
2342          */
2343         function addOlds() {
2344                 $archiveBase = 'archive';
2345                 $this->olds = array();
2346                 $this->oldCount = 0;
2347                 $archiveNames = array();
2348
2349                 $result = $this->db->select( 'oldimage',
2350                         array( 'oi_archive_name', 'oi_deleted' ),
2351                         array( 'oi_name' => $this->oldName ),
2352                         __METHOD__
2353                 );
2354
2355                 foreach ( $result as $row ) {
2356                         $archiveNames[] = $row->oi_archive_name;
2357                         $oldName = $row->oi_archive_name;
2358                         $bits = explode( '!', $oldName, 2 );
2359
2360                         if ( count( $bits ) != 2 ) {
2361                                 wfDebug( "Old file name missing !: '$oldName' \n" );
2362                                 continue;
2363                         }
2364
2365                         list( $timestamp, $filename ) = $bits;
2366
2367                         if ( $this->oldName != $filename ) {
2368                                 wfDebug( "Old file name doesn't match: '$oldName' \n" );
2369                                 continue;
2370                         }
2371
2372                         $this->oldCount++;
2373
2374                         // Do we want to add those to oldCount?
2375                         if ( $row->oi_deleted & File::DELETED_FILE ) {
2376                                 continue;
2377                         }
2378
2379                         $this->olds[] = array(
2380                                 "{$archiveBase}/{$this->oldHash}{$oldName}",
2381                                 "{$archiveBase}/{$this->newHash}{$timestamp}!{$this->newName}"
2382                         );
2383                 }
2384
2385                 return $archiveNames;
2386         }
2387
2388         /**
2389          * Perform the move.
2390          * @return FileRepoStatus
2391          */
2392         function execute() {
2393                 $repo = $this->file->repo;
2394                 $status = $repo->newGood();
2395
2396                 $triplets = $this->getMoveTriplets();
2397                 $triplets = $this->removeNonexistentFiles( $triplets );
2398
2399                 $this->file->lock(); // begin
2400                 // Rename the file versions metadata in the DB.
2401                 // This implicitly locks the destination file, which avoids race conditions.
2402                 // If we moved the files from A -> C before DB updates, another process could
2403                 // move files from B -> C at this point, causing storeBatch() to fail and thus
2404                 // cleanupTarget() to trigger. It would delete the C files and cause data loss.
2405                 $statusDb = $this->doDBUpdates();
2406                 if ( !$statusDb->isGood() ) {
2407                         $this->file->unlockAndRollback();
2408                         $statusDb->ok = false;
2409                         return $statusDb;
2410                 }
2411                 wfDebugLog( 'imagemove', "Renamed {$this->file->getName()} in database: {$statusDb->successCount} successes, {$statusDb->failCount} failures" );
2412
2413                 // Copy the files into their new location.
2414                 // If a prior process fataled copying or cleaning up files we tolerate any
2415                 // of the existing files if they are identical to the ones being stored.
2416                 $statusMove = $repo->storeBatch( $triplets, FileRepo::OVERWRITE_SAME );
2417                 wfDebugLog( 'imagemove', "Moved files for {$this->file->getName()}: {$statusMove->successCount} successes, {$statusMove->failCount} failures" );
2418                 if ( !$statusMove->isGood() ) {
2419                         // Delete any files copied over (while the destination is still locked)
2420                         $this->cleanupTarget( $triplets );
2421                         $this->file->unlockAndRollback(); // unlocks the destination
2422                         wfDebugLog( 'imagemove', "Error in moving files: " . $statusMove->getWikiText() );
2423                         $statusMove->ok = false;
2424                         return $statusMove;
2425                 }
2426                 $this->file->unlock(); // done
2427
2428                 // Everything went ok, remove the source files
2429                 $this->cleanupSource( $triplets );
2430
2431                 $status->merge( $statusDb );
2432                 $status->merge( $statusMove );
2433
2434                 return $status;
2435         }
2436
2437         /**
2438          * Do the database updates and return a new FileRepoStatus indicating how
2439          * many rows where updated.
2440          *
2441          * @return FileRepoStatus
2442          */
2443         function doDBUpdates() {
2444                 $repo = $this->file->repo;
2445                 $status = $repo->newGood();
2446                 $dbw = $this->db;
2447
2448                 // Update current image
2449                 $dbw->update(
2450                         'image',
2451                         array( 'img_name' => $this->newName ),
2452                         array( 'img_name' => $this->oldName ),
2453                         __METHOD__
2454                 );
2455
2456                 if ( $dbw->affectedRows() ) {
2457                         $status->successCount++;
2458                 } else {
2459                         $status->failCount++;
2460                         $status->fatal( 'imageinvalidfilename' );
2461                         return $status;
2462                 }
2463
2464                 // Update old images
2465                 $dbw->update(
2466                         'oldimage',
2467                         array(
2468                                 'oi_name' => $this->newName,
2469                                 'oi_archive_name = ' . $dbw->strreplace( 'oi_archive_name',
2470                                         $dbw->addQuotes( $this->oldName ), $dbw->addQuotes( $this->newName ) ),
2471                         ),
2472                         array( 'oi_name' => $this->oldName ),
2473                         __METHOD__
2474                 );
2475
2476                 $affected = $dbw->affectedRows();
2477                 $total = $this->oldCount;
2478                 $status->successCount += $affected;
2479                 // Bug 34934: $total is based on files that actually exist.
2480                 // There may be more DB rows than such files, in which case $affected
2481                 // can be greater than $total. We use max() to avoid negatives here.
2482                 $status->failCount += max( 0, $total - $affected );
2483                 if ( $status->failCount ) {
2484                         $status->error( 'imageinvalidfilename' );
2485                 }
2486
2487                 return $status;
2488         }
2489
2490         /**
2491          * Generate triplets for FileRepo::storeBatch().
2492          * @return array
2493          */
2494         function getMoveTriplets() {
2495                 $moves = array_merge( array( $this->cur ), $this->olds );
2496                 $triplets = array();    // The format is: (srcUrl, destZone, destUrl)
2497
2498                 foreach ( $moves as $move ) {
2499                         // $move: (oldRelativePath, newRelativePath)
2500                         $srcUrl = $this->file->repo->getVirtualUrl() . '/public/' . rawurlencode( $move[0] );
2501                         $triplets[] = array( $srcUrl, 'public', $move[1] );
2502                         wfDebugLog( 'imagemove', "Generated move triplet for {$this->file->getName()}: {$srcUrl} :: public :: {$move[1]}" );
2503                 }
2504
2505                 return $triplets;
2506         }
2507
2508         /**
2509          * Removes non-existent files from move batch.
2510          * @param $triplets array
2511          * @return array
2512          */
2513         function removeNonexistentFiles( $triplets ) {
2514                 $files = array();
2515
2516                 foreach ( $triplets as $file ) {
2517                         $files[$file[0]] = $file[0];
2518                 }
2519
2520                 $result = $this->file->repo->fileExistsBatch( $files );
2521                 $filteredTriplets = array();
2522
2523                 foreach ( $triplets as $file ) {
2524                         if ( $result[$file[0]] ) {
2525                                 $filteredTriplets[] = $file;
2526                         } else {
2527                                 wfDebugLog( 'imagemove', "File {$file[0]} does not exist" );
2528                         }
2529                 }
2530
2531                 return $filteredTriplets;
2532         }
2533
2534         /**
2535          * Cleanup a partially moved array of triplets by deleting the target
2536          * files. Called if something went wrong half way.
2537          */
2538         function cleanupTarget( $triplets ) {
2539                 // Create dest pairs from the triplets
2540                 $pairs = array();
2541                 foreach ( $triplets as $triplet ) {
2542                         // $triplet: (old source virtual URL, dst zone, dest rel)
2543                         $pairs[] = array( $triplet[1], $triplet[2] );
2544                 }
2545
2546                 $this->file->repo->cleanupBatch( $pairs );
2547         }
2548
2549         /**
2550          * Cleanup a fully moved array of triplets by deleting the source files.
2551          * Called at the end of the move process if everything else went ok.
2552          */
2553         function cleanupSource( $triplets ) {
2554                 // Create source file names from the triplets
2555                 $files = array();
2556                 foreach ( $triplets as $triplet ) {
2557                         $files[] = $triplet[0];
2558                 }
2559
2560                 $this->file->repo->cleanupBatch( $files );
2561         }
2562 }