enh: Add migration step to cover migration for existing users

Signed-off-by: Julius Härtl <jus@bitgrid.net>

Author: juliusknorr

appinfo/info.xml

@@ -28,6 +28,7 @@ The Notes app is a distraction free notes taking app for [Nextcloud](https://www
 	<repair-steps>
 		<post-migration>
 			<step>OCA\Notes\Migration\Cleanup</step>
+			<step>OCA\Notes\Migration\EditorHint</step>
 		</post-migration>
 	</repair-steps>
 

appinfo/routes.php

@@ -100,6 +100,7 @@
 	//////////  S E T T I N G S  //////////
 	['name' => 'settings#set', 'url' => '/settings', 'verb' => 'PUT'],
 	['name' => 'settings#get', 'url' => '/settings', 'verb' => 'GET'],
+	['name' => 'settings#migrate', 'url' => '/settings/migrate', 'verb' => 'POST'],
 
 
 	//////////  A P I  //////////

lib/Controller/PageController.php

@@ -4,43 +4,55 @@
 
 namespace OCA\Notes\Controller;
 
+use OCA\Notes\AppInfo\Application;
 use OCA\Notes\Service\NotesService;
 
+use OCA\Notes\Service\SettingsService;
 use OCA\Text\Event\LoadEditor;
+use OCP\App\IAppManager;
 use OCP\AppFramework\Controller;
 use OCP\AppFramework\Http\TemplateResponse;
 use OCP\AppFramework\Http\ContentSecurityPolicy;
 use OCP\AppFramework\Http\RedirectResponse;
+use OCP\AppFramework\Services\IInitialState;
 use OCP\EventDispatcher\IEventDispatcher;
+use OCP\IConfig;
 use OCP\IRequest;
 use OCP\IURLGenerator;
 use OCP\IUserSession;
 
 class PageController extends Controller {
 	private NotesService $notesService;
+	private IConfig $config;
 	private IUserSession $userSession;
 	private IURLGenerator $urlGenerator;
 	private IEventDispatcher $eventDispatcher;
+	private IInitialState $initialState;
 
 	public function __construct(
 		string $AppName,
 		IRequest $request,
 		NotesService $notesService,
+		IConfig $config,
 		IUserSession $userSession,
 		IURLGenerator $urlGenerator,
-		IEventDispatcher $eventDispatcher
+		IEventDispatcher $eventDispatcher,
+		IInitialState $initialState
 	) {
 		parent::__construct($AppName, $request);
 		$this->notesService = $notesService;
+		$this->config = $config;
 		$this->userSession = $userSession;
 		$this->urlGenerator = $urlGenerator;
 		$this->eventDispatcher = $eventDispatcher;
+		$this->initialState = $initialState;
 	}
 
 
 	/**
 	 * @NoAdminRequired
 	 * @NoCSRFRequired
+	 * @suppress PhanUndeclaredClassReference, PhanTypeMismatchArgument, PhanUndeclaredClassMethod
 	 */
 	public function index() : TemplateResponse {
 		$devMode = !is_file(dirname(__FILE__).'/../../js/notes-main.js');
@@ -50,10 +62,20 @@ public function index() : TemplateResponse {
 			[ ]
 		);
 
-		if (class_exists(LoadEditor::class)) {
+		if (\OCP\Server::get(IAppManager::class)->isEnabledForUser('text') && class_exists(LoadEditor::class)) {
 			$this->eventDispatcher->dispatchTyped(new LoadEditor());
 		}
 
+		$this->initialState->provideInitialState(
+			'config',
+			\OCP\Server::get(SettingsService::class)->getPublic($this->userSession->getUser()->getUID())
+		);
+
+		$this->initialState->provideInitialState(
+			'editorHint',
+			$this->config->getUserValue($this->userSession->getUser()->getUID(), Application::APP_ID, 'editorHint', '')
+		);
+
 		$csp = new ContentSecurityPolicy();
 		$csp->addAllowedImageDomain('*');
 		$response->setContentSecurityPolicy($csp);

lib/Controller/SettingsController.php

@@ -48,4 +48,9 @@ public function set(): JSONResponse {
 	public function get(): JSONResponse {
 		return new JSONResponse($this->service->getAll($this->getUID()));
 	}
+
+	public function migrate(): JSONResponse {
+		$this->service->delete($this->getUID(), 'editorHint');
+		return new JSONResponse();
+	}
 }

lib/Migration/EditorHint.php

@@ -0,0 +1,63 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @copyright Copyright (c) 2023 Julius Härtl <jus@bitgrid.net>
+ *
+ * @author Julius Härtl <jus@bitgrid.net>
+ *
+ * @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 <http://www.gnu.org/licenses/>.
+ */
+
+
+namespace OCA\Notes\Migration;
+
+use OCA\Notes\AppInfo\Application;
+use OCP\IConfig;
+use OCP\IUser;
+use OCP\IUserManager;
+use OCP\Migration\IOutput;
+use OCP\Migration\IRepairStep;
+
+class EditorHint implements IRepairStep {
+	private IConfig $config;
+	private IUserManager $userManager;
+	public function __construct(IConfig $config, IUserManager $userManager) {
+		$this->config = $config;
+		$this->userManager = $userManager;
+	}
+
+	public function getName() {
+		return 'Show a hint about the new editor to existing users';
+	}
+
+	public function run(IOutput $output) {
+		$appVersion = $this->config->getAppValue('text', 'installed_version');
+
+		if (!$appVersion || version_compare($appVersion, '4.7.0') !== -1) {
+			return;
+		}
+
+		$this->userManager->callForSeenUsers(function (IUser $user) {
+			if ($this->config->getUserValue($user->getUID(), Application::APP_ID, 'notesLastViewedNote', '') === '') {
+				return;
+			}
+
+			$this->config->setUserValue($user->getUID(), Application::APP_ID, 'editorHint', 'yes');
+		});
+	}
+}

lib/Service/SettingsService.php

@@ -168,6 +168,10 @@ public function get(string $uid, string $name) : string {
 		}
 	}
 
+	public function delete(string $uid, string $name): void {
+		$this->config->deleteUserValue($uid, Application::APP_ID, $name);
+	}
+
 	public function getPublic(string $uid) : \stdClass {
 		// initialize and load settings
 		$settings = $this->getAll($uid, true);

package-lock.json

@@ -16,6 +16,7 @@
     "@nextcloud/axios": "^2.2.0",
     "@nextcloud/dialogs": "^3.2.0",
     "@nextcloud/event-bus": "^3.0.2",
+    "@nextcloud/initial-state": "^2.0.0",
     "@nextcloud/moment": "^1.2.1",
     "@nextcloud/router": "^2.0.1",
     "@nextcloud/vue": "^7.3.0",

package.json

@@ -1,5 +1,6 @@
 <template>
-	<NcContent app-name="notes" :content-class="{loading: loading.notes}">
+	<EditorHint v-if="editorHint" @close="editorHint=false" />
+	<NcContent v-else app-name="notes" :content-class="{loading: loading.notes}">
 		<NcAppNavigation :class="{loading: loading.notes, 'icon-error': error}">
 			<NcAppNavigationNew
 				v-show="!loading.notes && !error"
@@ -52,6 +53,7 @@ import {
 	NcAppNavigationItem,
 	NcContent,
 } from '@nextcloud/vue'
+import { loadState } from '@nextcloud/initial-state'
 import { showSuccess, TOAST_UNDO_TIMEOUT, TOAST_PERMANENT_TIMEOUT } from '@nextcloud/dialogs'
 import '@nextcloud/dialogs/styles/toast.scss'
 
@@ -61,6 +63,7 @@ import PlusIcon from 'vue-material-design-icons/Plus.vue'
 import AppSettings from './components/AppSettings.vue'
 import NavigationList from './components/NavigationList.vue'
 import AppHelp from './components/AppHelp.vue'
+import EditorHint from './components/Modal/EditorHint.vue'
 
 import { config } from './config.js'
 import { fetchNotes, noteExists, createNote, undoDeleteNote } from './NotesService.js'
@@ -72,6 +75,7 @@ export default {
 	components: {
 		AppHelp,
 		AppSettings,
+		EditorHint,
 		InfoIcon,
 		NavigationList,
 		NcAppContent,
@@ -97,6 +101,7 @@ export default {
 			deletedNotes: [],
 			refreshTimer: null,
 			helpVisible: false,
+			editorHint: loadState('notes', 'editorHint', '') === 'yes' && window.oc_appswebroots.text,
 		}
 	},
 

src/App.vue

@@ -46,6 +46,15 @@ export const setSettings = settings => {
 		})
 }
 
+export const deleteEditorMode = () => {
+	return axios
+		.post(url('/settings/migrate'))
+		.catch(err => {
+			console.error(err)
+			throw err
+		})
+}
+
 export const getDashboardData = () => {
 	return axios
 		.get(url('/notes/dashboard'))

src/NotesService.js

@@ -0,0 +1,72 @@
+<template>
+	<NcModal>
+		<div class="editor-hint-modal">
+			<h2>{{ t('notes', 'Rich text editor') }}</h2>
+
+			<p>{{ t('notes', 'You can now switch to use the easy to use and distraction free rich text editor. It allows you to edit notes without seeing any markdown marks.') }}</p>
+
+			<p>{{ t('notes', 'This option can also be changed later on in the Notes app settings.') }}</p>
+
+			<div class="submit-buttons">
+				<NcButton type="secondary" :disabled="loading" @click="useOld">
+					{{ t('notes', 'Keep plain markdown editor') }}
+				</NcButton>
+				<NcButton type="primary" :disabled="loading" @click="useNew">
+					{{ t('notes', 'Use rich editor') }}
+				</NcButton>
+			</div>
+		</div>
+	</NcModal>
+</template>
+<script>
+import { NcModal, NcButton } from '@nextcloud/vue'
+import { loadState } from '@nextcloud/initial-state'
+
+import { deleteEditorMode, setSettings } from './../../NotesService.js'
+
+export default {
+	components: {
+		NcModal,
+		NcButton,
+	},
+	data() {
+		return {
+			loading: false,
+		}
+	},
+	methods: {
+		async useOld() {
+			const oldState = loadState('notes', 'config', {})
+			setSettings({
+				...oldState,
+				noteMode: oldState?.nodeMode ?? 'edit',
+			})
+			await deleteEditorMode()
+			this.$emit('close')
+		},
+		async useNew() {
+			setSettings({
+				...loadState('notes', 'config', {}),
+				noteMode: 'rich',
+			})
+			await deleteEditorMode()
+			this.$emit('close')
+		},
+	},
+}
+</script>
+<style lang="scss" scoped>
+.editor-hint-modal {
+	margin: 24px;
+}
+
+.submit-buttons {
+	display: flex;
+	justify-content: flex-end;
+	margin-top: 24px;
+
+	button {
+		margin-left: 12px;
+	}
+}
+</style>

src/components/Modal/EditorHint.vue

@@ -24,7 +24,7 @@ export default {
 
 	computed: {
 		rich() {
-			return store.state.app.settings.noteMode === 'rich'
+			return window.oc_appswebroots.text && store.state.app.settings.noteMode === 'rich'
 		},
 	},
 }

src/components/Note.vue

@@ -1,3 +1,5 @@
+import { set } from 'vue'
+
 const state = {
 	settings: {},
 	isSaving: false,
@@ -14,6 +16,10 @@ const mutations = {
 		state.settings = settings
 	},
 
+	setNoteMode(state, mode) {
+		set(state.settings, 'noteMode', mode)
+	},
+
 	setSaving(state, isSaving) {
 		state.isSaving = isSaving
 	},