includes/filerepo/FileRepo.php

   1 <?php
   2 /**
   3  * @defgroup FileRepo File Repository
   4  *
   5  * @brief This module handles how MediaWiki interacts with filesystems.
   6  *
   7  * @details
   8  */
   9
  10 /**
  11  * Base code for file repositories.
  12  *
  13  * This program is free software; you can redistribute it and/or modify
  14  * it under the terms of the GNU General Public License as published by
  15  * the Free Software Foundation; either version 2 of the License, or
  16  * (at your option) any later version.
  17  *
  18  * This program is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  21  * GNU General Public License for more details.
  22  *
  23  * You should have received a copy of the GNU General Public License along
  24  * with this program; if not, write to the Free Software Foundation, Inc.,
  25  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  26  * http://www.gnu.org/copyleft/gpl.html
  27  *
  28  * @file
  29  * @ingroup FileRepo
  30  */
  31
  32 /**
  33  * Base class for file repositories
  34  *
  35  * @ingroup FileRepo
  36  */
  37 class FileRepo {
  38         const DELETE_SOURCE = 1;
  39         const OVERWRITE = 2;
  40         const OVERWRITE_SAME = 4;
  41         const SKIP_LOCKING = 8;
  42
  43         /** @var FileBackend */
  44         protected $backend;
  45         /** @var Array Map of zones to config */
  46         protected $zones = array();
  47
  48         var $thumbScriptUrl, $transformVia404;
  49         var $descBaseUrl, $scriptDirUrl, $scriptExtension, $articleUrl;
  50         var $fetchDescription, $initialCapital;
  51         var $pathDisclosureProtection = 'simple'; // 'paranoid'
  52         var $descriptionCacheExpiry, $url, $thumbUrl;
  53         var $hashLevels, $deletedHashLevels;
  54         protected $abbrvThreshold;
  55
  56         /**
  57          * Factory functions for creating new files
  58          * Override these in the base class
  59          */
  60         var $fileFactory = array( 'UnregisteredLocalFile', 'newFromTitle' );
  61         var $oldFileFactory = false;
  62         var $fileFactoryKey = false, $oldFileFactoryKey = false;
  63
  64         /**
  65          * @param $info array|null
  66          * @throws MWException
  67          */
  68         public function __construct( array $info = null ) {
  69                 // Verify required settings presence
  70                 if(
  71                         $info === null
  72                         || !array_key_exists( 'name', $info )
  73                         || !array_key_exists( 'backend', $info )
  74                 ) {
  75                         throw new MWException( __CLASS__ . " requires an array of options having both 'name' and 'backend' keys.\n" );
  76                 }
  77
  78                 // Required settings
  79                 $this->name = $info['name'];
  80                 if ( $info['backend'] instanceof FileBackend ) {
  81                         $this->backend = $info['backend']; // useful for testing
  82                 } else {
  83                         $this->backend = FileBackendGroup::singleton()->get( $info['backend'] );
  84                 }
  85
  86                 // Optional settings that can have no value
  87                 $optionalSettings = array(
  88                         'descBaseUrl', 'scriptDirUrl', 'articleUrl', 'fetchDescription',
  89                         'thumbScriptUrl', 'pathDisclosureProtection', 'descriptionCacheExpiry',
  90                         'scriptExtension'
  91                 );
  92                 foreach ( $optionalSettings as $var ) {
  93                         if ( isset( $info[$var] ) ) {
  94                                 $this->$var = $info[$var];
  95                         }
  96                 }
  97
  98                 // Optional settings that have a default
  99                 $this->initialCapital = isset( $info['initialCapital'] )
 100                         ? $info['initialCapital']
 101                         : MWNamespace::isCapitalized( NS_FILE );
 102                 $this->url = isset( $info['url'] )
 103                         ? $info['url']
 104                         : false; // a subclass may set the URL (e.g. ForeignAPIRepo)
 105                 if ( isset( $info['thumbUrl'] ) ) {
 106                         $this->thumbUrl = $info['thumbUrl'];
 107                 } else {
 108                         $this->thumbUrl = $this->url ? "{$this->url}/thumb" : false;
 109                 }
 110                 $this->hashLevels = isset( $info['hashLevels'] )
 111                         ? $info['hashLevels']
 112                         : 2;
 113                 $this->deletedHashLevels = isset( $info['deletedHashLevels'] )
 114                         ? $info['deletedHashLevels']
 115                         : $this->hashLevels;
 116                 $this->transformVia404 = !empty( $info['transformVia404'] );
 117                 $this->abbrvThreshold = isset( $info['abbrvThreshold'] )
 118                         ? $info['abbrvThreshold']
 119                         : 255;
 120                 $this->isPrivate = !empty( $info['isPrivate'] );
 121                 // Give defaults for the basic zones...
 122                 $this->zones = isset( $info['zones'] ) ? $info['zones'] : array();
 123                 foreach ( array( 'public', 'thumb', 'transcoded', 'temp', 'deleted' ) as $zone ) {
 124                         if ( !isset( $this->zones[$zone]['container'] ) ) {
 125                                 $this->zones[$zone]['container'] = "{$this->name}-{$zone}";
 126                         }
 127                         if ( !isset( $this->zones[$zone]['directory'] ) ) {
 128                                 $this->zones[$zone]['directory'] = '';
 129                         }
 130                         if ( !isset( $this->zones[$zone]['urlsByExt'] ) ) {
 131                                 $this->zones[$zone]['urlsByExt'] = array();
 132                         }
 133                 }
 134         }
 135
 136         /**
 137          * Get the file backend instance. Use this function wisely.
 138          *
 139          * @return FileBackend
 140          */
 141         public function getBackend() {
 142                 return $this->backend;
 143         }
 144
 145         /**
 146          * Get an explanatory message if this repo is read-only.
 147          * This checks if an administrator disabled writes to the backend.
 148          *
 149          * @return string|bool Returns false if the repo is not read-only
 150          */
 151         public function getReadOnlyReason() {
 152                 return $this->backend->getReadOnlyReason();
 153         }
 154
 155         /**
 156          * Check if a single zone or list of zones is defined for usage
 157          *
 158          * @param $doZones Array Only do a particular zones
 159          * @throws MWException
 160          * @return Status
 161          */
 162         protected function initZones( $doZones = array() ) {
 163                 $status = $this->newGood();
 164                 foreach ( (array)$doZones as $zone ) {
 165                         $root = $this->getZonePath( $zone );
 166                         if ( $root === null ) {
 167                                 throw new MWException( "No '$zone' zone defined in the {$this->name} repo." );
 168                         }
 169                 }
 170                 return $status;
 171         }
 172
 173         /**
 174          * Determine if a string is an mwrepo:// URL
 175          *
 176          * @param $url string
 177          * @return bool
 178          */
 179         public static function isVirtualUrl( $url ) {
 180                 return substr( $url, 0, 9 ) == 'mwrepo://';
 181         }
 182
 183         /**
 184          * Get a URL referring to this repository, with the private mwrepo protocol.
 185          * The suffix, if supplied, is considered to be unencoded, and will be
 186          * URL-encoded before being returned.
 187          *
 188          * @param $suffix string|bool
 189          * @return string
 190          */
 191         public function getVirtualUrl( $suffix = false ) {
 192                 $path = 'mwrepo://' . $this->name;
 193                 if ( $suffix !== false ) {
 194                         $path .= '/' . rawurlencode( $suffix );
 195                 }
 196                 return $path;
 197         }
 198
 199         /**
 200          * Get the URL corresponding to one of the four basic zones
 201          *
 202          * @param $zone String One of: public, deleted, temp, thumb
 203          * @param $ext String|null Optional file extension
 204          * @return String or false
 205          */
 206         public function getZoneUrl( $zone, $ext = null ) {
 207                 if ( in_array( $zone, array( 'public', 'temp', 'thumb', 'transcoded' ) ) ) { // standard public zones
 208                         if ( $ext !== null && isset( $this->zones[$zone]['urlsByExt'][$ext] ) ) {
 209                                 return $this->zones[$zone]['urlsByExt'][$ext]; // custom URL for extension/zone
 210                         } elseif ( isset( $this->zones[$zone]['url'] ) ) {
 211                                 return $this->zones[$zone]['url']; // custom URL for zone
 212                         }
 213                 }
 214                 switch ( $zone ) {
 215                         case 'public':
 216                                 return $this->url;
 217                         case 'temp':
 218                                 return "{$this->url}/temp";
 219                         case 'deleted':
 220                                 return false; // no public URL
 221                         case 'thumb':
 222                                 return $this->thumbUrl;
 223                         case 'transcoded':
 224                                 return "{$this->url}/transcoded";
 225                         default:
 226                                 return false;
 227                 }
 228         }
 229
 230         /**
 231          * Get the thumb zone URL configured to be handled by scripts like thumb_handler.php.
 232          * This is probably only useful for internal requests, such as from a fast frontend server
 233          * to a slower backend server.
 234          *
 235          * Large sites may use a different host name for uploads than for wikis. In any case, the
 236          * wiki configuration is needed in order to use thumb.php. To avoid extracting the wiki ID
 237          * from the URL path, one can configure thumb_handler.php to recognize a special path on the
 238          * same host name as the wiki that is used for viewing thumbnails.
 239          *
 240          * @param $zone String: one of: public, deleted, temp, thumb
 241          * @return String or false
 242          */
 243         public function getZoneHandlerUrl( $zone ) {
 244                 if ( isset( $this->zones[$zone]['handlerUrl'] )
 245                         && in_array( $zone, array( 'public', 'temp', 'thumb', 'transcoded' ) ) )
 246                 {
 247                         return $this->zones[$zone]['handlerUrl'];
 248                 }
 249                 return false;
 250         }
 251
 252         /**
 253          * Get the backend storage path corresponding to a virtual URL.
 254          * Use this function wisely.
 255          *
 256          * @param $url string
 257          * @throws MWException
 258          * @return string
 259          */
 260         public function resolveVirtualUrl( $url ) {
 261                 if ( substr( $url, 0, 9 ) != 'mwrepo://' ) {
 262                         throw new MWException( __METHOD__.': unknown protocol' );
 263                 }
 264                 $bits = explode( '/', substr( $url, 9 ), 3 );
 265                 if ( count( $bits ) != 3 ) {
 266                         throw new MWException( __METHOD__.": invalid mwrepo URL: $url" );
 267                 }
 268                 list( $repo, $zone, $rel ) = $bits;
 269                 if ( $repo !== $this->name ) {
 270                         throw new MWException( __METHOD__.": fetching from a foreign repo is not supported" );
 271                 }
 272                 $base = $this->getZonePath( $zone );
 273                 if ( !$base ) {
 274                         throw new MWException( __METHOD__.": invalid zone: $zone" );
 275                 }
 276                 return $base . '/' . rawurldecode( $rel );
 277         }
 278
 279         /**
 280          * The the storage container and base path of a zone
 281          *
 282          * @param $zone string
 283          * @return Array (container, base path) or (null, null)
 284          */
 285         protected function getZoneLocation( $zone ) {
 286                 if ( !isset( $this->zones[$zone] ) ) {
 287                         return array( null, null ); // bogus
 288                 }
 289                 return array( $this->zones[$zone]['container'], $this->zones[$zone]['directory'] );
 290         }
 291
 292         /**
 293          * Get the storage path corresponding to one of the zones
 294          *
 295          * @param $zone string
 296          * @return string|null Returns null if the zone is not defined
 297          */
 298         public function getZonePath( $zone ) {
 299                 list( $container, $base ) = $this->getZoneLocation( $zone );
 300                 if ( $container === null || $base === null ) {
 301                         return null;
 302                 }
 303                 $backendName = $this->backend->getName();
 304                 if ( $base != '' ) { // may not be set
 305                         $base = "/{$base}";
 306                 }
 307                 return "mwstore://$backendName/{$container}{$base}";
 308         }
 309
 310         /**
 311          * Create a new File object from the local repository
 312          *
 313          * @param $title Mixed: Title object or string
 314          * @param $time Mixed: Time at which the image was uploaded.
 315          *              If this is specified, the returned object will be an
 316          *              instance of the repository's old file class instead of a
 317          *              current file. Repositories not supporting version control
 318          *              should return false if this parameter is set.
 319          * @return File|null A File, or null if passed an invalid Title
 320          */
 321         public function newFile( $title, $time = false ) {
 322                 $title = File::normalizeTitle( $title );
 323                 if ( !$title ) {
 324                         return null;
 325                 }
 326                 if ( $time ) {
 327                         if ( $this->oldFileFactory ) {
 328                                 return call_user_func( $this->oldFileFactory, $title, $this, $time );
 329                         } else {
 330                                 return false;
 331                         }
 332                 } else {
 333                         return call_user_func( $this->fileFactory, $title, $this );
 334                 }
 335         }
 336
 337         /**
 338          * Find an instance of the named file created at the specified time
 339          * Returns false if the file does not exist. Repositories not supporting
 340          * version control should return false if the time is specified.
 341          *
 342          * @param $title Mixed: Title object or string
 343          * @param $options array Associative array of options:
 344          *     time:           requested time for a specific file version, or false for the
 345          *                     current version. An image object will be returned which was
 346          *                     created at the specified time (which may be archived or current).
 347          *
 348          *     ignoreRedirect: If true, do not follow file redirects
 349          *
 350          *     private:        If true, return restricted (deleted) files if the current
 351          *                     user is allowed to view them. Otherwise, such files will not
 352          *                     be found.
 353          * @return File|bool False on failure
 354          */
 355         public function findFile( $title, $options = array() ) {
 356                 $title = File::normalizeTitle( $title );
 357                 if ( !$title ) {
 358                         return false;
 359                 }
 360                 $time = isset( $options['time'] ) ? $options['time'] : false;
 361                 # First try the current version of the file to see if it precedes the timestamp
 362                 $img = $this->newFile( $title );
 363                 if ( !$img ) {
 364                         return false;
 365                 }
 366                 if ( $img->exists() && ( !$time || $img->getTimestamp() == $time ) ) {
 367                         return $img;
 368                 }
 369                 # Now try an old version of the file
 370                 if ( $time !== false ) {
 371                         $img = $this->newFile( $title, $time );
 372                         if ( $img && $img->exists() ) {
 373                                 if ( !$img->isDeleted( File::DELETED_FILE ) ) {
 374                                         return $img; // always OK
 375                                 } elseif ( !empty( $options['private'] ) && $img->userCan( File::DELETED_FILE ) ) {
 376                                         return $img;
 377                                 }
 378                         }
 379                 }
 380
 381                 # Now try redirects
 382                 if ( !empty( $options['ignoreRedirect'] ) ) {
 383                         return false;
 384                 }
 385                 $redir = $this->checkRedirect( $title );
 386                 if ( $redir && $title->getNamespace() == NS_FILE) {
 387                         $img = $this->newFile( $redir );
 388                         if ( !$img ) {
 389                                 return false;
 390                         }
 391                         if ( $img->exists() ) {
 392                                 $img->redirectedFrom( $title->getDBkey() );
 393                                 return $img;
 394                         }
 395                 }
 396                 return false;
 397         }
 398
 399         /**
 400          * Find many files at once.
 401          *
 402          * @param $items array An array of titles, or an array of findFile() options with
 403          *    the "title" option giving the title. Example:
 404          *
 405          *     $findItem = array( 'title' => $title, 'private' => true );
 406          *     $findBatch = array( $findItem );
 407          *     $repo->findFiles( $findBatch );
 408          * @return array
 409          */
 410         public function findFiles( array $items ) {
 411                 $result = array();
 412                 foreach ( $items as $item ) {
 413                         if ( is_array( $item ) ) {
 414                                 $title = $item['title'];
 415                                 $options = $item;
 416                                 unset( $options['title'] );
 417                         } else {
 418                                 $title = $item;
 419                                 $options = array();
 420                         }
 421                         $file = $this->findFile( $title, $options );
 422                         if ( $file ) {
 423                                 $result[$file->getTitle()->getDBkey()] = $file;
 424                         }
 425                 }
 426                 return $result;
 427         }
 428
 429         /**
 430          * Find an instance of the file with this key, created at the specified time
 431          * Returns false if the file does not exist. Repositories not supporting
 432          * version control should return false if the time is specified.
 433          *
 434          * @param $sha1 String base 36 SHA-1 hash
 435          * @param $options array Option array, same as findFile().
 436          * @return File|bool False on failure
 437          */
 438         public function findFileFromKey( $sha1, $options = array() ) {
 439                 $time = isset( $options['time'] ) ? $options['time'] : false;
 440                 # First try to find a matching current version of a file...
 441                 if ( $this->fileFactoryKey ) {
 442                         $img = call_user_func( $this->fileFactoryKey, $sha1, $this, $time );
 443                 } else {
 444                         return false; // find-by-sha1 not supported
 445                 }
 446                 if ( $img && $img->exists() ) {
 447                         return $img;
 448                 }
 449                 # Now try to find a matching old version of a file...
 450                 if ( $time !== false && $this->oldFileFactoryKey ) { // find-by-sha1 supported?
 451                         $img = call_user_func( $this->oldFileFactoryKey, $sha1, $this, $time );
 452                         if ( $img && $img->exists() ) {
 453                                 if ( !$img->isDeleted( File::DELETED_FILE ) ) {
 454                                         return $img; // always OK
 455                                 } elseif ( !empty( $options['private'] ) && $img->userCan( File::DELETED_FILE ) ) {
 456                                         return $img;
 457                                 }
 458                         }
 459                 }
 460                 return false;
 461         }
 462
 463         /**
 464          * Get an array or iterator of file objects for files that have a given
 465          * SHA-1 content hash.
 466          *
 467          * STUB
 468          * @param $hash
 469          * @return array
 470          */
 471         public function findBySha1( $hash ) {
 472                 return array();
 473         }
 474
 475         /**
 476          * Get an array of arrays or iterators of file objects for files that
 477          * have the given SHA-1 content hashes.
 478          *
 479          * @param $hashes array An array of hashes
 480          * @return array An Array of arrays or iterators of file objects and the hash as key
 481          */
 482         public function findBySha1s( array $hashes ) {
 483                 $result = array();
 484                 foreach ( $hashes as $hash ) {
 485                         $files = $this->findBySha1( $hash );
 486                         if ( count( $files ) ) {
 487                                 $result[$hash] = $files;
 488                         }
 489                 }
 490                 return $result;
 491         }
 492
 493         /**
 494          * Return an array of files where the name starts with $prefix.
 495          *
 496          * STUB
 497          * @param string $prefix The prefix to search for
 498          * @param int $limit The maximum amount of files to return
 499          * @return array
 500          */
 501         public function findFilesByPrefix( $prefix, $limit ) {
 502                 return array();
 503         }
 504
 505         /**
 506          * Get the public root URL of the repository
 507          *
 508          * @deprecated since 1.20
 509          * @return string
 510          */
 511         public function getRootUrl() {
 512                 return $this->getZoneUrl( 'public' );
 513         }
 514
 515         /**
 516          * Get the URL of thumb.php
 517          *
 518          * @return string
 519          */
 520         public function getThumbScriptUrl() {
 521                 return $this->thumbScriptUrl;
 522         }
 523
 524         /**
 525          * Returns true if the repository can transform files via a 404 handler
 526          *
 527          * @return bool
 528          */
 529         public function canTransformVia404() {
 530                 return $this->transformVia404;
 531         }
 532
 533         /**
 534          * Get the name of an image from its title object
 535          *
 536          * @param $title Title
 537          * @return String
 538          */
 539         public function getNameFromTitle( Title $title ) {
 540                 global $wgContLang;
 541                 if ( $this->initialCapital != MWNamespace::isCapitalized( NS_FILE ) ) {
 542                         $name = $title->getUserCaseDBKey();
 543                         if ( $this->initialCapital ) {
 544                                 $name = $wgContLang->ucfirst( $name );
 545                         }
 546                 } else {
 547                         $name = $title->getDBkey();
 548                 }
 549                 return $name;
 550         }
 551
 552         /**
 553          * Get the public zone root storage directory of the repository
 554          *
 555          * @return string
 556          */
 557         public function getRootDirectory() {
 558                 return $this->getZonePath( 'public' );
 559         }
 560
 561         /**
 562          * Get a relative path including trailing slash, e.g. f/fa/
 563          * If the repo is not hashed, returns an empty string
 564          *
 565          * @param $name string Name of file
 566          * @return string
 567          */
 568         public function getHashPath( $name ) {
 569                 return self::getHashPathForLevel( $name, $this->hashLevels );
 570         }
 571
 572         /**
 573          * Get a relative path including trailing slash, e.g. f/fa/
 574          * If the repo is not hashed, returns an empty string
 575          *
 576          * @param $suffix string Basename of file from FileRepo::storeTemp()
 577          * @return string
 578          */
 579         public function getTempHashPath( $suffix ) {
 580                 $parts = explode( '!', $suffix, 2 ); // format is <timestamp>!<name> or just <name>
 581                 $name = isset( $parts[1] ) ? $parts[1] : $suffix; // hash path is not based on timestamp
 582                 return self::getHashPathForLevel( $name, $this->hashLevels );
 583         }
 584
 585         /**
 586          * @param $name
 587          * @param $levels
 588          * @return string
 589          */
 590         protected static function getHashPathForLevel( $name, $levels ) {
 591                 if ( $levels == 0 ) {
 592                         return '';
 593                 } else {
 594                         $hash = md5( $name );
 595                         $path = '';
 596                         for ( $i = 1; $i <= $levels; $i++ ) {
 597                                 $path .= substr( $hash, 0, $i ) . '/';
 598                         }
 599                         return $path;
 600                 }
 601         }
 602
 603         /**
 604          * Get the number of hash directory levels
 605          *
 606          * @return integer
 607          */
 608         public function getHashLevels() {
 609                 return $this->hashLevels;
 610         }
 611
 612         /**
 613          * Get the name of this repository, as specified by $info['name]' to the constructor
 614          *
 615          * @return string
 616          */
 617         public function getName() {
 618                 return $this->name;
 619         }
 620
 621         /**
 622          * Make an url to this repo
 623          *
 624          * @param $query mixed Query string to append
 625          * @param $entry string Entry point; defaults to index
 626          * @return string|bool False on failure
 627          */
 628         public function makeUrl( $query = '', $entry = 'index' ) {
 629                 if ( isset( $this->scriptDirUrl ) ) {
 630                         $ext = isset( $this->scriptExtension ) ? $this->scriptExtension : '.php';
 631                         return wfAppendQuery( "{$this->scriptDirUrl}/{$entry}{$ext}", $query );
 632                 }
 633                 return false;
 634         }
 635
 636         /**
 637          * Get the URL of an image description page. May return false if it is
 638          * unknown or not applicable. In general this should only be called by the
 639          * File class, since it may return invalid results for certain kinds of
 640          * repositories. Use File::getDescriptionUrl() in user code.
 641          *
 642          * In particular, it uses the article paths as specified to the repository
 643          * constructor, whereas local repositories use the local Title functions.
 644          *
 645          * @param $name string
 646          * @return string
 647          */
 648         public function getDescriptionUrl( $name ) {
 649                 $encName = wfUrlencode( $name );
 650                 if ( !is_null( $this->descBaseUrl ) ) {
 651                         # "http://example.com/wiki/Image:"
 652                         return $this->descBaseUrl . $encName;
 653                 }
 654                 if ( !is_null( $this->articleUrl ) ) {
 655                         # "http://example.com/wiki/$1"
 656                         #
 657                         # We use "Image:" as the canonical namespace for
 658                         # compatibility across all MediaWiki versions.
 659                         return str_replace( '$1',
 660                                 "Image:$encName", $this->articleUrl );
 661                 }
 662                 if ( !is_null( $this->scriptDirUrl ) ) {
 663                         # "http://example.com/w"
 664                         #
 665                         # We use "Image:" as the canonical namespace for
 666                         # compatibility across all MediaWiki versions,
 667                         # and just sort of hope index.php is right. ;)
 668                         return $this->makeUrl( "title=Image:$encName" );
 669                 }
 670                 return false;
 671         }
 672
 673         /**
 674          * Get the URL of the content-only fragment of the description page. For
 675          * MediaWiki this means action=render. This should only be called by the
 676          * repository's file class, since it may return invalid results. User code
 677          * should use File::getDescriptionText().
 678          *
 679          * @param $name String: name of image to fetch
 680          * @param $lang String: language to fetch it in, if any.
 681          * @return string
 682          */
 683         public function getDescriptionRenderUrl( $name, $lang = null ) {
 684                 $query = 'action=render';
 685                 if ( !is_null( $lang ) ) {
 686                         $query .= '&uselang=' . $lang;
 687                 }
 688                 if ( isset( $this->scriptDirUrl ) ) {
 689                         return $this->makeUrl(
 690                                 'title=' .
 691                                 wfUrlencode( 'Image:' . $name ) .
 692                                 "&$query" );
 693                 } else {
 694                         $descUrl = $this->getDescriptionUrl( $name );
 695                         if ( $descUrl ) {
 696                                 return wfAppendQuery( $descUrl, $query );
 697                         } else {
 698                                 return false;
 699                         }
 700                 }
 701         }
 702
 703         /**
 704          * Get the URL of the stylesheet to apply to description pages
 705          *
 706          * @return string|bool False on failure
 707          */
 708         public function getDescriptionStylesheetUrl() {
 709                 if ( isset( $this->scriptDirUrl ) ) {
 710                         return $this->makeUrl( 'title=MediaWiki:Filepage.css&' .
 711                                 wfArrayToCgi( Skin::getDynamicStylesheetQuery() ) );
 712                 }
 713                 return false;
 714         }
 715
 716         /**
 717          * Store a file to a given destination.
 718          *
 719          * @param $srcPath String: source file system path, storage path, or virtual URL
 720          * @param $dstZone String: destination zone
 721          * @param $dstRel String: destination relative path
 722          * @param $flags Integer: bitwise combination of the following flags:
 723          *     self::DELETE_SOURCE     Delete the source file after upload
 724          *     self::OVERWRITE         Overwrite an existing destination file instead of failing
 725          *     self::OVERWRITE_SAME    Overwrite the file if the destination exists and has the
 726          *                             same contents as the source
 727          *     self::SKIP_LOCKING      Skip any file locking when doing the store
 728          * @return FileRepoStatus
 729          */
 730         public function store( $srcPath, $dstZone, $dstRel, $flags = 0 ) {
 731                 $this->assertWritableRepo(); // fail out if read-only
 732
 733                 $status = $this->storeBatch( array( array( $srcPath, $dstZone, $dstRel ) ), $flags );
 734                 if ( $status->successCount == 0 ) {
 735                         $status->ok = false;
 736                 }
 737
 738                 return $status;
 739         }
 740
 741         /**
 742          * Store a batch of files
 743          *
 744          * @param $triplets Array: (src, dest zone, dest rel) triplets as per store()
 745          * @param $flags Integer: bitwise combination of the following flags:
 746          *     self::DELETE_SOURCE     Delete the source file after upload
 747          *     self::OVERWRITE         Overwrite an existing destination file instead of failing
 748          *     self::OVERWRITE_SAME    Overwrite the file if the destination exists and has the
 749          *                             same contents as the source
 750          *     self::SKIP_LOCKING      Skip any file locking when doing the store
 751          * @throws MWException
 752          * @return FileRepoStatus
 753          */
 754         public function storeBatch( array $triplets, $flags = 0 ) {
 755                 $this->assertWritableRepo(); // fail out if read-only
 756
 757                 $status = $this->newGood();
 758                 $backend = $this->backend; // convenience
 759
 760                 $operations = array();
 761                 $sourceFSFilesToDelete = array(); // cleanup for disk source files
 762                 // Validate each triplet and get the store operation...
 763                 foreach ( $triplets as $triplet ) {
 764                         list( $srcPath, $dstZone, $dstRel ) = $triplet;
 765                         wfDebug( __METHOD__
 766                                 . "( \$src='$srcPath', \$dstZone='$dstZone', \$dstRel='$dstRel' )\n"
 767                         );
 768
 769                         // Resolve destination path
 770                         $root = $this->getZonePath( $dstZone );
 771                         if ( !$root ) {
 772                                 throw new MWException( "Invalid zone: $dstZone" );
 773                         }
 774                         if ( !$this->validateFilename( $dstRel ) ) {
 775                                 throw new MWException( 'Validation error in $dstRel' );
 776                         }
 777                         $dstPath = "$root/$dstRel";
 778                         $dstDir  = dirname( $dstPath );
 779                         // Create destination directories for this triplet
 780                         if ( !$this->initDirectory( $dstDir )->isOK() ) {
 781                                 return $this->newFatal( 'directorycreateerror', $dstDir );
 782                         }
 783
 784                         // Resolve source to a storage path if virtual
 785                         $srcPath = $this->resolveToStoragePath( $srcPath );
 786
 787                         // Get the appropriate file operation
 788                         if ( FileBackend::isStoragePath( $srcPath ) ) {
 789                                 $opName = ( $flags & self::DELETE_SOURCE ) ? 'move' : 'copy';
 790                         } else {
 791                                 $opName = 'store';
 792                                 if ( $flags & self::DELETE_SOURCE ) {
 793                                         $sourceFSFilesToDelete[] = $srcPath;
 794                                 }
 795                         }
 796                         $operations[] = array(
 797                                 'op'            => $opName,
 798                                 'src'           => $srcPath,
 799                                 'dst'           => $dstPath,
 800                                 'overwrite'     => $flags & self::OVERWRITE,
 801                                 'overwriteSame' => $flags & self::OVERWRITE_SAME,
 802                         );
 803                 }
 804
 805                 // Execute the store operation for each triplet
 806                 $opts = array( 'force' => true );
 807                 if ( $flags & self::SKIP_LOCKING ) {
 808                         $opts['nonLocking'] = true;
 809                 }
 810                 $status->merge( $backend->doOperations( $operations, $opts ) );
 811                 // Cleanup for disk source files...
 812                 foreach ( $sourceFSFilesToDelete as $file ) {
 813                         wfSuppressWarnings();
 814                         unlink( $file ); // FS cleanup
 815                         wfRestoreWarnings();
 816                 }
 817
 818                 return $status;
 819         }
 820
 821         /**
 822          * Deletes a batch of files.
 823          * Each file can be a (zone, rel) pair, virtual url, storage path.
 824          * It will try to delete each file, but ignores any errors that may occur.
 825          *
 826          * @param $files array List of files to delete
 827          * @param $flags Integer: bitwise combination of the following flags:
 828          *     self::SKIP_LOCKING      Skip any file locking when doing the deletions
 829          * @return FileRepoStatus
 830          */
 831         public function cleanupBatch( array $files, $flags = 0 ) {
 832                 $this->assertWritableRepo(); // fail out if read-only
 833
 834                 $status = $this->newGood();
 835
 836                 $operations = array();
 837                 foreach ( $files as $path ) {
 838                         if ( is_array( $path ) ) {
 839                                 // This is a pair, extract it
 840                                 list( $zone, $rel ) = $path;
 841                                 $path = $this->getZonePath( $zone ) . "/$rel";
 842                         } else {
 843                                 // Resolve source to a storage path if virtual
 844                                 $path = $this->resolveToStoragePath( $path );
 845                         }
 846                         $operations[] = array( 'op' => 'delete', 'src' => $path );
 847                 }
 848                 // Actually delete files from storage...
 849                 $opts = array( 'force' => true );
 850                 if ( $flags & self::SKIP_LOCKING ) {
 851                         $opts['nonLocking'] = true;
 852                 }
 853                 $status->merge( $this->backend->doOperations( $operations, $opts ) );
 854
 855                 return $status;
 856         }
 857
 858         /**
 859          * Import a file from the local file system into the repo.
 860          * This does no locking nor journaling and overrides existing files.
 861          * This function can be used to write to otherwise read-only foreign repos.
 862          * This is intended for copying generated thumbnails into the repo.
 863          *
 864          * @param $src string Source file system path, storage path, or virtual URL
 865          * @param $dst string Virtual URL or storage path
 866          * @param $disposition string|null Content-Disposition if given and supported
 867          * @return FileRepoStatus
 868          */
 869         final public function quickImport( $src, $dst, $disposition = null ) {
 870                 return $this->quickImportBatch( array( array( $src, $dst, $disposition ) ) );
 871         }
 872
 873         /**
 874          * Purge a file from the repo. This does no locking nor journaling.
 875          * This function can be used to write to otherwise read-only foreign repos.
 876          * This is intended for purging thumbnails.
 877          *
 878          * @param $path string Virtual URL or storage path
 879          * @return FileRepoStatus
 880          */
 881         final public function quickPurge( $path ) {
 882                 return $this->quickPurgeBatch( array( $path ) );
 883         }
 884
 885         /**
 886          * Deletes a directory if empty.
 887          * This function can be used to write to otherwise read-only foreign repos.
 888          *
 889          * @param $dir string Virtual URL (or storage path) of directory to clean
 890          * @return Status
 891          */
 892         public function quickCleanDir( $dir ) {
 893                 $status = $this->newGood();
 894                 $status->merge( $this->backend->clean(
 895                         array( 'dir' => $this->resolveToStoragePath( $dir ) ) ) );
 896
 897                 return $status;
 898         }
 899
 900         /**
 901          * Import a batch of files from the local file system into the repo.
 902          * This does no locking nor journaling and overrides existing files.
 903          * This function can be used to write to otherwise read-only foreign repos.
 904          * This is intended for copying generated thumbnails into the repo.
 905          *
 906          * All path parameters may be a file system path, storage path, or virtual URL.
 907          * When "dispositions" are given they are used as Content-Disposition if supported.
 908          *
 909          * @param $triples Array List of (source path, destination path, disposition)
 910          * @return FileRepoStatus
 911          */
 912         public function quickImportBatch( array $triples ) {
 913                 $status = $this->newGood();
 914                 $operations = array();
 915                 foreach ( $triples as $triple ) {
 916                         list( $src, $dst ) = $triple;
 917                         $src = $this->resolveToStoragePath( $src );
 918                         $dst = $this->resolveToStoragePath( $dst );
 919                         $operations[] = array(
 920                                 'op'          => FileBackend::isStoragePath( $src ) ? 'copy' : 'store',
 921                                 'src'         => $src,
 922                                 'dst'         => $dst,
 923                                 'disposition' => isset( $triple[2] ) ? $triple[2] : null
 924                         );
 925                         $status->merge( $this->initDirectory( dirname( $dst ) ) );
 926                 }
 927                 $status->merge( $this->backend->doQuickOperations( $operations ) );
 928
 929                 return $status;
 930         }
 931
 932         /**
 933          * Purge a batch of files from the repo.
 934          * This function can be used to write to otherwise read-only foreign repos.
 935          * This does no locking nor journaling and is intended for purging thumbnails.
 936          *
 937          * @param $paths Array List of virtual URLs or storage paths
 938          * @return FileRepoStatus
 939          */
 940         public function quickPurgeBatch( array $paths ) {
 941                 $status = $this->newGood();
 942                 $operations = array();
 943                 foreach ( $paths as $path ) {
 944                         $operations[] = array(
 945                                 'op'                  => 'delete',
 946                                 'src'                 => $this->resolveToStoragePath( $path ),
 947                                 'ignoreMissingSource' => true
 948                         );
 949                 }
 950                 $status->merge( $this->backend->doQuickOperations( $operations ) );
 951
 952                 return $status;
 953         }
 954
 955         /**
 956          * Pick a random name in the temp zone and store a file to it.
 957          * Returns a FileRepoStatus object with the file Virtual URL in the value,
 958          * file can later be disposed using FileRepo::freeTemp().
 959          *
 960          * @param $originalName String: the base name of the file as specified
 961          *     by the user. The file extension will be maintained.
 962          * @param $srcPath String: the current location of the file.
 963          * @return FileRepoStatus object with the URL in the value.
 964          */
 965         public function storeTemp( $originalName, $srcPath ) {
 966                 $this->assertWritableRepo(); // fail out if read-only
 967
 968                 $date       = gmdate( "YmdHis" );
 969                 $hashPath   = $this->getHashPath( $originalName );
 970                 $dstRel     = "{$hashPath}{$date}!{$originalName}";
 971                 $dstUrlRel  = $hashPath . $date . '!' . rawurlencode( $originalName );
 972                 $virtualUrl = $this->getVirtualUrl( 'temp' ) . '/' . $dstUrlRel;
 973
 974                 $result = $this->quickImport( $srcPath, $virtualUrl );
 975                 $result->value = $virtualUrl;
 976
 977                 return $result;
 978         }
 979
 980         /**
 981          * Remove a temporary file or mark it for garbage collection
 982          *
 983          * @param $virtualUrl String: the virtual URL returned by FileRepo::storeTemp()
 984          * @return Boolean: true on success, false on failure
 985          */
 986         public function freeTemp( $virtualUrl ) {
 987                 $this->assertWritableRepo(); // fail out if read-only
 988
 989                 $temp = $this->getVirtualUrl( 'temp' );
 990                 if ( substr( $virtualUrl, 0, strlen( $temp ) ) != $temp ) {
 991                         wfDebug( __METHOD__.": Invalid temp virtual URL\n" );
 992                         return false;
 993                 }
 994
 995                 return $this->quickPurge( $virtualUrl )->isOK();
 996         }
 997
 998         /**
 999          * Concatenate a list of temporary files into a target file location.
1000          *
1001          * @param $srcPaths Array Ordered list of source virtual URLs/storage paths
1002          * @param $dstPath String Target file system path
1003          * @param $flags Integer: bitwise combination of the following flags:
1004          *     self::DELETE_SOURCE     Delete the source files
1005          * @return FileRepoStatus
1006          */
1007         public function concatenate( array $srcPaths, $dstPath, $flags = 0 ) {
1008                 $this->assertWritableRepo(); // fail out if read-only
1009
1010                 $status = $this->newGood();
1011
1012                 $sources = array();
1013                 foreach ( $srcPaths as $srcPath ) {
1014                         // Resolve source to a storage path if virtual
1015                         $source = $this->resolveToStoragePath( $srcPath );
1016                         $sources[] = $source; // chunk to merge
1017                 }
1018
1019                 // Concatenate the chunks into one FS file
1020                 $params = array( 'srcs' => $sources, 'dst' => $dstPath );
1021                 $status->merge( $this->backend->concatenate( $params ) );
1022                 if ( !$status->isOK() ) {
1023                         return $status;
1024                 }
1025
1026                 // Delete the sources if required
1027                 if ( $flags & self::DELETE_SOURCE ) {
1028                         $status->merge( $this->quickPurgeBatch( $srcPaths ) );
1029                 }
1030
1031                 // Make sure status is OK, despite any quickPurgeBatch() fatals
1032                 $status->setResult( true );
1033
1034                 return $status;
1035         }
1036
1037         /**
1038          * Copy or move a file either from a storage path, virtual URL,
1039          * or file system path, into this repository at the specified destination location.
1040          *
1041          * Returns a FileRepoStatus object. On success, the value contains "new" or
1042          * "archived", to indicate whether the file was new with that name.
1043          *
1044          * Options to $options include:
1045          *   - headers : name/value map of HTTP headers to use in response to GET/HEAD requests
1046          *
1047          * @param $srcPath String: the source file system path, storage path, or URL
1048          * @param $dstRel String: the destination relative path
1049          * @param $archiveRel String: the relative path where the existing file is to
1050          *        be archived, if there is one. Relative to the public zone root.
1051          * @param $flags Integer: bitfield, may be FileRepo::DELETE_SOURCE to indicate
1052          *        that the source file should be deleted if possible
1053          * @param $options Array Optional additional parameters
1054          * @return FileRepoStatus
1055          */
1056         public function publish(
1057                 $srcPath, $dstRel, $archiveRel, $flags = 0, array $options = array()
1058         ) {
1059                 $this->assertWritableRepo(); // fail out if read-only
1060
1061                 $status = $this->publishBatch(
1062                         array( array( $srcPath, $dstRel, $archiveRel, $options ) ), $flags );
1063                 if ( $status->successCount == 0 ) {
1064                         $status->ok = false;
1065                 }
1066                 if ( isset( $status->value[0] ) ) {
1067                         $status->value = $status->value[0];
1068                 } else {
1069                         $status->value = false;
1070                 }
1071
1072                 return $status;
1073         }
1074
1075         /**
1076          * Publish a batch of files
1077          *
1078          * @param $ntuples Array: (source, dest, archive) triplets or
1079          *        (source, dest, archive, options) 4-tuples as per publish().
1080          * @param $flags Integer: bitfield, may be FileRepo::DELETE_SOURCE to indicate
1081          *        that the source files should be deleted if possible
1082          * @throws MWException
1083          * @return FileRepoStatus
1084          */
1085         public function publishBatch( array $ntuples, $flags = 0 ) {
1086                 $this->assertWritableRepo(); // fail out if read-only
1087
1088                 $backend = $this->backend; // convenience
1089                 // Try creating directories
1090                 $status = $this->initZones( 'public' );
1091                 if ( !$status->isOK() ) {
1092                         return $status;
1093                 }
1094
1095                 $status = $this->newGood( array() );
1096
1097                 $operations = array();
1098                 $sourceFSFilesToDelete = array(); // cleanup for disk source files
1099                 // Validate each triplet and get the store operation...
1100                 foreach ( $ntuples as $i => $ntuple ) {
1101                         list( $srcPath, $dstRel, $archiveRel ) = $ntuple;
1102                         $options = isset( $ntuple[3] ) ? $ntuple[3] : array();
1103                         // Resolve source to a storage path if virtual
1104                         $srcPath = $this->resolveToStoragePath( $srcPath );
1105                         if ( !$this->validateFilename( $dstRel ) ) {
1106                                 throw new MWException( 'Validation error in $dstRel' );
1107                         }
1108                         if ( !$this->validateFilename( $archiveRel ) ) {
1109                                 throw new MWException( 'Validation error in $archiveRel' );
1110                         }
1111
1112                         $publicRoot = $this->getZonePath( 'public' );
1113                         $dstPath = "$publicRoot/$dstRel";
1114                         $archivePath = "$publicRoot/$archiveRel";
1115
1116                         $dstDir = dirname( $dstPath );
1117                         $archiveDir = dirname( $archivePath );
1118                         // Abort immediately on directory creation errors since they're likely to be repetitive
1119                         if ( !$this->initDirectory( $dstDir )->isOK() ) {
1120                                 return $this->newFatal( 'directorycreateerror', $dstDir );
1121                         }
1122                         if ( !$this->initDirectory( $archiveDir )->isOK() ) {
1123                                 return $this->newFatal( 'directorycreateerror', $archiveDir );
1124                         }
1125
1126                         // Set any desired headers to be use in GET/HEAD responses
1127                         $headers = isset( $options['headers'] ) ? $options['headers'] : array();
1128
1129                         // Archive destination file if it exists.
1130                         // This will check if the archive file also exists and fail if does.
1131                         // This is a sanity check to avoid data loss. On Windows and Linux,
1132                         // copy() will overwrite, so the existence check is vulnerable to
1133                         // race conditions unless an functioning LockManager is used.
1134                         // LocalFile also uses SELECT FOR UPDATE for synchronization.
1135                         $operations[] = array(
1136                                 'op'                  => 'copy',
1137                                 'src'                 => $dstPath,
1138                                 'dst'                 => $archivePath,
1139                                 'ignoreMissingSource' => true
1140                         );
1141
1142                         // Copy (or move) the source file to the destination
1143                         if ( FileBackend::isStoragePath( $srcPath ) ) {
1144                                 if ( $flags & self::DELETE_SOURCE ) {
1145                                         $operations[] = array(
1146                                                 'op'        => 'move',
1147                                                 'src'       => $srcPath,
1148                                                 'dst'       => $dstPath,
1149                                                 'overwrite' => true, // replace current
1150                                                 'headers'   => $headers
1151                                         );
1152                                 } else {
1153                                         $operations[] = array(
1154                                                 'op'        => 'copy',
1155                                                 'src'       => $srcPath,
1156                                                 'dst'       => $dstPath,
1157                                                 'overwrite' => true, // replace current
1158                                                 'headers'   => $headers
1159                                         );
1160                                 }
1161                         } else { // FS source path
1162                                 $operations[] = array(
1163                                         'op'        => 'store',
1164                                         'src'       => $srcPath,
1165                                         'dst'       => $dstPath,
1166                                         'overwrite' => true, // replace current
1167                                         'headers'   => $headers
1168                                 );
1169                                 if ( $flags & self::DELETE_SOURCE ) {
1170                                         $sourceFSFilesToDelete[] = $srcPath;
1171                                 }
1172                         }
1173                 }
1174
1175                 // Execute the operations for each triplet
1176                 $status->merge( $backend->doOperations( $operations ) );
1177                 // Find out which files were archived...
1178                 foreach ( $ntuples as $i => $ntuple ) {
1179                         list( $srcPath, $dstRel, $archiveRel ) = $ntuple;
1180                         $archivePath = $this->getZonePath( 'public' ) . "/$archiveRel";
1181                         if ( $this->fileExists( $archivePath ) ) {
1182                                 $status->value[$i] = 'archived';
1183                         } else {
1184                                 $status->value[$i] = 'new';
1185                         }
1186                 }
1187                 // Cleanup for disk source files...
1188                 foreach ( $sourceFSFilesToDelete as $file ) {
1189                         wfSuppressWarnings();
1190                         unlink( $file ); // FS cleanup
1191                         wfRestoreWarnings();
1192                 }
1193
1194                 return $status;
1195         }
1196
1197         /**
1198          * Creates a directory with the appropriate zone permissions.
1199          * Callers are responsible for doing read-only and "writable repo" checks.
1200          *
1201          * @param $dir string Virtual URL (or storage path) of directory to clean
1202          * @return Status
1203          */
1204         protected function initDirectory( $dir ) {
1205                 $path = $this->resolveToStoragePath( $dir );
1206                 list( $b, $container, $r ) = FileBackend::splitStoragePath( $path );
1207
1208                 $params = array( 'dir' => $path );
1209                 if ( $this->isPrivate || $container === $this->zones['deleted']['container'] ) {
1210                         # Take all available measures to prevent web accessibility of new deleted
1211                         # directories, in case the user has not configured offline storage
1212                         $params = array( 'noAccess' => true, 'noListing' => true ) + $params;
1213                 }
1214
1215                 return $this->backend->prepare( $params );
1216         }
1217
1218         /**
1219          * Deletes a directory if empty.
1220          *
1221          * @param $dir string Virtual URL (or storage path) of directory to clean
1222          * @return Status
1223          */
1224         public function cleanDir( $dir ) {
1225                 $this->assertWritableRepo(); // fail out if read-only
1226
1227                 $status = $this->newGood();
1228                 $status->merge( $this->backend->clean(
1229                         array( 'dir' => $this->resolveToStoragePath( $dir ) ) ) );
1230
1231                 return $status;
1232         }
1233
1234         /**
1235          * Checks existence of a a file
1236          *
1237          * @param $file string Virtual URL (or storage path) of file to check
1238          * @return bool
1239          */
1240         public function fileExists( $file ) {
1241                 $result = $this->fileExistsBatch( array( $file ) );
1242                 return $result[0];
1243         }
1244
1245         /**
1246          * Checks existence of an array of files.
1247          *
1248          * @param $files Array: Virtual URLs (or storage paths) of files to check
1249          * @return array|bool Either array of files and existence flags, or false
1250          */
1251         public function fileExistsBatch( array $files ) {
1252                 $result = array();
1253                 foreach ( $files as $key => $file ) {
1254                         $file = $this->resolveToStoragePath( $file );
1255                         $result[$key] = $this->backend->fileExists( array( 'src' => $file ) );
1256                 }
1257                 return $result;
1258         }
1259
1260         /**
1261          * Move a file to the deletion archive.
1262          * If no valid deletion archive exists, this may either delete the file
1263          * or throw an exception, depending on the preference of the repository
1264          *
1265          * @param $srcRel Mixed: relative path for the file to be deleted
1266          * @param $archiveRel Mixed: relative path for the archive location.
1267          *        Relative to a private archive directory.
1268          * @return FileRepoStatus object
1269          */
1270         public function delete( $srcRel, $archiveRel ) {
1271                 $this->assertWritableRepo(); // fail out if read-only
1272
1273                 return $this->deleteBatch( array( array( $srcRel, $archiveRel ) ) );
1274         }
1275
1276         /**
1277          * Move a group of files to the deletion archive.
1278          *
1279          * If no valid deletion archive is configured, this may either delete the
1280          * file or throw an exception, depending on the preference of the repository.
1281          *
1282          * The overwrite policy is determined by the repository -- currently LocalRepo
1283          * assumes a naming scheme in the deleted zone based on content hash, as
1284          * opposed to the public zone which is assumed to be unique.
1285          *
1286          * @param $sourceDestPairs Array of source/destination pairs. Each element
1287          *        is a two-element array containing the source file path relative to the
1288          *        public root in the first element, and the archive file path relative
1289          *        to the deleted zone root in the second element.
1290          * @throws MWException
1291          * @return FileRepoStatus
1292          */
1293         public function deleteBatch( array $sourceDestPairs ) {
1294                 $this->assertWritableRepo(); // fail out if read-only
1295
1296                 // Try creating directories
1297                 $status = $this->initZones( array( 'public', 'deleted' ) );
1298                 if ( !$status->isOK() ) {
1299                         return $status;
1300                 }
1301
1302                 $status = $this->newGood();
1303
1304                 $backend = $this->backend; // convenience
1305                 $operations = array();
1306                 // Validate filenames and create archive directories
1307                 foreach ( $sourceDestPairs as $pair ) {
1308                         list( $srcRel, $archiveRel ) = $pair;
1309                         if ( !$this->validateFilename( $srcRel ) ) {
1310                                 throw new MWException( __METHOD__.':Validation error in $srcRel' );
1311                         } elseif ( !$this->validateFilename( $archiveRel ) ) {
1312                                 throw new MWException( __METHOD__.':Validation error in $archiveRel' );
1313                         }
1314
1315                         $publicRoot = $this->getZonePath( 'public' );
1316                         $srcPath = "{$publicRoot}/$srcRel";
1317
1318                         $deletedRoot = $this->getZonePath( 'deleted' );
1319                         $archivePath = "{$deletedRoot}/{$archiveRel}";
1320                         $archiveDir = dirname( $archivePath ); // does not touch FS
1321
1322                         // Create destination directories
1323                         if ( !$this->initDirectory( $archiveDir )->isOK() ) {
1324                                 return $this->newFatal( 'directorycreateerror', $archiveDir );
1325                         }
1326
1327                         $operations[] = array(
1328                                 'op'            => 'move',
1329                                 'src'           => $srcPath,
1330                                 'dst'           => $archivePath,
1331                                 // We may have 2+ identical files being deleted,
1332                                 // all of which will map to the same destination file
1333                                 'overwriteSame' => true // also see bug 31792
1334                         );
1335                 }
1336
1337                 // Move the files by execute the operations for each pair.
1338                 // We're now committed to returning an OK result, which will
1339                 // lead to the files being moved in the DB also.
1340                 $opts = array( 'force' => true );
1341                 $status->merge( $backend->doOperations( $operations, $opts ) );
1342
1343                 return $status;
1344         }
1345
1346         /**
1347          * Delete files in the deleted directory if they are not referenced in the filearchive table
1348          *
1349          * STUB
1350          */
1351         public function cleanupDeletedBatch( array $storageKeys ) {
1352                 $this->assertWritableRepo();
1353         }
1354
1355         /**
1356          * Get a relative path for a deletion archive key,
1357          * e.g. s/z/a/ for sza251lrxrc1jad41h5mgilp8nysje52.jpg
1358          *
1359          * @param $key string
1360          * @throws MWException
1361          * @return string
1362          */
1363         public function getDeletedHashPath( $key ) {
1364                 if ( strlen( $key ) < 31 ) {
1365                         throw new MWException( "Invalid storage key '$key'." );
1366                 }
1367                 $path = '';
1368                 for ( $i = 0; $i < $this->deletedHashLevels; $i++ ) {
1369                         $path .= $key[$i] . '/';
1370                 }
1371                 return $path;
1372         }
1373
1374         /**
1375          * If a path is a virtual URL, resolve it to a storage path.
1376          * Otherwise, just return the path as it is.
1377          *
1378          * @param $path string
1379          * @return string
1380          * @throws MWException
1381          */
1382         protected function resolveToStoragePath( $path ) {
1383                 if ( $this->isVirtualUrl( $path ) ) {
1384                         return $this->resolveVirtualUrl( $path );
1385                 }
1386                 return $path;
1387         }
1388
1389         /**
1390          * Get a local FS copy of a file with a given virtual URL/storage path.
1391          * Temporary files may be purged when the file object falls out of scope.
1392          *
1393          * @param $virtualUrl string
1394          * @return TempFSFile|null Returns null on failure
1395          */
1396         public function getLocalCopy( $virtualUrl ) {
1397                 $path = $this->resolveToStoragePath( $virtualUrl );
1398                 return $this->backend->getLocalCopy( array( 'src' => $path ) );
1399         }
1400
1401         /**
1402          * Get a local FS file with a given virtual URL/storage path.
1403          * The file is either an original or a copy. It should not be changed.
1404          * Temporary files may be purged when the file object falls out of scope.
1405          *
1406          * @param $virtualUrl string
1407          * @return FSFile|null Returns null on failure.
1408          */
1409         public function getLocalReference( $virtualUrl ) {
1410                 $path = $this->resolveToStoragePath( $virtualUrl );
1411                 return $this->backend->getLocalReference( array( 'src' => $path ) );
1412         }
1413
1414         /**
1415          * Get properties of a file with a given virtual URL/storage path.
1416          * Properties should ultimately be obtained via FSFile::getProps().
1417          *
1418          * @param $virtualUrl string
1419          * @return Array
1420          */
1421         public function getFileProps( $virtualUrl ) {
1422                 $path = $this->resolveToStoragePath( $virtualUrl );
1423                 return $this->backend->getFileProps( array( 'src' => $path ) );
1424         }
1425
1426         /**
1427          * Get the timestamp of a file with a given virtual URL/storage path
1428          *
1429          * @param $virtualUrl string
1430          * @return string|bool False on failure
1431          */
1432         public function getFileTimestamp( $virtualUrl ) {
1433                 $path = $this->resolveToStoragePath( $virtualUrl );
1434                 return $this->backend->getFileTimestamp( array( 'src' => $path ) );
1435         }
1436
1437         /**
1438          * Get the size of a file with a given virtual URL/storage path
1439          *
1440          * @param $virtualUrl string
1441          * @return integer|bool False on failure
1442          */
1443         public function getFileSize( $virtualUrl ) {
1444                 $path = $this->resolveToStoragePath( $virtualUrl );
1445                 return $this->backend->getFileSize( array( 'src' => $path ) );
1446         }
1447
1448         /**
1449          * Get the sha1 (base 36) of a file with a given virtual URL/storage path
1450          *
1451          * @param $virtualUrl string
1452          * @return string|bool
1453          */
1454         public function getFileSha1( $virtualUrl ) {
1455                 $path = $this->resolveToStoragePath( $virtualUrl );
1456                 return $this->backend->getFileSha1Base36( array( 'src' => $path ) );
1457         }
1458
1459         /**
1460          * Attempt to stream a file with the given virtual URL/storage path
1461          *
1462          * @param $virtualUrl string
1463          * @param $headers Array Additional HTTP headers to send on success
1464          * @return bool Success
1465          */
1466         public function streamFile( $virtualUrl, $headers = array() ) {
1467                 $path = $this->resolveToStoragePath( $virtualUrl );
1468                 $params = array( 'src' => $path, 'headers' => $headers );
1469                 return $this->backend->streamFile( $params )->isOK();
1470         }
1471
1472         /**
1473          * Call a callback function for every public regular file in the repository.
1474          * This only acts on the current version of files, not any old versions.
1475          * May use either the database or the filesystem.
1476          *
1477          * @param $callback Array|string
1478          * @return void
1479          */
1480         public function enumFiles( $callback ) {
1481                 $this->enumFilesInStorage( $callback );
1482         }
1483
1484         /**
1485          * Call a callback function for every public file in the repository.
1486          * May use either the database or the filesystem.
1487          *
1488          * @param $callback Array|string
1489          * @return void
1490          */
1491         protected function enumFilesInStorage( $callback ) {
1492                 $publicRoot = $this->getZonePath( 'public' );
1493                 $numDirs = 1 << ( $this->hashLevels * 4 );
1494                 // Use a priori assumptions about directory structure
1495                 // to reduce the tree height of the scanning process.
1496                 for ( $flatIndex = 0; $flatIndex < $numDirs; $flatIndex++ ) {
1497                         $hexString = sprintf( "%0{$this->hashLevels}x", $flatIndex );
1498                         $path = $publicRoot;
1499                         for ( $hexPos = 0; $hexPos < $this->hashLevels; $hexPos++ ) {
1500                                 $path .= '/' . substr( $hexString, 0, $hexPos + 1 );
1501                         }
1502                         $iterator = $this->backend->getFileList( array( 'dir' => $path ) );
1503                         foreach ( $iterator as $name ) {
1504                                 // Each item returned is a public file
1505                                 call_user_func( $callback, "{$path}/{$name}" );
1506                         }
1507                 }
1508         }
1509
1510         /**
1511          * Determine if a relative path is valid, i.e. not blank or involving directory traveral
1512          *
1513          * @param $filename string
1514          * @return bool
1515          */
1516         public function validateFilename( $filename ) {
1517                 if ( strval( $filename ) == '' ) {
1518                         return false;
1519                 }
1520                 return FileBackend::isPathTraversalFree( $filename );
1521         }
1522
1523         /**
1524          * Get a callback function to use for cleaning error message parameters
1525          *
1526          * @return Array
1527          */
1528         function getErrorCleanupFunction() {
1529                 switch ( $this->pathDisclosureProtection ) {
1530                         case 'none':
1531                         case 'simple': // b/c
1532                                 $callback = array( $this, 'passThrough' );
1533                                 break;
1534                         default: // 'paranoid'
1535                                 $callback = array( $this, 'paranoidClean' );
1536                 }
1537                 return $callback;
1538         }
1539
1540         /**
1541          * Path disclosure protection function
1542          *
1543          * @param $param string
1544          * @return string
1545          */
1546         function paranoidClean( $param ) {
1547                 return '[hidden]';
1548         }
1549
1550         /**
1551          * Path disclosure protection function
1552          *
1553          * @param $param string
1554          * @return string
1555          */
1556         function passThrough( $param ) {
1557                 return $param;
1558         }
1559
1560         /**
1561          * Create a new fatal error
1562          *
1563          * @return FileRepoStatus
1564          */
1565         public function newFatal( $message /*, parameters...*/ ) {
1566                 $params = func_get_args();
1567                 array_unshift( $params, $this );
1568                 return MWInit::callStaticMethod( 'FileRepoStatus', 'newFatal', $params );
1569         }
1570
1571         /**
1572          * Create a new good result
1573          *
1574          * @param $value null|string
1575          * @return FileRepoStatus
1576          */
1577         public function newGood( $value = null ) {
1578                 return FileRepoStatus::newGood( $this, $value );
1579         }
1580
1581         /**
1582          * Checks if there is a redirect named as $title. If there is, return the
1583          * title object. If not, return false.
1584          * STUB
1585          *
1586          * @param $title Title of image
1587          * @return Bool
1588          */
1589         public function checkRedirect( Title $title ) {
1590                 return false;
1591         }
1592
1593         /**
1594          * Invalidates image redirect cache related to that image
1595          * Doesn't do anything for repositories that don't support image redirects.
1596          *
1597          * STUB
1598          * @param $title Title of image
1599          */
1600         public function invalidateImageRedirect( Title $title ) {}
1601
1602         /**
1603          * Get the human-readable name of the repo
1604          *
1605          * @return string
1606          */
1607         public function getDisplayName() {
1608                 // We don't name our own repo, return nothing
1609                 if ( $this->isLocal() ) {
1610                         return null;
1611                 }
1612                 // 'shared-repo-name-wikimediacommons' is used when $wgUseInstantCommons = true
1613                 return wfMessageFallback( 'shared-repo-name-' . $this->name, 'shared-repo' )->text();
1614         }
1615
1616         /**
1617          * Get the portion of the file that contains the origin file name.
1618          * If that name is too long, then the name "thumbnail.<ext>" will be given.
1619          *
1620          * @param $name string
1621          * @return string
1622          */
1623         public function nameForThumb( $name ) {
1624                 if ( strlen( $name ) > $this->abbrvThreshold ) {
1625                         $ext  = FileBackend::extensionFromPath( $name );
1626                         $name = ( $ext == '' ) ? 'thumbnail' : "thumbnail.$ext";
1627                 }
1628                 return $name;
1629         }
1630
1631         /**
1632          * Returns true if this the local file repository.
1633          *
1634          * @return bool
1635          */
1636         public function isLocal() {
1637                 return $this->getName() == 'local';
1638         }
1639
1640         /**
1641          * Get a key on the primary cache for this repository.
1642          * Returns false if the repository's cache is not accessible at this site.
1643          * The parameters are the parts of the key, as for wfMemcKey().
1644          *
1645          * STUB
1646          * @return bool
1647          */
1648         public function getSharedCacheKey( /*...*/ ) {
1649                 return false;
1650         }
1651
1652         /**
1653          * Get a key for this repo in the local cache domain. These cache keys are
1654          * not shared with remote instances of the repo.
1655          * The parameters are the parts of the key, as for wfMemcKey().
1656          *
1657          * @return string
1658          */
1659         public function getLocalCacheKey( /*...*/ ) {
1660                 $args = func_get_args();
1661                 array_unshift( $args, 'filerepo', $this->getName() );
1662                 return call_user_func_array( 'wfMemcKey', $args );
1663         }
1664
1665         /**
1666          * Get an temporary FileRepo associated with this repo.
1667          * Files will be created in the temp zone of this repo and
1668          * thumbnails in a /temp subdirectory in thumb zone of this repo.
1669          * It will have the same backend as this repo.
1670          *
1671          * @return TempFileRepo
1672          */
1673         public function getTempRepo() {
1674                 return new TempFileRepo( array(
1675                         'name'      => "{$this->name}-temp",
1676                         'backend'   => $this->backend,
1677                         'zones'     => array(
1678                                 'public' => array(
1679                                         'container' => $this->zones['temp']['container'],
1680                                         'directory' => $this->zones['temp']['directory']
1681                                 ),
1682                                 'thumb'  => array(
1683                                         'container' => $this->zones['thumb']['container'],
1684                                         'directory' => ( $this->zones['thumb']['directory'] == '' )
1685                                                 ? 'temp'
1686                                                 : $this->zones['thumb']['directory'] . '/temp'
1687                                 ),
1688                                 'transcoded'  => array(
1689                                         'container' => $this->zones['transcoded']['container'],
1690                                         'directory' => ( $this->zones['transcoded']['directory'] == '' )
1691                                                 ? 'temp'
1692                                                 : $this->zones['transcoded']['directory'] . '/temp'
1693                                 )
1694                         ),
1695                         'url'        => $this->getZoneUrl( 'temp' ),
1696                         'thumbUrl'   => $this->getZoneUrl( 'thumb' ) . '/temp',
1697                         'transcodedUrl'   => $this->getZoneUrl( 'transcoded' ) . '/temp',
1698                         'hashLevels' => $this->hashLevels // performance
1699                 ) );
1700         }
1701
1702         /**
1703          * Get an UploadStash associated with this repo.
1704          *
1705          * @param $user User
1706          * @return UploadStash
1707          */
1708         public function getUploadStash( User $user = null ) {
1709                 return new UploadStash( $this, $user );
1710         }
1711
1712         /**
1713          * Throw an exception if this repo is read-only by design.
1714          * This does not and should not check getReadOnlyReason().
1715          *
1716          * @return void
1717          * @throws MWException
1718          */
1719         protected function assertWritableRepo() {}
1720 }
1721
1722 /**
1723  * FileRepo for temporary files created via FileRepo::getTempRepo()
1724  */
1725 class TempFileRepo extends FileRepo {
1726         public function getTempRepo() {
1727                 throw new MWException( "Cannot get a temp repo from a temp repo." );
1728         }
1729 }