X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=src%2FApp%2FRouter.php;h=181f5368d51de5668a9f5d77bb419166330c7ade;hb=85d162d1d2a738c6d21e834fe1b5cb579c4f581e;hp=450822cf86fdf530212fc6b40ba65c2393a1b1f9;hpb=f9d0e57f913d55dedfb8c5175ae12dfe0b88d557;p=friendica.git

diff --git a/src/App/Router.php b/src/App/Router.php
index 450822cf86..181f5368d5 100644
--- a/src/App/Router.php
+++ b/src/App/Router.php
@@ -1,4 +1,23 @@
 <?php
+/**
+ * @copyright Copyright (C) 2010-2021, the Friendica project
+ *
+ * @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;
 
@@ -7,8 +26,11 @@ use FastRoute\DataGenerator\GroupCountBased;
 use FastRoute\Dispatcher;
 use FastRoute\RouteCollector;
 use FastRoute\RouteParser\Std;
+use Friendica\Core\Cache\Enum\Duration;
+use Friendica\Core\Cache\Capability\ICanCache;
 use Friendica\Core\Hook;
 use Friendica\Core\L10n;
+use Friendica\Core\Lock\Capability\ICanLock;
 use Friendica\Network\HTTPException;
 
 /**
@@ -23,12 +45,20 @@ 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 OPTIONS = 'OPTIONS';
 
 	const ALLOWED_METHODS = [
-		self::POST,
+		self::DELETE,
 		self::GET,
+		self::PATCH,
+		self::POST,
+		self::PUT,
+		self::OPTIONS
 	];
 
 	/** @var RouteCollector */
@@ -47,14 +77,28 @@ class Router
 	/** @var L10n */
 	private $l10n;
 
+	/** @var ICanCache */
+	private $cache;
+
+	/** @var ICanLock */
+	private $lock;
+
+	/** @var string */
+	private $baseRoutesFilepath;
+
 	/**
-	 * @param array $server The $_SERVER variable
-	 * @param L10n  $l10n
-	 * @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 ICanCache           $cache
+	 * @param RouteCollector|null $routeCollector
 	 */
-	public function __construct(array $server, L10n $l10n, RouteCollector $routeCollector = null)
+	public function __construct(array $server, string $baseRoutesFilepath, L10n $l10n, ICanCache $cache, ICanLock $lock, RouteCollector $routeCollector = null)
 	{
+		$this->baseRoutesFilepath = $baseRoutesFilepath;
 		$this->l10n = $l10n;
+		$this->cache = $cache;
+		$this->lock = $lock;
 
 		$httpMethod = $server['REQUEST_METHOD'] ?? self::GET;
 		$this->httpMethod = in_array($httpMethod, self::ALLOWED_METHODS) ? $httpMethod : self::GET;
@@ -62,9 +106,16 @@ class Router
 		$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
@@ -81,6 +132,9 @@ class Router
 
 		$this->routeCollector = $routeCollector;
 
+		// Add routes from addons
+		Hook::callAll('route_collection', $this->routeCollector);
+
 		return $this;
 	}
 
@@ -172,12 +226,9 @@ class Router
 	 */
 	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 = [];
@@ -204,4 +255,73 @@ class Router
 	{
 		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;
+		}
+
+		if (!$this->lock->acquire('getCachedDispatchData', 0)) {
+			// Immediately return uncached data when we can't aquire a lock
+			return $this->getDispatchData();
+		}
+
+		$routerDispatchData = $this->getDispatchData();
+
+		$this->cache->set('routerDispatchData', $routerDispatchData, Duration::DAY);
+		if (!empty($routesFileModifiedTime)) {
+			$this->cache->set('lastRoutesFileModifiedTime', $routesFileModifiedTime, Duration::MONTH);
+		}
+
+		if ($this->lock->isLocked('getCachedDispatchData')) {
+			$this->lock->release('getCachedDispatchData');
+		}
+
+		return $routerDispatchData;
+	}
 }