Merge pull request #11 from bessl/patch-2
[gitphp.git] / include / router / Router.class.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
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
<?php
/**
 * Request router
 *
 * @author Christopher Han <xiphux@gmail.com>
 * @copyright Copyright (c) 2010 Christopher Han
 * @package GitPHP
 * @subpackage Router
 */
class GitPHP_Router
{
 
        /**
         * Route map
         *
         * @var array
         */
        protected $routes = array();
 
        /**
         * Query parameter map
         *
         * @var array
         */
        protected $queryParameters = array();
 
        /**
         * Clean url flag
         *
         * @var boolean
         */
        protected $cleanurl = false;
 
        /**
         * Abbreviate hashes flag
         *
         * @var boolean
         */
        protected $abbreviate = false;
 
        /**
         * Base url
         *
         * @var string
         */
        protected $baseurl;
 
        /**
         * Full url
         *
         * @var string
         */
        protected $fullurl;
 
        /**
         * Constructor
         *
         * @param boolean $cleanurl true to generate clean urls
         * @param boolean $abbreviate true to abbreviate hashes
         */
        public function __construct($cleanurl = false, $abbreviate = false)
        {
                $this->cleanurl = $cleanurl;
                $this->abbreviate = $abbreviate;
 
                $this->baseurl = GitPHP_Util::BaseUrl();
                if (empty($this->baseurl))
                        $this->baseurl = '/';
                $this->fullurl = GitPHP_Util::BaseUrl(true);
 
                $this->InitializeRoutes();
                $this->InitializeQueryParameters();
        }
 
        /**
         * Get clean url setting
         *
         * @return boolean
         */
        public function GetCleanUrl()
        {
                return $this->cleanurl;
        }
 
        /**
         * Set clean url setting
         *
         * @param boolean $cleanurl true to generate clean urls
         */
        public function SetCleanUrl($cleanurl)
        {
                $this->cleanurl = $cleanurl;
        }
 
        /**
         * Get abbreviate hash setting
         *
         * @return boolean
         */
        public function GetAbbreviate()
        {
                return $this->abbreviate;
        }
 
        /**
         * Set abbreviate hash setting
         *
         * @param boolean $abbreviate abbreviate
         */
        public function SetAbbreviate($abbreviate)
        {
                $this->abbreviate = $abbreviate;
        }
 
        /**
         * Get base url
         *
         * @param boolean $full true to return full base url (include protocol and hostname)
         * @return string base url
         */
        public function GetBaseUrl($full = false)
        {
                if ($full)
                        return $this->fullurl;
 
                return $this->baseurl;
        }
 
        /**
         * Set base url
         *
         * @param string $baseurl base url
         */
        public function SetBaseUrl($baseurl)
        {
                $this->baseurl = $baseurl;
                $this->fullurl = $baseurl;
        }
 
        /**
         * Initialize route map
         */
        private function InitializeRoutes()
        {
                // project view
                $projectroute = new GitPHP_Route('projects/:project', array(
                        'project' => '[^\?]+'
                ));
 
                // project-specific action with hash and output method
                $this->routes[] = new GitPHP_Route(':action/:hash/:output', array(
                        'action' => 'blobs',
                        'hash' => '[0-9A-Fa-f]{4,40}|HEAD',
                        'output' => 'plain'
                ), array(), $projectroute);
 
                // project-specific action with hash
                $this->routes[] = new GitPHP_Route(':action/:hash', array(
                        'action' => 'commits|trees|blobs|search|snapshot|commitdiff|blobdiff|blame',
                        'hash' => '[0-9A-Fa-f]{4,40}|HEAD'
                ), array(), $projectroute);
 
                // project-specific action with hash or ref
                $this->routes[] = new GitPHP_Route(':action/:hash', array(
                        'action' => 'shortlog|log',
                        'hash' => '[^\?]+'
                ), array(), $projectroute);
 
                // map heads to shortlog
                $this->routes[] = new GitPHP_Route(':action/:hash', array(
                        'action' => 'heads',
                        'hash' => '[^\?]+'
                ), array(
                        'action' => 'shortlog'
                ), $projectroute);
 
                // project-specific graphs
                $this->routes[] = new GitPHP_Route(':action/:graphtype', array(
                        'action' => 'graphs',
                        'graphtype' => '[a-z]+'
                ), array(), $projectroute);
 
                // project-specific tag
                $this->routes[] = new GitPHP_Route(':action/:tag', array(
                        'action' => 'tags',
                        'tag' => '[^\?]+'
                ), array(), $projectroute);
 
                $formats = GitPHP_Archive::SupportedFormats();
                if (count($formats) > 0) {
                        $formatconstraint = implode("|", array_keys($formats));
                        // project specific snapshot format with hash
                        $this->routes[] = new GitPHP_Route(':format/:hash', array(
                                'format' => $formatconstraint,
                                'hash' => '[0-9A-Fa-f]{4,40}|HEAD'
                        ), array(
                                'action' => 'snapshot'
                        ), $projectroute);
 
                        // project specific snapshot format
                        $this->routes[] = new GitPHP_Route(':format', array(
                                'format' => $formatconstraint
                        ), array(
                                'action' => 'snapshot'
                        ), $projectroute);
                }
 
                // project-specific action only
                $this->routes[] = new GitPHP_Route(':action', array(
                        'action' => 'tags|heads|shortlog|log|search|atom|rss|snapshot|commits|graphs|trees|blobs|history|commitdiff|blobdiff'
                ), array(), $projectroute);
 
                $this->routes[] = $projectroute;
 
                // non-project action
                $this->routes[] = new GitPHP_Route(':action', array(
                        'action' => 'opml|projectindex|login|logout'
                ));
 
                usort($this->routes, array('GitPHP_Route', 'CompareRoute'));
        }
 
        /**
         * Initialize query parameter map
         */
        private function InitializeQueryParameters()
        {
                $this->queryParameters = array(
                        'project' => 'p',
                        'action' => 'a',
                        'hash' => 'h',
                        'hashbase' => 'hb',
                        'hashparent' => 'hp',
                        'graphtype' => 'g',
                        'output' => 'o',
                        'format' => 'fmt',
                        'tag' => 't',
                        'page' => 'pg',
                        'search' => 's',
                        'searchtype' => 'st',
                        'diffmode' => 'd',
                        'file' => 'f',
                        'mark' => 'm',
                        'prefix' => 'prefix',
                        'sort' => 'sort',
                        'lang' => 'l',
                        'redirect' => 'redirect'
                );
        }
 
        /**
         * Convert a parameter array to a query variable array
         *
         * @param array $params parameter array
         * @return array query variable array
         */
        private function ParameterArrayToQueryVarArray($params)
        {
                $queryvars = array();
 
                if (count($params) < 1)
                        return $queryvars;
 
                foreach ($params as $param => $val) {
 
                        if (empty($val))
                                continue;
 
                        if (empty($this->queryParameters[$param]))
                                continue;
 
                        $queryvar = $this->queryParameters[$param];
 
                        if (!empty($queryvar))
                                $queryvars[$queryvar] = $val;
                }
 
                return $queryvars;
        }
 
        /**
         * Convert a query variable array to a parameter array
         *
         * @param array $queryvars query variable array
         * @return array parameter array
         */
        private function QueryVarArrayToParameterArray($queryvars)
        {
                $params = array();
 
                if (count($queryvars) < 1)
                        return $params;
 
                foreach ($queryvars as $var => $val) {
 
                        if (empty($val))
                                continue;
 
                        $param = array_search($var, $this->queryParameters);
 
                        if (!empty($param))
                                $params[$param] = $val;
                }
 
                return $params;
        }
 
        /**
         * Build route from url parameters
         *
         * @param array $urlparams url parameters
         */
        private function BuildRoute($urlparams)
        {
                foreach ($this->routes as $route) {
 
                        if (!$route->Valid($urlparams))
                                continue;
 
                        $path = $route->Build($urlparams);
                        $usedparams = $route->GetUsedParameters();
 
                        return array($path, $usedparams);
                }
 
                return array(null, array());
        }
 
        /**
         * Find route matching query
         *
         * @param string $query query
         * @return array query parameters
         */
        private function FindRoute($query)
        {
                if (empty($query))
                        return array();
 
                foreach ($this->routes as $route) {
 
                        $params = $route->Match($query);
                        if ($params === false)
                                continue;
 
                        return $params;
                }
 
                return array();
        }
 
        /**
         * Gets a controller for an action
         *
         * @return mixed controller object
         */
        public function GetController()
        {
                $params = $this->QueryVarArrayToParameterArray($_GET);
                if (!empty($_POST)) {
                        $params = array_merge($params, $this->QueryVarArrayToParameterArray($_POST));
                }
 
                if (!empty($_GET['q'])) {
                        $restparams = GitPHP_Router::ReadCleanUrl($_SERVER['REQUEST_URI']);
                        if (count($restparams) > 0)
                                $params = array_merge($params, $restparams);
                }
 
                $controller = null;
 
                $action = null;
                if (!empty($params['action']))
                        $action = $params['action'];
 
                switch ($action) {
 
 
                        case 'search':
                                $controller = new GitPHP_Controller_Search();
                                break;
 
 
                        case 'commitdiff':
                        case 'commitdiff_plain':
                                $controller = new GitPHP_Controller_Commitdiff();
                                if ($action === 'commitdiff_plain')
                                        $controller->SetParam('output', 'plain');
                                break;
 
 
                        case 'blobdiff':
                        case 'blobdiff_plain':
                                $controller = new GitPHP_Controller_Blobdiff();
                                if ($action === 'blobdiff_plain')
                                        $controller->SetParam('output', 'plain');
                                break;
 
 
                        case 'history':
                                $controller = new GitPHP_Controller_History();
                                break;
 
 
                        case 'shortlog':
                        case 'log':
                                $controller = new GitPHP_Controller_Log();
                                if ($action === 'shortlog')
                                        $controller->SetParam('short', true);
                                break;
 
 
                        case 'snapshot':
                                $controller = new GitPHP_Controller_Snapshot();
                                break;
 
 
                        case 'tree':
                        case 'trees':
                                $controller = new GitPHP_Controller_Tree();
                                break;
 
 
                        case 'tags':
                                if (empty($params['tag'])) {
                                        $controller = new GitPHP_Controller_Tags();
                                        break;
                                }
                        case 'tag':
                                $controller = new GitPHP_Controller_Tag();
                                break;
 
 
                        case 'heads':
                                $controller = new GitPHP_Controller_Heads();
                                break;
 
 
                        case 'blame':
                                $controller = new GitPHP_Controller_Blame();
                                break;
 
 
                        case 'blob':
                        case 'blobs':
                        case 'blob_plain':      
                                $controller = new GitPHP_Controller_Blob();
                                if ($action === 'blob_plain')
                                        $controller->SetParam('output', 'plain');
                                break;
 
 
                        case 'atom':
                        case 'rss':
                                $controller = new GitPHP_Controller_Feed();
                                if ($action == 'rss')
                                        $controller->SetParam('format', GitPHP_Controller_Feed::RssFormat);
                                else if ($action == 'atom')
                                        $controller->SetParam('format', GitPHP_Controller_Feed::AtomFormat);
                                break;
 
 
                        case 'commit':
                        case 'commits':
                                $controller = new GitPHP_Controller_Commit();
                                break;
 
 
                        case 'summary':
                                $controller = new GitPHP_Controller_Project();
                                break;
 
 
                        case 'project_index':
                        case 'projectindex':
                                $controller = new GitPHP_Controller_ProjectList();
                                $controller->SetParam('txt', true);
                                break;
 
 
                        case 'opml':
                                $controller = new GitPHP_Controller_ProjectList();
                                $controller->SetParam('opml', true);
                                break;
 
                        
                        case 'login':
                                $controller = new GitPHP_Controller_Login();
                                if (!empty($_POST['username']))
                                        $controller->SetParam('username', $_POST['username']);
                                if (!empty($_POST['password']))
                                        $controller->SetParam('password', $_POST['password']);
                                break;
 
                        case 'logout':
                                $controller = new GitPHP_Controller_Logout();
                                break;
 
 
                        case 'graph':
                        case 'graphs':
                                //$controller = new GitPHP_Controller_Graph();
                                //break;
                        case 'graphdata':
                                //$controller = new GitPHP_Controller_GraphData();
                                //break;
                        default:
                                if (!empty($params['project'])) {
                                        $controller = new GitPHP_Controller_Project();
                                } else {
                                        $controller = new GitPHP_Controller_ProjectList();
                                }
                }
 
                foreach ($params as $paramname => $paramval) {
                        if ($paramname !== 'action')
                                $controller->SetParam($paramname, $paramval);
                }
 
                $controller->SetRouter($this);
 
                return $controller;
        }
 
        /**
         * Get message controller
         *
         * @return GitPHP_ControllerBase
         */
        public function GetMessageController()
        {
                $params = $this->QueryVarArrayToParameterArray($_GET);
 
                if (!empty($_GET['q'])) {
                        $restparams = GitPHP_Router::ReadCleanUrl($_SERVER['REQUEST_URI']);
                        if (count($restparams) > 0)
                                $params = array_merge($params, $restparams);
                }
 
                $controller = new GitPHP_Controller_Message();
 
                foreach ($params as $paramname => $paramval) {
                        if ($paramname !== 'action')
                                $controller->SetParam($paramname, $paramval);
                }
 
                $controller->SetRouter($this);
 
                return $controller;
        }
 
        /**
         * Read a rest-style clean url
         *
         * @param string $url url
         * @return array request parameters from url
         */
        private function ReadCleanUrl($url)
        {
                $querypos = strpos($url, '?');
                if ($querypos !== false)
                        $url = substr($url, 0, $querypos);
 
                $url = rtrim($url, "/");
 
                $baseurl = GitPHP_Util::AddSlash(GitPHP_Util::BaseUrl(), false);
                if (empty($baseurl))
                        $baseurl = '/';
 
                if (strncmp($baseurl, $url, strlen($baseurl)) === 0)
                        $url = substr($url, strlen($baseurl));
 
                return $this->FindRoute($url);
        }
 
        /**
         * Generate a url
         *
         * @param array $params request parameters
         * @param boolean $full true to get full url (include protocol and hostname)
         */
        public function GetUrl($params = array(), $full = false)
        {
                if ($full)
                        $baseurl = $this->fullurl;
                else
                        $baseurl = $this->baseurl;
 
                if ($this->cleanurl) {
                        if (substr_compare($baseurl, 'index.php', -9) === 0) {
                                $baseurl = dirname($baseurl);
                        }
                        $baseurl = GitPHP_Util::AddSlash($baseurl, false);
                } else {
                        if (substr_compare($baseurl, 'index.php', -9) !== 0) {
                                $baseurl = GitPHP_Util::AddSlash($baseurl, false);
                        }
                }
 
                if (count($params) < 1)
                        return $baseurl;
 
                $abbreviate = $this->abbreviate;
                if ($abbreviate && !empty($params['project']) && ($params['project'] instanceof GitPHP_Project)) {
                        if ($params['project']->GetCompat())
                                $abbreviate = false;
                }
 
                foreach ($params as $paramname => $paramval) {
                        switch ($paramname) {
                                case 'hash':
                                case 'hashbase':
                                case 'hashparent':
                                case 'mark':
                                        $params[$paramname] = GitPHP_Router::GetHash($paramval, $abbreviate);
                                        break;
                                case 'tag':
                                        $params[$paramname] = GitPHP_Router::GetTag($paramval);
                                        break;
                                case 'project':
                                        $params[$paramname] = GitPHP_Router::GetProject($paramval);
                                        break;
                        }
                }
 
                if ($this->cleanurl) {
 
                        if (!empty($params['action'])) {
                                switch ($params['action']) {
                                        case 'blob':
                                        case 'commit':
                                        case 'tree':
                                        case 'graph':
                                        case 'tag':
                                                // these actions are plural in clean urls
                                                $params['action'] = $params['action'] . 's';
                                                break;
                                }
                        }
 
                        list($queryurl, $exclude) = $this->BuildRoute($params);
                        $baseurl .= $queryurl;
 
                        foreach ($exclude as $excludeparam) {
                                unset($params[$excludeparam]);
                        }
                }
 
                $querystr = GitPHP_Router::GetQueryString($params);
 
                if (empty($querystr))
                        return $baseurl;
 
                return $baseurl . '?' . $querystr;
        }
 
        /**
         * Gets query parameters for a url
         *
         * @param array $params query parameters
         * @return string query string
         */
        private function GetQueryString($params = array())
        {
                if (count($params) < 1)
                        return null;
 
                $query = $this->ParameterArrayToQueryVarArray($params);
 
                if (count($query) < 1)
                        return null;
 
                $querystr = null;
 
                foreach ($query as $var => $val) {
                        if (empty($val))
                                continue;
                        if (!empty($querystr))
                                $querystr .= '&';
                        $querystr .= $var . '=' . rawurlencode($val);
                }
 
                return $querystr;
        }
 
        /**
         * Gets a hash for a string or hash-identified object
         *
         * @param string|GitPHP_GitObject $value string or hashed object
         * @param boolean $abbreviate true to abbreviate hash
         * @return string hash
         */
        private static function GetHash($value, $abbreviate = false)
        {
                if ($value instanceof GitPHP_GitObject)
                        return $value->GetHash($abbreviate);
                else if (is_string($value))
                        return $value;
 
                return null;
        }
 
        /**
         * Gets an identifier for a tag
         *
         * @param string|GitPHP_Tag $value string or tag
         * @return string hash
         */
        private static function GetTag($value)
        {
                if ($value instanceof GitPHP_Tag)
                        return $value->GetName();
                else if (is_string($value))
                        return $value;
                return null;
        }
 
        /**
         * Gets a project identifier for a project
         *
         * @param string|GitPHP_Project $value string or project
         * @return string identifier
         */
        private static function GetProject($value)
        {
                if ($value instanceof GitPHP_Project) {
                        return $value->GetProject();
                } else if (is_string($project)) {
                        return $value;
                }
        }
 
}
 
comments