TempFSFile.php

Go to the documentation of this file.

<?php
 
namespace Wikimedia\FileBackend\FSFile;
 
use MediaWiki\FileBackend\FSFile\TempFSFileFactory;
use RuntimeException;
use WeakMap;
use Wikimedia\AtEase\AtEase;
 
class TempFSFile extends FSFile {
    protected $canDelete = false;
 
    protected static $pathsCollect = null;
 
    private static $references;
 
    public function __construct( $path ) {
        parent::__construct( $path );
 
        if ( self::$pathsCollect === null ) {
            // @codeCoverageIgnoreStart
            self::$pathsCollect = [];
            register_shutdown_function( [ __CLASS__, 'purgeAllOnShutdown' ] );
            // @codeCoverageIgnoreEnd
        }
    }
 
    public static function factory( $prefix, $extension = '', $tmpDirectory = null ) {
        return ( new TempFSFileFactory( $tmpDirectory ) )->newTempFSFile( $prefix, $extension );
    }
 
    public static function getUsableTempDirectory() {
        $tmpDir = array_map( 'getenv', [ 'TMPDIR', 'TMP', 'TEMP' ] );
        $tmpDir[] = sys_get_temp_dir();
        $tmpDir[] = ini_get( 'upload_tmp_dir' );
        foreach ( $tmpDir as $tmp ) {
            if ( $tmp != '' && is_dir( $tmp ) && is_writable( $tmp ) ) {
                return $tmp;
            }
        }
 
        // PHP on Windows will detect C:\Windows\Temp as not writable even though PHP can write to
        // it so create a directory within that called 'mwtmp' with a suffix of the user running
        // the current process.
        // The user is included as if various scripts are run by different users they will likely
        // not be able to access each others temporary files.
        if ( PHP_OS_FAMILY === 'Windows' ) {
            $tmp = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'mwtmp-' . get_current_user();
            if ( !is_dir( $tmp ) ) {
                mkdir( $tmp );
            }
            if ( is_dir( $tmp ) && is_writable( $tmp ) ) {
                return $tmp;
            }
        }
 
        throw new RuntimeException(
            'No writable temporary directory could be found. ' .
            'Please explicitly specify a writable directory in configuration.' );
    }
 
    public function purge() {
        $this->canDelete = false; // done
        AtEase::suppressWarnings();
        $ok = unlink( $this->path );
        AtEase::restoreWarnings();
 
        unset( self::$pathsCollect[$this->path] );
 
        return $ok;
    }
 
    public function bind( $object ) {
        if ( is_object( $object ) ) {
            // Use a WeakMap on PHP >= 8.0 to avoid dynamic property creation (T324894)
            if ( PHP_VERSION_ID >= 80000 ) {
                if ( self::$references === null ) {
                    self::$references = new WeakMap;
                }
                self::$references[$object] = $this;
            } else {
                // PHP 7.4
                if ( !isset( $object->tempFSFileReferences ) ) {
                    // Init first since $object might use __get() and return only a copy variable
                    $object->tempFSFileReferences = [];
                }
                $object->tempFSFileReferences[] = $this;
            }
        }
 
        return $this;
    }
 
    public function preserve() {
        $this->canDelete = false;
 
        unset( self::$pathsCollect[$this->path] );
 
        return $this;
    }
 
    public function autocollect() {
        $this->canDelete = true;
 
        self::$pathsCollect[$this->path] = 1;
 
        return $this;
    }
 
    public static function purgeAllOnShutdown() {
        foreach ( self::$pathsCollect as $path => $unused ) {
            AtEase::suppressWarnings();
            unlink( $path );
            AtEase::restoreWarnings();
        }
    }
 
    public function __destruct() {
        if ( $this->canDelete ) {
            $this->purge();
        }
    }
}
 
class_alias( TempFSFile::class, 'TempFSFile' );