includes/filerepo/FileRepo.php

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