Skip to content

Commit 53888e4

Browse files
meet-alekseymeet-aleksey
committed
Ignore routes.
Improved HttpContextBase, HttpRequestBase and HttpResponseBase. Added definition of the content type of files.
1 parent a4c7aec commit 53888e4

18 files changed

+367
-108
lines changed

‎src/Controller.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ protected function json($data, $options = 0, $depth = 512) {
127127
*
128128
* @return FileResult
129129
*/
130-
protected function file($path, $contentType = 'application/octet-stream', $downloadName = null) {
130+
protected function file($path, $contentType = null, $downloadName = null) {
131131
return new FileResult($path, $contentType, $downloadName);
132132
}
133133

‎src/FileResult.php‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ class FileResult implements ActionResult {
3434
* @param string $contentType The content type.
3535
* @param string|bool $downloadName the content-disposition header so that a file-download dialog box is displayed in the browser with the specified file name.
3636
*/
37-
public function __construct($path, $contentType = 'application/octet-stream', $downloadName = null) {
37+
public function __construct($path, $contentType = null, $downloadName = null) {
3838
$this->path = $path;
3939
$this->contentType = $contentType;
4040
$this->downloadName = $downloadName;
@@ -57,6 +57,10 @@ public function execute($actionContext) {
5757
throw new \Exception('File "' . $this->path . '" not found.');
5858
}
5959

60+
if (empty($this->contentType) && function_exists('finfo_open') && ($fi = finfo_file(finfo_open(\FILEINFO_MIME_TYPE), $path) !== false)) {
61+
$this->contentType = $fi;
62+
}
63+
6064
$response = $actionContext->getHttpContext()->getResponse();
6165
$response->addHeader('Content-Type', (!empty($this->contentType) ? $this->contentType : 'application/octet-stream'));
6266
$response->addHeader('Content-Length', filesize($path));

‎src/HttpContext.php‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,9 @@ final class HttpContext extends HttpContextBase {
1111
*/
1212
public function __construct() {
1313
$routes = InternalHelper::getStaticPropertyValue('\PhpMvc\RouteTable', 'routes');
14-
parent::__construct($routes, new HttpRequest(), new HttpResponse());
14+
$ignored = InternalHelper::getStaticPropertyValue('\PhpMvc\RouteTable', 'ignored');
15+
16+
parent::__construct($routes, $ignored, new HttpRequest(), new HttpResponse());
1517
}
1618

1719
}

‎src/HttpContextBase.php‎

Lines changed: 42 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,27 @@ abstract class HttpContextBase {
3434
*/
3535
protected $route;
3636

37+
/**
38+
* Indicates that the request should be ignored.
39+
*/
40+
protected $ignore;
41+
42+
/**
43+
* The initial timestamp of the current HTTP request.
44+
*
45+
* @var int
46+
*/
47+
protected $timestamp;
48+
3749
/**
3850
* Initializes a new instance of the HttpContextBase.
51+
*
52+
* @param RouteCollection $routes The routes list.
53+
* @param RouteCollection $ignoreRoutes List of routes to ignore.
54+
* @param HttpRequestBase $request The reqiest.
55+
* @param HttpResponseBase $response The response.
3956
*/
40-
public function __construct($routes, $request, $response) {
57+
public function __construct($routes, $ignoreRoutes, $request, $response) {
4158
if (!isset($routes) || !$routes instanceof RouteCollection) {
4259
throw new \Exception('The $routes is requred and type must be derived from "\PhpMvc\RouteCollection".');
4360
}
@@ -50,11 +67,16 @@ public function __construct($routes, $request, $response) {
5067
throw new \Exception('The $response is requred and type must be derived from "\PhpMvc\HttpResponseBase".');
5168
}
5269

70+
$date = new \DateTime();
71+
$this->timestamp = $date->getTimestamp();
72+
5373
$this->routes = $routes;
5474
$this->request = $request;
5575
$this->response = $response;
5676

57-
$this->route = $routes->getRoute($this);
77+
if (!($this->ignore = (isset($ignoreRoutes) && $ignoreRoutes instanceof RouteCollection && ($this->route = $ignoreRoutes->getRoute($this)) !== null))) {
78+
$this->route = $routes->getRoute($this);
79+
}
5880
}
5981

6082
/**
@@ -102,4 +124,22 @@ public function getRoute() {
102124
return $this->route;
103125
}
104126

127+
/**
128+
* Returns TRUE if the current route is to be ignored.
129+
*
130+
* @return bool
131+
*/
132+
public function isIgnoredRoute() {
133+
return $this->ignore;
134+
}
135+
136+
/**
137+
* Gets the initial timestamp of the current HTTP request.
138+
*
139+
* @return int
140+
*/
141+
public function getTimestamp() {
142+
return $this->timestamp;
143+
}
144+
105145
}

‎src/HttpRequestBase.php‎

Lines changed: 110 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,26 @@
66
*/
77
abstract class HttpRequestBase {
88

9+
/**
10+
* Gets or sets information about the URL of the current request.
11+
*
12+
* @var array
13+
*/
14+
protected $url = null;
15+
916
/**
1017
* URI of the current request.
1118
*
1219
* @var string
1320
*/
14-
protected $requestUri;
21+
protected $rawUrl = null;
1522

1623
/**
1724
* Query string of the current request.
1825
*
1926
* @var QueryString
2027
*/
21-
protected $queryString;
28+
protected $queryString = null;
2229

2330
/**
2431
* Server variables.
@@ -88,34 +95,56 @@ protected function __construct(
8895
$this->post = $post;
8996
$this->files = $files;
9097

91-
$this->requestUri = $serverVariables['REQUEST_URI'];
92-
93-
$this->queryString = new QueryString();
94-
$queryString = array();
98+
$this->rawUrl = $this->serverVariables['REQUEST_URI'];
99+
}
95100

96-
if (($qsIndex = strpos($this->requestUri, '?')) !== false) {
97-
parse_str(substr($this->requestUri, $qsIndex + 1), $queryString);
98-
}
99-
else {
100-
if (!empty($serverVariables['QUERY_STRING'])) {
101-
parse_str($serverVariables['QUERY_STRING'], $queryString);
102-
}
101+
/**
102+
* Returns URL components.
103+
*
104+
* Potential keys within this array are:
105+
* - scheme - e.g. http
106+
* - host
107+
* - port
108+
* - user
109+
* - pass
110+
* - path
111+
* - query - after the question mark ?
112+
* - fragment - after the hashmark #
113+
*
114+
* @return array
115+
*/
116+
public function url() {
117+
// TODO: class for url
118+
if ($this->url === null) {
119+
$this->url = parse_url(
120+
'http' .
121+
(isset($serverVariables['HTTPS']) ? 's' : '') .
122+
'://' .
123+
$serverVariables['HTTP_HOST'] .
124+
$serverVariables['REQUEST_URI']
125+
);
103126
}
104127

105-
if (!empty($queryString)) {
106-
foreach ($queryString as $key => $value) {
107-
$this->queryString[$key] = $value;
108-
}
109-
}
128+
return $this->url;
129+
}
130+
131+
/**
132+
* Gets the raw URL of the current request.
133+
* For example: /home/example
134+
*
135+
* @return string
136+
*/
137+
public function rawUrl () {
138+
return $this->rawUrl;
110139
}
111140

112141
/**
113-
* Returns request URI.
142+
* Gets information about the URL of the client's previous request that linked to the current URL.
114143
*
115144
* @return string
116145
*/
117-
public function requestUri() {
118-
return $this->requestUri;
146+
public function urlReferrer() {
147+
return $this->serverVariables['HTTP_REFERER'];
119148
}
120149

121150
/**
@@ -126,9 +155,38 @@ public function requestUri() {
126155
* @return QueryString|string
127156
*/
128157
public function queryString($key = null) {
158+
if ($this->queryString === null) {
159+
$this->queryString = new QueryString();
160+
$queryString = array();
161+
162+
if (($qsIndex = strpos($this->rawUrl, '?')) !== false) {
163+
parse_str(substr($this->rawUrl, $qsIndex + 1), $queryString);
164+
}
165+
else {
166+
if (!empty($serverVariables['QUERY_STRING'])) {
167+
parse_str($serverVariables['QUERY_STRING'], $queryString);
168+
}
169+
}
170+
171+
if (!empty($queryString)) {
172+
foreach ($queryString as $key => $value) {
173+
$this->queryString[$key] = $value;
174+
}
175+
}
176+
}
177+
129178
return $this->getSingleKeyOrAll($this->queryString, $key);
130179
}
131180

181+
/**
182+
* Gets the document root directory under which the current script is executing, as defined in the server's configuration file.
183+
*
184+
* @return string
185+
*/
186+
public function documentRoot() {
187+
return $this->serverVariables['DOCUMENT_ROOT'];
188+
}
189+
132190
/**
133191
* Returns server variables.
134192
*
@@ -240,6 +298,37 @@ public function userHostAddress() {
240298
return $this->serverVariables['REMOTE_ADDR'];
241299
}
242300

301+
/**
302+
* Gets a sorted string array of client language preferences.
303+
*
304+
* @return array
305+
*/
306+
public function userLanguages() {
307+
if (isset($this->serverVariables['HTTP_ACCEPT_LANGUAGE'])) {
308+
preg_match_all(
309+
'/([a-z]{1,8}(-[a-z]{1,8})?)\s*(;\s*q\s*=\s*(1|0\.[0-9]+))?/i',
310+
$this->serverVariables['HTTP_ACCEPT_LANGUAGE'],
311+
$matches
312+
);
313+
314+
if (count($matches[1])) {
315+
$result = array_combine($matches[1], $matches[4]);
316+
317+
array_walk($result, function($lang, $amount) {
318+
if ($amount === '') {
319+
$langs[$lang] = 1;
320+
}
321+
});
322+
323+
arsort($result, \SORT_NUMERIC);
324+
325+
return $result;
326+
}
327+
}
328+
329+
return array();
330+
}
331+
243332
/**
244333
* Returns Content-Type of the request or empty string.
245334
*

‎src/HttpResponse.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ public function end() {
3737

3838
// files
3939
foreach ($this->files as $file) {
40-
$fp = fopen($this->path, 'rb');
40+
$fp = fopen($file, 'rb');
4141
fpassthru($fp);
4242
fclose($fp);
4343
}

‎src/HttpResponseBase.php‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,13 @@ public function clear() {
140140
$this->header = array();
141141
$this->cookies = array();
142142
$this->files = array();
143+
$this->statusCode = null;
144+
$this->statusDescription = null;
143145
$this->output = '';
146+
147+
if (ob_get_length() > 0) {
148+
ob_clean();
149+
}
144150
}
145151

146152
/**

‎src/Make.php‎

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -39,10 +39,12 @@ final class Make {
3939
public static function magic($appNamespace, $httpContext = null, $basePath = null) {
4040
self::init($appNamespace, $basePath);
4141
self::include();
42-
self::context($httpContext);
43-
self::headers();
44-
self::validation();
45-
self::render();
42+
43+
if (self::context($httpContext)) {
44+
self::headers();
45+
self::validation();
46+
self::render();
47+
}
4648
}
4749

4850
/**
@@ -125,12 +127,20 @@ private static function context($httpContext = null) {
125127
self::$request = $httpContext->getRequest();
126128
self::$response = $httpContext->getResponse();
127129

128-
// check route
130+
// get route
131+
if ($httpContext->isIgnoredRoute()) {
132+
self::$response->clear();
133+
require(PHPMVC_ROOT_PATH . self::$request->rawUrl());
134+
self::$response->end();
135+
return false;
136+
}
137+
129138
$route = $httpContext->getRoute();
130139

131140
if ($route == null) {
132141
self::$response->setStatusCode(404);
133142
self::$response->end();
143+
return false;
134144
}
135145

136146
define('PHPMVC_CONTROLLER', ucfirst($route->getValueOrDefault('controller', 'Home')));
@@ -208,6 +218,8 @@ private static function context($httpContext = null) {
208218
}
209219

210220
InternalHelper::setPropertyValue($actionContext, 'filters', $allFiltersInstance);
221+
222+
return true;
211223
}
212224

213225
/**

‎src/Route.php‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,13 @@ class Route {
4949
*/
5050
public $values;
5151

52+
/**
53+
* Indicates that this ignore rule.
54+
*
55+
* @var bool
56+
*/
57+
public $ignore;
58+
5259
/**
5360
* Gets or sets segments of the route.
5461
*
@@ -309,7 +316,7 @@ private function extractSegments($route, $template, &$required) {
309316

310317
$this->setBounds($segments);
311318

312-
if ((empty($namedSegments['controller']) && empty($this->defaults['controller'])) || (empty($namedSegments['action']) && empty($this->defaults['action']))) {
319+
if ($this->ignore !== true && ((empty($namedSegments['controller']) && empty($this->defaults['controller'])) || (empty($namedSegments['action']) && empty($this->defaults['action'])))) {
313320
throw new RouteSegmentsRequiredException($this);
314321
}
315322

0 commit comments

Comments
 (0)