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