includes/filerepo/backend/FileBackendStore.php

   1 <?php
   2 /**
   3  * @file
   4  * @ingroup FileBackend
   5  * @author Aaron Schulz
   6  */
   7
   8 /**
   9  * @brief Base class for all backends using particular storage medium.
  10  *
  11  * This class defines the methods as abstract that subclasses must implement.
  12  * Outside callers should *not* use functions with "Internal" in the name.
  13  *
  14  * The FileBackend operations are implemented using basic functions
  15  * such as storeInternal(), copyInternal(), deleteInternal() and the like.
  16  * This class is also responsible for path resolution and sanitization.
  17  *
  18  * @ingroup FileBackend
  19  * @since 1.19
  20  */
  21 abstract class FileBackendStore extends FileBackend {
  22         /** @var Array Map of paths to small (RAM/disk) cache items */
  23         protected $cache = array(); // (storage path => key => value)
  24         protected $maxCacheSize = 100; // integer; max paths with entries
  25         /** @var Array Map of paths to large (RAM/disk) cache items */
  26         protected $expensiveCache = array(); // (storage path => key => value)
  27         protected $maxExpensiveCacheSize = 10; // integer; max paths with entries
  28
  29         /** @var Array Map of container names to sharding settings */
  30         protected $shardViaHashLevels = array(); // (container name => config array)
  31
  32         protected $maxFileSize = 4294967296; // integer bytes (4GiB)
  33
  34         /**
  35          * Get the maximum allowable file size given backend
  36          * medium restrictions and basic performance constraints.
  37          * Do not call this function from places outside FileBackend and FileOp.
  38          *
  39          * @return integer Bytes
  40          */
  41         final public function maxFileSizeInternal() {
  42                 return $this->maxFileSize;
  43         }
  44
  45         /**
  46          * Check if a file can be created at a given storage path.
  47          * FS backends should check if the parent directory exists and the file is writable.
  48          * Backends using key/value stores should check if the container exists.
  49          *
  50          * @param $storagePath string
  51          * @return bool
  52          */
  53         abstract public function isPathUsableInternal( $storagePath );
  54
  55         /**
  56          * Create a file in the backend with the given contents.
  57          * Do not call this function from places outside FileBackend and FileOp.
  58          *
  59          * $params include:
  60          *     content       : the raw file contents
  61          *     dst           : destination storage path
  62          *     overwrite     : overwrite any file that exists at the destination
  63          *
  64          * @param $params Array
  65          * @return Status
  66          */
  67         final public function createInternal( array $params ) {
  68                 wfProfileIn( __METHOD__ );
  69                 wfProfileIn( __METHOD__ . '-' . $this->name );
  70                 if ( strlen( $params['content'] ) > $this->maxFileSizeInternal() ) {
  71                         $status = Status::newFatal( 'backend-fail-maxsize',
  72                                 $params['dst'], $this->maxFileSizeInternal() );
  73                 } else {
  74                         $status = $this->doCreateInternal( $params );
  75                         $this->clearCache( array( $params['dst'] ) );
  76                 }
  77                 wfProfileOut( __METHOD__ . '-' . $this->name );
  78                 wfProfileOut( __METHOD__ );
  79                 return $status;
  80         }
  81
  82         /**
  83          * @see FileBackendStore::createInternal()
  84          */
  85         abstract protected function doCreateInternal( array $params );
  86
  87         /**
  88          * Store a file into the backend from a file on disk.
  89          * Do not call this function from places outside FileBackend and FileOp.
  90          *
  91          * $params include:
  92          *     src           : source path on disk
  93          *     dst           : destination storage path
  94          *     overwrite     : overwrite any file that exists at the destination
  95          *
  96          * @param $params Array
  97          * @return Status
  98          */
  99         final public function storeInternal( array $params ) {
 100                 wfProfileIn( __METHOD__ );
 101                 wfProfileIn( __METHOD__ . '-' . $this->name );
 102                 if ( filesize( $params['src'] ) > $this->maxFileSizeInternal() ) {
 103                         $status = Status::newFatal( 'backend-fail-store', $params['dst'] );
 104                 } else {
 105                         $status = $this->doStoreInternal( $params );
 106                         $this->clearCache( array( $params['dst'] ) );
 107                 }
 108                 wfProfileOut( __METHOD__ . '-' . $this->name );
 109                 wfProfileOut( __METHOD__ );
 110                 return $status;
 111         }
 112
 113         /**
 114          * @see FileBackendStore::storeInternal()
 115          */
 116         abstract protected function doStoreInternal( array $params );
 117
 118         /**
 119          * Copy a file from one storage path to another in the backend.
 120          * Do not call this function from places outside FileBackend and FileOp.
 121          *
 122          * $params include:
 123          *     src           : source storage path
 124          *     dst           : destination storage path
 125          *     overwrite     : overwrite any file that exists at the destination
 126          *
 127          * @param $params Array
 128          * @return Status
 129          */
 130         final public function copyInternal( array $params ) {
 131                 wfProfileIn( __METHOD__ );
 132                 wfProfileIn( __METHOD__ . '-' . $this->name );
 133                 $status = $this->doCopyInternal( $params );
 134                 $this->clearCache( array( $params['dst'] ) );
 135                 wfProfileOut( __METHOD__ . '-' . $this->name );
 136                 wfProfileOut( __METHOD__ );
 137                 return $status;
 138         }
 139
 140         /**
 141          * @see FileBackendStore::copyInternal()
 142          */
 143         abstract protected function doCopyInternal( array $params );
 144
 145         /**
 146          * Delete a file at the storage path.
 147          * Do not call this function from places outside FileBackend and FileOp.
 148          *
 149          * $params include:
 150          *     src                 : source storage path
 151          *     ignoreMissingSource : do nothing if the source file does not exist
 152          *
 153          * @param $params Array
 154          * @return Status
 155          */
 156         final public function deleteInternal( array $params ) {
 157                 wfProfileIn( __METHOD__ );
 158                 wfProfileIn( __METHOD__ . '-' . $this->name );
 159                 $status = $this->doDeleteInternal( $params );
 160                 $this->clearCache( array( $params['src'] ) );
 161                 wfProfileOut( __METHOD__ . '-' . $this->name );
 162                 wfProfileOut( __METHOD__ );
 163                 return $status;
 164         }
 165
 166         /**
 167          * @see FileBackendStore::deleteInternal()
 168          */
 169         abstract protected function doDeleteInternal( array $params );
 170
 171         /**
 172          * Move a file from one storage path to another in the backend.
 173          * Do not call this function from places outside FileBackend and FileOp.
 174          *
 175          * $params include:
 176          *     src           : source storage path
 177          *     dst           : destination storage path
 178          *     overwrite     : overwrite any file that exists at the destination
 179          *
 180          * @param $params Array
 181          * @return Status
 182          */
 183         final public function moveInternal( array $params ) {
 184                 wfProfileIn( __METHOD__ );
 185                 wfProfileIn( __METHOD__ . '-' . $this->name );
 186                 $status = $this->doMoveInternal( $params );
 187                 $this->clearCache( array( $params['src'], $params['dst'] ) );
 188                 wfProfileOut( __METHOD__ . '-' . $this->name );
 189                 wfProfileOut( __METHOD__ );
 190                 return $status;
 191         }
 192
 193         /**
 194          * @see FileBackendStore::moveInternal()
 195          * @return Status
 196          */
 197         protected function doMoveInternal( array $params ) {
 198                 // Copy source to dest
 199                 $status = $this->copyInternal( $params );
 200                 if ( $status->isOK() ) {
 201                         // Delete source (only fails due to races or medium going down)
 202                         $status->merge( $this->deleteInternal( array( 'src' => $params['src'] ) ) );
 203                         $status->setResult( true, $status->value ); // ignore delete() errors
 204                 }
 205                 return $status;
 206         }
 207
 208         /**
 209          * @see FileBackend::concatenate()
 210          * @return Status
 211          */
 212         final public function concatenate( array $params ) {
 213                 wfProfileIn( __METHOD__ );
 214                 wfProfileIn( __METHOD__ . '-' . $this->name );
 215                 $status = Status::newGood();
 216
 217                 // Try to lock the source files for the scope of this function
 218                 $scopeLockS = $this->getScopedFileLocks( $params['srcs'], LockManager::LOCK_UW, $status );
 219                 if ( $status->isOK() ) {
 220                         // Actually do the concatenation
 221                         $status->merge( $this->doConcatenate( $params ) );
 222                 }
 223
 224                 wfProfileOut( __METHOD__ . '-' . $this->name );
 225                 wfProfileOut( __METHOD__ );
 226                 return $status;
 227         }
 228
 229         /**
 230          * @see FileBackendStore::concatenate()
 231          * @return Status
 232          */
 233         protected function doConcatenate( array $params ) {
 234                 $status = Status::newGood();
 235                 $tmpPath = $params['dst']; // convenience
 236
 237                 // Check that the specified temp file is valid...
 238                 wfSuppressWarnings();
 239                 $ok = ( is_file( $tmpPath ) && !filesize( $tmpPath ) );
 240                 wfRestoreWarnings();
 241                 if ( !$ok ) { // not present or not empty
 242                         $status->fatal( 'backend-fail-opentemp', $tmpPath );
 243                         return $status;
 244                 }
 245
 246                 // Build up the temp file using the source chunks (in order)...
 247                 $tmpHandle = fopen( $tmpPath, 'ab' );
 248                 if ( $tmpHandle === false ) {
 249                         $status->fatal( 'backend-fail-opentemp', $tmpPath );
 250                         return $status;
 251                 }
 252                 foreach ( $params['srcs'] as $virtualSource ) {
 253                         // Get a local FS version of the chunk
 254                         $tmpFile = $this->getLocalReference( array( 'src' => $virtualSource ) );
 255                         if ( !$tmpFile ) {
 256                                 $status->fatal( 'backend-fail-read', $virtualSource );
 257                                 return $status;
 258                         }
 259                         // Get a handle to the local FS version
 260                         $sourceHandle = fopen( $tmpFile->getPath(), 'r' );
 261                         if ( $sourceHandle === false ) {
 262                                 fclose( $tmpHandle );
 263                                 $status->fatal( 'backend-fail-read', $virtualSource );
 264                                 return $status;
 265                         }
 266                         // Append chunk to file (pass chunk size to avoid magic quotes)
 267                         if ( !stream_copy_to_stream( $sourceHandle, $tmpHandle ) ) {
 268                                 fclose( $sourceHandle );
 269                                 fclose( $tmpHandle );
 270                                 $status->fatal( 'backend-fail-writetemp', $tmpPath );
 271                                 return $status;
 272                         }
 273                         fclose( $sourceHandle );
 274                 }
 275                 if ( !fclose( $tmpHandle ) ) {
 276                         $status->fatal( 'backend-fail-closetemp', $tmpPath );
 277                         return $status;
 278                 }
 279
 280                 clearstatcache(); // temp file changed
 281
 282                 return $status;
 283         }
 284
 285         /**
 286          * @see FileBackend::doPrepare()
 287          * @return Status
 288          */
 289         final protected function doPrepare( array $params ) {
 290                 wfProfileIn( __METHOD__ );
 291                 wfProfileIn( __METHOD__ . '-' . $this->name );
 292
 293                 $status = Status::newGood();
 294                 list( $fullCont, $dir, $shard ) = $this->resolveStoragePath( $params['dir'] );
 295                 if ( $dir === null ) {
 296                         $status->fatal( 'backend-fail-invalidpath', $params['dir'] );
 297                         wfProfileOut( __METHOD__ . '-' . $this->name );
 298                         wfProfileOut( __METHOD__ );
 299                         return $status; // invalid storage path
 300                 }
 301
 302                 if ( $shard !== null ) { // confined to a single container/shard
 303                         $status->merge( $this->doPrepareInternal( $fullCont, $dir, $params ) );
 304                 } else { // directory is on several shards
 305                         wfDebug( __METHOD__ . ": iterating over all container shards.\n" );
 306                         list( $b, $shortCont, $r ) = self::splitStoragePath( $params['dir'] );
 307                         foreach ( $this->getContainerSuffixes( $shortCont ) as $suffix ) {
 308                                 $status->merge( $this->doPrepareInternal( "{$fullCont}{$suffix}", $dir, $params ) );
 309                         }
 310                 }
 311
 312                 wfProfileOut( __METHOD__ . '-' . $this->name );
 313                 wfProfileOut( __METHOD__ );
 314                 return $status;
 315         }
 316
 317         /**
 318          * @see FileBackendStore::doPrepare()
 319          * @return Status
 320          */
 321         protected function doPrepareInternal( $container, $dir, array $params ) {
 322                 return Status::newGood();
 323         }
 324
 325         /**
 326          * @see FileBackend::doSecure()
 327          * @return Status
 328          */
 329         final protected function doSecure( array $params ) {
 330                 wfProfileIn( __METHOD__ );
 331                 wfProfileIn( __METHOD__ . '-' . $this->name );
 332                 $status = Status::newGood();
 333
 334                 list( $fullCont, $dir, $shard ) = $this->resolveStoragePath( $params['dir'] );
 335                 if ( $dir === null ) {
 336                         $status->fatal( 'backend-fail-invalidpath', $params['dir'] );
 337                         wfProfileOut( __METHOD__ . '-' . $this->name );
 338                         wfProfileOut( __METHOD__ );
 339                         return $status; // invalid storage path
 340                 }
 341
 342                 if ( $shard !== null ) { // confined to a single container/shard
 343                         $status->merge( $this->doSecureInternal( $fullCont, $dir, $params ) );
 344                 } else { // directory is on several shards
 345                         wfDebug( __METHOD__ . ": iterating over all container shards.\n" );
 346                         list( $b, $shortCont, $r ) = self::splitStoragePath( $params['dir'] );
 347                         foreach ( $this->getContainerSuffixes( $shortCont ) as $suffix ) {
 348                                 $status->merge( $this->doSecureInternal( "{$fullCont}{$suffix}", $dir, $params ) );
 349                         }
 350                 }
 351
 352                 wfProfileOut( __METHOD__ . '-' . $this->name );
 353                 wfProfileOut( __METHOD__ );
 354                 return $status;
 355         }
 356
 357         /**
 358          * @see FileBackendStore::doSecure()
 359          * @return Status
 360          */
 361         protected function doSecureInternal( $container, $dir, array $params ) {
 362                 return Status::newGood();
 363         }
 364
 365         /**
 366          * @see FileBackend::doClean()
 367          * @return Status
 368          */
 369         final protected function doClean( array $params ) {
 370                 wfProfileIn( __METHOD__ );
 371                 wfProfileIn( __METHOD__ . '-' . $this->name );
 372                 $status = Status::newGood();
 373
 374                 list( $fullCont, $dir, $shard ) = $this->resolveStoragePath( $params['dir'] );
 375                 if ( $dir === null ) {
 376                         $status->fatal( 'backend-fail-invalidpath', $params['dir'] );
 377                         wfProfileOut( __METHOD__ . '-' . $this->name );
 378                         wfProfileOut( __METHOD__ );
 379                         return $status; // invalid storage path
 380                 }
 381
 382                 // Attempt to lock this directory...
 383                 $filesLockEx = array( $params['dir'] );
 384                 $scopedLockE = $this->getScopedFileLocks( $filesLockEx, LockManager::LOCK_EX, $status );
 385                 if ( !$status->isOK() ) {
 386                         wfProfileOut( __METHOD__ . '-' . $this->name );
 387                         wfProfileOut( __METHOD__ );
 388                         return $status; // abort
 389                 }
 390
 391                 if ( $shard !== null ) { // confined to a single container/shard
 392                         $status->merge( $this->doCleanInternal( $fullCont, $dir, $params ) );
 393                 } else { // directory is on several shards
 394                         wfDebug( __METHOD__ . ": iterating over all container shards.\n" );
 395                         list( $b, $shortCont, $r ) = self::splitStoragePath( $params['dir'] );
 396                         foreach ( $this->getContainerSuffixes( $shortCont ) as $suffix ) {
 397                                 $status->merge( $this->doCleanInternal( "{$fullCont}{$suffix}", $dir, $params ) );
 398                         }
 399                 }
 400
 401                 wfProfileOut( __METHOD__ . '-' . $this->name );
 402                 wfProfileOut( __METHOD__ );
 403                 return $status;
 404         }
 405
 406         /**
 407          * @see FileBackendStore::doClean()
 408          * @return Status
 409          */
 410         protected function doCleanInternal( $container, $dir, array $params ) {
 411                 return Status::newGood();
 412         }
 413
 414         /**
 415          * @see FileBackend::fileExists()
 416          * @return bool|null
 417          */
 418         final public function fileExists( array $params ) {
 419                 wfProfileIn( __METHOD__ );
 420                 wfProfileIn( __METHOD__ . '-' . $this->name );
 421                 $stat = $this->getFileStat( $params );
 422                 wfProfileOut( __METHOD__ . '-' . $this->name );
 423                 wfProfileOut( __METHOD__ );
 424                 return ( $stat === null ) ? null : (bool)$stat; // null => failure
 425         }
 426
 427         /**
 428          * @see FileBackend::getFileTimestamp()
 429          * @return bool
 430          */
 431         final public function getFileTimestamp( array $params ) {
 432                 wfProfileIn( __METHOD__ );
 433                 wfProfileIn( __METHOD__ . '-' . $this->name );
 434                 $stat = $this->getFileStat( $params );
 435                 wfProfileOut( __METHOD__ . '-' . $this->name );
 436                 wfProfileOut( __METHOD__ );
 437                 return $stat ? $stat['mtime'] : false;
 438         }
 439
 440         /**
 441          * @see FileBackend::getFileSize()
 442          * @return bool
 443          */
 444         final public function getFileSize( array $params ) {
 445                 wfProfileIn( __METHOD__ );
 446                 wfProfileIn( __METHOD__ . '-' . $this->name );
 447                 $stat = $this->getFileStat( $params );
 448                 wfProfileOut( __METHOD__ . '-' . $this->name );
 449                 wfProfileOut( __METHOD__ );
 450                 return $stat ? $stat['size'] : false;
 451         }
 452
 453         /**
 454          * @see FileBackend::getFileStat()
 455          * @return bool
 456          */
 457         final public function getFileStat( array $params ) {
 458                 wfProfileIn( __METHOD__ );
 459                 wfProfileIn( __METHOD__ . '-' . $this->name );
 460                 $path = self::normalizeStoragePath( $params['src'] );
 461                 if ( $path === null ) {
 462                         wfProfileOut( __METHOD__ . '-' . $this->name );
 463                         wfProfileOut( __METHOD__ );
 464                         return false; // invalid storage path
 465                 }
 466                 $latest = !empty( $params['latest'] );
 467                 if ( isset( $this->cache[$path]['stat'] ) ) {
 468                         // If we want the latest data, check that this cached
 469                         // value was in fact fetched with the latest available data.
 470                         if ( !$latest || $this->cache[$path]['stat']['latest'] ) {
 471                                 $this->pingCache( $path ); // LRU
 472                                 wfProfileOut( __METHOD__ . '-' . $this->name );
 473                                 wfProfileOut( __METHOD__ );
 474                                 return $this->cache[$path]['stat'];
 475                         }
 476                 }
 477                 wfProfileIn( __METHOD__ . '-miss' );
 478                 wfProfileIn( __METHOD__ . '-miss-' . $this->name );
 479                 $stat = $this->doGetFileStat( $params );
 480                 wfProfileOut( __METHOD__ . '-miss-' . $this->name );
 481                 wfProfileOut( __METHOD__ . '-miss' );
 482                 if ( is_array( $stat ) ) { // don't cache negatives
 483                         $this->trimCache(); // limit memory
 484                         $this->cache[$path]['stat'] = $stat;
 485                         $this->cache[$path]['stat']['latest'] = $latest;
 486                 }
 487                 wfProfileOut( __METHOD__ . '-' . $this->name );
 488                 wfProfileOut( __METHOD__ );
 489                 return $stat;
 490         }
 491
 492         /**
 493          * @see FileBackendStore::getFileStat()
 494          */
 495         abstract protected function doGetFileStat( array $params );
 496
 497         /**
 498          * @see FileBackend::getFileContents()
 499          * @return bool|string
 500          */
 501         public function getFileContents( array $params ) {
 502                 wfProfileIn( __METHOD__ );
 503                 wfProfileIn( __METHOD__ . '-' . $this->name );
 504                 $tmpFile = $this->getLocalReference( $params );
 505                 if ( !$tmpFile ) {
 506                         wfProfileOut( __METHOD__ . '-' . $this->name );
 507                         wfProfileOut( __METHOD__ );
 508                         return false;
 509                 }
 510                 wfSuppressWarnings();
 511                 $data = file_get_contents( $tmpFile->getPath() );
 512                 wfRestoreWarnings();
 513                 wfProfileOut( __METHOD__ . '-' . $this->name );
 514                 wfProfileOut( __METHOD__ );
 515                 return $data;
 516         }
 517
 518         /**
 519          * @see FileBackend::getFileSha1Base36()
 520          * @return bool|string
 521          */
 522         final public function getFileSha1Base36( array $params ) {
 523                 wfProfileIn( __METHOD__ );
 524                 wfProfileIn( __METHOD__ . '-' . $this->name );
 525                 $path = $params['src'];
 526                 if ( isset( $this->cache[$path]['sha1'] ) ) {
 527                         $this->pingCache( $path ); // LRU
 528                         wfProfileOut( __METHOD__ . '-' . $this->name );
 529                         wfProfileOut( __METHOD__ );
 530                         return $this->cache[$path]['sha1'];
 531                 }
 532                 wfProfileIn( __METHOD__ . '-miss' );
 533                 wfProfileIn( __METHOD__ . '-miss-' . $this->name );
 534                 $hash = $this->doGetFileSha1Base36( $params );
 535                 wfProfileOut( __METHOD__ . '-miss-' . $this->name );
 536                 wfProfileOut( __METHOD__ . '-miss' );
 537                 if ( $hash ) { // don't cache negatives
 538                         $this->trimCache(); // limit memory
 539                         $this->cache[$path]['sha1'] = $hash;
 540                 }
 541                 wfProfileOut( __METHOD__ . '-' . $this->name );
 542                 wfProfileOut( __METHOD__ );
 543                 return $hash;
 544         }
 545
 546         /**
 547          * @see FileBackendStore::getFileSha1Base36()
 548          * @return bool
 549          */
 550         protected function doGetFileSha1Base36( array $params ) {
 551                 $fsFile = $this->getLocalReference( $params );
 552                 if ( !$fsFile ) {
 553                         return false;
 554                 } else {
 555                         return $fsFile->getSha1Base36();
 556                 }
 557         }
 558
 559         /**
 560          * @see FileBackend::getFileProps()
 561          * @return Array
 562          */
 563         final public function getFileProps( array $params ) {
 564                 wfProfileIn( __METHOD__ );
 565                 wfProfileIn( __METHOD__ . '-' . $this->name );
 566                 $fsFile = $this->getLocalReference( $params );
 567                 $props = $fsFile ? $fsFile->getProps() : FSFile::placeholderProps();
 568                 wfProfileOut( __METHOD__ . '-' . $this->name );
 569                 wfProfileOut( __METHOD__ );
 570                 return $props;
 571         }
 572
 573         /**
 574          * @see FileBackend::getLocalReference()
 575          * @return TempFSFile|null
 576          */
 577         public function getLocalReference( array $params ) {
 578                 wfProfileIn( __METHOD__ );
 579                 wfProfileIn( __METHOD__ . '-' . $this->name );
 580                 $path = $params['src'];
 581                 if ( isset( $this->expensiveCache[$path]['localRef'] ) ) {
 582                         $this->pingExpensiveCache( $path );
 583                         wfProfileOut( __METHOD__ . '-' . $this->name );
 584                         wfProfileOut( __METHOD__ );
 585                         return $this->expensiveCache[$path]['localRef'];
 586                 }
 587                 $tmpFile = $this->getLocalCopy( $params );
 588                 if ( $tmpFile ) { // don't cache negatives
 589                         $this->trimExpensiveCache(); // limit memory
 590                         $this->expensiveCache[$path]['localRef'] = $tmpFile;
 591                 }
 592                 wfProfileOut( __METHOD__ . '-' . $this->name );
 593                 wfProfileOut( __METHOD__ );
 594                 return $tmpFile;
 595         }
 596
 597         /**
 598          * @see FileBackend::streamFile()
 599          * @return Status
 600          */
 601         final public function streamFile( array $params ) {
 602                 wfProfileIn( __METHOD__ );
 603                 wfProfileIn( __METHOD__ . '-' . $this->name );
 604                 $status = Status::newGood();
 605
 606                 $info = $this->getFileStat( $params );
 607                 if ( !$info ) { // let StreamFile handle the 404
 608                         $status->fatal( 'backend-fail-notexists', $params['src'] );
 609                 }
 610
 611                 // Set output buffer and HTTP headers for stream
 612                 $extraHeaders = isset( $params['headers'] ) ? $params['headers'] : array();
 613                 $res = StreamFile::prepareForStream( $params['src'], $info, $extraHeaders );
 614                 if ( $res == StreamFile::NOT_MODIFIED ) {
 615                         // do nothing; client cache is up to date
 616                 } elseif ( $res == StreamFile::READY_STREAM ) {
 617                         wfProfileIn( __METHOD__ . '-send' );
 618                         wfProfileIn( __METHOD__ . '-send-' . $this->name );
 619                         $status = $this->doStreamFile( $params );
 620                         wfProfileOut( __METHOD__ . '-send-' . $this->name );
 621                         wfProfileOut( __METHOD__ . '-send' );
 622                 } else {
 623                         $status->fatal( 'backend-fail-stream', $params['src'] );
 624                 }
 625
 626                 wfProfileOut( __METHOD__ . '-' . $this->name );
 627                 wfProfileOut( __METHOD__ );
 628                 return $status;
 629         }
 630
 631         /**
 632          * @see FileBackendStore::streamFile()
 633          * @return Status
 634          */
 635         protected function doStreamFile( array $params ) {
 636                 $status = Status::newGood();
 637
 638                 $fsFile = $this->getLocalReference( $params );
 639                 if ( !$fsFile ) {
 640                         $status->fatal( 'backend-fail-stream', $params['src'] );
 641                 } elseif ( !readfile( $fsFile->getPath() ) ) {
 642                         $status->fatal( 'backend-fail-stream', $params['src'] );
 643                 }
 644
 645                 return $status;
 646         }
 647
 648         /**
 649          * @copydoc FileBackend::getFileList()
 650          * @return Array|null|Traversable
 651          */
 652         final public function getFileList( array $params ) {
 653                 list( $fullCont, $dir, $shard ) = $this->resolveStoragePath( $params['dir'] );
 654                 if ( $dir === null ) { // invalid storage path
 655                         return null;
 656                 }
 657                 if ( $shard !== null ) {
 658                         // File listing is confined to a single container/shard
 659                         return $this->getFileListInternal( $fullCont, $dir, $params );
 660                 } else {
 661                         wfDebug( __METHOD__ . ": iterating over all container shards.\n" );
 662                         // File listing spans multiple containers/shards
 663                         list( $b, $shortCont, $r ) = self::splitStoragePath( $params['dir'] );
 664                         return new FileBackendStoreShardListIterator( $this,
 665                                 $fullCont, $dir, $this->getContainerSuffixes( $shortCont ), $params );
 666                 }
 667         }
 668
 669         /**
 670          * Do not call this function from places outside FileBackend
 671          *
 672          * @see FileBackendStore::getFileList()
 673          *
 674          * @param $container string Resolved container name
 675          * @param $dir string Resolved path relative to container
 676          * @param $params Array
 677          * @return Traversable|Array|null
 678          */
 679         abstract public function getFileListInternal( $container, $dir, array $params );
 680
 681         /**
 682          * Get the list of supported operations and their corresponding FileOp classes.
 683          *
 684          * @return Array
 685          */
 686         protected function supportedOperations() {
 687                 return array(
 688                         'store'       => 'StoreFileOp',
 689                         'copy'        => 'CopyFileOp',
 690                         'move'        => 'MoveFileOp',
 691                         'delete'      => 'DeleteFileOp',
 692                         'create'      => 'CreateFileOp',
 693                         'null'        => 'NullFileOp'
 694                 );
 695         }
 696
 697         /**
 698          * Return a list of FileOp objects from a list of operations.
 699          * Do not call this function from places outside FileBackend.
 700          *
 701          * The result must have the same number of items as the input.
 702          * An exception is thrown if an unsupported operation is requested.
 703          *
 704          * @param $ops Array Same format as doOperations()
 705          * @return Array List of FileOp objects
 706          * @throws MWException
 707          */
 708         final public function getOperationsInternal( array $ops ) {
 709                 $supportedOps = $this->supportedOperations();
 710
 711                 $performOps = array(); // array of FileOp objects
 712                 // Build up ordered array of FileOps...
 713                 foreach ( $ops as $operation ) {
 714                         $opName = $operation['op'];
 715                         if ( isset( $supportedOps[$opName] ) ) {
 716                                 $class = $supportedOps[$opName];
 717                                 // Get params for this operation
 718                                 $params = $operation;
 719                                 // Append the FileOp class
 720                                 $performOps[] = new $class( $this, $params );
 721                         } else {
 722                                 throw new MWException( "Operation '$opName' is not supported." );
 723                         }
 724                 }
 725
 726                 return $performOps;
 727         }
 728
 729         /**
 730          * Get a list of storage paths to lock for a list of operations
 731          * Returns an array with 'sh' (shared) and 'ex' (exclusive) keys,
 732          * each corresponding to a list of storage paths to be locked.
 733          *
 734          * @param $performOps Array List of FileOp objects
 735          * @return Array ('sh' => list of paths, 'ex' => list of paths)
 736          */
 737         final public function getPathsToLockForOpsInternal( array $performOps ) {
 738                 // Build up a list of files to lock...
 739                 $paths = array( 'sh' => array(), 'ex' => array() );
 740                 foreach ( $performOps as $fileOp ) {
 741                         $paths['sh'] = array_merge( $paths['sh'], $fileOp->storagePathsRead() );
 742                         $paths['ex'] = array_merge( $paths['ex'], $fileOp->storagePathsChanged() );
 743                 }
 744                 // Optimization: if doing an EX lock anyway, don't also set an SH one
 745                 $paths['sh'] = array_diff( $paths['sh'], $paths['ex'] );
 746                 // Get a shared lock on the parent directory of each path changed
 747                 $paths['sh'] = array_merge( $paths['sh'], array_map( 'dirname', $paths['ex'] ) );
 748
 749                 return $paths;
 750         }
 751
 752         /**
 753          * @see FileBackend::doOperationsInternal()
 754          * @return Status
 755          */
 756         protected function doOperationsInternal( array $ops, array $opts ) {
 757                 wfProfileIn( __METHOD__ );
 758                 wfProfileIn( __METHOD__ . '-' . $this->name );
 759                 $status = Status::newGood();
 760
 761                 // Build up a list of FileOps...
 762                 $performOps = $this->getOperationsInternal( $ops );
 763
 764                 // Acquire any locks as needed...
 765                 if ( empty( $opts['nonLocking'] ) ) {
 766                         // Build up a list of files to lock...
 767                         $paths = $this->getPathsToLockForOpsInternal( $performOps );
 768                         // Try to lock those files for the scope of this function...
 769                         $scopeLockS = $this->getScopedFileLocks( $paths['sh'], LockManager::LOCK_UW, $status );
 770                         $scopeLockE = $this->getScopedFileLocks( $paths['ex'], LockManager::LOCK_EX, $status );
 771                         if ( !$status->isOK() ) {
 772                                 wfProfileOut( __METHOD__ . '-' . $this->name );
 773                                 wfProfileOut( __METHOD__ );
 774                                 return $status; // abort
 775                         }
 776                 }
 777
 778                 // Clear any cache entries (after locks acquired)
 779                 $this->clearCache();
 780
 781                 // Actually attempt the operation batch...
 782                 $subStatus = FileOp::attemptBatch( $performOps, $opts, $this->fileJournal );
 783
 784                 // Merge errors into status fields
 785                 $status->merge( $subStatus );
 786                 $status->success = $subStatus->success; // not done in merge()
 787
 788                 wfProfileOut( __METHOD__ . '-' . $this->name );
 789                 wfProfileOut( __METHOD__ );
 790                 return $status;
 791         }
 792
 793         /**
 794          * @see FileBackend::clearCache()
 795          */
 796         final public function clearCache( array $paths = null ) {
 797                 if ( is_array( $paths ) ) {
 798                         $paths = array_map( 'FileBackend::normalizeStoragePath', $paths );
 799                         $paths = array_filter( $paths, 'strlen' ); // remove nulls
 800                 }
 801                 if ( $paths === null ) {
 802                         $this->cache = array();
 803                         $this->expensiveCache = array();
 804                 } else {
 805                         foreach ( $paths as $path ) {
 806                                 unset( $this->cache[$path] );
 807                                 unset( $this->expensiveCache[$path] );
 808                         }
 809                 }
 810                 $this->doClearCache( $paths );
 811         }
 812
 813         /**
 814          * Clears any additional stat caches for storage paths
 815          *
 816          * @see FileBackend::clearCache()
 817          *
 818          * @param $paths Array Storage paths (optional)
 819          * @return void
 820          */
 821         protected function doClearCache( array $paths = null ) {}
 822
 823         /**
 824          * Move a cache entry to the top (such as when accessed)
 825          *
 826          * @param $path string Storage path
 827          */
 828         protected function pingCache( $path ) {
 829                 if ( isset( $this->cache[$path] ) ) {
 830                         $tmp = $this->cache[$path];
 831                         unset( $this->cache[$path] );
 832                         $this->cache[$path] = $tmp;
 833                 }
 834         }
 835
 836         /**
 837          * Prune the inexpensive cache if it is too big to add an item
 838          *
 839          * @return void
 840          */
 841         protected function trimCache() {
 842                 if ( count( $this->cache ) >= $this->maxCacheSize ) {
 843                         reset( $this->cache );
 844                         unset( $this->cache[key( $this->cache )] );
 845                 }
 846         }
 847
 848         /**
 849          * Move a cache entry to the top (such as when accessed)
 850          *
 851          * @param $path string Storage path
 852          */
 853         protected function pingExpensiveCache( $path ) {
 854                 if ( isset( $this->expensiveCache[$path] ) ) {
 855                         $tmp = $this->expensiveCache[$path];
 856                         unset( $this->expensiveCache[$path] );
 857                         $this->expensiveCache[$path] = $tmp;
 858                 }
 859         }
 860
 861         /**
 862          * Prune the expensive cache if it is too big to add an item
 863          *
 864          * @return void
 865          */
 866         protected function trimExpensiveCache() {
 867                 if ( count( $this->expensiveCache ) >= $this->maxExpensiveCacheSize ) {
 868                         reset( $this->expensiveCache );
 869                         unset( $this->expensiveCache[key( $this->expensiveCache )] );
 870                 }
 871         }
 872
 873         /**
 874          * Check if a container name is valid.
 875          * This checks for for length and illegal characters.
 876          *
 877          * @param $container string
 878          * @return bool
 879          */
 880         final protected static function isValidContainerName( $container ) {
 881                 // This accounts for Swift and S3 restrictions while leaving room
 882                 // for things like '.xxx' (hex shard chars) or '.seg' (segments).
 883                 // This disallows directory separators or traversal characters.
 884                 // Note that matching strings URL encode to the same string;
 885                 // in Swift, the length restriction is *after* URL encoding.
 886                 return preg_match( '/^[a-z0-9][a-z0-9-_]{0,199}$/i', $container );
 887         }
 888
 889         /**
 890          * Splits a storage path into an internal container name,
 891          * an internal relative file name, and a container shard suffix.
 892          * Any shard suffix is already appended to the internal container name.
 893          * This also checks that the storage path is valid and within this backend.
 894          *
 895          * If the container is sharded but a suffix could not be determined,
 896          * this means that the path can only refer to a directory and can only
 897          * be scanned by looking in all the container shards.
 898          *
 899          * @param $storagePath string
 900          * @return Array (container, path, container suffix) or (null, null, null) if invalid
 901          */
 902         final protected function resolveStoragePath( $storagePath ) {
 903                 list( $backend, $container, $relPath ) = self::splitStoragePath( $storagePath );
 904                 if ( $backend === $this->name ) { // must be for this backend
 905                         $relPath = self::normalizeContainerPath( $relPath );
 906                         if ( $relPath !== null ) {
 907                                 // Get shard for the normalized path if this container is sharded
 908                                 $cShard = $this->getContainerShard( $container, $relPath );
 909                                 // Validate and sanitize the relative path (backend-specific)
 910                                 $relPath = $this->resolveContainerPath( $container, $relPath );
 911                                 if ( $relPath !== null ) {
 912                                         // Prepend any wiki ID prefix to the container name
 913                                         $container = $this->fullContainerName( $container );
 914                                         if ( self::isValidContainerName( $container ) ) {
 915                                                 // Validate and sanitize the container name (backend-specific)
 916                                                 $container = $this->resolveContainerName( "{$container}{$cShard}" );
 917                                                 if ( $container !== null ) {
 918                                                         return array( $container, $relPath, $cShard );
 919                                                 }
 920                                         }
 921                                 }
 922                         }
 923                 }
 924                 return array( null, null, null );
 925         }
 926
 927         /**
 928          * Like resolveStoragePath() except null values are returned if
 929          * the container is sharded and the shard could not be determined.
 930          *
 931          * @see FileBackendStore::resolveStoragePath()
 932          *
 933          * @param $storagePath string
 934          * @return Array (container, path) or (null, null) if invalid
 935          */
 936         final protected function resolveStoragePathReal( $storagePath ) {
 937                 list( $container, $relPath, $cShard ) = $this->resolveStoragePath( $storagePath );
 938                 if ( $cShard !== null ) {
 939                         return array( $container, $relPath );
 940                 }
 941                 return array( null, null );
 942         }
 943
 944         /**
 945          * Get the container name shard suffix for a given path.
 946          * Any empty suffix means the container is not sharded.
 947          *
 948          * @param $container string Container name
 949          * @param $relStoragePath string Storage path relative to the container
 950          * @return string|null Returns null if shard could not be determined
 951          */
 952         final protected function getContainerShard( $container, $relPath ) {
 953                 list( $levels, $base, $repeat ) = $this->getContainerHashLevels( $container );
 954                 if ( $levels == 1 || $levels == 2 ) {
 955                         // Hash characters are either base 16 or 36
 956                         $char = ( $base == 36 ) ? '[0-9a-z]' : '[0-9a-f]';
 957                         // Get a regex that represents the shard portion of paths.
 958                         // The concatenation of the captures gives us the shard.
 959                         if ( $levels === 1 ) { // 16 or 36 shards per container
 960                                 $hashDirRegex = '(' . $char . ')';
 961                         } else { // 256 or 1296 shards per container
 962                                 if ( $repeat ) { // verbose hash dir format (e.g. "a/ab/abc")
 963                                         $hashDirRegex = $char . '/(' . $char . '{2})';
 964                                 } else { // short hash dir format (e.g. "a/b/c")
 965                                         $hashDirRegex = '(' . $char . ')/(' . $char . ')';
 966                                 }
 967                         }
 968                         // Allow certain directories to be above the hash dirs so as
 969                         // to work with FileRepo (e.g. "archive/a/ab" or "temp/a/ab").
 970                         // They must be 2+ chars to avoid any hash directory ambiguity.
 971                         $m = array();
 972                         if ( preg_match( "!^(?:[^/]{2,}/)*$hashDirRegex(?:/|$)!", $relPath, $m ) ) {
 973                                 return '.' . implode( '', array_slice( $m, 1 ) );
 974                         }
 975                         return null; // failed to match
 976                 }
 977                 return ''; // no sharding
 978         }
 979
 980         /**
 981          * Get the sharding config for a container.
 982          * If greater than 0, then all file storage paths within
 983          * the container are required to be hashed accordingly.
 984          *
 985          * @param $container string
 986          * @return Array (integer levels, integer base, repeat flag) or (0, 0, false)
 987          */
 988         final protected function getContainerHashLevels( $container ) {
 989                 if ( isset( $this->shardViaHashLevels[$container] ) ) {
 990                         $config = $this->shardViaHashLevels[$container];
 991                         $hashLevels = (int)$config['levels'];
 992                         if ( $hashLevels == 1 || $hashLevels == 2 ) {
 993                                 $hashBase = (int)$config['base'];
 994                                 if ( $hashBase == 16 || $hashBase == 36 ) {
 995                                         return array( $hashLevels, $hashBase, $config['repeat'] );
 996                                 }
 997                         }
 998                 }
 999                 return array( 0, 0, false ); // no sharding
1000         }
1001
1002         /**
1003          * Get a list of full container shard suffixes for a container
1004          *
1005          * @param $container string
1006          * @return Array
1007          */
1008         final protected function getContainerSuffixes( $container ) {
1009                 $shards = array();
1010                 list( $digits, $base ) = $this->getContainerHashLevels( $container );
1011                 if ( $digits > 0 ) {
1012                         $numShards = pow( $base, $digits );
1013                         for ( $index = 0; $index < $numShards; $index++ ) {
1014                                 $shards[] = '.' . wfBaseConvert( $index, 10, $base, $digits );
1015                         }
1016                 }
1017                 return $shards;
1018         }
1019
1020         /**
1021          * Get the full container name, including the wiki ID prefix
1022          *
1023          * @param $container string
1024          * @return string
1025          */
1026         final protected function fullContainerName( $container ) {
1027                 if ( $this->wikiId != '' ) {
1028                         return "{$this->wikiId}-$container";
1029                 } else {
1030                         return $container;
1031                 }
1032         }
1033
1034         /**
1035          * Resolve a container name, checking if it's allowed by the backend.
1036          * This is intended for internal use, such as encoding illegal chars.
1037          * Subclasses can override this to be more restrictive.
1038          *
1039          * @param $container string
1040          * @return string|null
1041          */
1042         protected function resolveContainerName( $container ) {
1043                 return $container;
1044         }
1045
1046         /**
1047          * Resolve a relative storage path, checking if it's allowed by the backend.
1048          * This is intended for internal use, such as encoding illegal chars or perhaps
1049          * getting absolute paths (e.g. FS based backends). Note that the relative path
1050          * may be the empty string (e.g. the path is simply to the container).
1051          *
1052          * @param $container string Container name
1053          * @param $relStoragePath string Storage path relative to the container
1054          * @return string|null Path or null if not valid
1055          */
1056         protected function resolveContainerPath( $container, $relStoragePath ) {
1057                 return $relStoragePath;
1058         }
1059 }
1060
1061 /**
1062  * FileBackendStore helper function to handle file listings that span container shards.
1063  * Do not use this class from places outside of FileBackendStore.
1064  *
1065  * @ingroup FileBackend
1066  */
1067 class FileBackendStoreShardListIterator implements Iterator {
1068         /* @var FileBackendStore */
1069         protected $backend;
1070         /* @var Array */
1071         protected $params;
1072         /* @var Array */
1073         protected $shardSuffixes;
1074         protected $container; // string
1075         protected $directory; // string
1076
1077         /* @var Traversable */
1078         protected $iter;
1079         protected $curShard = 0; // integer
1080         protected $pos = 0; // integer
1081
1082         /**
1083          * @param $backend FileBackendStore
1084          * @param $container string Full storage container name
1085          * @param $dir string Storage directory relative to container
1086          * @param $suffixes Array List of container shard suffixes
1087          * @param $params Array
1088          */
1089         public function __construct(
1090                 FileBackendStore $backend, $container, $dir, array $suffixes, array $params
1091         ) {
1092                 $this->backend = $backend;
1093                 $this->container = $container;
1094                 $this->directory = $dir;
1095                 $this->shardSuffixes = $suffixes;
1096                 $this->params = $params;
1097         }
1098
1099         /**
1100          * @see Iterator::current()
1101          * @return string|bool String or false
1102          */
1103         public function current() {
1104                 if ( is_array( $this->iter ) ) {
1105                         return current( $this->iter );
1106                 } else {
1107                         return $this->iter->current();
1108                 }
1109         }
1110
1111         /**
1112          * @see Iterator::key()
1113          * @return integer
1114          */
1115         public function key() {
1116                 return $this->pos;
1117         }
1118
1119         /**
1120          * @see Iterator::next()
1121          * @return void
1122          */
1123         public function next() {
1124                 ++$this->pos;
1125                 if ( is_array( $this->iter ) ) {
1126                         next( $this->iter );
1127                 } else {
1128                         $this->iter->next();
1129                 }
1130                 // Find the next non-empty shard if no elements are left
1131                 $this->nextShardIteratorIfNotValid();
1132         }
1133
1134         /**
1135          * @see Iterator::rewind()
1136          * @return void
1137          */
1138         public function rewind() {
1139                 $this->pos = 0;
1140                 $this->curShard = 0;
1141                 $this->setIteratorFromCurrentShard();
1142                 // Find the next non-empty shard if this one has no elements
1143                 $this->nextShardIteratorIfNotValid();
1144         }
1145
1146         /**
1147          * @see Iterator::valid()
1148          * @return bool
1149          */
1150         public function valid() {
1151                 if ( $this->iter == null ) {
1152                         return false; // some failure?
1153                 } elseif ( is_array( $this->iter ) ) {
1154                         return ( current( $this->iter ) !== false ); // no paths can have this value
1155                 } else {
1156                         return $this->iter->valid();
1157                 }
1158         }
1159
1160         /**
1161          * If the list iterator for this container shard is out of items,
1162          * then move on to the next container that has items.
1163          * If there are none, then it advances to the last container.
1164          */
1165         protected function nextShardIteratorIfNotValid() {
1166                 while ( !$this->valid() ) {
1167                         if ( ++$this->curShard >= count( $this->shardSuffixes ) ) {
1168                                 break; // no more container shards
1169                         }
1170                         $this->setIteratorFromCurrentShard();
1171                 }
1172         }
1173
1174         /**
1175          * Set the list iterator to that of the current container shard
1176          */
1177         protected function setIteratorFromCurrentShard() {
1178                 $suffix = $this->shardSuffixes[$this->curShard];
1179                 $this->iter = $this->backend->getFileListInternal(
1180                         "{$this->container}{$suffix}", $this->directory, $this->params );
1181         }
1182 }