640 lines
18 KiB
JavaScript
Executable file
640 lines
18 KiB
JavaScript
Executable file
var Utils = require("./util");
|
|
var fs = Utils.FileSystem.require(),
|
|
pth = require("path");
|
|
|
|
fs.existsSync = fs.existsSync || pth.existsSync;
|
|
|
|
var ZipEntry = require("./zipEntry"),
|
|
ZipFile = require("./zipFile");
|
|
|
|
var isWin = /^win/.test(process.platform);
|
|
|
|
|
|
module.exports = function (/**String*/input) {
|
|
var _zip = undefined,
|
|
_filename = "";
|
|
|
|
if (input && typeof input === "string") { // load zip file
|
|
if (fs.existsSync(input)) {
|
|
_filename = input;
|
|
_zip = new ZipFile(input, Utils.Constants.FILE);
|
|
} else {
|
|
throw new Error(Utils.Errors.INVALID_FILENAME);
|
|
}
|
|
} else if (input && Buffer.isBuffer(input)) { // load buffer
|
|
_zip = new ZipFile(input, Utils.Constants.BUFFER);
|
|
} else { // create new zip file
|
|
_zip = new ZipFile(null, Utils.Constants.NONE);
|
|
}
|
|
|
|
function sanitize(prefix, name) {
|
|
prefix = pth.resolve(pth.normalize(prefix));
|
|
var parts = name.split('/');
|
|
for (var i = 0, l = parts.length; i < l; i++) {
|
|
var path = pth.normalize(pth.join(prefix, parts.slice(i, l).join(pth.sep)));
|
|
if (path.indexOf(prefix) === 0) {
|
|
return path;
|
|
}
|
|
}
|
|
return pth.normalize(pth.join(prefix, pth.basename(name)));
|
|
}
|
|
|
|
function getEntry(/**Object*/entry) {
|
|
if (entry && _zip) {
|
|
var item;
|
|
// If entry was given as a file name
|
|
if (typeof entry === "string")
|
|
item = _zip.getEntry(entry);
|
|
// if entry was given as a ZipEntry object
|
|
if (typeof entry === "object" && typeof entry.entryName !== "undefined" && typeof entry.header !== "undefined")
|
|
item = _zip.getEntry(entry.entryName);
|
|
|
|
if (item) {
|
|
return item;
|
|
}
|
|
}
|
|
return null;
|
|
}
|
|
|
|
return {
|
|
/**
|
|
* Extracts the given entry from the archive and returns the content as a Buffer object
|
|
* @param entry ZipEntry object or String with the full path of the entry
|
|
*
|
|
* @return Buffer or Null in case of error
|
|
*/
|
|
readFile: function (/**Object*/entry) {
|
|
var item = getEntry(entry);
|
|
return item && item.getData() || null;
|
|
},
|
|
|
|
/**
|
|
* Asynchronous readFile
|
|
* @param entry ZipEntry object or String with the full path of the entry
|
|
* @param callback
|
|
*
|
|
* @return Buffer or Null in case of error
|
|
*/
|
|
readFileAsync: function (/**Object*/entry, /**Function*/callback) {
|
|
var item = getEntry(entry);
|
|
if (item) {
|
|
item.getDataAsync(callback);
|
|
} else {
|
|
callback(null, "getEntry failed for:" + entry)
|
|
}
|
|
},
|
|
|
|
/**
|
|
* Extracts the given entry from the archive and returns the content as plain text in the given encoding
|
|
* @param entry ZipEntry object or String with the full path of the entry
|
|
* @param encoding Optional. If no encoding is specified utf8 is used
|
|
*
|
|
* @return String
|
|
*/
|
|
readAsText: function (/**Object*/entry, /**String=*/encoding) {
|
|
var item = getEntry(entry);
|
|
if (item) {
|
|
var data = item.getData();
|
|
if (data && data.length) {
|
|
return data.toString(encoding || "utf8");
|
|
}
|
|
}
|
|
return "";
|
|
},
|
|
|
|
/**
|
|
* Asynchronous readAsText
|
|
* @param entry ZipEntry object or String with the full path of the entry
|
|
* @param callback
|
|
* @param encoding Optional. If no encoding is specified utf8 is used
|
|
*
|
|
* @return String
|
|
*/
|
|
readAsTextAsync: function (/**Object*/entry, /**Function*/callback, /**String=*/encoding) {
|
|
var item = getEntry(entry);
|
|
if (item) {
|
|
item.getDataAsync(function (data, err) {
|
|
if (err) {
|
|
callback(data, err);
|
|
return;
|
|
}
|
|
|
|
if (data && data.length) {
|
|
callback(data.toString(encoding || "utf8"));
|
|
} else {
|
|
callback("");
|
|
}
|
|
})
|
|
} else {
|
|
callback("");
|
|
}
|
|
},
|
|
|
|
/**
|
|
* Remove the entry from the file or the entry and all it's nested directories and files if the given entry is a directory
|
|
*
|
|
* @param entry
|
|
*/
|
|
deleteFile: function (/**Object*/entry) { // @TODO: test deleteFile
|
|
var item = getEntry(entry);
|
|
if (item) {
|
|
_zip.deleteEntry(item.entryName);
|
|
}
|
|
},
|
|
|
|
/**
|
|
* Adds a comment to the zip. The zip must be rewritten after adding the comment.
|
|
*
|
|
* @param comment
|
|
*/
|
|
addZipComment: function (/**String*/comment) { // @TODO: test addZipComment
|
|
_zip.comment = comment;
|
|
},
|
|
|
|
/**
|
|
* Returns the zip comment
|
|
*
|
|
* @return String
|
|
*/
|
|
getZipComment: function () {
|
|
return _zip.comment || '';
|
|
},
|
|
|
|
/**
|
|
* Adds a comment to a specified zipEntry. The zip must be rewritten after adding the comment
|
|
* The comment cannot exceed 65535 characters in length
|
|
*
|
|
* @param entry
|
|
* @param comment
|
|
*/
|
|
addZipEntryComment: function (/**Object*/entry, /**String*/comment) {
|
|
var item = getEntry(entry);
|
|
if (item) {
|
|
item.comment = comment;
|
|
}
|
|
},
|
|
|
|
/**
|
|
* Returns the comment of the specified entry
|
|
*
|
|
* @param entry
|
|
* @return String
|
|
*/
|
|
getZipEntryComment: function (/**Object*/entry) {
|
|
var item = getEntry(entry);
|
|
if (item) {
|
|
return item.comment || '';
|
|
}
|
|
return ''
|
|
},
|
|
|
|
/**
|
|
* Updates the content of an existing entry inside the archive. The zip must be rewritten after updating the content
|
|
*
|
|
* @param entry
|
|
* @param content
|
|
*/
|
|
updateFile: function (/**Object*/entry, /**Buffer*/content) {
|
|
var item = getEntry(entry);
|
|
if (item) {
|
|
item.setData(content);
|
|
}
|
|
},
|
|
|
|
/**
|
|
* Adds a file from the disk to the archive
|
|
*
|
|
* @param localPath File to add to zip
|
|
* @param zipPath Optional path inside the zip
|
|
* @param zipName Optional name for the file
|
|
*/
|
|
addLocalFile: function (/**String*/localPath, /**String=*/zipPath, /**String=*/zipName) {
|
|
if (fs.existsSync(localPath)) {
|
|
if (zipPath) {
|
|
zipPath = zipPath.split("\\").join("/");
|
|
if (zipPath.charAt(zipPath.length - 1) !== "/") {
|
|
zipPath += "/";
|
|
}
|
|
} else {
|
|
zipPath = "";
|
|
}
|
|
var p = localPath.split("\\").join("/").split("/").pop();
|
|
|
|
if (zipName) {
|
|
this.addFile(zipPath + zipName, fs.readFileSync(localPath), "", 0)
|
|
} else {
|
|
this.addFile(zipPath + p, fs.readFileSync(localPath), "", 0)
|
|
}
|
|
} else {
|
|
throw new Error(Utils.Errors.FILE_NOT_FOUND.replace("%s", localPath));
|
|
}
|
|
},
|
|
|
|
/**
|
|
* Adds a local directory and all its nested files and directories to the archive
|
|
*
|
|
* @param localPath
|
|
* @param zipPath optional path inside zip
|
|
* @param filter optional RegExp or Function if files match will
|
|
* be included.
|
|
*/
|
|
addLocalFolder: function (/**String*/localPath, /**String=*/zipPath, /**=RegExp|Function*/filter) {
|
|
if (filter === undefined) {
|
|
filter = function () {
|
|
return true;
|
|
};
|
|
} else if (filter instanceof RegExp) {
|
|
filter = function (filter) {
|
|
return function (filename) {
|
|
return filter.test(filename);
|
|
}
|
|
}(filter);
|
|
}
|
|
|
|
if (zipPath) {
|
|
zipPath = zipPath.split("\\").join("/");
|
|
if (zipPath.charAt(zipPath.length - 1) !== "/") {
|
|
zipPath += "/";
|
|
}
|
|
} else {
|
|
zipPath = "";
|
|
}
|
|
// normalize the path first
|
|
localPath = pth.normalize(localPath);
|
|
localPath = localPath.split("\\").join("/"); //windows fix
|
|
if (localPath.charAt(localPath.length - 1) !== "/")
|
|
localPath += "/";
|
|
|
|
if (fs.existsSync(localPath)) {
|
|
|
|
var items = Utils.findFiles(localPath),
|
|
self = this;
|
|
|
|
if (items.length) {
|
|
items.forEach(function (path) {
|
|
var p = path.split("\\").join("/").replace(new RegExp(localPath.replace(/(\(|\)|\$)/g, '\\$1'), 'i'), ""); //windows fix
|
|
if (filter(p)) {
|
|
if (p.charAt(p.length - 1) !== "/") {
|
|
self.addFile(zipPath + p, fs.readFileSync(path), "", 0)
|
|
} else {
|
|
self.addFile(zipPath + p, Buffer.alloc(0), "", 0)
|
|
}
|
|
}
|
|
});
|
|
}
|
|
} else {
|
|
throw new Error(Utils.Errors.FILE_NOT_FOUND.replace("%s", localPath));
|
|
}
|
|
},
|
|
|
|
/**
|
|
* Asynchronous addLocalFile
|
|
* @param localPath
|
|
* @param callback
|
|
* @param zipPath optional path inside zip
|
|
* @param filter optional RegExp or Function if files match will
|
|
* be included.
|
|
*/
|
|
addLocalFolderAsync: function (/*String*/localPath, /*Function*/callback, /*String*/zipPath, /*RegExp|Function*/filter) {
|
|
if (filter === undefined) {
|
|
filter = function () {
|
|
return true;
|
|
};
|
|
} else if (filter instanceof RegExp) {
|
|
filter = function (filter) {
|
|
return function (filename) {
|
|
return filter.test(filename);
|
|
}
|
|
}(filter);
|
|
}
|
|
|
|
if (zipPath) {
|
|
zipPath = zipPath.split("\\").join("/");
|
|
if (zipPath.charAt(zipPath.length - 1) !== "/") {
|
|
zipPath += "/";
|
|
}
|
|
} else {
|
|
zipPath = "";
|
|
}
|
|
// normalize the path first
|
|
localPath = pth.normalize(localPath);
|
|
localPath = localPath.split("\\").join("/"); //windows fix
|
|
if (localPath.charAt(localPath.length - 1) !== "/")
|
|
localPath += "/";
|
|
|
|
var self = this;
|
|
fs.open(localPath, 'r', function (err, fd) {
|
|
if (err && err.code === 'ENOENT') {
|
|
callback(undefined, Utils.Errors.FILE_NOT_FOUND.replace("%s", localPath));
|
|
} else if (err) {
|
|
callback(undefined, err);
|
|
} else {
|
|
var items = Utils.findFiles(localPath);
|
|
var i = -1;
|
|
|
|
var next = function () {
|
|
i += 1;
|
|
if (i < items.length) {
|
|
var p = items[i].split("\\").join("/").replace(new RegExp(localPath.replace(/(\(|\))/g, '\\$1'), 'i'), ""); //windows fix
|
|
p = p.normalize('NFD').replace(/[\u0300-\u036f]/g, '').replace(/[^\x20-\x7E]/g, '') // accent fix
|
|
if (filter(p)) {
|
|
if (p.charAt(p.length - 1) !== "/") {
|
|
fs.readFile(items[i], function (err, data) {
|
|
if (err) {
|
|
callback(undefined, err);
|
|
} else {
|
|
self.addFile(zipPath + p, data, '', 0);
|
|
next();
|
|
}
|
|
})
|
|
} else {
|
|
self.addFile(zipPath + p, Buffer.alloc(0), "", 0);
|
|
next();
|
|
}
|
|
} else {
|
|
next();
|
|
}
|
|
|
|
} else {
|
|
callback(true, undefined);
|
|
}
|
|
}
|
|
|
|
next();
|
|
}
|
|
});
|
|
},
|
|
|
|
/**
|
|
* Allows you to create a entry (file or directory) in the zip file.
|
|
* If you want to create a directory the entryName must end in / and a null buffer should be provided.
|
|
* Comment and attributes are optional
|
|
*
|
|
* @param entryName
|
|
* @param content
|
|
* @param comment
|
|
* @param attr
|
|
*/
|
|
addFile: function (/**String*/entryName, /**Buffer*/content, /**String*/comment, /**Number*/attr) {
|
|
var entry = new ZipEntry();
|
|
entry.entryName = entryName;
|
|
entry.comment = comment || "";
|
|
|
|
if (!attr) {
|
|
if (entry.isDirectory) {
|
|
attr = (0o40755 << 16) | 0x10; // (permissions drwxr-xr-x) + (MS-DOS directory flag)
|
|
} else {
|
|
attr = 0o644 << 16; // permissions -r-wr--r--
|
|
}
|
|
}
|
|
|
|
entry.attr = attr;
|
|
|
|
entry.setData(content);
|
|
_zip.setEntry(entry);
|
|
},
|
|
|
|
/**
|
|
* Returns an array of ZipEntry objects representing the files and folders inside the archive
|
|
*
|
|
* @return Array
|
|
*/
|
|
getEntries: function () {
|
|
if (_zip) {
|
|
return _zip.entries;
|
|
} else {
|
|
return [];
|
|
}
|
|
},
|
|
|
|
/**
|
|
* Returns a ZipEntry object representing the file or folder specified by ``name``.
|
|
*
|
|
* @param name
|
|
* @return ZipEntry
|
|
*/
|
|
getEntry: function (/**String*/name) {
|
|
return getEntry(name);
|
|
},
|
|
|
|
getEntryCount: function() {
|
|
return _zip.getEntryCount();
|
|
},
|
|
|
|
forEach: function(callback) {
|
|
return _zip.forEach(callback);
|
|
},
|
|
|
|
/**
|
|
* Extracts the given entry to the given targetPath
|
|
* If the entry is a directory inside the archive, the entire directory and it's subdirectories will be extracted
|
|
*
|
|
* @param entry ZipEntry object or String with the full path of the entry
|
|
* @param targetPath Target folder where to write the file
|
|
* @param maintainEntryPath If maintainEntryPath is true and the entry is inside a folder, the entry folder
|
|
* will be created in targetPath as well. Default is TRUE
|
|
* @param overwrite If the file already exists at the target path, the file will be overwriten if this is true.
|
|
* Default is FALSE
|
|
*
|
|
* @return Boolean
|
|
*/
|
|
extractEntryTo: function (/**Object*/entry, /**String*/targetPath, /**Boolean*/maintainEntryPath, /**Boolean*/overwrite) {
|
|
overwrite = overwrite || false;
|
|
maintainEntryPath = typeof maintainEntryPath === "undefined" ? true : maintainEntryPath;
|
|
|
|
var item = getEntry(entry);
|
|
if (!item) {
|
|
throw new Error(Utils.Errors.NO_ENTRY);
|
|
}
|
|
|
|
var entryName = item.entryName;
|
|
|
|
var target = sanitize(targetPath, maintainEntryPath ? entryName : pth.basename(entryName));
|
|
|
|
if (item.isDirectory) {
|
|
target = pth.resolve(target, "..");
|
|
var children = _zip.getEntryChildren(item);
|
|
children.forEach(function (child) {
|
|
if (child.isDirectory) return;
|
|
var content = child.getData();
|
|
if (!content) {
|
|
throw new Error(Utils.Errors.CANT_EXTRACT_FILE);
|
|
}
|
|
var childName = sanitize(targetPath, maintainEntryPath ? child.entryName : pth.basename(child.entryName));
|
|
|
|
Utils.writeFileTo(childName, content, overwrite);
|
|
});
|
|
return true;
|
|
}
|
|
|
|
var content = item.getData();
|
|
if (!content) throw new Error(Utils.Errors.CANT_EXTRACT_FILE);
|
|
|
|
if (fs.existsSync(target) && !overwrite) {
|
|
throw new Error(Utils.Errors.CANT_OVERRIDE);
|
|
}
|
|
Utils.writeFileTo(target, content, overwrite);
|
|
|
|
return true;
|
|
},
|
|
|
|
/**
|
|
* Test the archive
|
|
*
|
|
*/
|
|
test: function () {
|
|
if (!_zip) {
|
|
return false;
|
|
}
|
|
|
|
for (var entry in _zip.entries) {
|
|
try {
|
|
if (entry.isDirectory) {
|
|
continue;
|
|
}
|
|
var content = _zip.entries[entry].getData();
|
|
if (!content) {
|
|
return false;
|
|
}
|
|
} catch (err) {
|
|
return false;
|
|
}
|
|
}
|
|
return true;
|
|
},
|
|
|
|
/**
|
|
* Extracts the entire archive to the given location
|
|
*
|
|
* @param targetPath Target location
|
|
* @param overwrite If the file already exists at the target path, the file will be overwriten if this is true.
|
|
* Default is FALSE
|
|
*/
|
|
extractAllTo: function (/**String*/targetPath, /**Boolean*/overwrite) {
|
|
overwrite = overwrite || false;
|
|
if (!_zip) {
|
|
throw new Error(Utils.Errors.NO_ZIP);
|
|
}
|
|
_zip.entries.forEach(function (entry) {
|
|
var entryName = sanitize(targetPath, entry.entryName.toString());
|
|
if (entry.isDirectory) {
|
|
Utils.makeDir(entryName);
|
|
return;
|
|
}
|
|
var content = entry.getData();
|
|
if (!content) {
|
|
throw new Error(Utils.Errors.CANT_EXTRACT_FILE);
|
|
}
|
|
Utils.writeFileTo(entryName, content, overwrite);
|
|
try {
|
|
fs.utimesSync(entryName, entry.header.time, entry.header.time)
|
|
} catch (err) {
|
|
throw new Error(Utils.Errors.CANT_EXTRACT_FILE);
|
|
}
|
|
})
|
|
},
|
|
|
|
/**
|
|
* Asynchronous extractAllTo
|
|
*
|
|
* @param targetPath Target location
|
|
* @param overwrite If the file already exists at the target path, the file will be overwriten if this is true.
|
|
* Default is FALSE
|
|
* @param callback
|
|
*/
|
|
extractAllToAsync: function (/**String*/targetPath, /**Boolean*/overwrite, /**Function*/callback) {
|
|
if (!callback) {
|
|
callback = function() {}
|
|
}
|
|
overwrite = overwrite || false;
|
|
if (!_zip) {
|
|
callback(new Error(Utils.Errors.NO_ZIP));
|
|
return;
|
|
}
|
|
|
|
var entries = _zip.entries;
|
|
var i = entries.length;
|
|
entries.forEach(function (entry) {
|
|
if (i <= 0) return; // Had an error already
|
|
|
|
var entryName = pth.normalize(entry.entryName.toString());
|
|
|
|
if (entry.isDirectory) {
|
|
Utils.makeDir(sanitize(targetPath, entryName));
|
|
if (--i === 0)
|
|
callback(undefined);
|
|
return;
|
|
}
|
|
entry.getDataAsync(function (content, err) {
|
|
if (i <= 0) return;
|
|
if (err) {
|
|
callback(new Error(err));
|
|
return;
|
|
}
|
|
if (!content) {
|
|
i = 0;
|
|
callback(new Error(Utils.Errors.CANT_EXTRACT_FILE));
|
|
return;
|
|
}
|
|
|
|
Utils.writeFileToAsync(sanitize(targetPath, entryName), content, overwrite, function (succ) {
|
|
try {
|
|
fs.utimesSync(pth.resolve(targetPath, entryName), entry.header.time, entry.header.time);
|
|
} catch (err) {
|
|
callback(new Error('Unable to set utimes'));
|
|
}
|
|
if (i <= 0) return;
|
|
if (!succ) {
|
|
i = 0;
|
|
callback(new Error('Unable to write'));
|
|
return;
|
|
}
|
|
if (--i === 0)
|
|
callback(undefined);
|
|
});
|
|
});
|
|
})
|
|
},
|
|
|
|
/**
|
|
* Writes the newly created zip file to disk at the specified location or if a zip was opened and no ``targetFileName`` is provided, it will overwrite the opened zip
|
|
*
|
|
* @param targetFileName
|
|
* @param callback
|
|
*/
|
|
writeZip: function (/**String*/targetFileName, /**Function*/callback) {
|
|
if (arguments.length === 1) {
|
|
if (typeof targetFileName === "function") {
|
|
callback = targetFileName;
|
|
targetFileName = "";
|
|
}
|
|
}
|
|
|
|
if (!targetFileName && _filename) {
|
|
targetFileName = _filename;
|
|
}
|
|
if (!targetFileName) return;
|
|
|
|
var zipData = _zip.compressToBuffer();
|
|
if (zipData) {
|
|
var ok = Utils.writeFileTo(targetFileName, zipData, true);
|
|
if (typeof callback === 'function') callback(!ok ? new Error("failed") : null, "");
|
|
}
|
|
},
|
|
|
|
/**
|
|
* Returns the content of the entire zip file as a Buffer object
|
|
*
|
|
* @return Buffer
|
|
*/
|
|
toBuffer: function (/**Function=*/onSuccess, /**Function=*/onFail, /**Function=*/onItemStart, /**Function=*/onItemEnd) {
|
|
this.valueOf = 2;
|
|
if (typeof onSuccess === "function") {
|
|
_zip.toAsyncBuffer(onSuccess, onFail, onItemStart, onItemEnd);
|
|
return null;
|
|
}
|
|
return _zip.compressToBuffer()
|
|
}
|
|
}
|
|
};
|