TempFSFile.php

Go to the documentation of this file.

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

    protected static $instances = array();

    protected static $pathsCollect = null;

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

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

    public static function factory( $prefix, $extension = '' ) {
        wfProfileIn( __METHOD__ );
        $base = wfTempDir() . '/' . $prefix . wfRandomString( 12 );
        $ext = ( $extension != '' ) ? ".{$extension}" : "";
        for ( $attempt = 1; true; $attempt++ ) {
            $path = "{$base}-{$attempt}{$ext}";
            wfSuppressWarnings();
            $newFileHandle = fopen( $path, 'x' );
            wfRestoreWarnings();
            if ( $newFileHandle ) {
                fclose( $newFileHandle );
                break; // got it
            }
            if ( $attempt >= 5 ) {
                wfProfileOut( __METHOD__ );

                return null; // give up
            }
        }
        $tmpFile = new self( $path );
        $tmpFile->autocollect(); // safely instantiated
        wfProfileOut( __METHOD__ );

        return $tmpFile;
    }

    public function purge() {
        $this->canDelete = false; // done
        wfSuppressWarnings();
        $ok = unlink( $this->path );
        wfRestoreWarnings();

        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 = array();
            }
            $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 ) {
            wfSuppressWarnings();
            unlink( $path );
            wfRestoreWarnings();
        }
    }

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