Merge pull request #2718 from nextcloud/enh/config-options

Add option to set default file extension and disable rich editing

lib/AppInfo/Application.php

@@ -34,6 +34,7 @@
 use OCA\Text\Listeners\FilesSharingLoadAdditionalScriptsListener;
 use OCA\Text\Listeners\LoadViewerListener;
 use OCA\Text\Listeners\RegisterDirectEditorEventListener;
+use OCA\Text\Service\ConfigService;
 use OCA\Viewer\Event\LoadViewer;
 use OCP\AppFramework\App;
 use OCP\AppFramework\Bootstrap\IBootContext;
@@ -66,9 +67,9 @@ public function register(IRegistrationContext $context): void {
 	}
 
 	public function boot(IBootContext $context): void {
-		$context->injectFn(function (ITemplateManager $templateManager, IL10N $l) {
-			$templateManager->registerTemplateFileCreator(function () use ($l) {
-				$markdownFile = new TemplateFileCreator(Application::APP_NAME, $l->t('New text file'), '.md');
+		$context->injectFn(function (ITemplateManager $templateManager, IL10N $l, ConfigService $configService) {
+			$templateManager->registerTemplateFileCreator(function () use ($l, $configService) {
+				$markdownFile = new TemplateFileCreator(Application::APP_NAME, $l->t('New text file'), '.' . $configService->getDefaultFileExtension());
 				$markdownFile->addMimetype('text/markdown');
 				$markdownFile->addMimetype('text/plain');
 				$markdownFile->setIconClass('icon-filetype-text');

lib/Listeners/FilesLoadAdditionalScriptsListener.php

@@ -26,28 +26,18 @@
 namespace OCA\Text\Listeners;
 
 use OCA\Files\Event\LoadAdditionalScriptsEvent;
-use OCA\Text\AppInfo\Application;
+use OCA\Text\Service\InitialStateProvider;
 use OCP\EventDispatcher\Event;
 use OCP\EventDispatcher\IEventListener;
-use OCP\IConfig;
-use OCP\IInitialStateService;
-use OCP\IUserSession;
 
 /**
  * @implements IEventListener<Event>
  */
 class FilesLoadAdditionalScriptsListener implements IEventListener {
-	/** @var IConfig */
-	protected $config;
-	/** @var IInitialStateService */
-	protected $initialStateService;
-	/** @var IUserSession */
-	protected $userSession;
+	private InitialStateProvider $initialStateProvider;
 
-	public function __construct(IConfig $config, IInitialStateService $initialStateService, IUserSession $userSession) {
-		$this->config = $config;
-		$this->initialStateService = $initialStateService;
-		$this->userSession = $userSession;
+	public function __construct(InitialStateProvider $initialStateProvider) {
+		$this->initialStateProvider = $initialStateProvider;
 	}
 
 	public function handle(Event $event): void {
@@ -57,15 +47,6 @@ public function handle(Event $event): void {
 
 		\OCP\Util::addScript('text', 'text-files');
 
-		$this->initialStateService->provideInitialState(
-			Application::APP_NAME,
-			'workspace_available',
-			$this->config->getAppValue(Application::APP_NAME, 'workspace_available', '1') === '1'
-		);
-		$this->initialStateService->provideInitialState(
-			Application::APP_NAME,
-			'workspace_enabled',
-			$this->config->getUserValue($this->userSession->getUser()->getUID(), Application::APP_NAME, 'workspace_enabled', '1') === '1'
-		);
+		$this->initialStateProvider->provideState();
 	}
 }

lib/Listeners/FilesSharingLoadAdditionalScriptsListener.php

@@ -25,31 +25,23 @@
 
 namespace OCA\Text\Listeners;
 
-use OCA\Text\AppInfo\Application;
+use OCA\Text\Service\InitialStateProvider;
 use OCP\EventDispatcher\Event;
 use OCP\EventDispatcher\IEventListener;
 use OCP\IConfig;
-use OCP\IInitialStateService;
+use OCP\Util;
 
 /** @implements IEventListener<Event> */
 class FilesSharingLoadAdditionalScriptsListener implements IEventListener {
-	/** @var IConfig */
-	protected $config;
-	/** @var IInitialStateService */
-	protected $initialStateService;
+	protected InitialStateProvider $initialStateProvider;
 
-	public function __construct(IConfig $config, IInitialStateService $initialStateService) {
-		$this->config = $config;
-		$this->initialStateService = $initialStateService;
+	public function __construct(IConfig $config, InitialStateProvider $initialStateProvider) {
+		$this->initialStateProvider = $initialStateProvider;
 	}
 
 	public function handle(Event $event): void {
-		\OCP\Util::addScript('text', 'text-public');
+		Util::addScript('text', 'text-public');
 
-		$this->initialStateService->provideInitialState(
-			Application::APP_NAME,
-			'workspace_available',
-			$this->config->getAppValue(Application::APP_NAME, 'workspace_available', '1') === '1'
-		);
+		$this->initialStateProvider->provideState();
 	}
 }

lib/Listeners/LoadViewerListener.php

@@ -25,16 +25,26 @@
 
 namespace OCA\Text\Listeners;
 
+use OCA\Text\Service\InitialStateProvider;
 use OCA\Viewer\Event\LoadViewer;
 use OCP\EventDispatcher\Event;
 use OCP\EventDispatcher\IEventListener;
+use OCP\Util;
 
 /** @implements IEventListener<Event> */
 class LoadViewerListener implements IEventListener {
+	private InitialStateProvider $initialStateProvider;
+
+	public function __construct(InitialStateProvider $initialStateProvider) {
+		$this->initialStateProvider = $initialStateProvider;
+	}
+
 	public function handle(Event $event): void {
 		if (!$event instanceof LoadViewer) {
 			return;
 		}
-		\OCP\Util::addScript('text', 'text-viewer', 'viewer');
+		Util::addScript('text', 'text-viewer', 'viewer');
+
+		$this->initialStateProvider->provideState();
 	}
 }

lib/Service/ConfigService.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace OCA\Text\Service;
+
+use OCA\Text\AppInfo\Application;
+use OCP\IConfig;
+
+class ConfigService {
+	private IConfig $config;
+
+	public function __construct(IConfig $config) {
+		$this->config = $config;
+	}
+
+	public function getDefaultFileExtension(): string {
+		return $this->config->getAppValue(Application::APP_NAME, 'default_file_extension', 'md');
+	}
+
+	public function isRichEditingEnabled(): bool {
+		return ($this->config->getAppValue(Application::APP_NAME, 'rich_editing_enabled', '1') === '1');
+	}
+
+	public function isRichWorkspaceAvailable(): bool {
+		return $this->config->getAppValue(Application::APP_NAME, 'workspace_available', '1') === '1';
+	}
+
+	public function isRichWorkspaceEnabledForUser(?string $userId): bool {
+		if ($userId === null) {
+			return true;
+		}
+		return $this->config->getUserValue($userId, Application::APP_NAME, 'workspace_enabled', '1') === '1';
+	}
+}

lib/Service/InitialStateProvider.php

@@ -0,0 +1,39 @@
+<?php
+
+namespace OCA\Text\Service;
+
+use OCP\AppFramework\Services\IInitialState;
+
+class InitialStateProvider {
+	private IInitialState $initialState;
+	private ConfigService $configService;
+	private ?string $userId;
+
+	public function __construct(IInitialState $initialState, ConfigService $configService, ?string $userId) {
+		$this->initialState = $initialState;
+		$this->configService = $configService;
+		$this->userId = $userId;
+	}
+
+	public function provideState(): void {
+		$this->initialState->provideInitialState(
+			'workspace_available',
+			$this->configService->isRichWorkspaceAvailable()
+		);
+
+		$this->initialState->provideInitialState(
+			'workspace_enabled',
+			$this->configService->isRichWorkspaceEnabledForUser($this->userId)
+		);
+
+		$this->initialState->provideInitialState(
+			'default_file_extension',
+			$this->configService->getDefaultFileExtension()
+		);
+
+		$this->initialState->provideInitialState(
+			'rich_editing_enabled',
+			$this->configService->isRichEditingEnabled()
+		);
+	}
+}

src/components/EditorWrapper.vue

@@ -102,6 +102,7 @@ import { EditorContent } from '@tiptap/vue-2'
 import { getVersion, receiveTransaction } from 'prosemirror-collab'
 import { Step } from 'prosemirror-transform'
 import { getCurrentUser } from '@nextcloud/auth'
+import { loadState } from '@nextcloud/initial-state'
 
 import {
 	EDITOR,
@@ -299,7 +300,7 @@ export default {
 			return this.isDirectEditing || (document.getElementById('isPublic') && document.getElementById('isPublic').value === '1')
 		},
 		isRichEditor() {
-			return this.mime === 'text/markdown'
+			return loadState('text', 'rich_editing_enabled', true) && this.mime === 'text/markdown'
 		},
 		fileExtension() {
 			return this.relativePath ? this.relativePath.split('/').pop().split('.').pop() : 'txt'

src/helpers/files.js

@@ -20,6 +20,7 @@
  *
  */
 
+import { loadState } from '@nextcloud/initial-state'
 import { openMimetypes } from './mime.js'
 import RichWorkspace from '../views/RichWorkspace.vue'
 import { imagePath } from '@nextcloud/router'
@@ -56,7 +57,7 @@ const registerFileCreate = () => {
 			menu.addMenuEntry({
 				id: 'file',
 				displayName: t('text', 'New text file'),
-				templateName: t('text', 'New text file') + '.md',
+				templateName: t('text', 'New text file') + '.' + loadState('text', 'default_file_extension'),
 				iconClass: 'icon-filetype-text',
 				fileType: 'file',
 				actionHandler(name) {