Permalink
Browse files

Packaging

  • Loading branch information...
1 parent f3c8979 commit fac11e44763a0644b284646f4d79e39e21fc10f8 @janjongboom committed Dec 28, 2011
Showing with 404 additions and 29 deletions.
  1. +86 −14 README.md
  2. +1 −0 index.js
  3. +235 −0 janzip/janzip.js
  4. +53 −0 janzip/rollingbuffer.js
  5. +8 −0 package.json
  6. +21 −15 server.js
View
100 README.md
@@ -1,18 +1,90 @@
-# README for a newly created project.
+# node-native-zip
-There are a couple of things you should do first, before you can use all of Git's power:
+All the current ZIP solutions for node.js are wrappers around existing zip executables, spawning on demand.
+To all of you who rather have a native implementation of zip'ing in javascript there is node-native-zip.
+This package works with `Buffer` objects, which allows you to do complex in-memory stuff with the least
+amount of overhead.
- * Add a remote to this project: in the Cloud9 IDE command line, you can execute the following commands
- `git remote add [remote name] [remote url (eg. 'git@github.com:/ajaxorg/node_chat')]` [Enter]
- * Create new files inside your project
- * Add them to to Git by executing the following command
- `git add [file1, file2, file3, ...]` [Enter]
- * Create a commit which can be pushed to the remote you just added
- `git commit -m 'added new files'` [Enter]
- * Push the commit the remote
- `git push [remote name] master` [Enter]
+It has been inspired by [JSZip](https://github.com/Stuk/jszip).
-That's it! If this doesn't work for you, please visit the excellent resources from [Github.com](http://help.github.com) and the [Pro Git](http://http://progit.org/book/) book.
-If you can't find your answers there, feel free to ask us via Twitter (@cloud9ide), [mailing list](groups.google.com/group/cloud9-ide) or IRC (#cloud9ide on freenode).
+## How to install
-Happy coding!
+Via NPM:
+
+ npm install node-native-zip
+
+Via GIT:
+
+ git clone git://github.com/janjongboom/node-native-zip.git
+
+## How to use
+
+There are two ways to feed files into a new .zip file. Either by adding `Buffer` objects, or by adding
+an array of files.
+
+### Adding Buffer objects
+
+ var fs = require("fs");
+ var zip = require("node-native-zip");
+
+ var archive = new zip();
+
+ archive.add("hello.txt", new Buffer("Hello world", "utf8"));
+
+ var buffer = archive.toBuffer();
+ fs.writeFile("./test1.zip", buffer, function () {
+ console.log("Finished");
+ });
+
+### Adding files from the file system
+
+ var fs = require("fs");
+ var zip = require("node-native-zip");
+
+ var archive = new zip();
+
+ archive.addFiles([
+ { name: "moehah.txt", path: "./test/moehah.txt" },
+ { name: "images/suz.jpg", path: "./test/images.jpg" }
+ ], function () {
+ var buff = archive.toBuffer();
+
+ fs.writeFile("./test2.zip", buff, function () {
+ console.log("Finished");
+ });
+ }, function (err) {
+ console.log(err);
+ });
+
+## API Reference
+
+There are three API methods:
+
+* `add(name, data)`, the 'name' is the name within the .zip file. To create a folder structure, add '/'
+* `addFiles(files, onComplete, onError)`, where files is an array containing objects in the form ` { name: "name/in/zip.file", path: "file-system.path" } `
+* `toBuffer()`, creates a new buffer and writes the zip file to it
+
+## Compression?
+
+The library currently doesn't do any compression. It stores the files via STORE. Main reason is that the
+compression call is synchronous at the moment, so the thread will block during compression, something to
+avoid.
+However, it is possible to add compression methods by implementing the following interface.
+
+ module.exports = (function () {
+ return {
+ indicator : [ 0x00, 0x00 ],
+ compress : function (content) {
+ // content is a Buffer object.
+ // you have to return a new Buffer too.
+ }
+ };
+ }());
+
+The `indicator` is an array consisting of two bytes indicating the compression technology.
+For example: `[ 0x00, 0x00]` is STORE, `[ 0x08, 0x00]` is DEFLATE.
+
+The `compress` function is a method that transforms an incoming `Buffer` into a new one.
+
+The easiest to implement is probably deflate, because there is a [sample](https://github.com/Stuk/jszip/blob/master/jszip-deflate.js)
+in JSZip. You will only need to change the inner workings from string-based to Buffer-based.
View
1 index.js
@@ -0,0 +1 @@
+module.exports = require("./janzip/janzip");
View
235 janzip/janzip.js
@@ -0,0 +1,235 @@
+/**
+ * node.js zipping module
+ *
+ * (c) Jan Jongboom, 2011
+ */
+var RollingBuffer = require("./rollingbuffer");
+var fs = require("fs");
+
+var Zip = function () {
+ var _self = this;
+
+ // simple wrapper to keep some stuff private
+ var exp = (function () {
+
+ var files = [];
+
+ /**
+ * Get the date / time parts of the file header
+ * @param {date} A date object
+ */
+ function getDateTimeHeaders (date) {
+ var dosTime, dosDate;
+
+ dosTime = date.getHours();
+ dosTime = dosTime << 6;
+ dosTime = dosTime | date.getMinutes();
+ dosTime = dosTime << 5;
+ dosTime = dosTime | date.getSeconds() / 2;
+
+ dosDate = date.getFullYear() - 1980;
+ dosDate = dosDate << 4;
+ dosDate = dosDate | (date.getMonth() + 1);
+ dosDate = dosDate << 5;
+ dosDate = dosDate | date.getDate();
+
+ return {
+ date: dosDate,
+ time: dosTime
+ };
+ }
+
+ /**
+ * Simple sum function
+ */
+ function getTotalBufLength (arr) {
+ var sum = 0;
+
+ arr.forEach(function (f) { sum += f.length; });
+
+ return sum;
+ }
+
+ /**
+ * Generate a file header (as a buffer)
+ */
+ function getFileHeader (file, compressIndicator, compressedData) {
+ var dt = getDateTimeHeaders(new Date());
+
+ var header = new RollingBuffer(26);
+
+ // version + bit flag
+ writeBytes(header, [ 0x0A, 0x00, 0x00, 0x00 ]);
+ // compression method @todo multiple methods, this is STORE
+ writeBytes(header, compressIndicator);
+ // file time & date
+ header.writeInt16(dt.time);
+ header.writeInt16(dt.date);
+ // crc32
+ header.writeInt32(crc32(compressedData));
+ // compressed size
+ header.writeInt32(compressedData.length);
+ // uncompressed size
+ header.writeInt32(file.data.length);
+ // file name length
+ header.writeInt16(file.name.length);
+ // fill
+ writeBytes(header, [ 0x00, 0x00 ]);
+
+ return header;
+ }
+
+ /**
+ * Add a file to the current file
+ * @param {name} The name of the file (can include folder structure)
+ * @param {data} A buffer containing the data
+ */
+ function add (filename, data) {
+ files.push({ name: filename, data: data });
+ }
+
+ /**
+ * Add multiple files to the current archive.
+ * Pass in an array containing { name: "", path: "" }
+ */
+ function addFiles (filenames, onCompleted, onError) {
+ var counter = 0;
+ var callback = function () {
+ if (++counter === filenames.length) {
+ clearTimeout(expirationTimer);
+ onCompleted();
+ }
+ };
+
+ filenames.forEach(function (f) {
+ fs.readFile(f.path, function (err, data) {
+ if (err) {
+ onError(err);
+ }
+ else {
+ add (f.name, data);
+ }
+ callback();
+ });
+ });
+
+ // there is a 1 minute expiration timer running
+ var expirationTimer = setTimeout(function () {
+ onError("Timeout reached when adding files");
+ }, 60 * 1000);
+ }
+
+ /**
+ * Returns the ZIP archive as a buffer object
+ */
+ function toBuffer (zipMethod) {
+ zipMethod = zipMethod || store;
+
+ var fileBuffers = [], dirBuffers = [];
+ var fileOffset = 0;
+
+ files.map(function(file) {
+ var data = zipMethod.compress(file.data);
+ var fileHeader = getFileHeader(file, zipMethod.indicator, data);
+
+ // write files
+ var fileBuffer = new RollingBuffer(4 + fileHeader.length + file.name.length + data.length);
+ writeBytes(fileBuffer, [0x50, 0x4b, 0x03, 0x04]); // 4
+ fileBuffer.appendBuffer(fileHeader); // hmm...
+ fileBuffer.write(file.name, "ascii");
+ fileBuffer.appendBuffer(data);
+
+ // now create dir
+ var dirBuffer = new RollingBuffer(4 + 2 + fileHeader.length + 6 + 4 + 4 + file.name.length);
+ writeBytes(dirBuffer, [0x50, 0x4b, 0x01, 0x02]);
+ writeBytes(dirBuffer, [0x14, 0x00]);
+ dirBuffer.appendBuffer(fileHeader);
+ // comment length, disk start, file attributes
+ writeBytes(dirBuffer, [0x00, 0x00, 0x00, 0x00, 0x00, 0x00]);
+ // external file attributes, @todo
+ writeBytes(dirBuffer, [0x00, 0x00, 0x00, 0x00]);
+ // relative offset of local header
+ dirBuffer.writeInt32(fileOffset);
+ // file name
+ dirBuffer.write(file.name, "ascii");
+
+ // update offset
+ fileOffset += fileBuffer.length;
+
+ fileBuffers.push(fileBuffer);
+ dirBuffers.push(dirBuffer);
+ });
+
+ var totalDirLength = getTotalBufLength(dirBuffers);
+ var totalFileLength = getTotalBufLength(fileBuffers);
+
+ var dirEnd = new RollingBuffer(8 + 2 + 2 + 4 + 4 + 2);
+ writeBytes(dirEnd, [0x50, 0x4b, 0x05, 0x06, 0x00, 0x00, 0x00, 0x00]);
+ // total number of entries
+ dirEnd.writeInt16(fileBuffers.length);
+ dirEnd.writeInt16(fileBuffers.length);
+ // directory lengths
+ dirEnd.writeInt32(totalDirLength);
+ // file lengths
+ dirEnd.writeInt32(totalFileLength);
+ // and the end of file
+ writeBytes(dirEnd, [0x00, 0x00]);
+
+ var buffer = new RollingBuffer(totalFileLength + totalDirLength + dirEnd.length);
+ fileBuffers.forEach(function (b) { buffer.appendBuffer(b); });
+ dirBuffers.forEach(function (b) { buffer.appendBuffer(b); });
+ buffer.appendBuffer(dirEnd);
+
+ return buffer.getInternalBuffer();
+ }
+
+ return {
+ add: add,
+ addFiles: addFiles,
+ toBuffer: toBuffer
+ };
+
+ }());
+
+ // expand this with the functions that we just created
+ Object.keys(exp).forEach(function (k) { _self[k] = exp[k]; });
+};
+
+module.exports = Zip;
+
+// ====== Default zipping method ======
+var store = (function () {
+ return {
+ indicator : [ 0x00, 0x00 ],
+ compress : function (content) {
+ return content;
+ }
+ };
+}());
+
+// ====== Helper functions ======
+function crc32 (buf) {
+ if (!buf || !buf.length) {
+ return [ 0x00, 0x00, 0x00, 0x00 ];
+ }
+
+ var table = [ 0x00000000, 0x77073096, 0xEE0E612C, 0x990951BA, 0x076DC419, 0x706AF48F, 0xE963A535, 0x9E6495A3, 0x0EDB8832, 0x79DCB8A4, 0xE0D5E91E, 0x97D2D988, 0x09B64C2B, 0x7EB17CBD, 0xE7B82D07, 0x90BF1D91, 0x1DB71064, 0x6AB020F2, 0xF3B97148, 0x84BE41DE, 0x1ADAD47D, 0x6DDDE4EB, 0xF4D4B551, 0x83D385C7, 0x136C9856, 0x646BA8C0, 0xFD62F97A, 0x8A65C9EC, 0x14015C4F, 0x63066CD9, 0xFA0F3D63, 0x8D080DF5, 0x3B6E20C8, 0x4C69105E, 0xD56041E4, 0xA2677172, 0x3C03E4D1, 0x4B04D447, 0xD20D85FD, 0xA50AB56B, 0x35B5A8FA, 0x42B2986C, 0xDBBBC9D6, 0xACBCF940, 0x32D86CE3, 0x45DF5C75, 0xDCD60DCF, 0xABD13D59, 0x26D930AC, 0x51DE003A, 0xC8D75180, 0xBFD06116, 0x21B4F4B5, 0x56B3C423, 0xCFBA9599, 0xB8BDA50F, 0x2802B89E, 0x5F058808, 0xC60CD9B2, 0xB10BE924, 0x2F6F7C87, 0x58684C11, 0xC1611DAB, 0xB6662D3D, 0x76DC4190, 0x01DB7106, 0x98D220BC, 0xEFD5102A, 0x71B18589, 0x06B6B51F, 0x9FBFE4A5, 0xE8B8D433, 0x7807C9A2, 0x0F00F934, 0x9609A88E, 0xE10E9818, 0x7F6A0DBB, 0x086D3D2D, 0x91646C97, 0xE6635C01, 0x6B6B51F4, 0x1C6C6162, 0x856530D8, 0xF262004E, 0x6C0695ED, 0x1B01A57B, 0x8208F4C1, 0xF50FC457, 0x65B0D9C6, 0x12B7E950, 0x8BBEB8EA, 0xFCB9887C, 0x62DD1DDF, 0x15DA2D49, 0x8CD37CF3, 0xFBD44C65, 0x4DB26158, 0x3AB551CE, 0xA3BC0074, 0xD4BB30E2, 0x4ADFA541, 0x3DD895D7, 0xA4D1C46D, 0xD3D6F4FB, 0x4369E96A, 0x346ED9FC, 0xAD678846, 0xDA60B8D0, 0x44042D73, 0x33031DE5, 0xAA0A4C5F, 0xDD0D7CC9, 0x5005713C, 0x270241AA, 0xBE0B1010, 0xC90C2086, 0x5768B525, 0x206F85B3, 0xB966D409, 0xCE61E49F, 0x5EDEF90E, 0x29D9C998, 0xB0D09822, 0xC7D7A8B4, 0x59B33D17, 0x2EB40D81, 0xB7BD5C3B, 0xC0BA6CAD, 0xEDB88320, 0x9ABFB3B6, 0x03B6E20C, 0x74B1D29A, 0xEAD54739, 0x9DD277AF, 0x04DB2615, 0x73DC1683, 0xE3630B12, 0x94643B84, 0x0D6D6A3E, 0x7A6A5AA8, 0xE40ECF0B, 0x9309FF9D, 0x0A00AE27, 0x7D079EB1, 0xF00F9344, 0x8708A3D2, 0x1E01F268, 0x6906C2FE, 0xF762575D, 0x806567CB, 0x196C3671, 0x6E6B06E7, 0xFED41B76, 0x89D32BE0, 0x10DA7A5A, 0x67DD4ACC, 0xF9B9DF6F, 0x8EBEEFF9, 0x17B7BE43, 0x60B08ED5, 0xD6D6A3E8, 0xA1D1937E, 0x38D8C2C4, 0x4FDFF252, 0xD1BB67F1, 0xA6BC5767, 0x3FB506DD, 0x48B2364B, 0xD80D2BDA, 0xAF0A1B4C, 0x36034AF6, 0x41047A60, 0xDF60EFC3, 0xA867DF55, 0x316E8EEF, 0x4669BE79, 0xCB61B38C, 0xBC66831A, 0x256FD2A0, 0x5268E236, 0xCC0C7795, 0xBB0B4703, 0x220216B9, 0x5505262F, 0xC5BA3BBE, 0xB2BD0B28, 0x2BB45A92, 0x5CB36A04, 0xC2D7FFA7, 0xB5D0CF31, 0x2CD99E8B, 0x5BDEAE1D, 0x9B64C2B0, 0xEC63F226, 0x756AA39C, 0x026D930A, 0x9C0906A9, 0xEB0E363F, 0x72076785, 0x05005713, 0x95BF4A82, 0xE2B87A14, 0x7BB12BAE, 0x0CB61B38, 0x92D28E9B, 0xE5D5BE0D, 0x7CDCEFB7, 0x0BDBDF21, 0x86D3D2D4, 0xF1D4E242, 0x68DDB3F8, 0x1FDA836E, 0x81BE16CD, 0xF6B9265B, 0x6FB077E1, 0x18B74777, 0x88085AE6, 0xFF0F6A70, 0x66063BCA, 0x11010B5C, 0x8F659EFF, 0xF862AE69, 0x616BFFD3, 0x166CCF45, 0xA00AE278, 0xD70DD2EE, 0x4E048354, 0x3903B3C2, 0xA7672661, 0xD06016F7, 0x4969474D, 0x3E6E77DB, 0xAED16A4A, 0xD9D65ADC, 0x40DF0B66, 0x37D83BF0, 0xA9BCAE53, 0xDEBB9EC5, 0x47B2CF7F, 0x30B5FFE9, 0xBDBDF21C, 0xCABAC28A, 0x53B39330, 0x24B4A3A6, 0xBAD03605, 0xCDD70693, 0x54DE5729, 0x23D967BF, 0xB3667A2E, 0xC4614AB8, 0x5D681B02, 0x2A6F2B94, 0xB40BBE37, 0xC30C8EA1, 0x5A05DF1B, 0x2D02EF8D ];
+
+ var crc = 0 ^ -1;
+
+ for (var ix = 0; ix < buf.length; ix++) {
+ var offset = (crc ^ buf[ix]) & 0xFF;
+ crc = (crc >>> 8) ^ table[offset];
+ }
+
+ return crc ^ -1;
+}
+
+/**
+ * Write a serie of Int8's to a buffer
+ */
+function writeBytes (target, data) {
+ for (var ix = 0; ix < data.length; ix++) {
+ target.writeInt8(data[ix]);
+ }
+}
View
53 janzip/rollingbuffer.js
@@ -0,0 +1,53 @@
+function RollingBuffer (arg0, arg1, arg2) {
+ var offset = 0x00;
+
+ this.buf = new Buffer(arg0, arg1, arg2); // make this nice :)
+ this.length = this.buf.length;
+
+ this.write = function (str, encoding) {
+ var written = this.buf.write(str, offset, encoding);
+ offset += written;
+ };
+
+ this.appendBuffer = function (newBuffer) {
+ if (newBuffer instanceof Buffer) {
+ newBuffer.copy(this.buf, offset);
+ offset += newBuffer.length;
+ }
+ else if (newBuffer instanceof RollingBuffer) {
+ newBuffer.buf.copy(this.buf, offset);
+ offset += newBuffer.buf.length;
+ }
+ };
+
+ this.toString = function (encoding) {
+ return this.buf.toString(encoding);
+ };
+
+ this.writeInt8 = function (data) {
+ this.buf[offset] = data;
+ offset += 1;
+ };
+
+ this.writeInt16 = function (data) {
+ this.buf[offset] = data & 0xff;
+ this.buf[offset + 1] = (data & 0xff00) >> 8;
+
+ offset += 2;
+ };
+
+ this.writeInt32 = function (data) {
+ this.buf[offset] = data & 0xff;
+ this.buf[offset + 1] = (data & 0xff00) >> 0x08;
+ this.buf[offset + 2] = (data & 0xff0000) >> 0x10;
+ this.buf[offset + 3] = (data & 0xff000000) >> 0x18;
+
+ offset += 4;
+ };
+
+ this.getInternalBuffer = function () {
+ return this.buf;
+ };
+}
+
+module.exports = RollingBuffer;
View
8 package.json
@@ -0,0 +1,8 @@
+{
+ "name": "node-native-zip",
+ "description": "A ZIP library without external dependencies",
+ "author": "Jan Jongboom <janjongboom@gmail.com>",
+ "dependencies": { },
+ "devDependencies": { },
+ "engine": "node >= 0.4.9"
+}
View
36 server.js
@@ -1,27 +1,33 @@
var fs = require("fs");
+var zip = require("./index");
-(function () {
- var zip = require("./jszip");
-
+(function () {
var archive = new zip();
- archive.add("smile.txt", "Smile!");
- var buffer = archive.generate(false);
- console.log(typeof buffer, buffer);
+ archive.add("hello.txt", new Buffer("Hello world", "utf8"));
- fs.writeFile("./test_original.zip", new Buffer(buffer, 'base64'), function () {
- console.log("we're done");
+ var buffer = archive.toBuffer();
+ fs.writeFile("./test1.zip", buffer, function () {
+ console.log("Finished");
});
-}());
+})
(function () {
- var zip = require("./janzip");
+ var zip = require("./index");
var archive = new zip();
- archive.add("smile.txt", new Buffer("Smile!", "utf8"));
- var buff = archive.toBuffer();
-
- fs.writeFile("./test_new.zip", buff, function () {
- console.log("im too");
+ archive.addFiles([
+ { name: "moehah.txt", path: "./test/moehah.txt" },
+ { name: "images/sam.jpg", path: "./test/images.jpg" }
+ ], function () {
+ var buff = archive.toBuffer();
+
+ fs.writeFile("./test_new.zip", buff, function () {
+ console.log("im finished");
+ });
+ }, function (err) {
+ console.log(err);
});
+ //archive.add("smile.txt", new Buffer("Smile!", "utf8"));
+
}())

0 comments on commit fac11e4

Please sign in to comment.