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