@webos-tools/cli 3.2.0 → 3.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (152) hide show
  1. package/.eslintignore +1 -1
  2. package/.eslintrc.js +52 -52
  3. package/.vscode/c_cpp_properties.json +21 -0
  4. package/.vscode/launch.json +97 -0
  5. package/.vscode/settings.json +13 -0
  6. package/.vscode/tasks.json +32 -0
  7. package/APIs.js +79 -79
  8. package/CHANGELOG.md +11 -5
  9. package/LICENSE +201 -201
  10. package/bin/ares-config.js +1 -1
  11. package/bin/ares-device-info.js +30 -30
  12. package/bin/ares-generate.js +274 -274
  13. package/bin/ares-inspect.js +179 -179
  14. package/bin/ares-install.js +223 -223
  15. package/bin/ares-log.js +259 -259
  16. package/bin/ares-pull.js +156 -156
  17. package/bin/ares-push.js +155 -155
  18. package/bin/ares-server.js +174 -174
  19. package/bin/ares-setup-device.js +6 -10
  20. package/bin/ares-shell.js +132 -132
  21. package/bin/ares.js +166 -166
  22. package/files/conf/ares.json +1 -2
  23. package/files/conf/ipk.json +30 -30
  24. package/files/conf/novacom-devices.json +2 -2
  25. package/files/conf/query/query-app.json +14 -14
  26. package/files/conf/query/query-hosted.json +18 -18
  27. package/files/conf/query/query-package.json +10 -10
  28. package/files/conf/query/query-service.json +6 -6
  29. package/files/conf/webos_emul +27 -27
  30. package/files/conf-base/env/sdk-apollo.json +8 -8
  31. package/files/conf-base/env/sdk-ose.json +8 -8
  32. package/files/conf-base/env/sdk-tv.json +8 -8
  33. package/files/conf-base/profile/config-apollo.json +29 -29
  34. package/files/conf-base/profile/config-ose.json +29 -29
  35. package/files/conf-base/profile/config-tv.json +31 -31
  36. package/files/conf-base/query/query-app.json +14 -14
  37. package/files/conf-base/query/query-hosted.json +18 -18
  38. package/files/conf-base/query/query-package.json +10 -10
  39. package/files/conf-base/query/query-service.json +6 -6
  40. package/files/conf-base/query/signage/query-app.json +1 -1
  41. package/files/conf-base/query/signage/query-service.json +1 -1
  42. package/files/conf-base/template-conf/ose-templates.json +67 -67
  43. package/files/conf-base/template-conf/tv-sdk-templates.json +57 -57
  44. package/files/help/ares-device.help +109 -109
  45. package/files/help/ares-install.help +95 -95
  46. package/files/help/ares-launch.help +1 -1
  47. package/files/help/ares-log-pmlogd.help +84 -84
  48. package/files/help/ares-log.help +101 -101
  49. package/files/help/ares-novacom.help +68 -68
  50. package/files/help/ares-pull.help +38 -38
  51. package/files/help/ares-push.help +38 -38
  52. package/files/help/ares-server.help +44 -44
  53. package/files/help/ares-shell.help +42 -42
  54. package/files/help/ares.help +52 -52
  55. package/files/help/readme.help +23 -23
  56. package/files/schema/ApplicationDescription.schema +319 -319
  57. package/files/templates/apollo-sdk-templates/appinfo/appinfo.json +10 -10
  58. package/files/templates/apollo-sdk-templates/bootplate-web/index.html +88 -88
  59. package/files/templates/apollo-sdk-templates/hosted-webapp/index.html +13 -13
  60. package/files/templates/apollo-sdk-templates/js-service/helloclient.js +31 -31
  61. package/files/templates/apollo-sdk-templates/js-service/helloworld_webos_service.js +188 -188
  62. package/files/templates/apollo-sdk-templates/serviceinfo/package.json +11 -11
  63. package/files/templates/apollo-sdk-templates/serviceinfo/services.json +8 -8
  64. package/files/templates/ose-sdk-templates/appinfo/appinfo.json +10 -10
  65. package/files/templates/ose-sdk-templates/bootplate-web/index.html +88 -88
  66. package/files/templates/ose-sdk-templates/hosted-webapp/index.html +13 -13
  67. package/files/templates/ose-sdk-templates/js-service/helloclient.js +31 -31
  68. package/files/templates/ose-sdk-templates/js-service/helloworld_webos_service.js +188 -188
  69. package/files/templates/ose-sdk-templates/qml-app/main.qml +68 -68
  70. package/files/templates/ose-sdk-templates/qmlappinfo/appinfo.json +10 -10
  71. package/files/templates/ose-sdk-templates/serviceinfo/package.json +11 -11
  72. package/files/templates/ose-sdk-templates/serviceinfo/services.json +8 -8
  73. package/files/templates/signage-sdk-templates/Backlight_Scheduling/index.html +1 -1
  74. package/files/templates/signage-sdk-templates/Backlight_Scheduling/scheduler.js +2 -3
  75. package/files/templates/signage-sdk-templates/File_Explorer/index.html +1 -33
  76. package/files/templates/signage-sdk-templates/File_Explorer/js/Root.js +0 -9
  77. package/files/templates/tv-sdk-templates/appinfo/appinfo.json +10 -10
  78. package/files/templates/tv-sdk-templates/bootplate-web/index.html +58 -58
  79. package/files/templates/tv-sdk-templates/bootplate-web/webOSTVjs-1.2.10/LICENSE-2.0.txt +202 -202
  80. package/files/templates/tv-sdk-templates/hosted-webapp/index.html +14 -14
  81. package/files/templates/tv-sdk-templates/js-service/helloworld_service.js +39 -39
  82. package/files/templates/tv-sdk-templates/packageinfo/packageinfo.json +3 -3
  83. package/files/templates/tv-sdk-templates/serviceinfo/package.json +11 -11
  84. package/files/templates/tv-sdk-templates/serviceinfo/services.json +8 -8
  85. package/lib/base/ares.html +40 -40
  86. package/lib/base/cli-appdata.js +290 -289
  87. package/lib/base/cli-control.js +44 -44
  88. package/lib/base/common-tools.js +29 -29
  89. package/lib/base/error-handler.js +265 -265
  90. package/lib/base/file-watcher.js +155 -155
  91. package/lib/base/help-format.js +147 -147
  92. package/lib/base/luna.js +178 -178
  93. package/lib/base/novacom.js +4 -4
  94. package/lib/base/sdkenv.js +59 -59
  95. package/lib/base/server.js +137 -137
  96. package/lib/base/setup-device.js +2 -2
  97. package/lib/base/version-tools.js +79 -79
  98. package/lib/device.js +1419 -1419
  99. package/lib/generator.js +1 -1
  100. package/lib/inspect.js +493 -493
  101. package/lib/log.js +584 -584
  102. package/lib/package.js +61 -7
  103. package/lib/pull.js +231 -231
  104. package/lib/pusher.js +210 -210
  105. package/lib/session.js +74 -74
  106. package/lib/shell.js +193 -193
  107. package/lib/tar-filter-pack.js +62 -62
  108. package/lib/util/copy.js +31 -31
  109. package/lib/util/createFileName.js +40 -40
  110. package/lib/util/eof.js +30 -30
  111. package/lib/util/json.js +63 -63
  112. package/lib/util/merge.js +14 -14
  113. package/lib/util/objclone.js +40 -40
  114. package/lib/util/spinner.js +37 -37
  115. package/npm-shrinkwrap.json +2 -2
  116. package/package.json +1 -1
  117. package/scripts/postinstall.js +24 -24
  118. package/spec/helpers/reporter.js +65 -65
  119. package/spec/jsSpecs/apiTest/generator.spec.js +372 -372
  120. package/spec/jsSpecs/apiTest/inspector.spec.js +89 -89
  121. package/spec/jsSpecs/apiTest/installer.spec.js +67 -67
  122. package/spec/jsSpecs/apiTest/launcher.spec.js +150 -150
  123. package/spec/jsSpecs/apiTest/packager.spec.js +194 -194
  124. package/spec/jsSpecs/apiTest/puller.spec.js +101 -101
  125. package/spec/jsSpecs/apiTest/pusher.spec.js +103 -103
  126. package/spec/jsSpecs/apiTest/server.spec.js +115 -115
  127. package/spec/jsSpecs/apiTest/setupDevice.spec.js +93 -93
  128. package/spec/jsSpecs/apiTest/shell.spec.js +49 -49
  129. package/spec/jsSpecs/ares-config.spec.js +88 -88
  130. package/spec/jsSpecs/ares-device.spec.js +443 -443
  131. package/spec/jsSpecs/ares-generate.spec.js +397 -401
  132. package/spec/jsSpecs/ares-inspect.spec.js +252 -252
  133. package/spec/jsSpecs/ares-install.spec.js +150 -150
  134. package/spec/jsSpecs/ares-log.spec.js +824 -824
  135. package/spec/jsSpecs/ares-novacom.spec.js +149 -149
  136. package/spec/jsSpecs/ares-pull.spec.js +157 -157
  137. package/spec/jsSpecs/ares-push.spec.js +146 -146
  138. package/spec/jsSpecs/ares-setup-device.spec.js +1 -0
  139. package/spec/jsSpecs/ares-shell.spec.js +220 -220
  140. package/spec/jsSpecs/ares.spec.js +83 -83
  141. package/spec/support/jasmine.json +22 -22
  142. package/spec/tempFiles/nativeApp/auto/pkg_arm64/appinfo.json +9 -9
  143. package/spec/tempFiles/nativeApp/ose/pkg_arm/appinfo.json +8 -8
  144. package/spec/tempFiles/nativeApp/ose/pkg_arm/package.properties +2 -2
  145. package/spec/tempFiles/nativeApp/oseEmul/pkg_x86/appinfo.json +9 -9
  146. package/spec/tempFiles/nativeApp/rsi/pkg_x86/appinfo.json +9 -9
  147. package/spec/tempFiles/sign/sign.crt +32 -32
  148. package/spec/tempFiles/sign/signPriv.key +52 -52
  149. package/spec/test_data/ares-generate.json +58 -91
  150. package/spec/test_data/ares.json +50 -50
  151. package/webos-tools-cli-3.2.1.tgz +0 -0
  152. package/webos-tools-cli-3.2.0.tgz +0 -0
package/lib/package.js CHANGED
@@ -25,8 +25,13 @@ const ar = require('ar-async'),
25
25
  temp = require('temp'),
26
26
  uglify = require('terser'),
27
27
  util = require('util'),
28
+ // zlib = require('zlib'),
29
+ // tarFilterPack = require('./tar-filter-pack'),
28
30
  errHndl = require('./base/error-handler'),
29
- tar = require('tar');
31
+ tar = require('tar'),
32
+ commonTools = require('./base/common-tools');
33
+
34
+ const appdata = commonTools.appdata;
30
35
 
31
36
  (function() {
32
37
  log.heading = 'packager';
@@ -62,10 +67,10 @@ const ar = require('ar-async'),
62
67
  this.nativecmd = false;
63
68
  this.minify = true;
64
69
  this.excludeFiles = [];
65
- this.rom = false;
66
- this.encrypt = false;
67
70
  this.sign = null;
68
71
  this.certificate = null;
72
+ this.sign = "";
73
+ this.certificate = "";
69
74
  this.appCount = 0;
70
75
  this.services = [];
71
76
  this.pkgServiceNames = [];
@@ -132,7 +137,7 @@ const ar = require('ar-async'),
132
137
 
133
138
  if (options && Object.prototype.hasOwnProperty.call(options, 'remainPlainIPK')) {
134
139
  this.remainPlainIPK = options.remainPlainIPK;
135
- }
140
+ }
136
141
 
137
142
  if (options && Object.prototype.hasOwnProperty.call(options, 'sign')) {
138
143
  if (!fs.existsSync(path.resolve(options.sign))) {
@@ -1283,6 +1288,7 @@ const ar = require('ar-async'),
1283
1288
  createDataHash.bind(this, tempCtrlDir, dataTgzFile),
1284
1289
  createCertificateHash.bind(this, tempCtrlDir),
1285
1290
  createControlFile.bind(this, tempCtrlDir, false),
1291
+ createSign.bind(this, tempCtrlDir, dataTgzFile),
1286
1292
  createControlSignFile.bind(this, tempCtrlDir),
1287
1293
  makeTgz.bind(this, tempCtrlDir, ctrlTgzFile),
1288
1294
  createDebianBinary.bind(this, tempDir),
@@ -1365,6 +1371,9 @@ const ar = require('ar-async'),
1365
1371
  }
1366
1372
 
1367
1373
  function createDataHash(dstDir, dataTgzPath, next) {
1374
+ // This function applies only to the signage profile.
1375
+ if (appdata.config.profile !== 'signage') return setImmediate(next);
1376
+
1368
1377
  const self = this;
1369
1378
  log.verbose("package#createDataHash()", "Create data hash");
1370
1379
 
@@ -1401,6 +1410,9 @@ const ar = require('ar-async'),
1401
1410
  }
1402
1411
 
1403
1412
  function createCertificateHash(dstDir, next) {
1413
+ // This function applies only to the signage profile.
1414
+ if (appdata.config.profile !== 'signage') return setImmediate(next);
1415
+
1404
1416
  const self = this;
1405
1417
  try {
1406
1418
  if (!self.certificate) {
@@ -1448,11 +1460,12 @@ const ar = require('ar-async'),
1448
1460
  ];
1449
1461
 
1450
1462
  // To IPK security (SEAL)
1451
- if (this.sign !== null) {
1463
+ // The data hashs apply only to the signage profile.
1464
+ if (this.sign !== null && appdata.config.profile === 'signage') {
1452
1465
  lines.push('Application-Hash-Algorithm: SHA-256');
1453
1466
  lines.push('Application-Hash: ' + this.dataHash);
1454
1467
  }
1455
- if (this.certificate !== null) {
1468
+ if (this.certificate !== null && appdata.config.profile === 'signage') {
1456
1469
  lines.push('Certificate-Hash: ' + this.certificateHash);
1457
1470
  lines.push('Signature-Algorithm: RSA');
1458
1471
  }
@@ -1465,6 +1478,9 @@ const ar = require('ar-async'),
1465
1478
  }
1466
1479
 
1467
1480
  function createControlSignFile(ctrlDir, next) {
1481
+ // This function applies only to the signage profile.
1482
+ if (appdata.config.profile !== 'signage') return setImmediate(next);
1483
+
1468
1484
  try {
1469
1485
  if (this.sign === null) {
1470
1486
  log.verbose("package#createControlSignFile()", "App signing is skipped");
@@ -1500,6 +1516,44 @@ const ar = require('ar-async'),
1500
1516
  }
1501
1517
  }
1502
1518
 
1519
+ function createSign(dstDir, dataTgzPath, next) {
1520
+ // This function does not apply to the signage profile.
1521
+ if (appdata.config.profile === 'signage') return setImmediate(next);
1522
+
1523
+ if ((!this.sign) || (!this.certificate)) {
1524
+ log.verbose("package#createSign()", "App signing is skipped");
1525
+ return setImmediate(next);
1526
+ }
1527
+
1528
+ const sigFilePath = path.join(dstDir, 'data.tar.gz.sha256.txt'),
1529
+ keyPath = path.resolve(this.sign),
1530
+ crtPath = path.resolve(this.certificate);
1531
+
1532
+ log.verbose("package#createSign()", "dataTgzPath:" + dataTgzPath + ", sigfile:" + sigFilePath);
1533
+ log.verbose("package#createSign()", "keyPath:" + keyPath + ", crtPath:" + crtPath);
1534
+
1535
+ try {
1536
+ // Create certificate to tmp/ctrl directory
1537
+ shelljs.cp('-f', crtPath, dstDir);
1538
+
1539
+ // Create signature and write data.tar.gz.sha256.txt
1540
+ const privateKey = fs.readFileSync(keyPath, 'utf-8'),
1541
+ dataFile = fs.readFileSync(dataTgzPath), // data.tar.gz
1542
+ signer = crypto.createSign('sha256');
1543
+
1544
+ signer.update(dataFile);
1545
+ signer.end();
1546
+
1547
+ const signature = signer.sign(privateKey),
1548
+ buff = Buffer.from(signature),
1549
+ base64data = buff.toString('base64');
1550
+
1551
+ fs.writeFile(sigFilePath, base64data, next);
1552
+ } catch (err) {
1553
+ setImmediate(next, err);
1554
+ }
1555
+ }
1556
+
1503
1557
  function createDebianBinary(dstDir, next) {
1504
1558
  const dstFilePath = path.join(dstDir, "debian-binary");
1505
1559
  log.verbose("package#createDebianBinary()", dstFilePath);
@@ -1706,7 +1760,7 @@ const ar = require('ar-async'),
1706
1760
  this.rscCount++;
1707
1761
  log.verbose("FOUND resourceinfo.json, rscCount " + this.rscCount);
1708
1762
  if (this.appCount > 0 || this.svcDir && this.svcDir.length > 0) {
1709
- return callback(errHndl.getErrMsg("NOT_PACKAGE_WITH_RESOURCE"));
1763
+ return callback(errHndl.getErrMsg("NOT_PACKAGE_WITH_RESOURCE"));
1710
1764
  }
1711
1765
  this.resources = this.resources || [];
1712
1766
  const rsc = {};
package/lib/pull.js CHANGED
@@ -1,231 +1,231 @@
1
- /*
2
- * Copyright (c) 2020-2024 LG Electronics Inc.
3
- *
4
- * SPDX-License-Identifier: Apache-2.0
5
- */
6
-
7
- const async = require('async'),
8
- fs = require('fs'),
9
- mkdirp = require('mkdirp'),
10
- npmlog = require('npmlog'),
11
- path = require('path'),
12
- streamBuffers = require('stream-buffers'),
13
- util = require('util'),
14
- errHndl = require('./base/error-handler'),
15
- novacom = require('./base/novacom'),
16
- spinner = require('./util/spinner');
17
-
18
- (function() {
19
- const log = npmlog;
20
- log.heading = 'pull';
21
- log.level = 'warn';
22
-
23
- const pull = {
24
- pull: function(srcPaths, dstPath, options, next, middleCb) {
25
- if (typeof next !== 'function') {
26
- throw errHndl.getErrMsg("MISSING_CALLBACK", "next", util.inspect(next));
27
- }
28
-
29
- const writeIsFile = new streamBuffers.WritableStreamBuffer(),
30
- writeIsDir = new streamBuffers.WritableStreamBuffer(),
31
- writeDirList = new streamBuffers.WritableStreamBuffer(),
32
- writeFileList = new streamBuffers.WritableStreamBuffer();
33
-
34
- let iCount = 0,
35
- totalSize = 0,
36
- timeStart = new Date().getTime(),
37
- timeEnd = new Date().getTime(),
38
- sourcePath = srcPaths,
39
- destinationPath = dstPath,
40
- stringArray = [];
41
-
42
- String.prototype.replaceAll = function(token, newToken, ignoreCase) {
43
- let str = this + "",
44
- i = -1;
45
-
46
- if (typeof token === "string") {
47
- if (ignoreCase) {
48
- while((i = str.toLowerCase().indexOf(token, i >= 0 ? i + newToken.length : 0)) !== -1) {
49
- str = str.substring(0, i) + newToken + str.substring(i + token.length);
50
- }
51
- } else {
52
- return this.split(token).join(newToken);
53
- }
54
- }
55
- return str;
56
- };
57
-
58
- function _makeSession(next) {
59
- if (options.session) {
60
- return next(null, options.session);
61
- } else {
62
- const printTarget = true;
63
- options.session = new novacom.Session(options.device, printTarget, next);
64
- }
65
- }
66
-
67
- function _transferFiles(session, next) {
68
- log.verbose('pull#transferFiles()', 'sourcePath:' + sourcePath + ', destinationPath:'+ destinationPath);
69
- try {
70
- const orginalSourcePath = sourcePath,
71
- dirIndex = sourcePath.length;
72
-
73
- sourcePath = sourcePath.replaceAll(" ","\\ ");
74
- let cmd = "[ -f " + sourcePath + " ] && echo 'f' || echo 'nf'";
75
-
76
- session.run(cmd, null, writeIsFile, null, function() {
77
- if (!options.silent) {
78
- spinner.start();
79
- }
80
- timeStart = new Date().getTime();
81
- if (writeIsFile.getContentsAsString() === 'f\n') {
82
- fs.exists(destinationPath, function(exists) {
83
- let stats;
84
- try {
85
- stats = fs.lstatSync(destinationPath);
86
- if (exists) {
87
- if (stats.isDirectory()) {
88
- destinationPath = path.resolve(destinationPath, path.basename(orginalSourcePath));
89
- }
90
- }
91
- } catch (err) {
92
- return setImmediate(next, errHndl.getErrMsg(err));
93
- }
94
- session.get(sourcePath, destinationPath, function(err) {
95
- if (err) {
96
- return setImmediate(next, err);
97
- } else {
98
- if (!options.ignore) {
99
- spinner.stop();
100
- middleCb("Pull: " + sourcePath + " -> " + destinationPath);
101
- }
102
- totalSize += stats.size;
103
- iCount++;
104
- setImmediate(next);
105
- }
106
- });
107
- });
108
- } else {
109
- cmd = "[ -d " + sourcePath + " ] && echo 'd' || echo 'nd'";
110
- session.run(cmd, null, writeIsDir, null, function() {
111
- function _copyAllFolders(next) {
112
- cmd = "find " + sourcePath + " -type d -follow -print";
113
- session.run(cmd, null, writeDirList, null, function() {
114
- stringArray = writeDirList.getContentsAsString().split('\n');
115
- async.eachSeries(stringArray, function(item, callback) {
116
- const filepath = path.join(destinationPath, item.substring(dirIndex));
117
- mkdirp(filepath, function(err) {
118
- if (!options.ignore && path.resolve(filepath) !== destinationPath) {
119
- spinner.stop();
120
- middleCb("Pull: " + item + " -> " + filepath);
121
- }
122
- setImmediate(callback, err);
123
- });
124
- }, function(err) {
125
- setImmediate(next, err);
126
- });
127
- });
128
- }
129
-
130
- function _copyAllFiles(next) {
131
- cmd = "find " + sourcePath + " -type f -follow -print";
132
- session.run(cmd, null, writeFileList, null, function() {
133
- if (writeFileList.size() === 0) {
134
- return setImmediate(next);
135
- }
136
-
137
- stringArray = writeFileList.getContentsAsString().split('\n');
138
- stringArray.pop();
139
- async.eachSeries(stringArray, function(item, callback) {
140
- const filepath = path.join(destinationPath, item.substring(dirIndex));
141
- session.get(item.replaceAll(" ","\\ "), filepath, function(err) {
142
- if (err) {
143
- return setImmediate(next, err);
144
- } else {
145
- if (!options.ignore) {
146
- spinner.stop();
147
- middleCb("Pull: " + item + " -> " + filepath);
148
- }
149
- iCount++;
150
- const stat = fs.lstatSync(filepath);
151
- totalSize += stat.size;
152
- setImmediate(callback);
153
- }
154
- });
155
- }, function(err) {
156
- setImmediate(next, err);
157
- });
158
- });
159
- }
160
-
161
- if (writeIsDir.getContentsAsString() === 'd\n') {
162
- destinationPath = path.resolve(path.join(destinationPath, path.basename(sourcePath)));
163
- try {
164
- const stat = fs.lstatSync(destinationPath);
165
- if (!stat.isDirectory()) {
166
- return next(errHndl.getErrMsg("NOT_DIRTYPE_PATH", destinationPath));
167
- }
168
- } catch(e) {
169
- if (e && e.code === 'ENOENT') {
170
- mkdirp.sync(destinationPath);
171
- } else {
172
- return next(e);
173
- }
174
- }
175
-
176
- if (!options.ignore) {
177
- spinner.stop();
178
- middleCb("Pull: " + sourcePath + " -> " + destinationPath);
179
- }
180
-
181
- async.waterfall([
182
- _copyAllFolders,
183
- _copyAllFiles
184
- ], function(err, result) {
185
- setImmediate(next, err, result);
186
- });
187
- } else {
188
- const err = errHndl.getErrMsg("NOT_EXIST_PATH", "SOURCE", sourcePath);
189
- return setImmediate(next, err);
190
- }
191
- });
192
- }
193
- });
194
- }
195
- catch (err) {
196
- let error;
197
- if (err.code === 1) {
198
- error = errHndl.getErrMsg("INVALID_VALUE", "path", err);
199
- }
200
- finish(error);
201
- }
202
- }
203
-
204
- function finish(err, result) {
205
- log.silly("pull#finsish()", "err:", err, ", result:", result);
206
- if (!err) {
207
- timeEnd = new Date().getTime();
208
- const timeDur = (timeEnd-timeStart)/1000;
209
- if (!options.silent) {
210
- spinner.stop();
211
- middleCb(iCount+" file(s) pulled");
212
- middleCb(Math.round((totalSize)/(1024*timeDur))+" KB/s ("+totalSize+" bytes in "+timeDur+"s)");
213
- }
214
- result = {msg:"Success"};
215
- }
216
- return next(err, result);
217
- }
218
-
219
- async.waterfall([
220
- _makeSession,
221
- _transferFiles
222
- ], function(err, result) {
223
- finish(err, result);
224
- });
225
- }
226
- };
227
-
228
- if (typeof module !== 'undefined' && module.exports) {
229
- module.exports = pull;
230
- }
231
- }());
1
+ /*
2
+ * Copyright (c) 2020-2024 LG Electronics Inc.
3
+ *
4
+ * SPDX-License-Identifier: Apache-2.0
5
+ */
6
+
7
+ const async = require('async'),
8
+ fs = require('fs'),
9
+ mkdirp = require('mkdirp'),
10
+ npmlog = require('npmlog'),
11
+ path = require('path'),
12
+ streamBuffers = require('stream-buffers'),
13
+ util = require('util'),
14
+ errHndl = require('./base/error-handler'),
15
+ novacom = require('./base/novacom'),
16
+ spinner = require('./util/spinner');
17
+
18
+ (function() {
19
+ const log = npmlog;
20
+ log.heading = 'pull';
21
+ log.level = 'warn';
22
+
23
+ const pull = {
24
+ pull: function(srcPaths, dstPath, options, next, middleCb) {
25
+ if (typeof next !== 'function') {
26
+ throw errHndl.getErrMsg("MISSING_CALLBACK", "next", util.inspect(next));
27
+ }
28
+
29
+ const writeIsFile = new streamBuffers.WritableStreamBuffer(),
30
+ writeIsDir = new streamBuffers.WritableStreamBuffer(),
31
+ writeDirList = new streamBuffers.WritableStreamBuffer(),
32
+ writeFileList = new streamBuffers.WritableStreamBuffer();
33
+
34
+ let iCount = 0,
35
+ totalSize = 0,
36
+ timeStart = new Date().getTime(),
37
+ timeEnd = new Date().getTime(),
38
+ sourcePath = srcPaths,
39
+ destinationPath = dstPath,
40
+ stringArray = [];
41
+
42
+ String.prototype.replaceAll = function(token, newToken, ignoreCase) {
43
+ let str = this + "",
44
+ i = -1;
45
+
46
+ if (typeof token === "string") {
47
+ if (ignoreCase) {
48
+ while((i = str.toLowerCase().indexOf(token, i >= 0 ? i + newToken.length : 0)) !== -1) {
49
+ str = str.substring(0, i) + newToken + str.substring(i + token.length);
50
+ }
51
+ } else {
52
+ return this.split(token).join(newToken);
53
+ }
54
+ }
55
+ return str;
56
+ };
57
+
58
+ function _makeSession(next) {
59
+ if (options.session) {
60
+ return next(null, options.session);
61
+ } else {
62
+ const printTarget = true;
63
+ options.session = new novacom.Session(options.device, printTarget, next);
64
+ }
65
+ }
66
+
67
+ function _transferFiles(session, next) {
68
+ log.verbose('pull#transferFiles()', 'sourcePath:' + sourcePath + ', destinationPath:'+ destinationPath);
69
+ try {
70
+ const orginalSourcePath = sourcePath,
71
+ dirIndex = sourcePath.length;
72
+
73
+ sourcePath = sourcePath.replaceAll(" ","\\ ");
74
+ let cmd = "[ -f " + sourcePath + " ] && echo 'f' || echo 'nf'";
75
+
76
+ session.run(cmd, null, writeIsFile, null, function() {
77
+ if (!options.silent) {
78
+ spinner.start();
79
+ }
80
+ timeStart = new Date().getTime();
81
+ if (writeIsFile.getContentsAsString() === 'f\n') {
82
+ fs.exists(destinationPath, function(exists) {
83
+ let stats;
84
+ try {
85
+ stats = fs.lstatSync(destinationPath);
86
+ if (exists) {
87
+ if (stats.isDirectory()) {
88
+ destinationPath = path.resolve(destinationPath, path.basename(orginalSourcePath));
89
+ }
90
+ }
91
+ } catch (err) {
92
+ return setImmediate(next, errHndl.getErrMsg(err));
93
+ }
94
+ session.get(sourcePath, destinationPath, function(err) {
95
+ if (err) {
96
+ return setImmediate(next, err);
97
+ } else {
98
+ if (!options.ignore) {
99
+ spinner.stop();
100
+ middleCb("Pull: " + sourcePath + " -> " + destinationPath);
101
+ }
102
+ totalSize += stats.size;
103
+ iCount++;
104
+ setImmediate(next);
105
+ }
106
+ });
107
+ });
108
+ } else {
109
+ cmd = "[ -d " + sourcePath + " ] && echo 'd' || echo 'nd'";
110
+ session.run(cmd, null, writeIsDir, null, function() {
111
+ function _copyAllFolders(next) {
112
+ cmd = "find " + sourcePath + " -type d -follow -print";
113
+ session.run(cmd, null, writeDirList, null, function() {
114
+ stringArray = writeDirList.getContentsAsString().split('\n');
115
+ async.eachSeries(stringArray, function(item, callback) {
116
+ const filepath = path.join(destinationPath, item.substring(dirIndex));
117
+ mkdirp(filepath, function(err) {
118
+ if (!options.ignore && path.resolve(filepath) !== destinationPath) {
119
+ spinner.stop();
120
+ middleCb("Pull: " + item + " -> " + filepath);
121
+ }
122
+ setImmediate(callback, err);
123
+ });
124
+ }, function(err) {
125
+ setImmediate(next, err);
126
+ });
127
+ });
128
+ }
129
+
130
+ function _copyAllFiles(next) {
131
+ cmd = "find " + sourcePath + " -type f -follow -print";
132
+ session.run(cmd, null, writeFileList, null, function() {
133
+ if (writeFileList.size() === 0) {
134
+ return setImmediate(next);
135
+ }
136
+
137
+ stringArray = writeFileList.getContentsAsString().split('\n');
138
+ stringArray.pop();
139
+ async.eachSeries(stringArray, function(item, callback) {
140
+ const filepath = path.join(destinationPath, item.substring(dirIndex));
141
+ session.get(item.replaceAll(" ","\\ "), filepath, function(err) {
142
+ if (err) {
143
+ return setImmediate(next, err);
144
+ } else {
145
+ if (!options.ignore) {
146
+ spinner.stop();
147
+ middleCb("Pull: " + item + " -> " + filepath);
148
+ }
149
+ iCount++;
150
+ const stat = fs.lstatSync(filepath);
151
+ totalSize += stat.size;
152
+ setImmediate(callback);
153
+ }
154
+ });
155
+ }, function(err) {
156
+ setImmediate(next, err);
157
+ });
158
+ });
159
+ }
160
+
161
+ if (writeIsDir.getContentsAsString() === 'd\n') {
162
+ destinationPath = path.resolve(path.join(destinationPath, path.basename(sourcePath)));
163
+ try {
164
+ const stat = fs.lstatSync(destinationPath);
165
+ if (!stat.isDirectory()) {
166
+ return next(errHndl.getErrMsg("NOT_DIRTYPE_PATH", destinationPath));
167
+ }
168
+ } catch(e) {
169
+ if (e && e.code === 'ENOENT') {
170
+ mkdirp.sync(destinationPath);
171
+ } else {
172
+ return next(e);
173
+ }
174
+ }
175
+
176
+ if (!options.ignore) {
177
+ spinner.stop();
178
+ middleCb("Pull: " + sourcePath + " -> " + destinationPath);
179
+ }
180
+
181
+ async.waterfall([
182
+ _copyAllFolders,
183
+ _copyAllFiles
184
+ ], function(err, result) {
185
+ setImmediate(next, err, result);
186
+ });
187
+ } else {
188
+ const err = errHndl.getErrMsg("NOT_EXIST_PATH", "SOURCE", sourcePath);
189
+ return setImmediate(next, err);
190
+ }
191
+ });
192
+ }
193
+ });
194
+ }
195
+ catch (err) {
196
+ let error;
197
+ if (err.code === 1) {
198
+ error = errHndl.getErrMsg("INVALID_VALUE", "path", err);
199
+ }
200
+ finish(error);
201
+ }
202
+ }
203
+
204
+ function finish(err, result) {
205
+ log.silly("pull#finsish()", "err:", err, ", result:", result);
206
+ if (!err) {
207
+ timeEnd = new Date().getTime();
208
+ const timeDur = (timeEnd-timeStart)/1000;
209
+ if (!options.silent) {
210
+ spinner.stop();
211
+ middleCb(iCount+" file(s) pulled");
212
+ middleCb(Math.round((totalSize)/(1024*timeDur))+" KB/s ("+totalSize+" bytes in "+timeDur+"s)");
213
+ }
214
+ result = {msg:"Success"};
215
+ }
216
+ return next(err, result);
217
+ }
218
+
219
+ async.waterfall([
220
+ _makeSession,
221
+ _transferFiles
222
+ ], function(err, result) {
223
+ finish(err, result);
224
+ });
225
+ }
226
+ };
227
+
228
+ if (typeof module !== 'undefined' && module.exports) {
229
+ module.exports = pull;
230
+ }
231
+ }());