includes/filerepo/FileRepo.php

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