Logo Search packages:      
Sourcecode: cakephp1.2 version File versions  Download package

cookie.php

<?php
/* SVN FILE: $Id: cookie.php 5875 2007-10-23 00:25:51Z phpnut $ */
/**
 * Short description for file.
 *
 * Long description for file
 *
 * PHP versions 4 and 5
 *
 * CakePHP(tm) :  Rapid Development Framework <http://www.cakephp.org/>
 * Copyright 2005-2007, Cake Software Foundation, Inc.
 *                                              1785 E. Sahara Avenue, Suite 490-204
 *                                              Las Vegas, Nevada 89104
 *
 * Licensed under The MIT License
 * Redistributions of files must retain the above copyright notice.
 *
 * @filesource
 * @copyright           Copyright 2005-2007, Cake Software Foundation, Inc.
 * @link                      http://www.cakefoundation.org/projects/info/cakephp CakePHP(tm) Project
 * @package             cake
 * @subpackage          cake.cake.libs.controller.components
 * @since               CakePHP(tm) v 1.2.0.4213
 * @version             $Revision: 5875 $
 * @modifiedby          $LastChangedBy: phpnut $
 * @lastmodified  $Date: 2007-10-22 19:25:51 -0500 (Mon, 22 Oct 2007) $
 * @license             http://www.opensource.org/licenses/mit-license.php The MIT License
 */
/**
 * Load Security class
 */
if (!class_exists('Security')) {
      uses('Security');
}
/**
 * Cookie Component.
 *
 * Cookie handling for the controller.
 *
 * @package       cake
 * @subpackage    cake.cake.libs.controller.components
 *
 */
00044 class CookieComponent extends Object {
/**
 * The name of the cookie.
 *
 * Overridden with the controller beforeFilter();
 * $this->Cookie->name = 'CookieName';
 *
 * @var string
 * @access public
 */
      var $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
 */
      var $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  var $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
 */
      var $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
 */
      var $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
 */
      var $secure = false;
/**
 * Encryption key.
 *
 * Overridden with the controller beforeFilter();
 * $this->Cookie->key = 'SomeRandomString';
 *
 * @var string
 * @access protected
 */
      var $key = null;
/**
 * Values stored in the cookie.
 *
 * Accessed in the controller using $this->Cookie->read('Name.key');
 *
 * @see CookieComponent::read();
 * @var string
 * @access private
 */
      var $__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
 */
      var $__type = 'cipher';
/**
 * Used to reset cookie time if $expire is passed to CookieComponent::write()
 *
 * @var string
 * @access private
 */
      var $__reset = null;
/**
 * Expire time of the cookie
 *
 * This is controlled by CookieComponent::time;
 *
 * @var string
 * @access private
 */
      var $__expires = 0;
/**
 * Main execution method.
 *
 * @param object $controller A reference to the instantiating controller object
 * @access public
 * @deprecated use Controller::beforeFilter() to set the properties of the CookieComponent
 */
00164       function initialize(&$controller) {
            $this->key = Configure::read('Security.salt');
            if (is_object($controller)) {
                  if (isset($controller->cookieName)) {
                        $this->name = $controller->cookieName;
                  }
                  if (isset($controller->cookieTime)) {
                        $this->time = $controller->cookieTime;
                  }
                  if (isset($controller->cookieKey)) {
                        $this->key = $controller->cookieKey;
                  }
                  if (isset($controller->cookiePath)) {
                        $this->path = $controller->cookiePath;
                  }
                  if (isset($controller->cookieDomain)) {
                        $this->domain = $controller->cookieDomain;
                  }
                  if (isset($controller->cookieSecure)) {
                        $this->secure = $controller->cookieSecure;
                  }
            }
      }
/**
 * Start CookieComponent for use in the controller
 *
 * @access public
 */
00192       function startup() {
            $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.], reguired 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
 * @access public
 */
00217       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) && $value !== null) {
                  $name = $this->__cookieVarNames($key);

                  if (count($name) > 1) {
                        $this->__values[$name[0]][$name[1]] = $value;
                        $this->__write("[".$name[0]."][".$name[1]."]", $value);
                  } else {
                        $this->__values[$name[0]] = $value;
                        $this->__write("[".$name[0]."]", $value);
                  }
            } else {
                  foreach ($key as $names => $value) {
                        $name = $this->__cookieVarNames($names);

                        if (count($name) > 1) {
                              $this->__values[$name[0]][$name[1]] = $value;
                              $this->__write("[".$name[0]."][".$name[1]."]", $value);
                        } else {
                              $this->__values[$name[0]] = $value;
                              $this->__write("[".$name[0]."]", $value);
                        }
                  }
            }
      }
/**
 * Read the value of the $_COOKIE[$key];
 *
 * Optional [Name.], reguired 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
 * @access public
 */
00259       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;
            }
            $name = $this->__cookieVarNames($key);

            if (count($name) > 1) {
                  if (isset($this->__values[$name[0]])) {
                        if(isset($this->__values[$name[0]][$name[1]])) {
                              return $this->__values[$name[0]][$name[1]];
                        }
                  }
                  return null;
            } else {
                  if (isset($this->__values[$name[0]])) {
                        $value = $this->__values[$name[0]];
                        return $value;
                  }
                  return null;
            }
      }
/**
 * Delete a cookie value
 *
 * Optional [Name.], reguired 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
 * @access public
 */
00296       function del($key) {
            $name = $this->__cookieVarNames($key);

            if (count($name) > 1) {
                  if (isset($this->__values[$name[0]])) {
                        unset($this->__values[$name[0]][$name[1]]);
                        $this->__delete("[".$name[0]."][".$name[1]."]");
                  }
            } else {
                  if (isset($this->__values[$name[0]])) {
                        if (is_array($this->__values[$name[0]])) {
                              foreach ($this->__values[$name[0]] as $key => $value) {
                                    $this->__delete("[".$name[0]."][".$key."]");
                              }
                        }
                        $this->__delete("[".$name[0]."]");
                        unset($this->__values[$name[0]]);
                  }
            }
      }
/**
 * 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.
 *
 * @access public
 */
00324       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
 */
00347       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
 * @access private
 */
00364       function __expire($expires = null) {
            $now = time();
            if (is_null($expires)) {
                  return $this->__expires;
            }
            $this->__reset = $this->__expires;
            if (is_integer($expires) || is_numeric($expires)) {
                  return $this->__expires = $now + intval($expires);
            } else {
                  return $this->__expires = strtotime($expires, $now);
            }
      }
/**
 * Set cookie
 *
 * @param string $name Name for cookie
 * @param string $value Value for cookie
 * @access private
 */
00383       function __write($name, $value) {
            setcookie($this->name . "$name", $this->__encrypt($value), $this->__expires, $this->path, $this->domain, $this->secure);

            if (!is_null($this->__reset)) {
                  $this->__expires = $this->__reset;
                  $this->__reset = null;
            }
            $this->__encrypted = true;
      }
/**
 * Sets a cookie expire time to remove cookie value
 *
 * @param string $name Name of cookie
 * @access private
 */
00398       function __delete($name) {
            setcookie($this->name . $name, '', time() - 42000, $this->path, $this->domain, $this->secure);
      }
/**
  * Encrypts $value using var $type method in Security class
  *
  * @param string $value Value to encrypt
  * @return string encrypted string
  * @access private
  */
00408        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 var $type method in Security class
 *
 * @param array $values Values to decrypt
 * @return string decrypted string
 * @access private
 */
00426       function __decrypt($values) {
            $decrypted = array();
            $type = $this->__type;

            foreach ($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);
      }

/**
 * Creates an array from the $name parameter which allows the dot notation
 * similar to one used by Session and Configure classes
 *
 * @param string $name Name with or without dot notation
 * @return array Extracted names
 * @access private
 */
00463       function __cookieVarNames($name) {
            if (is_string($name)) {
                  if (strpos($name, ".")) {
                        $name = explode(".", $name);
                  } else {
                        $name = array($name);
                  }
            }
            return $name;
      }
/**
 * Implode method to keep keys are multidimensional arrays
 *
 * @param array $array Map of key and values
 * @return string String in the form key1|value1,key2|value2
 * @access private
 */
00480       function __implode($array) {
            $string = '';
            foreach ($array as $key => $value) {
                  $string .= ',' . $key . '|' . $value;
            }
            return substr($string, 1);
      }
/**
 * Explode method to return array from string set in CookieComponent::__implode()
 *
 * @param string $string String in the form key1|value1,key2|value2
 * @return array Map of key and values
 * @access private
 */
00494       function __explode($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;
      }
}
?>

Generated by  Doxygen 1.6.0   Back to index