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
+ Mobiletto
2
+ =========
3
+
4
+ Mobiletto je abstraktna plast za shranjevanje JavaScript z izbirnim preglednim šifriranjem na strani odjemalca.
5
+
6
+ # Vsebina
7
+ * [Zakaj Mobiletto?](#Zakaj-Mobiletto?)
8
+ * [Hitri začetek](#Hitri začetek)
9
+ * [Mobiletto CLI](#mobiletto-cli)
10
+ * [Vir](#Vir)
11
+ * [Osnovna uporaba](#Basic-usage)
12
+ * [Metapodatki](#Metapodatki)
13
+ * [Nadomestni slog uvoza](#Alternate-import-style)
14
+ * [Caching](#Caching)
15
+ * [Zrcaljenje](#Zrcaljenje)
16
+ * [Prozorno šifriranje](#Transparent-encryption)
17
+ * [Vrtenje tipk](#Vrtenje tipk)
18
+ * [Vmesnik gonilnika](#Vmesnik gonilnika)
19
+ * [Beleženje](#Beleženje)
20
+
21
+ # Preberite to v drugem jeziku
22
+ Ta dokument README.md je bil preveden prek [hokeylization](https://github.com/cobbzilla/hokeylization) v
23
+ **[vsak jezik, ki ga podpira Google Prevajalnik](https://cloud.google.com/translate/docs/languages)!**
24
+
25
+ Prepričan sem, da ni popolno, a upam, da je bolje kot nič!
26
+
27
+ [🇸🇦 arabščina](../ar/README.md)
28
+ [🇧🇩 bengalščina](../bn/README.md)
29
+ [🇩🇪 nemščina](../de/README.md)
30
+ [🇺🇸 angleščina](../en/README.md)
31
+ [🇪🇸 španščina](../es/README.md)
32
+ [🇫🇷 francoščina](../fr/README.md)
33
+ [🇹🇩 Hausa](../ha/README.md)
34
+ [🇮🇳 Hindi](../hi/README.md)
35
+ [🇮🇩 indonezijščina](../id/README.md)
36
+ [🇮🇹 italijanščina](../it/README.md)
37
+ [🇯🇵 japonščina](../ja/README.md)
38
+ [🇰🇷 korejščina](../ko/README.md)
39
+ [🇮🇳 Maranthi](../mr/README.md)
40
+ [🇵🇱 poljščina](../pl/README.md)
41
+ [🇧🇷 portugalščina](../pt/README.md)
42
+ [🇷🇺 rusko](../ru/README.md)
43
+ [🇰🇪 svahili](../sw/README.md)
44
+ [🇵🇭 Tagalog](../tl/README.md)
45
+ [🇹🇷 turščina](../tr/README.md)
46
+ [🇵🇰 urdu](../ur/README.md)
47
+ [🇻🇳 vietnamščina](../vi/README.md)
48
+ [🇨🇳 kitajščina](../zh/README.md)
49
+
50
+
51
+ **[📚 ... Vsi jeziki ...](../README.md)**
52
+ ----
53
+
54
+ ### Ali obstaja težava s tem prevodom README?
55
+ Ta poseben prevod izvirnika [README](https://github.com/cobbzilla/mobiletto/blob/master/README.md)
56
+ je lahko pomanjkljivo -- *popravki so zelo dobrodošli!* Prosimo, pošljite [zahtevo za vlečenje na GitHub](https://github.com/cobbzilla/mobiletto/pulls),
57
+ ali če vam to ni všeč, [odprite težavo](https://github.com/cobbzilla/mobiletto/issues)
58
+
59
+ Ko ustvarite novo težavo GitHub o prevodu, naredite naslednje:
60
+ * vključite URL strani (kopirajte/prilepite iz naslovne vrstice brskalnika)
61
+ * vključi točno besedilo, ki je napačno (kopiraj/prilepi iz brskalnika)
62
+ * Prosimo, opišite, kaj je narobe -- ali je prevod napačen? je formatiranje nekako pokvarjeno?
63
+ * vljudno prosim za predlog boljšega prevoda oziroma kako naj bo besedilo pravilno oblikovano
64
+ * **Hvala vam!**
65
+
66
+ ## Zakaj Mobiletto?
67
+
68
+ ### Adijo zaklepanje prodajalca!
69
+ Različni ponudniki shranjevanja v oblaku imajo nezdružljive API-je. Tudi tisti, ki si prizadevajo za "združljivost S3"
70
+ imajo idiosinkratično vedenje.
71
+
72
+ Ko izberete določenega prodajalca prostora za shranjevanje za svojo aplikacijo, če kodirate neposredno v njihov API, vašo aplikacijo
73
+ je zdaj odvisen od te storitve. Ko čas mineva in se koda kopiči, pride do menjave prodajalcev
74
+ vse bolj nevzdržno. Dobrodošli v zabavnem svetu zaklenjenosti prodajalca!
75
+
76
+ Mobiletto je bil zasnovan za rešitev tega problema. Če svojo aplikacijo kodirate v API mobiletto, lahko enostavno
77
+ spremenite ponudnike shranjevanja in vedite, da se bo plast shranjevanja vaše aplikacije obnašala enako.
78
+
79
+ ### Obsežno testiranje
80
+ Vsi vozniki so preizkušeni glede enakega obnašanja s 60+ testi za vsakega voznika.
81
+ Testiramo vse voznike z vsako kombinacijo:
82
+ * Šifriranje: omogočeno in onemogočeno
83
+ * Predpomnilnik Redis: omogočen in onemogočen
84
+
85
+ S tem pristopom smo prepričani, da se bo mobiletto obnašal enako ne glede na to, kateri gonilnik uporabljate,
86
+ in ne glede na to, ali omogočite predpomnjenje in/ali šifriranje.
87
+
88
+ ### Podpora za gonilnike
89
+ Trenutni gonilniki za shranjevanje Mobiletto:
90
+ * `s3` : Amazon S3
91
+ * `b2` : Backblaze B2
92
+ * `local` : lokalni datotečni sistem
93
+
94
+ *Prispevki za podporo več ponudnikov shranjevanja v oblaku so zelo dobrodošli!*
95
+
96
+ ## mobiletto-cli
97
+ Mobiletto naj bi ga kot knjižnico uporabljala druga koda JavaScript.
98
+
99
+ Za delo z mobiletto v ukazni vrstici uporabite [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
100
+
101
+ ## Vir
102
+ * [mobiletto na GitHubu](https://github.com/cobbzilla/mobiletto)
103
+ * [mobiletto na npm](https://www.npmjs.com/package/mobiletto)
104
+
105
+ ## Hiter začetek
106
+ Kratek primer uporabe gonilnika mobiletto `s3` .
107
+
108
+ Ta koda bi delovala enako, če bi bil gonilnik `b2` ali `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
+ ## Osnovna uporaba
139
+ Veliko obširnejši primer, ki prikazuje večino ponujenih funkcij:
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
+ ## Metapodatki
241
+ Ukaz `metadata` vrne metapodatke o posameznem vnosu datotečnega sistema.
242
+ Podobno je vrnjena vrednost iz ukaza `list` niz metapodatkovnih objektov.
243
+
244
+ Metapodatkovni objekt je videti takole:
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
+ Lastnost `type` type` je lahko `file` file`, `dir` , `link` ali `special` .
255
+
256
+ Odvisno od vrste gonilnika ukaz `list` morda ne vrne vseh polj. Lastnosti `name` in `type`
257
+ mora biti vedno prisoten. Naslednji ukaz `metadata` bo vrnil vse razpoložljive lastnosti.
258
+
259
+ ## Nadomestni slog uvoza
260
+ Uvozite modul s polnim obsegom in uporabite funkcijo `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
+ ## Predpomnilnik
268
+ Mobiletto najbolje deluje s predpomnilnikom <a href="https://redis.io">redis</a> .
269
+
270
+ Mobiletto se bo poskušal povezati z instanco redis na 127.0.0.1:6379
271
+
272
+ Preglasite lahko eno od teh možnosti:
273
+ * Nastavite spremenljivko env `MOBILETTO_REDIS_HOST` MOBILETTO_REDIS_HOST`, mobile naj se poveže tukaj namesto lokalnega gostitelja
274
+ * Nastavite spremenljivko env `MOBILETTO_REDIS_PORT` , ta vrata bodo uporabljena
275
+
276
+ Mobiletto bo vse svoje ključe redis shranil s predpono `_mobiletto__` . To lahko spremenite
277
+ z nastavitvijo `MOBILETTO_REDIS_PREFIX` env var.
278
+
279
+ Predpomnjenje za vsako povezavo lahko nastavite tudi s predmetom `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
+ ### Ne želite redis predpomnjenja?
291
+ Če želite onemogočiti: `enabled: false` v svoj objekt `opts.redisConfig` , ko vzpostavite povezavo.
292
+
293
+ Kot je razloženo spodaj, bo onemogočanje predpomnjenja negativno vplivalo na zmogljivost in povzročilo več zahtev
294
+ za shranjevanje, ki ga resnično potrebujete.
295
+
296
+ ### Navodila za predpomnjenje
297
+ **Šifrirano shranjevanje**: branje/zapisovanje v šifrirano shranjevanje je le malo počasnejše od običajnega,
298
+ vendar je navigacija po imenikih (kar nekatere stvari počnejo) precej draga. Uporaba predpomnilnika redis
299
+ vam bo znatno povečal učinkovitost.
300
+
301
+ Privzeti predpomnilnik je varen, vendar ne deluje dobro, če imate veliko operacij pisanja/odstranjevanja.
302
+ Vsaka operacija zapisovanja ali odstranjevanja razveljavi celoten predpomnilnik, kar zagotavlja, da bodo naslednja branja videla
303
+ zadnje spremembe.
304
+
305
+ ### Orodja CLI
306
+ Če uporabljate orodje CLI, kot je [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
307
+ zagotovo boste želeli omogočiti predpomnilnik `mo` .
308
+
309
+ ## Zrcaljenje
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
+ Ukaz `mirror` izvede enkratno kopijo vseh datotek z enega mobilnega telefona na drugega.
318
+ Ne izvaja nobenega postopka za vzdrževanje ogledala skozi čas. Znova zaženite ukaz `mirror`
319
+ za sinhronizacijo morebitnih manjkajočih datotek.
320
+
321
+ Vrednost, vrnjena iz `mirror` , je preprost objekt s števci za število uspešno obdelanih datotek
322
+ zrcaljeno in koliko datotek je imelo napake:
323
+
324
+ {
325
+ success: count-of-files-mirrored,
326
+ errors: count-of-files-with-errors
327
+ }
328
+
329
+ OPOZORILO: Zrcaljenje velikih naborov podatkov je lahko zelo zamudno in zahteva pasovno širino
330
+
331
+ S semantiko klica `mirror` je lahko včasih zmedeno razumeti, kdo je
332
+ bralec in kdo je pisec. Predstavljajte si to kot izjavo o dodelitvi: "levi mobiletto"
333
+ je stvar, ki je dodeljena (zapisani zrcaljeni podatki) in "desni mobiletto" (
334
+ argument metode `mirror` ) je vrednost, ki se dodeli (preberejo se zrcalni podatki).
335
+
336
+ ## Transparentno šifriranje
337
+ Omogoči pregledno šifriranje na strani odjemalca:
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
+ Kaj se dogaja? Ločen "vnos imenika" (dirent) imenik (šifriran) spremlja, katere datoteke so v njem
357
+ imenik (ali dirent imenik).
358
+ * Ukaz `list` prebere vnosne datoteke imenika in dešifrira vsako navedeno pot; nato vrne metapodatke za vsako datoteko
359
+ * Ukazi `list` so bolj neučinkoviti, še posebej za imenike z velikim številom datotek
360
+ * Ukaz `write` zapiše dirent datoteke v dirent direktorij vsakega starša, rekurzivno; nato zapiše datoteko
361
+ * Ukazi `write` bodo povzročili O(N) zapisov, pri čemer je N = globina v hierarhiji imenika
362
+ * Ukaz `remove` odstrani ustrezno dirent datoteko in njeno nadrejeno datoteko, če je prazna; nato odstrani datoteko
363
+ * Nerekurzivni ukazi `remove` bodo povzročili O(N) branj in potencialno prav toliko brisov, pri čemer je N = globina v hierarhiji imenika
364
+ * Rekurzivni ukazi `remove` v velikih in globokih datotečnih sistemih so lahko dragi
365
+
366
+ Upoštevajte, da tudi z omogočenim šifriranjem na strani odjemalca nasprotnik s popolnim vpogledom v vašo šifrirano stran strežnika
367
+ shranjevanje lahko tudi brez ključa še vedno vidi skupno število imenikov in koliko datotek je v vsakem ter z
368
+ malo truda, odkrijte del ali celotno celotno strukturo hierarhije imenika.
369
+ *Opomba: za večjo varnost uporabite razmeroma ravno strukturo.*
370
+ Nasprotnik ne bi poznal imen imenikov/datotek, razen če bi poznal tudi vaše šifriranje
371
+ ključ ali kako drugače uspešno razbil šifriranje. Potem so vse stave izključene!
372
+
373
+ ### Zmogljivost in predpomnjenje
374
+ Operacije v šifriranem pomnilniku so lahko počasne. Rekurzivni seznami in odstranitve so lahko zelo počasni.
375
+ Predpomnjenje prek redisa izjemno pomaga, vendar upoštevajte, da se predpomnilnik izprazni ob kakršnem koli zapisovanju ali odstranjevanju.
376
+
377
+ ## Vrtenje ključev
378
+ Ustvarite mobiletto s svojim novim ključem, nato pa vanj zrcaljite stare podatke:
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
+ ## Vmesnik gonilnika
391
+ Gonilnik je katera koli datoteka JS, ki izvozi funkcijo 'storageClient' s tem podpisom:
392
+
393
+ function storageClient (key, secret, opts)
394
+
395
+ * `key` : niz, vaš API ključ (za `local` gonilnik je to osnovni imenik)
396
+ * `secret` : niz, vaša skrivnost API-ja (lahko jo izpustite za `local` gonilnik)
397
+ * `opts` : objekt, lastnosti so za vsak gonilnik:
398
+ * Za `local` local` lastnosti `fileMode` in `dirMode` določata, kako se ustvarjajo nove datoteke in imeniki
399
+ * Za `s3` je zahtevana lastnost `bucket` . Izbirne lastnosti so:
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
+ Objekt, ki ga vrne funkcija storageClient, mora definirati te funkcije:
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
+ ## Beleženje
431
+ Mobiletto uporablja knjižnico za beleženje [winston](https://www.npmjs.com/package/winston).
432
+
433
+ Dnevniki **bodo** vsebovali poti datotek in sporočila o napakah, vendar **nikoli** ne bodo vsebovali ključev, skrivnosti,
434
+ ali katere koli druge informacije o konfiguraciji povezave.
435
+
436
+ ### Nivo dnevnika
437
+ Uporabite spremenljivko okolja `MOBILETTO_LOG_LEVEL` , da nastavite raven dnevnika z eno
438
+ ravni `npm` , opredeljenih v [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
439
+
440
+ Privzeta raven je `error` . Najbolj podrobna raven je `silly` , čeprav trenutno mobiletto
441
+ se ne beleži na ravneh pod `debug`
442
+
443
+ MOBILETTO_LOG_LEVEL=silly # maximum logs!
444
+
445
+ ### Dnevniška datoteka
446
+ Zapisovalnik privzeto piše v konzolo. Za pošiljanje dnevnikov v datoteko nastavite `MOBILETTO_LOG_FILE`
447
+ spremenljivka okolja. Ko se prijavite v datoteko, se dnevniki ne bodo več zapisovali v konzolo.
448
+
449
+ MOBILETTO_LOG_FILE=/var/my_mobiletto_log
450
+
451
+ Za izklop beleženja:
452
+
453
+ MOBILETTO_LOG_FILE=/dev/null
454
+
455
+ </pre>