@ -1,5 +1,7 @@
<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
* SPDX-FileCopyrightText: 2016 ownCloud, Inc.
@ -25,36 +27,31 @@ use OCP\IRequest;
use OCP\IURLGenerator;
use OCP\IUserSession;
use OCP\L10N\IFactory;
use OCP\Server;
use OCP\ServerVersion;
use OCP\Support\Subscription\IRegistry;
use OCP\Template\ITemplate;
use OCP\Template\ITemplateManager;
use OCP\Util;
class TemplateLayout extends \OC_Template {
private static $versionHash = '';
class TemplateLayout {
private static string $versionHash = '';
/** @var string[] */
private static $cacheBusterCache = [];
/** @var CSSResourceLocator|null */
public static $cssLocator = null;
/** @var JSResourceLocator|null */
public static $jsLocator = null;
private IConfig $config;
private IAppManager $appManager;
private InitialStateService $initialState;
private INavigationManager $navigationManager;
/**
* @param string $renderAs
* @param string $appId application id
*/
public function __construct($renderAs, $appId = '') {
$this->config = \OCP\Server::get(IConfig::class);
$this->appManager = \OCP\Server::get(IAppManager::class);
$this->initialState = \OCP\Server::get(InitialStateService::class);
$this->navigationManager = \OCP\Server::get(INavigationManager::class);
private static array $cacheBusterCache = [];
public static ?CSSResourceLocator $cssLocator = null;
public static ?JSResourceLocator $jsLocator = null;
public function __construct(
private IConfig $config,
private IAppManager $appManager,
private InitialStateService $initialState,
private INavigationManager $navigationManager,
private ITemplateManager $templateManager,
) {
}
public function getPageTemplate(string $renderAs, string $appId): ITemplate {
// Add fallback theming variables if not rendered as user
if ($renderAs !== TemplateResponse::RENDER_AS_USER) {
// TODO cache generated default theme if enabled for fallback if server is erroring ?
@ -62,146 +59,148 @@ class TemplateLayout extends \OC_Template {
}
// Decide which page we show
if ($renderAs === TemplateResponse::RENDER_AS_USER) {
parent::__construct('core', 'layout.user');
if (in_array(\OC_App::getCurrentApp(), ['settings','admin', 'help']) !== false) {
$this->assign('bodyid', 'body-settings');
} else {
$this->assign('bodyid', 'body-user');
}
$this->initialState->provideInitialState('core', 'active-app', $this->navigationManager->getActiveEntry());
$this->initialState->provideInitialState('core', 'apps', array_values($this->navigationManager->getAll()));
if ($this->config->getSystemValueBool('unified_search.enabled', false) || !$this->config->getSystemValueBool('enable_non-accessible_features', true)) {
$this->initialState->provideInitialState('unified-search', 'limit-default', (int)$this->config->getAppValue('core', 'unified-search.limit-default', (string)SearchQuery::LIMIT_DEFAULT));
$this->initialState->provideInitialState('unified-search', 'min-search-length', (int)$this->config->getAppValue('core', 'unified-search.min-search-length', (string)1));
$this->initialState->provideInitialState('unified-search', 'live-search', $this->config->getAppValue('core', 'unified-search.live-search', 'yes') === 'yes');
Util::addScript('core', 'legacy-unified-search', 'core');
} else {
Util::addScript('core', 'unified-search', 'core');
}
// Set body data-theme
$this->assign('enabledThemes', []);
if ($this->appManager->isEnabledForUser('theming') & & class_exists('\OCA\Theming\Service\ThemesService')) {
/** @var \OCA\Theming\Service\ThemesService */
$themesService = \OC::$server->get(\OCA\Theming\Service\ThemesService::class);
$this->assign('enabledThemes', $themesService->getEnabledThemes());
}
// Set logo link target
$logoUrl = $this->config->getSystemValueString('logo_url', '');
$this->assign('logoUrl', $logoUrl);
// Set default entry name
$defaultEntryId = $this->navigationManager->getDefaultEntryIdForUser();
$defaultEntry = $this->navigationManager->get($defaultEntryId);
$this->assign('defaultAppName', $defaultEntry['name']);
switch ($renderAs) {
case TemplateResponse::RENDER_AS_USER:
$page = $this->templateManager->getTemplate('core', 'layout.user');
if (in_array(\OC_App::getCurrentApp(), ['settings','admin', 'help']) !== false) {
$page->assign('bodyid', 'body-settings');
} else {
$page->assign('bodyid', 'body-user');
}
// Add navigation entry
$this->assign('application', '');
$this->assign('appid', $appId);
$this->initialState->provideInitialState('core', 'active-app', $this->navigationManager->getActiveEntry());
$this->initialState->provideInitialState('core', 'apps', array_values($this->navigationManager->getAll()));
$navigation = $this->navigationManager->getAll();
$this->assign('navigation', $navigation);
$settingsNavigation = $this->navigationManager->getAll('settings');
$this->initialState->provideInitialState('core', 'settingsNavEntries', $settingsNavigation);
if ($this->config->getSystemValueBool('unified_search.enabled', false) || !$this->config->getSystemValueBool('enable_non-accessible_features', true)) {
$this->initialState->provideInitialState('unified-search', 'limit-default', (int)$this->config->getAppValue('core', 'unified-search.limit-default', (string)SearchQuery::LIMIT_DEFAULT));
$this->initialState->provideInitialState('unified-search', 'min-search-length', (int)$this->config->getAppValue('core', 'unified-search.min-search-length', (string)1));
$this->initialState->provideInitialState('unified-search', 'live-search', $this->config->getAppValue('core', 'unified-search.live-search', 'yes') === 'yes');
Util::addScript('core', 'legacy-unified-search', 'core');
} else {
Util::addScript('core', 'unified-search', 'core');
}
// Set body data-theme
$page->assign('enabledThemes', []);
if ($this->appManager->isEnabledForUser('theming') & & class_exists('\OCA\Theming\Service\ThemesService')) {
$themesService = Server::get(\OCA\Theming\Service\ThemesService::class);
$page->assign('enabledThemes', $themesService->getEnabledThemes());
}
foreach ($navigation as $entry) {
if ($entry['active']) {
$this->assign('application', $entry['name']);
break;
// Set logo link target
$logoUrl = $this->config->getSystemValueString('logo_url', '');
$page->assign('logoUrl', $logoUrl);
// Set default entry name
$defaultEntryId = $this->navigationManager->getDefaultEntryIdForUser();
$defaultEntry = $this->navigationManager->get($defaultEntryId);
$page->assign('defaultAppName', $defaultEntry['name'] ?? '');
// Add navigation entry
$page->assign('application', '');
$page->assign('appid', $appId);
$navigation = $this->navigationManager->getAll();
$page->assign('navigation', $navigation);
$settingsNavigation = $this->navigationManager->getAll('settings');
$this->initialState->provideInitialState('core', 'settingsNavEntries', $settingsNavigation);
foreach ($navigation as $entry) {
if ($entry['active']) {
$page->assign('application', $entry['name']);
break;
}
}
}
foreach ($settingsNavigation as $entry) {
if ($entry['active']) {
$this->assign('application', $entry['name']);
break;
foreach ($settingsNavigation as $entry) {
if ($entry['active']) {
$page->assign('application', $entry['name']);
break;
}
}
}
$userDisplayName = false;
$user = \OC::$server->get(IUserSession::class)->getUser();
if ($user) {
$userDisplayName = $user->getDisplayName();
}
$this->assign('user_displayname', $userDisplayName);
$this->assign('user_uid', \OC_User::getUser());
$user = Server::get(IUserSession::class)->getUser();
if ($user === null) {
$this->assign('userAvatarSet', false);
$this->assign('userStatus', false);
} else {
$this->assign('userAvatarSet', true);
$this->assign('userAvatarVersion', $this->config->getUserValue(\OC_User::getUser(), 'avatar', 'version', 0));
}
} elseif ($renderAs === TemplateResponse::RENDER_AS_ERROR) {
parent::__construct('core', 'layout.guest', '', false);
$this->assign('bodyid', 'body-login');
$this->assign('user_displayname', '');
$this->assign('user_uid', '');
} elseif ($renderAs === TemplateResponse::RENDER_AS_GUEST) {
parent::__construct('core', 'layout.guest');
\OC_Util::addStyle('guest');
$this->assign('bodyid', 'body-login');
$userDisplayName = false;
$user = \OC::$server->get(IUserSession::class)->getUser();
if ($user) {
$userDisplayName = $user->getDisplayName();
}
$this->assign('user_displayname', $userDisplayName);
$this->assign('user_uid', \OC_User::getUser());
} elseif ($renderAs === TemplateResponse::RENDER_AS_PUBLIC) {
parent::__construct('core', 'layout.public');
$this->assign('appid', $appId);
$this->assign('bodyid', 'body-public');
// Set body data-theme
$this->assign('enabledThemes', []);
if ($this->appManager->isEnabledForUser('theming') & & class_exists('\OCA\Theming\Service\ThemesService')) {
/** @var \OCA\Theming\Service\ThemesService $themesService */
$themesService = \OC::$server->get(\OCA\Theming\Service\ThemesService::class);
$this->assign('enabledThemes', $themesService->getEnabledThemes());
}
if ($user === null) {
$page->assign('user_uid', false);
$page->assign('user_displayname', false);
$page->assign('userAvatarSet', false);
$page->assign('userStatus', false);
} else {
$page->assign('user_uid', $user->getUID());
$page->assign('user_displayname', $user->getDisplayName());
$page->assign('userAvatarSet', true);
$page->assign('userAvatarVersion', $this->config->getUserValue($user->getUID(), 'avatar', 'version', 0));
}
break;
case TemplateResponse::RENDER_AS_ERROR:
$page = $this->templateManager->getTemplate('core', 'layout.guest', '', false);
$page->assign('bodyid', 'body-login');
$page->assign('user_displayname', '');
$page->assign('user_uid', '');
break;
case TemplateResponse::RENDER_AS_GUEST:
$page = $this->templateManager->getTemplate('core', 'layout.guest');
Util::addStyle('guest');
$page->assign('bodyid', 'body-login');
$userDisplayName = false;
$user = Server::get(IUserSession::class)->getUser();
if ($user) {
$userDisplayName = $user->getDisplayName();
}
$page->assign('user_displayname', $userDisplayName);
$page->assign('user_uid', \OC_User::getUser());
break;
case TemplateResponse::RENDER_AS_PUBLIC:
$page = $this->templateManager->getTemplate('core', 'layout.public');
$page->assign('appid', $appId);
$page->assign('bodyid', 'body-public');
// Set body data-theme
$page->assign('enabledThemes', []);
if ($this->appManager->isEnabledForUser('theming') & & class_exists('\OCA\Theming\Service\ThemesService')) {
$themesService = Server::get(\OCA\Theming\Service\ThemesService::class);
$page->assign('enabledThemes', $themesService->getEnabledThemes());
}
// Set logo link target
$logoUrl = $this->config->getSystemValueString('logo_url', '');
$this->assign('logoUrl', $logoUrl);
// Set logo link target
$logoUrl = $this->config->getSystemValueString('logo_url', '');
$page ->assign('logoUrl', $logoUrl);
/** @var IRegistry $subscription */
$subscription = \OCP\Server::get(IRegistry::class);
$showSimpleSignup = $this->config->getSystemValueBool('simpleSignUpLink.shown', true);
if ($showSimpleSignup & & $subscription->delegateHasValidSubscription()) {
$showSimpleSignup = false;
}
$subscription = Server::get(IRegistry::class);
$showSimpleSignup = $this->config->getSystemValueBool('simpleSignUpLink.shown', true);
if ($showSimpleSignup & & $subscription->delegateHasValidSubscription()) {
$showSimpleSignup = false;
}
$defaultSignUpLink = 'https://nextcloud.com/signup/';
$signUpLink = $this->config->getSystemValueString('registration_link', $defaultSignUpLink);
if ($signUpLink !== $defaultSignUpLink) {
$showSimpleSignup = true;
}
$defaultSignUpLink = 'https://nextcloud.com/signup/';
$signUpLink = $this->config->getSystemValueString('registration_link', $defaultSignUpLink);
if ($signUpLink !== $defaultSignUpLink) {
$showSimpleSignup = true;
}
if ($this->appManager->isEnabledForUser('registration')) {
$urlGenerator = \OCP\ Server::get(IURLGenerator::class);
$signUpLink = $urlGenerator->getAbsoluteURL('/index.php/apps/registration/');
}
if ($this->appManager->isEnabledForUser('registration')) {
$urlGenerator = Server::get(IURLGenerator::class);
$signUpLink = $urlGenerator->getAbsoluteURL('/index.php/apps/registration/');
}
$this->assign('showSimpleSignUpLink', $showSimpleSignup);
$this->assign('signUpLink', $signUpLink);
} else {
parent::__construct('core', 'layout.base');
$page->assign('showSimpleSignUpLink', $showSimpleSignup);
$page->assign('signUpLink', $signUpLink);
break;
default:
$page = $this->templateManager->getTemplate('core', 'layout.base');
break;
}
// Send the language, locale, and direction to our layouts
$lang = \OC::$server->get(IFactory::class)->findLanguage();
$locale = \OC::$server->get(IFactory::class)->findLocale($lang);
$direction = \OC::$server->getL10NFactory()->getLanguageDirection($lang);
$l10nFactory = Server::get(IFactory::class);
$lang = $l10nFactory->findLanguage();
$locale = $l10nFactory->findLocale($lang);
$direction = $l10nFactory->getLanguageDirection($lang);
$lang = str_replace('_', '-', $lang);
$this ->assign('language', $lang);
$this ->assign('locale', $locale);
$this ->assign('direction', $direction);
$page ->assign('language', $lang);
$page ->assign('locale', $locale);
$page ->assign('direction', $direction);
if ($this->config->getSystemValueBool('installed', false)) {
if (empty(self::$versionHash)) {
@ -216,7 +215,7 @@ class TemplateLayout extends \OC_Template {
// Add the js files
// TODO: remove deprecated OC_Util injection
$jsFiles = self::findJavascriptFiles(array_merge(\OC_Util::$scripts, Util::getScripts()));
$this ->assign('jsfiles', []);
$page ->assign('jsfiles', []);
if ($this->config->getSystemValueBool('installed', false) & & $renderAs != TemplateResponse::RENDER_AS_ERROR) {
// this is on purpose outside of the if statement below so that the initial state is prefilled (done in the getConfig() call)
// see https://github.com/nextcloud/server/pull/22636 for details
@ -238,26 +237,28 @@ class TemplateLayout extends \OC_Template {
);
$config = $jsConfigHelper->getConfig();
if (\OC::$server->getContentSecurityPolicyNonceManager()->browserSupportsCspV3()) {
$this ->assign('inline_ocjs', $config);
$page ->assign('inline_ocjs', $config);
} else {
$this ->append('jsfiles', \OC::$server->getURLGenerator()->linkToRoute('core.OCJS.getConfig', ['v' => self::$versionHash]));
$page ->append('jsfiles', \OC::$server->getURLGenerator()->linkToRoute('core.OCJS.getConfig', ['v' => self::$versionHash]));
}
}
foreach ($jsFiles as $info) {
$web = $info[1];
$file = $info[2];
$this ->append('jsfiles', $web . '/' . $file . $this->getVersionHashSuffix());
$page ->append('jsfiles', $web . '/' . $file . $this->getVersionHashSuffix());
}
$request = \OCP\Server::get(IRequest::class);
try {
$pathInfo = \OC::$server->getRequest()->getPathInfo();
$pathInfo = $request->getPathInfo();
} catch (\Exception $e) {
$pathInfo = '';
}
// Do not initialise scss appdata until we have a fully installed instance
// Do not load scss for update, errors, installation or login page
if (\OC::$server->getSystemConfig()->getValue ('installed', false)
if ($this->config->getSystemValueBool ('installed', false)
& & !\OCP\Util::needUpgrade()
& & $pathInfo !== ''
& & !preg_match('/^\/login/', $pathInfo)
@ -267,41 +268,42 @@ class TemplateLayout extends \OC_Template {
} else {
// If we ignore the scss compiler,
// we need to load the guest css fallback
\OC_ Util::addStyle('guest');
$cssFiles = self::findStylesheetFiles(\OC_Util::$styles, false );
Util::addStyle('guest');
$cssFiles = self::findStylesheetFiles(\OC_Util::$styles);
}
$this ->assign('cssfiles', []);
$this ->assign('printcssfiles', []);
$page ->assign('cssfiles', []);
$page ->assign('printcssfiles', []);
$this->initialState->provideInitialState('core', 'versionHash', self::$versionHash);
foreach ($cssFiles as $info) {
$web = $info[1];
$file = $info[2];
if (str_ends_with($file, 'print.css')) {
$this ->append('printcssfiles', $web . '/' . $file . $this->getVersionHashSuffix());
$page ->append('printcssfiles', $web . '/' . $file . $this->getVersionHashSuffix());
} else {
$suffix = $this->getVersionHashSuffix($web, $file);
if (!str_contains($file, '?v=')) {
$this ->append('cssfiles', $web . '/' . $file . $suffix);
$page ->append('cssfiles', $web . '/' . $file . $suffix);
} else {
$this ->append('cssfiles', $web . '/' . $file . '-' . substr($suffix, 3));
$page ->append('cssfiles', $web . '/' . $file . '-' . substr($suffix, 3));
}
}
}
$request = \OCP\Server::get(IRequest::class);
if ($request->isUserAgent([Request::USER_AGENT_CLIENT_IOS, Request::USER_AGENT_SAFARI, Request::USER_AGENT_SAFARI_MOBILE])) {
// Prevent auto zoom with iOS but still allow user zoom
// On chrome (and others) this does not work (will also disable user zoom)
$this ->assign('viewport_maximum_scale', '1.0');
$page ->assign('viewport_maximum_scale', '1.0');
}
$this->assign('initialStates', $this->initialState->getInitialStates());
$page->assign('initialStates', $this->initialState->getInitialStates());
$page->assign('id-app-content', $renderAs === TemplateResponse::RENDER_AS_USER ? '#app-content' : '#content');
$page->assign('id-app-navigation', $renderAs === TemplateResponse::RENDER_AS_USER ? '#app-navigation' : null);
$this->assign('id-app-content', $renderAs === TemplateResponse::RENDER_AS_USER ? '#app-content' : '#content');
$this->assign('id-app-navigation', $renderAs === TemplateResponse::RENDER_AS_USER ? '#app-navigation' : null);
return $page;
}
protected function getVersionHashSuffix(string $path = '', string $file = ''): string {
@ -339,7 +341,7 @@ class TemplateLayout extends \OC_Template {
if (array_key_exists($path, self::$cacheBusterCache) === false) {
// Not yet cached, so lets find the cache buster string
$appId = $this->getAppNamefromPath($path);
if ($appId === false || $appId === null ) {
if ($appId === false) {
// No app Id could be guessed
return false;
}
@ -362,11 +364,7 @@ class TemplateLayout extends \OC_Template {
return self::$cacheBusterCache[$path];
}
/**
* @param array $styles
* @return array
*/
public static function findStylesheetFiles($styles, $compileScss = true) {
public static function findStylesheetFiles(array $styles): array {
if (!self::$cssLocator) {
self::$cssLocator = \OCP\Server::get(CSSResourceLocator::class);
}
@ -374,12 +372,8 @@ class TemplateLayout extends \OC_Template {
return self::$cssLocator->getResources();
}
/**
* @param string $path
* @return string|false
*/
public function getAppNamefromPath($path) {
if ($path !== '' & & is_string($path)) {
public function getAppNamefromPath(string $path): string|false {
if ($path !== '') {
$pathParts = explode('/', $path);
if ($pathParts[0] === 'css') {
// This is a scss request
@ -392,11 +386,7 @@ class TemplateLayout extends \OC_Template {
return false;
}
/**
* @param array $scripts
* @return array
*/
public static function findJavascriptFiles($scripts) {
public static function findJavascriptFiles(array $scripts): array {
if (!self::$jsLocator) {
self::$jsLocator = \OCP\Server::get(JSResourceLocator::class);
}
@ -410,7 +400,7 @@ class TemplateLayout extends \OC_Template {
* @return string Relative path
* @throws \Exception If $filePath is not under \OC::$SERVERROOT
*/
public static function convertToRelativePath($filePath) {
public static function convertToRelativePath(string $filePath) {
$relativePath = explode(\OC::$SERVERROOT, $filePath);
if (count($relativePath) !== 2) {
throw new \Exception('$filePath is not under the \OC::$SERVERROOT');
Côme Chilliet
7 months ago
committed by