A free and open source instant messaging and VoIP chat app built for friends, groups, and communities.
// SPDX-License-Identifier: AGPL-3.0-or-later
import {AppStorageKey} from '@app/features/platform/state/AppStorageKeys';
import AppStorage from '@app/features/platform/state/PersistentStorage';
import {getProtectedIndexedDB} from '@app/features/platform/state/ProtectedWebStorage';
import type {
ThemeLibraryAsset,
ThemeLibraryLocalFileReference,
ThemeLibraryTheme,
} from '@app/features/theme/state/ThemeLibrary';
import {isObjectLike as isRecord} from '@fluxer/record_utils/src/RecordGuards';
const DB_NAME = 'fluxer-theme-library';
const DB_VERSION = 1;
const THEMES_STORE = 'themes';
const ASSETS_STORE = 'assets';
const LOCAL_FILES_STORE = 'localFiles';
const META_STORE = 'meta';
const ENABLED_THEME_IDS_KEY = 'enabledThemeIds';
const browserIndexedDB = getProtectedIndexedDB();
type ThemeLibraryTableName = typeof THEMES_STORE | typeof ASSETS_STORE | typeof LOCAL_FILES_STORE | typeof META_STORE;
let openPromise: Promise<IDBDatabase> | null = null;
const THEME_SOURCES = new Set<string>(['quick_css', 'css_file', 'desktop_directory', 'shared_theme', 'import']);
function isStringArray(value: unknown): value is Array<string> {
return Array.isArray(value) && value.every((item) => typeof item === 'string');
}
function isThemeLibraryTheme(value: unknown): value is ThemeLibraryTheme {
return (
isRecord(value) &&
typeof value.id === 'string' &&
typeof value.name === 'string' &&
typeof value.description === 'string' &&
typeof value.author === 'string' &&
typeof value.version === 'string' &&
isStringArray(value.tags) &&
typeof value.css === 'string' &&
typeof value.fileName === 'string' &&
typeof value.source === 'string' &&
THEME_SOURCES.has(value.source) &&
(value.linkedPath === undefined || typeof value.linkedPath === 'string') &&
(value.folderPath === undefined || typeof value.folderPath === 'string') &&
typeof value.createdAt === 'number' &&
typeof value.updatedAt === 'number'
);
}
function isThemeLibraryAsset(value: unknown): value is ThemeLibraryAsset {
return (
isRecord(value) &&
typeof value.id === 'string' &&
typeof value.name === 'string' &&
typeof value.mimeType === 'string' &&
typeof value.size === 'number' &&
(value.data === undefined || value.data instanceof Blob) &&
(value.desktopPath === undefined || typeof value.desktopPath === 'string') &&
typeof value.createdAt === 'number' &&
typeof value.updatedAt === 'number'
);
}
function isThemeLibraryLocalFileReference(value: unknown): value is ThemeLibraryLocalFileReference {
return (
isRecord(value) &&
typeof value.id === 'string' &&
typeof value.name === 'string' &&
typeof value.path === 'string' &&
typeof value.mimeType === 'string' &&
typeof value.size === 'number' &&
typeof value.createdAt === 'number' &&
typeof value.updatedAt === 'number'
);
}
function requestToPromise<T>(request: IDBRequest<T>): Promise<T> {
return new Promise((resolve, reject) => {
request.onsuccess = () => resolve(request.result);
request.onerror = () => reject(request.error ?? new Error('IndexedDB request failed'));
});
}
function transactionDone(transaction: IDBTransaction): Promise<void> {
return new Promise((resolve, reject) => {
transaction.oncomplete = () => resolve();
transaction.onerror = () => reject(transaction.error ?? new Error('IndexedDB transaction failed'));
transaction.onabort = () => reject(transaction.error ?? new Error('IndexedDB transaction aborted'));
});
}
function getDatabase(): Promise<IDBDatabase> {
if (openPromise) {
return openPromise;
}
const promise = new Promise<IDBDatabase>((resolve, reject) => {
if (!browserIndexedDB) {
reject(new Error('IndexedDB unavailable'));
return;
}
const request = browserIndexedDB.open(DB_NAME, DB_VERSION);
request.onupgradeneeded = () => {
const db = request.result;
if (!db.objectStoreNames.contains(THEMES_STORE)) {
db.createObjectStore(THEMES_STORE, {keyPath: 'id'});
}
if (!db.objectStoreNames.contains(ASSETS_STORE)) {
db.createObjectStore(ASSETS_STORE, {keyPath: 'id'});
}
if (!db.objectStoreNames.contains(LOCAL_FILES_STORE)) {
db.createObjectStore(LOCAL_FILES_STORE, {keyPath: 'id'});
}
if (!db.objectStoreNames.contains(META_STORE)) {
db.createObjectStore(META_STORE);
}
};
request.onsuccess = () => {
const db = request.result;
db.onversionchange = () => {
db.close();
openPromise = null;
};
resolve(db);
};
request.onerror = () => reject(request.error ?? new Error('Failed to open theme library database'));
request.onblocked = () => reject(new Error('Theme library database upgrade is blocked by another window'));
});
promise.catch(() => {
if (openPromise === promise) {
openPromise = null;
}
});
openPromise = promise;
return promise;
}
async function withReadonlyDb<T>(
name: ThemeLibraryTableName,
operation: (store: IDBObjectStore) => Promise<T>,
): Promise<T> {
const db = await getDatabase();
const transaction = db.transaction(name, 'readonly');
const store = transaction.objectStore(name);
const done = transactionDone(transaction);
const result = await operation(store);
await done;
return result;
}
async function withReadwriteDb<T>(name: ThemeLibraryTableName, operation: (store: IDBObjectStore) => T): Promise<T> {
const db = await getDatabase();
const transaction = db.transaction(name, 'readwrite');
const done = transactionDone(transaction);
const result = operation(transaction.objectStore(name));
await done;
return result;
}
const DURABLE_THEMES_KEY = AppStorageKey.THEME_LIBRARY_THEMES;
const DURABLE_LOCAL_FILES_KEY = AppStorageKey.THEME_LIBRARY_LOCAL_FILES;
const DURABLE_ENABLED_IDS_KEY = AppStorageKey.THEME_LIBRARY_ENABLED_IDS;
const DURABLE_MIGRATION_KEY = AppStorageKey.THEME_LIBRARY_MIGRATED;
function readDurableList<T>(key: string, guard: (value: unknown) => value is T): Array<T> {
const raw = AppStorage.getItem(key);
if (raw == null) return [];
try {
const parsed: unknown = JSON.parse(raw);
return Array.isArray(parsed) ? parsed.filter(guard) : [];
} catch {
return [];
}
}
function writeDurableList<T>(key: string, value: ReadonlyArray<T>): void {
AppStorage.setItem(key, JSON.stringify([...value]));
}
function readDurableStringArray(value: string): Array<string> {
try {
const parsed: unknown = JSON.parse(value);
return Array.isArray(parsed) ? parsed.filter((item): item is string => typeof item === 'string') : [];
} catch {
return [];
}
}
let themeLibraryMigrationPromise: Promise<void> | null = null;
async function ensureThemeLibraryMigrated(): Promise<void> {
if (themeLibraryMigrationPromise == null) {
themeLibraryMigrationPromise = migrateThemeLibraryToDurableStore();
}
return themeLibraryMigrationPromise;
}
async function migrateThemeLibraryToDurableStore(): Promise<void> {
if (AppStorage.getItem(DURABLE_MIGRATION_KEY) === '1') return;
try {
const [legacyThemes, legacyLocalFiles, legacyEnabledIds] = await Promise.all([
withReadonlyDb(THEMES_STORE, (store) => requestToPromise(store.getAll())).then((result) =>
result.filter(isThemeLibraryTheme),
),
withReadonlyDb(LOCAL_FILES_STORE, (store) => requestToPromise(store.getAll())).then((result) =>
result.filter(isThemeLibraryLocalFileReference),
),
withReadonlyDb(META_STORE, (store) => requestToPromise(store.get(ENABLED_THEME_IDS_KEY))).then((result) =>
Array.isArray(result) ? result.filter((value): value is string => typeof value === 'string') : [],
),
]);
if (legacyThemes.length > 0) writeDurableList(DURABLE_THEMES_KEY, legacyThemes);
if (legacyLocalFiles.length > 0) writeDurableList(DURABLE_LOCAL_FILES_KEY, legacyLocalFiles);
if (legacyEnabledIds.length > 0) {
AppStorage.setItem(DURABLE_ENABLED_IDS_KEY, JSON.stringify(legacyEnabledIds));
}
} catch {}
AppStorage.setItem(DURABLE_MIGRATION_KEY, '1');
}
export async function listThemeLibraryThemes(): Promise<Array<ThemeLibraryTheme>> {
await ensureThemeLibraryMigrated();
return readDurableList(DURABLE_THEMES_KEY, isThemeLibraryTheme);
}
export async function saveThemeLibraryTheme(theme: ThemeLibraryTheme): Promise<void> {
await ensureThemeLibraryMigrated();
const themes = readDurableList(DURABLE_THEMES_KEY, isThemeLibraryTheme);
writeDurableList(DURABLE_THEMES_KEY, [...themes.filter((existing) => existing.id !== theme.id), theme]);
}
export async function updateThemeLibraryThemes(
select: (theme: ThemeLibraryTheme) => boolean,
update: (theme: ThemeLibraryTheme) => ThemeLibraryTheme | null,
): Promise<{themes: Array<ThemeLibraryTheme>; written: boolean}> {
await ensureThemeLibraryMigrated();
const result: {themes: Array<ThemeLibraryTheme>; written: boolean} = {themes: [], written: false};
const stored = readDurableList(DURABLE_THEMES_KEY, isThemeLibraryTheme);
const next = stored.map((theme) => {
if (!select(theme)) return theme;
const updated = update(theme);
if (updated) result.written = true;
result.themes.push(updated ?? theme);
return updated ?? theme;
});
if (result.written) writeDurableList(DURABLE_THEMES_KEY, next);
return result;
}
export async function applyThemeLibraryThemeChanges(
upserts: ReadonlyArray<ThemeLibraryTheme>,
removedIds: ReadonlySet<string>,
): Promise<void> {
await ensureThemeLibraryMigrated();
const upsertIds = new Set(upserts.map((theme) => theme.id));
const themes = readDurableList(DURABLE_THEMES_KEY, isThemeLibraryTheme);
writeDurableList(DURABLE_THEMES_KEY, [
...themes.filter((existing) => !upsertIds.has(existing.id) && !removedIds.has(existing.id)),
...upserts,
]);
}
export function getThemeLibraryFolders(): Array<string> {
const raw = AppStorage.getItem(AppStorageKey.THEME_LIBRARY_FOLDERS);
return raw == null ? [] : readDurableStringArray(raw);
}
export function setThemeLibraryFolders(folders: ReadonlyArray<string>): void {
if (folders.length === 0) {
AppStorage.removeItem(AppStorageKey.THEME_LIBRARY_FOLDERS);
return;
}
AppStorage.setItem(AppStorageKey.THEME_LIBRARY_FOLDERS, JSON.stringify([...folders]));
}
export async function deleteThemeLibraryTheme(id: string): Promise<void> {
await ensureThemeLibraryMigrated();
const themes = readDurableList(DURABLE_THEMES_KEY, isThemeLibraryTheme);
writeDurableList(
DURABLE_THEMES_KEY,
themes.filter((existing) => existing.id !== id),
);
}
export async function clearThemeLibraryThemes(): Promise<void> {
AppStorage.removeItem(DURABLE_THEMES_KEY);
}
export async function listThemeLibraryAssets(): Promise<Array<ThemeLibraryAsset>> {
const result = await withReadonlyDb(ASSETS_STORE, (store) => requestToPromise(store.getAll()));
return result.filter(isThemeLibraryAsset);
}
export async function saveThemeLibraryAsset(asset: ThemeLibraryAsset): Promise<void> {
await withReadwriteDb(ASSETS_STORE, (store) => {
store.put(asset);
});
}
export async function deleteThemeLibraryAsset(id: string): Promise<void> {
await withReadwriteDb(ASSETS_STORE, (store) => {
store.delete(id);
});
}
export async function clearThemeLibraryAssets(): Promise<void> {
await withReadwriteDb(ASSETS_STORE, (store) => {
store.clear();
});
}
export async function listThemeLibraryLocalFiles(): Promise<Array<ThemeLibraryLocalFileReference>> {
await ensureThemeLibraryMigrated();
return readDurableList(DURABLE_LOCAL_FILES_KEY, isThemeLibraryLocalFileReference);
}
export async function saveThemeLibraryLocalFile(file: ThemeLibraryLocalFileReference): Promise<void> {
await ensureThemeLibraryMigrated();
const files = readDurableList(DURABLE_LOCAL_FILES_KEY, isThemeLibraryLocalFileReference);
writeDurableList(DURABLE_LOCAL_FILES_KEY, [...files.filter((existing) => existing.id !== file.id), file]);
}
export async function deleteThemeLibraryLocalFile(id: string): Promise<void> {
await ensureThemeLibraryMigrated();
const files = readDurableList(DURABLE_LOCAL_FILES_KEY, isThemeLibraryLocalFileReference);
writeDurableList(
DURABLE_LOCAL_FILES_KEY,
files.filter((existing) => existing.id !== id),
);
}
export async function clearThemeLibraryLocalFiles(): Promise<void> {
AppStorage.removeItem(DURABLE_LOCAL_FILES_KEY);
}
export async function getEnabledThemeIds(): Promise<Array<string>> {
await ensureThemeLibraryMigrated();
const raw = AppStorage.getItem(DURABLE_ENABLED_IDS_KEY);
return raw == null ? [] : readDurableStringArray(raw);
}
export async function setEnabledThemeIds(themeIds: ReadonlyArray<string>): Promise<void> {
await ensureThemeLibraryMigrated();
AppStorage.setItem(DURABLE_ENABLED_IDS_KEY, JSON.stringify([...themeIds]));
}
export function getAccountEnabledThemeIds(): Array<string> {
const raw = AppStorage.getItem(AppStorageKey.THEME_LIBRARY_ACCOUNT_ENABLED_IDS);
return raw == null ? [] : readDurableStringArray(raw);
}
export function setAccountEnabledThemeIds(themeIds: ReadonlyArray<string>): void {
AppStorage.setItem(AppStorageKey.THEME_LIBRARY_ACCOUNT_ENABLED_IDS, JSON.stringify([...themeIds]));
}
export async function clearThemeLibraryMeta(): Promise<void> {
AppStorage.removeItem(DURABLE_ENABLED_IDS_KEY);
}