FileHandler::gc() - Code Metrics - o2system/session - Measure and Improve Code Quality continuously with Scrutinizer

FileHandler::gc() B
last analyzed 2019-09-25 13:12 UTC

↳ Parent: FileHandler
Complexity

Conditions	9
Paths	5
Size

Total Lines	28
Code Lines	14
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
cc	9
eloc	14
c	1
b	0
f	0
nc	5
nop	1
dl	0
loc	28
rs	8.0555
<?php
/**
 * This file is part of the O2System Framework package.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @author         Steeve Andrian Salim
 * @copyright      Copyright (c) Steeve Andrian Salim
 */

// ------------------------------------------------------------------------

namespace O2System\Session\Handlers;

// ------------------------------------------------------------------------

use Psr\Log\LoggerInterface;
use O2System\Session\Abstracts\AbstractHandler;

/**
 * Class FileHandler
 *
 * @package O2System\Session\Handlers
 */
class FileHandler extends AbstractHandler
{
    /**
     * Platform Name
     *
     * @var string
     */
    protected $platform = 'file';

    /**
     * File Handle
     *
     * @var resource
     */
    protected $file;

    /**
     * File write path
     *
     * @var string
     */
    protected $path;

    /**
     * File Name and Path
     *
     * @var resource
     */
    protected $filePath;

    /**
     * Is New File Flag
     *
     * @var bool
     */
    protected $isNewFile;

    // ------------------------------------------------------------------------

    /**
     * FileHandler::open
     *
     * Initialize session
     *
     * @link  http://php.net/manual/en/sessionhandlerinterface.open.php
     *
     * @param string $save_path The path where to store/retrieve the session.
     * @param string $name      The session name.
     *
     * @return bool <p>
     * The return value (usually TRUE on success, FALSE on failure).
     * Note this value is returned internally to PHP for processing.
     * </p>
     * @since 5.4.0
     */
    public function open($save_path, $name)
    {
        $this->path = $this->config[ 'filePath' ];

        if ($this->isSupported() === false) {
            if ($this->logger instanceof LoggerInterface) {

                $this->logger->error('SESSION_E_FILE_UNSUPPORTED', [$this->path]);
            }

            return $this->failure;
        }

        $this->filePath = $this->path

            . $name . '-' // we'll use the session cookie name as a prefix to avoid collisions
            . ($this->config[ 'match' ]->ip ? md5($_SERVER[ 'REMOTE_ADDR' ]) . '-' : '');

        return $this->success;
    }

    // ------------------------------------------------------------------------

    /**
     * FileHandler::isSupported
     *
     * Checks if this platform is supported on this system.
     *
     * @return bool Returns FALSE if unsupported.
     */
    public function isSupported()
    {
        if ( ! is_writable($this->path)) {
            @mkdir($this->path, 0777, true);
            /** @scrutinizer ignore-unhandled */ @mkdir($this->path, 0777, true);
        }

        return (bool)is_writable($this->path);
    }

    // ------------------------------------------------------------------------

    /**
     * FileHandler::destroy
     *
     * Destroy a session
     *
     * @link  http://php.net/manual/en/sessionhandlerinterface.destroy.php
     *
     * @param string $session_id The session ID being destroyed.
     *
     * @return bool <p>
     * The return value (usually TRUE on success, FALSE on failure).
     * Note this value is returned internally to PHP for processing.
     * </p>
     * @since 5.4.0
     */
    public function destroy($session_id)
    {
        if ($this->close()) {
            return file_exists($this->filePath . $session_id)
            return file_exists(/** @scrutinizer ignore-type */ $this->filePath . $session_id)
                ? (unlink($this->filePath . $session_id) && $this->destroyCookie())
                : true;
        } elseif ($this->filePath !== null) {
            clearstatcache();

            return file_exists($this->filePath . $session_id)
                ? (unlink($this->filePath . $session_id) && $this->destroyCookie())
                : true;
        }

        return false;
    }

    // ------------------------------------------------------------------------

    /**
     * FileHandler::close
     *
     * Close the session
     *
     * @link  http://php.net/manual/en/sessionhandlerinterface.close.php
     * @return bool <p>
     *        The return value (usually TRUE on success, FALSE on failure).
     *        Note this value is returned internally to PHP for processing.
     *        </p>
     * @since 5.4.0
     */
    public function close()
    {
        if (is_resource($this->file)) {
            flock($this->file, LOCK_UN);
            fclose($this->file);

            $this->file = $this->isNewFile = $this->sessionId = null;

            return true;
        }

        return true;
    }

    // ------------------------------------------------------------------------

    /**
     * FileHandler::gc
     *
     * Cleanup old sessions
     *
     * @link  http://php.net/manual/en/sessionhandlerinterface.gc.php
     *
     * @param int $maxlifetime <p>
     *                         Sessions that have not updated for
     *                         the last maxlifetime seconds will be removed.
     *                         </p>
     *
     * @return bool <p>
     * The return value (usually TRUE on success, FALSE on failure).
     * Note this value is returned internally to PHP for processing.
     * </p>
     * @since 5.4.0
     */
    public function gc($maxlifetime)
    {
        if ( ! is_dir($this->path) || ($directory = opendir($this->path)) === false) {
            if ($this->logger instanceof LoggerInterface) {

                $this->logger->error('SESSION_E_FILE_ON_GC', [$this->path]);
            }

            return false;
        }

        $ts = time() - $maxlifetime;

        while (($file = readdir($directory)) !== false) {
            // If the filename doesn't match this pattern, it's either not a session file or is not ours
            if ( ! preg_match('/[' . $this->config[ 'name' ] . '-]+[0-9-a-f]+/', $file)
                || ! is_file($this->path . '/' . $file)
                || ($mtime = filemtime($this->path . '/' . $file)) === false
                || $mtime > $ts
            ) {
                continue;
            }

            unlink($this->path . '/' . $file);
        }

        closedir($directory);

        return true;
    }

    // ------------------------------------------------------------------------

    /**
     * FileHandler::write
     *
     * Write session data
     *
     * @link  http://php.net/manual/en/sessionhandlerinterface.write.php
     *
     * @param string $session_id   The session id.
     * @param string $session_data <p>
     *                             The encoded session data. This data is the
     *                             result of the PHP internally encoding
     *                             the $_SESSION superglobal to a serialized
     *                             string and passing it as this parameter.
     *                             Please note sessions use an alternative serialization method.
     *                             </p>
     *
     * @return bool <p>
     * The return value (usually TRUE on success, FALSE on failure).
     * Note this value is returned internally to PHP for processing.
     * </p>
     * @since 5.4.0
     */
    public function write($session_id, $session_data)
    {
        // If the two IDs don't match, we have a session_regenerate_id() call
        // and we need to close the old handle and open a new one
        if ($session_id !== $this->sessionId && ( ! $this->close() || $this->read($session_id) === false)) {
            return false;
        }

        if ( ! is_resource($this->file)) {
            return false;
        } elseif ($this->fingerprint === md5($session_data)) {
            return ($this->isNewFile)
                ? true
                : touch($this->filePath . $session_id);
                : touch(/** @scrutinizer ignore-type */ $this->filePath . $session_id);
        }

        if ( ! $this->isNewFile) {
            ftruncate($this->file, 0);
            rewind($this->file);
        }

        if (($length = strlen($session_data)) > 0) {
            for ($written = 0; $written < $length; $written += $result) {
                if (($result = fwrite($this->file, substr($session_data, $written))) === false) {
                    break;
                }
            }

            if ( ! is_int($result)) {

                $this->fingerprint = md5(substr($session_data, 0, $written));
$answer = 42;

$correct = false;

$correct = (bool) $answer;

                if ($this->logger instanceof LoggerInterface) {

                    $this->logger->error('SESSION_E_FILE_ON_WRITE');
                }

                return false;
            }
        }

        $this->fingerprint = md5($session_data);

        return true;
    }

    // ------------------------------------------------------------------------

    /**
     * FileHandler::read
     *
     * Read session data
     *
     * @link  http://php.net/manual/en/sessionhandlerinterface.read.php
     *
     * @param string $session_id The session id to read data for.
     *
     * @return string <p>
     * Returns an encoded string of the read data.
     * If nothing was read, it must return an empty string.
     * Note this value is returned internally to PHP for processing.
     * </p>
     * @since 5.4.0
     */
    public function read($session_id)
    {
        // This might seem weird, but PHP 5.6 introduced session_reset(),
        // which re-reads session data
        if ($this->file === null) {
            if (($this->file = fopen($this->filePath . $session_id, 'c+b')) === false) {
            if (($this->file = fopen(/** @scrutinizer ignore-type */ $this->filePath . $session_id, 'c+b')) === false) {
                if ($this->logger instanceof LoggerInterface) {

                    $this->logger->error('SESSION_E_FILE_ON_READ', [$this->filePath . $session_id]);
                }

                return false;

            }

            if (flock($this->file, LOCK_EX) === false) {
                fclose($this->file);
                $this->file = null;

                if ($this->logger instanceof LoggerInterface) {

                    $this->logger->error('SESSION_E_ON_LOCK', [$this->filePath . $session_id]);
                }

                return false;

            }

            // Needed by write() to detect session_regenerate_id() calls
            $this->sessionId = $session_id;

            if ($this->isNewFile) {
                chmod($this->filePath . $session_id, 0600);
                $this->fingerprint = md5('');
$answer = 42;

$correct = false;

$correct = (bool) $answer;

                return '';
            }
        } else {
            rewind($this->file);
        }

        $sessionData = '';
        for ($read = 0, $length = filesize($this->filePath . $session_id); $read < $length; $read += strlen(
            $buffer
        )
        ) {
            if (($buffer = fread($this->file, $length - $read)) === false) {
                break;
            }

            $sessionData .= $buffer;
        }

        $this->fingerprint = md5($sessionData);

        return $sessionData;
    }
}
o2system / session

GitHub Access Token became invalid

FileHandler::gc() B last analyzed 2019-09-25 13:12 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

FileHandler::gc() B
last analyzed 2019-09-25 13:12 UTC
