nextcloud / server

lib/private/AppFramework/Routing/RouteConfig.php

Indentation +259 added lines, -259 removed lines

@@ -40,265 +40,265 @@
  * @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',
-		'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->processSimpleRoutes($this->routes);
-
-		// parse resources
-		$this->processResources($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',
+        '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->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) {
-			$this->processRoute($ocsRoute, 'ocs.');
-		}
-	}
-
-	/**
-	 * 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) {
-			$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;
-		if ($routeNamePrefix === '' && !\in_array($this->appName, $this->rootUrlApps, true)) {
-			// 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
-		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 {
-		// 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);
-	}
+        $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 processSimpleRoutes(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'] ?? '';
+        $defaultRoot = $this->appName === 'core' ? '' : '/apps/' . $this->appName;
+        $root = $route['root'] ?? $defaultRoot;
+        if ($routeNamePrefix === '' && !\in_array($this->appName, $this->rootUrlApps, true)) {
+            // 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
+        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 {
+        // 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);
+    }
 }

Spacing +12 added lines, -12 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);
@@ -124,14 +124,14 @@ 
 	protected function processRoute(array $route, string $routeNamePrefix = ''): void {
 		$name = $route['name'];
 		$postfix = $route['postfix'] ?? '';
-		$defaultRoot = $this->appName === 'core' ? '' : '/apps/' . $this->appName;
+		$defaultRoot = $this->appName === 'core' ? '' : '/apps/'.$this->appName;
 		$root = $route['root'] ?? $defaultRoot;
 		if ($routeNamePrefix === '' && !\in_array($this->appName, $this->rootUrlApps, true)) {
 			// Only allow root URLS for some apps
 			$root = $defaultRoot;
 		}
 
-		$url = $root . $route['url'];
+		$url = $root.$route['url'];
 		$verb = strtoupper($route['verb'] ?? 'GET');
 
 		$split = explode('#', $name, 2);
@@ -143,7 +143,7 @@ 
 		$controllerName = $this->buildControllerName($controller);
 		$actionName = $this->buildActionName($action);
 
-		$routeName = $routeNamePrefix . $this->appName . '.' . $controller . '.' . $action . $postfix;
+		$routeName = $routeNamePrefix.$this->appName.'.'.$controller.'.'.$action.$postfix;
 
 		// register the route
 		$handler = new RouteActionHandler($this->container, $controllerName, $actionName);
@@ -187,11 +187,11 @@ 
 
 		$resources = $routes['ocs-resources'] ?? [];
 		foreach ($resources as $resource => $config) {
-			$root = $config['root'] ?? '/apps/' . $this->appName;
+			$root = $config['root'] ?? '/apps/'.$this->appName;
 
 			// the url parameter used as id to the resource
 			foreach ($actions as $action) {
-				$url = $root . $config['url'];
+				$url = $root.$config['url'];
 				$method = $action['name'];
 				$verb = strtoupper($action['verb'] ?? 'GET');
 				$collectionAction = $action['on-collection'] ?? false;
@@ -199,7 +199,7 @@ 
 					$url .= '/{id}';
 				}
 				if (isset($action['url-postfix'])) {
-					$url .= '/' . $action['url-postfix'];
+					$url .= '/'.$action['url-postfix'];
 				}
 
 				$controller = $resource;
@@ -207,7 +207,7 @@ 
 				$controllerName = $this->buildControllerName($controller);
 				$actionName = $this->buildActionName($method);
 
-				$routeName = 'ocs.' . $this->appName . '.' . strtolower($resource) . '.' . strtolower($method);
+				$routeName = 'ocs.'.$this->appName.'.'.strtolower($resource).'.'.strtolower($method);
 
 				$this->router->create($routeName, $url)->method($verb)->action(
 					new RouteActionHandler($this->container, $controllerName, $actionName)
@@ -249,7 +249,7 @@ 
 					$url .= '/{id}';
 				}
 				if (isset($action['url-postfix'])) {
-					$url .= '/' . $action['url-postfix'];
+					$url .= '/'.$action['url-postfix'];
 				}
 
 				$controller = $resource;
@@ -257,7 +257,7 @@ 
 				$controllerName = $this->buildControllerName($controller);
 				$actionName = $this->buildActionName($method);
 
-				$routeName = $this->appName . '.' . strtolower($resource) . '.' . strtolower($method);
+				$routeName = $this->appName.'.'.strtolower($resource).'.'.strtolower($method);
 
 				$this->router->create($routeName, $url)->method($verb)->action(
 					new RouteActionHandler($this->container, $controllerName, $actionName)
@@ -273,7 +273,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];
 	}
@@ -296,7 +296,7 @@ 
 		$pattern = '/_[a-z]?/';
 		return preg_replace_callback(
 			$pattern,
-			function ($matches) {
+			function($matches) {
 				return strtoupper(ltrim($matches[0], '_'));
 			},
 			$str);

lib/public/AppFramework/AuthPublicShareController.php

Indentation +163 added lines, -163 removed lines

@@ -45,167 +45,167 @@
  */
 abstract class AuthPublicShareController extends PublicShareController {
 
-	/** @var IURLGenerator */
-	protected $urlGenerator;
-
-	/**
-	 * @since 14.0.0
-	 */
-	public function __construct(string $appName,
-								IRequest $request,
-								ISession $session,
-								IURLGenerator $urlGenerator) {
-		parent::__construct($appName, $request, $session);
-
-		$this->urlGenerator = $urlGenerator;
-	}
-
-	/**
-	 * @PublicPage
-	 * @NoCSRFRequired
-	 *
-	 * Show the authentication page
-	 * The form has to submit to the authenticate method route
-	 *
-	 * @since 14.0.0
-	 */
-	public function showAuthenticate(): TemplateResponse {
-		return new TemplateResponse('core', 'publicshareauth', [], 'guest');
-	}
-
-	/**
-	 * The template to show when authentication failed
-	 *
-	 * @since 14.0.0
-	 */
-	protected function showAuthFailed(): TemplateResponse {
-		return new TemplateResponse('core', 'publicshareauth', ['wrongpw' => true], 'guest');
-	}
-
-	/**
-	 * Verify the password
-	 *
-	 * @since 14.0.0
-	 */
-	abstract protected function verifyPassword(string $password): bool;
-
-	/**
-	 * Function called after failed authentication
-	 *
-	 * You can use this to do some logging for example
-	 *
-	 * @since 14.0.0
-	 */
-	protected function authFailed() {
-	}
-
-	/**
-	 * Function called after successfull authentication
-	 *
-	 * You can use this to do some logging for example
-	 *
-	 * @since 14.0.0
-	 */
-	protected function authSucceeded() {
-	}
-
-	/**
-	 * @UseSession
-	 * @PublicPage
-	 * @BruteForceProtection(action=publicLinkAuth)
-	 *
-	 * Authenticate the share
-	 *
-	 * @since 14.0.0
-	 */
-	final public function authenticate(string $password = '') {
-		// Already authenticated
-		if ($this->isAuthenticated()) {
-			return $this->getRedirect();
-		}
-
-		if (!$this->verifyPassword($password)) {
-			$this->authFailed();
-			$response = $this->showAuthFailed();
-			$response->throttle();
-			return $response;
-		}
-
-		$this->session->regenerateId(true, true);
-		$response = $this->getRedirect();
-
-		$this->session->set('public_link_authenticated_token', $this->getToken());
-		$this->session->set('public_link_authenticated_password_hash', $this->getPasswordHash());
-
-		$this->authSucceeded();
-
-		return $response;
-	}
-
-	/**
-	 * Default landing page
-	 *
-	 * @since 14.0.0
-	 */
-	abstract public function showShare(): TemplateResponse;
-
-	/**
-	 * @since 14.0.0
-	 */
-	final public function getAuthenticationRedirect(string $redirect): RedirectResponse {
-		return new RedirectResponse(
-			$this->urlGenerator->linkToRoute($this->getRoute('showAuthenticate'), ['token' => $this->getToken(), 'redirect' => $redirect])
-		);
-	}
-
-
-	/**
-	 * @since 14.0.0
-	 */
-	private function getRoute(string $function): string {
-		$app = strtolower($this->appName);
-		$class = (new \ReflectionClass($this))->getShortName();
-		if (substr($class, -10) === 'Controller') {
-			$class = substr($class, 0, -10);
-		}
-		return $app .'.'. $class .'.'. $function;
-	}
-
-	/**
-	 * @since 14.0.0
-	 */
-	private function getRedirect(): RedirectResponse {
-		//Get all the stored redirect parameters:
-		$params = $this->session->get('public_link_authenticate_redirect');
-
-		$route = $this->getRoute('showShare');
-
-		if ($params === null) {
-			$params = [
-				'token' => $this->getToken(),
-			];
-		} else {
-			$params = json_decode($params, true);
-			if (isset($params['_route'])) {
-				$route = $params['_route'];
-				unset($params['_route']);
-			}
-
-			// If the token doesn't match the rest of the arguments can't be trusted either
-			if (isset($params['token']) && $params['token'] !== $this->getToken()) {
-				$params = [
-					'token' => $this->getToken(),
-				];
-			}
-
-			// We need a token
-			if (!isset($params['token'])) {
-				$params = [
-					'token' => $this->getToken(),
-				];
-			}
-		}
-
-		return new RedirectResponse($this->urlGenerator->linkToRoute($route, $params));
-	}
+    /** @var IURLGenerator */
+    protected $urlGenerator;
+
+    /**
+     * @since 14.0.0
+     */
+    public function __construct(string $appName,
+                                IRequest $request,
+                                ISession $session,
+                                IURLGenerator $urlGenerator) {
+        parent::__construct($appName, $request, $session);
+
+        $this->urlGenerator = $urlGenerator;
+    }
+
+    /**
+     * @PublicPage
+     * @NoCSRFRequired
+     *
+     * Show the authentication page
+     * The form has to submit to the authenticate method route
+     *
+     * @since 14.0.0
+     */
+    public function showAuthenticate(): TemplateResponse {
+        return new TemplateResponse('core', 'publicshareauth', [], 'guest');
+    }
+
+    /**
+     * The template to show when authentication failed
+     *
+     * @since 14.0.0
+     */
+    protected function showAuthFailed(): TemplateResponse {
+        return new TemplateResponse('core', 'publicshareauth', ['wrongpw' => true], 'guest');
+    }
+
+    /**
+     * Verify the password
+     *
+     * @since 14.0.0
+     */
+    abstract protected function verifyPassword(string $password): bool;
+
+    /**
+     * Function called after failed authentication
+     *
+     * You can use this to do some logging for example
+     *
+     * @since 14.0.0
+     */
+    protected function authFailed() {
+    }
+
+    /**
+     * Function called after successfull authentication
+     *
+     * You can use this to do some logging for example
+     *
+     * @since 14.0.0
+     */
+    protected function authSucceeded() {
+    }
+
+    /**
+     * @UseSession
+     * @PublicPage
+     * @BruteForceProtection(action=publicLinkAuth)
+     *
+     * Authenticate the share
+     *
+     * @since 14.0.0
+     */
+    final public function authenticate(string $password = '') {
+        // Already authenticated
+        if ($this->isAuthenticated()) {
+            return $this->getRedirect();
+        }
+
+        if (!$this->verifyPassword($password)) {
+            $this->authFailed();
+            $response = $this->showAuthFailed();
+            $response->throttle();
+            return $response;
+        }
+
+        $this->session->regenerateId(true, true);
+        $response = $this->getRedirect();
+
+        $this->session->set('public_link_authenticated_token', $this->getToken());
+        $this->session->set('public_link_authenticated_password_hash', $this->getPasswordHash());
+
+        $this->authSucceeded();
+
+        return $response;
+    }
+
+    /**
+     * Default landing page
+     *
+     * @since 14.0.0
+     */
+    abstract public function showShare(): TemplateResponse;
+
+    /**
+     * @since 14.0.0
+     */
+    final public function getAuthenticationRedirect(string $redirect): RedirectResponse {
+        return new RedirectResponse(
+            $this->urlGenerator->linkToRoute($this->getRoute('showAuthenticate'), ['token' => $this->getToken(), 'redirect' => $redirect])
+        );
+    }
+
+
+    /**
+     * @since 14.0.0
+     */
+    private function getRoute(string $function): string {
+        $app = strtolower($this->appName);
+        $class = (new \ReflectionClass($this))->getShortName();
+        if (substr($class, -10) === 'Controller') {
+            $class = substr($class, 0, -10);
+        }
+        return $app .'.'. $class .'.'. $function;
+    }
+
+    /**
+     * @since 14.0.0
+     */
+    private function getRedirect(): RedirectResponse {
+        //Get all the stored redirect parameters:
+        $params = $this->session->get('public_link_authenticate_redirect');
+
+        $route = $this->getRoute('showShare');
+
+        if ($params === null) {
+            $params = [
+                'token' => $this->getToken(),
+            ];
+        } else {
+            $params = json_decode($params, true);
+            if (isset($params['_route'])) {
+                $route = $params['_route'];
+                unset($params['_route']);
+            }
+
+            // If the token doesn't match the rest of the arguments can't be trusted either
+            if (isset($params['token']) && $params['token'] !== $this->getToken()) {
+                $params = [
+                    'token' => $this->getToken(),
+                ];
+            }
+
+            // We need a token
+            if (!isset($params['token'])) {
+                $params = [
+                    'token' => $this->getToken(),
+                ];
+            }
+        }
+
+        return new RedirectResponse($this->urlGenerator->linkToRoute($route, $params));
+    }
 }

Spacing +1 added lines, -1 removed lines

@@ -168,7 +168,7 @@
 		if (substr($class, -10) === 'Controller') {
 			$class = substr($class, 0, -10);
 		}
-		return $app .'.'. $class .'.'. $function;
+		return $app.'.'.$class.'.'.$function;
 	}
 
 	/**