w-converhp 2.0.8 → 2.0.11

package/docs/WConverhpClient.mjs.html

@@ -45,7 +45,9 @@
     
     <section>
         <article>
-            <pre class="prettyprint source linenums"><code>import axios from 'axios'
+            <pre class="prettyprint source linenums"><code>import path from 'path'
+import fs from 'fs'
+import axios from 'axios'
 import get from 'lodash-es/get.js'
 import isWindow from 'wsemi/src/isWindow.mjs'
 import genPm from 'wsemi/src/genPm.mjs'
@@ -66,6 +68,8 @@ import obj2u8arr from 'wsemi/src/obj2u8arr.mjs'
 import u8arr2obj from 'wsemi/src/u8arr2obj.mjs'
 import pmConvertResolve from 'wsemi/src/pmConvertResolve.mjs'
 import now2strp from 'wsemi/src/now2strp.mjs'
+import fsIsFolder from 'wsemi/src/fsIsFolder.mjs'
+import fsCreateFolder from 'wsemi/src/fsCreateFolder.mjs'
 
 
 /**
@@ -177,6 +181,35 @@ import now2strp from 'wsemi/src/now2strp.mjs'
  * }
  * uploadLargeFile()
  *
+ * function downloadLargeFile() {
+ *     let core = async() => {
+ *
+ *         await wo.download('id-for-file',
+ *             function ({ prog, p, m }) {
+ *                 // console.log('client web: download: prog', prog, p, m)
+ *                 if (m === 'download') {
+ *                     console.log('client web: download: prog', prog)
+ *                 }
+ *             },
+ *             {
+ *                 fdDownload: './',
+ *             })
+ *             .then(function(res) {
+ *                 console.log('client web: download: then', res)
+ *                 ms.push({ 'download output': res })
+ *             })
+ *             .catch(function (err) {
+ *                 console.log('client web: download: catch', err)
+ *             })
+ *
+ *         console.log('ms', ms)
+ *
+ *     }
+ *     core()
+ * }
+ *
+ * downloadLargeFile()
+ *
  */
 function WConverhpClient(opt) {
 
@@ -301,6 +334,9 @@ function WConverhpClient(opt) {
         else if (type === 'slicemerge') {
             urlUse = `${url}slcm`
         }
+        else if (type === 'download') {
+            urlUse = `${url}dw`
+        }
         else {
             throw new Error(`invalid type[${type}]`)
         }
@@ -375,6 +411,9 @@ function WConverhpClient(opt) {
         let rt = 'blob'
         if (env === 'nodejs') {
             rt = 'arraybuffer' //nodejs下沒有blob, 只能設定'json', 'arraybuffer', 'document', 'json', 'text', 'stream'
+            if (type === 'download') {
+                rt = 'stream' //nodejs download模式採用stream接收
+            }
         }
         // console.log('rt', rt)
 
@@ -432,11 +471,115 @@ function WConverhpClient(opt) {
         }
         // console.log('s', s)
 
+        //getFilenameByHeader
+        let getFilenameByHeader = (contentDisposition) => {
+            let fn = 'unknow'
+            try {
+                let reg = /filename="(.+?)"/
+                let matches = reg.exec(contentDisposition)
+                fn = matches ? matches[1] : 'unknown'
+            }
+            catch (err) {}
+            return fn
+        }
+
+        //downloadStream
+        let downloadStream = (res) => {
+            // console.log('res.headers', res.headers)
+
+            //pm
+            let pm = genPm()
+
+            //returnType
+            let returnType = get(res, `headers['return-type']`, '')
+            // console.log('returnType', returnType)
+
+            //returnMsg
+            let returnMsg = get(res, `headers['return-msg']`, '')
+            // console.log('returnMsg', returnMsg)
+
+            //check
+            if (returnType === 'error') {
+                pm.reject(returnMsg)
+                return pm
+            }
+
+            //contentDisposition
+            let contentDisposition = get(res, `headers['content-disposition']`, '')
+            // console.log('contentDisposition', contentDisposition)
+
+            //filename
+            let filename = getFilenameByHeader(contentDisposition)
+            // console.log('filename', filename)
+
+            //streamRecv
+            let streamRecv = get(res, 'data')
+
+            if (env === 'browser') {
+
+                //通過createObjectURL與a元素下載
+                let url = URL.createObjectURL(streamRecv)
+                let a = document.createElement('a')
+                a.href = url
+                a.download = filename // 動態設置檔名
+                document.body.appendChild(a)
+                a.click()
+                a.remove()
+                URL.revokeObjectURL(url)
+
+                pm.resolve(filename)
+            }
+            else {
+
+                //fdDownload, 只有後端下載才使用fdDownload
+                let fdDownload = get(opt, 'fdDownload', '')
+                if (!fsIsFolder(fdDownload)) {
+                    fsCreateFolder(fdDownload)
+                }
+                // console.log('fdDownload', fdDownload)
+
+                //fp
+                let fp = path.resolve(fdDownload, filename)
+                // console.log('fp', fp)
+
+                //streamWriter
+                let streamWriter = fs.createWriteStream(fp)
+
+                //pipe
+                streamRecv.pipe(streamWriter)
+
+                //finish
+                streamWriter.on('finish', () => {
+                    pm.resolve(fp)
+                })
+
+                //error
+                streamWriter.on('error', (err) => {
+                    pm.reject(err)
+                })
+
+            }
+
+            return pm
+        }
+
         //axios
         axios(s)
             .then(async (res) => {
                 // console.log('axios then', res)
 
+                //check download
+                if (type === 'download') {
+                    await downloadStream(res)
+                        .then((_res) => {
+                            pm.resolve(_res)
+                        })
+                        .catch((_err) => {
+                            pm.reject(_err)
+                        })
+                    return
+                }
+
                 //bb
                 let bb = get(res, 'data')
                 // console.log('bb', bb)
@@ -473,7 +616,7 @@ function WConverhpClient(opt) {
 
             })
             .catch(async (res) => {
-                //console.log('axios catch', res.toJSON())
+                // console.log('axios catch', res.toJSON())
                 //Network Error除可能是網路斷線之外, 可能被瀏覽器外掛封鎖阻擋, 亦可能因硬碟空間不足(&lt;4g)無法下載被瀏覽器拒絕
 
                 //data
@@ -507,6 +650,7 @@ function WConverhpClient(opt) {
                 if (data === 'Network Error') {
                     data = `Network Error. Make sure your space of hard drive is large enough or blocking by browser plugins.`
                 }
+                // console.log('data', data)
 
                 pm.reject(data)
             })
@@ -583,7 +727,7 @@ function WConverhpClient(opt) {
         }
         if (n === 0) {
             try {
-                n = bb.length //for Uint8Array
+                n = bb.length //for Uint8Array //後端用fs讀有檔案大小上限, 除非改傳入檔名用stream讀, 否則無法支援超大檔
                 n = cint(n)
             }
             catch (err) {}
@@ -591,9 +735,9 @@ function WConverhpClient(opt) {
         if (n === 0) {
             // eeEmit('error', `can not get size of bb`)
             // return Promise.reject(`can not get size of bb`)
-            n = 1
+            n = 1 //最小給1, 使能支援無大小檔案上傳
         }
-        console.log('n', n)
+        // console.log('n', n)
 
         //chunkTotal
         let chunkTotal = Math.ceil(n / sizeSlice)
@@ -744,9 +888,23 @@ function WConverhpClient(opt) {
         return sendDataSlice(tempId, bb, cbProgress)
     }
 
+    //download
+    async function download(fileId, cbProgress, opt = {}) {
+
+        //msg
+        let msg = { fileId }
+
+        //send download
+        let resMg = await send('download', msg, { ...opt, dataType: 'json', cbProgress })
+        // console.log('resMg', resMg)
+
+        return resMg
+    }
+
     //save
     ee.execute = execute
     ee.upload = upload
+    ee.download = download
 
     return ee
 }
@@ -767,7 +925,7 @@ export default WConverhpClient
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Wed Apr 02 2025 11:07:08 GMT+0800 (台北標準時間) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Tue Apr 08 2025 09:12:35 GMT+0800 (台北標準時間) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/WConverhpServer.html

@@ -80,7 +80,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="WConverhpServer.mjs.html">WConverhpServer.mjs</a>, <a href="WConverhpServer.mjs.html#line118">line 118</a>
+        <a href="WConverhpServer.mjs.html">WConverhpServer.mjs</a>, <a href="WConverhpServer.mjs.html#line158">line 158</a>
     </li></ul></dd>
     
 
@@ -127,7 +127,7 @@
 
     <h5 class="h5-examples">Example</h5>
     
-    <pre class="prettyprint"><code>import _ from 'lodash-es'
    port: 8080,
    apiName: 'api',
    pathStaticFiles: '.', //要存取專案資料夾下web.html, 故不能給dist
    verifyConn: () => {
        return true
    },
    // console.log(`Server[port:${opt.port}]: execute`, func, input)
    console.log(`Server[port:${opt.port}]: execute`, func)
    try {
        if (func === 'add') {
            if (_.get(input, 'p.d.u8a', null)) {
                console.log('input.p.d.u8a', input.p.d.u8a)
            }
            let r = {
                _add: input.p.a + input.p.b,
                _data: [11, 22.22, 'abc', { x: '21', y: 65.43, z: 'test中文' }],
                _bin: {
                    name: 'zdata.b2',
                    u8a: new Uint8Array([66, 97, 115]),
                    // name: '100mb.7z',
                    // u8a: new Uint8Array(fs.readFileSync('D:\\開源-JS-006-2-w-converhp\\_temp\\100mb.7z')),
                    // name: '500mb.7z',
                    // u8a: new Uint8Array(fs.readFileSync('D:\\開源-JS-006-2-w-converhp\\_temp\\500mb.7z')),
                    // name: '1000mb.7z',
                    // u8a: new Uint8Array(fs.readFileSync('D:\\開源-JS-006-2-w-converhp\\_temp\\1000mb.7z')),
                },
            }
            pm.resolve(r)
        }
        else {
            console.log('invalid func')
            pm.reject('invalid func')
        }
    }
    catch (err) {
        console.log('execute error', err)
        pm.reject('execute error')
    }
    console.log(`Server[port:${opt.port}]: upload`, input)
    try {
        let output = input
        pm.resolve(output)
    }
    catch (err) {
        console.log('upload error', err)
        pm.reject('upload error')
    }
    // console.log(`Server[port:${opt.port}]: handler`, data)
+    <pre class="prettyprint"><code>import _ from 'lodash-es'
    port: 8080,
    apiName: 'api',
    pathStaticFiles: '.', //要存取專案資料夾下web.html, 故不能給dist
    verifyConn: () => {
        return true
    },
    // console.log(`Server[port:${opt.port}]: execute`, func, input)
    console.log(`Server[port:${opt.port}]: execute`, func)
    try {
        if (func === 'add') {
            if (_.get(input, 'p.d.u8a', null)) {
                console.log('input.p.d.u8a', input.p.d.u8a)
            }
            let r = {
                _add: input.p.a + input.p.b,
                _data: [11, 22.22, 'abc', { x: '21', y: 65.43, z: 'test中文' }],
                _bin: {
                    name: 'zdata.b2',
                    u8a: new Uint8Array([66, 97, 115]),
                    // name: '100mb.7z',
                    // u8a: new Uint8Array(fs.readFileSync('D:\\開源-JS-006-2-w-converhp\\_temp\\100mb.7z')),
                    // name: '500mb.7z',
                    // u8a: new Uint8Array(fs.readFileSync('D:\\開源-JS-006-2-w-converhp\\_temp\\500mb.7z')),
                    // name: '1000mb.7z',
                    // u8a: new Uint8Array(fs.readFileSync('D:\\開源-JS-006-2-w-converhp\\_temp\\1000mb.7z')),
                },
            }
            pm.resolve(r)
        }
        else {
            console.log('invalid func')
            pm.reject('invalid func')
        }
    }
    catch (err) {
        console.log('execute error', err)
        pm.reject('execute error')
    }
    console.log(`Server[port:${opt.port}]: upload`, input)
    try {
        let output = input
        pm.resolve(output)
    }
    catch (err) {
        console.log('upload error', err)
        pm.reject('upload error')
    }
    console.log(`Server[port:${opt.port}]: download`, input)
    try {
        ms.push({ 'download': input })
        //fp
        let fp = `./test/1mb.7z`
        //streamRead
        let streamRead = fs.createReadStream(fp)
        //fileName
        let fileName = `1mb.7z`
        //fileSize
        let stats = fs.statSync(fp)
        let fileSize = stats.size
        //fileType
        let fileType = 'application/x-7z-compressed'
        //output
        let output = {
            streamRead,
            fileName,
            fileSize,
            fileType,
        }
        pm.resolve(output)
    }
    catch (err) {
        console.log('download error', err)
        pm.reject('download error')
    }
    // console.log(`Server[port:${opt.port}]: handler`, data)
 
 
 
@@ -709,7 +709,7 @@
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Wed Apr 02 2025 11:07:08 GMT+0800 (台北標準時間) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Tue Apr 08 2025 09:12:35 GMT+0800 (台北標準時間) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>