includes/filerepo/LocalFile.php

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