Ubiquity\cache\traits\RouterCacheTrait

Complexity

Total Complexity

53

Size/Duplication

Total Lines	201
Duplicated Lines	0 %

Test Coverage

Coverage

38.98%

Importance

Changes	4
Bugs	0	Features	1

20 Methods

Rating	Name	Duplication	Size	Complexity
A	addAdminRoutes()	0	2	1
A	getControllerCacheIndex()	0	6	3
A	isExpired()	0	2	1
A	storeRouteResponse()	0	4	1
A	controllerCacheUpdated()	0	13	4
A	addRoutes_()	0	8	2
A	setExpired()	0	4	2
A	storeDynamicRoutes()	0	4	2
A	addRoute()	0	4	2
A	getRoutes()	0	3	1
A	getRouteKey()	0	5	2
B	getControllerRoutes()	0	18	7
A	getControllerCache()	0	6	3
A	warmUpControllers()	0	8	5
A	expired()	0	2	1
A	getRouteCache()	0	12	4
A	setRouteCache()	0	4	1
A	addRoutes()	0	2	1
A	addRestRoutes()	0	2	1
B	getControllerCacheByDomain()	0	26	9

<?php

namespace Ubiquity\cache\traits;

use Ubiquity\controllers\Controller;
use Ubiquity\controllers\Router;
use Ubiquity\controllers\Startup;
use Ubiquity\controllers\StartupAsync;
use Ubiquity\domains\DDDManager;
use Ubiquity\utils\base\UIntrospection;
use Ubiquity\utils\base\UString;
use Ubiquity\utils\http\UResponse;

/**
 *
 * Ubiquity\cache\traits$RouterCacheTrait
 * This class is part of Ubiquity
 *
 * @author jcheron <myaddressmail@gmail.com>
 * @version 1.0.12
 * @property \Ubiquity\cache\system\AbstractDataCache $cache
 *
 */
trait RouterCacheTrait {

	abstract public static function getControllers($subClass = "\\Ubiquity\\controllers\\Controller", $backslash = false, $includeSubclass = false, $includeAbstract = false);

	public static function controllerCacheUpdated(&$config) {
		$result = false;
		$domain=DDDManager::getActiveDomain();
		$newRoutes = self::parseControllerFiles ( $config, true ,$domain!='');
		$ctrls = self::getControllerCacheByDomain(false,$domain);
		if ($newRoutes ['default'] != $ctrls && !(false)) {
			$result ['default'] = true;
		}
		$ctrls = self::getControllerCacheByDomain ( true,$domain );
		if ($newRoutes ['rest'] != $ctrls) {
			$result ['rest'] = true;
		}
		return $result;
	}

	public static function storeDynamicRoutes($isRest = false) {
		$routes = Router::getRoutes ();
		$part = ($isRest) ? 'rest' : 'default';
		self::$cache->store ( 'controllers/routes.' . $part, $routes, 'controllers' );
	}

	private static function storeRouteResponse($key, $response) {
		$cache = [ 'content-type' => UResponse::$headers ['Content-Type'] ?? 'text/html','content' => $response ];
		self::$cache->store ( 'controllers/' . $key, $cache, 'controllers' );
		return $response;
	}

	private static function getRouteKey($routePath) {
		if (\is_array ( $routePath )) {
			return 'path' . \md5 ( \implode ( '', $routePath ) );
		}
		return 'path' . \md5 ( Router::slashPath ( $routePath ) );
	}

	/**
	 *
	 * @param boolean $isRest
	 * @return array
	 */
	public static function getControllerCache($isRest = false) {
		$key = ($isRest) ? 'rest' : 'default';
		if (self::$cache->exists ( 'controllers/routes.' . $key )) {
			return self::$cache->fetch ( 'controllers/routes.' . $key );
		}
		return [ ];
	}

	/**
	 *
	 * @param boolean $isRest
	 * @param string $domain
	 * @return array
	 */
	public static function getControllerCacheByDomain(bool $isRest = false,string $domain=''): array {
		$key = ($isRest) ? 'rest' : 'default';
		if (self::$cache->exists ( 'controllers/routes.' . $key )) {
			if($domain=='') {
				return self::$cache->fetch('controllers/routes.' . $key);
			}else{
				$ns=Startup::getNS();
				$routes=self::$cache->fetch('controllers/routes.' . $key);
				$result=[];
				foreach ($routes as $k=>$route){
					if(isset($route['controller'])){
						if(UString::startswith($route['controller'],$ns)) {
							$result[$k]=$route;
						}
					}else{
						foreach ($route as $method=>$routePart){
							if(UString::startswith($routePart['controller'],$ns)) {
								$result[$k][$method]=$routePart;
							}
						}
					}
				}
				return $result;
			}
		}
		return [ ];
	}

	/**
	 *
	 * @param boolean $isRest
	 * @return array
	 */
	public static function getControllerCacheIndex($isRest = false) {
		$key = ($isRest) ? 'rest-index' : 'default-index';
		if (self::$cache->exists ( 'controllers/routes.' . $key )) {
			return self::$cache->fetch ( 'controllers/routes.' . $key );
		}
		return [ ];
	}

	public static function getRouteCache($routePath, $routeArray, $duration) {
		$key = self::getRouteKey ( $routePath );

		if (self::$cache->exists ( 'controllers/' . $key ) && ! self::expired ( $key, $duration )) {
			$response = self::$cache->fetch ( 'controllers/' . $key );
			if ($ct = $response ['content-type'] ?? false) {
				UResponse::setContentType ( $ct );
			}
			return $response ['content'] ?? '';
		} else {
			$response = Startup::runAsString ( $routeArray );
			return self::storeRouteResponse ( $key, $response );
		}
	}

	protected static function expired($key, $duration) {
		return self::$cache->expired ( "controllers/" . $key, $duration ) === true;
	}

	public static function isExpired($routePath, $duration) {
		return self::expired ( self::getRouteKey ( $routePath ), $duration );
	}

	public static function setExpired($routePath) {
		$key = self::getRouteKey ( $routePath );
		if (self::$cache->exists ( 'controllers/' . $key )) {
			self::$cache->remove ( 'controllers/' . $key );
		}
	}

	public static function setRouteCache($routePath) {
		$key = self::getRouteKey ( $routePath );
		$response = Startup::runAsString ( $routePath );
		return self::storeRouteResponse ( $key, $response );
	}

	public static function addAdminRoutes() {
		self::addControllerCache ( 'Ubiquity\controllers\Admin' );
	}

	public static function getRoutes() {
		$result = self::getControllerCache ();
		return $result;
	}

	public static function getControllerRoutes($controllerClass, $isRest = false) {
		$result = [ ];
		$ctrlCache = self::getControllerCache ( $isRest );
		foreach ( $ctrlCache as $path => $routeAttributes ) {
			if (isset ( $routeAttributes ['controller'] )) {
				if ($routeAttributes ['controller'] === $controllerClass) {
					$result [$path] = $routeAttributes;
				}
			} else {
				$firstValue = current ( $routeAttributes );
				if (isset ( $firstValue ) && isset ( $firstValue ['controller'] )) {
					if ($firstValue ['controller'] === $controllerClass) {
						$result [$path] = $routeAttributes;
					}
				}
			}
		}
		return $result;
	}

	public static function addRoute($path, $controller, $action = 'index', $methods = null, $name = '', $isRest = false, $priority = 0, $callback = null) {
		$controllerCache = self::getControllerCache ( $isRest );
		Router::addRouteToRoutes ( $controllerCache, $path, $controller, $action, $methods, $name, false, null, [ ], $priority, $callback );
		self::$cache->store ( 'controllers/routes.' . ($isRest ? 'rest' : 'default'), $controllerCache, 'controllers' );
	}

	public static function addRoutes($pathArray, $controller, $action = 'index', $methods = null, $name = '') {
		self::addRoutes_ ( $pathArray, $controller, $action, $methods, $name, false );
	}

	public static function addRestRoutes($pathArray, $controller, $action = 'index', $methods = null, $name = '') {
		self::addRoutes_ ( $pathArray, $controller, $action, $methods, $name, true );
	}

	private static function addRoutes_($pathArray, $controller, $action = 'index', $methods = null, $name = '', $isRest = false) {
		$controllerCache = self::getControllerCache ( $isRest );
		$postfix = 'default';
		if ($isRest) {
			$postfix = 'rest';
		}
		Router::addRoutesToRoutes ( $controllerCache, $pathArray, $controller, $action, $methods, $name );
		self::$cache->store ( 'controllers/routes.' . $postfix, $controllerCache, 'controllers' );
	}

	/**
	 * Preloads controllers.
	 * To use only with async servers (Swoole, Workerman)
	 *
	 * @param ?array $controllers
	 */
	public static function warmUpControllers($controllers = null) {
		$controllers ??= self::getControllers ();
		foreach ( $controllers as $ctrl ) {
			$controller = StartupAsync::getControllerInstance ( $ctrl );
			$binary = UIntrospection::implementsMethod ( $controller, 'isValid', Controller::class ) ? 1 : 0;
			$binary += UIntrospection::implementsMethod ( $controller, 'initialize', Controller::class ) ? 2 : 0;
			$binary += UIntrospection::implementsMethod ( $controller, 'finalize', Controller::class ) ? 4 : 0;
			$controller->_binaryCalls = $binary;
		}
	}
}