mobiletto 1.1.10 → 1.1.11

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 (116) hide show
  1. package/README.md +48 -0
  2. package/docs/README.md +113 -0
  3. package/docs/af/README.md +455 -0
  4. package/docs/am/README.md +455 -0
  5. package/docs/ar/README.md +455 -0
  6. package/docs/az/README.md +455 -0
  7. package/docs/be/README.md +455 -0
  8. package/docs/bg/README.md +455 -0
  9. package/docs/bn/README.md +455 -0
  10. package/docs/bs/README.md +455 -0
  11. package/docs/ca/README.md +455 -0
  12. package/docs/ceb/README.md +455 -0
  13. package/docs/co/README.md +455 -0
  14. package/docs/cs/README.md +455 -0
  15. package/docs/cy/README.md +455 -0
  16. package/docs/da/README.md +455 -0
  17. package/docs/de/README.md +455 -0
  18. package/docs/el/README.md +455 -0
  19. package/docs/eo/README.md +455 -0
  20. package/docs/es/README.md +455 -0
  21. package/docs/et/README.md +455 -0
  22. package/docs/eu/README.md +455 -0
  23. package/docs/fa/README.md +455 -0
  24. package/docs/fi/README.md +455 -0
  25. package/docs/fr/README.md +455 -0
  26. package/docs/fy/README.md +455 -0
  27. package/docs/ga/README.md +455 -0
  28. package/docs/gd/README.md +455 -0
  29. package/docs/gl/README.md +455 -0
  30. package/docs/gu/README.md +455 -0
  31. package/docs/ha/README.md +455 -0
  32. package/docs/haw/README.md +455 -0
  33. package/docs/he/README.md +455 -0
  34. package/docs/hi/README.md +455 -0
  35. package/docs/hmn/README.md +455 -0
  36. package/docs/hr/README.md +455 -0
  37. package/docs/ht/README.md +455 -0
  38. package/docs/hu/README.md +455 -0
  39. package/docs/hy/README.md +455 -0
  40. package/docs/id/README.md +455 -0
  41. package/docs/ig/README.md +455 -0
  42. package/docs/is/README.md +455 -0
  43. package/docs/it/README.md +455 -0
  44. package/docs/iw/README.md +455 -0
  45. package/docs/ja/README.md +455 -0
  46. package/docs/jv/README.md +455 -0
  47. package/docs/ka/README.md +455 -0
  48. package/docs/kk/README.md +455 -0
  49. package/docs/km/README.md +455 -0
  50. package/docs/kn/README.md +455 -0
  51. package/docs/ko/README.md +455 -0
  52. package/docs/ku/README.md +455 -0
  53. package/docs/ky/README.md +455 -0
  54. package/docs/la/README.md +455 -0
  55. package/docs/lb/README.md +455 -0
  56. package/docs/lo/README.md +455 -0
  57. package/docs/lt/README.md +455 -0
  58. package/docs/lv/README.md +455 -0
  59. package/docs/mg/README.md +455 -0
  60. package/docs/mi/README.md +455 -0
  61. package/docs/mk/README.md +455 -0
  62. package/docs/ml/README.md +455 -0
  63. package/docs/mn/README.md +455 -0
  64. package/docs/mr/README.md +455 -0
  65. package/docs/ms/README.md +455 -0
  66. package/docs/mt/README.md +455 -0
  67. package/docs/my/README.md +455 -0
  68. package/docs/ne/README.md +455 -0
  69. package/docs/nl/README.md +455 -0
  70. package/docs/no/README.md +455 -0
  71. package/docs/ny/README.md +455 -0
  72. package/docs/or/README.md +455 -0
  73. package/docs/pa/README.md +455 -0
  74. package/docs/pl/README.md +455 -0
  75. package/docs/ps/README.md +455 -0
  76. package/docs/pt/README.md +455 -0
  77. package/docs/ro/README.md +455 -0
  78. package/docs/ru/README.md +455 -0
  79. package/docs/rw/README.md +455 -0
  80. package/docs/sd/README.md +455 -0
  81. package/docs/si/README.md +455 -0
  82. package/docs/sk/README.md +455 -0
  83. package/docs/sl/README.md +455 -0
  84. package/docs/sm/README.md +455 -0
  85. package/docs/sn/README.md +455 -0
  86. package/docs/so/README.md +455 -0
  87. package/docs/sq/README.md +455 -0
  88. package/docs/sr/README.md +455 -0
  89. package/docs/st/README.md +455 -0
  90. package/docs/su/README.md +455 -0
  91. package/docs/sv/README.md +455 -0
  92. package/docs/sw/README.md +455 -0
  93. package/docs/ta/README.md +455 -0
  94. package/docs/te/README.md +455 -0
  95. package/docs/tg/README.md +455 -0
  96. package/docs/th/README.md +455 -0
  97. package/docs/tk/README.md +455 -0
  98. package/docs/tl/README.md +455 -0
  99. package/docs/tr/README.md +455 -0
  100. package/docs/tt/README.md +455 -0
  101. package/docs/ug/README.md +455 -0
  102. package/docs/uk/README.md +455 -0
  103. package/docs/ur/README.md +455 -0
  104. package/docs/uz/README.md +455 -0
  105. package/docs/vi/README.md +455 -0
  106. package/docs/xh/README.md +455 -0
  107. package/docs/yi/README.md +455 -0
  108. package/docs/yo/README.md +455 -0
  109. package/docs/zh/README.md +455 -0
  110. package/docs/zu/README.md +455 -0
  111. package/drivers/b2/index.js +24 -6
  112. package/hokey.json +16 -0
  113. package/index.js +7 -2
  114. package/package.json +1 -1
  115. package/test/api.spec.js +12 -9
  116. package/util/redis.js +1 -1
@@ -0,0 +1,455 @@
1
+ I-Mobiletto
2
+ ==========
3
+
4
+ I-Mobiletto isendlalelo esinqamulelayo sesitoreji se-JavaScript, esinombhalo wemfihlo ongaseceleni weklayenti ongakukhetha.
5
+
6
+ # Okuqukethwe
7
+ * [Kungani i-Mobiletto?](#Why-Mobiletto?)
8
+ * [Isiqalo esisheshayo](#Qala ngokushesha)
9
+ * [Mobiletto CLI](#mobiletto-cli)
10
+ * [Umthombo](#Umthombo)
11
+ * [Ukusetshenziswa okuyisisekelo](#Ukusetshenziswa okuyisisekelo)
12
+ * [Imethadatha](#Imethadatha)
13
+ * [Esinye isitayela sokungenisa](#Esinye-isitayela sokungenisa)
14
+ * [Ukulondoloza isikhashana](#Ukulondoloza isikhashana)
15
+ * [Ukubukisa](#Ukubukisa)
16
+ * [Ukubethela okusobala](#Ukubethela-Ngaphandle)
17
+ * [Ukuzungezisa kokhiye](#Ukuzungezisa kokhiye)
18
+ * [Isixhumi esibonakalayo somshayeli](#I-Driver-interface)
19
+ * [Ukungena](#Ukungena)
20
+
21
+ # Funda lokhu ngolunye ulimi
22
+ Lo mbhalo we-README.md uhunyushwe ngokuthi [hokeylization](https://github.com/cobbzilla/hokeylization), ku-
23
+ **[zonke izilimi zisekelwa i-Google Translate](https://cloud.google.com/translate/docs/languages)!**
24
+
25
+ Ngiqinisekile ukuthi ayiphelele, kodwa ngethemba ukuthi ingcono kunalutho!
26
+
27
+ [🇸🇦 Arabic](../ar/README.md)
28
+ [🇧🇩 Bengali](../bn/README.md)
29
+ [🇩🇪 isiJalimane](../de/README.md)
30
+ [🇺🇸 IsiNgisi](../zu/README.md)
31
+ [🇪🇸 Spanish](../es/README.md)
32
+ [🇫🇷 French](../fr/README.md)
33
+ [🇹🇩 Hausa](../ha/README.md)
34
+ [🇮🇳 Hindi](../hi/README.md)
35
+ [🇮🇩 isi-Indonesian](../id/README.md)
36
+ [🇮🇹 isiNtaliyane](../it/README.md)
37
+ [🇯🇵 Japanese](../ja/README.md)
38
+ [🇰🇷 isi-Korean](../ko/README.md)
39
+ [🇮🇳 Maranthi](../mr/README.md)
40
+ [🇵🇱 Polish](../pl/README.md)
41
+ [🇧🇷 isi-Portuguese](../pt/README.md)
42
+ [🇷🇺 Russian](../ru/README.md)
43
+ [🇰🇪 Swahili](../sw/README.md)
44
+ [🇵🇭 Tagalog](../tl/README.md)
45
+ [🇹🇷 Isi-Turkish](../tr/README.md)
46
+ [🇵🇰 Urdu](../ur/README.md)
47
+ [🇻🇳 Vietnamese](../vi/README.md)
48
+ [🇨🇳 isiShayina](../zh/README.md)
49
+
50
+
51
+ **[📚 ... Zonke Izilimi ...](../README.md)**
52
+ ----
53
+
54
+ ### Ingabe kunenkinga ngalokhu kuhunyushwa kwe- README?
55
+ Lokhu kuhunyushwa koqobo [README](https://github.com/cobbzilla/mobiletto/blob/master/README.md)
56
+ ingase ibe namaphutha -- *izilungiso zamukelekile kakhulu!* Sicela uthumele [isicelo sokudonsa ku-GitHub](https://github.com/cobbzilla/mobiletto/pulls),
57
+ noma uma ungakhululekile ukwenza lokho, [vula inkinga](https://github.com/cobbzilla/mobiletto/issues)
58
+
59
+ Uma udala udaba olusha lwe-GitHub mayelana nokuhumusha, sicela wenze:
60
+ * faka i-URL yekhasi (kopisha/unamathisele kubha yekheli lesiphequluli)
61
+ * faka phakathi nombhalo ongalungile (kopisha/unamathisele esipheqululini)
62
+ * ngicela uchaze ukuthi yini engalungile -- ingabe ukuhumusha akulungile? ingabe ukufometha kwephukile ngandlela thile?
63
+ * ngomusa nikeza isiphakamiso senguqulo engcono kakhulu, noma indlela umbhalo okufanele ufomethwe kahle ngayo
64
+ * **Ngiyabonga!**
65
+
66
+ ## Kungani i-Mobiletto?
67
+
68
+ ### Sala kahle ukukhiya komthengisi!
69
+ Abahlinzeki abahlukahlukene besitoreji samafu banama-API angahambelani. Ngisho nalabo abalwela "ukuhambisana kwe-S3"
70
+ babe nokuziphatha okungaqondakali.
71
+
72
+ Uma ukhetha umdayisi othile wesitoreji wohlelo lwakho lokusebenza, uma ukhodi ngokuqondile ku-API yakhe, uhlelo lwakho lokusebenza
73
+ manje incike kuleyo sevisi. Njengoba isikhathi sihamba futhi ikhodi inqwabelana, ukushintsha abathengisi kuba
74
+ ngokungathembeki ngokwandayo. Uyemukelwa emhlabeni ojabulisayo wokukhiya ngaphakathi komthengisi!
75
+
76
+ I-Mobiletto yakhelwe ukuxazulula le nkinga. Ngokubhala ngekhodi uhlelo lwakho lokusebenza ku-mobiletto's API, ungakwazi kalula
77
+ shintsha abahlinzeki besitoreji futhi wazi ukuthi isendlalelo sesitoreji sohlelo lwakho lokusebenza sizoziphatha ngendlela efanayo.
78
+
79
+ ### Ukuhlola okubanzi
80
+ Bonke abashayeli bahlolelwa ukuziphatha okufanayo ngokuhlolwa okungu-60+ kumshayeli ngamunye.
81
+ Sihlola bonke abashayeli ngazo zonke inhlanganisela:
82
+ * Ukubethela: kokubili kunikwe amandla futhi kukhutshaziwe
83
+ * I-Cache ye-Redis: kokubili kunikwe amandla futhi kukhutshaziwe
84
+
85
+ Le ndlela isinika ukuthula kwengqondo ukuthi i-mobiletto izoziphatha ngendlela efanayo noma ngabe usebenzisa muphi umshayeli,
86
+ futhi kungakhathalekile ukuthi unika amandla ukulondoloza isikhashana kanye/noma ukubethela.
87
+
88
+ ### Ukwesekwa kwabashayeli
89
+ Abashayeli besitoreji bamanje be-Mobiletto:
90
+ * `s3` : Amazon S3
91
+ * `b2` : I-Backblaze B2
92
+ * `local` : uhlelo lwefayela lwasendaweni
93
+
94
+ *Iminikelo yokusekela abahlinzeki abengeziwe besitoreji samafu yamukelekile kakhulu!*
95
+
96
+ ## mobiletto-cli
97
+ I-Mobiletto ihloselwe ukusetshenziswa njengomtapo wolwazi ngenye ikhodi ye-JavaScript.
98
+
99
+ Ukuze usebenze ne-mobiletto kulayini womyalo, sebenzisa i-[mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
100
+
101
+ ## Umthombo
102
+ * [i-mobiletto ku-GitHub](https://github.com/cobbzilla/mobiletto)
103
+ * [i-mobiletto ku-npm](https://www.npmjs.com/package/mobiletto)
104
+
105
+ ## Ukuqala Ngokushesha
106
+ Isibonelo esifushane sisebenzisa umshayeli we-mobiletto `s3` .
107
+
108
+ Le khodi izosebenza ngendlela efanayo uma umshayeli `b2` noma `local` .
109
+
110
+ const storage = require('mobiletto')
111
+ const bucket = await storage.connect('s3', aws_key, aws_secret, {bucket: 'bk'})
112
+
113
+ // list objects: returns array of metadata objects
114
+ const listing = await bucket.list()
115
+ const dirList = await bucket.list('some/dir/')
116
+ const everything = await bucket.list('', {recursive: true})
117
+
118
+ // write an entire file
119
+ let bytesWritten = await bucket.writeFile('some/path', someBufferOfData)
120
+
121
+ // write a file from a stream/generator
122
+ bytesWritten = await bucket.write('some/path', streamOrGenerator)
123
+
124
+ // read an entire file
125
+ // returns null if an exception would otherwise be thrown
126
+ const bufferOrNull = await bucket.safeReadFile('some/path')
127
+
128
+ // stream-read a file, passing data to callback
129
+ const bytesRead = await bucket.read('some/path', (chunk) => { ...do something with chunk... } )
130
+
131
+ // remove a file, returns the path removed
132
+ let removed = await bucket.remove('some/path') // removed is a string
133
+
134
+ // remove a directory, returns array of paths removed
135
+ removed = await bucket.remove('some/directory', {recursive: true}) // removed is now an array!
136
+
137
+ ----
138
+ ## Ukusetshenziswa okuyisisekelo
139
+ Isibonelo esibanzi kakhulu, esibonisa izici eziningi ezinikezwayo:
140
+
141
+ const { mobiletto } = require('mobiletto')
142
+
143
+ // General usage
144
+ const api = await mobiletto(driverName, key, secret, opts)
145
+
146
+ // To use 'local' driver:
147
+ // * key: base directory
148
+ // * secret: ignored, can be null
149
+ // * opts object:
150
+ // * readOnly: optional, never change anything on the filesystem; default is false
151
+ // * fileMode: optional, permissions used when creating new files, default is 0600. can be string or integer
152
+ // * dirMode: optional, permissions used when creating new directories, default is 0700. can be string or integer
153
+ const local = await mobiletto('local', '/home/ubuntu/tmp', null, {fileMode: 0o0600, dirMode: '0700'})
154
+
155
+ // To use 's3' driver:
156
+ // * key: AWS Access Key ID
157
+ // * secret: AWS Secret Key
158
+ // * opts object:
159
+ // * readOnly: optional, never change anything on the bucket; default is false
160
+ // * bucket: required, name of the S3 bucket
161
+ // * region: optional, the AWS region to communicate with, default is us-east-1
162
+ // * prefix: optional, all read/writes within the S3 bucket will be under this prefix
163
+ // * delimiter: optional, directory delimiter, default is '/' (note: always '/' when encryption is enabled)
164
+ const s3 = await mobiletto('s3', aws_key, aws_secret, {bucket: 'bk', region: 'us-east-1'})
165
+
166
+ // To use 'b2' driver:
167
+ // * key: Backblaze Key ID
168
+ // * secret: Backblaze Application Key
169
+ // * opts object:
170
+ // * readOnly: optional, never change anything on the bucket; default is false
171
+ // * bucket: required, the ID (**not the name**) of the B2 bucket
172
+ // * prefix: optional, all read/writes within the B2 bucket will be under this prefix
173
+ // * delimiter: optional, directory delimiter, default is '/' (note: always '/' when encryption is enabled)
174
+ // * partSize: optional, large files will be split into chunks of this size when uploading
175
+ const b3 = await mobiletto('b2', b2_key_id, b2_app_key, {bucket: 'bk', partSize: 10000000})
176
+
177
+ // List files
178
+ api.list() // --> returns an array of metadata objects
179
+
180
+ // List files recursively
181
+ api.list({ recursive: true })
182
+
183
+ // List files in a directory
184
+ const path = 'some/path'
185
+ api.list(path)
186
+ api.list(path, { recursive: true }) // also supports recursive flag
187
+
188
+ // Visit files in a directory -- visitor function must be async
189
+ api.list(path, { visitor: myAsyncFunc })
190
+ api.list(path, { visitor: myAsyncFunc, recursive: true })
191
+
192
+ // The `list` method throws MobilettoNotFoundError if the path does not exist
193
+ // When you call `safeList` on a non-existent path, it returns an empty array
194
+ api.safeList('/path/that/does/not/exist') // returns []
195
+
196
+ // Read metadata for a file
197
+ api.metadata(path) // returns metadata object
198
+
199
+ // The `metadata` method throws MobilettoNotFoundError if the path does not exist
200
+ // When you call `safeMetadata` on a non-existent path, it returns null
201
+ api.safeMetadata('/tmp/does_not_exist') // returns null
202
+
203
+ // Read a file
204
+ // Provide a callback that writes the data someplace
205
+ const callback = (chunk) => { ... write chunk somewhere ... }
206
+ api.read(path, callback) // returns count of bytes read
207
+
208
+ // Read an entire file at once
209
+ const data = await api.readFile(path) // returns a byte Buffer of the file contents
210
+
211
+ // Read an entire file at once
212
+ // returns null if an exception would otherwise be thrown
213
+ const bufferOrNull = await bucket.safeReadFile('some/path')
214
+
215
+ // Write a file
216
+ // Provide a generator function that yields chunks of data
217
+ const generator = function* () {
218
+ while ( ... more-data-to-return ... ) {
219
+ data = ... load-data ...
220
+ yield data
221
+ }
222
+ }
223
+ local.api(path, generator) // returns count of bytes written
224
+
225
+ // Write an entire file at once (convenience method)
226
+ await api.writeFile(path, bufferOrString) // returns count of bytes written
227
+
228
+ // Delete a file
229
+ // Quiet param is optional (default false), when set errors will not be thrown if the path does not exist
230
+ // Always returns a value or throws an error.
231
+ // Return value may be a single string of the file removed, or an array of all files removed (driver-dependent)
232
+ const quiet = true
233
+ api.remove(path, {quiet}) // returns single path removed
234
+
235
+ // Recursively delete a directory and do it quietly (do not report errors)
236
+ const recursive = true
237
+ const quiet = true
238
+ api.remove(path, {recursive, quiet}) // returns array of paths removed
239
+
240
+ ## Imethadatha
241
+ Umyalo `metadata` ubuyisela imethadatha mayelana nokufakiwe kwesistimu eyodwa yefayela.
242
+ Ngokufanayo, inani elibuyayo elisuka kumyalo `list` lwezinto zemethadatha.
243
+
244
+ Into yemethadatha ibukeka kanje:
245
+
246
+ {
247
+ "name": "fully/qualified/path/to/file",
248
+ "type": "entry-type",
249
+ "size": size-in-bytes,
250
+ "ctime": creation-time-epoch-millis,
251
+ "mtime": modification-time-epoch-millis
252
+ }
253
+
254
+ Isici `type` singaba `file` , `dir` , `link` , noma `special` .
255
+
256
+ Kuye ngohlobo lomshayeli, umyalo `list` ungase ungabuyiseli zonke izinkambu. Izakhiwo `name` kanye `type`
257
+ kufanele ahlale ekhona. Umyalo `metadata` olandelayo uzobuyisela zonke izici ezitholakalayo.
258
+
259
+ ## Esinye isitayela sokungenisa
260
+ Ngenisa imojuli enescoped ngokugcwele futhi usebenzise umsebenzi `connect` :
261
+
262
+ const storage = require('mobiletto')
263
+ const opts = {bucket: 'bk', region: 'us-east-1'}
264
+ const s3 = await storage.connect('s3', aws_key, aws_secret, opts)
265
+ const objectData = await s3.readFile('some/path')
266
+
267
+ ## Ukulondoloza isikhashana
268
+ I-Mobiletto isebenza kahle kakhulu nge- <a href="https://redis.io">redis</a> cache.
269
+
270
+ I-Mobiletto izozama ukuxhuma kusibonelo se-redis kokuthi 127.0.0.1:6379
271
+
272
+ Ungakwazi ukukhipha okunye kwalokhu:
273
+ * Setha i- `MOBILETTO_REDIS_HOST` env var, i-mobiletto xhuma lapha esikhundleni se-localhost
274
+ * Setha i-env var ethi `MOBILETTO_REDIS_PORT` , le mbobo izosetshenziswa
275
+
276
+ I-Mobiletto izogcina bonke okhiye bayo be- `_mobiletto__` . Ungakushintsha lokhu
277
+ ngokusetha `MOBILETTO_REDIS_PREFIX` env var.
278
+
279
+ Ungakwazi futhi ukusetha i-caching yokuxhumana ngakunye ngento `opts.redisConfig` :
280
+
281
+ const redisConfig = {
282
+ enabled: true, // optional, default is true. if false other props are ignored
283
+ host: '127.0.0.1',
284
+ port: 6379,
285
+ prefix: '_mobiletto__'
286
+ }
287
+ const opts = { redisConfig, bucket: 'bk', region: 'us-east-1' }
288
+ const s3 = await storage.connect('s3', aws_key, aws_secret, opts)
289
+
290
+ ### Awufuni i-redis caching?
291
+ Ukukhubaza: dlula `enabled: false` amanga` entweni yakho `opts.redisConfig` uma usungula uxhumano lwakho.
292
+
293
+ Njengoba kuxoxiwe ngezansi, ukukhubaza ukugcinwa kwesikhashana kuzoba nomthelela omubi ekusebenzeni futhi kungenise izicelo eziningi
294
+ endaweni yokugcina oyidingayo ngempela.
295
+
296
+ ### Isiqondiso senqolobane
297
+ **Isitoreji esibethelwe**: isitoreji esibethelwe sokufunda/sokubhala sihamba kancane kunokujwayelekile,
298
+ kodwa ukuzulazula ezinhlwini zemibhalo (okwenziwa ezinye izinto) kubiza kakhulu. Ukusebenzisa inqolobane ye-redis
299
+ izokunikeza ukuthuthukiswa okubalulekile kokusebenza.
300
+
301
+ Inqolobane ezenzakalelayo iphephile, kodwa ayisebenzi kahle uma unemisebenzi eminingi yokubhala/ukususa.
302
+ Noma yikuphi ukubhala noma ukususa umsebenzi kwenza yonke inqolobane ingavumelekile, kuqinisekisa ukuthi ukufundwa okulandelayo kuzobona
303
+ izinguquko zakamuva.
304
+
305
+ ### CLI amathuluzi
306
+ Uma usebenzisa ithuluzi le-CLI elifana ne-[mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
307
+ nakanjani uzofuna ukuthi inqolobane ye-redis inikwe amandla, njengoba ihlala kuzo zonke izinxushunxushu zomyalo othi `mo` .
308
+
309
+ ## Ukwenza isibuko
310
+
311
+ // Copy a local filesystem mobiletto to S3
312
+ s3.mirror(local)
313
+
314
+ // Mirror a local subdirectory from one mobiletto to an S3 mobiletto, with it's own subdirectory
315
+ local.mirror(s3, 'some/local-folder', 'some/s3-folder')
316
+
317
+ Umyalo `mirror` wenza ikhophi yesikhathi esisodwa yawo wonke amafayela ukusuka ku-mobiletto eyodwa ukuya kwenye.
318
+ Ayigijimi noma iyiphi inqubo yokugcina isibuko ngokuhamba kwesikhathi. Qalisa umyalo `mirror` futhi
319
+ ukuvumelanisa noma yimaphi amafayela angekho.
320
+
321
+ Inani lokubuyisela elisuka `mirror` liyinto elula enezinto zokubala zokuthi mangaki amafayela aphumelele
322
+ kufakwe isibuko nokuthi mangaki amafayela abe namaphutha:
323
+
324
+ {
325
+ success: count-of-files-mirrored,
326
+ errors: count-of-files-with-errors
327
+ }
328
+
329
+ ISEXWAYISO: Ukulingisa amasethi amakhulu edatha kungase kudle isikhathi futhi kudle umkhawulokudonsa
330
+
331
+ Nge- `mirror` call semantics kungase kudide ukuqonda ukuthi ubani
332
+ umfundi nokuthi ubani umbhali. Kucabange njengesitatimende somsebenzi: "i-mobiletto engakwesokunxele"
333
+ into eyabelwa yona (idatha efakwe esibukweni ebhaliwe), kanye "nesandla sokudla mobiletto" (the
334
+ i-agumenti `mirror` ) inani elinikezwayo (idatha efakwe esibukweni iyafundwa).
335
+
336
+ ## Ukubethela okusobala
337
+ Nika amandla ukubethela kohlangothi lweklayenti okusobala:
338
+
339
+ // Pass encryption parameters
340
+ const encryption = {
341
+ // key is required, must be >= 16 chars
342
+ key: randomstring.generate(128),
343
+
344
+ // optional, the default is to derive IV from key
345
+ // when set, IV must be >= 16 chars
346
+ iv: randomstring.generate(128),
347
+
348
+ // optional, the default is aes-256-cbc
349
+ algo: 'aes-256-cbc'
350
+ }
351
+ const api = await mobiletto(driverName, key, secret, opts, encryption)
352
+
353
+ // Subsequent write operations will encrypt data (client side) when writing
354
+ // Subsequent read operations will decrypt data (client side) when reading
355
+
356
+ Kwenzakalani? Uhla lwemibhalo oluhlukile "lwe-directory entry" (dirent) (olubethelwe) lulandelela ukuthi yimaphi amafayela akulokho
357
+ uhla lwemibhalo (oluyi-direct directory).
358
+ * Umyalo `list` ufunda amafayela okufaka uhla lwemibhalo, uhlukanise indlela ngayinye esohlwini; bese ibuyisela imethadatha yefayela ngalinye
359
+ * Imiyalo `list` kahle, ikakhulukazi kuzinkomba ezinenani elikhulu lamafayela
360
+ * Umyalo othi `write` ubhala amafayela aqondile kuhla lwemibhalo lomzali ngamunye, ngokuphindaphindiwe; bese ebhala ifayela
361
+ * `write` imiyalo izofaka u-O(N) ekubhaleni, ngo-N = ukujula ohlwini lwemibhalo
362
+ * Umyalo othi `remove` ususa ifayela elihambisanayo, futhi umzali walo uma engenalutho, ngokuphindaphindiwe; bese ikhipha ifayela
363
+ * Imiyalo `remove` -O(N) futhi okungenzeka kususwe okuningi, ngokujula kuka-N = ohlwini lwemibhalo
364
+ * Imiyalo `remove` ephindaphindayo ezinhlelweni zamafayela ezinkulu nezijulile ingabiza
365
+
366
+ Qaphela ukuthi noma ngabe ukubethela ohlangothini lweklayenti kunikwe amandla, isitha esibonakala ngokugcwele ohlangothini lwakho lweseva olubethelwe
367
+ isitoreji, ngisho nangaphandle kokhiye, singakwazi ukubona ingqikithi yenani lezinkomba nokuthi mangaki amafayela ekuyinye, kanye ne
368
+ umzamo othile, thola okunye noma sonke isakhiwo sohlu lwemibhalo.
369
+ *Qaphela: Sebenzisa isakhiwo esiyisicaba ukuze uthole ukuphepha okungcono.*
370
+ Isitha ngeke sazi amagama ezinkomba/amafayela ngaphandle uma sikwazi nokubethela kwakho
371
+ ukhiye noma uqhekeze ngempumelelo ukubethela. Konke ukubhejwa kuyacishwa ngaleso sikhathi!
372
+
373
+ ### Ukusebenza nokugcinwa kwesikhashana
374
+ Ukusebenza kusitoreji esibethelwe kungase kuhambe kancane. Ukufakwa kuhlu okuphindaphindayo nokususwa kungahamba kancane kakhulu.
375
+ Ukulondoloza isikhashana nge-redis kusiza kakhulu, kodwa qaphela ukuthi inqolobane ithululwa kunoma yikuphi okulotshiweyo noma okukhishiwe.
376
+
377
+ ## Ukuzungezisa ukhiye
378
+ Dala i-mobiletto ngokhiye wakho omusha, bese ubonisa idatha endala kuyo:
379
+
380
+ const storage = require('mobiletto')
381
+
382
+ const oldEncryption = { key: .... }
383
+ const oldStorage = await storage.connect('s3', aws_key, aws_secret, {bucket: 'bk', region: 'us-east-1'}, oldEncryption)
384
+
385
+ const newEncryption = { key: .... }
386
+ const newStorage = await storage.connect('s3', aws_key, aws_secret, {bucket: 'zz', region: 'us-east-1'}, newEncryption)
387
+
388
+ newStorage.mirror(oldStorage) // if oldStorage is very large, this may take a looooooong time...
389
+
390
+ ## Isixhumi esibonakalayo somshayeli
391
+ Umshayeli yinoma yiliphi ifayela le-JS elithumela ngaphandle umsebenzi we-'storageClient' ngalesi siginesha:
392
+
393
+ function storageClient (key, secret, opts)
394
+
395
+ * `key` : iyunithi yezinhlamvu, ukhiye wakho we-API ( `local` lolu wuhlu lwemibhalo oluyisisekelo)
396
+ * `secret` : iyunithi yezinhlamvu, imfihlo ye-API yakho (ingashiywa kumshayeli `local` )
397
+ * `opts` ngamunye:
398
+ * `local` , izici `fileMode` kanye `dirMode` zinquma ukuthi kwakhiwe kanjani amafayela amasha nezinkomba.
399
+ * Ku `s3` , indawo `bucket` iyadingeka. Izakhiwo ozikhethela yilezi:
400
+ * `region`: the S3 region, default is us-east-1
401
+ * `prefix`: a prefix to prepend to all S3 paths, default is the empty string
402
+ * `delimiter`: the directory delimiter, default is '/'
403
+
404
+ Into ebuyiselwa umsebenzi we-StoreClient kumele ichaze le misebenzi:
405
+
406
+ // Test the driver before using, ensure proper configuration
407
+ async testConfig ()
408
+
409
+ // List files in path (or from base-directory)
410
+ // If recursive is true, list recursively
411
+ // If visitor is defined, it will be an async function. await the visitor function on each file found
412
+ // Otherwise, perform the listing and return an array of objects
413
+ async list (path, recursive = false, visitor = null) // path may be omitted
414
+
415
+ // Read metadata for a path
416
+ async metadata (path)
417
+
418
+ // Read a file
419
+ // callback receives a chunk of data. endCallback is called at end-of-stream
420
+ async read (path, callback, endCallback = null)
421
+
422
+ // Write a file
423
+ // driver must be able to handle a generator or a stream
424
+ async write (path, generatorOrReadableStream)
425
+
426
+ // Remove a file, or recursively delete a directory
427
+ // returns a string of a single path removed, or an array of multiple paths removed
428
+ async remove (path, recursive = false, quiet = false)
429
+
430
+ ## Ukugawula
431
+ I-Mobiletto isebenzisa ilabhulali yokugawula ye-[winston](https://www.npmjs.com/package/winston).
432
+
433
+ Amalogi **azoqukatha izindlela zamafayela nemilayezo yephutha, kodwa **angeke** aqukathe okhiye, izimfihlo,
434
+ noma yiluphi olunye ulwazi lokucushwa kokuxhumana.
435
+
436
+ ### Ileveli yelogi
437
+ Sebenzisa `MOBILETTO_LOG_LEVEL` okuguquguqukayo kwemvelo ukuze usethe ileveli yelogi, usebenzisa eyodwa
438
+ `npm` achazwe kokuthi [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
439
+
440
+ Izinga elizenzakalelayo lithi `error` . Izinga le-verbose kakhulu lithi `silly` , nakuba okwamanje mobiletto
441
+ ayingeni emazingeni angaphansi `debug`
442
+
443
+ MOBILETTO_LOG_LEVEL=silly # maximum logs!
444
+
445
+ ### Ifayela lokungena
446
+ Ngokuzenzakalelayo, logger ubhalela ikhonsoli. Ukuze uthumele amalogi efayeleni, setha `MOBILETTO_LOG_FILE`
447
+ imvelo variable. Uma ungena kufayela, amalogi ngeke esabhalwa kukhonsoli.
448
+
449
+ MOBILETTO_LOG_FILE=/var/my_mobiletto_log
450
+
451
+ Ukuze uvale ukugawula:
452
+
453
+ MOBILETTO_LOG_FILE=/dev/null
454
+
455
+ </pre>
@@ -125,7 +125,7 @@ class StorageClient {
125
125
  const files = []
126
126
  await this.auth()
127
127
  const hasMax = opts && opts.max
128
- const maxFileCount = hasMax ? opts.max : 100
128
+ const maxFileCount = hasMax ? opts.max : 1000
129
129
  const pfx = (this.prefix.length === 0 || this.prefix.endsWith(this.delimiter) ? this.prefix : this.prefix + this.delimiter) +
130
130
  (pth.startsWith(this.delimiter) ? pth.substring(0) : pth)
131
131
 
@@ -137,13 +137,31 @@ class StorageClient {
137
137
  })
138
138
  const handleResponse = async (files, pth, response, visitor) => {
139
139
  const list = await this.processList(pth, response, visitor)
140
+ if (list.length === 0) {
141
+ return true
142
+ }
140
143
  if (!optsDir && !firstResult && list.length > 0) {
141
144
  firstResult = list[0]
142
- if (list[0].name.endsWith(this.delimiter)) {
143
- dirDiscovered = true
144
- } else if (!dirDiscovered && list.length > 1 && list[1].name.startsWith(list[0].name)) {
145
- files.push(list[0])
146
- return true
145
+ const exact = firstResult.name === pth || firstResult.name === pth + this.delimiter
146
+ if (exact) {
147
+ // we found exactly what we were looking for
148
+ // if the next thing in the list starts with it plus delimiter,
149
+ // it is a directory, return the contents as long as they match
150
+ if (list.length > 1 && list[1].name.startsWith(pth + this.delimiter)) {
151
+ const dirEntries = list.filter(o => o.name.startsWith(pth));
152
+ files.push(...dirEntries)
153
+ return false
154
+ } else if (firstResult.name.endsWith(this.delimiter)) {
155
+ const dirEntries = list.filter(o => o.name.startsWith(pth));
156
+ files.push(...dirEntries)
157
+ dirDiscovered = true
158
+ return true
159
+
160
+ } else {
161
+ // it's an exact file-match, return it
162
+ files.push(list[0])
163
+ return true
164
+ }
147
165
  }
148
166
  }
149
167
  if (hasMax && files.length + list.length >= maxFileCount) {
package/hokey.json ADDED
@@ -0,0 +1,16 @@
1
+ {
2
+ "inputLanguage": "en",
3
+ "languages": "all",
4
+ "hokey": [
5
+ {
6
+ "name": "README",
7
+ "infile": "README.md",
8
+ "outfile": "docs/LANG/",
9
+ "excludes": ["docs/", "node_modules/", "\\.git/", "tmp/"],
10
+ "filter": "relativizeMarkdownLinks docs",
11
+ "force": true,
12
+ "markdown": true,
13
+ "index": "docs/README.md"
14
+ }
15
+ ]
16
+ }
package/index.js CHANGED
@@ -539,8 +539,13 @@ async function mobiletto (driverPath, key, secret, opts, encryption = null) {
539
539
  try {
540
540
  entries = await _loadMeta(dirent, await client.list(dirent))
541
541
  } catch (e) {
542
- if (e instanceof MobilettoNotFoundError && p.includes('/')) {
543
- return await tryParentDirForSingleFile(p, visitor, e)
542
+ if (e instanceof MobilettoNotFoundError) {
543
+ if (p.includes('/')) {
544
+ return await tryParentDirForSingleFile(p, visitor, e)
545
+ }
546
+ throw e
547
+ } else {
548
+ throw new MobilettoError(`encClient.list(${p}): ${e}`, e)
544
549
  }
545
550
  }
546
551
  if (recursive) {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "mobiletto",
3
- "version": "1.1.10",
3
+ "version": "1.1.11",
4
4
  "description": "A storage layer that presents a uniform interface to Amazon S3, Backblaze B2, and local storage",
5
5
  "main": "index.js",
6
6
  "keywords": [
package/test/api.spec.js CHANGED
@@ -129,7 +129,7 @@ if (!redisSetup.enabled) continue
129
129
 
130
130
  for (const driverName of DRIVER_NAMES) {
131
131
  // For testing single drivers
132
- // if (driverName !== 'local') continue
132
+ // if (driverName !== 'b2') continue
133
133
 
134
134
  const driverTest = `${driverName} [${redisSetup.name}]`
135
135
  const config = redisSetup.config(DRIVER_CONFIG[driverName])
@@ -373,8 +373,9 @@ describe(`${driverTest} test`, () => {
373
373
  })
374
374
  it("should successfully recursively list files and see all correct subdirectories and files", async () => {
375
375
  const allFiles = await fixture.api.list(randomParent, { recursive: true })
376
- expect(allFiles).to.have.lengthOf(fileCount + 1)
377
- expect(allFiles.find(f => f.name === fullSubdirPath && f.type === M_DIR)).to.not.be.null
376
+ expect(allFiles).to.have.lengthOf.greaterThanOrEqual(fileCount)
377
+ // Not all drivers return "dir" entries when recursively listing. We should see all the files though
378
+ // expect(allFiles.find(f => f.name === fullSubdirPath && f.type === M_DIR)).to.not.be.null
378
379
  expect(allFiles.find(f => f.name === fixture.name && f.type === M_FILE)).to.not.be.null
379
380
  for (let i = 0; i < fileCount; i++) {
380
381
  expect(allFiles.find(f => f.name === tempFilename(fixture.name, i) && f.type === M_FILE)).to.not.be.null
@@ -389,7 +390,7 @@ describe(`${driverTest} test`, () => {
389
390
  expect(objects[0]).to.have.property('type', M_DIR, `subdir should have type ${M_DIR}`)
390
391
  })
391
392
  it("should see correct types on objects returned from a listing of the subdirectory", async () => {
392
- const objects = await fixture.api.list(`${randomParent}/${subdirName}`)
393
+ const objects = await fixture.api.list(`${randomParent}/${subdirName}/`)
393
394
  expect(objects).to.have.lengthOf(fileCount)
394
395
  for (let i = 0; i < fileCount; i++) {
395
396
  // we should find all the files, and they should all have the correct type
@@ -404,15 +405,17 @@ describe(`${driverTest} test`, () => {
404
405
  expect(results).to.have.property('success').greaterThan(0, 'expected some successes in mirroring')
405
406
  })
406
407
  it("should see the same files mirrored both places", async () => {
407
- const originalThings = await fixture.api.list(fullSubdirPath)
408
+ const originalThings = await fixture.api.list(fullSubdirPath, { recursive: true })
408
409
  const mirrorPath = `${mirrorDest}${subdirName}`
409
- const mirrorThings = await fixture.mirrorApi.list(mirrorPath)
410
+ const mirrorThings = await fixture.mirrorApi.list(mirrorPath, { recursive: true })
410
411
  expect(originalThings.length === mirrorThings.length).to.be.true
411
412
 
412
- const intersection = originalThings
413
- .filter(orig => mirrorThings
413
+ const originalFiles = originalThings.filter(o => o.type === M_FILE)
414
+ const mirrorFiles = mirrorThings.filter(o => o.type === M_FILE)
415
+ const intersection = originalFiles
416
+ .filter(orig => mirrorFiles
414
417
  .find(m => basename(m.name) === basename(orig.name)))
415
- expect(intersection.length === originalThings.length).to.be.true
418
+ expect(intersection.length === originalFiles.length).to.be.true
416
419
  })
417
420
  it("loading metadata on a mirrored file succeeds", async () => {
418
421
  const destPath = mirrorDest + subdirName + '/' + basename(fixture.name)
package/util/redis.js CHANGED
@@ -54,7 +54,7 @@ class MobilettoCache {
54
54
  this.flush().then(
55
55
  () => { logger.debug(`redis(${name}): successfully flushed`) },
56
56
  (e) => {
57
- logger.error(`redis(${name}): error flushing: ${e}, not using redis!`)
57
+ logger.warn(`redis(${name}): error flushing: ${e}, disabling redis`)
58
58
  this.redis = null
59
59
  }
60
60
  )