Add IUrlGenerator::linkToDefaultPageUrl()

Replaces the deprecated \OC_Util::getDefaultPageUrl() and makes this API public.

Signed-off-by: Daniel Rudolf <github.com@daniel-rudolf.de>

4 files changed, 58 insertions, 40 deletions

diff --git a/lib/private/URLGenerator.php b/lib/private/URLGenerator.php
index 34bb65cd0e6..1d8cb041611 100644
--- a/lib/private/URLGenerator.php
+++ b/lib/private/URLGenerator.php
@@ -8,6 +8,7 @@ declare(strict_types=1);
  * @author Arthur Schiwon <blizzz@arthur-schiwon.de>
  * @author Bart Visscher <bartv@thisnet.nl>
  * @author Christoph Wurst <christoph@winzerhof-wurst.at>
+ * @author Daniel Rudolf <github.com@daniel-rudolf.de>
  * @author Felix Epp <work@felixepp.de>
  * @author Joas Schilling <coding@schilljs.com>
  * @author Jörn Friedrich Dreyer <jfd@butonic.de>
@@ -45,6 +46,7 @@ use OCP\ICacheFactory;
 use OCP\IConfig;
 use OCP\IRequest;
 use OCP\IURLGenerator;
+use OCP\IUserSession;
 use RuntimeException;
 
 /**
@@ -268,6 +270,51 @@ class URLGenerator implements IURLGenerator {
 	}
 
 	/**
+	 * Returns the URL of the default page based on the system configuration
+	 * and the apps visible for the current user
+	 * @return string
+	 */
+	public function linkToDefaultPageUrl(): string {
+		// Deny the redirect if the URL contains a @
+		// This prevents unvalidated redirects like ?redirect_url=:user@domain.com
+		if (isset($_REQUEST['redirect_url']) && strpos($_REQUEST['redirect_url'], '@') === false) {
+			return $this->getAbsoluteURL(urldecode($_REQUEST['redirect_url']));
+		}
+
+		$defaultPage = \OC::$server->getConfig()->getAppValue('core', 'defaultpage');
+		if ($defaultPage) {
+			return $this->getAbsoluteURL($defaultPage);
+		}
+
+		$appId = 'files';
+		$defaultApps = explode(',', $this->config->getSystemValue('defaultapp', 'dashboard,files'));
+
+		/** @var IUserSession $userSession */
+		$userSession = \OC::$server->get(IUserSession::class);
+		$userId = $userSession->isLoggedIn() ? $userSession->getUser()->getUID() : null;
+		if ($userId !== null) {
+			$userDefaultApps = explode(',', $this->config->getUserValue($userId, 'core', 'defaultapp'));
+			$defaultApps = array_filter(array_merge($userDefaultApps, $defaultApps));
+		}
+
+		// find the first app that is enabled for the current user
+		foreach ($defaultApps as $defaultApp) {
+			$defaultApp = \OC_App::cleanAppId(strip_tags($defaultApp));
+			if (\OC::$server->getAppManager()->isEnabledForUser($defaultApp)) {
+				$appId = $defaultApp;
+				break;
+			}
+		}
+
+		if ($this->config->getSystemValue('htaccess.IgnoreFrontController', false) === true
+			|| getenv('front_controller_active') === 'true') {
+			return $this->getAbsoluteURL('/apps/' . $appId . '/');
+		}
+
+		return $this->getAbsoluteURL('/index.php/apps/' . $appId . '/');
+	}
+
+	/**
 	 * @return string base url of the current request
 	 */
 	public function getBaseUrl(): string {
diff --git a/lib/private/legacy/OC_Util.php b/lib/private/legacy/OC_Util.php
index 87964f98374..1f5f04ff055 100644
--- a/lib/private/legacy/OC_Util.php
+++ b/lib/private/legacy/OC_Util.php
@@ -1089,46 +1089,8 @@ class OC_Util {
 	 * @suppress PhanDeprecatedFunction
 	 */
 	public static function getDefaultPageUrl() {
-		/** @var IConfig $config */
-		$config = \OC::$server->get(IConfig::class);
 		$urlGenerator = \OC::$server->getURLGenerator();
-		// Deny the redirect if the URL contains a @
-		// This prevents unvalidated redirects like ?redirect_url=:user@domain.com
-		if (isset($_REQUEST['redirect_url']) && strpos($_REQUEST['redirect_url'], '@') === false) {
-			$location = $urlGenerator->getAbsoluteURL(urldecode($_REQUEST['redirect_url']));
-		} else {
-			$defaultPage = \OC::$server->getConfig()->getAppValue('core', 'defaultpage');
-			if ($defaultPage) {
-				$location = $urlGenerator->getAbsoluteURL($defaultPage);
-			} else {
-				$appId = 'files';
-				$defaultApps = explode(',', $config->getSystemValue('defaultapp', 'dashboard,files'));
-
-				/** @var IUserSession $userSession */
-				$userSession = \OC::$server->get(IUserSession::class);
-				$user = $userSession->getUser();
-				if ($user) {
-					$userDefaultApps = explode(',', $config->getUserValue($user->getUID(), 'core', 'defaultapp'));
-					$defaultApps = array_filter(array_merge($userDefaultApps, $defaultApps));
-				}
-
-				// find the first app that is enabled for the current user
-				foreach ($defaultApps as $defaultApp) {
-					$defaultApp = OC_App::cleanAppId(strip_tags($defaultApp));
-					if (static::getAppManager()->isEnabledForUser($defaultApp)) {
-						$appId = $defaultApp;
-						break;
-					}
-				}
-
-				if ($config->getSystemValue('htaccess.IgnoreFrontController', false) === true || getenv('front_controller_active') === 'true') {
-					$location = $urlGenerator->getAbsoluteURL('/apps/' . $appId . '/');
-				} else {
-					$location = $urlGenerator->getAbsoluteURL('/index.php/apps/' . $appId . '/');
-				}
-			}
-		}
-		return $location;
+		return $urlGenerator->linkToDefaultPageUrl();
 	}
 
 	/**
diff --git a/lib/public/AppFramework/Http/RedirectToDefaultAppResponse.php b/lib/public/AppFramework/Http/RedirectToDefaultAppResponse.php
index 36e629d6342..32604e9e14c 100644
--- a/lib/public/AppFramework/Http/RedirectToDefaultAppResponse.php
+++ b/lib/public/AppFramework/Http/RedirectToDefaultAppResponse.php
@@ -38,6 +38,7 @@ class RedirectToDefaultAppResponse extends RedirectResponse {
 	 * @since 16.0.0
 	 */
 	public function __construct() {
-		parent::__construct(\OC_Util::getDefaultPageUrl());
+		$urlGenerator = \OC::$server->getURLGenerator();
+		parent::__construct($urlGenerator->linkToDefaultPageUrl());
 	}
 }
diff --git a/lib/public/IURLGenerator.php b/lib/public/IURLGenerator.php
index 486ca47d252..89ad4332c2d 100644
--- a/lib/public/IURLGenerator.php
+++ b/lib/public/IURLGenerator.php
@@ -98,6 +98,14 @@ interface IURLGenerator {
 	public function linkToDocs(string $key): string;
 
 	/**
+	 * Returns the URL of the default page based on the system configuration
+	 * and the apps visible for the current user
+	 * @return string
+	 * @since 23.0.0
+	 */
+	public function linkToDefaultPageUrl(): string;
+
+	/**
 	 * @return string base url of the current request
 	 * @since 13.0.0
 	 */