forked from OpenMage/magento-mirror
/
Front.php
268 lines (237 loc) · 8.17 KB
/
Front.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
<?php
/**
* Magento
*
* NOTICE OF LICENSE
*
* This source file is subject to the Open Software License (OSL 3.0)
* that is bundled with this package in the file LICENSE.txt.
* It is also available through the world-wide-web at this URL:
* http://opensource.org/licenses/osl-3.0.php
* If you did not receive a copy of the license and are unable to
* obtain it through the world-wide-web, please send an email
* to license@magentocommerce.com so we can send you a copy immediately.
*
* DISCLAIMER
*
* Do not edit or add to this file if you wish to upgrade Magento to newer
* versions in the future. If you wish to customize Magento for your
* needs please refer to http://www.magentocommerce.com for more information.
*
* @category Mage
* @package Mage_Core
* @copyright Copyright (c) 2008 Irubin Consulting Inc. DBA Varien (http://www.varien.com)
* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
*/
class Mage_Core_Controller_Varien_Front extends Varien_Object
{
protected $_defaults = array();
/**
* Available routers array
*
* @var array
*/
protected $_routers = array();
protected $_urlCache = array();
const XML_STORE_ROUTERS_PATH = 'web/routers';
public function setDefault($key, $value=null)
{
if (is_array($key)) {
$this->_defaults = $key;
} else {
$this->_defaults[$key] = $value;
}
return $this;
}
public function getDefault($key=null)
{
if (is_null($key)) {
return $this->_defaults;
} elseif (isset($this->_defaults[$key])) {
return $this->_defaults[$key];
}
return false;
}
/**
* Retrieve request object
*
* @return Mage_Core_Controller_Request_Http
*/
public function getRequest()
{
return Mage::app()->getRequest();
}
/**
* Retrieve response object
*
* @return Zend_Controller_Response_Http
*/
public function getResponse()
{
return Mage::app()->getResponse();
}
/**
* Adding new router
*
* @param string $name
* @param Mage_Core_Controller_Varien_Router_Abstract $router
* @return Mage_Core_Controller_Varien_Front
*/
public function addRouter($name, Mage_Core_Controller_Varien_Router_Abstract $router)
{
$router->setFront($this);
$this->_routers[$name] = $router;
return $this;
}
/**
* Retrieve router by name
*
* @param string $name
* @return Mage_Core_Controller_Varien_Router_Abstract
*/
public function getRouter($name)
{
if (isset($this->_routers[$name])) {
return $this->_routers[$name];
}
return false;
}
public function init()
{
Mage::dispatchEvent('controller_front_init_before', array('front'=>$this));
$routersInfo = Mage::app()->getStore()->getConfig(self::XML_STORE_ROUTERS_PATH);
Varien_Profiler::start('mage::app::init_front_controller::collect_routers');
foreach ($routersInfo as $routerCode => $routerInfo) {
if (isset($routerInfo['disabled']) && $routerInfo['disabled']) {
continue;
}
if (isset($routerInfo['class'])) {
$router = new $routerInfo['class'];
if (isset($routerInfo['area'])) {
$router->collectRoutes($routerInfo['area'], $routerCode);
}
$this->addRouter($routerCode, $router);
}
}
Varien_Profiler::stop('mage::app::init_front_controller::collect_routers');
Mage::dispatchEvent('controller_front_init_routers', array('front'=>$this));
// Add default router at the last
$default = new Mage_Core_Controller_Varien_Router_Default();
$this->addRouter('default', $default);
return $this;
}
public function dispatch()
{
$request = $this->getRequest();
$request->setPathInfo()->setDispatched(false);
Varien_Profiler::start('mage::dispatch::db_url_rewrite');
Mage::getModel('core/url_rewrite')->rewrite();
Varien_Profiler::stop('mage::dispatch::db_url_rewrite');
Varien_Profiler::start('mage::dispatch::config_url_rewrite');
$this->rewrite();
Varien_Profiler::stop('mage::dispatch::config_url_rewrite');
Varien_Profiler::start('mage::dispatch::routers_match');
$i = 0;
while (!$request->isDispatched() && $i++<100) {
foreach ($this->_routers as $router) {
if ($router->match($this->getRequest())) {
break;
}
}
}
Varien_Profiler::stop('mage::dispatch::routers_match');
if ($i>100) {
Mage::throwException('Front controller reached 100 router match iterations');
}
Varien_Profiler::start('mage::app::dispatch::send_response');
$this->getResponse()->sendResponse();
Varien_Profiler::stop('mage::app::dispatch::send_response');
return $this;
}
public function getRouterByRoute($routeName)
{
// empty route supplied - return base url
if (empty($routeName)) {
$router = $this->getRouter('standard');
} elseif ($this->getRouter('admin')->getFrontNameByRoute($routeName)) {
// try standard router url assembly
$router = $this->getRouter('admin');
} elseif ($this->getRouter('standard')->getFrontNameByRoute($routeName)) {
// try standard router url assembly
$router = $this->getRouter('standard');
} elseif ($router = $this->getRouter($routeName)) {
// try custom router url assembly
} else {
// get default router url
$router = $this->getRouter('default');
}
return $router;
}
public function getRouterByFrontName($frontName)
{
// empty route supplied - return base url
if (empty($frontName)) {
$router = $this->getRouter('standard');
} elseif ($this->getRouter('admin')->getRouteByFrontName($frontName)) {
// try standard router url assembly
$router = $this->getRouter('admin');
} elseif ($this->getRouter('standard')->getRouteByFrontName($frontName)) {
// try standard router url assembly
$router = $this->getRouter('standard');
} elseif ($router = $this->getRouter($frontName)) {
// try custom router url assembly
} else {
// get default router url
$router = $this->getRouter('default');
}
return $router;
}
/**
* Apply configuration rewrites to current url
*
* @return Mage_Core_Controller_Varien_Front
*/
public function rewrite()
{
$request = $this->getRequest();
$config = Mage::getConfig()->getNode('global/rewrite');
if (!$config) {
return;
}
foreach ($config->children() as $rewrite) {
$from = (string)$rewrite->from;
$to = (string)$rewrite->to;
if (empty($from) || empty($to)) {
continue;
}
$from = $this->_processRewriteUrl($from);
$to = $this->_processRewriteUrl($to);
$pathInfo = preg_replace($from, $to, $request->getPathInfo());
if (isset($rewrite->complete)) {
$request->setPathInfo($pathInfo);
} else {
$request->rewritePathInfo($pathInfo);
}
}
}
/**
* Replace route name placeholders in url to front name
*
* @param string $url
* @return string
*/
protected function _processRewriteUrl($url)
{
$startPos = strpos($url, '{');
if ($startPos!==false) {
$endPos = strpos($url, '}');
$routeName = substr($url, $startPos+1, $endPos-$startPos-1);
$router = $this->getRouterByRoute($routeName);
if ($router) {
$fronName = $router->getFrontNameByRoute($routeName);
$url = str_replace('{'.$routeName.'}', $fronName, $url);
}
}
return $url;
}
}