123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317 |
- <?php
- declare(strict_types=1);
- /**
- * @copyright Copyright (c) 2016, ownCloud, Inc.
- *
- * @author Bernhard Posselt <dev@bernhard-posselt.com>
- * @author Morris Jobke <hey@morrisjobke.de>
- * @author Patrick Paysant <ppaysant@linagora.com>
- * @author Robin Appelman <robin@icewind.nl>
- * @author Robin McCorkell <robin@mccorkell.me.uk>
- * @author Roeland Jago Douma <roeland@famdouma.nl>
- * @author Thomas Müller <thomas.mueller@tmit.eu>
- *
- * @license AGPL-3.0
- *
- * 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.
- *
- * 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, version 3,
- * along with this program. If not, see <http://www.gnu.org/licenses/>
- *
- */
- namespace OC\AppFramework\Routing;
- use OC\AppFramework\DependencyInjection\DIContainer;
- use OCP\Route\IRouter;
- /**
- * Class RouteConfig
- * @package OC\AppFramework\routing
- */
- class RouteConfig {
- /** @var DIContainer */
- private $container;
- /** @var IRouter */
- private $router;
- /** @var array */
- private $routes;
- /** @var string */
- private $appName;
- /** @var string[] */
- private $controllerNameCache = [];
- /**
- * @param \OC\AppFramework\DependencyInjection\DIContainer $container
- * @param \OCP\Route\IRouter $router
- * @param array $routes
- * @internal param $appName
- */
- public function __construct(DIContainer $container, IRouter $router, $routes) {
- $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
- */
- 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']);
- }
- }
- }
- /**
- * Creates one route base on the give configuration
- * @param array $routes
- * @throws \UnexpectedValueException
- */
- private function processSimpleRoutes(array $routes): void {
- $simpleRoutes = $routes['routes'] ?? [];
- foreach ($simpleRoutes as $simpleRoute) {
- $name = $simpleRoute['name'];
- $postfix = $simpleRoute['postfix'] ?? '';
- $url = $simpleRoute['url'];
- $verb = strtoupper($simpleRoute['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 = $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', $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']);
- }
- }
- }
- /**
- * For a given name and url restful OCS routes are created:
- * - 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
- * - create
- * - update
- * - destroy
- *
- * @param array $routes
- */
- private function processResources(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['resources'] ?? [];
- 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;
- if (!$collectionAction) {
- $url .= '/{id}';
- }
- if (isset($action['url-postfix'])) {
- $url .= '/' . $action['url-postfix'];
- }
- $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(
- new RouteActionHandler($this->container, $controllerName, $actionName)
- );
- }
- }
- }
- /**
- * Based on a given route name the controller name is generated
- * @param string $controller
- * @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];
- }
- /**
- * Based on the action part of the route name the controller method name is generated
- * @param string $action
- * @return string
- */
- private function buildActionName(string $action): string {
- return $this->underScoreToCamelCase($action);
- }
- /**
- * Underscored strings are converted to camel case strings
- * @param string $str
- * @return string
- */
- private function underScoreToCamelCase(string $str): string {
- $pattern = '/_[a-z]?/';
- return preg_replace_callback(
- $pattern,
- function ($matches) {
- return strtoupper(ltrim($matches[0], '_'));
- },
- $str);
- }
- }
|