* @copyright 2007-2014 PrestaShop SA
* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
* International Registered Trademark & Property of PrestaShop SA
*/
class CookieCore
{
/** @var array Contain cookie content in a key => value format */
protected $_content;
/** @var array Crypted cookie name for setcookie() */
protected $_name;
/** @var array expiration date for setcookie() */
protected $_expire;
/** @var array Website domain for setcookie() */
protected $_domain;
/** @var array Path for setcookie() */
protected $_path;
/** @var array cipher tool instance */
protected $_cipherTool;
protected $_modified = false;
protected $_allow_writing;
protected $_salt;
protected $_standalone;
/**
* Get data if the cookie exists and else initialize an new one
*
* @param $name string Cookie name before encrypting
* @param $path string
*/
public function __construct($name, $path = '', $expire = null, $shared_urls = null, $standalone = false)
{
$this->_content = array();
$this->_standalone = $standalone;
$this->_expire = is_null($expire) ? time() + 1728000 : (int)$expire;
$this->_name = 'PrestaShop-'.md5(($this->_standalone ? '' : _PS_VERSION_).$name);
$this->_path = trim(($this->_standalone ? '' : Context::getContext()->shop->physical_uri).$path, '/\\').'/';
if ($this->_path{0} != '/') $this->_path = '/'.$this->_path;
$this->_path = rawurlencode($this->_path);
$this->_path = str_replace('%2F', '/', $this->_path);
$this->_path = str_replace('%7E', '~', $this->_path);
$this->_domain = $this->getDomain($shared_urls);
$this->_allow_writing = true;
$this->_salt = $this->_standalone ? str_pad('', 8, md5('ps'.__FILE__)) : _COOKIE_IV_;
if ($this->_standalone)
$this->_cipherTool = new Blowfish(str_pad('', 56, md5('ps'.__FILE__)), str_pad('', 56, md5('iv'.__FILE__)));
elseif (!Configuration::get('PS_CIPHER_ALGORITHM'))
$this->_cipherTool = new Blowfish(_COOKIE_KEY_, _COOKIE_IV_);
else
$this->_cipherTool = new Rijndael(_RIJNDAEL_KEY_, _RIJNDAEL_IV_);
$this->update();
}
public function disallowWriting()
{
$this->_allow_writing = false;
}
protected function getDomain($shared_urls = null)
{
$r = '!(?:(\w+)://)?(?:(\w+)\:(\w+)@)?([^/:]+)?(?:\:(\d*))?([^#?]+)?(?:\?([^#]+))?(?:#(.+$))?!i';
if (!preg_match ($r, Tools::getHttpHost(false, false), $out) || !isset($out[4]))
return false;
if (preg_match('/^(((25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]{1}[0-9]|[1-9]).)'.
'{1}((25[0-5]|2[0-4][0-9]|[1]{1}[0-9]{2}|[1-9]{1}[0-9]|[0-9]).)'.
'{2}((25[0-5]|2[0-4][0-9]|[1]{1}[0-9]{2}|[1-9]{1}[0-9]|[0-9]){1}))$/', $out[4]))
return false;
if (!strstr(Tools::getHttpHost(false, false), '.'))
return false;
$domain = false;
if ($shared_urls !== null)
{
foreach ($shared_urls as $shared_url)
{
if ($shared_url != $out[4])
continue;
if (preg_match('/^(?:.*\.)?([^.]*(?:.{2,4})?\..{2,3})$/Ui', $shared_url, $res))
{
$domain = '.'.$res[1];
break;
}
}
}
if (!$domain)
$domain = $out[4];
return $domain;
}
/**
* Set expiration date
*
* @param integer $expire Expiration time from now
*/
public function setExpire($expire)
{
$this->_expire = (int)($expire);
}
/**
* Magic method wich return cookie data from _content array
*
* @param string $key key wanted
* @return string value corresponding to the key
*/
public function __get($key)
{
return isset($this->_content[$key]) ? $this->_content[$key] : false;
}
/**
* Magic method which check if key exists in the cookie
*
* @param string $key key wanted
* @return boolean key existence
*/
public function __isset($key)
{
return isset($this->_content[$key]);
}
/**
* Magic method wich add data into _content array
*
* @param string $key key desired
* @param $value value corresponding to the key
*/
public function __set($key, $value)
{
if (is_array($value))
die(Tools::displayError());
if (preg_match('/¤|\|/', $key.$value))
throw new Exception('Forbidden chars in cookie');
if (!$this->_modified && (!isset($this->_content[$key]) || (isset($this->_content[$key]) && $this->_content[$key] != $value)))
$this->_modified = true;
$this->_content[$key] = $value;
}
/**
* Magic method wich delete data into _content array
*
* @param string $key key wanted
*/
public function __unset($key)
{
if (isset($this->_content[$key]))
$this->_modified = true;
unset($this->_content[$key]);
}
/**
* Check customer informations saved into cookie and return customer validity
*
* @deprecated as of version 1.5 use Customer::isLogged() instead
* @return boolean customer validity
*/
public function isLogged($withGuest = false)
{
Tools::displayAsDeprecated();
if (!$withGuest && $this->is_guest == 1)
return false;
/* Customer is valid only if it can be load and if cookie password is the same as database one */
if ($this->logged == 1 && $this->id_customer && Validate::isUnsignedId($this->id_customer) && Customer::checkPassword((int)($this->id_customer), $this->passwd))
return true;
return false;
}
/**
* Check employee informations saved into cookie and return employee validity
*
* @deprecated as of version 1.5 use Employee::isLoggedBack() instead
* @return boolean employee validity
*/
public function isLoggedBack()
{
Tools::displayAsDeprecated();
/* Employee is valid only if it can be load and if cookie password is the same as database one */
return ($this->id_employee
&& Validate::isUnsignedId($this->id_employee)
&& Employee::checkPassword((int)$this->id_employee, $this->passwd)
&& (!isset($this->_content['remote_addr']) || $this->_content['remote_addr'] == ip2long(Tools::getRemoteAddr()) || !Configuration::get('PS_COOKIE_CHECKIP'))
);
}
/**
* Delete cookie
* As of version 1.5 don't call this function, use Customer::logout() or Employee::logout() instead;
*/
public function logout()
{
$this->_content = array();
$this->_setcookie();
unset($_COOKIE[$this->_name]);
$this->_modified = true;
}
/**
* Soft logout, delete everything links to the customer
* but leave there affiliate's informations.
* As of version 1.5 don't call this function, use Customer::mylogout() instead;
*/
public function mylogout()
{
unset($this->_content['id_compare']);
unset($this->_content['id_customer']);
unset($this->_content['id_guest']);
unset($this->_content['is_guest']);
unset($this->_content['id_connections']);
unset($this->_content['customer_lastname']);
unset($this->_content['customer_firstname']);
unset($this->_content['passwd']);
unset($this->_content['logged']);
unset($this->_content['email']);
unset($this->_content['id_cart']);
unset($this->_content['id_address_invoice']);
unset($this->_content['id_address_delivery']);
$this->_modified = true;
}
public function makeNewLog()
{
unset($this->_content['id_customer']);
unset($this->_content['id_guest']);
Guest::setNewGuest($this);
$this->_modified = true;
}
/**
* Get cookie content
*/
public function update($nullValues = false)
{
if (isset($_COOKIE[$this->_name]))
{
/* Decrypt cookie content */
$content = $this->_cipherTool->decrypt($_COOKIE[$this->_name]);
//printf("\$content = %s
", $content);
/* Get cookie checksum */
$tmpTab = explode('¤', $content);
array_pop($tmpTab);
$content_for_checksum = implode('¤', $tmpTab).'¤';
$checksum = crc32($this->_salt.$content_for_checksum);
//printf("\$checksum = %s
", $checksum);
/* Unserialize cookie content */
$tmpTab = explode('¤', $content);
foreach ($tmpTab as $keyAndValue)
{
$tmpTab2 = explode('|', $keyAndValue);
if (count($tmpTab2) == 2)
$this->_content[$tmpTab2[0]] = $tmpTab2[1];
}
/* Blowfish fix */
if (isset($this->_content['checksum']))
$this->_content['checksum'] = (int)($this->_content['checksum']);
//printf("\$this->_content['checksum'] = %s
", $this->_content['checksum']);
//die();
/* Check if cookie has not been modified */
if (!isset($this->_content['checksum']) || $this->_content['checksum'] != $checksum)
$this->logout();
if (!isset($this->_content['date_add']))
$this->_content['date_add'] = date('Y-m-d H:i:s');
}
else
$this->_content['date_add'] = date('Y-m-d H:i:s');
//checks if the language exists, if not choose the default language
if (!$this->_standalone && !Language::getLanguage((int)$this->id_lang))
{
$this->id_lang = Configuration::get('PS_LANG_DEFAULT');
// set detect_language to force going through Tools::setCookieLanguage to figure out browser lang
$this->detect_language = true;
}
}
/**
* Setcookie according to php version
*/
protected function _setcookie($cookie = null)
{
if ($cookie)
{
$content = $this->_cipherTool->encrypt($cookie);
$time = $this->_expire;
}
else
{
$content = 0;
$time = 1;
}
if (PHP_VERSION_ID <= 50200) /* PHP version > 5.2.0 */
return setcookie($this->_name, $content, $time, $this->_path, $this->_domain, 0);
else
return setcookie($this->_name, $content, $time, $this->_path, $this->_domain, 0, true);
}
public function __destruct()
{
$this->write();
}
/**
* Save cookie with setcookie()
*/
public function write()
{
if (!$this->_modified || headers_sent() || !$this->_allow_writing)
return;
$cookie = '';
/* Serialize cookie content */
if (isset($this->_content['checksum'])) unset($this->_content['checksum']);
foreach ($this->_content as $key => $value)
$cookie .= $key.'|'.$value.'¤';
/* Add checksum to cookie */
$cookie .= 'checksum|'.crc32($this->_salt.$cookie);
$this->_modified = false;
/* Cookies are encrypted for evident security reasons */
return $this->_setcookie($cookie);
}
/**
* Get a family of variables (e.g. "filter_")
*/
public function getFamily($origin)
{
$result = array();
if (count($this->_content) == 0)
return $result;
foreach ($this->_content as $key => $value)
if (strncmp($key, $origin, strlen($origin)) == 0)
$result[$key] = $value;
return $result;
}
/**
*
*/
public function unsetFamily($origin)
{
$family = $this->getFamily($origin);
foreach (array_keys($family) as $member)
unset($this->$member);
}
/**
* @return String name of cookie
*/
public function getName()
{
return $this->_name;
}
/**
* Check if the cookie exists
*
* @since 1.5.0
* @return bool
*/
public function exists()
{
return isset($_COOKIE[$this->_name]);
}
}