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