SiteRouter.php
18.3 KB
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
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
<?php
/**
* Joomla! Content Management System
*
* @copyright Copyright (C) 2005 - 2019 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/
namespace Joomla\CMS\Router;
defined('JPATH_PLATFORM') or die;
use Joomla\CMS\Application\CMSApplication;
use Joomla\CMS\Component\ComponentHelper;
use Joomla\CMS\Component\Router\RouterInterface;
use Joomla\CMS\Component\Router\RouterLegacy;
use Joomla\String\StringHelper;
/**
* Class to create and parse routes for the site application
*
* @since 1.5
*/
class SiteRouter extends Router
{
/**
* Component-router objects
*
* @var array
* @since 3.3
*/
protected $componentRouters = array();
/**
* Current Application-Object
*
* @var CMSApplication
* @since 3.4
*/
protected $app;
/**
* Current \JMenu-Object
*
* @var \JMenu
* @since 3.4
*/
protected $menu;
/**
* Class constructor
*
* @param array $options Array of options
* @param CMSApplication $app CMSApplication Object
* @param \JMenu $menu \JMenu object
*
* @since 3.4
*/
public function __construct($options = array(), CMSApplication $app = null, \JMenu $menu = null)
{
parent::__construct($options);
$this->app = $app ?: CMSApplication::getInstance('site');
$this->menu = $menu ?: $this->app->getMenu();
}
/**
* Function to convert a route to an internal URI
*
* @param \JUri &$uri The uri.
*
* @return array
*
* @since 1.5
*/
public function parse(&$uri)
{
$vars = array();
if ($this->app->get('force_ssl') == 2 && strtolower($uri->getScheme()) !== 'https')
{
// Forward to https
$uri->setScheme('https');
$this->app->redirect((string) $uri, 301);
}
// Get the path
// Decode URL to convert percent-encoding to unicode so that strings match when routing.
$path = urldecode($uri->getPath());
// Remove the base URI path.
$path = substr_replace($path, '', 0, strlen(\JUri::base(true)));
// Check to see if a request to a specific entry point has been made.
if (preg_match("#.*?\.php#u", $path, $matches))
{
// Get the current entry point path relative to the site path.
$scriptPath = realpath($_SERVER['SCRIPT_FILENAME'] ?: str_replace('\\\\', '\\', $_SERVER['PATH_TRANSLATED']));
$relativeScriptPath = str_replace('\\', '/', str_replace(JPATH_SITE, '', $scriptPath));
// If a php file has been found in the request path, check to see if it is a valid file.
// Also verify that it represents the same file from the server variable for entry script.
if (file_exists(JPATH_SITE . $matches[0]) && ($matches[0] === $relativeScriptPath))
{
// Remove the entry point segments from the request path for proper routing.
$path = str_replace($matches[0], '', $path);
}
}
// Identify format
if ($this->_mode == JROUTER_MODE_SEF)
{
if ($this->app->get('sef_suffix') && !(substr($path, -9) === 'index.php' || substr($path, -1) === '/'))
{
if ($suffix = pathinfo($path, PATHINFO_EXTENSION))
{
$vars['format'] = $suffix;
}
}
}
// Set the route
$uri->setPath(trim($path, '/'));
// Set the parsepreprocess components methods
$components = ComponentHelper::getComponents();
foreach ($components as $component)
{
$componentRouter = $this->getComponentRouter($component->option);
if (method_exists($componentRouter, 'parsepreprocess'))
{
$this->attachParseRule(array($componentRouter, 'parsepreprocess'), static::PROCESS_BEFORE);
}
}
$vars += parent::parse($uri);
return $vars;
}
/**
* Function to convert an internal URI to a route
*
* @param string $url The internal URL
*
* @return string The absolute search engine friendly URL
*
* @since 1.5
*/
public function build($url)
{
$uri = parent::build($url);
// Get the path data
$route = $uri->getPath();
// Add the suffix to the uri
if ($this->_mode == JROUTER_MODE_SEF && $route)
{
if ($this->app->get('sef_suffix') && !(substr($route, -9) === 'index.php' || substr($route, -1) === '/'))
{
if ($format = $uri->getVar('format', 'html'))
{
$route .= '.' . $format;
$uri->delVar('format');
}
}
if ($this->app->get('sef_rewrite'))
{
// Transform the route
if ($route === 'index.php')
{
$route = '';
}
else
{
$route = str_replace('index.php/', '', $route);
}
}
}
// Add frontend basepath to the uri
$uri->setPath(\JUri::root(true) . '/' . $route);
return $uri;
}
/**
* Function to convert a raw route to an internal URI
*
* @param \JUri &$uri The raw route
*
* @return array
*
* @since 3.2
* @deprecated 4.0 Attach your logic as rule to the main parse stage
*/
protected function parseRawRoute(&$uri)
{
$vars = array();
// Handle an empty URL (special case)
if (!$uri->getVar('Itemid') && !$uri->getVar('option'))
{
$item = $this->menu->getDefault($this->app->getLanguage()->getTag());
if (!is_object($item))
{
// No default item set
return $vars;
}
// Set the information in the request
$vars = $item->query;
// Get the itemid
$vars['Itemid'] = $item->id;
// Set the active menu item
$this->menu->setActive($vars['Itemid']);
return $vars;
}
// Get the variables from the uri
$this->setVars($uri->getQuery(true));
// Get the itemid, if it hasn't been set force it to null
$this->setVar('Itemid', $this->app->input->getInt('Itemid', null));
// Only an Itemid OR if filter language plugin set? Get the full information from the itemid
if (count($this->getVars()) === 1 || ($this->app->getLanguageFilter() && count($this->getVars()) === 2))
{
$item = $this->menu->getItem($this->getVar('Itemid'));
if ($item && $item->type == 'alias')
{
$newItem = $this->menu->getItem($item->params->get('aliasoptions'));
if ($newItem)
{
$item->query = array_merge($item->query, $newItem->query);
$item->component = $newItem->component;
}
}
if ($item !== null && is_array($item->query))
{
$vars += $item->query;
}
}
// Set the active menu item
$this->menu->setActive($this->getVar('Itemid'));
return $vars;
}
/**
* Function to convert a sef route to an internal URI
*
* @param \JUri &$uri The sef URI
*
* @return string Internal URI
*
* @since 3.2
* @deprecated 4.0 Attach your logic as rule to the main parse stage
*/
protected function parseSefRoute(&$uri)
{
$route = $uri->getPath();
// Remove the suffix
if ($this->app->get('sef_suffix'))
{
if ($suffix = pathinfo($route, PATHINFO_EXTENSION))
{
$route = str_replace('.' . $suffix, '', $route);
}
}
// Get the variables from the uri
$vars = $uri->getQuery(true);
// Handle an empty URL (special case)
if (empty($route))
{
// If route is empty AND option is set in the query, assume it's non-sef url, and parse apropriately
if (isset($vars['option']) || isset($vars['Itemid']))
{
return $this->parseRawRoute($uri);
}
$item = $this->menu->getDefault($this->app->getLanguage()->getTag());
// If user not allowed to see default menu item then avoid notices
if (is_object($item))
{
// Set query variables of default menu item into the request, but keep existing request variables
$vars = array_merge($vars, $item->query);
// Get the itemid
$vars['Itemid'] = $item->id;
// Set the active menu item
$this->menu->setActive($vars['Itemid']);
$this->setVars($vars);
}
return $vars;
}
// Parse the application route
$segments = explode('/', $route);
if (count($segments) > 1 && $segments[0] === 'component')
{
$vars['option'] = 'com_' . $segments[1];
$vars['Itemid'] = null;
$route = implode('/', array_slice($segments, 2));
}
else
{
// Get menu items.
$items = $this->menu->getMenu();
$found = false;
$route_lowercase = StringHelper::strtolower($route);
$lang_tag = $this->app->getLanguage()->getTag();
// Iterate through all items and check route matches.
foreach ($items as $item)
{
if ($item->route && StringHelper::strpos($route_lowercase . '/', $item->route . '/') === 0 && $item->type !== 'menulink')
{
// Usual method for non-multilingual site.
if (!$this->app->getLanguageFilter())
{
// Exact route match. We can break iteration because exact item was found.
if ($item->route === $route_lowercase)
{
$found = $item;
break;
}
// Partial route match. Item with highest level takes priority.
if (!$found || $found->level < $item->level)
{
$found = $item;
}
}
// Multilingual site.
elseif ($item->language === '*' || $item->language === $lang_tag)
{
// Exact route match.
if ($item->route === $route_lowercase)
{
$found = $item;
// Break iteration only if language is matched.
if ($item->language === $lang_tag)
{
break;
}
}
// Partial route match. Item with highest level or same language takes priority.
if (!$found || $found->level < $item->level || $item->language === $lang_tag)
{
$found = $item;
}
}
}
}
if (!$found)
{
$found = $this->menu->getDefault($lang_tag);
}
else
{
$route = substr($route, strlen($found->route));
if ($route)
{
$route = substr($route, 1);
}
}
if ($found)
{
if ($found->type == 'alias')
{
$newItem = $this->menu->getItem($found->params->get('aliasoptions'));
if ($newItem)
{
$found->query = array_merge($found->query, $newItem->query);
$found->component = $newItem->component;
}
}
$vars['Itemid'] = $found->id;
$vars['option'] = $found->component;
}
}
// Set the active menu item
if (isset($vars['Itemid']))
{
$this->menu->setActive($vars['Itemid']);
}
// Set the variables
$this->setVars($vars);
// Parse the component route
if (!empty($route) && isset($this->_vars['option']))
{
$segments = explode('/', $route);
if (empty($segments[0]))
{
array_shift($segments);
}
// Handle component route
$component = preg_replace('/[^A-Z0-9_\.-]/i', '', $this->_vars['option']);
if (count($segments))
{
$crouter = $this->getComponentRouter($component);
$vars = $crouter->parse($segments);
$this->setVars($vars);
}
$route = implode('/', $segments);
}
else
{
// Set active menu item
if ($item = $this->menu->getActive())
{
$vars = $item->query;
}
}
$uri->setPath($route);
return $vars;
}
/**
* Function to build a raw route
*
* @param \JUri &$uri The internal URL
*
* @return string Raw Route
*
* @since 3.2
* @deprecated 4.0 Attach your logic as rule to the main build stage
*/
protected function buildRawRoute(&$uri)
{
// Get the query data
$query = $uri->getQuery(true);
if (!isset($query['option']))
{
return;
}
$component = preg_replace('/[^A-Z0-9_\.-]/i', '', $query['option']);
$crouter = $this->getComponentRouter($component);
$query = $crouter->preprocess($query);
$uri->setQuery($query);
}
/**
* Function to build a sef route
*
* @param \JUri &$uri The internal URL
*
* @return void
*
* @since 1.5
* @deprecated 4.0 Attach your logic as rule to the main build stage
* @codeCoverageIgnore
*/
protected function _buildSefRoute(&$uri)
{
$this->buildSefRoute($uri);
}
/**
* Function to build a sef route
*
* @param \JUri &$uri The uri
*
* @return void
*
* @since 3.2
* @deprecated 4.0 Attach your logic as rule to the main build stage
*/
protected function buildSefRoute(&$uri)
{
// Get the route
$route = $uri->getPath();
// Get the query data
$query = $uri->getQuery(true);
if (!isset($query['option']))
{
return;
}
// Build the component route
$component = preg_replace('/[^A-Z0-9_\.-]/i', '', $query['option']);
$itemID = !empty($query['Itemid']) ? $query['Itemid'] : null;
$crouter = $this->getComponentRouter($component);
$parts = $crouter->build($query);
$result = implode('/', $parts);
$tmp = ($result !== '') ? $result : '';
// Build the application route
$built = false;
if (!empty($query['Itemid']))
{
$item = $this->menu->getItem($query['Itemid']);
if (is_object($item) && $query['option'] === $item->component)
{
if (!$item->home)
{
$tmp = !empty($tmp) ? $item->route . '/' . $tmp : $item->route;
}
$built = true;
}
}
if (empty($query['Itemid']) && !empty($itemID))
{
$query['Itemid'] = $itemID;
}
if (!$built)
{
$tmp = 'component/' . substr($query['option'], 4) . '/' . $tmp;
}
if ($tmp)
{
$route .= '/' . $tmp;
}
// Unset unneeded query information
if (isset($item) && $query['option'] === $item->component)
{
unset($query['Itemid']);
}
unset($query['option']);
// Set query again in the URI
$uri->setQuery($query);
$uri->setPath($route);
}
/**
* Process the parsed router variables based on custom defined rules
*
* @param \JUri &$uri The URI to parse
* @param string $stage The stage that should be processed.
* Possible values: 'preprocess', 'postprocess'
* and '' for the main parse stage
*
* @return array The array of processed URI variables
*
* @since 3.2
*/
protected function processParseRules(&$uri, $stage = self::PROCESS_DURING)
{
// Process the attached parse rules
$vars = parent::processParseRules($uri, $stage);
if ($stage === self::PROCESS_DURING)
{
// Process the pagination support
if ($this->_mode == JROUTER_MODE_SEF)
{
$start = $uri->getVar('start');
if ($start !== null)
{
$uri->delVar('start');
$vars['limitstart'] = $start;
}
}
}
return $vars;
}
/**
* Process the build uri query data based on custom defined rules
*
* @param \JUri &$uri The URI
* @param string $stage The stage that should be processed.
* Possible values: 'preprocess', 'postprocess'
* and '' for the main build stage
*
* @return void
*
* @since 3.2
* @deprecated 4.0 The special logic should be implemented as rule
*/
protected function processBuildRules(&$uri, $stage = self::PROCESS_DURING)
{
if ($stage === self::PROCESS_DURING)
{
// Make sure any menu vars are used if no others are specified
$query = $uri->getQuery(true);
if ($this->_mode != 1
&& isset($query['Itemid'])
&& (count($query) === 2 || (count($query) === 3 && isset($query['lang']))))
{
// Get the active menu item
$itemid = $uri->getVar('Itemid');
$lang = $uri->getVar('lang');
$item = $this->menu->getItem($itemid);
if ($item)
{
$uri->setQuery($item->query);
}
$uri->setVar('Itemid', $itemid);
if ($lang)
{
$uri->setVar('lang', $lang);
}
}
}
// Process the attached build rules
parent::processBuildRules($uri, $stage);
if ($stage === self::PROCESS_BEFORE)
{
// Get the query data
$query = $uri->getQuery(true);
if (!isset($query['option']))
{
return;
}
// Build the component route
$component = preg_replace('/[^A-Z0-9_\.-]/i', '', $query['option']);
$router = $this->getComponentRouter($component);
$query = $router->preprocess($query);
$uri->setQuery($query);
}
if ($stage === self::PROCESS_DURING)
{
// Get the path data
$route = $uri->getPath();
if ($this->_mode == JROUTER_MODE_SEF && $route)
{
$limitstart = $uri->getVar('limitstart');
if ($limitstart !== null)
{
$uri->setVar('start', (int) $limitstart);
$uri->delVar('limitstart');
}
}
$uri->setPath($route);
}
}
/**
* Create a uri based on a full or partial URL string
*
* @param string $url The URI
*
* @return \JUri
*
* @since 3.2
*/
protected function createUri($url)
{
// Create the URI
$uri = parent::createUri($url);
// Get the itemid form the URI
$itemid = $uri->getVar('Itemid');
if ($itemid === null)
{
if ($option = $uri->getVar('option'))
{
$item = $this->menu->getItem($this->getVar('Itemid'));
if ($item !== null && $item->component === $option)
{
$uri->setVar('Itemid', $item->id);
}
}
else
{
if ($option = $this->getVar('option'))
{
$uri->setVar('option', $option);
}
if ($itemid = $this->getVar('Itemid'))
{
$uri->setVar('Itemid', $itemid);
}
}
}
else
{
if (!$uri->getVar('option'))
{
if ($item = $this->menu->getItem($itemid))
{
$uri->setVar('option', $item->component);
}
}
}
return $uri;
}
/**
* Get component router
*
* @param string $component Name of the component including com_ prefix
*
* @return RouterInterface Component router
*
* @since 3.3
*/
public function getComponentRouter($component)
{
if (!isset($this->componentRouters[$component]))
{
$compname = ucfirst(substr($component, 4));
$class = $compname . 'Router';
if (!class_exists($class))
{
// Use the component routing handler if it exists
$path = JPATH_SITE . '/components/' . $component . '/router.php';
// Use the custom routing handler if it exists
if (file_exists($path))
{
require_once $path;
}
}
if (class_exists($class))
{
$reflection = new \ReflectionClass($class);
if (in_array('Joomla\\CMS\\Component\\Router\\RouterInterface', $reflection->getInterfaceNames()))
{
$this->componentRouters[$component] = new $class($this->app, $this->menu);
}
}
if (!isset($this->componentRouters[$component]))
{
$this->componentRouters[$component] = new RouterLegacy($compname);
}
}
return $this->componentRouters[$component];
}
/**
* Set a router for a component
*
* @param string $component Component name with com_ prefix
* @param object $router Component router
*
* @return boolean True if the router was accepted, false if not
*
* @since 3.3
*/
public function setComponentRouter($component, $router)
{
$reflection = new \ReflectionClass($router);
if (in_array('Joomla\\CMS\\Component\\Router\\RouterInterface', $reflection->getInterfaceNames()))
{
$this->componentRouters[$component] = $router;
return true;
}
else
{
return false;
}
}
}