mirror of
https://github.com/kamilwylegala/cakephp2-php8.git
synced 2025-03-28 04:32:57 +00:00
63275626ee
Cookie values using the 1.x formatting will be read, and upon next write be converted to json encoded values. Fixes #1593
490 lines
12 KiB
PHP
490 lines
12 KiB
PHP
<?php
|
|
/**
|
|
* Cookie Component
|
|
*
|
|
* PHP 5
|
|
*
|
|
* CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
|
|
* Copyright 2005-2010, Cake Software Foundation, Inc. (http://cakefoundation.org)
|
|
*
|
|
* Licensed under The MIT License
|
|
* Redistributions of files must retain the above copyright notice.
|
|
*
|
|
* @copyright Copyright 2005-2010, Cake Software Foundation, Inc. (http://cakefoundation.org)
|
|
* @link http://cakephp.org CakePHP(tm) Project
|
|
* @package cake.libs.controller.components
|
|
* @since CakePHP(tm) v 1.2.0.4213
|
|
* @license MIT License (http://www.opensource.org/licenses/mit-license.php)
|
|
*/
|
|
|
|
App::uses('Component', 'Controller');
|
|
App::uses('Security', 'Utility');
|
|
|
|
/**
|
|
* Cookie Component.
|
|
*
|
|
* Cookie handling for the controller.
|
|
*
|
|
* @package cake.libs.controller.components
|
|
* @link http://book.cakephp.org/view/1280/Cookies
|
|
*
|
|
*/
|
|
class CookieComponent extends Component {
|
|
|
|
/**
|
|
* The name of the cookie.
|
|
*
|
|
* Overridden with the controller beforeFilter();
|
|
* $this->Cookie->name = 'CookieName';
|
|
*
|
|
* @var string
|
|
* @access public
|
|
*/
|
|
public $name = 'CakeCookie';
|
|
|
|
/**
|
|
* The time a cookie will remain valid.
|
|
*
|
|
* Can be either integer Unix timestamp or a date string.
|
|
*
|
|
* Overridden with the controller beforeFilter();
|
|
* $this->Cookie->time = '5 Days';
|
|
*
|
|
* @var mixed
|
|
* @access public
|
|
*/
|
|
public $time = null;
|
|
|
|
/**
|
|
* Cookie path.
|
|
*
|
|
* Overridden with the controller beforeFilter();
|
|
* $this->Cookie->path = '/';
|
|
*
|
|
* The path on the server in which the cookie will be available on.
|
|
* If public $cookiePath is set to '/foo/', the cookie will only be available
|
|
* within the /foo/ directory and all sub-directories such as /foo/bar/ of domain.
|
|
* The default value is the entire domain.
|
|
*
|
|
* @var string
|
|
* @access public
|
|
*/
|
|
public $path = '/';
|
|
|
|
/**
|
|
* Domain path.
|
|
*
|
|
* The domain that the cookie is available.
|
|
*
|
|
* Overridden with the controller beforeFilter();
|
|
* $this->Cookie->domain = '.example.com';
|
|
*
|
|
* To make the cookie available on all subdomains of example.com.
|
|
* Set $this->Cookie->domain = '.example.com'; in your controller beforeFilter
|
|
*
|
|
* @var string
|
|
* @access public
|
|
*/
|
|
public $domain = '';
|
|
|
|
/**
|
|
* Secure HTTPS only cookie.
|
|
*
|
|
* Overridden with the controller beforeFilter();
|
|
* $this->Cookie->secure = true;
|
|
*
|
|
* Indicates that the cookie should only be transmitted over a secure HTTPS connection.
|
|
* When set to true, the cookie will only be set if a secure connection exists.
|
|
*
|
|
* @var boolean
|
|
* @access public
|
|
*/
|
|
public $secure = false;
|
|
|
|
/**
|
|
* Encryption key.
|
|
*
|
|
* Overridden with the controller beforeFilter();
|
|
* $this->Cookie->key = 'SomeRandomString';
|
|
*
|
|
* @var string
|
|
* @access protected
|
|
*/
|
|
public $key = null;
|
|
|
|
/**
|
|
* HTTP only cookie
|
|
*
|
|
* Set to true to make HTTP only cookies. Cookies that are HTTP only
|
|
* are not accessible in Javascript.
|
|
*
|
|
* @var boolean
|
|
*/
|
|
public $httpOnly = false;
|
|
|
|
/**
|
|
* Values stored in the cookie.
|
|
*
|
|
* Accessed in the controller using $this->Cookie->read('Name.key');
|
|
*
|
|
* @see CookieComponent::read();
|
|
* @var string
|
|
* @access private
|
|
*/
|
|
protected $_values = array();
|
|
|
|
/**
|
|
* Type of encryption to use.
|
|
*
|
|
* Currently only one method is available
|
|
* Defaults to Security::cipher();
|
|
*
|
|
* @var string
|
|
* @access private
|
|
* @todo add additional encryption methods
|
|
*/
|
|
protected $_type = 'cipher';
|
|
|
|
/**
|
|
* Used to reset cookie time if $expire is passed to CookieComponent::write()
|
|
*
|
|
* @var string
|
|
* @access private
|
|
*/
|
|
protected $_reset = null;
|
|
|
|
/**
|
|
* Expire time of the cookie
|
|
*
|
|
* This is controlled by CookieComponent::time;
|
|
*
|
|
* @var string
|
|
* @access private
|
|
*/
|
|
protected $_expires = 0;
|
|
|
|
/**
|
|
* Constructor
|
|
*
|
|
* @param ComponentCollection $collection A ComponentCollection for this component
|
|
* @param array $settings Array of settings.
|
|
*/
|
|
public function __construct(ComponentCollection $collection, $settings = array()) {
|
|
$this->key = Configure::read('Security.salt');
|
|
parent::__construct($collection, $settings);
|
|
if (isset($this->time)) {
|
|
$this->_expire($this->time);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Start CookieComponent for use in the controller
|
|
*
|
|
*/
|
|
public function startup($controller) {
|
|
$this->_expire($this->time);
|
|
|
|
if (isset($_COOKIE[$this->name])) {
|
|
$this->_values = $this->_decrypt($_COOKIE[$this->name]);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Write a value to the $_COOKIE[$key];
|
|
*
|
|
* Optional [Name.], required key, optional $value, optional $encrypt, optional $expires
|
|
* $this->Cookie->write('[Name.]key, $value);
|
|
*
|
|
* By default all values are encrypted.
|
|
* You must pass $encrypt false to store values in clear test
|
|
*
|
|
* You must use this method before any output is sent to the browser.
|
|
* Failure to do so will result in header already sent errors.
|
|
*
|
|
* @param mixed $key Key for the value
|
|
* @param mixed $value Value
|
|
* @param boolean $encrypt Set to true to encrypt value, false otherwise
|
|
* @param string $expires Can be either Unix timestamp, or date string
|
|
*/
|
|
public function write($key, $value = null, $encrypt = true, $expires = null) {
|
|
if (is_null($encrypt)) {
|
|
$encrypt = true;
|
|
}
|
|
$this->_encrypted = $encrypt;
|
|
$this->_expire($expires);
|
|
|
|
if (!is_array($key)) {
|
|
$key = array($key => $value);
|
|
}
|
|
|
|
foreach ($key as $name => $value) {
|
|
if (strpos($name, '.') === false) {
|
|
$this->_values[$name] = $value;
|
|
$this->_write("[$name]", $value);
|
|
} else {
|
|
$names = explode('.', $name, 2);
|
|
if (!isset($this->_values[$names[0]])) {
|
|
$this->_values[$names[0]] = array();
|
|
}
|
|
$this->_values[$names[0]] = Set::insert($this->_values[$names[0]], $names[1], $value);
|
|
$this->_write('[' . implode('][', $names) . ']', $value);
|
|
}
|
|
}
|
|
$this->_encrypted = true;
|
|
}
|
|
|
|
/**
|
|
* Read the value of the $_COOKIE[$key];
|
|
*
|
|
* Optional [Name.], required key
|
|
* $this->Cookie->read(Name.key);
|
|
*
|
|
* @param mixed $key Key of the value to be obtained. If none specified, obtain map key => values
|
|
* @return string or null, value for specified key
|
|
*/
|
|
public function read($key = null) {
|
|
if (empty($this->_values) && isset($_COOKIE[$this->name])) {
|
|
$this->_values = $this->_decrypt($_COOKIE[$this->name]);
|
|
}
|
|
|
|
if (is_null($key)) {
|
|
return $this->_values;
|
|
}
|
|
|
|
if (strpos($key, '.') !== false) {
|
|
$names = explode('.', $key, 2);
|
|
$key = $names[0];
|
|
}
|
|
if (!isset($this->_values[$key])) {
|
|
return null;
|
|
}
|
|
|
|
if (!empty($names[1])) {
|
|
return Set::extract($this->_values[$key], $names[1]);
|
|
}
|
|
return $this->_values[$key];
|
|
}
|
|
|
|
/**
|
|
* Delete a cookie value
|
|
*
|
|
* Optional [Name.], required key
|
|
* $this->Cookie->read('Name.key);
|
|
*
|
|
* You must use this method before any output is sent to the browser.
|
|
* Failure to do so will result in header already sent errors.
|
|
*
|
|
* @param string $key Key of the value to be deleted
|
|
* @return void
|
|
*/
|
|
public function delete($key) {
|
|
if (empty($this->_values)) {
|
|
$this->read();
|
|
}
|
|
if (strpos($key, '.') === false) {
|
|
unset($this->_values[$key]);
|
|
$this->_delete("[$key]");
|
|
return;
|
|
}
|
|
$names = explode('.', $key, 2);
|
|
$this->_values[$names[0]] = Set::remove($this->_values[$names[0]], $names[1]);
|
|
$this->_delete('[' . implode('][', $names) . ']');
|
|
}
|
|
|
|
/**
|
|
* Destroy current cookie
|
|
*
|
|
* You must use this method before any output is sent to the browser.
|
|
* Failure to do so will result in header already sent errors.
|
|
*
|
|
* @return void
|
|
*/
|
|
public function destroy() {
|
|
if (isset($_COOKIE[$this->name])) {
|
|
$this->_values = $this->_decrypt($_COOKIE[$this->name]);
|
|
}
|
|
|
|
foreach ($this->_values as $name => $value) {
|
|
if (is_array($value)) {
|
|
foreach ($value as $key => $val) {
|
|
unset($this->_values[$name][$key]);
|
|
$this->_delete("[$name][$key]");
|
|
}
|
|
}
|
|
unset($this->_values[$name]);
|
|
$this->_delete("[$name]");
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Will allow overriding default encryption method.
|
|
*
|
|
* @param string $type Encryption method
|
|
* @access public
|
|
* @todo NOT IMPLEMENTED
|
|
*/
|
|
public function type($type = 'cipher') {
|
|
$this->_type = 'cipher';
|
|
}
|
|
|
|
/**
|
|
* Set the expire time for a session variable.
|
|
*
|
|
* Creates a new expire time for a session variable.
|
|
* $expire can be either integer Unix timestamp or a date string.
|
|
*
|
|
* Used by write()
|
|
* CookieComponent::write(string, string, boolean, 8400);
|
|
* CookieComponent::write(string, string, boolean, '5 Days');
|
|
*
|
|
* @param mixed $expires Can be either Unix timestamp, or date string
|
|
* @return int Unix timestamp
|
|
*/
|
|
protected function _expire($expires = null) {
|
|
$now = time();
|
|
if (is_null($expires)) {
|
|
return $this->_expires;
|
|
}
|
|
$this->_reset = $this->_expires;
|
|
|
|
if ($expires == 0) {
|
|
return $this->_expires = 0;
|
|
}
|
|
|
|
if (is_integer($expires) || is_numeric($expires)) {
|
|
return $this->_expires = $now + intval($expires);
|
|
}
|
|
return $this->_expires = strtotime($expires, $now);
|
|
}
|
|
|
|
/**
|
|
* Set cookie
|
|
*
|
|
* @param string $name Name for cookie
|
|
* @param string $value Value for cookie
|
|
*/
|
|
protected function _write($name, $value) {
|
|
$this->_setcookie(
|
|
$this->name . $name, $this->_encrypt($value),
|
|
$this->_expires, $this->path, $this->domain, $this->secure, $this->httpOnly
|
|
);
|
|
|
|
if (!is_null($this->_reset)) {
|
|
$this->_expires = $this->_reset;
|
|
$this->_reset = null;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Sets a cookie expire time to remove cookie value
|
|
*
|
|
* @param string $name Name of cookie
|
|
* @return void
|
|
*/
|
|
protected function _delete($name) {
|
|
$this->_setcookie(
|
|
$this->name . $name, '',
|
|
time() - 42000, $this->path, $this->domain, $this->secure, $this->httpOnly
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Object wrapper for setcookie() so it can be mocked in unit tests.
|
|
*
|
|
* @param string $name Name of the cookie
|
|
* @param integer $expire Time the cookie expires in
|
|
* @param string $path Path the cookie applies to
|
|
* @param string $domain Domain the cookie is for.
|
|
* @param boolean $secure Is the cookie https?
|
|
* @param boolean $httpOnly Is the cookie available in the client?
|
|
* @return void
|
|
*/
|
|
protected function _setcookie($name, $value, $expire, $path, $domain, $secure, $httpOnly = false) {
|
|
setcookie($name, $value, $expire, $path, $domain, $secure, $httpOnly);
|
|
}
|
|
/**
|
|
* Encrypts $value using public $type method in Security class
|
|
*
|
|
* @param string $value Value to encrypt
|
|
* @return string encrypted string
|
|
* @return string Encoded values
|
|
*/
|
|
protected function _encrypt($value) {
|
|
if (is_array($value)) {
|
|
$value = $this->_implode($value);
|
|
}
|
|
|
|
if ($this->_encrypted === true) {
|
|
$type = $this->_type;
|
|
$value = "Q2FrZQ==." .base64_encode(Security::$type($value, $this->key));
|
|
}
|
|
return $value;
|
|
}
|
|
|
|
/**
|
|
* Decrypts $value using public $type method in Security class
|
|
*
|
|
* @param array $values Values to decrypt
|
|
* @return string decrypted string
|
|
*/
|
|
protected function _decrypt($values) {
|
|
$decrypted = array();
|
|
$type = $this->_type;
|
|
|
|
foreach ((array)$values as $name => $value) {
|
|
if (is_array($value)) {
|
|
foreach ($value as $key => $val) {
|
|
$pos = strpos($val, 'Q2FrZQ==.');
|
|
$decrypted[$name][$key] = $this->_explode($val);
|
|
|
|
if ($pos !== false) {
|
|
$val = substr($val, 8);
|
|
$decrypted[$name][$key] = $this->_explode(Security::$type(base64_decode($val), $this->key));
|
|
}
|
|
}
|
|
} else {
|
|
$pos = strpos($value, 'Q2FrZQ==.');
|
|
$decrypted[$name] = $this->_explode($value);
|
|
|
|
if ($pos !== false) {
|
|
$value = substr($value, 8);
|
|
$decrypted[$name] = $this->_explode(Security::$type(base64_decode($value), $this->key));
|
|
}
|
|
}
|
|
}
|
|
return $decrypted;
|
|
}
|
|
|
|
/**
|
|
* Implode method to keep keys are multidimensional arrays
|
|
*
|
|
* @param array $array Map of key and values
|
|
* @return string A json encoded string.
|
|
*/
|
|
protected function _implode(array $array) {
|
|
return json_encode($array);
|
|
}
|
|
|
|
/**
|
|
* Explode method to return array from string set in CookieComponent::_implode()
|
|
* Maintains reading backwards compatibility with 1.x CookieComponent::_implode().
|
|
*
|
|
* @param string $string A string containing JSON encoded data, or a bare string.
|
|
* @return array Map of key and values
|
|
*/
|
|
protected function _explode($string) {
|
|
if ($string[0] === '{' || $string[0] === '[') {
|
|
$ret = json_decode($string, true);
|
|
return ($ret != null) ? $ret : $string;
|
|
}
|
|
$array = array();
|
|
foreach (explode(',', $string) as $pair) {
|
|
$key = explode('|', $pair);
|
|
if (!isset($key[1])) {
|
|
return $key[0];
|
|
}
|
|
$array[$key[0]] = $key[1];
|
|
}
|
|
return $array;
|
|
}
|
|
}
|