TempFSFile.php

Go to the documentation of this file.

<?php
class TempFSFile extends FSFile {
    protected $canDelete = false;

    protected static $pathsCollect = null;

    public function __construct( $path ) {
        parent::__construct( $path );

        if ( self::$pathsCollect === null ) {
            self::$pathsCollect = [];
            register_shutdown_function( [ __CLASS__, 'purgeAllOnShutdown' ] );
        }
    }

    public static function factory( $prefix, $extension = '', $tmpDirectory = null ) {
        $ext = ( $extension != '' ) ? ".{$extension}" : '';

        $attempts = 5;
        while ( $attempts-- ) {
            $hex = sprintf( '%06x%06x', mt_rand( 0, 0xffffff ), mt_rand( 0, 0xffffff ) );
            if ( !is_string( $tmpDirectory ) ) {
                $tmpDirectory = self::getUsableTempDirectory();
            }
            $path = wfTempDir() . '/' . $prefix . $hex . $ext;
            MediaWiki\suppressWarnings();
            $newFileHandle = fopen( $path, 'x' );
            MediaWiki\restoreWarnings();
            if ( $newFileHandle ) {
                fclose( $newFileHandle );
                $tmpFile = new self( $path );
                $tmpFile->autocollect();
                // Safely instantiated, end loop.
                return $tmpFile;
            }
        }

        // Give up
        return null;
    }

    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 ( strtoupper( substr( PHP_OS, 0, 3 ) ) === 'WIN' ) {
            $tmp = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'mwtmp-' . get_current_user();
            if ( !file_exists( $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
        MediaWiki\suppressWarnings();
        $ok = unlink( $this->path );
        MediaWiki\restoreWarnings();

        unset( self::$pathsCollect[$this->path] );

        return $ok;
    }

    public function bind( $object ) {
        if ( is_object( $object ) ) {
            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 ) {
            MediaWiki\suppressWarnings();
            unlink( $path );
            MediaWiki\restoreWarnings();
        }
    }

    function __destruct() {
        if ( $this->canDelete ) {
            $this->purge();
        }
    }
}