TempFSFileFactory.php

Go to the documentation of this file.

<?php
 
namespace MediaWiki\FileBackend\FSFile;
 
use Wikimedia\AtEase\AtEase;
use Wikimedia\FileBackend\FSFile\TempFSFile;
 
class TempFSFileFactory {
    private $tmpDirectory;
 
    public function __construct( $tmpDirectory = null ) {
        $this->tmpDirectory = $tmpDirectory;
    }
 
    public function newTempFSFile( $prefix, $extension = '' ) {
        $ext = ( $extension != '' ) ? ".{$extension}" : '';
        $tmpDirectory = $this->tmpDirectory;
        if ( !is_string( $tmpDirectory ) ) {
            $tmpDirectory = TempFSFile::getUsableTempDirectory();
        }
 
        $attempts = 5;
        while ( $attempts-- ) {
            $hex = sprintf( '%06x%06x', mt_rand( 0, 0xffffff ), mt_rand( 0, 0xffffff ) );
            $path = "$tmpDirectory/$prefix$hex$ext";
            AtEase::suppressWarnings();
            $newFileHandle = fopen( $path, 'x' );
            AtEase::restoreWarnings();
            if ( $newFileHandle ) {
                fclose( $newFileHandle );
                $tmpFile = new TempFSFile( $path );
                $tmpFile->autocollect();
                // Safely instantiated, end loop.
                return $tmpFile;
            }
        }
 
        // Give up
        return null; // @codeCoverageIgnore
    }
}