mobiletto 1.1.8 → 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 (117) hide show
  1. package/README.md +56 -4
  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 +33 -17
  114. package/package.json +3 -2
  115. package/test/api.spec.js +319 -306
  116. package/util/logger.js +1 -1
  117. package/util/redis.js +1 -1
@@ -0,0 +1,455 @@
1
+ Mobiletto
2
+ =========
3
+
4
+ Mobiletto ialah lapisan abstraksi storan JavaScript, dengan penyulitan bahagian pelanggan telus pilihan.
5
+
6
+ # Kandungan
7
+ * [Kenapa Mobiletto?](#Why-Mobiletto?)
8
+ * [Quick start](#Quick-start)
9
+ * [Mobiletto CLI](#mobiletto-cli)
10
+ * [Sumber](#Source)
11
+ * [Penggunaan asas](#Penggunaan Asas)
12
+ * [Metadata](#Metadata)
13
+ * [Gaya import ganti](gaya import-ganti)
14
+ * [Caching](#Caching)
15
+ * [Mirroring](#Mirroring)
16
+ * [Penyulitan telus](#penyulitan telus)
17
+ * [Putaran kekunci](#Putaran kekunci)
18
+ * [Antara muka pemandu](#Antara muka Pemandu)
19
+ * [Logging](#Logging)
20
+
21
+ # Baca ini dalam bahasa lain
22
+ Dokumen README.md ini telah diterjemahkan, melalui [hokeylization](https://github.com/cobbzilla/hokeylization), ke dalam
23
+ **[setiap bahasa disokong oleh Terjemahan Google](https://cloud.google.com/translate/docs/languages)!**
24
+
25
+ Saya pasti ia tidak sempurna, tetapi saya harap ia lebih baik daripada tiada!
26
+
27
+ [🇸🇦 Bahasa Arab](../ar/README.md)
28
+ [🇧🇩 Bengali](../bn/README.md)
29
+ [🇩🇪 Bahasa Jerman](../de/README.md)
30
+ [🇺🇸 Bahasa Inggeris](../ms/README.md)
31
+ [🇪🇸 Bahasa Sepanyol](../es/README.md)
32
+ [🇫🇷 Perancis](../fr/README.md)
33
+ [🇹🇩 Hausa](../ha/README.md)
34
+ [🇮🇳 Hindi](../hi/README.md)
35
+ [🇮🇩 Indonesia](../id/README.md)
36
+ [🇮🇹 Itali](../it/README.md)
37
+ [🇯🇵 Bahasa Jepun](../ja/README.md)
38
+ [🇰🇷 Korea](../ko/README.md)
39
+ [🇮🇳 Maranthi](../mr/README.md)
40
+ [🇵🇱 Poland](../pl/README.md)
41
+ [🇧🇷 Portugis](../pt/README.md)
42
+ [🇷🇺 Rusia](../ru/README.md)
43
+ [🇰🇪 Swahili](../sw/README.md)
44
+ [🇵🇭 Tagalog](../tl/README.md)
45
+ [🇹🇷 Turki](../tr/README.md)
46
+ [🇵🇰 Urdu](../ur/README.md)
47
+ [🇻🇳 Vietnam](../vi/README.md)
48
+ [🇨🇳 Cina](../zh/README.md)
49
+
50
+
51
+ **[📚 ... Semua Bahasa ...](../README.md)**
52
+ ----
53
+
54
+ ### Adakah terdapat masalah dengan terjemahan README ini?
55
+ Terjemahan khusus [README] asal ini (https://github.com/cobbzilla/mobiletto/blob/master/README.md)
56
+ mungkin cacat -- *pembetulan amat dialu-alukan!* Sila hantar [permintaan tarik pada GitHub](https://github.com/cobbzilla/mobiletto/pulls),
57
+ atau jika anda tidak selesa berbuat demikian, [buka isu](https://github.com/cobbzilla/mobiletto/issues)
58
+
59
+ Apabila anda membuat isu GitHub baharu tentang terjemahan, sila lakukan:
60
+ * sertakan URL halaman (salin/tampal dari bar alamat penyemak imbas)
61
+ * sertakan teks tepat yang salah (salin/tampal dari penyemak imbas)
62
+ * sila terangkan apa yang salah -- adakah terjemahan itu salah? adakah pemformatan rosak entah bagaimana?
63
+ * sila tawarkan cadangan terjemahan yang lebih baik, atau cara teks harus diformat dengan betul
64
+ * **Terima kasih!**
65
+
66
+ ## Mengapa Mobiletto?
67
+
68
+ ### Selamat tinggal vendor lock-in!
69
+ Pelbagai penyedia storan awan mempunyai API yang tidak serasi. Malah mereka yang berusaha untuk "keserasian S3"
70
+ mempunyai tingkah laku idiosinkratik.
71
+
72
+ Apabila anda memilih vendor storan tertentu untuk apl anda, jika anda mengekod terus ke API mereka, apl anda
73
+ kini bergantung kepada perkhidmatan itu. Apabila masa berlalu dan kod terkumpul, menukar vendor menjadi
74
+ semakin tidak dapat dipertahankan. Selamat datang ke dunia yang menyeronokkan vendor lock-in!
75
+
76
+ Mobiletto telah direka untuk menyelesaikan masalah ini. Dengan mengekodkan apl anda kepada API mobiletto, anda boleh dengan mudah
77
+ tukar penyedia storan dan ketahui bahawa lapisan storan apl anda akan berkelakuan sama.
78
+
79
+ ### Ujian yang meluas
80
+ Semua pemandu diuji untuk tingkah laku yang sama dengan 60+ ujian untuk setiap pemandu.
81
+ Kami menguji semua pemandu dengan setiap kombinasi:
82
+ * Penyulitan: didayakan dan dilumpuhkan
83
+ * Cache Redis: kedua-duanya didayakan dan dilumpuhkan
84
+
85
+ Pendekatan ini memberi kami ketenangan fikiran bahawa mobiletto akan berkelakuan sama tanpa mengira pemandu yang anda gunakan,
86
+ dan tidak kira sama ada anda mendayakan caching dan/atau penyulitan.
87
+
88
+ ### Sokongan pemandu
89
+ Pemacu storan Mobiletto semasa:
90
+ * `s3` : Amazon S3
91
+ * `b2` : Backblaze B2
92
+ * `local` : sistem fail tempatan
93
+
94
+ *Sumbangan untuk menyokong lebih banyak penyedia storan awan amat dialu-alukan!*
95
+
96
+ ## mobiletto-cli
97
+ Mobiletto bertujuan untuk digunakan sebagai perpustakaan oleh kod JavaScript lain.
98
+
99
+ Untuk bekerja dengan mobiletto pada baris arahan, gunakan [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
100
+
101
+ ## Sumber
102
+ * [mobiletto di GitHub](https://github.com/cobbzilla/mobiletto)
103
+ * [mobiletto on npm](https://www.npmjs.com/package/mobiletto)
104
+
105
+ ## Permulaan pantas
106
+ Contoh ringkas menggunakan pemacu `s3` .
107
+
108
+ Kod ini akan berjalan sama jika pemandu adalah `b2` atau `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
+ ## Penggunaan asas
139
+ Contoh yang lebih meluas, menunjukkan kebanyakan ciri yang ditawarkan:
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
+ ## Metadata
241
+ Perintah `metadata` mengembalikan metadata tentang satu kemasukan sistem fail.
242
+ Begitu juga, nilai pulangan daripada arahan `list` ialah tatasusunan objek metadata.
243
+
244
+ Objek metadata kelihatan seperti ini:
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
+ Sifat `type` boleh menjadi `file` , `dir` , `link` , atau `special` .
255
+
256
+ Bergantung pada jenis pemacu, arahan `list` mungkin tidak mengembalikan semua medan. Sifat `name` dan `type`
257
+ hendaklah sentiasa ada. Perintah `metadata` seterusnya akan mengembalikan semua sifat yang tersedia.
258
+
259
+ ## Gaya import ganti
260
+ Import modul berskop sepenuhnya dan gunakan fungsi `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
+ ## Caching
268
+ Mobiletto berfungsi paling baik dengan cache <a href="https://redis.io">redis</a> .
269
+
270
+ Mobiletto akan cuba menyambung ke contoh redis pada 127.0.0.1:6379
271
+
272
+ Anda boleh mengatasi salah satu daripada ini:
273
+ * Tetapkan var env `MOBILETTO_REDIS_HOST` , mobiletto sambung di sini dan bukannya localhost
274
+ * Tetapkan env var `MOBILETTO_REDIS_PORT` , port ini akan digunakan
275
+
276
+ Mobiletto akan menyimpan semua kunci redisnya dengan awalan `_mobiletto__` . Anda boleh mengubah ini
277
+ dengan menetapkan var env `MOBILETTO_REDIS_PREFIX` .
278
+
279
+ Anda juga boleh menetapkan caching per sambungan dengan objek `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
+ ### Tidak mahu caching redis?
291
+ Untuk melumpuhkan: `enabled: false` dalam objek `opts.redisConfig` anda apabila anda membuat sambungan anda.
292
+
293
+ Seperti yang dibincangkan di bawah, melumpuhkan caching akan memberi kesan buruk pada prestasi dan menimbulkan lebih banyak permintaan
294
+ kepada storan yang anda perlukan.
295
+
296
+ ### Panduan caching
297
+ **Storan disulitkan**: membaca/menulis storan disulitkan hanya perlahan sedikit daripada biasa,
298
+ tetapi menavigasi di sekitar direktori (yang dilakukan oleh beberapa perkara) agak mahal. Menggunakan cache redis
299
+ akan memberi anda peningkatan prestasi yang ketara.
300
+
301
+ Cache lalai adalah selamat, tetapi tidak berfungsi dengan baik jika anda mempunyai banyak operasi tulis/buang.
302
+ Sebarang operasi tulis atau alih keluar membatalkan keseluruhan cache, memastikan bacaan seterusnya akan melihat
303
+ perubahan terkini.
304
+
305
+ ### Alat CLI
306
+ Jika anda menggunakan alat CLI seperti [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
307
+ anda pasti mahu cache redis didayakan, kerana ia berlangsung merentasi seruan perintah `mo` .
308
+
309
+ ## Mencerminkan
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
+ Arahan `mirror` melakukan salinan satu kali semua fail dari satu mobiletto ke yang lain.
318
+ Ia tidak menjalankan sebarang proses untuk mengekalkan cermin dari semasa ke semasa. Jalankan arahan `mirror` sekali lagi
319
+ untuk menyegerakkan mana-mana fail yang hilang.
320
+
321
+ Nilai pulangan daripada `mirror` ialah objek ringkas dengan pembilang untuk bilangan fail yang berjaya
322
+ dicerminkan dan bilangan fail yang mempunyai ralat:
323
+
324
+ {
325
+ success: count-of-files-mirrored,
326
+ errors: count-of-files-with-errors
327
+ }
328
+
329
+ AMARAN: Mencerminkan set data yang besar boleh memakan masa dan intensif lebar jalur
330
+
331
+ Dengan semantik panggilan `mirror` kadangkala boleh mengelirukan untuk memahami siapa itu
332
+ pembaca dan siapa penulisnya. Bayangkan ia seperti pernyataan tugasan: "mobiletto kiri"
333
+ ialah perkara yang ditugaskan kepada (data bercermin ditulis), dan "mobiletto kanan" (the
334
+ hujah kepada kaedah `mirror` ) ialah nilai yang diberikan (data bercermin dibaca).
335
+
336
+ ## Penyulitan telus
337
+ Dayakan penyulitan sisi pelanggan yang telus:
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
+ Apa yang sedang berlaku? Direktori "masukan direktori" (dirent) berasingan (disulitkan) menjejaki fail yang terdapat di dalamnya
357
+ direktori (aka direktori dirent).
358
+ * Perintah `list` membaca fail kemasukan direktori, menyahsulit setiap laluan yang disenaraikan; kemudian mengembalikan metadata untuk setiap fail
359
+ * Arahan `list` adalah lebih tidak cekap, terutamanya untuk direktori dengan bilangan fail yang banyak
360
+ * Perintah `write` menulis fail dirent dalam direktori dirent setiap ibu bapa, secara rekursif; kemudian menulis fail
361
+ * Arahan `write` akan dikenakan O(N) menulis, dengan N = kedalaman dalam hierarki direktori
362
+ * Perintah `remove` mengalih keluar fail dirent yang sepadan, dan induknya jika kosong, secara rekursif; kemudian mengeluarkan fail
363
+ * `remove` bukan rekursif akan dikenakan O(N) bacaan dan berkemungkinan sebanyak pemadaman, dengan N = kedalaman dalam hierarki direktori
364
+ * `remove` rekursif pada sistem fail besar dan dalam boleh jadi mahal
365
+
366
+ Ambil perhatian bahawa walaupun dengan penyulitan bahagian klien didayakan, musuh dengan keterlihatan penuh ke bahagian pelayan anda yang disulitkan
367
+ storan, walaupun tanpa kunci, masih boleh melihat jumlah direktori dan bilangan fail dalam setiap satu, dan dengan
368
+ sedikit usaha, temui sebahagian atau semua struktur keseluruhan hierarki direktori.
369
+ *Nota: Gunakan struktur yang agak rata untuk keselamatan yang lebih baik.*
370
+ Pihak lawan tidak akan mengetahui nama direktori/fail melainkan mereka juga mengetahui penyulitan anda
371
+ kunci atau telah berjaya memecahkan penyulitan. Semua pertaruhan dibatalkan!
372
+
373
+ ### Prestasi dan caching
374
+ Operasi pada storan yang disulitkan boleh menjadi perlahan. Penyenaraian dan pengalihan keluar rekursif boleh menjadi sangat perlahan.
375
+ Caching melalui redis sangat membantu, tetapi ambil perhatian bahawa cache disiram apabila sebarang penulisan atau dialih keluar.
376
+
377
+ ## Putaran kunci
378
+ Buat mobiletto dengan kunci baharu anda, kemudian cerminkan data lama ke dalamnya:
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
+ ## Antara muka pemandu
391
+ Pemacu ialah sebarang fail JS yang mengeksport fungsi 'storageClient' dengan tandatangan ini:
392
+
393
+ function storageClient (key, secret, opts)
394
+
395
+ * `key` : rentetan, kunci API anda (untuk pemacu `local` ini ialah direktori asas)
396
+ * `secret` : rentetan, rahsia API anda (boleh ditinggalkan untuk pemacu `local` )
397
+ * `opts` : objek, sifatnya adalah per-driver:
398
+ * Untuk `local` , sifat `fileMode` dan `dirMode` menentukan cara membuat fail dan direktori baharu dicipta
399
+ * Untuk `s3` , sifat `bucket` diperlukan. Sifat pilihan ialah:
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
+ Objek yang dikembalikan oleh fungsi storageClient mesti menentukan fungsi ini:
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
+ ## Pembalakan
431
+ Mobiletto menggunakan perpustakaan pengelogan [winston](https://www.npmjs.com/package/winston).
432
+
433
+ Log **akan** mengandungi laluan fail dan mesej ralat, tetapi **tidak akan** mengandungi kunci, rahsia,
434
+ atau sebarang maklumat konfigurasi sambungan lain.
435
+
436
+ ### Tahap log
437
+ Gunakan pembolehubah persekitaran `MOBILETTO_LOG_LEVEL` untuk menetapkan tahap log, menggunakan satu
438
+ daripada tahap `npm` yang ditakrifkan dalam [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
439
+
440
+ Tahap lalai ialah `error` . Tahap yang paling bertele-tele ialah `silly` , walaupun pada masa ini mobiletto
441
+ tidak log pada tahap di bawah `debug`
442
+
443
+ MOBILETTO_LOG_LEVEL=silly # maximum logs!
444
+
445
+ ### Fail log
446
+ Secara lalai, logger menulis ke konsol. Untuk menghantar log ke fail, tetapkan `MOBILETTO_LOG_FILE`
447
+ pembolehubah persekitaran. Apabila log masuk ke fail, log tidak lagi akan ditulis ke konsol.
448
+
449
+ MOBILETTO_LOG_FILE=/var/my_mobiletto_log
450
+
451
+ Untuk mematikan pengelogan:
452
+
453
+ MOBILETTO_LOG_FILE=/dev/null
454
+
455
+ </pre>