nextcloud/lib/private/AppFramework/Routing/RouteConfig.php

335 lines
9.9 KiB
PHP
Raw Normal View History

2013-08-17 13:16:48 +04:00
<?php
declare(strict_types=1);
2013-08-17 13:16:48 +04:00
/**
2016-07-21 18:07:57 +03:00
* @copyright Copyright (c) 2016, ownCloud, Inc.
*
2015-03-26 13:44:34 +03:00
* @author Bernhard Posselt <dev@bernhard-posselt.com>
* @author Joas Schilling <coding@schilljs.com>
2015-03-26 13:44:34 +03:00
* @author Morris Jobke <hey@morrisjobke.de>
* @author Patrick Paysant <ppaysant@linagora.com>
2016-07-21 19:13:36 +03:00
* @author Robin Appelman <robin@icewind.nl>
2016-01-12 17:02:16 +03:00
* @author Robin McCorkell <robin@mccorkell.me.uk>
2016-07-21 18:07:57 +03:00
* @author Roeland Jago Douma <roeland@famdouma.nl>
2015-03-26 13:44:34 +03:00
* @author Thomas Müller <thomas.mueller@tmit.eu>
2013-08-17 13:16:48 +04:00
*
2015-03-26 13:44:34 +03:00
* @license AGPL-3.0
2013-08-17 13:16:48 +04:00
*
2015-03-26 13:44:34 +03:00
* This code is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
2013-08-17 13:16:48 +04:00
*
2015-03-26 13:44:34 +03:00
* This program is distributed in the hope that it will be useful,
2013-08-17 13:16:48 +04:00
* but WITHOUT ANY WARRANTY; without even the implied warranty of
2015-03-26 13:44:34 +03:00
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
2013-08-17 13:16:48 +04:00
*
2015-03-26 13:44:34 +03:00
* You should have received a copy of the GNU Affero General Public License, version 3,
* along with this program. If not, see <http://www.gnu.org/licenses/>
2013-08-17 13:16:48 +04:00
*
*/
namespace OC\AppFramework\Routing;
2013-08-17 13:16:48 +04:00
use OC\AppFramework\DependencyInjection\DIContainer;
use OCP\AppFramework\App;
use OCP\Route\IRouter;
2013-08-17 13:16:48 +04:00
/**
* Class RouteConfig
* @package OC\AppFramework\routing
*/
class RouteConfig {
/** @var DIContainer */
2013-08-17 13:16:48 +04:00
private $container;
/** @var IRouter */
2013-08-17 13:16:48 +04:00
private $router;
/** @var array */
2013-08-17 13:16:48 +04:00
private $routes;
/** @var string */
2013-08-17 13:16:48 +04:00
private $appName;
/** @var string[] */
private $controllerNameCache = [];
2013-08-17 13:16:48 +04:00
/**
* @param \OC\AppFramework\DependencyInjection\DIContainer $container
* @param \OCP\Route\IRouter $router
* @param array $routes
2013-08-17 13:16:48 +04:00
* @internal param $appName
*/
public function __construct(DIContainer $container, IRouter $router, $routes) {
2013-08-17 13:16:48 +04:00
$this->routes = $routes;
$this->container = $container;
$this->router = $router;
$this->appName = $container['AppName'];
}
/**
* The routes and resource will be registered to the \OCP\Route\IRouter
2013-08-17 13:16:48 +04:00
*/
public function register() {
// parse simple
$this->processSimpleRoutes($this->routes);
// parse resources
$this->processResources($this->routes);
/*
* OCS routes go into a different collection
*/
$oldCollection = $this->router->getCurrentCollection();
$this->router->useCollection($oldCollection . '.ocs');
// parse ocs simple routes
$this->processOCS($this->routes);
// parse ocs simple routes
$this->processOCSResources($this->routes);
$this->router->useCollection($oldCollection);
}
private function processOCS(array $routes): void {
$ocsRoutes = $routes['ocs'] ?? [];
foreach ($ocsRoutes as $ocsRoute) {
$name = $ocsRoute['name'];
$postfix = $ocsRoute['postfix'] ?? '';
$root = $ocsRoute['root'] ?? '/apps/' . $this->appName;
$url = $root . $ocsRoute['url'];
$verb = strtoupper($ocsRoute['verb'] ?? 'GET');
$split = explode('#', $name, 2);
if (count($split) !== 2) {
throw new \UnexpectedValueException('Invalid route name');
}
list($controller, $action) = $split;
$controllerName = $this->buildControllerName($controller);
$actionName = $this->buildActionName($action);
$routeName = 'ocs.' . $this->appName . '.' . $controller . '.' . $action . $postfix;
// register the route
$handler = new RouteActionHandler($this->container, $controllerName, $actionName);
$router = $this->router->create($routeName, $url)
->method($verb)
->action($handler);
// optionally register requirements for route. This is used to
// tell the route parser how url parameters should be matched
if(array_key_exists('requirements', $ocsRoute)) {
$router->requirements($ocsRoute['requirements']);
}
// optionally register defaults for route. This is used to
// tell the route parser how url parameters should be default valued
if(array_key_exists('defaults', $ocsRoute)) {
$router->defaults($ocsRoute['defaults']);
}
}
2013-08-17 13:16:48 +04:00
}
/**
* Creates one route base on the give configuration
* @param array $routes
2013-08-17 13:16:48 +04:00
* @throws \UnexpectedValueException
*/
private function processSimpleRoutes(array $routes): void {
$simpleRoutes = $routes['routes'] ?? [];
2013-08-17 13:16:48 +04:00
foreach ($simpleRoutes as $simpleRoute) {
$name = $simpleRoute['name'];
$postfix = $simpleRoute['postfix'] ?? '';
2014-11-19 14:00:41 +03:00
2013-08-17 13:16:48 +04:00
$url = $simpleRoute['url'];
$verb = strtoupper($simpleRoute['verb'] ?? 'GET');
2013-08-17 13:16:48 +04:00
$split = explode('#', $name, 2);
if (count($split) !== 2) {
2013-08-17 13:16:48 +04:00
throw new \UnexpectedValueException('Invalid route name');
}
list($controller, $action) = $split;
2013-08-17 13:16:48 +04:00
$controllerName = $this->buildControllerName($controller);
$actionName = $this->buildActionName($action);
$appName = $simpleRoute['app'] ?? $this->appName;
if (isset($simpleRoute['app'])) {
// Legacy routes that need to be globally available while they are handled by an app
// E.g. '/f/{id}', '/s/{token}', '/call/{token}', …
$controllerName = str_replace('controllerController', 'Controller', $controllerName);
if ($controllerName === 'PublicpreviewController') {
$controllerName = 'PublicPreviewController';
} elseif ($controllerName === 'RequesthandlerController') {
$controllerName = 'RequestHandlerController';
}
$controllerName = App::buildAppNamespace($appName) . '\\Controller\\' . $controllerName;
}
2013-08-17 13:16:48 +04:00
$routeName = $appName . '.' . $controller . '.' . $action . $postfix;
2013-08-17 13:16:48 +04:00
// register the route
$handler = new RouteActionHandler($this->container, $controllerName, $actionName);
$router = $this->router->create($routeName, $url)
2014-04-09 23:57:32 +04:00
->method($verb)
->action($handler);
2014-06-26 16:02:20 +04:00
// optionally register requirements for route. This is used to
2014-04-09 23:57:32 +04:00
// tell the route parser how url parameters should be matched
if(array_key_exists('requirements', $simpleRoute)) {
$router->requirements($simpleRoute['requirements']);
}
// optionally register defaults for route. This is used to
// tell the route parser how url parameters should be default valued
if(array_key_exists('defaults', $simpleRoute)) {
$router->defaults($simpleRoute['defaults']);
}
2013-08-17 13:16:48 +04:00
}
}
/**
* For a given name and url restful OCS routes are created:
2013-08-17 13:16:48 +04:00
* - index
* - show
* - create
* - update
* - destroy
*
* @param array $routes
*/
private function processOCSResources(array $routes): void {
// declaration of all restful actions
$actions = [
['name' => 'index', 'verb' => 'GET', 'on-collection' => true],
['name' => 'show', 'verb' => 'GET'],
['name' => 'create', 'verb' => 'POST', 'on-collection' => true],
['name' => 'update', 'verb' => 'PUT'],
['name' => 'destroy', 'verb' => 'DELETE'],
];
$resources = $routes['ocs-resources'] ?? [];
foreach ($resources as $resource => $config) {
$root = $config['root'] ?? '/apps/' . $this->appName;
// the url parameter used as id to the resource
foreach($actions as $action) {
$url = $root . $config['url'];
$method = $action['name'];
$verb = strtoupper($action['verb'] ?? 'GET');
$collectionAction = $action['on-collection'] ?? false;
if (!$collectionAction) {
$url .= '/{id}';
}
if (isset($action['url-postfix'])) {
$url .= '/' . $action['url-postfix'];
}
$controller = $resource;
$controllerName = $this->buildControllerName($controller);
$actionName = $this->buildActionName($method);
$routeName = 'ocs.' . $this->appName . '.' . strtolower($resource) . '.' . strtolower($method);
$this->router->create($routeName, $url)->method($verb)->action(
new RouteActionHandler($this->container, $controllerName, $actionName)
);
}
}
}
/**
* For a given name and url restful routes are created:
* - index
* - show
2013-08-17 13:16:48 +04:00
* - create
* - update
* - destroy
*
* @param array $routes
2013-08-17 13:16:48 +04:00
*/
private function processResources(array $routes): void {
2013-08-17 13:16:48 +04:00
// declaration of all restful actions
$actions = [
['name' => 'index', 'verb' => 'GET', 'on-collection' => true],
['name' => 'show', 'verb' => 'GET'],
['name' => 'create', 'verb' => 'POST', 'on-collection' => true],
['name' => 'update', 'verb' => 'PUT'],
['name' => 'destroy', 'verb' => 'DELETE'],
];
$resources = $routes['resources'] ?? [];
2013-08-17 13:16:48 +04:00
foreach ($resources as $resource => $config) {
// the url parameter used as id to the resource
foreach($actions as $action) {
$url = $config['url'];
$method = $action['name'];
$verb = strtoupper($action['verb'] ?? 'GET');
$collectionAction = $action['on-collection'] ?? false;
2013-08-17 13:16:48 +04:00
if (!$collectionAction) {
$url .= '/{id}';
2013-08-17 13:16:48 +04:00
}
if (isset($action['url-postfix'])) {
$url .= '/' . $action['url-postfix'];
2013-08-17 13:16:48 +04:00
}
$controller = $resource;
$controllerName = $this->buildControllerName($controller);
$actionName = $this->buildActionName($method);
$routeName = $this->appName . '.' . strtolower($resource) . '.' . strtolower($method);
$this->router->create($routeName, $url)->method($verb)->action(
2013-08-17 13:16:48 +04:00
new RouteActionHandler($this->container, $controllerName, $actionName)
);
}
}
}
/**
* Based on a given route name the controller name is generated
* @param string $controller
2013-08-17 13:16:48 +04:00
* @return string
*/
private function buildControllerName(string $controller): string {
if (!isset($this->controllerNameCache[$controller])) {
$this->controllerNameCache[$controller] = $this->underScoreToCamelCase(ucfirst($controller)) . 'Controller';
}
return $this->controllerNameCache[$controller];
2013-08-17 13:16:48 +04:00
}
/**
* Based on the action part of the route name the controller method name is generated
* @param string $action
2013-08-17 13:16:48 +04:00
* @return string
*/
private function buildActionName(string $action): string {
2013-08-17 13:16:48 +04:00
return $this->underScoreToCamelCase($action);
}
/**
* Underscored strings are converted to camel case strings
* @param string $str
2013-08-17 13:16:48 +04:00
* @return string
*/
private function underScoreToCamelCase(string $str): string {
$pattern = '/_[a-z]?/';
2013-08-17 13:16:48 +04:00
return preg_replace_callback(
$pattern,
function ($matches) {
return strtoupper(ltrim($matches[0], '_'));
2013-08-17 13:16:48 +04:00
},
$str);
}
}