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                 if ( $oldKey ) {
 659                         $wgMemc->delete( $oldKey );
 660                 }
 661         }
 662
 663         /**
 664          * Delete all previously generated thumbnails, refresh metadata in memcached and purge the squid
 665          */
 666         function purgeCache() {
 667                 // Refresh metadata cache
 668                 $this->purgeMetadataCache();
 669
 670                 // Delete thumbnails
 671                 $this->purgeThumbnails();
 672
 673                 // Purge squid cache for this file
 674                 SquidUpdate::purge( array( $this->getURL() ) );
 675         }
 676
 677         /**
 678          * Delete cached transformed files
 679          */
 680         function purgeThumbnails() {
 681                 global $wgUseSquid, $wgExcludeFromThumbnailPurge;
 682
 683                 // Delete thumbnails
 684                 $files = $this->getThumbnails();
 685                 $dir = $this->getThumbPath();
 686                 $urls = array();
 687
 688                 foreach ( $files as $file ) {
 689                         // Only remove files not in the $wgExcludeFromThumbnailPurge configuration variable
 690                         $ext = pathinfo( "$dir/$file", PATHINFO_EXTENSION );
 691                         if ( in_array( $ext, $wgExcludeFromThumbnailPurge ) ) {
 692                                 continue;
 693                         }
 694
 695                         # Check that the base file name is part of the thumb name
 696                         # This is a basic sanity check to avoid erasing unrelated directories
 697                         if ( strpos( $file, $this->getName() ) !== false ) {
 698                                 $url = $this->getThumbUrl( $file );
 699                                 $urls[] = $url;
 700                                 wfSuppressWarnings();
 701                                 unlink( "$dir/$file" );
 702                                 wfRestoreWarnings();
 703                         }
 704                 }
 705
 706                 // Purge the squid
 707                 if ( $wgUseSquid ) {
 708                         SquidUpdate::purge( $urls );
 709                 }
 710         }
 711
 712         /** purgeDescription inherited */
 713         /** purgeEverything inherited */
 714
 715         function getHistory( $limit = null, $start = null, $end = null, $inc = true ) {
 716                 $dbr = $this->repo->getSlaveDB();
 717                 $tables = array( 'oldimage' );
 718                 $fields = OldLocalFile::selectFields();
 719                 $conds = $opts = $join_conds = array();
 720                 $eq = $inc ? '=' : '';
 721                 $conds[] = "oi_name = " . $dbr->addQuotes( $this->title->getDBkey() );
 722
 723                 if ( $start ) {
 724                         $conds[] = "oi_timestamp <$eq " . $dbr->addQuotes( $dbr->timestamp( $start ) );
 725                 }
 726
 727                 if ( $end ) {
 728                         $conds[] = "oi_timestamp >$eq " . $dbr->addQuotes( $dbr->timestamp( $end ) );
 729                 }
 730
 731                 if ( $limit ) {
 732                         $opts['LIMIT'] = $limit;
 733                 }
 734
 735                 // Search backwards for time > x queries
 736                 $order = ( !$start && $end !== null ) ? 'ASC' : 'DESC';
 737                 $opts['ORDER BY'] = "oi_timestamp $order";
 738                 $opts['USE INDEX'] = array( 'oldimage' => 'oi_name_timestamp' );
 739
 740                 wfRunHooks( 'LocalFile::getHistory', array( &$this, &$tables, &$fields,
 741                         &$conds, &$opts, &$join_conds ) );
 742
 743                 $res = $dbr->select( $tables, $fields, $conds, __METHOD__, $opts, $join_conds );
 744                 $r = array();
 745
 746                 foreach ( $res as $row ) {
 747                         if ( $this->repo->oldFileFromRowFactory ) {
 748                                 $r[] = call_user_func( $this->repo->oldFileFromRowFactory, $row, $this->repo );
 749                         } else {
 750                                 $r[] = OldLocalFile::newFromRow( $row, $this->repo );
 751                         }
 752                 }
 753
 754                 if ( $order == 'ASC' ) {
 755                         $r = array_reverse( $r ); // make sure it ends up descending
 756                 }
 757
 758                 return $r;
 759         }
 760
 761         /**
 762          * Return the history of this file, line by line.
 763          * starts with current version, then old versions.
 764          * uses $this->historyLine to check which line to return:
 765          *  0      return line for current version
 766          *  1      query for old versions, return first one
 767          *  2, ... return next old version from above query
 768          */
 769         public function nextHistoryLine() {
 770                 # Polymorphic function name to distinguish foreign and local fetches
 771                 $fname = get_class( $this ) . '::' . __FUNCTION__;
 772
 773                 $dbr = $this->repo->getSlaveDB();
 774
 775                 if ( $this->historyLine == 0 ) {// called for the first time, return line from cur
 776                         $this->historyRes = $dbr->select( 'image',
 777                                 array(
 778                                         '*',
 779                                         "'' AS oi_archive_name",
 780                                         '0 as oi_deleted',
 781                                         'img_sha1'
 782                                 ),
 783                                 array( 'img_name' => $this->title->getDBkey() ),
 784                                 $fname
 785                         );
 786
 787                         if ( 0 == $dbr->numRows( $this->historyRes ) ) {
 788                                 $this->historyRes = null;
 789                                 return false;
 790                         }
 791                 } elseif ( $this->historyLine == 1 ) {
 792                         $this->historyRes = $dbr->select( 'oldimage', '*',
 793                                 array( 'oi_name' => $this->title->getDBkey() ),
 794                                 $fname,
 795                                 array( 'ORDER BY' => 'oi_timestamp DESC' )
 796                         );
 797                 }
 798                 $this->historyLine ++;
 799
 800                 return $dbr->fetchObject( $this->historyRes );
 801         }
 802
 803         /**
 804          * Reset the history pointer to the first element of the history
 805          */
 806         public function resetHistory() {
 807                 $this->historyLine = 0;
 808
 809                 if ( !is_null( $this->historyRes ) ) {
 810                         $this->historyRes = null;
 811                 }
 812         }
 813
 814         /** getFullPath inherited */
 815         /** getHashPath inherited */
 816         /** getRel inherited */
 817         /** getUrlRel inherited */
 818         /** getArchiveRel inherited */
 819         /** getArchivePath inherited */
 820         /** getThumbPath inherited */
 821         /** getArchiveUrl inherited */
 822         /** getThumbUrl inherited */
 823         /** getArchiveVirtualUrl inherited */
 824         /** getThumbVirtualUrl inherited */
 825         /** isHashed inherited */
 826
 827         /**
 828          * Upload a file and record it in the DB
 829          * @param $srcPath String: source path or virtual URL
 830          * @param $comment String: upload description
 831          * @param $pageText String: text to use for the new description page,
 832          *                  if a new description page is created
 833          * @param $flags Integer: flags for publish()
 834          * @param $props Array: File properties, if known. This can be used to reduce the
 835          *               upload time when uploading virtual URLs for which the file info
 836          *               is already known
 837          * @param $timestamp String: timestamp for img_timestamp, or false to use the current time
 838          * @param $user Mixed: User object or null to use $wgUser
 839          *
 840          * @return FileRepoStatus object. On success, the value member contains the
 841          *     archive name, or an empty string if it was a new file.
 842          */
 843         function upload( $srcPath, $comment, $pageText, $flags = 0, $props = false, $timestamp = false, $user = null ) {
 844                 $this->lock();
 845                 $status = $this->publish( $srcPath, $flags );
 846
 847                 if ( $status->ok ) {
 848                         if ( !$this->recordUpload2( $status->value, $comment, $pageText, $props, $timestamp, $user ) ) {
 849                                 $status->fatal( 'filenotfound', $srcPath );
 850                         }
 851                 }
 852
 853                 $this->unlock();
 854
 855                 return $status;
 856         }
 857
 858         /**
 859          * Record a file upload in the upload log and the image table
 860          */
 861         function recordUpload2(
 862                 $oldver, $comment, $pageText, $props = false, $timestamp = false, $user = null
 863         ) {
 864                 if ( is_null( $user ) ) {
 865                         global $wgUser;
 866                         $user = $wgUser;
 867                 }
 868
 869                 $dbw = $this->repo->getMasterDB();
 870                 $dbw->begin();
 871
 872                 if ( !$props ) {
 873                         $props = $this->repo->getFileProps( $this->getVirtualUrl() );
 874                 }
 875
 876                 if ( $timestamp === false ) {
 877                         $timestamp = $dbw->timestamp();
 878                 }
 879
 880                 $props['description'] = $comment;
 881                 $props['user'] = $user->getId();
 882                 $props['user_text'] = $user->getName();
 883                 $props['timestamp'] = wfTimestamp( TS_MW, $timestamp ); // DB -> TS_MW
 884                 $this->setProps( $props );
 885
 886                 # Delete thumbnails
 887                 $this->purgeThumbnails();
 888
 889                 # The file is already on its final location, remove it from the squid cache
 890                 SquidUpdate::purge( array( $this->getURL() ) );
 891
 892                 # Fail now if the file isn't there
 893                 if ( !$this->fileExists ) {
 894                         wfDebug( __METHOD__ . ": File " . $this->getRel() . " went missing!\n" );
 895                         return false;
 896                 }
 897
 898                 $reupload = false;
 899
 900                 # Test to see if the row exists using INSERT IGNORE
 901                 # This avoids race conditions by locking the row until the commit, and also
 902                 # doesn't deadlock. SELECT FOR UPDATE causes a deadlock for every race condition.
 903                 $dbw->insert( 'image',
 904                         array(
 905                                 'img_name' => $this->getName(),
 906                                 'img_size' => $this->size,
 907                                 'img_width' => intval( $this->width ),
 908                                 'img_height' => intval( $this->height ),
 909                                 'img_bits' => $this->bits,
 910                                 'img_media_type' => $this->media_type,
 911                                 'img_major_mime' => $this->major_mime,
 912                                 'img_minor_mime' => $this->minor_mime,
 913                                 'img_timestamp' => $timestamp,
 914                                 'img_description' => $comment,
 915                                 'img_user' => $user->getId(),
 916                                 'img_user_text' => $user->getName(),
 917                                 'img_metadata' => $this->metadata,
 918                                 'img_sha1' => $this->sha1
 919                         ),
 920                         __METHOD__,
 921                         'IGNORE'
 922                 );
 923
 924                 if ( $dbw->affectedRows() == 0 ) {
 925                         $reupload = true;
 926
 927                         # Collision, this is an update of a file
 928                         # Insert previous contents into oldimage
 929                         $dbw->insertSelect( 'oldimage', 'image',
 930                                 array(
 931                                         'oi_name' => 'img_name',
 932                                         'oi_archive_name' => $dbw->addQuotes( $oldver ),
 933                                         'oi_size' => 'img_size',
 934                                         'oi_width' => 'img_width',
 935                                         'oi_height' => 'img_height',
 936                                         'oi_bits' => 'img_bits',
 937                                         'oi_timestamp' => 'img_timestamp',
 938                                         'oi_description' => 'img_description',
 939                                         'oi_user' => 'img_user',
 940                                         'oi_user_text' => 'img_user_text',
 941                                         'oi_metadata' => 'img_metadata',
 942                                         'oi_media_type' => 'img_media_type',
 943                                         'oi_major_mime' => 'img_major_mime',
 944                                         'oi_minor_mime' => 'img_minor_mime',
 945                                         'oi_sha1' => 'img_sha1'
 946                                 ), array( 'img_name' => $this->getName() ), __METHOD__
 947                         );
 948
 949                         # Update the current image row
 950                         $dbw->update( 'image',
 951                                 array( /* SET */
 952                                         'img_size' => $this->size,
 953                                         'img_width' => intval( $this->width ),
 954                                         'img_height' => intval( $this->height ),
 955                                         'img_bits' => $this->bits,
 956                                         'img_media_type' => $this->media_type,
 957                                         'img_major_mime' => $this->major_mime,
 958                                         'img_minor_mime' => $this->minor_mime,
 959                                         'img_timestamp' => $timestamp,
 960                                         'img_description' => $comment,
 961                                         'img_user' => $user->getId(),
 962                                         'img_user_text' => $user->getName(),
 963                                         'img_metadata' => $this->metadata,
 964                                         'img_sha1' => $this->sha1
 965                                 ), array( /* WHERE */
 966                                         'img_name' => $this->getName()
 967                                 ), __METHOD__
 968                         );
 969                 } else {
 970                         # This is a new file
 971                         # Update the image count
 972                         $site_stats = $dbw->tableName( 'site_stats' );
 973                         $dbw->query( "UPDATE $site_stats SET ss_images=ss_images+1", __METHOD__ );
 974                 }
 975
 976                 $descTitle = $this->getTitle();
 977                 $article = new ImagePage( $descTitle );
 978                 $article->setFile( $this );
 979
 980                 # Add the log entry
 981                 $log = new LogPage( 'upload' );
 982                 $action = $reupload ? 'overwrite' : 'upload';
 983                 $log->addEntry( $action, $descTitle, $comment, array(), $user );
 984
 985                 if ( $descTitle->exists() ) {
 986                         # Create a null revision
 987                         $latest = $descTitle->getLatestRevID();
 988                         $nullRevision = Revision::newNullRevision(
 989                                 $dbw,
 990                                 $descTitle->getArticleId(),
 991                                 $log->getRcComment(),
 992                                 false
 993                         );
 994                         $nullRevision->insertOn( $dbw );
 995
 996                         wfRunHooks( 'NewRevisionFromEditComplete', array( $article, $nullRevision, $latest, $user ) );
 997                         $article->updateRevisionOn( $dbw, $nullRevision );
 998
 999                         # Invalidate the cache for the description page
1000                         $descTitle->invalidateCache();
1001                         $descTitle->purgeSquid();
1002                 } else {
1003                         # New file; create the description page.
1004                         # There's already a log entry, so don't make a second RC entry
1005                         # Squid and file cache for the description page are purged by doEdit.
1006                         $article->doEdit( $pageText, $comment, EDIT_NEW | EDIT_SUPPRESS_RC );
1007                 }
1008
1009                 # Commit the transaction now, in case something goes wrong later
1010                 # The most important thing is that files don't get lost, especially archives
1011                 $dbw->commit();
1012
1013                 # Save to cache and purge the squid
1014                 # We shall not saveToCache before the commit since otherwise
1015                 # in case of a rollback there is an usable file from memcached
1016                 # which in fact doesn't really exist (bug 24978)
1017                 $this->saveToCache();
1018
1019                 # Hooks, hooks, the magic of hooks...
1020                 wfRunHooks( 'FileUpload', array( $this, $reupload, $descTitle->exists() ) );
1021
1022                 # Invalidate cache for all pages using this file
1023                 $update = new HTMLCacheUpdate( $this->getTitle(), 'imagelinks' );
1024                 $update->doUpdate();
1025
1026                 # Invalidate cache for all pages that redirects on this page
1027                 $redirs = $this->getTitle()->getRedirectsHere();
1028
1029                 foreach ( $redirs as $redir ) {
1030                         $update = new HTMLCacheUpdate( $redir, 'imagelinks' );
1031                         $update->doUpdate();
1032                 }
1033
1034                 return true;
1035         }
1036
1037         /**
1038          * Move or copy a file to its public location. If a file exists at the
1039          * destination, move it to an archive. Returns a FileRepoStatus object with
1040          * the archive name in the "value" member on success.
1041          *
1042          * The archive name should be passed through to recordUpload for database
1043          * registration.
1044          *
1045          * @param $srcPath String: local filesystem path to the source image
1046          * @param $flags Integer: a bitwise combination of:
1047          *     File::DELETE_SOURCE      Delete the source file, i.e. move rather than copy
1048          * @return FileRepoStatus object. On success, the value member contains the
1049          *     archive name, or an empty string if it was a new file.
1050          */
1051         function publish( $srcPath, $flags = 0 ) {
1052                 return $this->publishTo( $srcPath, $this->getRel(), $flags );
1053         }
1054
1055         /**
1056          * Move or copy a file to a specified location. Returns a FileRepoStatus
1057          * object with the archive name in the "value" member on success.
1058          *
1059          * The archive name should be passed through to recordUpload for database
1060          * registration.
1061          *
1062          * @param $srcPath String: local filesystem path to the source image
1063          * @param $dstRel String: target relative path
1064          * @param $flags Integer: a bitwise combination of:
1065          *     File::DELETE_SOURCE      Delete the source file, i.e. move rather than copy
1066          * @return FileRepoStatus object. On success, the value member contains the
1067          *     archive name, or an empty string if it was a new file.
1068          */
1069         function publishTo( $srcPath, $dstRel, $flags = 0 ) {
1070                 $this->lock();
1071
1072                 $archiveName = wfTimestamp( TS_MW ) . '!'. $this->getName();
1073                 $archiveRel = 'archive/' . $this->getHashPath() . $archiveName;
1074                 $flags = $flags & File::DELETE_SOURCE ? LocalRepo::DELETE_SOURCE : 0;
1075                 $status = $this->repo->publish( $srcPath, $dstRel, $archiveRel, $flags );
1076
1077                 if ( $status->value == 'new' ) {
1078                         $status->value = '';
1079                 } else {
1080                         $status->value = $archiveName;
1081                 }
1082
1083                 $this->unlock();
1084
1085                 return $status;
1086         }
1087
1088         /** getLinksTo inherited */
1089         /** getExifData inherited */
1090         /** isLocal inherited */
1091         /** wasDeleted inherited */
1092
1093         /**
1094          * Move file to the new title
1095          *
1096          * Move current, old version and all thumbnails
1097          * to the new filename. Old file is deleted.
1098          *
1099          * Cache purging is done; checks for validity
1100          * and logging are caller's responsibility
1101          *
1102          * @param $target Title New file name
1103          * @return FileRepoStatus object.
1104          */
1105         function move( $target ) {
1106                 wfDebugLog( 'imagemove', "Got request to move {$this->name} to " . $target->getText() );
1107                 $this->lock();
1108
1109                 $batch = new LocalFileMoveBatch( $this, $target );
1110                 $batch->addCurrent();
1111                 $batch->addOlds();
1112
1113                 $status = $batch->execute();
1114                 wfDebugLog( 'imagemove', "Finished moving {$this->name}" );
1115
1116                 $this->purgeEverything();
1117                 $this->unlock();
1118
1119                 if ( $status->isOk() ) {
1120                         // Now switch the object
1121                         $this->title = $target;
1122                         // Force regeneration of the name and hashpath
1123                         unset( $this->name );
1124                         unset( $this->hashPath );
1125                         // Purge the new image
1126                         $this->purgeEverything();
1127                 }
1128
1129                 return $status;
1130         }
1131
1132         /**
1133          * Delete all versions of the file.
1134          *
1135          * Moves the files into an archive directory (or deletes them)
1136          * and removes the database rows.
1137          *
1138          * Cache purging is done; logging is caller's responsibility.
1139          *
1140          * @param $reason
1141          * @param $suppress
1142          * @return FileRepoStatus object.
1143          */
1144         function delete( $reason, $suppress = false ) {
1145                 $this->lock();
1146
1147                 $batch = new LocalFileDeleteBatch( $this, $reason, $suppress );
1148                 $batch->addCurrent();
1149
1150                 # Get old version relative paths
1151                 $dbw = $this->repo->getMasterDB();
1152                 $result = $dbw->select( 'oldimage',
1153                         array( 'oi_archive_name' ),
1154                         array( 'oi_name' => $this->getName() ) );
1155                 foreach ( $result as $row ) {
1156                         $batch->addOld( $row->oi_archive_name );
1157                 }
1158                 $status = $batch->execute();
1159
1160                 if ( $status->ok ) {
1161                         // Update site_stats
1162                         $site_stats = $dbw->tableName( 'site_stats' );
1163                         $dbw->query( "UPDATE $site_stats SET ss_images=ss_images-1", __METHOD__ );
1164                         $this->purgeEverything();
1165                 }
1166
1167                 $this->unlock();
1168
1169                 return $status;
1170         }
1171
1172         /**
1173          * Delete an old version of the file.
1174          *
1175          * Moves the file into an archive directory (or deletes it)
1176          * and removes the database row.
1177          *
1178          * Cache purging is done; logging is caller's responsibility.
1179          *
1180          * @param $archiveName String
1181          * @param $reason String
1182          * @param $suppress Boolean
1183          * @throws MWException or FSException on database or file store failure
1184          * @return FileRepoStatus object.
1185          */
1186         function deleteOld( $archiveName, $reason, $suppress = false ) {
1187                 $this->lock();
1188
1189                 $batch = new LocalFileDeleteBatch( $this, $reason, $suppress );
1190                 $batch->addOld( $archiveName );
1191                 $status = $batch->execute();
1192
1193                 $this->unlock();
1194
1195                 if ( $status->ok ) {
1196                         $this->purgeDescription();
1197                         $this->purgeHistory();
1198                 }
1199
1200                 return $status;
1201         }
1202
1203         /**
1204          * Restore all or specified deleted revisions to the given file.
1205          * Permissions and logging are left to the caller.
1206          *
1207          * May throw database exceptions on error.
1208          *
1209          * @param $versions set of record ids of deleted items to restore,
1210          *                    or empty to restore all revisions.
1211          * @param $unsuppress Boolean
1212          * @return FileRepoStatus
1213          */
1214         function restore( $versions = array(), $unsuppress = false ) {
1215                 $batch = new LocalFileRestoreBatch( $this, $unsuppress );
1216
1217                 if ( !$versions ) {
1218                         $batch->addAll();
1219                 } else {
1220                         $batch->addIds( $versions );
1221                 }
1222
1223                 $status = $batch->execute();
1224
1225                 if ( !$status->isGood() ) {
1226                         return $status;
1227                 }
1228
1229                 $cleanupStatus = $batch->cleanup();
1230                 $cleanupStatus->successCount = 0;
1231                 $cleanupStatus->failCount = 0;
1232                 $status->merge( $cleanupStatus );
1233
1234                 return $status;
1235         }
1236
1237         /** isMultipage inherited */
1238         /** pageCount inherited */
1239         /** scaleHeight inherited */
1240         /** getImageSize inherited */
1241
1242         /**
1243          * Get the URL of the file description page.
1244          */
1245         function getDescriptionUrl() {
1246                 return $this->title->getLocalUrl();
1247         }
1248
1249         /**
1250          * Get the HTML text of the description page
1251          * This is not used by ImagePage for local files, since (among other things)
1252          * it skips the parser cache.
1253          */
1254         function getDescriptionText() {
1255                 global $wgParser;
1256                 $revision = Revision::newFromTitle( $this->title );
1257                 if ( !$revision ) return false;
1258                 $text = $revision->getText();
1259                 if ( !$text ) return false;
1260                 $pout = $wgParser->parse( $text, $this->title, new ParserOptions() );
1261                 return $pout->getText();
1262         }
1263
1264         function getDescription() {
1265                 $this->load();
1266                 return $this->description;
1267         }
1268
1269         function getTimestamp() {
1270                 $this->load();
1271                 return $this->timestamp;
1272         }
1273
1274         function getSha1() {
1275                 $this->load();
1276                 // Initialise now if necessary
1277                 if ( $this->sha1 == '' && $this->fileExists ) {
1278                         $this->sha1 = File::sha1Base36( $this->getPath() );
1279                         if ( !wfReadOnly() && strval( $this->sha1 ) != '' ) {
1280                                 $dbw = $this->repo->getMasterDB();
1281                                 $dbw->update( 'image',
1282                                         array( 'img_sha1' => $this->sha1 ),
1283                                         array( 'img_name' => $this->getName() ),
1284                                         __METHOD__ );
1285                                 $this->saveToCache();
1286                         }
1287                 }
1288
1289                 return $this->sha1;
1290         }
1291
1292         /**
1293          * Start a transaction and lock the image for update
1294          * Increments a reference counter if the lock is already held
1295          * @return boolean True if the image exists, false otherwise
1296          */
1297         function lock() {
1298                 $dbw = $this->repo->getMasterDB();
1299
1300                 if ( !$this->locked ) {
1301                         $dbw->begin();
1302                         $this->locked++;
1303                 }
1304
1305                 return $dbw->selectField( 'image', '1', array( 'img_name' => $this->getName() ), __METHOD__ );
1306         }
1307
1308         /**
1309          * Decrement the lock reference count. If the reference count is reduced to zero, commits
1310          * the transaction and thereby releases the image lock.
1311          */
1312         function unlock() {
1313                 if ( $this->locked ) {
1314                         --$this->locked;
1315                         if ( !$this->locked ) {
1316                                 $dbw = $this->repo->getMasterDB();
1317                                 $dbw->commit();
1318                         }
1319                 }
1320         }
1321
1322         /**
1323          * Roll back the DB transaction and mark the image unlocked
1324          */
1325         function unlockAndRollback() {
1326                 $this->locked = false;
1327                 $dbw = $this->repo->getMasterDB();
1328                 $dbw->rollback();
1329         }
1330 } // LocalFile class
1331
1332 # ------------------------------------------------------------------------------
1333
1334 /**
1335  * Helper class for file deletion
1336  * @ingroup FileRepo
1337  */
1338 class LocalFileDeleteBatch {
1339
1340         /**
1341          * @var LocalFile
1342          */
1343         var $file;
1344
1345         var $reason, $srcRels = array(), $archiveUrls = array(), $deletionBatch, $suppress;
1346         var $status;
1347
1348         function __construct( File $file, $reason = '', $suppress = false ) {
1349                 $this->file = $file;
1350                 $this->reason = $reason;
1351                 $this->suppress = $suppress;
1352                 $this->status = $file->repo->newGood();
1353         }
1354
1355         function addCurrent() {
1356                 $this->srcRels['.'] = $this->file->getRel();
1357         }
1358
1359         function addOld( $oldName ) {
1360                 $this->srcRels[$oldName] = $this->file->getArchiveRel( $oldName );
1361                 $this->archiveUrls[] = $this->file->getArchiveUrl( $oldName );
1362         }
1363
1364         function getOldRels() {
1365                 if ( !isset( $this->srcRels['.'] ) ) {
1366                         $oldRels =& $this->srcRels;
1367                         $deleteCurrent = false;
1368                 } else {
1369                         $oldRels = $this->srcRels;
1370                         unset( $oldRels['.'] );
1371                         $deleteCurrent = true;
1372                 }
1373
1374                 return array( $oldRels, $deleteCurrent );
1375         }
1376
1377         protected function getHashes() {
1378                 $hashes = array();
1379                 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
1380
1381                 if ( $deleteCurrent ) {
1382                         $hashes['.'] = $this->file->getSha1();
1383                 }
1384
1385                 if ( count( $oldRels ) ) {
1386                         $dbw = $this->file->repo->getMasterDB();
1387                         $res = $dbw->select(
1388                                 'oldimage',
1389                                 array( 'oi_archive_name', 'oi_sha1' ),
1390                                 'oi_archive_name IN (' . $dbw->makeList( array_keys( $oldRels ) ) . ')',
1391                                 __METHOD__
1392                         );
1393
1394                         foreach ( $res as $row ) {
1395                                 if ( rtrim( $row->oi_sha1, "\0" ) === '' ) {
1396                                         // Get the hash from the file
1397                                         $oldUrl = $this->file->getArchiveVirtualUrl( $row->oi_archive_name );
1398                                         $props = $this->file->repo->getFileProps( $oldUrl );
1399
1400                                         if ( $props['fileExists'] ) {
1401                                                 // Upgrade the oldimage row
1402                                                 $dbw->update( 'oldimage',
1403                                                         array( 'oi_sha1' => $props['sha1'] ),
1404                                                         array( 'oi_name' => $this->file->getName(), 'oi_archive_name' => $row->oi_archive_name ),
1405                                                         __METHOD__ );
1406                                                 $hashes[$row->oi_archive_name] = $props['sha1'];
1407                                         } else {
1408                                                 $hashes[$row->oi_archive_name] = false;
1409                                         }
1410                                 } else {
1411                                         $hashes[$row->oi_archive_name] = $row->oi_sha1;
1412                                 }
1413                         }
1414                 }
1415
1416                 $missing = array_diff_key( $this->srcRels, $hashes );
1417
1418                 foreach ( $missing as $name => $rel ) {
1419                         $this->status->error( 'filedelete-old-unregistered', $name );
1420                 }
1421
1422                 foreach ( $hashes as $name => $hash ) {
1423                         if ( !$hash ) {
1424                                 $this->status->error( 'filedelete-missing', $this->srcRels[$name] );
1425                                 unset( $hashes[$name] );
1426                         }
1427                 }
1428
1429                 return $hashes;
1430         }
1431
1432         function doDBInserts() {
1433                 global $wgUser;
1434
1435                 $dbw = $this->file->repo->getMasterDB();
1436                 $encTimestamp = $dbw->addQuotes( $dbw->timestamp() );
1437                 $encUserId = $dbw->addQuotes( $wgUser->getId() );
1438                 $encReason = $dbw->addQuotes( $this->reason );
1439                 $encGroup = $dbw->addQuotes( 'deleted' );
1440                 $ext = $this->file->getExtension();
1441                 $dotExt = $ext === '' ? '' : ".$ext";
1442                 $encExt = $dbw->addQuotes( $dotExt );
1443                 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
1444
1445                 // Bitfields to further suppress the content
1446                 if ( $this->suppress ) {
1447                         $bitfield = 0;
1448                         // This should be 15...
1449                         $bitfield |= Revision::DELETED_TEXT;
1450                         $bitfield |= Revision::DELETED_COMMENT;
1451                         $bitfield |= Revision::DELETED_USER;
1452                         $bitfield |= Revision::DELETED_RESTRICTED;
1453                 } else {
1454                         $bitfield = 'oi_deleted';
1455                 }
1456
1457                 if ( $deleteCurrent ) {
1458                         $concat = $dbw->buildConcat( array( "img_sha1", $encExt ) );
1459                         $where = array( 'img_name' => $this->file->getName() );
1460                         $dbw->insertSelect( 'filearchive', 'image',
1461                                 array(
1462                                         'fa_storage_group' => $encGroup,
1463                                         'fa_storage_key'   => "CASE WHEN img_sha1='' THEN '' ELSE $concat END",
1464                                         'fa_deleted_user'      => $encUserId,
1465                                         'fa_deleted_timestamp' => $encTimestamp,
1466                                         'fa_deleted_reason'    => $encReason,
1467                                         'fa_deleted'               => $this->suppress ? $bitfield : 0,
1468
1469                                         'fa_name'         => 'img_name',
1470                                         'fa_archive_name' => 'NULL',
1471                                         'fa_size'         => 'img_size',
1472                                         'fa_width'        => 'img_width',
1473                                         'fa_height'       => 'img_height',
1474                                         'fa_metadata'     => 'img_metadata',
1475                                         'fa_bits'         => 'img_bits',
1476                                         'fa_media_type'   => 'img_media_type',
1477                                         'fa_major_mime'   => 'img_major_mime',
1478                                         'fa_minor_mime'   => 'img_minor_mime',
1479                                         'fa_description'  => 'img_description',
1480                                         'fa_user'         => 'img_user',
1481                                         'fa_user_text'    => 'img_user_text',
1482                                         'fa_timestamp'    => 'img_timestamp'
1483                                 ), $where, __METHOD__ );
1484                 }
1485
1486                 if ( count( $oldRels ) ) {
1487                         $concat = $dbw->buildConcat( array( "oi_sha1", $encExt ) );
1488                         $where = array(
1489                                 'oi_name' => $this->file->getName(),
1490                                 'oi_archive_name IN (' . $dbw->makeList( array_keys( $oldRels ) ) . ')' );
1491                         $dbw->insertSelect( 'filearchive', 'oldimage',
1492                                 array(
1493                                         'fa_storage_group' => $encGroup,
1494                                         'fa_storage_key'   => "CASE WHEN oi_sha1='' THEN '' ELSE $concat END",
1495                                         'fa_deleted_user'      => $encUserId,
1496                                         'fa_deleted_timestamp' => $encTimestamp,
1497                                         'fa_deleted_reason'    => $encReason,
1498                                         'fa_deleted'               => $this->suppress ? $bitfield : 'oi_deleted',
1499
1500                                         'fa_name'         => 'oi_name',
1501                                         'fa_archive_name' => 'oi_archive_name',
1502                                         'fa_size'         => 'oi_size',
1503                                         'fa_width'        => 'oi_width',
1504                                         'fa_height'       => 'oi_height',
1505                                         'fa_metadata'     => 'oi_metadata',
1506                                         'fa_bits'         => 'oi_bits',
1507                                         'fa_media_type'   => 'oi_media_type',
1508                                         'fa_major_mime'   => 'oi_major_mime',
1509                                         'fa_minor_mime'   => 'oi_minor_mime',
1510                                         'fa_description'  => 'oi_description',
1511                                         'fa_user'         => 'oi_user',
1512                                         'fa_user_text'    => 'oi_user_text',
1513                                         'fa_timestamp'    => 'oi_timestamp',
1514                                         'fa_deleted'      => $bitfield
1515                                 ), $where, __METHOD__ );
1516                 }
1517         }
1518
1519         function doDBDeletes() {
1520                 $dbw = $this->file->repo->getMasterDB();
1521                 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
1522
1523                 if ( count( $oldRels ) ) {
1524                         $dbw->delete( 'oldimage',
1525                                 array(
1526                                         'oi_name' => $this->file->getName(),
1527                                         'oi_archive_name' => array_keys( $oldRels )
1528                                 ), __METHOD__ );
1529                 }
1530
1531                 if ( $deleteCurrent ) {
1532                         $dbw->delete( 'image', array( 'img_name' => $this->file->getName() ), __METHOD__ );
1533                 }
1534         }
1535
1536         /**
1537          * Run the transaction
1538          */
1539         function execute() {
1540                 global $wgUseSquid;
1541                 wfProfileIn( __METHOD__ );
1542
1543                 $this->file->lock();
1544                 // Leave private files alone
1545                 $privateFiles = array();
1546                 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
1547                 $dbw = $this->file->repo->getMasterDB();
1548
1549                 if ( !empty( $oldRels ) ) {
1550                         $res = $dbw->select( 'oldimage',
1551                                 array( 'oi_archive_name' ),
1552                                 array( 'oi_name' => $this->file->getName(),
1553                                         'oi_archive_name IN (' . $dbw->makeList( array_keys( $oldRels ) ) . ')',
1554                                         $dbw->bitAnd( 'oi_deleted', File::DELETED_FILE ) => File::DELETED_FILE ),
1555                                 __METHOD__ );
1556
1557                         foreach ( $res as $row ) {
1558                                 $privateFiles[$row->oi_archive_name] = 1;
1559                         }
1560                 }
1561                 // Prepare deletion batch
1562                 $hashes = $this->getHashes();
1563                 $this->deletionBatch = array();
1564                 $ext = $this->file->getExtension();
1565                 $dotExt = $ext === '' ? '' : ".$ext";
1566
1567                 foreach ( $this->srcRels as $name => $srcRel ) {
1568                         // Skip files that have no hash (missing source).
1569                         // Keep private files where they are.
1570                         if ( isset( $hashes[$name] ) && !array_key_exists( $name, $privateFiles ) ) {
1571                                 $hash = $hashes[$name];
1572                                 $key = $hash . $dotExt;
1573                                 $dstRel = $this->file->repo->getDeletedHashPath( $key ) . $key;
1574                                 $this->deletionBatch[$name] = array( $srcRel, $dstRel );
1575                         }
1576                 }
1577
1578                 // Lock the filearchive rows so that the files don't get deleted by a cleanup operation
1579                 // We acquire this lock by running the inserts now, before the file operations.
1580                 //
1581                 // This potentially has poor lock contention characteristics -- an alternative
1582                 // scheme would be to insert stub filearchive entries with no fa_name and commit
1583                 // them in a separate transaction, then run the file ops, then update the fa_name fields.
1584                 $this->doDBInserts();
1585
1586                 // Removes non-existent file from the batch, so we don't get errors.
1587                 $this->deletionBatch = $this->removeNonexistentFiles( $this->deletionBatch );
1588
1589                 // Execute the file deletion batch
1590                 $status = $this->file->repo->deleteBatch( $this->deletionBatch );
1591
1592                 if ( !$status->isGood() ) {
1593                         $this->status->merge( $status );
1594                 }
1595
1596                 if ( !$this->status->ok ) {
1597                         // Critical file deletion error
1598                         // Roll back inserts, release lock and abort
1599                         // TODO: delete the defunct filearchive rows if we are using a non-transactional DB
1600                         $this->file->unlockAndRollback();
1601                         wfProfileOut( __METHOD__ );
1602                         return $this->status;
1603                 }
1604
1605                 // Purge squid
1606                 if ( $wgUseSquid ) {
1607                         $urls = array();
1608
1609                         foreach ( $this->srcRels as $srcRel ) {
1610                                 $urlRel = str_replace( '%2F', '/', rawurlencode( $srcRel ) );
1611                                 $urls[] = $this->file->repo->getZoneUrl( 'public' ) . '/' . $urlRel;
1612                         }
1613                         SquidUpdate::purge( $urls );
1614                 }
1615
1616                 // Delete image/oldimage rows
1617                 $this->doDBDeletes();
1618
1619                 // Commit and return
1620                 $this->file->unlock();
1621                 wfProfileOut( __METHOD__ );
1622
1623                 return $this->status;
1624         }
1625
1626         /**
1627          * Removes non-existent files from a deletion batch.
1628          */
1629         function removeNonexistentFiles( $batch ) {
1630                 $files = $newBatch = array();
1631
1632                 foreach ( $batch as $batchItem ) {
1633                         list( $src, $dest ) = $batchItem;
1634                         $files[$src] = $this->file->repo->getVirtualUrl( 'public' ) . '/' . rawurlencode( $src );
1635                 }
1636
1637                 $result = $this->file->repo->fileExistsBatch( $files, FSRepo::FILES_ONLY );
1638
1639                 foreach ( $batch as $batchItem ) {
1640                         if ( $result[$batchItem[0]] ) {
1641                                 $newBatch[] = $batchItem;
1642                         }
1643                 }
1644
1645                 return $newBatch;
1646         }
1647 }
1648
1649 # ------------------------------------------------------------------------------
1650
1651 /**
1652  * Helper class for file undeletion
1653  * @ingroup FileRepo
1654  */
1655 class LocalFileRestoreBatch {
1656         /**
1657          * @var LocalFile
1658          */
1659         var $file;
1660
1661         var $cleanupBatch, $ids, $all, $unsuppress = false;
1662
1663         function __construct( File $file, $unsuppress = false ) {
1664                 $this->file = $file;
1665                 $this->cleanupBatch = $this->ids = array();
1666                 $this->ids = array();
1667                 $this->unsuppress = $unsuppress;
1668         }
1669
1670         /**
1671          * Add a file by ID
1672          */
1673         function addId( $fa_id ) {
1674                 $this->ids[] = $fa_id;
1675         }
1676
1677         /**
1678          * Add a whole lot of files by ID
1679          */
1680         function addIds( $ids ) {
1681                 $this->ids = array_merge( $this->ids, $ids );
1682         }
1683
1684         /**
1685          * Add all revisions of the file
1686          */
1687         function addAll() {
1688                 $this->all = true;
1689         }
1690
1691         /**
1692          * Run the transaction, except the cleanup batch.
1693          * The cleanup batch should be run in a separate transaction, because it locks different
1694          * rows and there's no need to keep the image row locked while it's acquiring those locks
1695          * The caller may have its own transaction open.
1696          * So we save the batch and let the caller call cleanup()
1697          */
1698         function execute() {
1699                 global $wgLang;
1700
1701                 if ( !$this->all && !$this->ids ) {
1702                         // Do nothing
1703                         return $this->file->repo->newGood();
1704                 }
1705
1706                 $exists = $this->file->lock();
1707                 $dbw = $this->file->repo->getMasterDB();
1708                 $status = $this->file->repo->newGood();
1709
1710                 // Fetch all or selected archived revisions for the file,
1711                 // sorted from the most recent to the oldest.
1712                 $conditions = array( 'fa_name' => $this->file->getName() );
1713
1714                 if ( !$this->all ) {
1715                         $conditions[] = 'fa_id IN (' . $dbw->makeList( $this->ids ) . ')';
1716                 }
1717
1718                 $result = $dbw->select( 'filearchive', '*',
1719                         $conditions,
1720                         __METHOD__,
1721                         array( 'ORDER BY' => 'fa_timestamp DESC' )
1722                 );
1723
1724                 $idsPresent = array();
1725                 $storeBatch = array();
1726                 $insertBatch = array();
1727                 $insertCurrent = false;
1728                 $deleteIds = array();
1729                 $first = true;
1730                 $archiveNames = array();
1731
1732                 foreach ( $result as $row ) {
1733                         $idsPresent[] = $row->fa_id;
1734
1735                         if ( $row->fa_name != $this->file->getName() ) {
1736                                 $status->error( 'undelete-filename-mismatch', $wgLang->timeanddate( $row->fa_timestamp ) );
1737                                 $status->failCount++;
1738                                 continue;
1739                         }
1740
1741                         if ( $row->fa_storage_key == '' ) {
1742                                 // Revision was missing pre-deletion
1743                                 $status->error( 'undelete-bad-store-key', $wgLang->timeanddate( $row->fa_timestamp ) );
1744                                 $status->failCount++;
1745                                 continue;
1746                         }
1747
1748                         $deletedRel = $this->file->repo->getDeletedHashPath( $row->fa_storage_key ) . $row->fa_storage_key;
1749                         $deletedUrl = $this->file->repo->getVirtualUrl() . '/deleted/' . $deletedRel;
1750
1751                         $sha1 = substr( $row->fa_storage_key, 0, strcspn( $row->fa_storage_key, '.' ) );
1752
1753                         # Fix leading zero
1754                         if ( strlen( $sha1 ) == 32 && $sha1[0] == '0' ) {
1755                                 $sha1 = substr( $sha1, 1 );
1756                         }
1757
1758                         if ( is_null( $row->fa_major_mime ) || $row->fa_major_mime == 'unknown'
1759                                 || is_null( $row->fa_minor_mime ) || $row->fa_minor_mime == 'unknown'
1760                                 || is_null( $row->fa_media_type ) || $row->fa_media_type == 'UNKNOWN'
1761                                 || is_null( $row->fa_metadata ) ) {
1762                                 // Refresh our metadata
1763                                 // Required for a new current revision; nice for older ones too. :)
1764                                 $props = RepoGroup::singleton()->getFileProps( $deletedUrl );
1765                         } else {
1766                                 $props = array(
1767                                         'minor_mime' => $row->fa_minor_mime,
1768                                         'major_mime' => $row->fa_major_mime,
1769                                         'media_type' => $row->fa_media_type,
1770                                         'metadata'   => $row->fa_metadata
1771                                 );
1772                         }
1773
1774                         if ( $first && !$exists ) {
1775                                 // This revision will be published as the new current version
1776                                 $destRel = $this->file->getRel();
1777                                 $insertCurrent = array(
1778                                         'img_name'        => $row->fa_name,
1779                                         'img_size'        => $row->fa_size,
1780                                         'img_width'       => $row->fa_width,
1781                                         'img_height'      => $row->fa_height,
1782                                         'img_metadata'    => $props['metadata'],
1783                                         'img_bits'        => $row->fa_bits,
1784                                         'img_media_type'  => $props['media_type'],
1785                                         'img_major_mime'  => $props['major_mime'],
1786                                         'img_minor_mime'  => $props['minor_mime'],
1787                                         'img_description' => $row->fa_description,
1788                                         'img_user'        => $row->fa_user,
1789                                         'img_user_text'   => $row->fa_user_text,
1790                                         'img_timestamp'   => $row->fa_timestamp,
1791                                         'img_sha1'        => $sha1
1792                                 );
1793
1794                                 // The live (current) version cannot be hidden!
1795                                 if ( !$this->unsuppress && $row->fa_deleted ) {
1796                                         $storeBatch[] = array( $deletedUrl, 'public', $destRel );
1797                                         $this->cleanupBatch[] = $row->fa_storage_key;
1798                                 }
1799                         } else {
1800                                 $archiveName = $row->fa_archive_name;
1801
1802                                 if ( $archiveName == '' ) {
1803                                         // This was originally a current version; we
1804                                         // have to devise a new archive name for it.
1805                                         // Format is <timestamp of archiving>!<name>
1806                                         $timestamp = wfTimestamp( TS_UNIX, $row->fa_deleted_timestamp );
1807
1808                                         do {
1809                                                 $archiveName = wfTimestamp( TS_MW, $timestamp ) . '!' . $row->fa_name;
1810                                                 $timestamp++;
1811                                         } while ( isset( $archiveNames[$archiveName] ) );
1812                                 }
1813
1814                                 $archiveNames[$archiveName] = true;
1815                                 $destRel = $this->file->getArchiveRel( $archiveName );
1816                                 $insertBatch[] = array(
1817                                         'oi_name'         => $row->fa_name,
1818                                         'oi_archive_name' => $archiveName,
1819                                         'oi_size'         => $row->fa_size,
1820                                         'oi_width'        => $row->fa_width,
1821                                         'oi_height'       => $row->fa_height,
1822                                         'oi_bits'         => $row->fa_bits,
1823                                         'oi_description'  => $row->fa_description,
1824                                         'oi_user'         => $row->fa_user,
1825                                         'oi_user_text'    => $row->fa_user_text,
1826                                         'oi_timestamp'    => $row->fa_timestamp,
1827                                         'oi_metadata'     => $props['metadata'],
1828                                         'oi_media_type'   => $props['media_type'],
1829                                         'oi_major_mime'   => $props['major_mime'],
1830                                         'oi_minor_mime'   => $props['minor_mime'],
1831                                         'oi_deleted'      => $this->unsuppress ? 0 : $row->fa_deleted,
1832                                         'oi_sha1'         => $sha1 );
1833                         }
1834
1835                         $deleteIds[] = $row->fa_id;
1836
1837                         if ( !$this->unsuppress && $row->fa_deleted & File::DELETED_FILE ) {
1838                                 // private files can stay where they are
1839                                 $status->successCount++;
1840                         } else {
1841                                 $storeBatch[] = array( $deletedUrl, 'public', $destRel );
1842                                 $this->cleanupBatch[] = $row->fa_storage_key;
1843                         }
1844
1845                         $first = false;
1846                 }
1847
1848                 unset( $result );
1849
1850                 // Add a warning to the status object for missing IDs
1851                 $missingIds = array_diff( $this->ids, $idsPresent );
1852
1853                 foreach ( $missingIds as $id ) {
1854                         $status->error( 'undelete-missing-filearchive', $id );
1855                 }
1856
1857                 // Remove missing files from batch, so we don't get errors when undeleting them
1858                 $storeBatch = $this->removeNonexistentFiles( $storeBatch );
1859
1860                 // Run the store batch
1861                 // Use the OVERWRITE_SAME flag to smooth over a common error
1862                 $storeStatus = $this->file->repo->storeBatch( $storeBatch, FileRepo::OVERWRITE_SAME );
1863                 $status->merge( $storeStatus );
1864
1865                 if ( !$status->isGood() ) {
1866                         // Even if some files could be copied, fail entirely as that is the
1867                         // easiest thing to do without data loss
1868                         $this->cleanupFailedBatch( $storeStatus, $storeBatch );
1869                         $status->ok = false;
1870                         $this->file->unlock();
1871
1872                         return $status;
1873                 }
1874
1875                 // Run the DB updates
1876                 // Because we have locked the image row, key conflicts should be rare.
1877                 // If they do occur, we can roll back the transaction at this time with
1878                 // no data loss, but leaving unregistered files scattered throughout the
1879                 // public zone.
1880                 // This is not ideal, which is why it's important to lock the image row.
1881                 if ( $insertCurrent ) {
1882                         $dbw->insert( 'image', $insertCurrent, __METHOD__ );
1883                 }
1884
1885                 if ( $insertBatch ) {
1886                         $dbw->insert( 'oldimage', $insertBatch, __METHOD__ );
1887                 }
1888
1889                 if ( $deleteIds ) {
1890                         $dbw->delete( 'filearchive',
1891                                 array( 'fa_id IN (' . $dbw->makeList( $deleteIds ) . ')' ),
1892                                 __METHOD__ );
1893                 }
1894
1895                 // If store batch is empty (all files are missing), deletion is to be considered successful
1896                 if ( $status->successCount > 0 || !$storeBatch ) {
1897                         if ( !$exists ) {
1898                                 wfDebug( __METHOD__ . " restored {$status->successCount} items, creating a new current\n" );
1899
1900                                 // Update site_stats
1901                                 $site_stats = $dbw->tableName( 'site_stats' );
1902                                 $dbw->query( "UPDATE $site_stats SET ss_images=ss_images+1", __METHOD__ );
1903
1904                                 $this->file->purgeEverything();
1905                         } else {
1906                                 wfDebug( __METHOD__ . " restored {$status->successCount} as archived versions\n" );
1907                                 $this->file->purgeDescription();
1908                                 $this->file->purgeHistory();
1909                         }
1910                 }
1911
1912                 $this->file->unlock();
1913
1914                 return $status;
1915         }
1916
1917         /**
1918          * Removes non-existent files from a store batch.
1919          */
1920         function removeNonexistentFiles( $triplets ) {
1921                 $files = $filteredTriplets = array();
1922                 foreach ( $triplets as $file )
1923                         $files[$file[0]] = $file[0];
1924
1925                 $result = $this->file->repo->fileExistsBatch( $files, FSRepo::FILES_ONLY );
1926
1927                 foreach ( $triplets as $file ) {
1928                         if ( $result[$file[0]] ) {
1929                                 $filteredTriplets[] = $file;
1930                         }
1931                 }
1932
1933                 return $filteredTriplets;
1934         }
1935
1936         /**
1937          * Removes non-existent files from a cleanup batch.
1938          */
1939         function removeNonexistentFromCleanup( $batch ) {
1940                 $files = $newBatch = array();
1941                 $repo = $this->file->repo;
1942
1943                 foreach ( $batch as $file ) {
1944                         $files[$file] = $repo->getVirtualUrl( 'deleted' ) . '/' .
1945                                 rawurlencode( $repo->getDeletedHashPath( $file ) . $file );
1946                 }
1947
1948                 $result = $repo->fileExistsBatch( $files, FSRepo::FILES_ONLY );
1949
1950                 foreach ( $batch as $file ) {
1951                         if ( $result[$file] ) {
1952                                 $newBatch[] = $file;
1953                         }
1954                 }
1955
1956                 return $newBatch;
1957         }
1958
1959         /**
1960          * Delete unused files in the deleted zone.
1961          * This should be called from outside the transaction in which execute() was called.
1962          */
1963         function cleanup() {
1964                 if ( !$this->cleanupBatch ) {
1965                         return $this->file->repo->newGood();
1966                 }
1967
1968                 $this->cleanupBatch = $this->removeNonexistentFromCleanup( $this->cleanupBatch );
1969
1970                 $status = $this->file->repo->cleanupDeletedBatch( $this->cleanupBatch );
1971
1972                 return $status;
1973         }
1974
1975         /**
1976          * Cleanup a failed batch. The batch was only partially successful, so
1977          * rollback by removing all items that were succesfully copied.
1978          *
1979          * @param Status $storeStatus
1980          * @param array $storeBatch
1981          */
1982         function cleanupFailedBatch( $storeStatus, $storeBatch ) {
1983                 $cleanupBatch = array();
1984
1985                 foreach ( $storeStatus->success as $i => $success ) {
1986                         // Check if this item of the batch was successfully copied
1987                         if ( $success ) {
1988                                 // Item was successfully copied and needs to be removed again
1989                                 // Extract ($dstZone, $dstRel) from the batch
1990                                 $cleanupBatch[] = array( $storeBatch[$i][1], $storeBatch[$i][2] );
1991                         }
1992                 }
1993                 $this->file->repo->cleanupBatch( $cleanupBatch );
1994         }
1995 }
1996
1997 # ------------------------------------------------------------------------------
1998
1999 /**
2000  * Helper class for file movement
2001  * @ingroup FileRepo
2002  */
2003 class LocalFileMoveBatch {
2004         var $file, $cur, $olds, $oldCount, $archive, $target, $db;
2005
2006         function __construct( File $file, Title $target ) {
2007                 $this->file = $file;
2008                 $this->target = $target;
2009                 $this->oldHash = $this->file->repo->getHashPath( $this->file->getName() );
2010                 $this->newHash = $this->file->repo->getHashPath( $this->target->getDBkey() );
2011                 $this->oldName = $this->file->getName();
2012                 $this->newName = $this->file->repo->getNameFromTitle( $this->target );
2013                 $this->oldRel = $this->oldHash . $this->oldName;
2014                 $this->newRel = $this->newHash . $this->newName;
2015                 $this->db = $file->repo->getMasterDb();
2016         }
2017
2018         /**
2019          * Add the current image to the batch
2020          */
2021         function addCurrent() {
2022                 $this->cur = array( $this->oldRel, $this->newRel );
2023         }
2024
2025         /**
2026          * Add the old versions of the image to the batch
2027          */
2028         function addOlds() {
2029                 $archiveBase = 'archive';
2030                 $this->olds = array();
2031                 $this->oldCount = 0;
2032
2033                 $result = $this->db->select( 'oldimage',
2034                         array( 'oi_archive_name', 'oi_deleted' ),
2035                         array( 'oi_name' => $this->oldName ),
2036                         __METHOD__
2037                 );
2038
2039                 foreach ( $result as $row ) {
2040                         $oldName = $row->oi_archive_name;
2041                         $bits = explode( '!', $oldName, 2 );
2042
2043                         if ( count( $bits ) != 2 ) {
2044                                 wfDebug( "Old file name missing !: '$oldName' \n" );
2045                                 continue;
2046                         }
2047
2048                         list( $timestamp, $filename ) = $bits;
2049
2050                         if ( $this->oldName != $filename ) {
2051                                 wfDebug( "Old file name doesn't match: '$oldName' \n" );
2052                                 continue;
2053                         }
2054
2055                         $this->oldCount++;
2056
2057                         // Do we want to add those to oldCount?
2058                         if ( $row->oi_deleted & File::DELETED_FILE ) {
2059                                 continue;
2060                         }
2061
2062                         $this->olds[] = array(
2063                                 "{$archiveBase}/{$this->oldHash}{$oldName}",
2064                                 "{$archiveBase}/{$this->newHash}{$timestamp}!{$this->newName}"
2065                         );
2066                 }
2067         }
2068
2069         /**
2070          * Perform the move.
2071          */
2072         function execute() {
2073                 $repo = $this->file->repo;
2074                 $status = $repo->newGood();
2075                 $triplets = $this->getMoveTriplets();
2076
2077                 $triplets = $this->removeNonexistentFiles( $triplets );
2078
2079                 // Copy the files into their new location
2080                 $statusMove = $repo->storeBatch( $triplets );
2081                 wfDebugLog( 'imagemove', "Moved files for {$this->file->name}: {$statusMove->successCount} successes, {$statusMove->failCount} failures" );
2082                 if ( !$statusMove->isGood() ) {
2083                         wfDebugLog( 'imagemove', "Error in moving files: " . $statusMove->getWikiText() );
2084                         $this->cleanupTarget( $triplets );
2085                         $statusMove->ok = false;
2086                         return $statusMove;
2087                 }
2088
2089                 $this->db->begin();
2090                 $statusDb = $this->doDBUpdates();
2091                 wfDebugLog( 'imagemove', "Renamed {$this->file->name} in database: {$statusDb->successCount} successes, {$statusDb->failCount} failures" );
2092                 if ( !$statusDb->isGood() ) {
2093                         $this->db->rollback();
2094                         // Something went wrong with the DB updates, so remove the target files
2095                         $this->cleanupTarget( $triplets );
2096                         $statusDb->ok = false;
2097                         return $statusDb;
2098                 }
2099                 $this->db->commit();
2100
2101                 // Everything went ok, remove the source files
2102                 $this->cleanupSource( $triplets );
2103
2104                 $status->merge( $statusDb );
2105                 $status->merge( $statusMove );
2106
2107                 return $status;
2108         }
2109
2110         /**
2111          * Do the database updates and return a new FileRepoStatus indicating how
2112          * many rows where updated.
2113          *
2114          * @return FileRepoStatus
2115          */
2116         function doDBUpdates() {
2117                 $repo = $this->file->repo;
2118                 $status = $repo->newGood();
2119                 $dbw = $this->db;
2120
2121                 // Update current image
2122                 $dbw->update(
2123                         'image',
2124                         array( 'img_name' => $this->newName ),
2125                         array( 'img_name' => $this->oldName ),
2126                         __METHOD__
2127                 );
2128
2129                 if ( $dbw->affectedRows() ) {
2130                         $status->successCount++;
2131                 } else {
2132                         $status->failCount++;
2133                         $status->fatal( 'imageinvalidfilename' );
2134                         return $status;
2135                 }
2136
2137                 // Update old images
2138                 $dbw->update(
2139                         'oldimage',
2140                         array(
2141                                 'oi_name' => $this->newName,
2142                                 'oi_archive_name = ' . $dbw->strreplace( 'oi_archive_name', $dbw->addQuotes( $this->oldName ), $dbw->addQuotes( $this->newName ) ),
2143                         ),
2144                         array( 'oi_name' => $this->oldName ),
2145                         __METHOD__
2146                 );
2147
2148                 $affected = $dbw->affectedRows();
2149                 $total = $this->oldCount;
2150                 $status->successCount += $affected;
2151                 $status->failCount += $total - $affected;
2152                 if ( $status->failCount ) {
2153                         $status->error( 'imageinvalidfilename' );
2154                 }
2155
2156                 return $status;
2157         }
2158
2159         /**
2160          * Generate triplets for FSRepo::storeBatch().
2161          */
2162         function getMoveTriplets() {
2163                 $moves = array_merge( array( $this->cur ), $this->olds );
2164                 $triplets = array();    // The format is: (srcUrl, destZone, destUrl)
2165
2166                 foreach ( $moves as $move ) {
2167                         // $move: (oldRelativePath, newRelativePath)
2168                         $srcUrl = $this->file->repo->getVirtualUrl() . '/public/' . rawurlencode( $move[0] );
2169                         $triplets[] = array( $srcUrl, 'public', $move[1] );
2170                         wfDebugLog( 'imagemove', "Generated move triplet for {$this->file->name}: {$srcUrl} :: public :: {$move[1]}" );
2171                 }
2172
2173                 return $triplets;
2174         }
2175
2176         /**
2177          * Removes non-existent files from move batch.
2178          */
2179         function removeNonexistentFiles( $triplets ) {
2180                 $files = array();
2181
2182                 foreach ( $triplets as $file ) {
2183                         $files[$file[0]] = $file[0];
2184                 }
2185
2186                 $result = $this->file->repo->fileExistsBatch( $files, FSRepo::FILES_ONLY );
2187                 $filteredTriplets = array();
2188
2189                 foreach ( $triplets as $file ) {
2190                         if ( $result[$file[0]] ) {
2191                                 $filteredTriplets[] = $file;
2192                         } else {
2193                                 wfDebugLog( 'imagemove', "File {$file[0]} does not exist" );
2194                         }
2195                 }
2196
2197                 return $filteredTriplets;
2198         }
2199
2200         /**
2201          * Cleanup a partially moved array of triplets by deleting the target
2202          * files. Called if something went wrong half way.
2203          */
2204         function cleanupTarget( $triplets ) {
2205                 // Create dest pairs from the triplets
2206                 $pairs = array();
2207                 foreach ( $triplets as $triplet ) {
2208                         $pairs[] = array( $triplet[1], $triplet[2] );
2209                 }
2210
2211                 $this->file->repo->cleanupBatch( $pairs );
2212         }
2213
2214         /**
2215          * Cleanup a fully moved array of triplets by deleting the source files.
2216          * Called at the end of the move process if everything else went ok.
2217          */
2218         function cleanupSource( $triplets ) {
2219                 // Create source file names from the triplets
2220                 $files = array();
2221                 foreach ( $triplets as $triplet ) {
2222                         $files[] = $triplet[0];
2223                 }
2224
2225                 $this->file->repo->cleanupBatch( $files );
2226         }
2227 }