Skip to content

Sync-in · Sovereign platform for file storage, sharing, synchronization, and collaboration.

feat(backend:files): add showHiddenFiles option to toggle visibility of dotfiles

johavened47fbf3fe7f
diff --git a/backend/src/applications/files/constants/files.ts b/backend/src/applications/files/constants/files.ts
index 48944055..4d0e8ea5 100644
--- a/backend/src/applications/files/constants/files.ts
+++ b/backend/src/applications/files/constants/files.ts
@@ -6,26 +6,6 @@
export const DEFAULT_HIGH_WATER_MARK = 1024 * 1024
export const DEFAULT_MIME_TYPE = 'application/octet-stream'
-export const DEFAULT_FILTERS = new Set([
- '.DS_Store',
- '.swp',
- '.AppleDouble',
- '.AppleDesktop',
- 'Thumbs.db',
- '.Spotlight-V100',
- '.DocumentRevisions-V100',
- '.fseventsd',
- '.MobileBackups',
- 'Icon?',
- '__MACOSX',
- '.thumbnails',
- '.DAV',
- '.desktop',
- 'desktop.ini',
- '.TemporaryItems',
- '.localized',
- '__pycache__'
-])
export const EXTRA_MIMES_TYPE = new Map([
['.ts', 'text-typescript'],
['.py', 'text-x-python'],
diff --git a/backend/src/applications/files/files.config.ts b/backend/src/applications/files/files.config.ts
index a86bb2bc..346244e4 100644
--- a/backend/src/applications/files/files.config.ts
+++ b/backend/src/applications/files/files.config.ts
@@ -44,6 +44,9 @@ export class FilesConfig {
@IsInt()
maxUploadSize: number = 5368709120 // 5 GB
+ @IsBoolean()
+ showHiddenFiles: boolean = false
+
@IsNotEmptyObject()
@ValidateNested()
@Type(() => FilesOnlyOfficeConfig)
diff --git a/backend/src/applications/spaces/services/spaces-browser.service.ts b/backend/src/applications/spaces/services/spaces-browser.service.ts
index 00f61971..0ed0b1a8 100644
--- a/backend/src/applications/spaces/services/spaces-browser.service.ts
+++ b/backend/src/applications/spaces/services/spaces-browser.service.ts
@@ -7,7 +7,7 @@
import { HttpException, Injectable, Logger } from '@nestjs/common'
import fs from 'node:fs/promises'
import path from 'node:path'
-import { DEFAULT_FILTERS } from '../../files/constants/files'
+import { configuration } from '../../../configuration/config.environment'
import { FileLock } from '../../files/interfaces/file-lock.interface'
import { FileProps } from '../../files/interfaces/file-props.interface'
import { FilesLockManager } from '../../files/services/files-lock-manager.service'
@@ -138,7 +138,7 @@ export class SpacesBrowser {
this.logger.log(`${this.parsePath.name} - ignore special file : ${element.name}`)
continue
}
- if (DEFAULT_FILTERS.has(element.name)) {
+ if (!configuration.applications.files.showHiddenFiles && element.name[0] === '.') {
this.logger.verbose(`${this.parsePath.name} - ignore filtered file : ${element.name}`)
continue
}
diff --git a/backend/src/applications/spaces/services/spaces-manager.service.ts b/backend/src/applications/spaces/services/spaces-manager.service.ts
index d80afef9..3e643573 100644
--- a/backend/src/applications/spaces/services/spaces-manager.service.ts
+++ b/backend/src/applications/spaces/services/spaces-manager.service.ts
@@ -12,9 +12,9 @@ import { ACTION } from '../../../common/constants'
import { convertDiffUpdate, diffCollection, differencePermissions } from '../../../common/functions'
import type { Entries } from '../../../common/interfaces'
import { createSlug, regExpNumberSuffix } from '../../../common/shared'
+import { configuration } from '../../../configuration/config.environment'
import { Cache } from '../../../infrastructure/cache/services/cache.service'
import { ContextManager } from '../../../infrastructure/context/services/context-manager.service'
-import { DEFAULT_FILTERS } from '../../files/constants/files'
import { FileError } from '../../files/models/file-error'
import { dirListFileNames, dirSize, getProps, isPathExists, moveFiles, removeFiles } from '../../files/utils/files'
import { LINK_TYPE } from '../../links/constants/links'
@@ -183,7 +183,7 @@ export class SpacesManager {
for (const space of [...(await this.listSpaces(user.id)), personalTrash] as SpaceTrash[]) {
const rPath = space.alias === SPACE_ALIAS.PERSONAL ? user.trashPath : SpaceModel.getTrashPath(space.alias)
try {
- space.nb = (await fs.readdir(rPath)).filter((f) => !DEFAULT_FILTERS.has(f)).length
+ space.nb = (await fs.readdir(rPath)).filter((f) => configuration.applications.files.showHiddenFiles || f[0] !== '.').length
if (space.nb) {
const stats = await fs.stat(rPath)
space.mtime = stats.mtime.getTime()
diff --git a/environment/environment.dist.yaml b/environment/environment.dist.yaml
index 30411720..e3781fc3 100755
--- a/environment/environment.dist.yaml
+++ b/environment/environment.dist.yaml
@@ -81,6 +81,8 @@ applications:
dataPath: /home/sync-in
# Default to 5 GB if not specified
maxUploadSize: 5368709120
+ # Show files starting with a dot in the file explorer (default: false)
+ showHiddenFiles: false
onlyoffice:
enabled: false
# for an external server (e.g: https://onlyoffice.domain.com), remember the url must be accessible from browser !