2013-08-17 13:16:48 +04:00
|
|
|
<?php
|
2019-12-03 21:57:53 +03:00
|
|
|
|
2019-01-21 14:14:01 +03:00
|
|
|
declare(strict_types=1);
|
2019-12-03 21:57:53 +03:00
|
|
|
|
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>
|
2019-12-03 21:57:53 +03:00
|
|
|
* @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,
|
2019-12-03 21:57:53 +03:00
|
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>
|
2013-08-17 13:16:48 +04:00
|
|
|
*
|
|
|
|
*/
|
2015-02-26 13:37:37 +03:00
|
|
|
|
2016-04-22 16:28:09 +03:00
|
|
|
namespace OC\AppFramework\Routing;
|
2013-08-17 13:16:48 +04:00
|
|
|
|
|
|
|
use OC\AppFramework\DependencyInjection\DIContainer;
|
2014-03-10 17:04:58 +04:00
|
|
|
use OCP\Route\IRouter;
|
2013-08-17 13:16:48 +04:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Class RouteConfig
|
|
|
|
* @package OC\AppFramework\routing
|
|
|
|
*/
|
|
|
|
class RouteConfig {
|
2016-09-11 14:25:32 +03:00
|
|
|
/** @var DIContainer */
|
2013-08-17 13:16:48 +04:00
|
|
|
private $container;
|
2016-09-11 14:25:32 +03:00
|
|
|
|
|
|
|
/** @var IRouter */
|
2013-08-17 13:16:48 +04:00
|
|
|
private $router;
|
2016-09-11 14:25:32 +03:00
|
|
|
|
|
|
|
/** @var array */
|
2013-08-17 13:16:48 +04:00
|
|
|
private $routes;
|
2016-09-11 14:25:32 +03:00
|
|
|
|
|
|
|
/** @var string */
|
2013-08-17 13:16:48 +04:00
|
|
|
private $appName;
|
|
|
|
|
2016-09-11 14:25:32 +03:00
|
|
|
/** @var string[] */
|
|
|
|
private $controllerNameCache = [];
|
|
|
|
|
2020-04-14 18:53:15 +03:00
|
|
|
protected $rootUrlApps = [
|
2020-03-23 18:33:11 +03:00
|
|
|
'cloud_federation_api',
|
|
|
|
'core',
|
|
|
|
'files_sharing',
|
|
|
|
'files',
|
|
|
|
'spreed',
|
|
|
|
];
|
|
|
|
|
2013-08-17 13:16:48 +04:00
|
|
|
/**
|
|
|
|
* @param \OC\AppFramework\DependencyInjection\DIContainer $container
|
2014-03-10 17:04:58 +04:00
|
|
|
* @param \OCP\Route\IRouter $router
|
2016-09-11 14:25:32 +03:00
|
|
|
* @param array $routes
|
2013-08-17 13:16:48 +04:00
|
|
|
* @internal param $appName
|
|
|
|
*/
|
2014-03-10 17:04:58 +04:00
|
|
|
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'];
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2014-03-10 17:04:58 +04:00
|
|
|
* 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);
|
2016-05-17 11:11:27 +03:00
|
|
|
|
|
|
|
/*
|
|
|
|
* OCS routes go into a different collection
|
|
|
|
*/
|
|
|
|
$oldCollection = $this->router->getCurrentCollection();
|
2019-01-21 14:14:01 +03:00
|
|
|
$this->router->useCollection($oldCollection . '.ocs');
|
2016-05-17 11:11:27 +03:00
|
|
|
|
|
|
|
// parse ocs simple routes
|
|
|
|
$this->processOCS($this->routes);
|
|
|
|
|
2019-01-21 14:02:36 +03:00
|
|
|
// parse ocs simple routes
|
|
|
|
$this->processOCSResources($this->routes);
|
|
|
|
|
2016-05-17 11:11:27 +03:00
|
|
|
$this->router->useCollection($oldCollection);
|
|
|
|
}
|
|
|
|
|
2019-01-21 14:14:01 +03:00
|
|
|
private function processOCS(array $routes): void {
|
|
|
|
$ocsRoutes = $routes['ocs'] ?? [];
|
2016-05-17 11:11:27 +03:00
|
|
|
foreach ($ocsRoutes as $ocsRoute) {
|
2020-03-23 18:33:11 +03:00
|
|
|
$this->processRoute($ocsRoute, 'ocs.');
|
2016-05-17 11:11:27 +03:00
|
|
|
}
|
2013-08-17 13:16:48 +04:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Creates one route base on the give configuration
|
2014-05-12 00:51:30 +04:00
|
|
|
* @param array $routes
|
2013-08-17 13:16:48 +04:00
|
|
|
* @throws \UnexpectedValueException
|
|
|
|
*/
|
2019-01-21 14:14:01 +03:00
|
|
|
private function processSimpleRoutes(array $routes): void {
|
|
|
|
$simpleRoutes = $routes['routes'] ?? [];
|
2013-08-17 13:16:48 +04:00
|
|
|
foreach ($simpleRoutes as $simpleRoute) {
|
2020-03-23 18:33:11 +03:00
|
|
|
$this->processRoute($simpleRoute);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
protected function processRoute(array $route, string $routeNamePrefix = ''): void {
|
|
|
|
$name = $route['name'];
|
|
|
|
$postfix = $route['postfix'] ?? '';
|
|
|
|
$defaultRoot = $this->appName === 'core' ? '' : '/apps/' . $this->appName;
|
|
|
|
$root = $route['root'] ?? $defaultRoot;
|
2020-04-14 18:53:15 +03:00
|
|
|
if ($routeNamePrefix === '' && !\in_array($this->appName, $this->rootUrlApps, true)) {
|
2020-03-23 18:33:11 +03:00
|
|
|
// Only allow root URLS for some apps
|
|
|
|
$root = $defaultRoot;
|
|
|
|
}
|
|
|
|
|
|
|
|
$url = $root . $route['url'];
|
|
|
|
$verb = strtoupper($route['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 = $routeNamePrefix . $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
|
2020-04-14 18:24:29 +03:00
|
|
|
if (array_key_exists('requirements', $route)) {
|
2020-03-23 18:33:11 +03:00
|
|
|
$router->requirements($route['requirements']);
|
|
|
|
}
|
|
|
|
|
|
|
|
// optionally register defaults for route. This is used to
|
|
|
|
// tell the route parser how url parameters should be default valued
|
2020-04-14 18:24:29 +03:00
|
|
|
if (array_key_exists('defaults', $route)) {
|
2020-03-23 18:33:11 +03:00
|
|
|
$router->defaults($route['defaults']);
|
2013-08-17 13:16:48 +04:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2019-01-21 14:14:01 +03:00
|
|
|
* For a given name and url restful OCS routes are created:
|
2013-08-17 13:16:48 +04:00
|
|
|
* - index
|
|
|
|
* - show
|
2019-01-21 14:02:36 +03:00
|
|
|
* - create
|
|
|
|
* - update
|
|
|
|
* - destroy
|
|
|
|
*
|
|
|
|
* @param array $routes
|
|
|
|
*/
|
2019-01-21 14:14:01 +03:00
|
|
|
private function processOCSResources(array $routes): void {
|
2019-01-21 14:02:36 +03:00
|
|
|
// declaration of all restful actions
|
2019-01-21 14:14:01 +03:00
|
|
|
$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'],
|
|
|
|
];
|
2019-01-21 14:02:36 +03:00
|
|
|
|
|
|
|
$resources = $routes['ocs-resources'] ?? [];
|
|
|
|
foreach ($resources as $resource => $config) {
|
|
|
|
$root = $config['root'] ?? '/apps/' . $this->appName;
|
|
|
|
|
|
|
|
// the url parameter used as id to the resource
|
2020-04-10 15:19:56 +03:00
|
|
|
foreach ($actions as $action) {
|
2019-01-21 14:02:36 +03:00
|
|
|
$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
|
|
|
|
*
|
2014-05-12 00:51:30 +04:00
|
|
|
* @param array $routes
|
2013-08-17 13:16:48 +04:00
|
|
|
*/
|
2019-01-21 14:14:01 +03:00
|
|
|
private function processResources(array $routes): void {
|
2013-08-17 13:16:48 +04:00
|
|
|
// declaration of all restful actions
|
2019-01-21 14:14:01 +03:00
|
|
|
$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
|
2020-04-10 15:19:56 +03:00
|
|
|
foreach ($actions as $action) {
|
2013-08-17 13:16:48 +04:00
|
|
|
$url = $config['url'];
|
|
|
|
$method = $action['name'];
|
2019-01-21 14:14:01 +03:00
|
|
|
$verb = strtoupper($action['verb'] ?? 'GET');
|
|
|
|
$collectionAction = $action['on-collection'] ?? false;
|
2013-08-17 13:16:48 +04:00
|
|
|
if (!$collectionAction) {
|
2019-01-21 14:14:01 +03:00
|
|
|
$url .= '/{id}';
|
2013-08-17 13:16:48 +04:00
|
|
|
}
|
|
|
|
if (isset($action['url-postfix'])) {
|
2019-01-21 14:14:01 +03:00
|
|
|
$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);
|
|
|
|
|
2017-04-18 22:50:25 +03:00
|
|
|
$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
|
2014-05-12 00:51:30 +04:00
|
|
|
* @param string $controller
|
2013-08-17 13:16:48 +04:00
|
|
|
* @return string
|
|
|
|
*/
|
2019-01-21 14:14:01 +03:00
|
|
|
private function buildControllerName(string $controller): string {
|
2016-09-11 14:25:32 +03:00
|
|
|
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
|
2014-05-12 00:51:30 +04:00
|
|
|
* @param string $action
|
2013-08-17 13:16:48 +04:00
|
|
|
* @return string
|
|
|
|
*/
|
2019-01-21 14:14:01 +03:00
|
|
|
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
|
2014-05-12 00:51:30 +04:00
|
|
|
* @param string $str
|
2013-08-17 13:16:48 +04:00
|
|
|
* @return string
|
|
|
|
*/
|
2019-01-21 14:14:01 +03:00
|
|
|
private function underScoreToCamelCase(string $str): string {
|
|
|
|
$pattern = '/_[a-z]?/';
|
2013-08-17 13:16:48 +04:00
|
|
|
return preg_replace_callback(
|
|
|
|
$pattern,
|
|
|
|
function ($matches) {
|
2019-01-21 14:14:01 +03:00
|
|
|
return strtoupper(ltrim($matches[0], '_'));
|
2013-08-17 13:16:48 +04:00
|
|
|
},
|
|
|
|
$str);
|
|
|
|
}
|
|
|
|
}
|