feat: setting to show/hide hidden files

fixes #1245

Signed-off-by: Roberto Vidal <roberto.vidal@ikumene.com>

Author: jrvidal

lib/Controller/Helper.php

@@ -75,11 +75,12 @@ public function getNotesAndCategories(
 		?string $category = null,
 		int $chunkSize = 0,
 		?string $chunkCursorStr = null,
+		?bool $showHidden = null,
 	) : array {
 		$userId = $this->getUID();
 		$chunkCursor = $chunkCursorStr ? ChunkCursor::fromString($chunkCursorStr) : null;
 		$lastUpdate = $chunkCursor->timeStart ?? new \DateTime();
-		$data = $this->notesService->getAll($userId, true); // auto-create notes folder if not exists
+		$data = $this->notesService->getAll($userId, true, $showHidden); // auto-create notes folder if not exists
 		$metaNotes = $this->metaService->getAll($userId, $data['notes']);
 
 		// if a category is requested, then ignore all other notes

lib/Controller/NotesApiController.php

@@ -66,7 +66,9 @@ public function index(
 			$this->settingsService->getAll($userId, true);
 			// load notes and categories
 			$exclude = explode(',', $exclude);
-			$data = $this->helper->getNotesAndCategories($pruneBefore, $exclude, $category, $chunkSize, $chunkCursor);
+			// show hidden folders by default, ignoring settings, so clients can handle them at will
+			$showHidden = true;
+			$data = $this->helper->getNotesAndCategories($pruneBefore, $exclude, $category, $chunkSize, $chunkCursor, $showHidden);
 			$notesData = $data['notesData'];
 			if (!$data['chunkCursor']) {
 				// if last chunk, then send all notes (pruned)

lib/Service/NotesService.php

@@ -30,11 +30,14 @@ public function __construct(
 		$this->noteUtil = $noteUtil;
 	}
 
-	public function getAll(string $userId, bool $autoCreateNotesFolder = false) : array {
+	public function getAll(string $userId, bool $autoCreateNotesFolder = false, ?bool $showHidden = null) : array {
 		$customExtension = $this->getCustomExtension($userId);
 		try {
 			$notesFolder = $this->getNotesFolder($userId, $autoCreateNotesFolder);
-			$data = self::gatherNoteFiles($customExtension, $notesFolder);
+			if ($showHidden === null) {
+				$showHidden = $this->settings->get($userId, 'showHidden');
+			}
+			$data = self::gatherNoteFiles($customExtension, $notesFolder, $showHidden);
 			$fileIds = array_keys($data['files']);
 			// pre-load tags for all notes (performance improvement)
 			$this->noteUtil->getTagService()->loadTags($fileIds);
@@ -66,7 +69,8 @@ public function countNotes(string $userId) : int {
 		$customExtension = $this->getCustomExtension($userId);
 		try {
 			$notesFolder = $this->getNotesFolder($userId, false);
-			$data = self::gatherNoteFiles($customExtension, $notesFolder);
+			$showHidden = $this->settings->get($userId, 'showHidden');
+			$data = self::gatherNoteFiles($customExtension, $notesFolder, $showHidden);
 			return count($data['files']);
 		} catch (NotesFolderException $e) {
 			return 0;
@@ -168,6 +172,7 @@ private function getNotesFolder(string $userId, bool $create = true) : Folder {
 	private static function gatherNoteFiles(
 		string $customExtension,
 		Folder $folder,
+		bool $showHidden,
 		string $categoryPrefix = '',
 	) : array {
 		$data = [
@@ -176,10 +181,14 @@ private static function gatherNoteFiles(
 		];
 		$nodes = $folder->getDirectoryListing();
 		foreach ($nodes as $node) {
+			$hidden = str_starts_with($node->getName(), '.');
+			if ($hidden && !$showHidden) {
+				continue;
+			}
 			if ($node->getType() === FileInfo::TYPE_FOLDER && $node instanceof Folder) {
 				$subCategory = $categoryPrefix . $node->getName();
 				$data['categories'][] = $subCategory;
-				$data_sub = self::gatherNoteFiles($customExtension, $node, $subCategory . '/');
+				$data_sub = self::gatherNoteFiles($customExtension, $node, $showHidden, $subCategory . '/');
 				$data['files'] = $data['files'] + $data_sub['files'];
 				$data['categories'] = $data['categories'] + $data_sub['categories'];
 			} elseif (self::isNote($node, $customExtension)) {

lib/Service/SettingsService.php

@@ -68,6 +68,12 @@ public function __construct(
 					return '.' . $out;
 				},
 			],
+			'showHidden' => [
+				'default' => true,
+				'validate' => function ($value) {
+					return (bool)$value;
+				}
+			],
 		];
 	}
 
@@ -169,7 +175,7 @@ public function getAll(string $uid, $saveInitial = false) : \stdClass {
 	/**
 	 * @throws \OCP\PreConditionNotMetException
 	 */
-	public function get(string $uid, string $name) : string {
+	public function get(string $uid, string $name) : string|bool {
 		$settings = $this->getAll($uid);
 		if (property_exists($settings, $name)) {
 			return $settings->{$name};

src/components/AppSettings.vue

@@ -22,17 +22,26 @@
 				{{ t('notes', 'Organize your notes in categories.') }}
 			</div>
 		</NcAppSettingsSection>
-		<NcAppSettingsSection id="notes-path-section" :name="t('notes', 'Notes path')">
+		<NcAppSettingsSection id="notes-path-section" :name="t('notes', 'Notes folder')">
 			<p class="app-settings-section__desc">
 				{{ t('notes', 'Folder to store your notes') }}
 			</p>
+
 			<input id="notesPath"
 				v-model="settings.notesPath"
 				type="text"
 				name="notesPath"
 				:placeholder="t('notes', 'Root directory')"
 				@click="onChangeNotePath"
 			>
+			<div>
+				<NcCheckboxRadioSwitch
+					v-model="settings.showHidden"
+					@update:checked="onChangeSettings"
+				>
+					{{ t('notes', 'Show hidden folders') }}
+				</NcCheckboxRadioSwitch>
+			</div>
 		</NcAppSettingsSection>
 		<NcAppSettingsSection id="file-suffix-section" :name="t('notes', 'File extension')">
 			<p class="app-settings-section__desc">
@@ -87,6 +96,7 @@
 import {
 	NcAppSettingsDialog,
 	NcAppSettingsSection,
+	NcCheckboxRadioSwitch,
 } from '@nextcloud/vue'
 
 import { getFilePickerBuilder } from '@nextcloud/dialogs'
@@ -101,6 +111,7 @@ export default {
 	components: {
 		NcAppSettingsDialog,
 		NcAppSettingsSection,
+		NcCheckboxRadioSwitch,
 		HelpMobile,
 	},
 
@@ -136,6 +147,7 @@ export default {
 				{ shortcut: t('notes', 'CTRL') + '+' + t('notes', 'ALT') + '+I', action: t('notes', 'Insert image') },
 				{ shortcut: t('notes', 'CTRL') + '+/', action: t('notes', 'Switch between editor and viewer') },
 			],
+			initialShowHidden: Boolean(store.state.app.settings.showHidden),
 		}
 	},
 
@@ -195,6 +207,12 @@ export default {
 		setSettingsOpen(newValue) {
 			this.settingsOpen = newValue
 			this.$emit('update:open', newValue)
+
+			if (this.settingsOpen) {
+				this.$data.initialShowHidden = Boolean(store.state.app.settings.showHidden)
+			} else if (this.$data.initialShowHidden !== store.state.app.settings.showHidden) {
+				this.$emit('reload')
+			}
 		},
 	},
 }
@@ -211,4 +229,8 @@ export default {
 .settings-block form {
 	display: inline-flex;
 }
+
+#notesPath {
+	margin-bottom: 1rem;
+}
 </style>