Revision control
Copy as Markdown
Other Tools
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
const lazy = {};
ChromeUtils.defineESModuleGetters(lazy, {
});
// No need to backup those paths, they are not used when importing.
const IGNORE_PATHS = [
"cache2",
"chrome_debugger_profile",
"crashes",
"datareporting",
"extensions",
"extension-store",
"logs",
"lock",
"minidumps",
"parent.lock",
"shader-cache",
"saved-telemetry-pings",
"security_state",
"storage",
"xulstore",
];
/**
* A module to export the current profile to a zip file.
*/
export class ProfileExporter {
_logger = console.createInstance({
prefix: "mail.export",
maxLogLevel: "Warn",
maxLogLevelPref: "mail.export.loglevel",
});
/**
* Callback for progress updates.
*/
onProgress = () => {};
/**
* Export the current profile to the specified target zip file.
*
* @param {nsIFile} targetFile - A target zip file to write to.
*/
async startExport(targetFile) {
const zipW = Components.Constructor(
"@mozilla.org/zipwriter;1",
"nsIZipWriter"
)();
// MODE_WRONLY (0x02) and MODE_CREATE (0x08)
zipW.open(targetFile, 0x02 | 0x08);
const profileDir = Services.dirsvc.get("ProfD", Ci.nsIFile);
const rootPathCount = PathUtils.split(profileDir.parent.path).length;
const zipEntryMap = new Map();
await this._collectFilesToZip(zipEntryMap, rootPathCount, profileDir);
const totalEntries = zipEntryMap.size;
let i = 0;
for (const [path, file] of zipEntryMap) {
try {
zipW.addEntryFile(
path,
0, // no compression, bigger file but much faster
file,
false
);
} catch (e) {
this._logger.error(`Failed to add ${path}`, e);
}
if (++i % 10 === 0) {
this.onProgress(i, totalEntries);
await new Promise(resolve => lazy.setTimeout(resolve));
}
}
this.onProgress(totalEntries, totalEntries);
zipW.close();
}
/**
* Recursively collect files to be zipped, save the entries into zipEntryMap.
*
* @param {Map<string, nsIFile>} zipEntryMap - Collection of files to be zipped.
* @param {number} rootPathCount - The count of rootPath parts.
* @param {nsIFile} folder - The folder to search for files to zip.
*/
async _collectFilesToZip(zipEntryMap, rootPathCount, folder) {
for (const file of folder.directoryEntries) {
if (!file.exists()) {
continue;
}
if (file.isDirectory()) {
await this._collectFilesToZip(zipEntryMap, rootPathCount, file);
} else {
// We don't want to include the rootPath part in the zip file.
const parts = PathUtils.split(file.path).slice(rootPathCount);
// Parts look like this: ["profile-default", "lock"].
if (IGNORE_PATHS.includes(parts[1])) {
continue;
}
// Path separator inside a zip file is always "/".
zipEntryMap.set(parts.join("/"), file);
}
}
}
}