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