123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463 |
- <?php
- namespace OC\Route;
- use OC\AppFramework\Routing\RouteParser;
- use OCP\AppFramework\App;
- use OCP\Diagnostics\IEventLogger;
- use OCP\IConfig;
- use OCP\IRequest;
- use OCP\Route\IRouter;
- use OCP\Util;
- use Psr\Container\ContainerInterface;
- use Psr\Log\LoggerInterface;
- use Symfony\Component\Routing\Exception\ResourceNotFoundException;
- use Symfony\Component\Routing\Exception\RouteNotFoundException;
- use Symfony\Component\Routing\Generator\UrlGenerator;
- use Symfony\Component\Routing\Matcher\UrlMatcher;
- use Symfony\Component\Routing\RequestContext;
- use Symfony\Component\Routing\RouteCollection;
- class Router implements IRouter {
-
- protected $collections = [];
-
- protected $collection = null;
-
- protected $collectionName = null;
-
- protected $root = null;
-
- protected $generator = null;
-
- protected $routingFiles;
-
- protected $loaded = false;
-
- protected $loadedApps = [];
- protected LoggerInterface $logger;
-
- protected $context;
- private IEventLogger $eventLogger;
- private IConfig $config;
- private ContainerInterface $container;
- public function __construct(
- LoggerInterface $logger,
- IRequest $request,
- IConfig $config,
- IEventLogger $eventLogger,
- ContainerInterface $container
- ) {
- $this->logger = $logger;
- $this->config = $config;
- $baseUrl = \OC::$WEBROOT;
- if (!($config->getSystemValue('htaccess.IgnoreFrontController', false) === true || getenv('front_controller_active') === 'true')) {
- $baseUrl .= '/index.php';
- }
- if (!\OC::$CLI && isset($_SERVER['REQUEST_METHOD'])) {
- $method = $_SERVER['REQUEST_METHOD'];
- } else {
- $method = 'GET';
- }
- $host = $request->getServerHost();
- $schema = $request->getServerProtocol();
- $this->context = new RequestContext($baseUrl, $method, $host, $schema);
-
- $this->root = $this->getCollection('root');
- $this->eventLogger = $eventLogger;
- $this->container = $container;
- }
-
- public function getRoutingFiles() {
- if ($this->routingFiles === null) {
- $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;
- }
-
- 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;
- }
- $appPath = \OC_App::getAppPath($app);
- $file = $appPath . '/appinfo/routes.php';
- if ($appPath !== false && file_exists($file)) {
- $routingFiles = [$app => $file];
- } else {
- $routingFiles = [];
- }
- }
- $this->eventLogger->start('route:load:' . $requestedApp, 'Loading Routes for ' . $requestedApp);
- foreach ($routingFiles as $app => $file) {
- if (!isset($this->loadedApps[$app])) {
- if (!\OC_App::isAppLoaded($app)) {
-
-
- $this->loaded = false;
- continue;
- }
- $this->loadedApps[$app] = true;
- $this->useCollection($app);
- $this->requireRouteFile($file, $app);
- $collection = $this->getCollection($app);
- $this->root->addCollection($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';
-
- $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);
- }
- $this->eventLogger->end('route:load:' . $requestedApp);
- }
-
- protected function getCollection($name) {
- if (!isset($this->collections[$name])) {
- $this->collections[$name] = new RouteCollection();
- }
- return $this->collections[$name];
- }
-
- public function useCollection($name) {
- $this->collection = $this->getCollection($name);
- $this->collectionName = $name;
- }
-
- public function getCurrentCollection() {
- return $this->collectionName;
- }
-
- public function create($name,
- $pattern,
- array $defaults = [],
- array $requirements = []) {
- $route = new Route($pattern, $defaults, $requirements);
- $this->collection->add($name, $route);
- return $route;
- }
-
- public function findMatchingRoute(string $url): array {
- $this->eventLogger->start('route:match', 'Match route');
- if (str_starts_with($url, '/apps/')) {
-
- [, , $app,] = explode('/', $url, 4);
- $app = \OC_App::cleanAppId($app);
- \OC::$REQUESTEDAPP = $app;
- $this->loadRoutes($app);
- } elseif (str_starts_with($url, '/ocsapp/apps/')) {
-
- [, , , $app,] = explode('/', $url, 5);
- $app = \OC_App::cleanAppId($app);
- \OC::$REQUESTEDAPP = $app;
- $this->loadRoutes($app);
- } elseif (str_starts_with($url, '/settings/')) {
- $this->loadRoutes('settings');
- } elseif (str_starts_with($url, '/core/')) {
- \OC::$REQUESTEDAPP = $url;
- if (!$this->config->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 (!str_ends_with($url, '/')) {
-
-
-
- try {
- $parameters = $matcher->match($url . '/');
- } catch (ResourceNotFoundException $newException) {
-
- throw $e;
- }
- } else {
- throw $e;
- }
- }
- $this->eventLogger->end('route:match');
- return $parameters;
- }
-
- public function match($url) {
- $parameters = $this->findMatchingRoute($url);
- $this->eventLogger->start('route:run', 'Run route');
- if (isset($parameters['caller'])) {
- $caller = $parameters['caller'];
- unset($parameters['caller']);
- unset($parameters['action']);
- $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']);
- unset($parameters['caller']);
- $this->eventLogger->start('route:run:call', 'Run callable route');
- call_user_func($action, $parameters);
- $this->eventLogger->end('route:run:call');
- } elseif (isset($parameters['file'])) {
- include $parameters['file'];
- } else {
- throw new \Exception('no action available');
- }
- $this->eventLogger->end('route:run');
- }
-
- public function getGenerator() {
- if (null !== $this->generator) {
- return $this->generator;
- }
- return $this->generator = new UrlGenerator($this->root, $this->context);
- }
-
- public function generate($name,
- $parameters = [],
- $absolute = false) {
- $referenceType = UrlGenerator::ABSOLUTE_URL;
- if ($absolute === false) {
- $referenceType = UrlGenerator::ABSOLUTE_PATH;
- }
- $name = $this->fixLegacyRootName($name);
- if (str_contains($name, '.')) {
- [$appName, $other] = explode('.', $name, 3);
-
- if ($appName === 'ocs') {
- $appName = $other;
- }
- $this->loadRoutes($appName);
- try {
- return $this->getGenerator()->generate($name, $parameters, $referenceType);
- } catch (RouteNotFoundException $e) {
- }
- }
-
- $this->loadRoutes();
- try {
- return $this->getGenerator()->generate($name, $parameters, $referenceType);
- } catch (RouteNotFoundException $e) {
- $this->logger->info($e->getMessage(), ['exception' => $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;
- }
-
- private function requireRouteFile($file, $appName) {
- $this->setupRoutes(include_once $file, $appName);
- }
-
- private function setupRoutes($routes, $appName) {
- if (is_array($routes)) {
- $routeParser = new RouteParser();
- $defaultRoutes = $routeParser->parseDefaultRoutes($routes, $appName);
- $ocsRoutes = $routeParser->parseOCSRoutes($routes, $appName);
- $this->root->addCollection($defaultRoutes);
- $ocsRoutes->addPrefix('/ocsapp');
- $this->root->addCollection($ocsRoutes);
- }
- }
- private function getApplicationClass(string $appName) {
- $appNameSpace = App::buildAppNamespace($appName);
- $applicationClassName = $appNameSpace . '\\AppInfo\\Application';
- if (class_exists($applicationClassName)) {
- $application = $this->container->get($applicationClassName);
- } else {
- $application = new App($appName);
- }
- return $application;
- }
- }
|