Cookie::hash() - Code Metrics - gjerokrsteski/pimf-framework - Measure and Improve Code Quality continuously with Scrutinizer

Cookie::hash() A
last analyzed 2019-05-14 14:03 UTC

↳ Parent: Cookie

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
nc	1
nop	1
dl	0
loc	4
rs	10
c	0
b	0
f	0

<?php
/**
 * Pimf
 *
 * @copyright Copyright (c)  Gjero Krsteski (http://krsteski.de)
 * @license   http://opensource.org/licenses/MIT MIT
 */

namespace Pimf;

/**
 * Using the cookie
 *
 * <code>
 *    // Get the value of the "favorite" cookie
 *    $favorite = Cookie::get('favorite');
 *
 *    // Get the value of a cookie or return a default value
 *    $favorite = Cookie::get('framework', 'Pimf');
 *
 *    // Set the value of the "favorite" cookie
 *    Cookie::put('favorite', 'Pimf');
 *
 *    // Set the value of the "favorite" cookie for twenty minutes
 *    Cookie::put('favorite', 'Pimf', 20);
 *
 *    // Set a cookie that should last one year
 *    Cookie::forever('favorite', 'Blue');
 *
 * </code>
 *
 * @package Pimf
 * @author  Gjero Krsteski <[email protected]>
 */
class Cookie
{
    /**
     * How long is forever (in minutes)?
     *
     * @var int
     */
    const FOREVER = 2628000;

    /**
     * The cookies that have been set.
     *
     * @var array
     */
    public static $jar = array();

    /**
     * Determine if a cookie exists.
     *
     * @param  string $name
     *
     * @return bool
     */
    public static function has($name)
    {
        return (static::get($name) !== null);
    }

    /**
     * Get the value of a cookie.
     *
     * @param      $name
     * @param null $default
     *
     * @return null|string
     */
    public static function get($name, $default = null)
    {
        if (isset(static::$jar[$name])) {
            return static::parse(static::$jar[$name]['value']);
        }

        $cookie = Request::$cookieData;

        if (!is_null($value = $cookie->get($name))) {
            return static::parse($value);
        }

        return $default;
    }

    /**
     * Set the value of a cookie.
     *
     * @param        $name
     * @param        $value
     * @param int    $expiration
     * @param string $path
     * @param null   $domain
     * @param bool   $secure
     *
     * @return bool
     * @throws \RuntimeException
     */
    public static function put($name, $value, $expiration = 0, $path = '/', $domain = null, $secure = false)
    {
        if ($expiration !== 0) {
            $expiration = time() + ($expiration * 60);
        }

        $value = static::hash($value) . '+' . $value;

        // are we attempting to send a secure cookie over the insecure HTTP.
        if ($secure === true && Config::get('ssl') === false) {
            throw new \RuntimeException("Attempting to set secure cookie over HTTP!");
        }

        static::$jar[$name] = compact('name', 'value', 'expiration', 'path', 'domain', 'secure');

        return true;
    }

    /**
     * Set a "permanent" cookie. The cookie will last for one year.
     *
     * @param        $name
     * @param        $value
     * @param string $path
     * @param null   $domain
     * @param bool   $secure
     *
     * @return bool
     */
    public static function forever($name, $value, $path = '/', $domain = null, $secure = false)
    {
        return static::put($name, $value, static::FOREVER, $path, $domain, $secure);
    }

    /**
     * Delete a cookie.
     *
     * @param        string $name
     * @param string        $path
     * @param null          $domain
     * @param bool          $secure
     *
     * @return bool
     */
    public static function forget($name, $path = '/', $domain = null, $secure = false)
    {
        return static::put($name, null, -2000, $path, $domain, $secure);
    }

    /**
     * Hash the given cookie value.
     *
     * @param string $value
     *
     * @return string
     */
    public static function hash($value)
    {
        return hash_hmac('sha1', $value, Config::get('app.key'));
    }

    /**
     * Parse a hash fingerprinted cookie value.
     *
     * @param string $value
     *
     * @return string
     */
    protected static function parse($value)
    {
        $segments = explode('+', $value);

        // check if the cookie is invalid.
        if (!(count($segments) >= 2)) {
            return null;
        }

        $value = implode('+', array_slice($segments, 1));

        // check the SHA-1 hash from the cookie.
        if ($segments[0] == static::hash($value)) {
            return $value;
        }

        return null;
    }

    /**
     * Send along with the rest of the HTTP headers.
     */
    public static function send()
    {
        foreach (static::$jar as $cookie) {
            setcookie($cookie['name'], $cookie['value'], $cookie['expiration'], $cookie['path'], $cookie['domain'],
                $cookie['secure'], true);
        }
    }
}


1			<?php
2			/**
3			* Pimf
4			*
5			* @copyright Copyright (c) Gjero Krsteski (http://krsteski.de)
6			* @license http://opensource.org/licenses/MIT MIT
7			*/
8
9			namespace Pimf;
10
11			/**
12			* Using the cookie
13			*
14			* <code>
15			* // Get the value of the "favorite" cookie
16			* $favorite = Cookie::get('favorite');
17			*
18			* // Get the value of a cookie or return a default value
19			* $favorite = Cookie::get('framework', 'Pimf');
20			*
21			* // Set the value of the "favorite" cookie
22			* Cookie::put('favorite', 'Pimf');
23			*
24			* // Set the value of the "favorite" cookie for twenty minutes
25			* Cookie::put('favorite', 'Pimf', 20);
26			*
27			* // Set a cookie that should last one year
28			* Cookie::forever('favorite', 'Blue');
29			*
30			* </code>
31			*
32			* @package Pimf
33			* @author Gjero Krsteski <[email protected]>
34			*/
35			class Cookie
36			{
37			/**
38			* How long is forever (in minutes)?
39			*
40			* @var int
41			*/
42			const FOREVER = 2628000;
43
44			/**
45			* The cookies that have been set.
46			*
47			* @var array
48			*/
49			public static $jar = array();
50
51			/**
52			* Determine if a cookie exists.
53			*
54			* @param string $name
55			*
56			* @return bool
57			*/
58			public static function has($name)
59			{
60			return (static::get($name) !== null);
61			}
62
63			/**
64			* Get the value of a cookie.
65			*
66			* @param $name
67			* @param null $default
68			*
69			* @return null\|string
70			*/
71			public static function get($name, $default = null)
72			{
73			if (isset(static::$jar[$name])) {
74			return static::parse(static::$jar[$name]['value']);
75			}
76
77			$cookie = Request::$cookieData;
78
79			if (!is_null($value = $cookie->get($name))) {
80			return static::parse($value);
81			}
82
83			return $default;
84			}
85
86			/**
87			* Set the value of a cookie.
88			*
89			* @param $name
90			* @param $value
91			* @param int $expiration
92			* @param string $path
93			* @param null $domain
94			* @param bool $secure
95			*
96			* @return bool
97			* @throws \RuntimeException
98			*/
99			public static function put($name, $value, $expiration = 0, $path = '/', $domain = null, $secure = false)
100			{
101			if ($expiration !== 0) {
102			$expiration = time() + ($expiration * 60);
103			}
104
105			$value = static::hash($value) . '+' . $value;
106
107			// are we attempting to send a secure cookie over the insecure HTTP.
108			if ($secure === true && Config::get('ssl') === false) {
109			throw new \RuntimeException("Attempting to set secure cookie over HTTP!");
110			}
111
112			static::$jar[$name] = compact('name', 'value', 'expiration', 'path', 'domain', 'secure');
113
114			return true;
115			}
116
117			/**
118			* Set a "permanent" cookie. The cookie will last for one year.
119			*
120			* @param $name
121			* @param $value
122			* @param string $path
123			* @param null $domain
124			* @param bool $secure
125			*
126			* @return bool
127			*/
128			public static function forever($name, $value, $path = '/', $domain = null, $secure = false)
129			{
130			return static::put($name, $value, static::FOREVER, $path, $domain, $secure);
131			}
132
133			/**
134			* Delete a cookie.
135			*
136			* @param string $name
137			* @param string $path
138			* @param null $domain
139			* @param bool $secure
140			*
141			* @return bool
142			*/
143			public static function forget($name, $path = '/', $domain = null, $secure = false)
144			{
145			return static::put($name, null, -2000, $path, $domain, $secure);
146			}
147
148			/**
149			* Hash the given cookie value.
150			*
151			* @param string $value
152			*
153			* @return string
154			*/
155			public static function hash($value)
156			{
157			return hash_hmac('sha1', $value, Config::get('app.key'));
158			}
159
160			/**
161			* Parse a hash fingerprinted cookie value.
162			*
163			* @param string $value
164			*
165			* @return string
166			*/
167			protected static function parse($value)
168			{
169			$segments = explode('+', $value);
170
171			// check if the cookie is invalid.
172			if (!(count($segments) >= 2)) {
173			return null;
174			}
175
176			$value = implode('+', array_slice($segments, 1));
177
178			// check the SHA-1 hash from the cookie.
179			if ($segments[0] == static::hash($value)) {
180			return $value;
181			}
182
183			return null;
184			}
185
186			/**
187			* Send along with the rest of the HTTP headers.
188			*/
189			public static function send()
190			{
191			foreach (static::$jar as $cookie) {
192			setcookie($cookie['name'], $cookie['value'], $cookie['expiration'], $cookie['path'], $cookie['domain'],
193			$cookie['secure'], true);
194			}
195			}
196			}
197

gjerokrsteski / pimf-framework

GitHub Access Token became invalid

Cookie::hash() A last analyzed 2019-05-14 14:03 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Cookie::hash() A
last analyzed 2019-05-14 14:03 UTC