// Copyright 2018 Signal Messenger, LLC // SPDX-License-Identifier: AGPL-3.0-only import { join, relative, normalize } from 'path'; import fastGlob from 'fast-glob'; import glob from 'glob'; import pify from 'pify'; import fse from 'fs-extra'; import { map, isString } from 'lodash'; import normalizePath from 'normalize-path'; import { isPathInside } from '../ts/util/isPathInside'; const PATH = 'attachments.noindex'; const AVATAR_PATH = 'avatars.noindex'; const BADGES_PATH = 'badges.noindex'; const STICKER_PATH = 'stickers.noindex'; const TEMP_PATH = 'temp'; const UPDATE_CACHE_PATH = 'update-cache'; const DRAFT_PATH = 'drafts.noindex'; const CACHED_PATHS = new Map(); const createPathGetter = (subpath: string) => (userDataPath: string): string => { if (!isString(userDataPath)) { throw new TypeError("'userDataPath' must be a string"); } const naivePath = join(userDataPath, subpath); const cached = CACHED_PATHS.get(naivePath); if (cached) { return cached; } let result = naivePath; if (fse.pathExistsSync(naivePath)) { result = fse.realpathSync(naivePath); } CACHED_PATHS.set(naivePath, result); return result; }; export const getAvatarsPath = createPathGetter(AVATAR_PATH); export const getBadgesPath = createPathGetter(BADGES_PATH); export const getDraftPath = createPathGetter(DRAFT_PATH); export const getPath = createPathGetter(PATH); export const getStickersPath = createPathGetter(STICKER_PATH); export const getTempPath = createPathGetter(TEMP_PATH); export const getUpdateCachePath = createPathGetter(UPDATE_CACHE_PATH); export const createDeleter = ( root: string ): ((relativePath: string) => Promise) => { if (!isString(root)) { throw new TypeError("'root' must be a path"); } return async (relativePath: string): Promise => { if (!isString(relativePath)) { throw new TypeError("'relativePath' must be a string"); } const absolutePath = join(root, relativePath); const normalized = normalize(absolutePath); if (!isPathInside(normalized, root)) { throw new Error('Invalid relative path'); } await fse.remove(absolutePath); }; }; export const getAllAttachments = async ( userDataPath: string ): Promise> => { const dir = getPath(userDataPath); const pattern = normalizePath(join(dir, '**', '*')); const files = await fastGlob(pattern, { onlyFiles: true }); return map(files, file => relative(dir, file)); }; const getAllBadgeImageFiles = async ( userDataPath: string ): Promise> => { const dir = getBadgesPath(userDataPath); const pattern = normalizePath(join(dir, '**', '*')); const files = await fastGlob(pattern, { onlyFiles: true }); return map(files, file => relative(dir, file)); }; export const getAllStickers = async ( userDataPath: string ): Promise> => { const dir = getStickersPath(userDataPath); const pattern = normalizePath(join(dir, '**', '*')); const files = await fastGlob(pattern, { onlyFiles: true }); return map(files, file => relative(dir, file)); }; export const getAllDraftAttachments = async ( userDataPath: string ): Promise> => { const dir = getDraftPath(userDataPath); const pattern = normalizePath(join(dir, '**', '*')); const files = await fastGlob(pattern, { onlyFiles: true }); return map(files, file => relative(dir, file)); }; export const getBuiltInImages = async (): Promise> => { const dir = join(__dirname, '../images'); const pattern = join(dir, '**', '*.svg'); // Note: we cannot use fast-glob here because, inside of .asar files, readdir will not // honor the withFileTypes flag: https://github.com/electron/electron/issues/19074 const files = await pify(glob)(pattern, { nodir: true }); return map(files, file => relative(dir, file)); }; export const clearTempPath = (userDataPath: string): Promise => { const tempPath = getTempPath(userDataPath); return fse.emptyDir(tempPath); }; export const deleteAll = async ({ userDataPath, attachments, }: { userDataPath: string; attachments: ReadonlyArray; }): Promise => { const deleteFromDisk = createDeleter(getPath(userDataPath)); for (let index = 0, max = attachments.length; index < max; index += 1) { const file = attachments[index]; // eslint-disable-next-line no-await-in-loop await deleteFromDisk(file); } console.log(`deleteAll: deleted ${attachments.length} files`); }; export const deleteAllStickers = async ({ userDataPath, stickers, }: { userDataPath: string; stickers: ReadonlyArray; }): Promise => { const deleteFromDisk = createDeleter(getStickersPath(userDataPath)); for (let index = 0, max = stickers.length; index < max; index += 1) { const file = stickers[index]; // eslint-disable-next-line no-await-in-loop await deleteFromDisk(file); } console.log(`deleteAllStickers: deleted ${stickers.length} files`); }; export const deleteAllBadges = async ({ userDataPath, pathsToKeep, }: { userDataPath: string; pathsToKeep: Set; }): Promise => { const deleteFromDisk = createDeleter(getBadgesPath(userDataPath)); let filesDeleted = 0; for (const file of await getAllBadgeImageFiles(userDataPath)) { if (!pathsToKeep.has(file)) { // eslint-disable-next-line no-await-in-loop await deleteFromDisk(file); filesDeleted += 1; } } console.log(`deleteAllBadges: deleted ${filesDeleted} files`); }; export const deleteAllDraftAttachments = async ({ userDataPath, attachments, }: { userDataPath: string; attachments: ReadonlyArray; }): Promise => { const deleteFromDisk = createDeleter(getDraftPath(userDataPath)); for (let index = 0, max = attachments.length; index < max; index += 1) { const file = attachments[index]; // eslint-disable-next-line no-await-in-loop await deleteFromDisk(file); } console.log(`deleteAllDraftAttachments: deleted ${attachments.length} files`); };