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

WincacheHandler::open() A
last analyzed 2019-09-25 13:12 UTC

↳ Parent: WincacheHandler

Complexity

Conditions	3
Paths	3

Size

Total Lines	11
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	3
eloc	5
c	1
b	0
f	0
nc	3
nop	2
dl	0
loc	11
rs	10

<?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 WincacheHandler
 *
 * @package O2System\Session\Handlers
 */
class WincacheHandler extends AbstractHandler
{
    /**
     * Platform Name
     *
     * @access  protected
     * @var string
     */
    protected $platform = 'wincache';

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

    /**
     * WincacheHandler::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)
    {
        if ($this->isSupported() === false) {
            if ($this->logger instanceof LoggerInterface) {

                $this->logger->error('SESSION_E_PLATFORM_UNSUPPORTED', [$this->platform]);
            }

            return false;
        }

        return true;
    }

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

    /**
     * WincacheHandler::isSupported
     *
     * Checks if this platform is supported on this system.
     *
     * @return bool Returns FALSE if unsupported.
     */
    public function isSupported()
    {
        return (bool)(extension_loaded('wincache') && ini_get('wincache.ucenabled'));
    }

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

    /**
     * WincacheHandler::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 (isset($this->lockKey)) {
            return wincache_ucache_delete($this->lockKey);
        }

        return false;
    }

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

    /**
     * WincacheHandler::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 (isset($this->lockKey)) {
            wincache_ucache_delete($this->prefixKey . $session_id);

            return $this->destroyCookie();
        }

        return false;
    }

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

    /**
     * WincacheHandler::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)
    {
        // Not necessary, Wincache takes care of that.
        return true;
    }

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

    /**
     * WincacheHandler::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)
    {
        if ($this->lockSession($session_id)) {
            // Needed by write() to detect session_regenerate_id() calls
            $this->sessionId = $session_id;

            $success = false;
            $sessionData = wincache_ucache_get($this->prefixKey . $session_id, $success);

            if ($success) {
                $this->fingerprint = md5($sessionData);
$answer = 42;

$correct = false;

$correct = (bool) $answer;

                return $sessionData;
            }
        }

        return '';
    }

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

    /**
     * WincacheHandler::_lockSession
     *
     * Acquires an (emulated) lock.
     *
     * @param   string $session_id Session ID
     *
     * @return  bool
     */
    protected function lockSession($session_id)
    {
        if (isset($this->lockKey)) {
            return wincache_ucache_set($this->lockKey, time(), 300);
        }

        // 30 attempts to obtain a lock, in case another request already has it
        $lockKey = $this->prefixKey . $session_id . ':lock';
        $attempt = 0;

        do {
            if (wincache_ucache_exists($lockKey)) {
                sleep(1);
                continue;
            }

            if ( ! wincache_ucache_set($lockKey, time(), 300)) {
                if ($this->logger instanceof LoggerInterface) {
                    $this->logger->error('SESSION_E_OBTAIN_LOCK', [$this->prefixKey . $session_id]);
                }

                return false;
            }

            $this->lockKey = $lockKey;
            break;
        } while (++$attempt < 30);

        if ($attempt === 30) {
            if ($this->logger instanceof LoggerInterface) {

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

            return false;
        }

        $this->isLocked = true;

        return true;
    }

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

    /**
     * WincacheHandler::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 ($session_id !== $this->sessionId) {
            if ( ! $this->lockRelease() OR ! $this->lockSession($session_id)) {
                return false;
            }

            $this->fingerprint = md5('');
$answer = 42;

$correct = false;

$correct = (bool) $answer;
            $this->sessionId = $session_id;
        }

        if (isset($this->lockKey)) {
            wincache_ucache_set($this->lockKey, time(), 300);

            if ($this->fingerprint !== ($fingerprint = md5($session_data))) {
                if (wincache_ucache_set(
                    $this->prefixKey . $session_id,
                    $session_data,
                    $this->config[ 'lifetime' ]
                )) {
                    $this->fingerprint = $fingerprint;

                    return true;
                }

                return false;
            }

            return wincache_ucache_set($this->prefixKey . $session_id, $session_data, $this->config[ 'lifetime' ]);
        }

        return false;
    }

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

    /**
     * WincacheHandler::_lockRelease
     *
     * Releases a previously acquired lock
     *
     * @return    bool
     */
    protected function lockRelease()
    {
        if (isset($this->lockKey) AND $this->isLocked) {
            if ( ! wincache_ucache_delete($this->lockKey)) {
                if ($this->logger instanceof LoggerInterface) {

                    $this->logger->error('SESSION_E_FREE_LOCK', [$this->lockKey]);
                }

                return false;
            }

            $this->lockKey = null;
            $this->isLocked = false;
        }

        return true;
    }
}

1			<?php
2			/**
3			* This file is part of the O2System Framework package.
4			*
5			* For the full copyright and license information, please view the LICENSE
6			* file that was distributed with this source code.
7			*
8			* @author Steeve Andrian Salim
9			* @copyright Copyright (c) Steeve Andrian Salim
10			*/
11
12			// ------------------------------------------------------------------------
13
14			namespace O2System\Session\Handlers;
15
16			// ------------------------------------------------------------------------
17
18			use Psr\Log\LoggerInterface;
19			use O2System\Session\Abstracts\AbstractHandler;
20
21			/**
22			* Class WincacheHandler
23			*
24			* @package O2System\Session\Handlers
25			*/
26			class WincacheHandler extends AbstractHandler
27			{
28			/**
29			* Platform Name
30			*
31			* @access protected
32			* @var string
33			*/
34			protected $platform = 'wincache';
35
36			// ------------------------------------------------------------------------
37
38			/**
39			* WincacheHandler::open
40			*
41			* Initialize session
42			*
43			* @link http://php.net/manual/en/sessionhandlerinterface.open.php
44			*
45			* @param string $save_path The path where to store/retrieve the session.
46			* @param string $name The session name.
47			*
48			* @return bool <p>
49			* The return value (usually TRUE on success, FALSE on failure).
50			* Note this value is returned internally to PHP for processing.
51			* </p>
52			* @since 5.4.0
53			*/
54			public function open($save_path, $name)
55			{
56			if ($this->isSupported() === false) {
57			if ($this->logger instanceof LoggerInterface) {
			0 ignored issues – show introduced 2019-04-29 15:05 UTC by Report Bug Copy Issue Report `$this->logger` is always a sub-type of `Psr\Log\LoggerInterface`. Loading history...
58			$this->logger->error('SESSION_E_PLATFORM_UNSUPPORTED', [$this->platform]);
59			}
60
61			return false;
62			}
63
64			return true;
65			}
66
67			// ------------------------------------------------------------------------
68
69			/**
70			* WincacheHandler::isSupported
71			*
72			* Checks if this platform is supported on this system.
73			*
74			* @return bool Returns FALSE if unsupported.
75			*/
76			public function isSupported()
77			{
78			return (bool)(extension_loaded('wincache') && ini_get('wincache.ucenabled'));
79			}
80
81			// ------------------------------------------------------------------------
82
83			/**
84			* WincacheHandler::close
85			*
86			* Close the session
87			*
88			* @link http://php.net/manual/en/sessionhandlerinterface.close.php
89			* @return bool <p>
90			* The return value (usually TRUE on success, FALSE on failure).
91			* Note this value is returned internally to PHP for processing.
92			* </p>
93			* @since 5.4.0
94			*/
95			public function close()
96			{
97			if (isset($this->lockKey)) {
98			return wincache_ucache_delete($this->lockKey);
99			}
100
101			return false;
102			}
103
104			// ------------------------------------------------------------------------
105
106			/**
107			* WincacheHandler::destroy
108			*
109			* Destroy a session
110			*
111			* @link http://php.net/manual/en/sessionhandlerinterface.destroy.php
112			*
113			* @param string $session_id The session ID being destroyed.
114			*
115			* @return bool <p>
116			* The return value (usually TRUE on success, FALSE on failure).
117			* Note this value is returned internally to PHP for processing.
118			* </p>
119			* @since 5.4.0
120			*/
121			public function destroy($session_id)
122			{
123			if (isset($this->lockKey)) {
124			wincache_ucache_delete($this->prefixKey . $session_id);
125
126			return $this->destroyCookie();
127			}
128
129			return false;
130			}
131
132			// ------------------------------------------------------------------------
133
134			/**
135			* WincacheHandler::gc
136			*
137			* Cleanup old sessions
138			*
139			* @link http://php.net/manual/en/sessionhandlerinterface.gc.php
140			*
141			* @param int $maxlifetime <p>
142			* Sessions that have not updated for
143			* the last maxlifetime seconds will be removed.
144			* </p>
145			*
146			* @return bool <p>
147			* The return value (usually TRUE on success, FALSE on failure).
148			* Note this value is returned internally to PHP for processing.
149			* </p>
150			* @since 5.4.0
151			*/
152			public function gc($maxlifetime)
153			{
154			// Not necessary, Wincache takes care of that.
155			return true;
156			}
157
158			// ------------------------------------------------------------------------
159
160			/**
161			* WincacheHandler::read
162			*
163			* Read session data
164			*
165			* @link http://php.net/manual/en/sessionhandlerinterface.read.php
166			*
167			* @param string $session_id The session id to read data for.
168			*
169			* @return string <p>
170			* Returns an encoded string of the read data.
171			* If nothing was read, it must return an empty string.
172			* Note this value is returned internally to PHP for processing.
173			* </p>
174			* @since 5.4.0
175			*/
176			public function read($session_id)
177			{
178			if ($this->lockSession($session_id)) {
179			// Needed by write() to detect session_regenerate_id() calls
180			$this->sessionId = $session_id;
181
182			$success = false;
183			$sessionData = wincache_ucache_get($this->prefixKey . $session_id, $success);
184
185			if ($success) {
186			$this->fingerprint = md5($sessionData);
			0 ignored issues – show Documentation Bug introduced 2019-01-16 11:54 UTC by Report Bug Copy Issue Report The property `$fingerprint` was declared of type `boolean`, but `md5($sessionData)` is of type `string`. Maybe add a type cast? This check looks for assignments to scalar types that may be of the wrong type. To ensure the code behaves as expected, it may be a good idea to add an explicit type cast. $answer = 42; $correct = false; $correct = (bool) $answer; Loading history...
187
188			return $sessionData;
189			}
190			}
191
192			return '';
193			}
194
195			// ------------------------------------------------------------------------
196
197			/**
198			* WincacheHandler::_lockSession
199			*
200			* Acquires an (emulated) lock.
201			*
202			* @param string $session_id Session ID
203			*
204			* @return bool
205			*/
206			protected function lockSession($session_id)
207			{
208			if (isset($this->lockKey)) {
209			return wincache_ucache_set($this->lockKey, time(), 300);
210			}
211
212			// 30 attempts to obtain a lock, in case another request already has it
213			$lockKey = $this->prefixKey . $session_id . ':lock';
214			$attempt = 0;
215
216			do {
217			if (wincache_ucache_exists($lockKey)) {
218			sleep(1);
219			continue;
220			}
221
222			if ( ! wincache_ucache_set($lockKey, time(), 300)) {
223			if ($this->logger instanceof LoggerInterface) {
224			$this->logger->error('SESSION_E_OBTAIN_LOCK', [$this->prefixKey . $session_id]);
225			}
226
227			return false;
228			}
229
230			$this->lockKey = $lockKey;
231			break;
232			} while (++$attempt < 30);
233
234			if ($attempt === 30) {
235			if ($this->logger instanceof LoggerInterface) {
			0 ignored issues – show introduced 2019-04-29 15:05 UTC by Report Bug Copy Issue Report `$this->logger` is always a sub-type of `Psr\Log\LoggerInterface`. Loading history...
236			$this->logger->error('SESSION_E_OBTAIN_LOCK_30', [$this->prefixKey . $session_id]);
237			}
238
239			return false;
240			}
241
242			$this->isLocked = true;
243
244			return true;
245			}
246
247			//--------------------------------------------------------------------
248
249			/**
250			* WincacheHandler::write
251			*
252			* Write session data
253			*
254			* @link http://php.net/manual/en/sessionhandlerinterface.write.php
255			*
256			* @param string $session_id The session id.
257			* @param string $session_data <p>
258			* The encoded session data. This data is the
259			* result of the PHP internally encoding
260			* the $_SESSION superglobal to a serialized
261			* string and passing it as this parameter.
262			* Please note sessions use an alternative serialization method.
263			* </p>
264			*
265			* @return bool <p>
266			* The return value (usually TRUE on success, FALSE on failure).
267			* Note this value is returned internally to PHP for processing.
268			* </p>
269			* @since 5.4.0
270			*/
271			public function write($session_id, $session_data)
272			{
273			if ($session_id !== $this->sessionId) {
274			if ( ! $this->lockRelease() OR ! $this->lockSession($session_id)) {
275			return false;
276			}
277
278			$this->fingerprint = md5('');
			0 ignored issues – show Documentation Bug introduced 2019-01-16 11:54 UTC by Report Bug Copy Issue Report The property `$fingerprint` was declared of type `boolean`, but `md5('')` is of type `string`. Maybe add a type cast? This check looks for assignments to scalar types that may be of the wrong type. To ensure the code behaves as expected, it may be a good idea to add an explicit type cast. $answer = 42; $correct = false; $correct = (bool) $answer; Loading history...
279			$this->sessionId = $session_id;
280			}
281
282			if (isset($this->lockKey)) {
283			wincache_ucache_set($this->lockKey, time(), 300);
284
285			if ($this->fingerprint !== ($fingerprint = md5($session_data))) {
286			if (wincache_ucache_set(
287			$this->prefixKey . $session_id,
288			$session_data,
289			$this->config[ 'lifetime' ]
290			)) {
291			$this->fingerprint = $fingerprint;
292
293			return true;
294			}
295
296			return false;
297			}
298
299			return wincache_ucache_set($this->prefixKey . $session_id, $session_data, $this->config[ 'lifetime' ]);
300			}
301
302			return false;
303			}
304
305			//--------------------------------------------------------------------
306
307			/**
308			* WincacheHandler::_lockRelease
309			*
310			* Releases a previously acquired lock
311			*
312			* @return bool
313			*/
314			protected function lockRelease()
315			{
316			if (isset($this->lockKey) AND $this->isLocked) {
317			if ( ! wincache_ucache_delete($this->lockKey)) {
318			if ($this->logger instanceof LoggerInterface) {
			0 ignored issues – show introduced 2019-04-29 15:05 UTC by Report Bug Copy Issue Report `$this->logger` is always a sub-type of `Psr\Log\LoggerInterface`. Loading history...
319			$this->logger->error('SESSION_E_FREE_LOCK', [$this->lockKey]);
320			}
321
322			return false;
323			}
324
325			$this->lockKey = null;
326			$this->isLocked = false;
327			}
328
329			return true;
330			}
331			}

o2system / session

GitHub Access Token became invalid

WincacheHandler::open() A last analyzed 2019-09-25 13:12 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

WincacheHandler::open() A
last analyzed 2019-09-25 13:12 UTC