From c30bab34e6c0716069d59631597f4c36f7a45d8f Mon Sep 17 00:00:00 2001 From: Roeland Jago Douma Date: Tue, 16 Jun 2020 21:54:20 +0200 Subject: [PATCH] Move accessibility js route to static js and initial state Yet again another js file that doesn't have to be served via nextcloud. But can just be done via the webbrowser. Signed-off-by: Roeland Jago Douma --- apps/accessibility/appinfo/routes.php | 1 - .../composer/composer/autoload_classmap.php | 1 + .../composer/composer/autoload_static.php | 1 + apps/accessibility/js/accessibilityoca.js | 4 ++ .../accessibility/lib/AppInfo/Application.php | 45 ++++---------- .../Controller/AccessibilityController.php | 39 ------------ .../lib/Service/JSDataService.php | 62 +++++++++++++++++++ 7 files changed, 81 insertions(+), 72 deletions(-) create mode 100644 apps/accessibility/js/accessibilityoca.js create mode 100644 apps/accessibility/lib/Service/JSDataService.php diff --git a/apps/accessibility/appinfo/routes.php b/apps/accessibility/appinfo/routes.php index 0278457b6a..da0bfdbd18 100644 --- a/apps/accessibility/appinfo/routes.php +++ b/apps/accessibility/appinfo/routes.php @@ -27,7 +27,6 @@ return [ 'routes' => [ ['name' => 'accessibility#getCss', 'url' => '/css/user-{md5}', 'verb' => 'GET'], - ['name' => 'accessibility#getJavascript', 'url' => '/js/accessibility', 'verb' => 'GET'], ], 'ocs' => [ [ diff --git a/apps/accessibility/composer/composer/autoload_classmap.php b/apps/accessibility/composer/composer/autoload_classmap.php index d0d7a9a280..dd926bcda3 100644 --- a/apps/accessibility/composer/composer/autoload_classmap.php +++ b/apps/accessibility/composer/composer/autoload_classmap.php @@ -11,6 +11,7 @@ return array( 'OCA\\Accessibility\\Controller\\AccessibilityController' => $baseDir . '/../lib/Controller/AccessibilityController.php', 'OCA\\Accessibility\\Controller\\ConfigController' => $baseDir . '/../lib/Controller/ConfigController.php', 'OCA\\Accessibility\\Migration\\RepairUserConfig' => $baseDir . '/../lib/Migration/RepairUserConfig.php', + 'OCA\\Accessibility\\Service\\JSDataService' => $baseDir . '/../lib/Service/JSDataService.php', 'OCA\\Accessibility\\Settings\\Personal' => $baseDir . '/../lib/Settings/Personal.php', 'OCA\\Accessibility\\Settings\\PersonalSection' => $baseDir . '/../lib/Settings/PersonalSection.php', ); diff --git a/apps/accessibility/composer/composer/autoload_static.php b/apps/accessibility/composer/composer/autoload_static.php index e8870488db..7d73696476 100644 --- a/apps/accessibility/composer/composer/autoload_static.php +++ b/apps/accessibility/composer/composer/autoload_static.php @@ -26,6 +26,7 @@ class ComposerStaticInitAccessibility 'OCA\\Accessibility\\Controller\\AccessibilityController' => __DIR__ . '/..' . '/../lib/Controller/AccessibilityController.php', 'OCA\\Accessibility\\Controller\\ConfigController' => __DIR__ . '/..' . '/../lib/Controller/ConfigController.php', 'OCA\\Accessibility\\Migration\\RepairUserConfig' => __DIR__ . '/..' . '/../lib/Migration/RepairUserConfig.php', + 'OCA\\Accessibility\\Service\\JSDataService' => __DIR__ . '/..' . '/../lib/Service/JSDataService.php', 'OCA\\Accessibility\\Settings\\Personal' => __DIR__ . '/..' . '/../lib/Settings/Personal.php', 'OCA\\Accessibility\\Settings\\PersonalSection' => __DIR__ . '/..' . '/../lib/Settings/PersonalSection.php', ); diff --git a/apps/accessibility/js/accessibilityoca.js b/apps/accessibility/js/accessibilityoca.js new file mode 100644 index 0000000000..756d21d034 --- /dev/null +++ b/apps/accessibility/js/accessibilityoca.js @@ -0,0 +1,4 @@ +OCA.Accessibility = OCP.InitialState.loadState('accessibility', 'data') +if (OCA.Accessibility.theme !== false) { + document.body.classList.add(OCA.Accessibility.theme); +} diff --git a/apps/accessibility/lib/AppInfo/Application.php b/apps/accessibility/lib/AppInfo/Application.php index e691b8353d..c5c495c182 100644 --- a/apps/accessibility/lib/AppInfo/Application.php +++ b/apps/accessibility/lib/AppInfo/Application.php @@ -29,12 +29,14 @@ declare(strict_types=1); namespace OCA\Accessibility\AppInfo; +use OCA\Accessibility\Service\JSDataService; use OCP\AppFramework\App; use OCP\AppFramework\Bootstrap\IBootContext; use OCP\AppFramework\Bootstrap\IBootstrap; use OCP\AppFramework\Bootstrap\IRegistrationContext; +use OCP\AppFramework\IAppContainer; use OCP\IConfig; -use OCP\IServerContainer; +use OCP\IInitialStateService; use OCP\IURLGenerator; use OCP\IUserSession; use function count; @@ -46,15 +48,6 @@ class Application extends App implements IBootstrap { /** @var string */ public const APP_ID = 'accessibility'; - /** @var IConfig */ - private $config; - - /** @var IUserSession */ - private $userSession; - - /** @var IURLGenerator */ - private $urlGenerator; - public function __construct() { parent::__construct(self::APP_ID); } @@ -68,11 +61,8 @@ class Application extends App implements IBootstrap { $context->getAppContainer()->query(IConfig::class), $context->getAppContainer()->query(IURLGenerator::class) ); - $this->injectJavascript( - $context->getAppContainer()->query(IURLGenerator::class), - $context->getAppContainer()->query(IConfig::class), - $context->getServerContainer() - ); + + $this->registerInitialState($context->getAppContainer()); } private function injectCss(IUserSession $userSession, @@ -91,23 +81,14 @@ class Application extends App implements IBootstrap { } } - private function injectJavascript(IURLGenerator $urlGenerator, - IConfig $config, - IServerContainer $serverContainer) { - $linkToJs = $urlGenerator->linkToRoute( - self::APP_ID . '.accessibility.getJavascript', - [ - 'v' => $config->getAppValue(self::APP_ID, 'cachebuster', '0'), - ] - ); + private function registerInitialState(IAppContainer $container) { + /** @var IInitialStateService $initialState */ + $initialState = $container->query(IInitialStateService::class); - \OCP\Util::addHeader( - 'script', - [ - 'src' => $linkToJs, - 'nonce' => $serverContainer->getContentSecurityPolicyNonceManager()->getNonce() - ], - '' - ); + $initialState->provideLazyInitialState(self::APP_ID, 'data', function () use ($container) { + /** @var JSDataService $data */ + $data = $container->query(JSDataService::class); + return $data; + }); } } diff --git a/apps/accessibility/lib/Controller/AccessibilityController.php b/apps/accessibility/lib/Controller/AccessibilityController.php index 25e117c715..bafe8eb3e4 100644 --- a/apps/accessibility/lib/Controller/AccessibilityController.php +++ b/apps/accessibility/lib/Controller/AccessibilityController.php @@ -39,7 +39,6 @@ use OCP\App\IAppManager; use OCP\AppFramework\Controller; use OCP\AppFramework\Http; use OCP\AppFramework\Http\DataDisplayResponse; -use OCP\AppFramework\Http\DataDownloadResponse; use OCP\AppFramework\Utility\ITimeFactory; use OCP\IConfig; use OCP\ILogger; @@ -204,44 +203,6 @@ class AccessibilityController extends Controller { return $response; } - /** - * @NoCSRFRequired - * @PublicPage - * @NoSameSiteCookieRequired - * - * @return DataDownloadResponse - */ - public function getJavascript(): DataDownloadResponse { - $user = $this->userSession->getUser(); - - if ($user === null) { - $theme = false; - $highcontrast = false; - } else { - $theme = $this->config->getUserValue($user->getUID(), $this->appName, 'theme', false); - $highcontrast = $this->config->getUserValue($user->getUID(), $this->appName, 'highcontrast', false) !== false; - } - if ($theme !== false) { - $responseJS = '(function() { - OCA.Accessibility = { - highcontrast: ' . json_encode($highcontrast) . ', - theme: ' . json_encode($theme) . ', - }; - document.body.classList.add(' . json_encode($theme) . '); -})();'; - } else { - $responseJS = '(function() { - OCA.Accessibility = { - highcontrast: ' . json_encode($highcontrast) . ', - theme: ' . json_encode($theme) . ', - }; -})();'; - } - $response = new DataDownloadResponse($responseJS, 'javascript', 'text/javascript'); - $response->cacheFor(3600); - return $response; - } - /** * Return an array with the user theme & font settings * diff --git a/apps/accessibility/lib/Service/JSDataService.php b/apps/accessibility/lib/Service/JSDataService.php new file mode 100644 index 0000000000..61bcd33472 --- /dev/null +++ b/apps/accessibility/lib/Service/JSDataService.php @@ -0,0 +1,62 @@ + + * + * @author Roeland Jago Douma + * + * @license GNU AGPL version 3 or any later version + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + * + */ + +namespace OCA\Accessibility\Service; + +use OCA\Accessibility\AppInfo\Application; +use OCP\IConfig; +use OCP\IUserSession; + +class JSDataService implements \JsonSerializable { + /** @var IUserSession */ + private $userSession; + /** @var IConfig */ + private $config; + + public function __construct( + IUserSession $userSession, + IConfig $config + ) { + $this->userSession = $userSession; + $this->config = $config; + } + + public function jsonSerialize() { + $user = $this->userSession->getUser(); + + if ($user === null) { + $theme = false; + $highcontrast = false; + } else { + $theme = $this->config->getUserValue($user->getUID(), Application::APP_ID, 'theme', false); + $highcontrast = $this->config->getUserValue($user->getUID(), Application::APP_ID, 'highcontrast', false) !== false; + } + + return [ + 'theme' => $theme, + 'highcontrast' => $highcontrast, + ]; + } +}