includes/filerepo/FileRepo.php

   1 <?php
   2
   3 /**
   4  * Base class for file repositories
   5  * Do not instantiate, use a derived class.
   6  * @ingroup FileRepo
   7  */
   8 abstract class FileRepo {
   9         const DELETE_SOURCE = 1;
  10         const FIND_PRIVATE = 1;
  11         const FIND_IGNORE_REDIRECT = 2;
  12         const OVERWRITE = 2;
  13         const OVERWRITE_SAME = 4;
  14
  15         var $thumbScriptUrl, $transformVia404;
  16         var $descBaseUrl, $scriptDirUrl, $articleUrl, $fetchDescription, $initialCapital;
  17         var $pathDisclosureProtection = 'paranoid';
  18         var $descriptionCacheExpiry, $apiThumbCacheExpiry, $apiThumbCacheDir;
  19
  20         /**
  21          * Factory functions for creating new files
  22          * Override these in the base class
  23          */
  24         var $fileFactory = false, $oldFileFactory = false;
  25         var $fileFactoryKey = false, $oldFileFactoryKey = false;
  26
  27         function __construct( $info ) {
  28                 // Required settings
  29                 $this->name = $info['name'];
  30
  31                 // Optional settings
  32                 $this->initialCapital = true; // by default
  33                 foreach ( array( 'descBaseUrl', 'scriptDirUrl', 'articleUrl', 'fetchDescription',
  34                         'thumbScriptUrl', 'initialCapital', 'pathDisclosureProtection',
  35                         'descriptionCacheExpiry', 'apiThumbCacheExpiry', 'apiThumbCacheDir' ) as $var )
  36                 {
  37                         if ( isset( $info[$var] ) ) {
  38                                 $this->$var = $info[$var];
  39                         }
  40                 }
  41                 $this->transformVia404 = !empty( $info['transformVia404'] );
  42         }
  43
  44         /**
  45          * Determine if a string is an mwrepo:// URL
  46          */
  47         static function isVirtualUrl( $url ) {
  48                 return substr( $url, 0, 9 ) == 'mwrepo://';
  49         }
  50
  51         /**
  52          * Create a new File object from the local repository
  53          * @param mixed $title Title object or string
  54          * @param mixed $time Time at which the image was uploaded.
  55          *                    If this is specified, the returned object will be an
  56          *                    instance of the repository's old file class instead of
  57          *                    a current file. Repositories not supporting version
  58          *                    control should return false if this parameter is set.
  59          */
  60         function newFile( $title, $time = false ) {
  61                 if ( !($title instanceof Title) ) {
  62                         $title = Title::makeTitleSafe( NS_IMAGE, $title );
  63                         if ( !is_object( $title ) ) {
  64                                 return null;
  65                         }
  66                 }
  67                 if ( $time ) {
  68                         if ( $this->oldFileFactory ) {
  69                                 return call_user_func( $this->oldFileFactory, $title, $this, $time );
  70                         } else {
  71                                 return false;
  72                         }
  73                 } else {
  74                         return call_user_func( $this->fileFactory, $title, $this );
  75                 }
  76         }
  77
  78         /**
  79          * Find an instance of the named file created at the specified time
  80          * Returns false if the file does not exist. Repositories not supporting
  81          * version control should return false if the time is specified.
  82          *
  83          * @param mixed $title Title object or string
  84          * @param mixed $time 14-character timestamp, or false for the current version
  85          */
  86         function findFile( $title, $time = false, $flags = 0 ) {
  87                 if ( !($title instanceof Title) ) {
  88                         $title = Title::makeTitleSafe( NS_IMAGE, $title );
  89                         if ( !is_object( $title ) ) {
  90                                 return false;
  91                         }
  92                 }
  93                 # First try the current version of the file to see if it precedes the timestamp
  94                 $img = $this->newFile( $title );
  95                 if ( !$img ) {
  96                         return false;
  97                 }
  98                 if ( $img->exists() && ( !$time || $img->getTimestamp() == $time ) ) {
  99                         return $img;
 100                 }
 101                 # Now try an old version of the file
 102                 if ( $time !== false ) {
 103                         $img = $this->newFile( $title, $time );
 104                         if ( $img->exists() ) {
 105                                 if ( !$img->isDeleted(File::DELETED_FILE) ) {
 106                                         return $img;
 107                                 } else if ( ($flags & FileRepo::FIND_PRIVATE) && $img->userCan(File::DELETED_FILE) ) {
 108                                         return $img;
 109                                 }
 110                         }
 111                 }
 112
 113                 # Now try redirects
 114                 if ( $flags & FileRepo::FIND_IGNORE_REDIRECT ) {
 115                         return false;
 116                 }
 117                 $redir = $this->checkRedirect( $title );
 118                 if( $redir && $redir->getNamespace() == NS_IMAGE) {
 119                         $img = $this->newFile( $redir );
 120                         if( !$img ) {
 121                                 return false;
 122                         }
 123                         if( $img->exists() ) {
 124                                 $img->redirectedFrom( $title->getDBkey() );
 125                                 return $img;
 126                         }
 127                 }
 128                 return false;
 129         }
 130
 131         /*
 132          * Find many files at once.
 133          * @param array $titles, an array of titles
 134          * @param int $flags
 135          */
 136         function findFiles( $titles, $flags ) {
 137                 $result = array();
 138                 foreach ( $titles as $index => $title ) {
 139                         $file = $this->findFile( $title, $flags );
 140                         if ( $file )
 141                                 $result[$file->getTitle()->getDBkey()] = $file;
 142                 }
 143                 return $result;
 144         }
 145
 146         /**
 147          * Create a new File object from the local repository
 148          * @param mixed $sha1 SHA-1 key
 149          * @param mixed $time Time at which the image was uploaded.
 150          *                    If this is specified, the returned object will be an
 151          *                    instance of the repository's old file class instead of
 152          *                    a current file. Repositories not supporting version
 153          *                    control should return false if this parameter is set.
 154          */
 155         function newFileFromKey( $sha1, $time = false ) {
 156                 if ( $time ) {
 157                         if ( $this->oldFileFactoryKey ) {
 158                                 return call_user_func( $this->oldFileFactoryKey, $sha1, $this, $time );
 159                         } else {
 160                                 return false;
 161                         }
 162                 } else {
 163                         return call_user_func( $this->fileFactoryKey, $sha1, $this );
 164                 }
 165         }
 166
 167         /**
 168          * Find an instance of the file with this key, created at the specified time
 169          * Returns false if the file does not exist. Repositories not supporting
 170          * version control should return false if the time is specified.
 171          *
 172          * @param string $sha1 string
 173          * @param mixed $time 14-character timestamp, or false for the current version
 174          */
 175         function findFileFromKey( $sha1, $time = false, $flags = 0 ) {
 176                 # First try the current version of the file to see if it precedes the timestamp
 177                 $img = $this->newFileFromKey( $sha1 );
 178                 if ( !$img ) {
 179                         return false;
 180                 }
 181                 if ( $img->exists() && ( !$time || $img->getTimestamp() == $time ) ) {
 182                         return $img;
 183                 }
 184                 # Now try an old version of the file
 185                 if ( $time !== false ) {
 186                         $img = $this->newFileFromKey( $sha1, $time );
 187                         if ( $img->exists() ) {
 188                                 if ( !$img->isDeleted(File::DELETED_FILE) ) {
 189                                         return $img;
 190                                 } else if ( ($flags & FileRepo::FIND_PRIVATE) && $img->userCan(File::DELETED_FILE) ) {
 191                                         return $img;
 192                                 }
 193                         }
 194                 }
 195                 return false;
 196         }
 197
 198         /**
 199          * Get the URL of thumb.php
 200          */
 201         function getThumbScriptUrl() {
 202                 return $this->thumbScriptUrl;
 203         }
 204
 205         /**
 206          * Returns true if the repository can transform files via a 404 handler
 207          */
 208         function canTransformVia404() {
 209                 return $this->transformVia404;
 210         }
 211
 212         /**
 213          * Get the name of an image from its title object
 214          */
 215         function getNameFromTitle( $title ) {
 216                 global $wgCapitalLinks;
 217                 if ( $this->initialCapital != $wgCapitalLinks ) {
 218                         global $wgContLang;
 219                         $name = $title->getUserCaseDBKey();
 220                         if ( $this->initialCapital ) {
 221                                 $name = $wgContLang->ucfirst( $name );
 222                         }
 223                 } else {
 224                         $name = $title->getDBkey();
 225                 }
 226                 return $name;
 227         }
 228
 229         static function getHashPathForLevel( $name, $levels ) {
 230                 if ( $levels == 0 ) {
 231                         return '';
 232                 } else {
 233                         $hash = md5( $name );
 234                         $path = '';
 235                         for ( $i = 1; $i <= $levels; $i++ ) {
 236                                 $path .= substr( $hash, 0, $i ) . '/';
 237                         }
 238                         return $path;
 239                 }
 240         }
 241
 242         /**
 243          * Get the name of this repository, as specified by $info['name]' to the constructor
 244          */
 245         function getName() {
 246                 return $this->name;
 247         }
 248
 249         /**
 250          * Get the file description page base URL, or false if there isn't one.
 251          * @private
 252          */
 253         function getDescBaseUrl() {
 254                 if ( is_null( $this->descBaseUrl ) ) {
 255                         if ( !is_null( $this->articleUrl ) ) {
 256                                 $this->descBaseUrl = str_replace( '$1',
 257                                         wfUrlencode( MWNamespace::getCanonicalName( NS_IMAGE ) ) . ':', $this->articleUrl );
 258                         } elseif ( !is_null( $this->scriptDirUrl ) ) {
 259                                 $this->descBaseUrl = $this->scriptDirUrl . '/index.php?title=' .
 260                                         wfUrlencode( MWNamespace::getCanonicalName( NS_IMAGE ) ) . ':';
 261                         } else {
 262                                 $this->descBaseUrl = false;
 263                         }
 264                 }
 265                 return $this->descBaseUrl;
 266         }
 267
 268         /**
 269          * Get the URL of an image description page. May return false if it is
 270          * unknown or not applicable. In general this should only be called by the
 271          * File class, since it may return invalid results for certain kinds of
 272          * repositories. Use File::getDescriptionUrl() in user code.
 273          *
 274          * In particular, it uses the article paths as specified to the repository
 275          * constructor, whereas local repositories use the local Title functions.
 276          */
 277         function getDescriptionUrl( $name ) {
 278                 $base = $this->getDescBaseUrl();
 279                 if ( $base ) {
 280                         return $base . wfUrlencode( $name );
 281                 } else {
 282                         return false;
 283                 }
 284         }
 285
 286         /**
 287          * Get the URL of the content-only fragment of the description page. For
 288          * MediaWiki this means action=render. This should only be called by the
 289          * repository's file class, since it may return invalid results. User code
 290          * should use File::getDescriptionText().
 291          */
 292         function getDescriptionRenderUrl( $name ) {
 293                 if ( isset( $this->scriptDirUrl ) ) {
 294                         return $this->scriptDirUrl . '/index.php?title=' .
 295                                 wfUrlencode( MWNamespace::getCanonicalName( NS_IMAGE ) . ':' . $name ) .
 296                                 '&action=render';
 297                 } else {
 298                         $descBase = $this->getDescBaseUrl();
 299                         if ( $descBase ) {
 300                                 return wfAppendQuery( $descBase . wfUrlencode( $name ), 'action=render' );
 301                         } else {
 302                                 return false;
 303                         }
 304                 }
 305         }
 306
 307         /**
 308          * Store a file to a given destination.
 309          *
 310          * @param string $srcPath Source path or virtual URL
 311          * @param string $dstZone Destination zone
 312          * @param string $dstRel Destination relative path
 313          * @param integer $flags Bitwise combination of the following flags:
 314          *     self::DELETE_SOURCE     Delete the source file after upload
 315          *     self::OVERWRITE         Overwrite an existing destination file instead of failing
 316          *     self::OVERWRITE_SAME    Overwrite the file if the destination exists and has the
 317          *                             same contents as the source
 318          * @return FileRepoStatus
 319          */
 320         function store( $srcPath, $dstZone, $dstRel, $flags = 0 ) {
 321                 $status = $this->storeBatch( array( array( $srcPath, $dstZone, $dstRel ) ), $flags );
 322                 if ( $status->successCount == 0 ) {
 323                         $status->ok = false;
 324                 }
 325                 return $status;
 326         }
 327
 328         /**
 329          * Store a batch of files
 330          *
 331          * @param array $triplets (src,zone,dest) triplets as per store()
 332          * @param integer $flags Flags as per store
 333          */
 334         abstract function storeBatch( $triplets, $flags = 0 );
 335
 336         /**
 337          * Pick a random name in the temp zone and store a file to it.
 338          * Returns a FileRepoStatus object with the URL in the value.
 339          *
 340          * @param string $originalName The base name of the file as specified
 341          *     by the user. The file extension will be maintained.
 342          * @param string $srcPath The current location of the file.
 343          */
 344         abstract function storeTemp( $originalName, $srcPath );
 345
 346         /**
 347          * Remove a temporary file or mark it for garbage collection
 348          * @param string $virtualUrl The virtual URL returned by storeTemp
 349          * @return boolean True on success, false on failure
 350          * STUB
 351          */
 352         function freeTemp( $virtualUrl ) {
 353                 return true;
 354         }
 355
 356         /**
 357          * Copy or move a file either from the local filesystem or from an mwrepo://
 358          * virtual URL, into this repository at the specified destination location.
 359          *
 360          * Returns a FileRepoStatus object. On success, the value contains "new" or
 361          * "archived", to indicate whether the file was new with that name.
 362          *
 363          * @param string $srcPath The source path or URL
 364          * @param string $dstRel The destination relative path
 365          * @param string $archiveRel The relative path where the existing file is to
 366          *        be archived, if there is one. Relative to the public zone root.
 367          * @param integer $flags Bitfield, may be FileRepo::DELETE_SOURCE to indicate
 368          *        that the source file should be deleted if possible
 369          */
 370         function publish( $srcPath, $dstRel, $archiveRel, $flags = 0 ) {
 371                 $status = $this->publishBatch( array( array( $srcPath, $dstRel, $archiveRel ) ), $flags );
 372                 if ( $status->successCount == 0 ) {
 373                         $status->ok = false;
 374                 }
 375                 if ( isset( $status->value[0] ) ) {
 376                         $status->value = $status->value[0];
 377                 } else {
 378                         $status->value = false;
 379                 }
 380                 return $status;
 381         }
 382
 383         /**
 384          * Publish a batch of files
 385          * @param array $triplets (source,dest,archive) triplets as per publish()
 386          * @param integer $flags Bitfield, may be FileRepo::DELETE_SOURCE to indicate
 387          *        that the source files should be deleted if possible
 388          */
 389         abstract function publishBatch( $triplets, $flags = 0 );
 390
 391         /**
 392          * Move a group of files to the deletion archive.
 393          *
 394          * If no valid deletion archive is configured, this may either delete the
 395          * file or throw an exception, depending on the preference of the repository.
 396          *
 397          * The overwrite policy is determined by the repository -- currently FSRepo
 398          * assumes a naming scheme in the deleted zone based on content hash, as
 399          * opposed to the public zone which is assumed to be unique.
 400          *
 401          * @param array $sourceDestPairs Array of source/destination pairs. Each element
 402          *        is a two-element array containing the source file path relative to the
 403          *        public root in the first element, and the archive file path relative
 404          *        to the deleted zone root in the second element.
 405          * @return FileRepoStatus
 406          */
 407         abstract function deleteBatch( $sourceDestPairs );
 408
 409         /**
 410          * Move a file to the deletion archive.
 411          * If no valid deletion archive exists, this may either delete the file
 412          * or throw an exception, depending on the preference of the repository
 413          * @param mixed $srcRel Relative path for the file to be deleted
 414          * @param mixed $archiveRel Relative path for the archive location.
 415          *        Relative to a private archive directory.
 416          * @return WikiError object (wikitext-formatted), or true for success
 417          */
 418         function delete( $srcRel, $archiveRel ) {
 419                 return $this->deleteBatch( array( array( $srcRel, $archiveRel ) ) );
 420         }
 421
 422         /**
 423          * Get properties of a file with a given virtual URL
 424          * The virtual URL must refer to this repo
 425          * Properties should ultimately be obtained via File::getPropsFromPath()
 426          */
 427         abstract function getFileProps( $virtualUrl );
 428
 429         /**
 430          * Call a callback function for every file in the repository
 431          * May use either the database or the filesystem
 432          * STUB
 433          */
 434         function enumFiles( $callback ) {
 435                 throw new MWException( 'enumFiles is not supported by ' . get_class( $this ) );
 436         }
 437
 438         /**
 439          * Determine if a relative path is valid, i.e. not blank or involving directory traveral
 440          */
 441         function validateFilename( $filename ) {
 442                 if ( strval( $filename ) == '' ) {
 443                         return false;
 444                 }
 445                 if ( wfIsWindows() ) {
 446                         $filename = strtr( $filename, '\\', '/' );
 447                 }
 448                 /**
 449                  * Use the same traversal protection as Title::secureAndSplit()
 450                  */
 451                 if ( strpos( $filename, '.' ) !== false &&
 452                      ( $filename === '.' || $filename === '..' ||
 453                        strpos( $filename, './' ) === 0  ||
 454                        strpos( $filename, '../' ) === 0 ||
 455                        strpos( $filename, '/./' ) !== false ||
 456                        strpos( $filename, '/../' ) !== false ) )
 457                 {
 458                         return false;
 459                 } else {
 460                         return true;
 461                 }
 462         }
 463
 464         /**#@+
 465          * Path disclosure protection functions
 466          */
 467         function paranoidClean( $param ) { return '[hidden]'; }
 468         function passThrough( $param ) { return $param; }
 469
 470         /**
 471          * Get a callback function to use for cleaning error message parameters
 472          */
 473         function getErrorCleanupFunction() {
 474                 switch ( $this->pathDisclosureProtection ) {
 475                         case 'none':
 476                                 $callback = array( $this, 'passThrough' );
 477                                 break;
 478                         default: // 'paranoid'
 479                                 $callback = array( $this, 'paranoidClean' );
 480                 }
 481                 return $callback;
 482         }
 483         /**#@-*/
 484
 485         /**
 486          * Create a new fatal error
 487          */
 488         function newFatal( $message /*, parameters...*/ ) {
 489                 $params = func_get_args();
 490                 array_unshift( $params, $this );
 491                 return call_user_func_array( array( 'FileRepoStatus', 'newFatal' ), $params );
 492         }
 493
 494         /**
 495          * Create a new good result
 496          */
 497         function newGood( $value = null ) {
 498                 return FileRepoStatus::newGood( $this, $value );
 499         }
 500
 501         /**
 502          * Delete files in the deleted directory if they are not referenced in the filearchive table
 503          * STUB
 504          */
 505         function cleanupDeletedBatch( $storageKeys ) {}
 506
 507         /**
 508          * Checks if there is a redirect named as $title
 509          * STUB
 510          *
 511          * @param Title $title Title of image
 512          */
 513         function checkRedirect( $title ) {
 514                 return false;
 515         }
 516
 517         /**
 518          * Invalidates image redirect cache related to that image
 519          * STUB
 520          *
 521          * @param Title $title Title of image
 522          */
 523         function invalidateImageRedirect( $title ) {
 524         }
 525
 526         function findBySha1( $hash ) {
 527                 return array();
 528         }
 529 }