nextcloud / server

lib/private/Route/Router.php

Indentation +344 added lines, -344 removed lines

@@ -45,376 +45,376 @@
 use Symfony\Component\Routing\RouteCollection;
 
 class Router implements IRouter {
-	/** @var RouteCollection[] */
-	protected $collections = [];
-	/** @var null|RouteCollection */
-	protected $collection = null;
-	/** @var null|string */
-	protected $collectionName = null;
-	/** @var null|RouteCollection */
-	protected $root = null;
-	/** @var null|UrlGenerator */
-	protected $generator = null;
-	/** @var string[] */
-	protected $routingFiles;
-	/** @var bool */
-	protected $loaded = false;
-	/** @var array */
-	protected $loadedApps = [];
-	/** @var ILogger */
-	protected $logger;
-	/** @var RequestContext */
-	protected $context;
+    /** @var RouteCollection[] */
+    protected $collections = [];
+    /** @var null|RouteCollection */
+    protected $collection = null;
+    /** @var null|string */
+    protected $collectionName = null;
+    /** @var null|RouteCollection */
+    protected $root = null;
+    /** @var null|UrlGenerator */
+    protected $generator = null;
+    /** @var string[] */
+    protected $routingFiles;
+    /** @var bool */
+    protected $loaded = false;
+    /** @var array */
+    protected $loadedApps = [];
+    /** @var ILogger */
+    protected $logger;
+    /** @var RequestContext */
+    protected $context;
 
-	/**
-	 * @param ILogger $logger
-	 */
-	public function __construct(ILogger $logger) {
-		$this->logger = $logger;
-		$baseUrl = \OC::$WEBROOT;
-		if (!(\OC::$server->getConfig()->getSystemValue('htaccess.IgnoreFrontController', false) === true || getenv('front_controller_active') === 'true')) {
-			$baseUrl = \OC::$server->getURLGenerator()->linkTo('', 'index.php');
-		}
-		if (!\OC::$CLI && isset($_SERVER['REQUEST_METHOD'])) {
-			$method = $_SERVER['REQUEST_METHOD'];
-		} else {
-			$method = 'GET';
-		}
-		$request = \OC::$server->getRequest();
-		$host = $request->getServerHost();
-		$schema = $request->getServerProtocol();
-		$this->context = new RequestContext($baseUrl, $method, $host, $schema);
-		// TODO cache
-		$this->root = $this->getCollection('root');
-	}
+    /**
+     * @param ILogger $logger
+     */
+    public function __construct(ILogger $logger) {
+        $this->logger = $logger;
+        $baseUrl = \OC::$WEBROOT;
+        if (!(\OC::$server->getConfig()->getSystemValue('htaccess.IgnoreFrontController', false) === true || getenv('front_controller_active') === 'true')) {
+            $baseUrl = \OC::$server->getURLGenerator()->linkTo('', 'index.php');
+        }
+        if (!\OC::$CLI && isset($_SERVER['REQUEST_METHOD'])) {
+            $method = $_SERVER['REQUEST_METHOD'];
+        } else {
+            $method = 'GET';
+        }
+        $request = \OC::$server->getRequest();
+        $host = $request->getServerHost();
+        $schema = $request->getServerProtocol();
+        $this->context = new RequestContext($baseUrl, $method, $host, $schema);
+        // TODO cache
+        $this->root = $this->getCollection('root');
+    }
 
-	/**
-	 * Get the files to load the routes from
-	 *
-	 * @return string[]
-	 */
-	public function getRoutingFiles() {
-		if (!isset($this->routingFiles)) {
-			$this->routingFiles = [];
-			foreach (\OC_APP::getEnabledApps() as $app) {
-				$appPath = \OC_App::getAppPath($app);
-				if ($appPath !== false) {
-					$file = $appPath . '/appinfo/routes.php';
-					if (file_exists($file)) {
-						$this->routingFiles[$app] = $file;
-					}
-				}
-			}
-		}
-		return $this->routingFiles;
-	}
+    /**
+     * Get the files to load the routes from
+     *
+     * @return string[]
+     */
+    public function getRoutingFiles() {
+        if (!isset($this->routingFiles)) {
+            $this->routingFiles = [];
+            foreach (\OC_APP::getEnabledApps() as $app) {
+                $appPath = \OC_App::getAppPath($app);
+                if ($appPath !== false) {
+                    $file = $appPath . '/appinfo/routes.php';
+                    if (file_exists($file)) {
+                        $this->routingFiles[$app] = $file;
+                    }
+                }
+            }
+        }
+        return $this->routingFiles;
+    }
 
-	/**
-	 * Loads the routes
-	 *
-	 * @param null|string $app
-	 */
-	public function loadRoutes($app = null) {
-		if (is_string($app)) {
-			$app = \OC_App::cleanAppId($app);
-		}
+    /**
+     * Loads the routes
+     *
+     * @param null|string $app
+     */
+    public function loadRoutes($app = null) {
+        if (is_string($app)) {
+            $app = \OC_App::cleanAppId($app);
+        }
 
-		$requestedApp = $app;
-		if ($this->loaded) {
-			return;
-		}
-		if (is_null($app)) {
-			$this->loaded = true;
-			$routingFiles = $this->getRoutingFiles();
-		} else {
-			if (isset($this->loadedApps[$app])) {
-				return;
-			}
-			$file = \OC_App::getAppPath($app) . '/appinfo/routes.php';
-			if ($file !== false && file_exists($file)) {
-				$routingFiles = [$app => $file];
-			} else {
-				$routingFiles = [];
-			}
-		}
-		\OC::$server->getEventLogger()->start('loadroutes' . $requestedApp, 'Loading Routes');
-		foreach ($routingFiles as $app => $file) {
-			if (!isset($this->loadedApps[$app])) {
-				if (!\OC_App::isAppLoaded($app)) {
-					// app MUST be loaded before app routes
-					// try again next time loadRoutes() is called
-					$this->loaded = false;
-					continue;
-				}
-				$this->loadedApps[$app] = true;
-				$this->useCollection($app);
-				$this->requireRouteFile($file, $app);
-				$collection = $this->getCollection($app);
-				$this->root->addCollection($collection);
+        $requestedApp = $app;
+        if ($this->loaded) {
+            return;
+        }
+        if (is_null($app)) {
+            $this->loaded = true;
+            $routingFiles = $this->getRoutingFiles();
+        } else {
+            if (isset($this->loadedApps[$app])) {
+                return;
+            }
+            $file = \OC_App::getAppPath($app) . '/appinfo/routes.php';
+            if ($file !== false && file_exists($file)) {
+                $routingFiles = [$app => $file];
+            } else {
+                $routingFiles = [];
+            }
+        }
+        \OC::$server->getEventLogger()->start('loadroutes' . $requestedApp, 'Loading Routes');
+        foreach ($routingFiles as $app => $file) {
+            if (!isset($this->loadedApps[$app])) {
+                if (!\OC_App::isAppLoaded($app)) {
+                    // app MUST be loaded before app routes
+                    // try again next time loadRoutes() is called
+                    $this->loaded = false;
+                    continue;
+                }
+                $this->loadedApps[$app] = true;
+                $this->useCollection($app);
+                $this->requireRouteFile($file, $app);
+                $collection = $this->getCollection($app);
+                $this->root->addCollection($collection);
 
-				// Also add the OCS collection
-				$collection = $this->getCollection($app.'.ocs');
-				$collection->addPrefix('/ocsapp');
-				$this->root->addCollection($collection);
-			}
-		}
-		if (!isset($this->loadedApps['core'])) {
-			$this->loadedApps['core'] = true;
-			$this->useCollection('root');
-			require_once __DIR__ . '/../../../core/routes.php';
+                // Also add the OCS collection
+                $collection = $this->getCollection($app.'.ocs');
+                $collection->addPrefix('/ocsapp');
+                $this->root->addCollection($collection);
+            }
+        }
+        if (!isset($this->loadedApps['core'])) {
+            $this->loadedApps['core'] = true;
+            $this->useCollection('root');
+            require_once __DIR__ . '/../../../core/routes.php';
 
-			// Also add the OCS collection
-			$collection = $this->getCollection('root.ocs');
-			$collection->addPrefix('/ocsapp');
-			$this->root->addCollection($collection);
-		}
-		if ($this->loaded) {
-			$collection = $this->getCollection('ocs');
-			$collection->addPrefix('/ocs');
-			$this->root->addCollection($collection);
-		}
-		\OC::$server->getEventLogger()->end('loadroutes' . $requestedApp);
-	}
+            // Also add the OCS collection
+            $collection = $this->getCollection('root.ocs');
+            $collection->addPrefix('/ocsapp');
+            $this->root->addCollection($collection);
+        }
+        if ($this->loaded) {
+            $collection = $this->getCollection('ocs');
+            $collection->addPrefix('/ocs');
+            $this->root->addCollection($collection);
+        }
+        \OC::$server->getEventLogger()->end('loadroutes' . $requestedApp);
+    }
 
-	/**
-	 * @return string
-	 * @deprecated
-	 */
-	public function getCacheKey() {
-		return '';
-	}
+    /**
+     * @return string
+     * @deprecated
+     */
+    public function getCacheKey() {
+        return '';
+    }
 
-	/**
-	 * @param string $name
-	 * @return \Symfony\Component\Routing\RouteCollection
-	 */
-	protected function getCollection($name) {
-		if (!isset($this->collections[$name])) {
-			$this->collections[$name] = new RouteCollection();
-		}
-		return $this->collections[$name];
-	}
+    /**
+     * @param string $name
+     * @return \Symfony\Component\Routing\RouteCollection
+     */
+    protected function getCollection($name) {
+        if (!isset($this->collections[$name])) {
+            $this->collections[$name] = new RouteCollection();
+        }
+        return $this->collections[$name];
+    }
 
-	/**
-	 * Sets the collection to use for adding routes
-	 *
-	 * @param string $name Name of the collection to use.
-	 * @return void
-	 */
-	public function useCollection($name) {
-		$this->collection = $this->getCollection($name);
-		$this->collectionName = $name;
-	}
+    /**
+     * Sets the collection to use for adding routes
+     *
+     * @param string $name Name of the collection to use.
+     * @return void
+     */
+    public function useCollection($name) {
+        $this->collection = $this->getCollection($name);
+        $this->collectionName = $name;
+    }
 
-	/**
-	 * returns the current collection name in use for adding routes
-	 *
-	 * @return string the collection name
-	 */
-	public function getCurrentCollection() {
-		return $this->collectionName;
-	}
+    /**
+     * returns the current collection name in use for adding routes
+     *
+     * @return string the collection name
+     */
+    public function getCurrentCollection() {
+        return $this->collectionName;
+    }
 
 
-	/**
-	 * Create a \OC\Route\Route.
-	 *
-	 * @param string $name Name of the route to create.
-	 * @param string $pattern The pattern to match
-	 * @param array $defaults An array of default parameter values
-	 * @param array $requirements An array of requirements for parameters (regexes)
-	 * @return \OC\Route\Route
-	 */
-	public function create($name,
-						   $pattern,
-						   array $defaults = [],
-						   array $requirements = []) {
-		$route = new Route($pattern, $defaults, $requirements);
-		$this->collection->add($name, $route);
-		return $route;
-	}
+    /**
+     * Create a \OC\Route\Route.
+     *
+     * @param string $name Name of the route to create.
+     * @param string $pattern The pattern to match
+     * @param array $defaults An array of default parameter values
+     * @param array $requirements An array of requirements for parameters (regexes)
+     * @return \OC\Route\Route
+     */
+    public function create($name,
+                            $pattern,
+                            array $defaults = [],
+                            array $requirements = []) {
+        $route = new Route($pattern, $defaults, $requirements);
+        $this->collection->add($name, $route);
+        return $route;
+    }
 
-	/**
-	 * Find the route matching $url
-	 *
-	 * @param string $url The url to find
-	 * @throws \Exception
-	 * @return void
-	 */
-	public function match($url) {
-		if (substr($url, 0, 6) === '/apps/') {
-			// empty string / 'apps' / $app / rest of the route
-			list(, , $app,) = explode('/', $url, 4);
+    /**
+     * Find the route matching $url
+     *
+     * @param string $url The url to find
+     * @throws \Exception
+     * @return void
+     */
+    public function match($url) {
+        if (substr($url, 0, 6) === '/apps/') {
+            // empty string / 'apps' / $app / rest of the route
+            list(, , $app,) = explode('/', $url, 4);
 
-			$app = \OC_App::cleanAppId($app);
-			\OC::$REQUESTEDAPP = $app;
-			$this->loadRoutes($app);
-		} elseif (substr($url, 0, 13) === '/ocsapp/apps/') {
-			// empty string / 'ocsapp' / 'apps' / $app / rest of the route
-			list(, , , $app,) = explode('/', $url, 5);
+            $app = \OC_App::cleanAppId($app);
+            \OC::$REQUESTEDAPP = $app;
+            $this->loadRoutes($app);
+        } elseif (substr($url, 0, 13) === '/ocsapp/apps/') {
+            // empty string / 'ocsapp' / 'apps' / $app / rest of the route
+            list(, , , $app,) = explode('/', $url, 5);
 
-			$app = \OC_App::cleanAppId($app);
-			\OC::$REQUESTEDAPP = $app;
-			$this->loadRoutes($app);
-		} elseif (substr($url, 0, 10) === '/settings/') {
-			$this->loadRoutes('settings');
-		} elseif (substr($url, 0, 6) === '/core/') {
-			\OC::$REQUESTEDAPP = $url;
-			if (!\OC::$server->getConfig()->getSystemValueBool('maintenance') && !Util::needUpgrade()) {
-				\OC_App::loadApps();
-			}
-			$this->loadRoutes('core');
-		} else {
-			$this->loadRoutes();
-		}
+            $app = \OC_App::cleanAppId($app);
+            \OC::$REQUESTEDAPP = $app;
+            $this->loadRoutes($app);
+        } elseif (substr($url, 0, 10) === '/settings/') {
+            $this->loadRoutes('settings');
+        } elseif (substr($url, 0, 6) === '/core/') {
+            \OC::$REQUESTEDAPP = $url;
+            if (!\OC::$server->getConfig()->getSystemValueBool('maintenance') && !Util::needUpgrade()) {
+                \OC_App::loadApps();
+            }
+            $this->loadRoutes('core');
+        } else {
+            $this->loadRoutes();
+        }
 
-		$matcher = new UrlMatcher($this->root, $this->context);
-		try {
-			$parameters = $matcher->match($url);
-		} catch (ResourceNotFoundException $e) {
-			if (substr($url, -1) !== '/') {
-				// We allow links to apps/files? for backwards compatibility reasons
-				// However, since Symfony does not allow empty route names, the route
-				// we need to match is '/', so we need to append the '/' here.
-				try {
-					$parameters = $matcher->match($url . '/');
-				} catch (ResourceNotFoundException $newException) {
-					// If we still didn't match a route, we throw the original exception
-					throw $e;
-				}
-			} else {
-				throw $e;
-			}
-		}
+        $matcher = new UrlMatcher($this->root, $this->context);
+        try {
+            $parameters = $matcher->match($url);
+        } catch (ResourceNotFoundException $e) {
+            if (substr($url, -1) !== '/') {
+                // We allow links to apps/files? for backwards compatibility reasons
+                // However, since Symfony does not allow empty route names, the route
+                // we need to match is '/', so we need to append the '/' here.
+                try {
+                    $parameters = $matcher->match($url . '/');
+                } catch (ResourceNotFoundException $newException) {
+                    // If we still didn't match a route, we throw the original exception
+                    throw $e;
+                }
+            } else {
+                throw $e;
+            }
+        }
 
-		\OC::$server->getEventLogger()->start('run_route', 'Run route');
-		if (isset($parameters['caller'])) {
-			$caller = $parameters['caller'];
-			unset($parameters['caller']);
-			$application = $this->getApplicationClass($caller[0]);
-			\OC\AppFramework\App::main($caller[1], $caller[2], $application->getContainer(), $parameters);
-		} elseif (isset($parameters['action'])) {
-			$action = $parameters['action'];
-			if (!is_callable($action)) {
-				throw new \Exception('not a callable action');
-			}
-			unset($parameters['action']);
-			call_user_func($action, $parameters);
-		} elseif (isset($parameters['file'])) {
-			include $parameters['file'];
-		} else {
-			throw new \Exception('no action available');
-		}
-		\OC::$server->getEventLogger()->end('run_route');
-	}
+        \OC::$server->getEventLogger()->start('run_route', 'Run route');
+        if (isset($parameters['caller'])) {
+            $caller = $parameters['caller'];
+            unset($parameters['caller']);
+            $application = $this->getApplicationClass($caller[0]);
+            \OC\AppFramework\App::main($caller[1], $caller[2], $application->getContainer(), $parameters);
+        } elseif (isset($parameters['action'])) {
+            $action = $parameters['action'];
+            if (!is_callable($action)) {
+                throw new \Exception('not a callable action');
+            }
+            unset($parameters['action']);
+            call_user_func($action, $parameters);
+        } elseif (isset($parameters['file'])) {
+            include $parameters['file'];
+        } else {
+            throw new \Exception('no action available');
+        }
+        \OC::$server->getEventLogger()->end('run_route');
+    }
 
-	/**
-	 * Get the url generator
-	 *
-	 * @return \Symfony\Component\Routing\Generator\UrlGenerator
-	 *
-	 */
-	public function getGenerator() {
-		if (null !== $this->generator) {
-			return $this->generator;
-		}
+    /**
+     * Get the url generator
+     *
+     * @return \Symfony\Component\Routing\Generator\UrlGenerator
+     *
+     */
+    public function getGenerator() {
+        if (null !== $this->generator) {
+            return $this->generator;
+        }
 
-		return $this->generator = new UrlGenerator($this->root, $this->context);
-	}
+        return $this->generator = new UrlGenerator($this->root, $this->context);
+    }
 
-	/**
-	 * Generate url based on $name and $parameters
-	 *
-	 * @param string $name Name of the route to use.
-	 * @param array $parameters Parameters for the route
-	 * @param bool $absolute
-	 * @return string
-	 */
-	public function generate($name,
-							 $parameters = [],
-							 $absolute = false) {
-		$this->loadRoutes();
-		try {
-			$referenceType = UrlGenerator::ABSOLUTE_URL;
-			if ($absolute === false) {
-				$referenceType = UrlGenerator::ABSOLUTE_PATH;
-			}
-			$name = $this->fixLegacyRootName($name);
-			return $this->getGenerator()->generate($name, $parameters, $referenceType);
-		} catch (RouteNotFoundException $e) {
-			$this->logger->logException($e);
-			return '';
-		}
-	}
+    /**
+     * Generate url based on $name and $parameters
+     *
+     * @param string $name Name of the route to use.
+     * @param array $parameters Parameters for the route
+     * @param bool $absolute
+     * @return string
+     */
+    public function generate($name,
+                                $parameters = [],
+                                $absolute = false) {
+        $this->loadRoutes();
+        try {
+            $referenceType = UrlGenerator::ABSOLUTE_URL;
+            if ($absolute === false) {
+                $referenceType = UrlGenerator::ABSOLUTE_PATH;
+            }
+            $name = $this->fixLegacyRootName($name);
+            return $this->getGenerator()->generate($name, $parameters, $referenceType);
+        } catch (RouteNotFoundException $e) {
+            $this->logger->logException($e);
+            return '';
+        }
+    }
 
-	protected function fixLegacyRootName(string $routeName): string {
-		if ($routeName === 'files.viewcontroller.showFile') {
-			return 'files.View.showFile';
-		}
-		if ($routeName === 'files_sharing.sharecontroller.showShare') {
-			return 'files_sharing.Share.showShare';
-		}
-		if ($routeName === 'files_sharing.sharecontroller.showAuthenticate') {
-			return 'files_sharing.Share.showAuthenticate';
-		}
-		if ($routeName === 'files_sharing.sharecontroller.authenticate') {
-			return 'files_sharing.Share.authenticate';
-		}
-		if ($routeName === 'files_sharing.sharecontroller.downloadShare') {
-			return 'files_sharing.Share.downloadShare';
-		}
-		if ($routeName === 'files_sharing.publicpreview.directLink') {
-			return 'files_sharing.PublicPreview.directLink';
-		}
-		if ($routeName === 'cloud_federation_api.requesthandlercontroller.addShare') {
-			return 'cloud_federation_api.RequestHandler.addShare';
-		}
-		if ($routeName === 'cloud_federation_api.requesthandlercontroller.receiveNotification') {
-			return 'cloud_federation_api.RequestHandler.receiveNotification';
-		}
-		return $routeName;
-	}
+    protected function fixLegacyRootName(string $routeName): string {
+        if ($routeName === 'files.viewcontroller.showFile') {
+            return 'files.View.showFile';
+        }
+        if ($routeName === 'files_sharing.sharecontroller.showShare') {
+            return 'files_sharing.Share.showShare';
+        }
+        if ($routeName === 'files_sharing.sharecontroller.showAuthenticate') {
+            return 'files_sharing.Share.showAuthenticate';
+        }
+        if ($routeName === 'files_sharing.sharecontroller.authenticate') {
+            return 'files_sharing.Share.authenticate';
+        }
+        if ($routeName === 'files_sharing.sharecontroller.downloadShare') {
+            return 'files_sharing.Share.downloadShare';
+        }
+        if ($routeName === 'files_sharing.publicpreview.directLink') {
+            return 'files_sharing.PublicPreview.directLink';
+        }
+        if ($routeName === 'cloud_federation_api.requesthandlercontroller.addShare') {
+            return 'cloud_federation_api.RequestHandler.addShare';
+        }
+        if ($routeName === 'cloud_federation_api.requesthandlercontroller.receiveNotification') {
+            return 'cloud_federation_api.RequestHandler.receiveNotification';
+        }
+        return $routeName;
+    }
 
-	/**
-	 * To isolate the variable scope used inside the $file it is required in it's own method
-	 *
-	 * @param string $file the route file location to include
-	 * @param string $appName
-	 */
-	private function requireRouteFile($file, $appName) {
-		$this->setupRoutes(include_once $file, $appName);
-	}
+    /**
+     * To isolate the variable scope used inside the $file it is required in it's own method
+     *
+     * @param string $file the route file location to include
+     * @param string $appName
+     */
+    private function requireRouteFile($file, $appName) {
+        $this->setupRoutes(include_once $file, $appName);
+    }
 
 
-	/**
-	 * If a routes.php file returns an array, try to set up the application and
-	 * register the routes for the app. The application class will be chosen by
-	 * camelcasing the appname, e.g.: my_app will be turned into
-	 * \OCA\MyApp\AppInfo\Application. If that class does not exist, a default
-	 * App will be intialized. This makes it optional to ship an
-	 * appinfo/application.php by using the built in query resolver
-	 *
-	 * @param array $routes the application routes
-	 * @param string $appName the name of the app.
-	 */
-	private function setupRoutes($routes, $appName) {
-		if (is_array($routes)) {
-			$application = $this->getApplicationClass($appName);
-			$application->registerRoutes($this, $routes);
-		}
-	}
+    /**
+     * If a routes.php file returns an array, try to set up the application and
+     * register the routes for the app. The application class will be chosen by
+     * camelcasing the appname, e.g.: my_app will be turned into
+     * \OCA\MyApp\AppInfo\Application. If that class does not exist, a default
+     * App will be intialized. This makes it optional to ship an
+     * appinfo/application.php by using the built in query resolver
+     *
+     * @param array $routes the application routes
+     * @param string $appName the name of the app.
+     */
+    private function setupRoutes($routes, $appName) {
+        if (is_array($routes)) {
+            $application = $this->getApplicationClass($appName);
+            $application->registerRoutes($this, $routes);
+        }
+    }
 
-	private function getApplicationClass(string $appName) {
-		$appNameSpace = App::buildAppNamespace($appName);
+    private function getApplicationClass(string $appName) {
+        $appNameSpace = App::buildAppNamespace($appName);
 
-		$applicationClassName = $appNameSpace . '\\AppInfo\\Application';
+        $applicationClassName = $appNameSpace . '\\AppInfo\\Application';
 
-		if (class_exists($applicationClassName)) {
-			$application = \OC::$server->query($applicationClassName);
-		} else {
-			$application = new App($appName);
-		}
+        if (class_exists($applicationClassName)) {
+            $application = \OC::$server->query($applicationClassName);
+        } else {
+            $application = new App($appName);
+        }
 
-		return $application;
-	}
+        return $application;
+    }
 }

Spacing +9 added lines, -9 removed lines

@@ -99,7 +99,7 @@ 
 			foreach (\OC_APP::getEnabledApps() as $app) {
 				$appPath = \OC_App::getAppPath($app);
 				if ($appPath !== false) {
-					$file = $appPath . '/appinfo/routes.php';
+					$file = $appPath.'/appinfo/routes.php';
 					if (file_exists($file)) {
 						$this->routingFiles[$app] = $file;
 					}
@@ -130,14 +130,14 @@ 
 			if (isset($this->loadedApps[$app])) {
 				return;
 			}
-			$file = \OC_App::getAppPath($app) . '/appinfo/routes.php';
+			$file = \OC_App::getAppPath($app).'/appinfo/routes.php';
 			if ($file !== false && file_exists($file)) {
 				$routingFiles = [$app => $file];
 			} else {
 				$routingFiles = [];
 			}
 		}
-		\OC::$server->getEventLogger()->start('loadroutes' . $requestedApp, 'Loading Routes');
+		\OC::$server->getEventLogger()->start('loadroutes'.$requestedApp, 'Loading Routes');
 		foreach ($routingFiles as $app => $file) {
 			if (!isset($this->loadedApps[$app])) {
 				if (!\OC_App::isAppLoaded($app)) {
@@ -161,7 +161,7 @@ 
 		if (!isset($this->loadedApps['core'])) {
 			$this->loadedApps['core'] = true;
 			$this->useCollection('root');
-			require_once __DIR__ . '/../../../core/routes.php';
+			require_once __DIR__.'/../../../core/routes.php';
 
 			// Also add the OCS collection
 			$collection = $this->getCollection('root.ocs');
@@ -173,7 +173,7 @@ 
 			$collection->addPrefix('/ocs');
 			$this->root->addCollection($collection);
 		}
-		\OC::$server->getEventLogger()->end('loadroutes' . $requestedApp);
+		\OC::$server->getEventLogger()->end('loadroutes'.$requestedApp);
 	}
 
 	/**
@@ -244,14 +244,14 @@ 
 	public function match($url) {
 		if (substr($url, 0, 6) === '/apps/') {
 			// empty string / 'apps' / $app / rest of the route
-			list(, , $app,) = explode('/', $url, 4);
+			list(,, $app,) = explode('/', $url, 4);
 
 			$app = \OC_App::cleanAppId($app);
 			\OC::$REQUESTEDAPP = $app;
 			$this->loadRoutes($app);
 		} elseif (substr($url, 0, 13) === '/ocsapp/apps/') {
 			// empty string / 'ocsapp' / 'apps' / $app / rest of the route
-			list(, , , $app,) = explode('/', $url, 5);
+			list(,,, $app,) = explode('/', $url, 5);
 
 			$app = \OC_App::cleanAppId($app);
 			\OC::$REQUESTEDAPP = $app;
@@ -277,7 +277,7 @@ 
 				// However, since Symfony does not allow empty route names, the route
 				// we need to match is '/', so we need to append the '/' here.
 				try {
-					$parameters = $matcher->match($url . '/');
+					$parameters = $matcher->match($url.'/');
 				} catch (ResourceNotFoundException $newException) {
 					// If we still didn't match a route, we throw the original exception
 					throw $e;
@@ -407,7 +407,7 @@ 
 	private function getApplicationClass(string $appName) {
 		$appNameSpace = App::buildAppNamespace($appName);
 
-		$applicationClassName = $appNameSpace . '\\AppInfo\\Application';
+		$applicationClassName = $appNameSpace.'\\AppInfo\\Application';
 
 		if (class_exists($applicationClassName)) {
 			$application = \OC::$server->query($applicationClassName);

lib/private/AppFramework/Routing/RouteConfig.php

Indentation +248 added lines, -248 removed lines

@@ -39,254 +39,254 @@
  * @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 = [];
-
-	protected $rootUrlApps = [
-		'cloud_federation_api',
-		'core',
-		'files_sharing',
-		'files',
-		'settings',
-		'spreed',
-	];
-
-	/**
-	 * @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->processIndexRoutes($this->routes);
-
-		// parse resources
-		$this->processIndexResources($this->routes);
-
-		/*
+    /** @var DIContainer */
+    private $container;
+
+    /** @var IRouter */
+    private $router;
+
+    /** @var array */
+    private $routes;
+
+    /** @var string */
+    private $appName;
+
+    /** @var string[] */
+    private $controllerNameCache = [];
+
+    protected $rootUrlApps = [
+        'cloud_federation_api',
+        'core',
+        'files_sharing',
+        'files',
+        'settings',
+        'spreed',
+    ];
+
+    /**
+     * @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->processIndexRoutes($this->routes);
+
+        // parse resources
+        $this->processIndexResources($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) {
-			$this->processRoute($ocsRoute, 'ocs.');
-		}
-	}
-
-	/**
-	 * Creates one route base on the give configuration
-	 * @param array $routes
-	 * @throws \UnexpectedValueException
-	 */
-	private function processIndexRoutes(array $routes): void {
-		$simpleRoutes = $routes['routes'] ?? [];
-		foreach ($simpleRoutes as $simpleRoute) {
-			$this->processRoute($simpleRoute);
-		}
-	}
-
-	protected function processRoute(array $route, string $routeNamePrefix = ''): void {
-		$name = $route['name'];
-		$postfix = $route['postfix'] ?? '';
-		$root = $this->buildRootPrefix($route, $routeNamePrefix);
-
-		$url = $root . '/' . ltrim($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;
-
-		$router = $this->router->create($routeName, $url)
-			->method($verb)
-			->setDefault('caller', [$this->appName, $controllerName, $actionName]);
-
-		// optionally register requirements for route. This is used to
-		// tell the route parser how url parameters should be matched
-		if (array_key_exists('requirements', $route)) {
-			$router->requirements($route['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', $route)) {
-			$router->defaults($route['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 {
-		$this->processResources($routes['ocs-resources'] ?? [], 'ocs.');
-	}
-
-	/**
-	 * For a given name and url restful routes are created:
-	 *  - index
-	 *  - show
-	 *  - create
-	 *  - update
-	 *  - destroy
-	 *
-	 * @param array $routes
-	 */
-	private function processIndexResources(array $routes): void {
-		$this->processResources($routes['resources'] ?? []);
-	}
-
-	/**
-	 * For a given name and url restful routes are created:
-	 *  - index
-	 *  - show
-	 *  - create
-	 *  - update
-	 *  - destroy
-	 *
-	 * @param array $resources
-	 * @param string $routeNamePrefix
-	 */
-	protected function processResources(array $resources, string $routeNamePrefix = ''): 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'],
-		];
-
-		foreach ($resources as $resource => $config) {
-			$root = $this->buildRootPrefix($config, $routeNamePrefix);
-
-			// the url parameter used as id to the resource
-			foreach ($actions as $action) {
-				$url = $root . '/' . ltrim($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 = $routeNamePrefix . $this->appName . '.' . strtolower($resource) . '.' . strtolower($method);
-
-				$this->router->create($routeName, $url)
-					->method($verb)
-					->setDefault('caller', [$this->appName, $controllerName, $actionName]);
-			}
-		}
-	}
-
-	private function buildRootPrefix(array $route, string $routeNamePrefix): string {
-		$defaultRoot = $this->appName === 'core' ? '' : '/apps/' . $this->appName;
-		$root = $route['root'] ?? $defaultRoot;
-
-		if ($routeNamePrefix !== '') {
-			// In OCS all apps are whitelisted
-			return $root;
-		}
-
-		if (!\in_array($this->appName, $this->rootUrlApps, true)) {
-			// Only allow root URLS for some apps
-			return  $defaultRoot;
-		}
-
-		return $root;
-	}
-
-	/**
-	 * 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);
-	}
+        $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) {
+            $this->processRoute($ocsRoute, 'ocs.');
+        }
+    }
+
+    /**
+     * Creates one route base on the give configuration
+     * @param array $routes
+     * @throws \UnexpectedValueException
+     */
+    private function processIndexRoutes(array $routes): void {
+        $simpleRoutes = $routes['routes'] ?? [];
+        foreach ($simpleRoutes as $simpleRoute) {
+            $this->processRoute($simpleRoute);
+        }
+    }
+
+    protected function processRoute(array $route, string $routeNamePrefix = ''): void {
+        $name = $route['name'];
+        $postfix = $route['postfix'] ?? '';
+        $root = $this->buildRootPrefix($route, $routeNamePrefix);
+
+        $url = $root . '/' . ltrim($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;
+
+        $router = $this->router->create($routeName, $url)
+            ->method($verb)
+            ->setDefault('caller', [$this->appName, $controllerName, $actionName]);
+
+        // optionally register requirements for route. This is used to
+        // tell the route parser how url parameters should be matched
+        if (array_key_exists('requirements', $route)) {
+            $router->requirements($route['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', $route)) {
+            $router->defaults($route['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 {
+        $this->processResources($routes['ocs-resources'] ?? [], 'ocs.');
+    }
+
+    /**
+     * For a given name and url restful routes are created:
+     *  - index
+     *  - show
+     *  - create
+     *  - update
+     *  - destroy
+     *
+     * @param array $routes
+     */
+    private function processIndexResources(array $routes): void {
+        $this->processResources($routes['resources'] ?? []);
+    }
+
+    /**
+     * For a given name and url restful routes are created:
+     *  - index
+     *  - show
+     *  - create
+     *  - update
+     *  - destroy
+     *
+     * @param array $resources
+     * @param string $routeNamePrefix
+     */
+    protected function processResources(array $resources, string $routeNamePrefix = ''): 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'],
+        ];
+
+        foreach ($resources as $resource => $config) {
+            $root = $this->buildRootPrefix($config, $routeNamePrefix);
+
+            // the url parameter used as id to the resource
+            foreach ($actions as $action) {
+                $url = $root . '/' . ltrim($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 = $routeNamePrefix . $this->appName . '.' . strtolower($resource) . '.' . strtolower($method);
+
+                $this->router->create($routeName, $url)
+                    ->method($verb)
+                    ->setDefault('caller', [$this->appName, $controllerName, $actionName]);
+            }
+        }
+    }
+
+    private function buildRootPrefix(array $route, string $routeNamePrefix): string {
+        $defaultRoot = $this->appName === 'core' ? '' : '/apps/' . $this->appName;
+        $root = $route['root'] ?? $defaultRoot;
+
+        if ($routeNamePrefix !== '') {
+            // In OCS all apps are whitelisted
+            return $root;
+        }
+
+        if (!\in_array($this->appName, $this->rootUrlApps, true)) {
+            // Only allow root URLS for some apps
+            return  $defaultRoot;
+        }
+
+        return $root;
+    }
+
+    /**
+     * 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);
+    }
 }

Spacing +9 added lines, -9 removed lines

@@ -91,7 +91,7 @@ 
 		 * OCS routes go into a different collection
 		 */
 		$oldCollection = $this->router->getCurrentCollection();
-		$this->router->useCollection($oldCollection . '.ocs');
+		$this->router->useCollection($oldCollection.'.ocs');
 
 		// parse ocs simple routes
 		$this->processOCS($this->routes);
@@ -126,7 +126,7 @@ 
 		$postfix = $route['postfix'] ?? '';
 		$root = $this->buildRootPrefix($route, $routeNamePrefix);
 
-		$url = $root . '/' . ltrim($route['url'], '/');
+		$url = $root.'/'.ltrim($route['url'], '/');
 		$verb = strtoupper($route['verb'] ?? 'GET');
 
 		$split = explode('#', $name, 2);
@@ -138,7 +138,7 @@ 
 		$controllerName = $this->buildControllerName($controller);
 		$actionName = $this->buildActionName($action);
 
-		$routeName = $routeNamePrefix . $this->appName . '.' . $controller . '.' . $action . $postfix;
+		$routeName = $routeNamePrefix.$this->appName.'.'.$controller.'.'.$action.$postfix;
 
 		$router = $this->router->create($routeName, $url)
 			->method($verb)
@@ -211,7 +211,7 @@ 
 
 			// the url parameter used as id to the resource
 			foreach ($actions as $action) {
-				$url = $root . '/' . ltrim($config['url'], '/');
+				$url = $root.'/'.ltrim($config['url'], '/');
 				$method = $action['name'];
 
 				$verb = strtoupper($action['verb'] ?? 'GET');
@@ -220,7 +220,7 @@ 
 					$url .= '/{id}';
 				}
 				if (isset($action['url-postfix'])) {
-					$url .= '/' . $action['url-postfix'];
+					$url .= '/'.$action['url-postfix'];
 				}
 
 				$controller = $resource;
@@ -228,7 +228,7 @@ 
 				$controllerName = $this->buildControllerName($controller);
 				$actionName = $this->buildActionName($method);
 
-				$routeName = $routeNamePrefix . $this->appName . '.' . strtolower($resource) . '.' . strtolower($method);
+				$routeName = $routeNamePrefix.$this->appName.'.'.strtolower($resource).'.'.strtolower($method);
 
 				$this->router->create($routeName, $url)
 					->method($verb)
@@ -238,7 +238,7 @@ 
 	}
 
 	private function buildRootPrefix(array $route, string $routeNamePrefix): string {
-		$defaultRoot = $this->appName === 'core' ? '' : '/apps/' . $this->appName;
+		$defaultRoot = $this->appName === 'core' ? '' : '/apps/'.$this->appName;
 		$root = $route['root'] ?? $defaultRoot;
 
 		if ($routeNamePrefix !== '') {
@@ -261,7 +261,7 @@ 
 	 */
 	private function buildControllerName(string $controller): string {
 		if (!isset($this->controllerNameCache[$controller])) {
-			$this->controllerNameCache[$controller] = $this->underScoreToCamelCase(ucfirst($controller)) . 'Controller';
+			$this->controllerNameCache[$controller] = $this->underScoreToCamelCase(ucfirst($controller)).'Controller';
 		}
 		return $this->controllerNameCache[$controller];
 	}
@@ -284,7 +284,7 @@ 
 		$pattern = '/_[a-z]?/';
 		return preg_replace_callback(
 			$pattern,
-			function ($matches) {
+			function($matches) {
 				return strtoupper(ltrim($matches[0], '_'));
 			},
 			$str);