File code/core/Mage/Adminhtml/Model/Url.php

Packages

currencysymbol
MAbout
Mage
- Admin
- Adminhtml
- AdminNotification
- Api
- Api2
- Authorizenet
- Backup
- Bundle
- Captcha
- Catalog
- CatalogIndex
- CatalogInventory
- CatalogRule
- CatalogSearch
- Centinel
- Checkout
- Cms
- Compiler
- Connect
- Contacts
- Core
- Cron
- CurrencySymbol
- Customer
- Dataflow
- Directory
- DirtectPost
- Downloadable
- Eav
- GiftMessage
- GoogleAnalytics
- GoogleBase
- GoogleCheckout
- ImportExport
- Index
- Install
- Log
- Media
- Newsletter
- Oauth
- Page
- PageCache
- Paygate
- Payment
- Paypal
- PaypalUk
- Persistent
- Poll
- ProductAlert
- Rating
- Reports
- Review
- Rss
- Rule
- Sales
- SalesRule
- Sedfriend
- Sendfriend
- Shipping
- Sitemap
- Tag
- Tax
- Usa
- Weee
- Widget
- Wishlist
- XmlConnect
None
Phoenix
- Moneybookers
PHP
Zend
- Date
- Mime
- XmlRpc

Classes

Interfaces

Exceptions

Mage_Adminhtml_Exception

  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_Adminhtml
 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: class Mage_Adminhtml_Model_Url extends Mage_Core_Model_Url
 27: {
 28:     /**
 29:      * Secret key query param name
 30:      */
 31:     const SECRET_KEY_PARAM_NAME = 'key';
 32: 
 33:     /**
 34:      * Retrieve is secure mode for ULR logic
 35:      *
 36:      * @return bool
 37:      */
 38:     public function getSecure()
 39:     {
 40:         if ($this->hasData('secure_is_forced')) {
 41:             return $this->getData('secure');
 42:         }
 43:         return Mage::getStoreConfigFlag('web/secure/use_in_adminhtml');
 44:     }
 45: 
 46:     /**
 47:      * Force strip secret key param if _nosecret param specified
 48:      *
 49:      * @return Mage_Core_Model_Url
 50:      */
 51:     public function setRouteParams(array $data, $unsetOldParams=true)
 52:     {
 53:         if (isset($data['_nosecret'])) {
 54:             $this->setNoSecret(true);
 55:             unset($data['_nosecret']);
 56:         } else {
 57:             $this->setNoSecret(false);
 58:         }
 59: 
 60:         return parent::setRouteParams($data, $unsetOldParams);
 61:     }
 62: 
 63:     /**
 64:      * Custom logic to retrieve Urls
 65:      *
 66:      * @param string $routePath
 67:      * @param array $routeParams
 68:      * @return string
 69:      */
 70:     public function getUrl($routePath=null, $routeParams=null)
 71:     {
 72:         $cacheSecretKey = false;
 73:         if (is_array($routeParams) && isset($routeParams['_cache_secret_key'])) {
 74:             unset($routeParams['_cache_secret_key']);
 75:             $cacheSecretKey = true;
 76:         }
 77: 
 78:         $result = parent::getUrl($routePath, $routeParams);
 79:         if (!$this->useSecretKey()) {
 80:             return $result;
 81:         }
 82: 
 83:         $_route = $this->getRouteName() ? $this->getRouteName() : '*';
 84:         $_controller = $this->getControllerName() ? $this->getControllerName() : $this->getDefaultControllerName();
 85:         $_action = $this->getActionName() ? $this->getActionName() : $this->getDefaultActionName();
 86: 
 87:         if ($cacheSecretKey) {
 88:             $secret = array(self::SECRET_KEY_PARAM_NAME => "\${$_controller}/{$_action}\$");
 89:         }
 90:         else {
 91:             $secret = array(self::SECRET_KEY_PARAM_NAME => $this->getSecretKey($_controller, $_action));
 92:         }
 93:         if (is_array($routeParams)) {
 94:             $routeParams = array_merge($secret, $routeParams);
 95:         } else {
 96:             $routeParams = $secret;
 97:         }
 98:         if (is_array($this->getRouteParams())) {
 99:             $routeParams = array_merge($this->getRouteParams(), $routeParams);
100:         }
101: 
102:         return parent::getUrl("{$_route}/{$_controller}/{$_action}", $routeParams);
103:     }
104: 
105:     /**
106:      * Generate secret key for controller and action based on form key
107:      *
108:      * @param string $controller Controller name
109:      * @param string $action Action name
110:      * @return string
111:      */
112:     public function getSecretKey($controller = null, $action = null)
113:     {
114:         $salt = Mage::getSingleton('core/session')->getFormKey();
115: 
116:         $p = explode('/', trim($this->getRequest()->getOriginalPathInfo(), '/'));
117:         if (!$controller) {
118:             $controller = !empty($p[1]) ? $p[1] : $this->getRequest()->getControllerName();
119:         }
120:         if (!$action) {
121:             $action = !empty($p[2]) ? $p[2] : $this->getRequest()->getActionName();
122:         }
123: 
124:         $secret = $controller . $action . $salt;
125:         return Mage::helper('core')->getHash($secret);
126:     }
127: 
128:     /**
129:      * Return secret key settings flag
130:      *
131:      * @return boolean
132:      */
133:     public function useSecretKey()
134:     {
135:         return Mage::getStoreConfigFlag('admin/security/use_form_key') && !$this->getNoSecret();
136:     }
137: 
138:     /**
139:      * Enable secret key using
140:      *
141:      * @return Mage_Adminhtml_Model_Url
142:      */
143:     public function turnOnSecretKey()
144:     {
145:         $this->setNoSecret(false);
146:         return $this;
147:     }
148: 
149:     /**
150:      * Disable secret key using
151:      *
152:      * @return Mage_Adminhtml_Model_Url
153:      */
154:     public function turnOffSecretKey()
155:     {
156:         $this->setNoSecret(true);
157:         return $this;
158:     }
159: 
160:     /**
161:      * Refresh admin menu cache etc.
162:      *
163:      * @return Mage_Adminhtml_Model_Url
164:      */
165:     public function renewSecretUrls()
166:     {
167:         Mage::app()->cleanCache(array(Mage_Adminhtml_Block_Page_Menu::CACHE_TAGS));
168:     }
169: }
170: