rosell-dk / webp-convert

src/Helpers/FileExists.php

<?php

namespace WebPConvert\Helpers;

/**
 * A fileExist function free of deception
 *
 * @package    WebPConvert
 * @author     Bjørn Rosell <it@rosell.dk>
 * @since      Class available since Release 2.3.0
 */
class FileExists
{

    private static $lastWarning;

    /**
     * A warning handler that registers that a warning has occured and suppresses it.
     *
     * @return void
     */
    public static function warningHandler($errno, $errstr, $errfile, $errline)
    {
        self::$lastWarning = [$errstr, $errno];

        // Suppress the warning by returning void
        return;
    }

    /**
     * A well behaved replacement for file_exist that throws upon failure rather than emmitting a warning.
     *
     * @throws \Exception If file_exists threw a warning
     * @return boolean|null  True if file exists. False if it doesn't.
     */
    public static function honestFileExists($path)
    {
        // There is a challenges here:
        // We want to suppress warnings, but at the same time we want to know that it happened.
        // We achieve this by registering an error handler
        $previousErrorHandler = set_error_handler(

The assignment to $previousErrorHandler is dead and can be removed.

            array('WebPConvert\Helpers\FileExists', "warningHandler"),
            E_WARNING | E_USER_WARNING | E_NOTICE | E_USER_NOTICE
        );
        self::$lastWarning = null;
        $found = @file_exists($path);

        // restore previous error handler immediately
        restore_error_handler();

        // If file_exists returns true, we can rely on there being a file there
        if ($found) {
            return true;
        }

        // file_exists returned false.
        // this result is only trustworthy if no warning was emitted.
        if (is_null(self::$lastWarning)) {
            return false;
        }

        list($errstr, $errno) = self::$lastWarning;
        throw new \Exception($errstr, $errno);
    }

    /**
     * A fileExist based on an exec call.
     *
     * @throws \Exception  If exec cannot be called
     * @return boolean|null  True if file exists. False if it doesn't.
     */
    public static function fileExistsUsingExec($path)
    {
        if (!function_exists('exec')) {
            throw new \Exception(
                'cannot determine if file exists using exec() - the function is unavailable'
            );
        }

        // Lets try to find out by executing "ls path/to/cwebp"
        exec('ls ' . $path, $output, $returnCode);
        if (($returnCode == 0) && (isset($output[0]))) {
            return true;
        }

        // We assume that "ls" command is general available!
        // As that failed, we can conclude the file does not exist.
        return false;
    }

    /**
     * A fileExist doing the best it can.
     *
     * @throws \Exception  If it cannot be determined if the file exists
     * @return boolean|null  True if file exists. False if it doesn't.
     */
    public static function fileExistsTryHarder($path)
    {
        try {
            $result = self::honestFileExists($path);
        } catch (\Exception $e) {
            try {
                $result = self::fileExistsUsingExec($path);
            } catch (\Exception $e) {
                throw new \Exception('Cannot determine if file exists or not');
            }
        }
        return $result;
    }
}