includes/filerepo/FileRepo.php

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