4 * A repository for files accessible via the local filesystem. Does not support
5 * database access or registration.
8 class FSRepo
extends FileRepo
{
9 var $directory, $deletedDir, $url, $hashLevels, $deletedHashLevels;
10 var $fileFactory = array( 'UnregisteredLocalFile', 'newFromTitle' );
11 var $oldFileFactory = false;
12 var $pathDisclosureProtection = 'simple';
14 function __construct( $info ) {
15 parent
::__construct( $info );
18 $this->directory
= $info['directory'];
19 $this->url
= $info['url'];
22 $this->hashLevels
= isset( $info['hashLevels'] ) ?
$info['hashLevels'] : 2;
23 $this->deletedHashLevels
= isset( $info['deletedHashLevels'] ) ?
24 $info['deletedHashLevels'] : $this->hashLevels
;
25 $this->deletedDir
= isset( $info['deletedDir'] ) ?
$info['deletedDir'] : false;
29 * Get the public root directory of the repository.
31 function getRootDirectory() {
32 return $this->directory
;
36 * Get the public root URL of the repository
38 function getRootUrl() {
43 * Returns true if the repository uses a multi-level directory structure
46 return (bool)$this->hashLevels
;
50 * Get the local directory corresponding to one of the three basic zones
52 function getZonePath( $zone ) {
55 return $this->directory
;
57 return "{$this->directory}/temp";
59 return $this->deletedDir
;
66 * Get the URL corresponding to one of the three basic zones
68 function getZoneUrl( $zone ) {
73 return "{$this->url}/temp";
75 return false; // no public URL
82 * Get a URL referring to this repository, with the private mwrepo protocol.
83 * The suffix, if supplied, is considered to be unencoded, and will be
84 * URL-encoded before being returned.
86 function getVirtualUrl( $suffix = false ) {
87 $path = 'mwrepo://' . $this->name
;
88 if ( $suffix !== false ) {
89 $path .= '/' . rawurlencode( $suffix );
95 * Get the local path corresponding to a virtual URL
97 function resolveVirtualUrl( $url ) {
98 if ( substr( $url, 0, 9 ) != 'mwrepo://' ) {
99 throw new MWException( __METHOD__
.': unknown protoocl' );
102 $bits = explode( '/', substr( $url, 9 ), 3 );
103 if ( count( $bits ) != 3 ) {
104 throw new MWException( __METHOD__
.": invalid mwrepo URL: $url" );
106 list( $repo, $zone, $rel ) = $bits;
107 if ( $repo !== $this->name
) {
108 throw new MWException( __METHOD__
.": fetching from a foreign repo is not supported" );
110 $base = $this->getZonePath( $zone );
112 throw new MWException( __METHOD__
.": invalid zone: $zone" );
114 return $base . '/' . rawurldecode( $rel );
118 * Store a batch of files
120 * @param array $triplets (src,zone,dest) triplets as per store()
121 * @param integer $flags Bitwise combination of the following flags:
122 * self::DELETE_SOURCE Delete the source file after upload
123 * self::OVERWRITE Overwrite an existing destination file instead of failing
124 * self::OVERWRITE_SAME Overwrite the file if the destination exists and has the
125 * same contents as the source
127 function storeBatch( $triplets, $flags = 0 ) {
128 if ( !wfMkdirParents( $this->directory
) ) {
129 return $this->newFatal( 'upload_directory_missing', $this->directory
);
131 if ( !is_writable( $this->directory
) ) {
132 return $this->newFatal( 'upload_directory_read_only', $this->directory
);
134 $status = $this->newGood();
135 foreach ( $triplets as $i => $triplet ) {
136 list( $srcPath, $dstZone, $dstRel ) = $triplet;
138 $root = $this->getZonePath( $dstZone );
140 throw new MWException( "Invalid zone: $dstZone" );
142 if ( !$this->validateFilename( $dstRel ) ) {
143 throw new MWException( 'Validation error in $dstRel' );
145 $dstPath = "$root/$dstRel";
146 $dstDir = dirname( $dstPath );
148 if ( !is_dir( $dstDir ) ) {
149 if ( !wfMkdirParents( $dstDir ) ) {
150 return $this->newFatal( 'directorycreateerror', $dstDir );
152 // In the deleted zone, seed new directories with a blank
153 // index.html, to prevent crawling
154 if ( $dstZone == 'deleted' ) {
155 file_put_contents( "$dstDir/index.html", '' );
159 if ( self
::isVirtualUrl( $srcPath ) ) {
160 $srcPath = $triplets[$i][0] = $this->resolveVirtualUrl( $srcPath );
162 if ( !is_file( $srcPath ) ) {
163 // Make a list of files that don't exist for return to the caller
164 $status->fatal( 'filenotfound', $srcPath );
167 if ( !( $flags & self
::OVERWRITE
) && file_exists( $dstPath ) ) {
168 if ( $flags & self
::OVERWRITE_SAME
) {
169 $hashSource = sha1_file( $srcPath );
170 $hashDest = sha1_file( $dstPath );
171 if ( $hashSource != $hashDest ) {
172 $status->fatal( 'fileexistserror', $dstPath );
175 $status->fatal( 'fileexistserror', $dstPath );
180 $deleteDest = wfIsWindows() && ( $flags & self
::OVERWRITE
);
182 // Abort now on failure
183 if ( !$status->ok
) {
187 foreach ( $triplets as $triplet ) {
188 list( $srcPath, $dstZone, $dstRel ) = $triplet;
189 $root = $this->getZonePath( $dstZone );
190 $dstPath = "$root/$dstRel";
193 if ( $flags & self
::DELETE_SOURCE
) {
197 if ( !rename( $srcPath, $dstPath ) ) {
198 $status->error( 'filerenameerror', $srcPath, $dstPath );
202 if ( !copy( $srcPath, $dstPath ) ) {
203 $status->error( 'filecopyerror', $srcPath, $dstPath );
208 chmod( $dstPath, 0644 );
209 $status->successCount++
;
211 $status->failCount++
;
218 * Pick a random name in the temp zone and store a file to it.
219 * @param string $originalName The base name of the file as specified
220 * by the user. The file extension will be maintained.
221 * @param string $srcPath The current location of the file.
222 * @return FileRepoStatus object with the URL in the value.
224 function storeTemp( $originalName, $srcPath ) {
225 $date = gmdate( "YmdHis" );
226 $hashPath = $this->getHashPath( $originalName );
227 $dstRel = "$hashPath$date!$originalName";
228 $dstUrlRel = $hashPath . $date . '!' . rawurlencode( $originalName );
230 $result = $this->store( $srcPath, 'temp', $dstRel );
231 $result->value
= $this->getVirtualUrl( 'temp' ) . '/' . $dstUrlRel;
236 * Remove a temporary file or mark it for garbage collection
237 * @param string $virtualUrl The virtual URL returned by storeTemp
238 * @return boolean True on success, false on failure
240 function freeTemp( $virtualUrl ) {
241 $temp = "mwrepo://{$this->name}/temp";
242 if ( substr( $virtualUrl, 0, strlen( $temp ) ) != $temp ) {
243 wfDebug( __METHOD__
.": Invalid virtual URL\n" );
246 $path = $this->resolveVirtualUrl( $virtualUrl );
247 wfSuppressWarnings();
248 $success = unlink( $path );
254 * Publish a batch of files
255 * @param array $triplets (source,dest,archive) triplets as per publish()
256 * @param integer $flags Bitfield, may be FileRepo::DELETE_SOURCE to indicate
257 * that the source files should be deleted if possible
259 function publishBatch( $triplets, $flags = 0 ) {
260 // Perform initial checks
261 if ( !wfMkdirParents( $this->directory
) ) {
262 return $this->newFatal( 'upload_directory_missing', $this->directory
);
264 if ( !is_writable( $this->directory
) ) {
265 return $this->newFatal( 'upload_directory_read_only', $this->directory
);
267 $status = $this->newGood( array() );
268 foreach ( $triplets as $i => $triplet ) {
269 list( $srcPath, $dstRel, $archiveRel ) = $triplet;
271 if ( substr( $srcPath, 0, 9 ) == 'mwrepo://' ) {
272 $triplets[$i][0] = $srcPath = $this->resolveVirtualUrl( $srcPath );
274 if ( !$this->validateFilename( $dstRel ) ) {
275 throw new MWException( 'Validation error in $dstRel' );
277 if ( !$this->validateFilename( $archiveRel ) ) {
278 throw new MWException( 'Validation error in $archiveRel' );
280 $dstPath = "{$this->directory}/$dstRel";
281 $archivePath = "{$this->directory}/$archiveRel";
283 $dstDir = dirname( $dstPath );
284 $archiveDir = dirname( $archivePath );
285 // Abort immediately on directory creation errors since they're likely to be repetitive
286 if ( !is_dir( $dstDir ) && !wfMkdirParents( $dstDir ) ) {
287 return $this->newFatal( 'directorycreateerror', $dstDir );
289 if ( !is_dir( $archiveDir ) && !wfMkdirParents( $archiveDir ) ) {
290 return $this->newFatal( 'directorycreateerror', $archiveDir );
292 if ( !is_file( $srcPath ) ) {
293 // Make a list of files that don't exist for return to the caller
294 $status->fatal( 'filenotfound', $srcPath );
298 if ( !$status->ok
) {
302 foreach ( $triplets as $i => $triplet ) {
303 list( $srcPath, $dstRel, $archiveRel ) = $triplet;
304 $dstPath = "{$this->directory}/$dstRel";
305 $archivePath = "{$this->directory}/$archiveRel";
307 // Archive destination file if it exists
308 if( is_file( $dstPath ) ) {
309 // Check if the archive file exists
310 // This is a sanity check to avoid data loss. In UNIX, the rename primitive
311 // unlinks the destination file if it exists. DB-based synchronisation in
312 // publishBatch's caller should prevent races. In Windows there's no
313 // problem because the rename primitive fails if the destination exists.
314 if ( is_file( $archivePath ) ) {
317 wfSuppressWarnings();
318 $success = rename( $dstPath, $archivePath );
323 $status->error( 'filerenameerror',$dstPath, $archivePath );
324 $status->failCount++
;
327 wfDebug(__METHOD__
.": moved file $dstPath to $archivePath\n");
329 $status->value
[$i] = 'archived';
331 $status->value
[$i] = 'new';
335 wfSuppressWarnings();
336 if ( $flags & self
::DELETE_SOURCE
) {
337 if ( !rename( $srcPath, $dstPath ) ) {
338 $status->error( 'filerenameerror', $srcPath, $dstPath );
342 if ( !copy( $srcPath, $dstPath ) ) {
343 $status->error( 'filecopyerror', $srcPath, $dstPath );
350 $status->successCount++
;
351 wfDebug(__METHOD__
.": wrote tempfile $srcPath to $dstPath\n");
352 // Thread-safe override for umask
353 chmod( $dstPath, 0644 );
355 $status->failCount++
;
362 * Move a group of files to the deletion archive.
363 * If no valid deletion archive is configured, this may either delete the
364 * file or throw an exception, depending on the preference of the repository.
366 * @param array $sourceDestPairs Array of source/destination pairs. Each element
367 * is a two-element array containing the source file path relative to the
368 * public root in the first element, and the archive file path relative
369 * to the deleted zone root in the second element.
370 * @return FileRepoStatus
372 function deleteBatch( $sourceDestPairs ) {
373 $status = $this->newGood();
374 if ( !$this->deletedDir
) {
375 throw new MWException( __METHOD__
.': no valid deletion archive directory' );
379 * Validate filenames and create archive directories
381 foreach ( $sourceDestPairs as $pair ) {
382 list( $srcRel, $archiveRel ) = $pair;
383 if ( !$this->validateFilename( $srcRel ) ) {
384 throw new MWException( __METHOD__
.':Validation error in $srcRel' );
386 if ( !$this->validateFilename( $archiveRel ) ) {
387 throw new MWException( __METHOD__
.':Validation error in $archiveRel' );
389 $archivePath = "{$this->deletedDir}/$archiveRel";
390 $archiveDir = dirname( $archivePath );
391 if ( !is_dir( $archiveDir ) ) {
392 if ( !wfMkdirParents( $archiveDir ) ) {
393 $status->fatal( 'directorycreateerror', $archiveDir );
396 // Seed new directories with a blank index.html, to prevent crawling
397 file_put_contents( "$archiveDir/index.html", '' );
399 // Check if the archive directory is writable
400 // This doesn't appear to work on NTFS
401 if ( !is_writable( $archiveDir ) ) {
402 $status->fatal( 'filedelete-archive-read-only', $archiveDir );
405 if ( !$status->ok
) {
412 * We're now committed to returning an OK result, which will lead to
413 * the files being moved in the DB also.
415 foreach ( $sourceDestPairs as $pair ) {
416 list( $srcRel, $archiveRel ) = $pair;
417 $srcPath = "{$this->directory}/$srcRel";
418 $archivePath = "{$this->deletedDir}/$archiveRel";
420 if ( file_exists( $archivePath ) ) {
421 # A file with this content hash is already archived
422 if ( !@unlink
( $srcPath ) ) {
423 $status->error( 'filedeleteerror', $srcPath );
427 if ( !@rename
( $srcPath, $archivePath ) ) {
428 $status->error( 'filerenameerror', $srcPath, $archivePath );
431 @chmod
( $archivePath, 0644 );
435 $status->successCount++
;
437 $status->failCount++
;
444 * Get a relative path including trailing slash, e.g. f/fa/
445 * If the repo is not hashed, returns an empty string
447 function getHashPath( $name ) {
448 return FileRepo
::getHashPathForLevel( $name, $this->hashLevels
);
452 * Get a relative path for a deletion archive key,
453 * e.g. s/z/a/ for sza251lrxrc1jad41h5mgilp8nysje52.jpg
455 function getDeletedHashPath( $key ) {
457 for ( $i = 0; $i < $this->deletedHashLevels
; $i++
) {
458 $path .= $key[$i] . '/';
464 * Call a callback function for every file in the repository.
465 * Uses the filesystem even in child classes.
467 function enumFilesInFS( $callback ) {
468 $numDirs = 1 << ( $this->hashLevels
* 4 );
469 for ( $flatIndex = 0; $flatIndex < $numDirs; $flatIndex++
) {
470 $hexString = sprintf( "%0{$this->hashLevels}x", $flatIndex );
471 $path = $this->directory
;
472 for ( $hexPos = 0; $hexPos < $this->hashLevels
; $hexPos++
) {
473 $path .= '/' . substr( $hexString, 0, $hexPos +
1 );
475 if ( !file_exists( $path ) ||
!is_dir( $path ) ) {
478 $dir = opendir( $path );
479 while ( false !== ( $name = readdir( $dir ) ) ) {
480 call_user_func( $callback, $path . '/' . $name );
486 * Call a callback function for every file in the repository
487 * May use either the database or the filesystem
489 function enumFiles( $callback ) {
490 $this->enumFilesInFS( $callback );
494 * Get properties of a file with a given virtual URL
495 * The virtual URL must refer to this repo
497 function getFileProps( $virtualUrl ) {
498 $path = $this->resolveVirtualUrl( $virtualUrl );
499 return File
::getPropsFromPath( $path );
503 * Path disclosure protection functions
505 * Get a callback function to use for cleaning error message parameters
507 function getErrorCleanupFunction() {
508 switch ( $this->pathDisclosureProtection
) {
510 $callback = array( $this, 'simpleClean' );
513 $callback = parent
::getErrorCleanupFunction();
518 function simpleClean( $param ) {
519 if ( !isset( $this->simpleCleanPairs
) ) {
521 $this->simpleCleanPairs
= array(
522 $this->directory
=> 'public',
523 "{$this->directory}/temp" => 'temp',
525 dirname( __FILE__
) => '$IP/extensions/WebStore',
527 if ( $this->deletedDir
) {
528 $this->simpleCleanPairs
[$this->deletedDir
] = 'deleted';
531 return strtr( $param, $this->simpleCleanPairs
);