1: <?php
  2: /**
  3:  * Magento
  4:  *
  5:  * NOTICE OF LICENSE
  6:  *
  7:  * This source file is subject to the Open Software License (OSL 3.0)
  8:  * that is bundled with this package in the file LICENSE.txt.
  9:  * It is also available through the world-wide-web at this URL:
 10:  * http://opensource.org/licenses/osl-3.0.php
 11:  * If you did not receive a copy of the license and are unable to
 12:  * obtain it through the world-wide-web, please send an email
 13:  * to license@magentocommerce.com so we can send you a copy immediately.
 14:  *
 15:  * DISCLAIMER
 16:  *
 17:  * Do not edit or add to this file if you wish to upgrade Magento to newer
 18:  * versions in the future. If you wish to customize Magento for your
 19:  * needs please refer to http://www.magentocommerce.com for more information.
 20:  *
 21:  * @category    Mage
 22:  * @package     Mage_Core
 23:  * @copyright   Copyright (c) 2012 Magento Inc. (http://www.magentocommerce.com)
 24:  * @license     http://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
 25:  */
 26: 
 27: 
 28: /**
 29:  * Core cookie model
 30:  *
 31:  * @category   Mage
 32:  * @package    Mage_Core
 33:  * @author     Magento Core Team <core@magentocommerce.com>
 34:  */
 35: class Mage_Core_Model_Cookie
 36: {
 37:     const XML_PATH_COOKIE_DOMAIN    = 'web/cookie/cookie_domain';
 38:     const XML_PATH_COOKIE_PATH      = 'web/cookie/cookie_path';
 39:     const XML_PATH_COOKIE_LIFETIME  = 'web/cookie/cookie_lifetime';
 40:     const XML_PATH_COOKIE_HTTPONLY  = 'web/cookie/cookie_httponly';
 41: 
 42:     protected $_lifetime;
 43: 
 44:     /**
 45:      * Store object
 46:      *
 47:      * @var Mage_Core_Model_Store
 48:      */
 49:     protected $_store;
 50: 
 51:     /**
 52:      * Set Store object
 53:      *
 54:      * @param mixed $store
 55:      * @return Mage_Core_Model_Cookie
 56:      */
 57:     public function setStore($store)
 58:     {
 59:         $this->_store = Mage::app()->getStore($store);
 60:         return $this;
 61:     }
 62: 
 63:     /**
 64:      * Retrieve Store object
 65:      *
 66:      * @return Mage_Core_Model_Store
 67:      */
 68:     public function getStore()
 69:     {
 70:         if (is_null($this->_store)) {
 71:             $this->_store = Mage::app()->getStore();
 72:         }
 73:         return $this->_store;
 74:     }
 75: 
 76:     /**
 77:      * Retrieve Request object
 78:      *
 79:      * @return Mage_Core_Controller_Request_Http
 80:      */
 81:     protected function _getRequest()
 82:     {
 83:         return Mage::app()->getRequest();
 84:     }
 85: 
 86:     /**
 87:      * Retrieve Response object
 88:      *
 89:      * @return Mage_Core_Controller_Response_Http
 90:      */
 91:     protected function _getResponse()
 92:     {
 93:         return Mage::app()->getResponse();
 94:     }
 95: 
 96:     /**
 97:      * Retrieve Domain for cookie
 98:      *
 99:      * @return string
100:      */
101:     public function getDomain()
102:     {
103:         $domain = $this->getConfigDomain();
104:         if (empty($domain)) {
105:             $domain = $this->_getRequest()->getHttpHost();
106:         }
107:         return $domain;
108:     }
109: 
110:     /**
111:      * Retrieve Config Domain for cookie
112:      *
113:      * @return string
114:      */
115:     public function getConfigDomain()
116:     {
117:         return (string)Mage::getStoreConfig(self::XML_PATH_COOKIE_DOMAIN, $this->getStore());
118:     }
119: 
120:     /**
121:      * Retrieve Path for cookie
122:      *
123:      * @return string
124:      */
125:     public function getPath()
126:     {
127:         $path = Mage::getStoreConfig(self::XML_PATH_COOKIE_PATH, $this->getStore());
128:         if (empty($path)) {
129:             $path = $this->_getRequest()->getBasePath();
130:         }
131:         return $path;
132:     }
133: 
134:     /**
135:      * Retrieve cookie lifetime
136:      *
137:      * @return int
138:      */
139:     public function getLifetime()
140:     {
141:         if (!is_null($this->_lifetime)) {
142:             $lifetime = $this->_lifetime;
143:         } else {
144:             $lifetime = Mage::getStoreConfig(self::XML_PATH_COOKIE_LIFETIME, $this->getStore());
145:         }
146:         if (!is_numeric($lifetime)) {
147:             $lifetime = 3600;
148:         }
149:         return $lifetime;
150:     }
151: 
152:     /**
153:      * Set cookie lifetime
154:      *
155:      * @param int $lifetime
156:      * @return Mage_Core_Model_Cookie
157:      */
158:     public function setLifetime($lifetime)
159:     {
160:         $this->_lifetime = (int)$lifetime;
161:         return $this;
162:     }
163: 
164:     /**
165:      * Retrieve use HTTP only flag
166:      *
167:      * @return bool
168:      */
169:     public function getHttponly()
170:     {
171:         $httponly = Mage::getStoreConfig(self::XML_PATH_COOKIE_HTTPONLY, $this->getStore());
172:         if (is_null($httponly)) {
173:             return null;
174:         }
175:         return (bool)$httponly;
176:     }
177: 
178:     /**
179:      * Is https secure request
180:      * Use secure on adminhtml only
181:      *
182:      * @return bool
183:      */
184:     public function isSecure()
185:     {
186:         if ($this->getStore()->isAdmin()) {
187:             return $this->_getRequest()->isSecure();
188:         }
189:         return false;
190:     }
191: 
192:     /**
193:      * Set cookie
194:      *
195:      * @param string $name The cookie name
196:      * @param string $value The cookie value
197:      * @param int $period Lifetime period
198:      * @param string $path
199:      * @param string $domain
200:      * @param int|bool $secure
201:      * @param bool $httponly
202:      * @return Mage_Core_Model_Cookie
203:      */
204:     public function set($name, $value, $period = null, $path = null, $domain = null, $secure = null, $httponly = null)
205:     {
206:         /**
207:          * Check headers sent
208:          */
209:         if (!$this->_getResponse()->canSendHeaders(false)) {
210:             return $this;
211:         }
212: 
213:         if ($period === true) {
214:             $period = 3600 * 24 * 365;
215:         } elseif (is_null($period)) {
216:             $period = $this->getLifetime();
217:         }
218: 
219:         if ($period == 0) {
220:             $expire = 0;
221:         }
222:         else {
223:             $expire = time() + $period;
224:         }
225:         if (is_null($path)) {
226:             $path = $this->getPath();
227:         }
228:         if (is_null($domain)) {
229:             $domain = $this->getDomain();
230:         }
231:         if (is_null($secure)) {
232:             $secure = $this->isSecure();
233:         }
234:         if (is_null($httponly)) {
235:             $httponly = $this->getHttponly();
236:         }
237: 
238:         setcookie($name, $value, $expire, $path, $domain, $secure, $httponly);
239: 
240:         return $this;
241:     }
242: 
243:     /**
244:      * Postpone cookie expiration time if cookie value defined
245:      *
246:      * @param string $name The cookie name
247:      * @param int $period Lifetime period
248:      * @param string $path
249:      * @param string $domain
250:      * @param int|bool $secure
251:      * @return Mage_Core_Model_Cookie
252:      */
253:     public function renew($name, $period = null, $path = null, $domain = null, $secure = null, $httponly = null)
254:     {
255:         if (($period === null) && !$this->getLifetime()) {
256:             return $this;
257:         }
258:         $value = $this->_getRequest()->getCookie($name, false);
259:         if ($value !== false) {
260:             $this->set($name, $value, $period, $path, $domain, $secure, $httponly);
261:         }
262:         return $this;
263:     }
264: 
265:     /**
266:      * Retrieve cookie or false if not exists
267:      *
268:      * @param string $neme The cookie name
269:      * @return mixed
270:      */
271:     public function get($name = null)
272:     {
273:         return $this->_getRequest()->getCookie($name, false);
274:     }
275: 
276:     /**
277:      * Delete cookie
278:      *
279:      * @param string $name
280:      * @param string $path
281:      * @param string $domain
282:      * @param int|bool $secure
283:      * @param int|bool $httponly
284:      * @return Mage_Core_Model_Cookie
285:      */
286:     public function delete($name, $path = null, $domain = null, $secure = null, $httponly = null)
287:     {
288:         /**
289:          * Check headers sent
290:          */
291:         if (!$this->_getResponse()->canSendHeaders(false)) {
292:             return $this;
293:         }
294: 
295:         if (is_null($path)) {
296:             $path = $this->getPath();
297:         }
298:         if (is_null($domain)) {
299:             $domain = $this->getDomain();
300:         }
301:         if (is_null($secure)) {
302:             $secure = $this->isSecure();
303:         }
304:         if (is_null($httponly)) {
305:             $httponly = $this->getHttponly();
306:         }
307: 
308:         setcookie($name, null, null, $path, $domain, $secure, $httponly);
309:         return $this;
310:     }
311: }
312: