summaryrefslogtreecommitdiffstats
path: root/src/Router/Runner/Controller.php
blob: eb26ecdab24862a924f51c88a00f793b21fba58d (plain)
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
<?php

namespace Jasny\Router\Runner;

use Jasny\Router\Runner;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Message\ResponseInterface;

/**
 * Run a route using a controller
 */
class Controller extends Runner
{
    /**
     * Return with a 404 not found response
     * 
     * @param ServerRequestInterface $request
     * @param ResponseInterface $response
     * @return ResponseInterface
     */
    protected function notFound(ServerRequestInterface $request, ResponseInterface $response)
    {
        $finalResponse = $response
            ->withProtocolVersion($request->getProtocolVersion())
            ->withStatus(404)
            ->withHeader('Content-Type', 'text/plain');
        
        $finalResponse->getBody()->write("Not found");
        
        return $finalResponse;
    }

    /**
     * Assert that a class exists and will provide a callable object
     * 
     * @return type
     */
    protected function validateClass($class)
    {
        if (!preg_match('/^([a-zA-Z_]\w*\\\\)*[a-zA-Z_]\w*$/', $class)) {
            trigger_error("Can't route to controller '$class': invalid classname", E_USER_NOTICE);
            return false;
        }
        
        if (!class_exists($class)) {
            trigger_error("Can't route to controller '$class': class not exists", E_USER_NOTICE);
            return false;
        }

        $refl = new \ReflectionClass($class);
        $realClass = $refl->getName();
        
        if ($realClass !== $class) {
            trigger_error("Can't route to controller '$class': case mismatch with '$realClass'", E_USER_NOTICE);
            return false;
        }
        
        if (!$refl->hasMethod('__invoke')) {
            trigger_error("Can't route to controller '$class': class does not have '__invoke' method", E_USER_NOTICE);   
            return false;
        }
        
        return true;
    }

    /**
     * Turn kabab-case into StudlyCase.
     * 
     * @internal Jasny\studlycase isn't used because it's to tolerent, which might lead to security issues.
     * 
     * @param string $string
     * @return string
     */
    protected function studlyCase($string)
    {
        return preg_replace_callback('/(?:^|(\w)-)(\w)/', function($match) {
            return $match[1] . strtoupper($match[2]);
        }, strtolower(addcslashes($string, '\\')));
    }
    
    /**
     * Get class name from controller name
     * 
     * @param string|array $name
     * @return string
     */
    protected function getClass($name)
    {
        return join('\\', array_map([$this, 'studlyCase'], (array)$name)) . 'Controller';
    }
    
    /**
     * Instantiate a controller object
     * @codeCoverageIgnore
     * 
     * @param string $class
     * @return callable|object
     */
    protected function instantiate($class)
    {
        return new $class();
    }
    
    /**
     * Route to a controller
     * 
     * @param ServerRequestInterface  $request
     * @param ResponseInterface $response
     * @return ResponseInterface|mixed
     */
    public function run(ServerRequestInterface $request, ResponseInterface $response)
    {
        $route = $request->getAttribute('route');        
        $name = !empty($route->controller) ? $route->controller : null;
        
        $class = $this->getClass($name);

        if (!$this->validateClass($class)) {
            return $this->notFound($request, $response);
        }
        
        $controller = $this->instantiate($class);
        
        return $controller($request, $response);
    }
}