includes/filerepo/file/LocalFile.php

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