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