w-ftp 1.0.2 → 1.0.5

package/docs/WFtp.mjs.html

@@ -27,7 +27,7 @@
 
 <nav >
     
-    <h2><a href="index.html">Home</a></h2><h3>Global</h3><ul><li><a href="global.html#ftpCheckFile">ftpCheckFile</a></li><li><a href="global.html#ftpConn">ftpConn</a></li><li><a href="global.html#ftpDownload">ftpDownload</a></li><li><a href="global.html#ftpLs">ftpLs</a></li><li><a href="global.html#ftpQuit">ftpQuit</a></li><li><a href="global.html#ftpStateFile">ftpStateFile</a></li><li><a href="global.html#ftpSyncToLocal">ftpSyncToLocal</a></li><li><a href="global.html#ftpSyncToRemote">ftpSyncToRemote</a></li><li><a href="global.html#ftpUpload">ftpUpload</a></li><li><a href="global.html#WFtp">WFtp</a></li></ul>
+    <h2><a href="index.html">Home</a></h2><h3>Global</h3><ul><li><a href="global.html#conn">conn</a></li><li><a href="global.html#download">download</a></li><li><a href="global.html#isFile">isFile</a></li><li><a href="global.html#isFolder">isFolder</a></li><li><a href="global.html#ls">ls</a></li><li><a href="global.html#quit">quit</a></li><li><a href="global.html#stateFile">stateFile</a></li><li><a href="global.html#syncToLocal">syncToLocal</a></li><li><a href="global.html#syncToRemote">syncToRemote</a></li><li><a href="global.html#upload">upload</a></li><li><a href="global.html#WFtp">WFtp</a></li></ul>
 </nav>
 
 <div id="main">
@@ -64,6 +64,7 @@ import fsTreeFolder from 'wsemi/src/fsTreeFolder.mjs'
 import fsIsFolder from 'wsemi/src/fsIsFolder.mjs'
 import fsIsFile from 'wsemi/src/fsIsFile.mjs'
 import fsCreateFolder from 'wsemi/src/fsCreateFolder.mjs'
+import ot from 'dayjs'
 import Jsftp from './jsftp.js'
 
 
@@ -104,7 +105,7 @@ import Jsftp from './jsftp.js'
  *     })
  *
  */
-async function ftpConn(opt = {}) {
+async function conn(opt = {}) {
     return null
 }
 
@@ -143,7 +144,7 @@ async function ftpConn(opt = {}) {
  *     })
  *
  */
-async function ftpLs(fdRemote = '.') {
+async function ls(fdRemote = '.') {
     return null
 }
 
@@ -179,7 +180,7 @@ async function ftpLs(fdRemote = '.') {
  *         console.log(err)
  *     })
  */
-async function ftpQuit() {
+async function quit() {
     return null
 }
 
@@ -217,7 +218,7 @@ async function ftpQuit() {
  *         console.log(err)
  *     })
  */
-async function ftpStateFile(fpRemote) {
+async function stateFile(fpRemote) {
     return null
 }
 
@@ -243,8 +244,8 @@ async function ftpStateFile(fpRemote) {
  *         password: st.up.password,
  *     })
  *
- *     r = await ftp.checkFile('./_test_upload_client/DECL_20210805055044.csv')
- *     console.log('ftp.checkFile', r)
+ *     r = await ftp.isFile('./_test_upload_client/DECL_20210805055044.csv')
+ *     console.log('ftp.isFile', r)
  *
  *     r = await ftp.quit()
  *     console.log('ftp.quit', r)
@@ -255,7 +256,45 @@ async function ftpStateFile(fpRemote) {
  *         console.log(err)
  *     })
  */
-async function ftpCheckFile(fpRemote) {
+async function isFile(fpRemote) {
+    return null
+}
+
+
+/**
+ * 確認伺服器指定資料夾是否存在
+ *
+ * @param {String} opt.fpRemote 輸入伺服器上指定資料夾字串
+ * @return {Promise} 回傳Promise，resolve回傳指定資料夾是否存在布林值，reject回傳錯誤訊息
+ * @example
+ * import WFtp from './src/WFtp.mjs'
+ *
+ * async function test() {
+ *     let r
+ *
+ *     let ftp = WFtp()
+ *     // console.log('ftp', ftp)
+ *
+ *     await ftp.conn({
+ *         hostname: st.up.hostname,
+ *         port: st.up.port,
+ *         username: st.up.username,
+ *         password: st.up.password,
+ *     })
+ *
+ *     r = await ftp.isFolder('./_test_upload_client')
+ *     console.log('ftp.isFolder', r)
+ *
+ *     r = await ftp.quit()
+ *     console.log('ftp.quit', r)
+ *
+ * }
+ * test()
+ *     .catch((err) => {
+ *         console.log(err)
+ *     })
+ */
+async function isFolder(fpRemote) {
     return null
 }
 
@@ -297,7 +336,7 @@ async function ftpCheckFile(fpRemote) {
  *         console.log(err)
  *     })
  */
-async function ftpDownload(fpRemote, fpLocal, cbProcess = null) {
+async function download(fpRemote, fpLocal, cbProcess = null) {
     return null
 }
 
@@ -339,7 +378,7 @@ async function ftpDownload(fpRemote, fpLocal, cbProcess = null) {
  *         console.log(err)
  *     })
  */
-async function ftpUpload(fpLocal, fpRemote, cbProcess) {
+async function upload(fpLocal, fpRemote, cbProcess) {
     return null
 }
 
@@ -381,7 +420,7 @@ async function ftpUpload(fpLocal, fpRemote, cbProcess) {
  *         console.log(err)
  *     })
  */
-async function ftpSyncToLocal(fdRemote, fdLocal, cbProcess) {
+async function syncToLocal(fdRemote, fdLocal, cbProcess) {
     return null
 }
 
@@ -423,7 +462,7 @@ async function ftpSyncToLocal(fdRemote, fdLocal, cbProcess) {
  *         console.log(err)
  *     })
  */
-async function ftpSyncToRemote(fdLocal, fdRemote, cbProcess) {
+async function syncToRemote(fdLocal, fdRemote, cbProcess) {
     return null
 }
 
@@ -431,11 +470,11 @@ async function ftpSyncToRemote(fdLocal, fdRemote, cbProcess) {
 /**
  * 操作FTP，包含連線、下載、資料夾內檔案同步下載、上傳、資料夾內檔案同步上傳等功能
  *
- * @returns {Object} 回傳FTP操作物件，包含conn、ls、stateFile、checkFile、download、syncToLocal、syncToRemote、upload、quit。
+ * @returns {Object} 回傳FTP操作物件，包含conn、ls、stateFile、isFile、download、syncToLocal、syncToRemote、upload、quit。
  * @example
  * import WFtp from './src/WFtp.mjs'
  *
- * async function test_up() {
+ * async function test_dw() {
  *     let r
  *
  *     let ftp = WFtp()
@@ -448,46 +487,73 @@ async function ftpSyncToRemote(fdLocal, fdRemote, cbProcess) {
  *         password: `{password}`,
  *     })
  *
- *     let fps = await ftp.ls('.')
- *     console.log('ftp.ls', fps[0], fps.length)
+ *     async function core() {
  *
- *     r = await ftp.upload('./_test_upload_client/DECL_20210805055044.csv', './DECL_20210805055044.csv', (p) => {
- *         console.log('ftp.upload p', p.name, p.progress)
- *     })
- *     console.log('ftp.upload', r)
+ *         let fps = await ftp.ls('.')
+ *         console.log('ftp.ls', fps[0], fps.length)
  *
- *     r = await ftp.syncToRemote('./_test_upload_client', '.', (p) => {
- *         console.log('ftp.syncToRemote p', p.name, p.progress)
- *     })
- *     console.log('ftp.syncToRemote', r)
+ *         r = await ftp.download('./DECL_20210805055044.csv', './_test_download_client/DECL_20210805055044.csv', (p) => {
+ *             console.log('ftp.download p', p.name, p.progress)
+ *         })
+ *         console.log('ftp.download', r)
+ *
+ *         r = await ftp.syncToLocal('.', './_test_download_client', (p) => {
+ *             console.log('ftp.syncToLocal p', p.name, p.progress)
+ *         })
+ *         console.log('ftp.syncToLocal', r)
+ *
+ *     }
+ *     await core()
+ *         .catch((err) => {
+ *             console.log(err)
+ *         })
  *
  *     r = await ftp.quit()
  *     console.log('ftp.quit', r)
  *
  * }
- * test_up()
+ * test_dw()
  *     .catch((err) => {
  *         console.log(err)
  *     })
  * // ftp.ls {
  * //   name: 'DECL_202108.csv',
  * //   type: 0,
- * //   time: 1658366760000,
+ * //   time: 1658302140000,
  * //   size: '218690',
  * //   owner: 'ftp',
  * //   group: 'ftp',
  * //   userPermissions: { read: true, write: true, exec: false },
  * //   groupPermissions: { read: true, write: true, exec: false },
  * //   otherPermissions: { read: true, write: true, exec: false }
- * // } 73
- * // ftp.upload p DECL_20210805055044.csv 75.71339448693362
- * // drain
- * // ftp.upload p DECL_20210805055044.csv 100
- * // ftp.upload ok
- * // ftp.syncToRemote { num: 0, files: [] }
+ * // } 74
+ * // ftp.download p DECL_20210805055044.csv 4.7320871554333515
+ * // ftp.download p DECL_20210805055044.csv 9.464174310866703
+ * // ftp.download p DECL_20210805055044.csv 14.196261466300053
+ * // ftp.download p DECL_20210805055044.csv 18.928348621733406
+ * // ftp.download p DECL_20210805055044.csv 23.660435777166754
+ * // ftp.download p DECL_20210805055044.csv 28.392522932600105
+ * // ftp.download p DECL_20210805055044.csv 33.12461008803346
+ * // ftp.download p DECL_20210805055044.csv 37.85669724346681
+ * // ftp.download p DECL_20210805055044.csv 42.58878439890016
+ * // ftp.download p DECL_20210805055044.csv 47.32087155433351
+ * // ftp.download p DECL_20210805055044.csv 52.05295870976686
+ * // ftp.download p DECL_20210805055044.csv 56.78504586520021
+ * // ftp.download p DECL_20210805055044.csv 61.517133020633565
+ * // ftp.download p DECL_20210805055044.csv 66.24922017606691
+ * // ftp.download p DECL_20210805055044.csv 70.98130733150026
+ * // ftp.download p DECL_20210805055044.csv 75.71339448693362
+ * // ftp.download p DECL_20210805055044.csv 80.44548164236697
+ * // ftp.download p DECL_20210805055044.csv 85.17756879780032
+ * // ftp.download p DECL_20210805055044.csv 89.90965595323367
+ * // ftp.download p DECL_20210805055044.csv 94.64174310866701
+ * // ftp.download p DECL_20210805055044.csv 99.37383026410038
+ * // ftp.download p DECL_20210805055044.csv 100
+ * // ftp.download ok
+ * // ftp.syncToLocal { num: 0, files: [] }
  * // ftp.quit { code: 221, text: '221 Goodbye.', isMark: false, isError: false }
  *
- * async function test_dw() {
+ * async function test_up() {
  *     let r
  *
  *     let ftp = WFtp()
@@ -500,81 +566,70 @@ async function ftpSyncToRemote(fdLocal, fdRemote, cbProcess) {
  *         password: `{password}`,
  *     })
  *
- *     let fps = await ftp.ls('.')
- *     console.log('ftp.ls', fps[0], fps.length)
+ *     async function core() {
  *
- *     r = await ftp.download('./DECL_20210805055044.csv', './_test_download_client/DECL_20210805055044.csv', (p) => {
- *         console.log('ftp.download p', p.name, p.progress)
- *     })
- *     console.log('ftp.download', r)
+ *         let fps = await ftp.ls('.')
+ *         console.log('ftp.ls', fps[0], fps.length)
  *
- *     r = await ftp.syncToLocal('.', './_test_download_client', (p) => {
- *         console.log('ftp.syncToLocal p', p.name, p.progress)
- *     })
- *     console.log('ftp.syncToLocal', r)
+ *         r = await ftp.upload('./_test_upload_client/DECL_20210805055044.csv', './DECL_20210805055044.csv', (p) => {
+ *             console.log('ftp.upload p', p.name, p.progress)
+ *         })
+ *         console.log('ftp.upload', r)
+ *
+ *         r = await ftp.syncToRemote('./_test_upload_client', '.', (p) => {
+ *             console.log('ftp.syncToRemote p', p.name, p.progress)
+ *         })
+ *         console.log('ftp.syncToRemote', r)
+ *
+ *     }
+ *     await core()
+ *         .catch((err) => {
+ *             console.log(err)
+ *         })
  *
  *     r = await ftp.quit()
  *     console.log('ftp.quit', r)
  *
  * }
- * test_dw()
+ * test_up()
  *     .catch((err) => {
  *         console.log(err)
  *     })
  * // ftp.ls {
  * //   name: 'DECL_202108.csv',
  * //   type: 0,
- * //   time: 1658302140000,
+ * //   time: 1658366760000,
  * //   size: '218690',
  * //   owner: 'ftp',
  * //   group: 'ftp',
  * //   userPermissions: { read: true, write: true, exec: false },
  * //   groupPermissions: { read: true, write: true, exec: false },
  * //   otherPermissions: { read: true, write: true, exec: false }
- * // } 74
- * // ftp.download p DECL_20210805055044.csv 4.7320871554333515
- * // ftp.download p DECL_20210805055044.csv 9.464174310866703
- * // ftp.download p DECL_20210805055044.csv 14.196261466300053
- * // ftp.download p DECL_20210805055044.csv 18.928348621733406
- * // ftp.download p DECL_20210805055044.csv 23.660435777166754
- * // ftp.download p DECL_20210805055044.csv 28.392522932600105
- * // ftp.download p DECL_20210805055044.csv 33.12461008803346
- * // ftp.download p DECL_20210805055044.csv 37.85669724346681
- * // ftp.download p DECL_20210805055044.csv 42.58878439890016
- * // ftp.download p DECL_20210805055044.csv 47.32087155433351
- * // ftp.download p DECL_20210805055044.csv 52.05295870976686
- * // ftp.download p DECL_20210805055044.csv 56.78504586520021
- * // ftp.download p DECL_20210805055044.csv 61.517133020633565
- * // ftp.download p DECL_20210805055044.csv 66.24922017606691
- * // ftp.download p DECL_20210805055044.csv 70.98130733150026
- * // ftp.download p DECL_20210805055044.csv 75.71339448693362
- * // ftp.download p DECL_20210805055044.csv 80.44548164236697
- * // ftp.download p DECL_20210805055044.csv 85.17756879780032
- * // ftp.download p DECL_20210805055044.csv 89.90965595323367
- * // ftp.download p DECL_20210805055044.csv 94.64174310866701
- * // ftp.download p DECL_20210805055044.csv 99.37383026410038
- * // ftp.download p DECL_20210805055044.csv 100
- * // ftp.download ok
- * // ftp.syncToLocal { num: 0, files: [] }
+ * // } 73
+ * // ftp.upload p DECL_20210805055044.csv 75.71339448693362
+ * // ftp.upload p DECL_20210805055044.csv 100
+ * // ftp.upload ok
+ * // ftp.syncToRemote { num: 0, files: [] }
  * // ftp.quit { code: 221, text: '221 Goodbye.', isMark: false, isError: false }
  *
  */
 function WFtp() {
-    let t = this
-    t._ = {
-        doc_ftpConn: ftpConn,
-        doc_ftpLs: ftpLs,
-        doc_ftpQuit: ftpQuit,
-        doc_ftpStateFile: ftpStateFile,
-        doc_ftpCheckFile: ftpCheckFile,
-        doc_ftpDownload: ftpDownload,
-        doc_ftpUpload: ftpUpload,
-        doc_ftpSyncToLocal: ftpSyncToLocal,
-        doc_ftpSyncToRemote: ftpSyncToRemote,
+    let doc = {
+        doc_conn: conn,
+        doc_ls: ls,
+        doc_quit: quit,
+        doc_stateFile: stateFile,
+        doc_isFile: isFile,
+        doc_isFolder: isFolder,
+        doc_download: download,
+        doc_upload: upload,
+        doc_syncToLocal: syncToLocal,
+        doc_syncToRemote: syncToRemote,
     }
 
     function WFtpCore() {
         let Ftp = null
+        let timeLimit = 1 * 60 * 1000 //1hr
 
 
         async function ftpConn(opt = {}) {
@@ -611,6 +666,18 @@ function WFtp() {
                 return pm
             }
 
+            //timeLimit
+            let _timeLimit = get(opt, 'timeLimit')
+            if (isnum(_timeLimit)) {
+
+                //cint
+                _timeLimit = cint(_timeLimit)
+
+                //update
+                timeLimit = _timeLimit
+
+            }
+
             try {
                 Ftp = new Jsftp({
                     host: hostname, //hostname or ip
@@ -618,6 +685,7 @@ function WFtp() {
                     user: username, // defaults to "anonymous"
                     pass: password, // defaults to "@anonymous"
                 })
+                Ftp.__doc__ = doc
                 pm.resolve('ok')
             }
             catch (err) {
@@ -639,11 +707,26 @@ function WFtp() {
                 return pm
             }
 
+            //timeLimit
+            let t = setTimeout(() => {
+                pm.reject(`timeout[${timeLimit}]`)
+            }, timeLimit)
+
             Ftp.ls(fdRemote, (err, res) => {
+
+                //clearTimeout
+                clearTimeout(t)
+
                 if (err) {
                     pm.reject(err)
                 }
                 else {
+                    res = map(res, (v) => {
+                        let d = ot(v.time) //jsfpt解析時間係基於ls, 其檔案變更時間精度只至分而沒有秒, 故無法提供精確的檔案變更時間
+                        v.ctime = d.format('YYYY-MM-DDTHH:mm:ssZ') //添加UTC時間
+                        v.isFolder = ftpIsFolderCore(v)
+                        return v
+                    })
                     pm.resolve(res)
                 }
             })
@@ -663,7 +746,29 @@ function WFtp() {
                 return pm
             }
 
+            //timeLimit
+            let t = setTimeout(() => {
+
+                //destroy
+                Ftp.destroy()
+
+                //clear
+                Ftp = null
+
+                pm.reject(`timeout[${timeLimit}]`)
+            }, timeLimit)
+
             Ftp.raw('quit', (err, res) => {
+
+                //clearTimeout
+                clearTimeout(t)
+
+                //destroy
+                Ftp.destroy()
+
+                //clear
+                Ftp = null
+
                 if (err) {
                     pm.reject(err)
                 }
@@ -696,13 +801,56 @@ function WFtp() {
         }
 
 
-        async function ftpCheckFile(fpRemote) {
+        function ftpIsFolderCore(file) {
+
+            //check
+            if (!iseobj(file)) {
+                return false
+            }
+
+            //type
+            let type = get(file, 'type', -1)
+
+            //b
+            let b = type === 1
+
+            return b
+        }
+
+
+        function ftpIsFileCore(file) {
+
+            //check
+            if (!iseobj(file)) {
+                return false
+            }
+
+            //type
+            let type = get(file, 'type', -1)
+
+            //b
+            let b = type === 0
+
+            return b
+        }
+
+
+        async function ftpIsFolder(fpRemote) {
 
             //ftpStateFile
             let file = await ftpStateFile(fpRemote)
 
-            //b
-            let b = iseobj(file)
+            //ftpIsFolderCore
+            let b = ftpIsFolderCore(file)
+
+            return b
+        }
+
+
+        async function ftpIsFile(fpRemote) {
+
+            //ftpIsFileCore
+            let b = await ftpIsFileCore(fpRemote)
 
             return b
         }
@@ -743,6 +891,22 @@ function WFtp() {
             let file = await ftpStateFile(fpRemote)
             // console.log('file', file)
 
+            //ftpIsFileCore
+            let b = await ftpIsFileCore(file)
+            // console.log('b', b)
+
+            //check
+            if (!b) {
+                pm.reject(`fpRemote[${fpRemote}] is not a file`)
+                return pm
+            }
+
+            //check
+            if (!iseobj(file)) {
+                pm.reject(`fpRemote[${fpRemote}] does not have information`)
+                return pm
+            }
+
             //fileSize
             let fileSize = get(file, 'size')
 
@@ -754,10 +918,19 @@ function WFtp() {
             fileSize = cint(fileSize)
             // console.log('fileSize', fileSize)
 
+            //timeLimit
+            let t = setTimeout(() => {
+                pm.reject(`timeout[${timeLimit}]`)
+            }, timeLimit)
+
             Ftp.get(fpRemote, (err, socket) => {
 
                 //check
                 if (err) {
+
+                    //clearTimeout
+                    clearTimeout(t)
+
                     pm.reject(err)
                 }
 
@@ -795,6 +968,10 @@ function WFtp() {
 
                 //on close
                 socket.on('close', (err) => {
+
+                    //clearTimeout
+                    clearTimeout(t)
+
                     if (err) {
                         pm.reject(err)
                     }
@@ -861,18 +1038,31 @@ function WFtp() {
             // //createReadStream
             // let reader = fs.createReadStream(fpLocal)
 
+            //timeLimit
+            let t = setTimeout(() => {
+                pm.reject(`timeout[${timeLimit}]`)
+            }, timeLimit)
+
             let dss = 0
             Ftp.put(bufferLocal, fpRemote, (err, buffer) => {
                 // console.log('Ftp.put', err, buffer)
 
                 //check
                 if (err) {
+
+                    //clearTimeout
+                    clearTimeout(t)
+
                     pm.reject(err)
                     return
                 }
 
                 //check
                 if (size(buffer) === 0) {
+
+                    //clearTimeout
+                    clearTimeout(t)
+
                     pm.resolve('ok')
                     return
                 }
@@ -906,11 +1096,9 @@ function WFtp() {
 
             //ftpLs
             let fsRemote = await ftpLs(fdRemote)
-            // fsRemote = map(fsRemote, (v) => {
-            //     let d = dayjs(v.time)
-            //     v.stat = d.format('YYYY-MM-DDTHH:mm:ss')
-            //     return v
-            // })
+            fsRemote = filter(fsRemote, (v) => {
+                return !v.isFolder
+            })
             // console.log('fsRemote', fsRemote)
 
             //check fdLocal
@@ -1083,7 +1271,8 @@ function WFtp() {
             conn: ftpConn,
             ls: ftpLs,
             stateFile: ftpStateFile,
-            checkFile: ftpCheckFile,
+            isFile: ftpIsFile,
+            isFolder: ftpIsFolder,
             download: ftpDownload,
             syncToLocal: ftpSyncToLocal,
             syncToRemote: ftpSyncToRemote,
@@ -1111,7 +1300,7 @@ export default WFtp
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.10</a> on Sat Jul 23 2022 21:29:33 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 3.6.10</a> on Sat Sep 03 2022 15:35:03 GMT+0800 (台北標準時間) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>