/
mZip.mjs.html
443 lines (355 loc) · 12.4 KB
/
mZip.mjs.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>mZip.mjs - Documentation</title>
<script src="scripts/prettify/prettify.js"></script>
<script src="scripts/prettify/lang-css.js"></script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
<script src="scripts/nav.js" defer></script>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
</head>
<body>
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
<label for="nav-trigger" class="navicon-button x">
<div class="navicon"></div>
</label>
<label for="nav-trigger" class="overlay"></label>
<nav >
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="m7z.html">m7z</a><ul class='methods'><li data-type='method'><a href="m7z.html#.setProg">setProg</a></li><li data-type='method'><a href="m7z.html#.unzip">unzip</a></li><li data-type='method'><a href="m7z.html#.zipFile">zipFile</a></li><li data-type='method'><a href="m7z.html#.zipFolder">zipFolder</a></li></ul></li><li><a href="mZip.html">mZip</a><ul class='methods'><li data-type='method'><a href="mZip.html#.unzip">unzip</a></li><li data-type='method'><a href="mZip.html#.zipFile">zipFile</a></li><li data-type='method'><a href="mZip.html#.zipFolder">zipFolder</a></li></ul></li></ul>
</nav>
<div id="main">
<h1 class="page-title">mZip.mjs</h1>
<section>
<article>
<pre class="prettyprint source linenums"><code>import path from 'path'
import fs from 'fs'
import archiver from 'archiver'
import archiverEnc from 'archiver-zip-encrypted'
import unzipper from 'unzipper'
import get from 'lodash/get'
import genPm from 'wsemi/src/genPm.mjs'
import pmMap from 'wsemi/src/pmMap.mjs'
import getFileName from 'wsemi/src/getFileName.mjs'
import checkTarget from './checkTarget.mjs'
//registerFormat
archiver.registerFormat('zip-encrypted', archiverEnc)
/**
* Zip處理
*
* @class
* @returns {Object} 回傳壓縮物件，可使用函數zipFile、zipFolder、unzip
* @example
* import wz from 'w-zip'
*
* let fpUnzip = './testData/outputZip'
* let fpUnzipExtract = fpUnzip + '/extract'
*
* let fpSrc1 = './testData/input/file1(中文).txt'
* let fpZip1 = fpUnzip + '/test1.zip'
*
* let fpSrc2 = './testData/input/folder1'
* let fpZip2 = fpUnzip + '/test2.zip'
* let fpZip2PW = fpUnzip + '/test2PW.zip'
* let pw = 'abc'
*
* async function test() {
*
* //zipFile
* console.log('zipFile before')
* console.log('zipFile', await wz.mZip.zipFile(fpSrc1, fpZip1))
* console.log('zipFile after')
*
* //zipFolder
* console.log('zipFolder before')
* console.log('zipFolder', await wz.mZip.zipFolder(fpSrc2, fpZip2))
* console.log('zipFolder after')
*
* //zipFolder with password
* console.log('zipFolder with password before')
* console.log('zipFolder with password', await wz.mZip.zipFolder(fpSrc2, fpZip2PW, { pw }))
* console.log('zipFolder with password after')
*
* //unzip
* console.log('unzip1 before')
* console.log('unzip1', await wz.mZip.unzip(fpZip1, fpUnzipExtract + '/test1'))
* console.log('unzip1 after')
*
* //unzip
* console.log('unzip2 before')
* console.log('unzip2', await wz.mZip.unzip(fpZip2, fpUnzipExtract + '/test2'))
* console.log('unzip2 after')
*
* //unzip with password
* console.log('unzip2 with password before')
* console.log('unzip2 with password', await wz.mZip.unzip(fpZip2PW, fpUnzipExtract + '/test2PW', { pw }))
* console.log('unzip2 with password after')
*
* }
* test()
* .catch((err) => {
* console.log(err)
* })
*
* // zipFile before
* // zipFile done: ./testData/outputZip/test1.zip
* // zipFile after
* // zipFolder before
* // zipFolder done: ./testData/outputZip/test2.zip
* // zipFolder after
* // zipFolder with password before
* // zipFolder with password done: ./testData/outputZip/test2PW.zip
* // zipFolder with password after
* // unzip1 before
* // unzip1 done: ./testData/outputZip/extract/test1
* // unzip1 after
* // unzip2 before
* // unzip2 done: ./testData/outputZip/extract/test2
* // unzip2 after
* // unzip2 with password before
* // unzip2 with password done: ./testData/outputZip/extract/test2PW
* // unzip2 with password after
*/
function mZip() {
/**
* 壓縮檔案
*
* @memberof mZip
* @param {String} fpSrc 輸入壓縮來源檔案位置字串
* @param {String} fpTar 輸入壓縮目標檔案位置字串
* @param {Object} [opt={}] 輸入設定物件，預設{}
* @param {Integer} [opt.level] 輸入壓縮程度整數，範圍為0至9，0為不壓縮而9為最高壓縮，預設9
* @param {String} [opt.pw] 輸入壓縮密碼字串，預設''
* @returns {Promise} 回傳Promise，resolve為成功資訊，reject為失敗資訊
*/
async function zipFile(fpSrc, fpTar, opt = {}) {
//check
if (!fs.existsSync(fpSrc)) {
return Promise.reject('invalid path of source file')
}
if (!fs.lstatSync(fpSrc).isFile()) {
return Promise.reject('path of source is not file')
}
//check fpTar
if (!checkTarget(fpTar)) {
return Promise.reject('invalid fpSrc')
}
//default
let level = get(opt, 'level', 9)
let pw = get(opt, 'pw', '')
try {
//pm
let pm = genPm()
//check
if (!fs.existsSync(path.dirname(fpTar))) {
fs.mkdirSync(path.dirname(fpTar), { recursive: true })
}
//archiver
let output = fs.createWriteStream(fpTar)
let archive
if (pw === '') {
archive = archiver('zip', {
zlib: { level },
})
}
else {
archive = archiver('zip-encrypted', {
zlib: { level },
encryptionMethod: 'zip20', //只能用zip20, 因unzipper目前不支援aes256
password: pw,
})
}
output.on('close', function() {
//console.log(archive.pointer() + ' total bytes')
//resolve
pm.resolve('done: ' + fpTar)
})
archive.on('warning', function(warn) {
//console.log('warning', warn)
})
archive.on('error', function(err) {
Promise.reject(err)
})
//pipe
archive.pipe(output)
//file
archive.file(fpSrc, { name: path.basename(fpSrc) })
//finalize
archive.finalize()
return pm
}
catch (err) {
return Promise.reject(err)
}
}
/**
* 壓縮資料夾
*
* @memberof mZip
* @param {String} fpSrc 輸入壓縮來源資料夾位置字串
* @param {String} fpTar 輸入壓縮目標資料夾位置字串
* @param {Integer} level 輸入壓縮程度整數，範圍為0至9，0為不壓縮而9為最高壓縮，預設9
* @returns {Promise} 回傳Promise，resolve為成功資訊，reject為失敗資訊
*/
async function zipFolder(fpSrc, fpTar, opt = {}) {
//check
if (!fs.existsSync(fpSrc)) {
return Promise.reject('invalid path of source file')
}
if (!fs.lstatSync(fpSrc).isDirectory()) {
return Promise.reject('path of source is not folder')
}
//check fpTar
if (!checkTarget(fpTar)) {
return Promise.reject('invalid fpSrc')
}
//default
let level = get(opt, 'level', 9)
let pw = get(opt, 'pw', '')
try {
//pm
let pm = genPm()
//check
if (!fs.existsSync(path.dirname(fpTar))) {
fs.mkdirSync(path.dirname(fpTar), { recursive: true })
}
//archiver
let output = fs.createWriteStream(fpTar)
let archive
if (pw === '') {
archive = archiver('zip', {
zlib: { level },
})
}
else {
archive = archiver('zip-encrypted', {
zlib: { level },
encryptionMethod: 'zip20', //只能用zip20, 因unzipper目前不支援aes256
password: pw,
})
}
output.on('close', function() {
//console.log(archive.pointer() + ' total bytes')
//resolve
pm.resolve('done: ' + fpTar)
})
archive.on('warning', function(warn) {
//console.log('warning', warn)
})
archive.on('error', function(err) {
Promise.reject(err)
})
//pipe
archive.pipe(output)
//directory
archive.directory(fpSrc, path.basename(fpSrc))
//finalize
archive.finalize()
return pm
}
catch (err) {
return Promise.reject(err)
}
}
/**
* 解壓縮檔案至資料夾
*
* @memberof mZip
* @param {String} fpSrc 輸入解壓縮來源檔案位置字串
* @param {String} fpTar 輸入解壓縮目標資料夾位置字串
* @param {Object} [opt={}] 輸入設定物件，預設{}
* @param {String} [opt.pw=''] 輸入解壓縮密碼字串，預設''
* @returns {Promise} 回傳Promise，resolve為成功資訊，reject為失敗資訊
*/
async function unzip(fpSrc, fpTar, opt = {}) {
//check
if (!fs.existsSync(fpSrc)) {
return Promise.reject('invalid path of source file')
}
if (!fs.lstatSync(fpSrc).isFile()) {
return Promise.reject('path of source is not file')
}
//check fpTar
if (!checkTarget(fpTar)) {
return Promise.reject('invalid fpSrc')
}
//default
let pw = get(opt, 'pw', '')
//extract
async function extract(fpSrc, fpTar, password) {
//mkdir
async function mkdir(fd) {
try {
//check
if (!fs.existsSync(fd)) {
fs.mkdirSync(fd, { recursive: true })
}
}
catch (err) {
return Promise.reject(err)
}
return 'done'
}
//extractFile
async function extractFile(file, fn, password = '') {
try {
//check
if (!fs.existsSync(path.dirname(fn))) {
fs.mkdirSync(path.dirname(fn), { recursive: true })
}
//buffer
let b = await file.buffer(password)
//writeFileSync
fs.writeFileSync(fn, b)
}
catch (err) {
return Promise.reject(err)
}
return 'done'
}
//directory
let directory = await unzipper.Open.file(fpSrc)
//pmMap
return pmMap(directory.files, async (file) => {
let p = path.join(fpTar, file.path)
if (file.type === 'File') {
return extractFile(file, p, password)
}
else {
return mkdir(p)
}
})
}
try {
//extract
await extract(fpSrc, fpTar, pw)
return Promise.resolve('done: ' + getFileName(fpTar))
}
catch (err) {
return Promise.reject(err)
}
}
return {
zipFile,
zipFolder,
unzip,
}
}
export default mZip()
</code></pre>
</article>
</section>
</div>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> on Fri Oct 22 2021 12:13:27 GMT+0800 (台北標準時間) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
</footer>
<script>prettyPrint();</script>
<script src="scripts/polyfill.js"></script>
<script src="scripts/linenumber.js"></script>
</body>
</html>