<?php
+/**
+ * @copyright Copyright (C) 2020, Friendica
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ *
+ */
namespace Friendica\App;
use FastRoute\Dispatcher;
use FastRoute\RouteCollector;
use FastRoute\RouteParser\Std;
+use Friendica\Core\Cache\Duration;
+use Friendica\Core\Cache\ICache;
use Friendica\Core\Hook;
use Friendica\Core\L10n;
use Friendica\Network\HTTPException;
*/
class Router
{
- const POST = 'POST';
- const GET = 'GET';
+ const DELETE = 'DELETE';
+ const GET = 'GET';
+ const PATCH = 'PATCH';
+ const POST = 'POST';
+ const PUT = 'PUT';
const ALLOWED_METHODS = [
- self::POST,
+ self::DELETE,
self::GET,
+ self::PATCH,
+ self::POST,
+ self::PUT,
];
/** @var RouteCollector */
*/
private $parameters = [];
+ /** @var L10n */
+ private $l10n;
+
+ /** @var ICache */
+ private $cache;
+
+ /** @var string */
+ private $baseRoutesFilepath;
+
/**
- * @param array $server The $_SERVER variable
- * @param RouteCollector|null $routeCollector Optional the loaded Route collector
+ * @param array $server The $_SERVER variable
+ * @param string $baseRoutesFilepath The path to a base routes file to leverage cache, can be empty
+ * @param L10n $l10n
+ * @param ICache $cache
+ * @param RouteCollector|null $routeCollector
*/
- public function __construct(array $server, RouteCollector $routeCollector = null)
+ public function __construct(array $server, string $baseRoutesFilepath, L10n $l10n, ICache $cache, RouteCollector $routeCollector = null)
{
+ $this->baseRoutesFilepath = $baseRoutesFilepath;
+ $this->l10n = $l10n;
+ $this->cache = $cache;
+
$httpMethod = $server['REQUEST_METHOD'] ?? self::GET;
$this->httpMethod = in_array($httpMethod, self::ALLOWED_METHODS) ? $httpMethod : self::GET;
$this->routeCollector = isset($routeCollector) ?
$routeCollector :
new RouteCollector(new Std(), new GroupCountBased());
+
+ if ($this->baseRoutesFilepath && !file_exists($this->baseRoutesFilepath)) {
+ throw new HTTPException\InternalServerErrorException('Routes file path does\'n exist.');
+ }
}
/**
+ * This will be called either automatically if a base routes file path was submitted,
+ * or can be called manually with a custom route array.
+ *
* @param array $routes The routes to add to the Router
*
* @return self The router instance with the loaded routes
$this->routeCollector = $routeCollector;
+ // Add routes from addons
+ Hook::callAll('route_collection', $this->routeCollector);
+
return $this;
}
*/
public function getModuleClass($cmd)
{
- // Add routes from addons
- Hook::callAll('route_collection', $this->routeCollector);
-
$cmd = '/' . ltrim($cmd, '/');
- $dispatcher = new Dispatcher\GroupCountBased($this->routeCollector->getData());
+ $dispatcher = new Dispatcher\GroupCountBased($this->getCachedDispatchData());
$moduleClass = null;
$this->parameters = [];
$moduleClass = $routeInfo[1];
$this->parameters = $routeInfo[2];
} elseif ($routeInfo[0] === Dispatcher::METHOD_NOT_ALLOWED) {
- throw new HTTPException\MethodNotAllowedException(L10n::t('Method not allowed for this module. Allowed method(s): %s', implode(', ', $routeInfo[1])));
+ throw new HTTPException\MethodNotAllowedException($this->l10n->t('Method not allowed for this module. Allowed method(s): %s', implode(', ', $routeInfo[1])));
} else {
- throw new HTTPException\NotFoundException(L10n::t('Page not found.'));
+ throw new HTTPException\NotFoundException($this->l10n->t('Page not found.'));
}
return $moduleClass;
{
return $this->parameters;
}
+
+ /**
+ * If a base routes file path has been provided, we can load routes from it if the cache misses.
+ *
+ * @return array
+ * @throws HTTPException\InternalServerErrorException
+ */
+ private function getDispatchData()
+ {
+ $dispatchData = [];
+
+ if ($this->baseRoutesFilepath) {
+ $dispatchData = require $this->baseRoutesFilepath;
+ if (!is_array($dispatchData)) {
+ throw new HTTPException\InternalServerErrorException('Invalid base routes file');
+ }
+ }
+
+ $this->loadRoutes($dispatchData);
+
+ return $this->routeCollector->getData();
+ }
+
+ /**
+ * We cache the dispatch data for speed, as computing the current routes (version 2020.09)
+ * takes about 850ms for each requests.
+ *
+ * The cached "routerDispatchData" lasts for a day, and must be cleared manually when there
+ * is any changes in the enabled addons list.
+ *
+ * Additionally, we check for the base routes file last modification time to automatically
+ * trigger re-computing the dispatch data.
+ *
+ * @return array|mixed
+ * @throws HTTPException\InternalServerErrorException
+ */
+ private function getCachedDispatchData()
+ {
+ $routerDispatchData = $this->cache->get('routerDispatchData');
+ $lastRoutesFileModifiedTime = $this->cache->get('lastRoutesFileModifiedTime');
+ $forceRecompute = false;
+
+ if ($this->baseRoutesFilepath) {
+ $routesFileModifiedTime = filemtime($this->baseRoutesFilepath);
+ $forceRecompute = $lastRoutesFileModifiedTime != $routesFileModifiedTime;
+ }
+
+ if (!$forceRecompute && $routerDispatchData) {
+ return $routerDispatchData;
+ }
+
+ $routerDispatchData = $this->getDispatchData();
+
+ $this->cache->set('routerDispatchData', $routerDispatchData, Duration::DAY);
+ if (!empty($routesFileModifiedTime)) {
+ $this->cache->set('lastRoutesFileMtime', $routesFileModifiedTime, Duration::MONTH);
+ }
+
+ return $routerDispatchData;
+ }
}
projects / friendica.git / blobdiff