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