zipFile.js 8.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320
  1. var ZipEntry = require("./zipEntry"),
  2. Headers = require("./headers"),
  3. Utils = require("./util");
  4. module.exports = function (/*String|Buffer*/input, /*Number*/inputType) {
  5. var entryList = [],
  6. entryTable = {},
  7. _comment = Buffer.alloc(0),
  8. filename = "",
  9. fs = Utils.FileSystem.require(),
  10. inBuffer = null,
  11. mainHeader = new Headers.MainHeader();
  12. if (inputType === Utils.Constants.FILE) {
  13. // is a filename
  14. filename = input;
  15. inBuffer = fs.readFileSync(filename);
  16. readMainHeader();
  17. } else if (inputType === Utils.Constants.BUFFER) {
  18. // is a memory buffer
  19. inBuffer = input;
  20. readMainHeader();
  21. } else {
  22. // none. is a new file
  23. }
  24. function readEntries() {
  25. entryTable = {};
  26. entryList = new Array(mainHeader.diskEntries); // total number of entries
  27. var index = mainHeader.offset; // offset of first CEN header
  28. for (var i = 0; i < entryList.length; i++) {
  29. var tmp = index,
  30. entry = new ZipEntry(inBuffer);
  31. entry.header = inBuffer.slice(tmp, tmp += Utils.Constants.CENHDR);
  32. entry.entryName = inBuffer.slice(tmp, tmp += entry.header.fileNameLength);
  33. if (entry.header.extraLength) {
  34. entry.extra = inBuffer.slice(tmp, tmp += entry.header.extraLength);
  35. }
  36. if (entry.header.commentLength)
  37. entry.comment = inBuffer.slice(tmp, tmp + entry.header.commentLength);
  38. index += entry.header.entryHeaderSize;
  39. entryList[i] = entry;
  40. entryTable[entry.entryName] = entry;
  41. }
  42. }
  43. function readMainHeader() {
  44. var i = inBuffer.length - Utils.Constants.ENDHDR, // END header size
  45. n = Math.max(0, i - 0xFFFF), // 0xFFFF is the max zip file comment length
  46. endOffset = -1; // Start offset of the END header
  47. for (i; i >= n; i--) {
  48. if (inBuffer[i] !== 0x50) continue; // quick check that the byte is 'P'
  49. if (inBuffer.readUInt32LE(i) === Utils.Constants.ENDSIG) { // "PK\005\006"
  50. endOffset = i;
  51. break;
  52. }
  53. }
  54. if (!~endOffset)
  55. throw Utils.Errors.INVALID_FORMAT;
  56. mainHeader.loadFromBinary(inBuffer.slice(endOffset, endOffset + Utils.Constants.ENDHDR));
  57. if (mainHeader.commentLength) {
  58. _comment = inBuffer.slice(endOffset + Utils.Constants.ENDHDR);
  59. }
  60. readEntries();
  61. }
  62. return {
  63. /**
  64. * Returns an array of ZipEntry objects existent in the current opened archive
  65. * @return Array
  66. */
  67. get entries() {
  68. return entryList;
  69. },
  70. /**
  71. * Archive comment
  72. * @return {String}
  73. */
  74. get comment() {
  75. return _comment.toString();
  76. },
  77. set comment(val) {
  78. mainHeader.commentLength = val.length;
  79. _comment = val;
  80. },
  81. /**
  82. * Returns a reference to the entry with the given name or null if entry is inexistent
  83. *
  84. * @param entryName
  85. * @return ZipEntry
  86. */
  87. getEntry: function (/*String*/entryName) {
  88. return entryTable[entryName] || null;
  89. },
  90. /**
  91. * Adds the given entry to the entry list
  92. *
  93. * @param entry
  94. */
  95. setEntry: function (/*ZipEntry*/entry) {
  96. entryList.push(entry);
  97. entryTable[entry.entryName] = entry;
  98. mainHeader.totalEntries = entryList.length;
  99. },
  100. /**
  101. * Removes the entry with the given name from the entry list.
  102. *
  103. * If the entry is a directory, then all nested files and directories will be removed
  104. * @param entryName
  105. */
  106. deleteEntry: function (/*String*/entryName) {
  107. var entry = entryTable[entryName];
  108. if (entry && entry.isDirectory) {
  109. var _self = this;
  110. this.getEntryChildren(entry).forEach(function (child) {
  111. if (child.entryName !== entryName) {
  112. _self.deleteEntry(child.entryName)
  113. }
  114. })
  115. }
  116. entryList.splice(entryList.indexOf(entry), 1);
  117. delete(entryTable[entryName]);
  118. mainHeader.totalEntries = entryList.length;
  119. },
  120. /**
  121. * Iterates and returns all nested files and directories of the given entry
  122. *
  123. * @param entry
  124. * @return Array
  125. */
  126. getEntryChildren: function (/*ZipEntry*/entry) {
  127. if (entry.isDirectory) {
  128. var list = [],
  129. name = entry.entryName,
  130. len = name.length;
  131. entryList.forEach(function (zipEntry) {
  132. if (zipEntry.entryName.substr(0, len) === name) {
  133. list.push(zipEntry);
  134. }
  135. });
  136. return list;
  137. }
  138. return []
  139. },
  140. /**
  141. * Returns the zip file
  142. *
  143. * @return Buffer
  144. */
  145. compressToBuffer: function () {
  146. if (entryList.length > 1) {
  147. entryList.sort(function (a, b) {
  148. var nameA = a.entryName.toLowerCase();
  149. var nameB = b.entryName.toLowerCase();
  150. if (nameA < nameB) {
  151. return -1
  152. }
  153. if (nameA > nameB) {
  154. return 1
  155. }
  156. return 0;
  157. });
  158. }
  159. var totalSize = 0,
  160. dataBlock = [],
  161. entryHeaders = [],
  162. dindex = 0;
  163. mainHeader.size = 0;
  164. mainHeader.offset = 0;
  165. entryList.forEach(function (entry) {
  166. // compress data and set local and entry header accordingly. Reason why is called first
  167. var compressedData = entry.getCompressedData();
  168. // data header
  169. entry.header.offset = dindex;
  170. var dataHeader = entry.header.dataHeaderToBinary();
  171. var c = entry.entryName + entry.extra.toString();
  172. var postHeader = Buffer.alloc(c.length, c);
  173. var dataLength = dataHeader.length + postHeader.length + compressedData.length;
  174. dindex += dataLength;
  175. dataBlock.push(dataHeader);
  176. dataBlock.push(postHeader);
  177. dataBlock.push(compressedData);
  178. var entryHeader = entry.packHeader();
  179. entryHeaders.push(entryHeader);
  180. mainHeader.size += entryHeader.length;
  181. totalSize += (dataLength + entryHeader.length);
  182. });
  183. totalSize += mainHeader.mainHeaderSize; // also includes zip file comment length
  184. // point to end of data and beginning of central directory first record
  185. mainHeader.offset = dindex;
  186. dindex = 0;
  187. var outBuffer = Buffer.alloc(totalSize);
  188. dataBlock.forEach(function (content) {
  189. content.copy(outBuffer, dindex); // write data blocks
  190. dindex += content.length;
  191. });
  192. entryHeaders.forEach(function (content) {
  193. content.copy(outBuffer, dindex); // write central directory entries
  194. dindex += content.length;
  195. });
  196. var mh = mainHeader.toBinary();
  197. if (_comment) {
  198. _comment.copy(mh, Utils.Constants.ENDHDR); // add zip file comment
  199. }
  200. mh.copy(outBuffer, dindex); // write main header
  201. return outBuffer
  202. },
  203. toAsyncBuffer: function (/*Function*/onSuccess, /*Function*/onFail, /*Function*/onItemStart, /*Function*/onItemEnd) {
  204. if (entryList.length > 1) {
  205. entryList.sort(function (a, b) {
  206. var nameA = a.entryName.toLowerCase();
  207. var nameB = b.entryName.toLowerCase();
  208. if (nameA > nameB) {
  209. return -1
  210. }
  211. if (nameA < nameB) {
  212. return 1
  213. }
  214. return 0;
  215. });
  216. }
  217. var totalSize = 0,
  218. dataBlock = [],
  219. entryHeaders = [],
  220. dindex = 0;
  221. mainHeader.size = 0;
  222. mainHeader.offset = 0;
  223. var compress = function (entryList) {
  224. var self = arguments.callee;
  225. if (entryList.length) {
  226. var entry = entryList.pop();
  227. var name = entry.entryName + entry.extra.toString();
  228. if (onItemStart) onItemStart(name);
  229. entry.getCompressedDataAsync(function (compressedData) {
  230. if (onItemEnd) onItemEnd(name);
  231. entry.header.offset = dindex;
  232. // data header
  233. var dataHeader = entry.header.dataHeaderToBinary();
  234. var postHeader = Buffer.alloc(name);
  235. var dataLength = dataHeader.length + postHeader.length + compressedData.length;
  236. dindex += dataLength;
  237. dataBlock.push(dataHeader);
  238. dataBlock.push(postHeader);
  239. dataBlock.push(compressedData);
  240. var entryHeader = entry.packHeader();
  241. entryHeaders.push(entryHeader);
  242. mainHeader.size += entryHeader.length;
  243. totalSize += (dataLength + entryHeader.length);
  244. if (entryList.length) {
  245. self(entryList);
  246. } else {
  247. totalSize += mainHeader.mainHeaderSize; // also includes zip file comment length
  248. // point to end of data and beginning of central directory first record
  249. mainHeader.offset = dindex;
  250. dindex = 0;
  251. var outBuffer = Buffer.alloc(totalSize);
  252. dataBlock.forEach(function (content) {
  253. content.copy(outBuffer, dindex); // write data blocks
  254. dindex += content.length;
  255. });
  256. entryHeaders.forEach(function (content) {
  257. content.copy(outBuffer, dindex); // write central directory entries
  258. dindex += content.length;
  259. });
  260. var mh = mainHeader.toBinary();
  261. if (_comment) {
  262. _comment.copy(mh, Utils.Constants.ENDHDR); // add zip file comment
  263. }
  264. mh.copy(outBuffer, dindex); // write main header
  265. onSuccess(outBuffer);
  266. }
  267. });
  268. }
  269. };
  270. compress(entryList);
  271. }
  272. }
  273. };