| 1 | # Technical Reference
|
| 2 |
|
| 3 | ## server/index.js
|
| 4 | - start() - Initialises DB/keys, starts HTTP/HTTPS servers, and starts the background thumbnail cache loop.
|
| 5 | - shutdown(opts, ...servers) - Graceful teardown: stops thumbnail loop, closes DB/servers, exits with configurable code after drain/timeout.
|
| 6 | - Express error handler - Logs uncaught route errors to logs.txt before returning a JSON 500 response.
|
| 7 | - GET /share/:token - Calls buildShareOpenGraphPage to serve share.html with injected OG meta tags for all visitors; social media crawlers see rich preview data, browsers get the full interactive page.
|
| 8 |
|
| 9 | ## server/logger.js
|
| 10 | - logError(message, error, details) - Appends error lines to logs.txt, trimming old lines so the file stays under 1 MB; use for route failures and process-level exceptions.
|
| 11 |
|
| 12 | ## server/image-subtitles.js
|
| 13 | - parseRenderOptions(options) - Normalises subtitle-frame request options and validates filePath/streamIndex/time/canvas dimensions; stream index `0` is valid and must not be treated as missing.
|
| 14 | - renderImageSubtitleFrame({ filePath, streamIndex, timeSeconds, canvasWidth, canvasHeight }) - Extracts bitmap subtitle streams to cached `.sup`, parses PGS display sets, and returns cached/composited PNG subtitle frames for a requested timestamp; returns null when no subtitle is active.
|
| 15 | - clearCachesForFile(filePath) - Removes all event and frame cache entries for a given file path; called when video stream sessions end to prevent memory accumulation.
|
| 16 | - pruneOldImageSubtitleCaches(filePath, slowestViewerTimeSeconds) - Drops subtitle frame caches for events that have passed their retention threshold of end time + event duration + 30 seconds (e.g., event ending at 30s with 10s duration is dropped after slowest viewer reaches 70s); used during segment pruning to keep memory usage bounded on long videos, especially on resource-limited hardware like Raspberry Pi.
|
| 17 |
|
| 18 | ## server/thumbnail-cache.js
|
| 19 | - syncThumbnailCacheOnce() - Mirrors configured roots and userPath into public/thumbs and generates 99x99-max WebP thumbnails for image files, video files (ffprobe/ffmpeg frame at ~10%), and 3D model files (STL/OBJ, isometric SVG projection via Sharp); removes stale thumbnails and updates manifest hashes.
|
| 20 | - startThumbnailCacheLoop() - Schedules cache sync runs 5 seconds after boot and 5 seconds after each run completes.
|
| 21 | - stopThumbnailCacheLoop() - Stops scheduled background cache sync runs.
|
| 22 | - getCachedThumbnailInfo(sourceFile) - Returns cached thumbnail path/content-type when present; null when not ready.
|
| 23 | - getThumbPathForSourceFile(sourceFile) - Maps an absolute source file path to its mirrored cache thumbnail path.
|
| 24 | - getThumbRelPathForSourceFile(sourceFile) - Returns public-relative thumbnail path used in manifest entries.
|
| 25 | - getFilesWithThumbnailsInDir(dirPath) - Returns [{filePath, thumbRelPath}] for all files inside dirPath (recursive) that have a cached thumbnail; sorted by filePath.
|
| 26 | - getFolderIconSourceFile(folderPath) - Returns the source image path for a folder's icon: explicit assignment first, then auto-first cached image, null if none.
|
| 27 | - setFolderIconAssignment(folderPath, imagePath) - Saves an explicit folder icon assignment to .folder-icons.json; pass null to clear (auto-detect used instead).
|
| 28 |
|
| 29 | ## server/db.js
|
| 30 | - initDb() - Initializes SQLite schema for users, file metadata (including watched_by), and auth_sessions (idle timeout/revocation support), and migrates watched_by for existing DB files.
|
| 31 | - getDb() - Returns singleton DB handle with WAL and foreign key pragmas.
|
| 32 | - closeDb() - Closes singleton DB handle to release file locks.
|
| 33 |
|
| 34 | ## server/auth.js
|
| 35 | - createToken(username, req, fingerprint) - Creates JWT bound to IP/region/fingerprint and linked to a DB-backed session id.
|
| 36 | - requireAuth(req, res, next) - Verifies JWT + binding + session row + 1-hour idle timeout, updates last_seen_at, and attaches req.user.
|
| 37 | - requireAdmin(req, res, next) - Requires authenticated admin user.
|
| 38 | - revokeSession(sessionId) - Revokes a session row so future token use fails immediately.
|
| 39 | - getClientIp(req) - Normalizes request IP (including IPv4-mapped IPv6 loopback cases).
|
| 40 | - getRegion(ip) - Derives coarse region binding from geoip lookup or local fallback.
|
| 41 | - SESSION_IDLE_TIMEOUT_MS - Server-enforced idle timeout window (1 hour).
|
| 42 |
|
| 43 | ## server/routes/auth.js
|
| 44 | - extractCredentials(body) - Accepts encrypted payloads and compatibility plaintext payloads for login/setup.
|
| 45 | - makeAuthResponse(token, clientPublicKey) - Returns encrypted token when client key exists, plaintext token otherwise.
|
| 46 | - POST /api/auth/setup - Creates first admin and issues token.
|
| 47 | - POST /api/auth/login - Authenticates user by case-insensitive username match and issues token with canonical stored username.
|
| 48 | - GET /api/auth/me - Returns current authenticated user profile.
|
| 49 | - POST /api/auth/logout - Revokes the active session.
|
| 50 |
|
| 51 | ## server/routes/admin.js
|
| 52 | - POST /api/admin/users - Creates a new user and enforces case-insensitive username uniqueness.
|
| 53 | - PATCH /api/admin/users/:id - Updates user password/admin flag/permissions; rejects self-demotion and still blocks removing the last admin account.
|
| 54 | - GET /api/admin/orphan-userfolders - Returns non-empty user folders under userPath that no longer match any account, and auto-deletes empty orphan folders.
|
| 55 | - DELETE /api/admin/users/:id - Also removes the deleted user's personal folder when it exists and is empty.
|
| 56 | - normalizePermissions(permissions) - Normalizes permission maps and enforces that write access implies read access.
|
| 57 | - ensureUserFolders(userPath) - Ensures configured userPath exists and creates per-user subfolders for all current users.
|
| 58 | - GET /api/admin/config - Returns admin config including userPath and userFolderSizeLimit (bytes, null for unlimited).
|
| 59 | - PUT /api/admin/config - Persists paths plus userPath/userFolderSizeLimit and ensures per-user folders exist.
|
| 60 | - GET /api/admin/update-status - Returns { underSystemd, commitsAhead[] }. Detects systemd via INVOCATION_ID env var; runs git fetch + git log to find commits ahead of HEAD. Used by the frontend to set button label (Shut down server / Restart Server / Restart & Update).
|
| 61 |
|
| 62 | ## server/routes/files.js
|
| 63 | - GET /api/files/roots - Returns readable roots with display label (alias when configured), originalName, and path.
|
| 64 | - GET /api/files/roots - Adds a synthetic 'My folder' root for the authenticated user when userPath is configured.
|
| 65 | - loadConfigAndRoots() - Loads config and effective roots together so route access checks stay consistent.
|
| 66 | - resolveRootForUser(absPath, roots, user, config) - Resolves access for configured roots plus user-owned personal folder.
|
| 67 | - resolveRootForUser(absPath, roots, user, config) - Allows admins to access orphaned user folders (deleted-account folders) under userPath.
|
| 68 | - canReadInfo(user, info) / canWriteInfo(user, info) - Permission checks that automatically allow access for personal user-folder roots.
|
| 69 | - checkUserFolderSizeLimit(config, username, addedBytes) - Validates a user-folder capacity limit against current usage.
|
| 70 | - POST /api/files/root-alias - Sets a display-only alias for an exact configured root path (no filesystem rename).
|
| 71 | - GET /api/files/root-access - Returns users who can access an exact configured root and their access mode (R / R+W).
|
| 72 | - GET /api/files/meta - Returns file metadata and lazily computes/stores sha256 when missing.
|
| 73 | - GET /api/files/duplicates - Returns accessible files that share the selected file's sha256 hash.
|
| 74 | - GET /api/files/space - Returns used/free disk space and, for personal folders, user-limit fields (userLimitBytes/userFreeBytes).
|
| 75 | - GET /api/files/thumbnail - Serves cache-only thumbnail images for authorized files; returns 404 while cache is not ready.
|
| 76 | - GET /api/files/folder-images - Returns files inside a directory (recursive) that already have a cached thumbnail (including video thumbnails when cached).
|
| 77 | - GET /api/files/folder-icon - Returns the current icon source file for a folder ({icon:{filePath}} or {icon:null}); explicit assignment takes priority over auto-first.
|
| 78 | - POST /api/files/folder-icon - Sets or clears a folder's explicit icon assignment; imagePath must have a cached thumbnail; write access required.
|
| 79 | - GET /api/files/search - Fuzzy-searches all readable roots (and personal folder when configured) for files, returning ranked matches with path metadata.
|
| 80 | - GET /api/files/search-images - Fuzzy-searches readable roots for image files with ready thumbnails, returning capped results plus scan-truncation metadata for scalable global favicon selection.
|
| 81 | - GET /api/files/global-favicon-image - Publicly serves the configured global favicon thumbnail file so browsers can load `<link rel="icon">` without auth headers.
|
| 82 | - GET /api/files/global-favicon - Returns the configured global favicon source file path ({favicon:{filePath}} or {favicon:null}).
|
| 83 | - POST /api/files/global-favicon - Admin-only route that sets or clears the global favicon source image; image must have a cached thumbnail.
|
| 84 | - GET /api/files/download-zip?dir=<absolute-path> - Authenticated. Streams the directory as a zip archive; caches the zip for up to 1 day in zip-cache/.
|
| 85 | - makeTempUploadPath(dir, originalName) - Builds a hidden per-upload staging filename in the target directory for multipart uploads.
|
| 86 | - unlinkIfExists(targetPath, cb) - Removes a file during upload cleanup while ignoring already-missing temp files.
|
| 87 | - promoteUploadedFile(tempPath, finalPath, cb) - Atomically renames a completed staged upload into place on the Linux server.
|
| 88 | - splitNameExt(name) - Splits a filename into stem/ext, preserving dotless names and hidden-file behavior.
|
| 89 | - pickNumberedPath(dir, requestedName) - Finds the first free `name (n).ext` path inside a directory.
|
| 90 | - removePathRecursive(targetPath) - Deletes existing file or directory destination to support overwrite moves.
|
| 91 | - movePathWithFallback(from, dest) - Moves files/folders with an EXDEV copy-then-delete fallback so cross-device moves into My Folder still succeed.
|
| 92 | - POST /api/files/upload - Streams multipart uploads into hidden temp files, computes/stores sha256, and enforces user-folder size limits.
|
| 93 | - POST /api/files/move - Moves file/folder; supports conflict strategies: `error` (default), `overwrite`, or `rename` with optional `targetName`.
|
| 94 | - POST /api/files/copy - Copies a file to a destination folder with conflict strategies (`error`, `overwrite`, `rename`) and user-folder size-limit checks.
|
| 95 | - POST /api/files/video-stream - Creates a short-lived HLS session for a video and returns playlistUrl, durationSeconds, videoWidth, videoHeight, subtitleTracks, imageSubtitleTracks, and subtitleSummary ({total, converted, imageBased, skipped}).
|
| 96 | - GET /api/files/video-stream-subtitle-frame - Authenticated. Renders a PNG subtitle frame for bitmap subtitle tracks via cached PGS decode/composite flow; on failures or no active subtitle it returns 204 so the client can stop retrying.
|
| 97 | - DELETE /api/files/video-stream/:sessionId - Explicitly releases an active short-lived video stream session and stops backend processing.
|
| 98 | - POST /api/files/watched-statuses - Returns fast per-user watched statuses for up to 500 file paths without triggering expensive metadata/hash work; response is { statuses: { [filePath]: 'fully'|'partway' } }.
|
| 99 | - POST /api/files/watch-progress - Records per-user watch status (`partway` >=10%, `fully` >=70%) for sidebar "Watched by" display.
|
| 100 |
|
| 101 | ## server/routes/share.js
|
| 102 | - getUserFolderPath(config, username) - Resolves the owning user's personal folder path from config.userPath.
|
| 103 | - resolveRootForUser(absPath, roots, user, config) - Resolves configured roots plus the owning user's personal folder for share checks.
|
| 104 | - canReadInfo(user, info) - Read-check helper that always allows the owner of a personal folder root.
|
| 105 | - POST /api/share/create - Authenticated. Creates a 24-hour share token for a file or directory; returns {token, expiresAt} and accepts items inside the authenticated user's My Folder.
|
| 106 | - GET /api/share/info/:token - Public. Returns {name, isDir, expiresAt} for a valid non-expired token; 410 when expired, 404 when unknown.
|
| 107 | - GET /api/share/preview/:token - Public. Streams file content inline for preview (files only, max 50 MB); 400 for directories, 410 expired.
|
| 108 | - GET /api/share/download/:token - Public. Downloads the file or a zip of the directory for a valid token; 410 expired.
|
| 109 | - GET /api/share/video-stream/:token - Public. Creates a short-lived HLS session for a shared video and returns playlistUrl, durationSeconds, subtitleTracks, imageSubtitleTracks, and subtitleSummary ({total, converted, imageBased, skipped}).
|
| 110 | - buildShareOpenGraphPage(token, req) - Reads share.html, injects OG meta tags (<og:title>, <og:description>, <og:image> for image files, twitter:card) based on DB lookup of token, and returns the full HTML string. Handles expired and not-found tokens. Exported and used by the /share/:token route in server/index.js.
|
| 111 | - buildZip(dirPath, cacheKey) - Creates (or returns cached) zip in zip-cache/; prunes stale zips before building; exported for reuse in files.js.
|
| 112 | - pruneZipCache() - Deletes zip files in zip-cache/ older than 1 day; called automatically before each zip build.
|
| 113 | - ZIP_CACHE_DIR - Absolute path to the zip-cache/ directory (project root).
|
| 114 |
|
| 115 | ## server/video-stream.js
|
| 116 | - createVideoStreamSession(sourcePath) - Probes input metadata and reuses a compatible active transcode session per source file when possible; returns a per-viewer lease id as sessionId plus duration, videoWidth, videoHeight, subtitleTracks, imageSubtitleTracks, and subtitleSummary data, including same-name sidecar `.srt` subtitles converted to WebVTT.
|
| 117 | - sendVideoStreamAsset(sessionId, assetPath, req, res) - Resolves viewer leases to a shared stream session, serves HLS assets, tracks lease activity, and prunes segments using the slowest active viewer position.
|
| 118 | - releaseVideoStreamSession(sessionId) - Releases one viewer lease; only destroys the underlying transcode session when no active leases remain; cleanup also clears image subtitle frame/event caches to prevent memory accumulation.
|
| 119 | - runSegmentPrune(session) - Removes HLS segment files that fall behind the slowest active viewer and calls pruneImageSubtitleCachesForSession() to drop old subtitle frames once they pass end time + duration + 30 seconds, so subtitle buffers follow the same retention rules as video chunks.
|
| 120 | - STREAM_ROOT_DIR - Temporary root directory for active ffmpeg-backed stream sessions.
|
| 121 | - STREAM_SESSION_TTL_MS - Idle lifetime for a stream session before cleanup.
|
| 122 | - STREAM_IDLE_STOP_MS - Maximum client inactivity window before an active stream session is terminated (5 minutes).
|
| 123 | - STREAM_SEGMENT_RETENTION_COUNT - Number of most-recent HLS segment indices kept on disk while older segments are pruned; when not overridden with VIDEO_STREAM_SEGMENT_RETENTION_COUNT it is derived from hardware capacity (RAM + CPU), current memory/CPU pressure, and Raspberry Pi 5 profile bounds.
|
| 124 |
|
| 125 | ## server/db.js
|
| 126 | - initDb() - Initializes SQLite schema for users, file metadata, auth_sessions, and share_tokens (expires_at index).
|
| 127 | - getDb() - Returns singleton DB handle with WAL and foreign key pragmas.
|
| 128 | - closeDb() - Closes singleton DB handle to release file locks.
|
| 129 |
|
| 130 | ## public/share.html
|
| 131 | - Standalone public share page served at /share/:token; no auth required.
|
| 132 | - Timer bar - Live HH:MM:SS countdown showing remaining validity; turns red and disables download when expired.
|
| 133 | - tryPreview(name, isDir) - Renders inline preview (img/video/audio/text pre); no-op for unsupported types or directories.
|
| 134 | - Share video preview - Uses the same Video.js playback behaviour as app previews: VOD UI enforcement, long forward buffer, forced caption overrides (text background opacity transparent + text edge style uniform), and subtitle/audio track restore/save by matching track names when available.
|
| 135 | - Fetches /api/share/info/:token on load; shows error state for 404/410 responses.
|
| 136 | - Download link points to /api/share/download/:token; labelled "Download als .zip" for directories.
|
| 137 |
|
| 138 | ## public/index.html
|
| 139 | - Auth form - Login/setup form uses username plus mode-specific password autocomplete tokens so browser password managers behave correctly.
|
| 140 | - Top bar - Places icon-only Refresh to the left of breadcrumb/Home, keeps search input with icon-only search button, and groups actions into Upload/User dropdown triggers.
|
| 141 | - Admin panel - Includes an icon-only global favicon button that opens the shared icon picker modal.
|
| 142 | - Admin panel - Users section includes a conditional orphaned-user-folders subsection that appears only when non-empty orphan folders exist.
|
| 143 | - Admin modal - Includes User Folders controls (user path + per-user size limit) and a dedicated save action for that config.
|
| 144 | - Import map - Maps `three` and `three/addons/` to local vendored modules for client-side STL/OBJ previews.
|
| 145 |
|
| 146 | ## public/app.js
|
| 147 | - showApp() - Reveals app shell; keeps sidebar folded by default on mobile and shows folder overview sidebar on desktop.
|
| 148 | - showAuthOverlay(setupMode) - Displays the login/setup overlay and switches the password autocomplete token between current-password and new-password based on mode.
|
| 149 | - getOrCreateClientBindingId() - Creates/loads a persistent local browser binding id used in auth fingerprint derivation.
|
| 150 | - getFingerprint() - Builds a stable fingerprint from binding id + stable browser properties (not viewport metrics) to avoid false session invalidation on UI/window-state changes.
|
| 151 | - saveSessionState() - Persists token, selected path, and last operation timestamp in localStorage.
|
| 152 | - loadSessionState() - Restores persisted state only when the last operation is within the 1-hour local idle window.
|
| 153 | - api(method, path, body, opts) - Central API caller; refreshes local session timestamp on successful authenticated calls.
|
| 154 | - performLogout() - Explicit logout path that revokes server session and clears local session state.
|
| 155 | - initAuth() - Restores prior session when valid and auto-logins without credential prompt.
|
| 156 | - showConfirm(title, message, { html, okLabel }) - In-page confirm dialog; returns Promise<boolean>. `html=true` renders message as innerHTML (caller must escape user data). `okLabel` overrides the OK button text. Use instead of window.confirm().
|
| 157 | - escHtml(s) - HTML-escapes a string (& < > ") for safe use with innerHTML in confirm messages.
|
| 158 | - showPrompt(title, message, defaultValue) - In-page text-input dialog; returns Promise<string|null>. Use instead of window.prompt().
|
| 159 | - showOverwrite(filename) - In-page overwrite-decision dialog for file conflicts; returns Promise<'yes'|'no'|'all'|'none'>.
|
| 160 | - splitNameExt(name) - Client-side filename splitter used for local conflict rename suggestions.
|
| 161 | - nextAvailableName(requestedName, existingNames) - Computes `name (n).ext` for upload/move rename options.
|
| 162 | - listDirNameSet(dir) - Fetches directory listing and returns a Set of existing names.
|
| 163 | - cloneFileWithName(file, newName) - Creates a renamed File object for non-overwrite uploads.
|
| 164 | - showFileConflictChoice(filename, renameTo, mode) - Dialog for single upload/move conflicts; returns overwrite/rename/cancel.
|
| 165 | - parseHumanSize(input) - Parses human-readable sizes like `25 MB`/`1gb` into bytes for admin user-folder limits.
|
| 166 | - updateAdminSizeFeedback(rawValue) - Validates size input and updates admin hint text/classes with parsed byte preview.
|
| 167 | - relativePathFromRoot(targetPath, rootPath) - Produces a root-relative path string for sidebar folder context display.
|
| 168 | - displayPathWithRootLabel(targetPath, rootPath, rootLabel) - Produces Linux-style root-relative display paths like `/Downloads/A/B` for folder context UI.
|
| 169 | - runGlobalFileSearch() - Executes cross-root fuzzy file search via `/files/search`, swaps the grid into search-results mode, and updates breadcrumb/folder-stats text.
|
| 170 | - openShareModal(item) - Opens the Delen (share) popup, calls POST /api/share/create, shows the 24-hour URL with a copy button and OK to dismiss.
|
| 171 | - loadThumbnails() - Registers visible file icons for lazy thumbnail loading (both file thumbnails and folder icons); retries missing cache thumbnails during incremental refresh.
|
| 172 | - loadOneThumbnail(iconEl) - Loads thumbnails from server cache endpoint for images, text snapshots for text files, and badges for other files; marks image icons as pending when cache returns 404 and uses direct source SVG thumbnails for SVG files under 1MB.
|
| 173 | - loadOneThumbnail(iconEl) - Loads thumbnails from server cache endpoint for images and videos, text snapshots for text files, and badges for other files; marks image/video icons as pending when cache returns 404 and uses direct source SVG thumbnails for SVG files under 1MB.
|
| 174 | - loadOneThumbnail(iconEl) - Loads thumbnails from server cache endpoint for images, videos, and supported 3D model files; text files still use text snapshots and badges remain the fallback when no thumbnail strategy exists.
|
| 175 | - observeFolderIcon(iconEl) - Registers a folder icon element with IntersectionObserver for lazy loading.
|
| 176 | - loadOneFolderIcon(iconEl) - Fetches /api/files/folder-icon then the thumbnail blob and overlays it inside the folder SVG; no-op if no icon available.
|
| 177 | - applyFolderThumbnail(iconEl, srcUrl) - Injects an SVG <image> element clipped to the folder outline path into the folder's icon SVG.
|
| 178 | - initTopbarDropdowns() / closeTopbarDropdowns() - Controls Upload/User roll-down menus (open/close, outside-click close, Escape close) without resizing the top bar.
|
| 179 | - setAdminUpdateBadge(count) - Renders the update-count badge and coordinates its anchor between User trigger and Admin menu item.
|
| 180 | - syncAdminUpdateBadgeAnchor() / animateBadgeToTarget(targetEl) / moveBadgeToTarget(targetEl) - Animates badge movement while opening User dropdown and uses a non-animated move on close to prevent snap-to-corner geometry glitches.
|
| 181 | - openFolderIconPicker(item) - Opens the folder icon picker modal; shows cached-thumbnail files from the folder (including video thumbnails); allows selection, clearing, and cancellation.
|
| 182 | - openIconPickerModal(options) - Shared icon-picker modal used by folder-icon and global-favicon flows; includes live thumbnail-name filtering.
|
| 183 | - openGlobalFaviconPicker() - Opens a debounced, server-backed image-search modal across all accessible roots and sets/clears global favicon via `/files/global-favicon`.
|
| 184 | - refreshGlobalFavicon() - Reads `/files/global-favicon`, updates admin-panel favicon preview button, and applies/removes the page `<link rel="icon">` URL.
|
| 185 | - refreshAdminOrphanUserFolders() - Fetches `/admin/orphan-userfolders`, conditionally renders orphaned folder rows, and wires "Open folder" navigation for admins.
|
| 186 | - refreshAfterIconChange(item) - Resets and reloads the folder icon in both the grid tile and sidebar after set/clear operations.
|
| 187 | - disconnectFolderIconObserver() - Disconnects and clears the folder icon IntersectionObserver on grid rebuild.
|
| 188 | - getThumbnailKind(name) - Classifies files into image/text/badge thumbnail strategies.
|
| 189 | - observeThumbnailIcon(iconEl) - Defers thumbnail fetch work until file icons are near/in the viewport.
|
| 190 | - disconnectThumbnailObserver() - Clears active IntersectionObserver when the grid is rebuilt.
|
| 191 | - setThumbnailPending(iconEl, pending) - Toggles per-icon pending spinner state while a cached image thumbnail is not ready yet.
|
| 192 | - buildThumbnailSource(item, blob, kind) - Produces thumbnail image source (data/blob URL) for icon injection.
|
| 193 | - buildAuthHeaders() - Builds the authenticated fetch headers used by preview-side API calls that need the bearer token plus fingerprint header.
|
| 194 | - bindImageSubtitleOverlay(player, videojs, prefs, session, item) - Adds the fullscreen-safe image-subtitle button, menu, and bottom overlay used to fetch and display subtitle frames for image-based tracks; highlights the currently selected IM menu option; persists per-user image subtitle stream index + track name; restores by saved track name first (then stream index); disables the track after the first failed frame request to avoid repeated polling.
|
| 195 | - renderStreamedVideoPreview(item, targetEl) - Creates the Video.js player with HLS source/track config, enforces non-live playback UI for file streams, uses container-fill sizing to keep previews within bounds, restores per-user video prefs (volume + subtitle/audio track names when present), wires the image-subtitle overlay controller, forces caption overrides on each open (text background opacity transparent + text edge style uniform), reports watch progress, warns when subtitle streams exist but none are web-compatible, and releases the backend stream session on close/unload.
|
| 196 | - modelPreviewType(name) - Classifies direct client-side 3D preview support for `.stl` and `.obj`.
|
| 197 | - loadThreePreviewModules() - Lazy-loads Three.js plus OrbitControls/STLLoader/OBJLoader via import map aliases.
|
| 198 | - modelThumbnailDataUrl(item, blob) - Builds a blue SVG thumbnail for STL/OBJ files by parsing their geometry client-side; falls back to a badge when parsing fails.
|
| 199 | - buildModelObjectFromBlob(blob, type, modules) - Parses STL/OBJ blobs and produces a geometry-only model using the standard blue material.
|
| 200 | - renderModelPreview(item, blob, targetEl) - Renders interactive STL/OBJ previews (drag rotate + scroll zoom) with WebGL fallback messaging when unavailable.
|
| 201 | - closePreview(opts) - Closes expanded previews; video previews ignore backdrop close and require explicit close action.
|
| 202 |
|
| 203 | ## tests/thumbnail-cache.test.js
|
| 204 | - thumbnail cache worker / creates cached thumbnail with dimensions smaller than 100px - Verifies cached image generation and manifest write.
|
| 205 | - thumbnail cache worker / removes cached thumbnail when source file is deleted - Verifies stale thumbnail cleanup behavior.
|
| 206 | - thumbnail cache worker / creates cached thumbnail for video files using ffmpeg frame extraction - Verifies video thumbnail generation uses ffprobe duration and ffmpeg frame capture.
|
| 207 | - afterEach() cleanup - Removes temp roots with `fs.rmSync(...maxRetries...)` to tolerate transient Windows file locks.
|
| 208 | - detectCodeLanguage(name, mime) - Determines preview language for text/script files by MIME and extension.
|
| 209 | - prettyPrintCode(raw, lang) - Best-effort formatter for JSON/markup/script previews before rendering.
|
| 210 | - highlightCode(raw, lang) - Escapes and syntax-highlights preview text into HTML spans.
|
| 211 | - fileAccentColor(name) - Returns canonical file-type accent color used by icon strokes and preview sheet outline.
|
| 212 | - openFolderSidebar() - Persistent sidebar fallback view that shows current folder/root overview when no item is selected.
|
| 213 | - closeSidebar() - Clears selection; hides the panel entirely on mobile and restores folder overview sidebar on desktop.
|
| 214 | - isMobileViewport() - Central media-query helper for mobile-only sidebar/interaction behavior.
|
| 215 | - hideSidebarPanel() - Hides sidebar panel and removes sidebar-open layout class from the app shell.
|
| 216 | - renderBreadcrumb() - Builds clickable breadcrumb path and marks each folder segment as a drag-drop move target via .crumb-drop-target and data-path.
|
| 217 | - fetchFileBlob(item) - Downloads a file as Blob with auth headers for preview/download flows.
|
| 218 | - downloadOrView(item, sourceSvgEl) - Opens preview; prefers in-place expanded tile preview when invoked from a file icon, falls back to overlay when no source tile is available.
|
| 219 | - downloadOrView(item, sourceSvgEl) - Opens in-place expanded tile preview from a file icon; shows error toast if no source tile is found.
|
| 220 | - renderPreviewBody(item, blob, objectUrl, targetEl) - Renders preview content (image/video/audio/pdf/text) or unsupported message into a target container.
|
| 221 | - animateRect(el, fromRect, toRect, opts) - Helper that animates element rectangle (left/top/width/height) for expand/collapse transitions.
|
| 222 | - openExpandedTilePreview(item, tileEl, sourceSvgEl, blob, objectUrl) - Reparents the real file tile to body, expands it to viewport preview, injects close/download controls.
|
| 223 | - openExpandedTilePreview(item, tileEl, sourceSvgEl, blob, objectUrl) - Reparents tile to body, shows spinner during expand animation, renders content after animation; applies file-type accent colour to tile border and outline glow.
|
| 224 | - openExpandedTilePreview(item, tileEl, sourceSvgEl, loadPreviewContent) - Preserves the tile's original grid slot with a hidden placeholder while preview is open, then adds preview action buttons for Download and Share.
|
| 225 | - closeExpandedTilePreview() - Collapses expanded tile preview back to the original grid slot, restores original icon markup, and removes the preview placeholder.
|
| 226 | - closePreview() - Closes either expanded-tile preview or overlay preview, then revokes active preview object URL.
|
| 227 | - closePreview() - Closes expanded-tile preview and revokes active preview object URL.
|
| 228 | - openMovePicker(item) - Opens Move To selector modal with expandable folder tree across all writable roots and executes /api/files/move.
|
| 229 | - openCopyPicker(item) - Opens Copy To selector modal with the same tree and executes /api/files/copy.
|
| 230 | - openDestinationPicker(item, mode) - Shared destination picker state/labels for move vs copy operations.
|
| 231 | - moveWithConflictResolution(item, targetDir) - Attempts move and handles 409 conflicts by prompting overwrite/rename/cancel then retries.
|
| 232 | - copyWithConflictResolution(item, targetDir) - Attempts copy and handles 409 conflicts by prompting overwrite/rename/cancel then retries.
|
| 233 | - rootPermissionLabel(root) - Resolves permission key for a root using originalName when available; personal folders resolve to the built-in My Folder label.
|
| 234 | - ensureMoveModal() - Lazily creates and wires Move To modal UI (tree, selection state, confirm/cancel handlers).
|
| 235 | - createMoveNode(folderPath, label) - Builds an expandable/selectable folder node for the Move To tree.
|
| 236 | - loadMoveChildren(containerEl, dirPath) - Lazy-loads subfolders for a tree node via /api/files/list.
|
| 237 | - isInlinePreviewableBlob(blob, name) - Determines if a blob can be previewed inline by MIME/extension.
|
| 238 | - makeFileItem(item) - Builds a .file-item element; roots in Home now use folder-like interaction (single-click focus, double-click open), roots are non-draggable, and mobile long-press contextmenu suppression remains.
|
| 239 | - makeFileItem(item) - Renders tile icons first, then applies any cached watched overlay state (`fully` full-size filled eye, `partway` smaller darker filled eye).
|
| 240 | - loadWatchedStatusesForCurrentDir() - Fetches watched states in one bulk POST /files/watched-statuses request per directory (with legacy /files/meta fallback), caches statuses per path, and updates tile overlays quickly.
|
| 241 | - attachMobileLongPress(el, item) - Adds mobile long-press detection on file/folder tiles to open the item sidebar without desktop side effects.
|
| 242 | - beginSidebarLoad() - Aborts in-flight sidebar requests and increments a load token so stale async responses cannot mutate the current sidebar state.
|
| 243 | - openSidebar(item) - Renders item details/actions in sidebar; roots show alias + original name + usage stats, hide Move To/Delete, keep Rename.
|
| 244 | - openSidebar(item) - Personal user roots display access as private and skip /files/root-access lookups to avoid forbidden noise.
|
| 245 | - openSidebar(item) - Uses abortable metadata/access requests and stale-load guards to prevent race-condition UI duplication when selection changes quickly.
|
| 246 | - canWrite(item) - Resolves whether the current user may write to the selected item/root; personal folders are always writable for the owner.
|
| 247 | - fetchRootAccessList(rootPath) - Fetches root access users from the server for a specific configured root.
|
| 248 | - formatRootAccessList(users) - Formats root access entries as "username mode" values for sidebar rendering.
|
| 249 | - openSidebar(item) - Renders item details/actions in sidebar; root selections include alias/original name/usage/access list and keep Rename while hiding Move To/Delete.
|
| 250 | - openFolderSidebar() - Shows current folder details when nothing is selected; when at root base-level it also shows root access list.
|
| 251 | - openRenameModal(item) - Renames files/folders; for roots this writes display alias via /api/files/root-alias and reloads roots.
|
| 252 | - uploadFiles(fileList) - Uploads files one-by-one with per-file conflict prompt (overwrite/rename/cancel) when names already exist.
|
| 253 | - openUserModal(user, paths) - Admin user editor; enforces UI permission rule that Write is disabled/unchecked while Read is unchecked and disables the Admin checkbox when editing the current signed-in admin account.
|
| 254 | - refreshAdminOrphanUserFolders() UI flow - Admin panel shows orphaned user folders only when present and opens selected orphan folder from the section button.
|
| 255 |
|
| 256 | ## public/drag-move.js
|
| 257 | - makeDraggable(el, item) - Attaches pointerdown to a .file-item; starts drag after threshold movement. Depends on: api(), canWrite(), navigateTo(), STATE, closeSidebar(), toast() from app.js.
|
| 258 | - makeDraggable(el, item) - Touch drag now requires a short hold before movement, uses pointer capture, and keeps drag responsive on mobile.
|
| 259 | - (internal) _beginDrag(e, el, item) - Lifts and re-parents the real .file-item to body, inserts hidden placeholder, and shows parent-folder drag target when applicable.
|
| 260 | - (internal) _moveDrag(e) - Moves the real dragged item, hit-tests folder tiles, breadcrumb segments, and parent-folder target, toggles target highlight state.
|
| 261 | - (internal) _endDrag() - On valid target: runs drop animation, calls moveWithConflictResolution() for overwrite/rename/cancel conflicts, then refreshes dir. Otherwise snap-back.
|
| 262 | - (internal) _cleanupDrag(reinsert) - Restores tile styles; reinserts into grid on failure/abort or removes before refresh on success, hides drag helper targets.
|
| 263 |
|
| 264 | ## public/drag-move.css
|
| 265 | - .file-item.dragging - Lifted style for real dragged tile.
|
| 266 | - .file-item.drop-target - Glows folder icon when drag hovers over it.
|
| 267 | - .drag-parent-target - Temporary top-left "move to parent" drop target shown while dragging in nested folders.
|
| 268 | - .crumb-drop-target.active - Highlight style for breadcrumb drop destinations during drag.
|
| 269 | - @keyframes drag-rise-spin-fall - Real tile rises, spins, falls/scales into folder on drop.
|
| 270 | - @keyframes folder-bounce - Target folder bounces down then back on accept.
|
| 271 | - .preview-backdrop/.file-item--preview/.preview-expand-* - In-place expanded tile preview styling (no separate overlay window), including preserved icon-outline layer.
|
| 272 | - .preview-expand-share - Secondary action button positioned next to .preview-expand-download in expanded file preview.
|
| 273 | - .move-modal/.move-tree/.move-node* - Move To tree picker styles with expandable/collapsible folder hierarchy.
|
| 274 |
|
| 275 | ## public/style.css
|
| 276 | - #sidebar-duplicates + related classes - Sidebar duplicate-file list styling with truncation and hover feedback.
|
| 277 | - .admin-size-feedback(.ok/.err) - Validation feedback styling for admin user-folder size-limit input.
|
| 278 | - .top-search* + .global-favicon-preview - Topbar file search controls and global favicon preview button styling.
|
| 279 | - .folder-icon-filter - Search input styling for live filtering in the icon-picker modal.
|
| 280 |
|
| 281 | ## tests/auth.routes.test.js
|
| 282 | - session lifecycle / POST /api/auth/logout revokes active session - Verifies explicit logout invalidates token immediately.
|
| 283 | - session lifecycle / session expires after 1 hour of inactivity - Verifies server-side idle timeout enforcement.
|
| 284 |
|
| 285 | ## tests/page.load.test.js
|
| 286 | - bootClient() - Boots the app in jsdom and waits until app shell is visible or timeout before assertions.
|
| 287 | - waitFor(dom, predicate, timeoutMs) - Poll helper used by interaction tests to wait for rendered tiles.
|
| 288 | - login overlay uses username and current-password autocomplete tokens - Verifies normal sign-in mode exposes browser-friendly login autocomplete attributes.
|
| 289 | - first-run setup uses new-password autocomplete token - Verifies setup mode switches the password field to the browser-friendly new-password token.
|
| 290 | - expanded file preview shows a Share button next to Download - Verifies expanded preview UI includes both actions inside a dedicated footer below the preview content.
|
| 291 | - expanded STL preview falls back gracefully when WebGL is unavailable - Verifies STL preview path shows a clear fallback message when WebGL contexts are unavailable.
|
| 292 | - expanded video preview uses a stream session and video.js - Verifies streamed video preview uses the server-backed HLS session and registers subtitle tracks with video.js.
|
| 293 | - video preview does not close on backdrop click and closes via X button - Verifies video previews require explicit close via X.
|
| 294 | - video preview restores per-user saved volume preference - Verifies per-user saved video volume is applied on preview open.
|
| 295 | - video preview restores saved subtitle/audio track names when available - Verifies per-user subtitle/audio selections are reapplied by matching track names.
|
| 296 | - video preview keeps default tracks when saved names are not present - Verifies subtitle/audio defaults remain unchanged when saved names are missing.
|
| 297 | - video preview saves subtitle/audio track names per user when selection changes - Verifies subtitle/audio selections are persisted into per-user video preferences.
|
| 298 | - video preview applies caption overrides per open - Verifies requested caption overrides are always loaded into Video.js settings.
|
| 299 | - video preview does not save caption style settings per user on close - Verifies caption style changes are not persisted to per-user video preferences.
|
| 300 | - video preview releases the backend stream session when closed - Verifies closing a streamed video preview sends an explicit backend release call.
|
| 301 | - rapid file reselection does not duplicate sidebar action buttons after delayed metadata - Verifies stale sidebar loads are ignored so action buttons are not duplicated.
|
| 302 | - video tiles show centred watched overlays after watched metadata is loaded - Verifies overlays remain absent until watched metadata is fetched, then render as solid eye icons for fully and partway statuses.
|
| 303 | - shows pending icon spinner when video thumbnail cache is not ready - Verifies video tiles use thumbnail-cache loading (instead of badge fallback) and pending-state UI.
|
| 304 |
|
| 305 | ## tests/video-stream.test.js
|
| 306 | - createVideoStreamSession resolves once ffmpeg starts writing stream assets - Verifies session creation no longer waits for the final master playlist before preview can begin.
|
| 307 | - createVideoStreamSession configures flat segment filenames that match playlist URLs - Verifies ffmpeg segment output paths match the segment URLs emitted in the generated HLS playlists.
|
| 308 | - createVideoStreamSession does not become ready from subtitle files alone - Verifies stream readiness is tied to HLS output instead of extracted subtitle files.
|
| 309 | - createVideoStreamSession keeps playback available when subtitle conversion fails - Verifies subtitle conversion failures are skipped without breaking stream playback.
|
| 310 | - sendVideoStreamAsset prunes old segment files after playback moves far ahead - Verifies old segments are removed only after the retention window passes.
|
| 311 | - createVideoStreamSession reuses one transcode for concurrent viewers of the same file - Verifies two viewers share one ffmpeg transcode while keeping independent lease release behaviour.
|
| 312 |
|
| 313 | ## tests/share.page.load.test.js
|
| 314 | - applies default caption settings for share-page video playback - Verifies requested caption defaults are applied and persisted on share-page video preview.
|
| 315 | - restores and saves share-page subtitle/audio track preferences by name - Verifies share-page subtitle/audio choices are restored and persisted by track-name matching.
|
| 316 |
|
| 317 | ## tests/files.routes.test.js
|
| 318 | - POST /api/files/watch-progress stores per-user watched status by thresholds - Verifies watch-status persistence and no downgrade from fully to partway.
|
| 319 | - DELETE /api/files/video-stream/:sessionId releases an active stream session - Verifies explicit stream session release route wiring.
|
| 320 |
|
| 321 | ## public/vendor/three/three.module.js
|
| 322 | - Third-party Three.js runtime module (vendored, unmodified) used for client-side 3D previews.
|
| 323 |
|
| 324 | ## public/vendor/three/addons/controls/OrbitControls.js
|
| 325 | - Third-party OrbitControls module (vendored, unmodified) providing drag-rotate and wheel-zoom interactions.
|
| 326 |
|
| 327 | ## public/vendor/three/addons/loaders/STLLoader.js
|
| 328 | - Third-party STL parser module (vendored, unmodified) for client-side `.stl` geometry loading.
|
| 329 |
|
| 330 | ## public/vendor/three/addons/loaders/OBJLoader.js
|
| 331 | - Third-party OBJ parser module (vendored, unmodified) for client-side `.obj` geometry loading.
|