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 là một lớp trừu tượng lưu trữ JavaScript, với mã hóa phía máy khách trong suốt tùy chọn.
5
+
6
+ # Nội dung
7
+ * [Tại sao lại là Mobiletto?](# Tại sao-Mobiletto?)
8
+ * [Bắt đầu nhanh](# Bắt đầu nhanh)
9
+ * [Mobiletto CLI](# mobiletto-cli)
10
+ * [Nguồn](# Nguồn)
11
+ * [Cách sử dụng cơ bản](# Cách sử dụng cơ bản)
12
+ * [Siêu dữ liệu](# Siêu dữ liệu)
13
+ * [Kiểu nhập thay thế](# Kiểu nhập thay thế)
14
+ * [Bộ nhớ đệm](# bộ nhớ đệm)
15
+ * [Phản chiếu](# Phản chiếu)
16
+ * [Mã hóa minh bạch](# Mã hóa minh bạch)
17
+ * [Xoay phím](# Xoay phím)
18
+ * [Giao diện trình điều khiển](# Giao diện trình điều khiển)
19
+ * [Ghi nhật ký](# Ghi nhật ký)
20
+
21
+ # Đọc sách này bằng ngôn ngữ khác
22
+ Tài liệu README.md này đã được dịch, qua [hokeyption](https://github.com/cobbzilla/hokeyption), sang
23
+ ** [mọi ngôn ngữ được Google Dịch hỗ trợ](https://cloud.google.com/translate/docs/languages)! **
24
+
25
+ Tôi chắc chắn rằng nó không hoàn hảo, nhưng tôi hy vọng nó còn hơn không!
26
+
27
+ [🇸🇦 tiếng Ả Rập](docs / ar / README.md)
28
+ [🇧🇩 Tiếng Bengali](docs / bn / README.md)
29
+ [🇩🇪 tiếng Đức](docs / de / README.md)
30
+ [🇺🇸 Tiếng Anh](docs / en / README.md)
31
+ [🇪🇸 Tiếng Tây Ban Nha](docs / es / README.md)
32
+ [🇫🇷 Tiếng Pháp](docs / fr / README.md)
33
+ [🇹🇩 Hausa](docs / ha / README.md)
34
+ [🇮🇳 Hindi](docs / hi / README.md)
35
+ [🇮🇩 tiếng Indonesia](docs / id / README.md)
36
+ [🇮🇹 Tiếng Ý](docs / it / README.md)
37
+ [🇯🇵 Tiếng Nhật](docs / ja / README.md)
38
+ [🇰🇷 Tiếng Hàn](docs / ko / README.md)
39
+ [🇮🇳 Maranthi](docs / mr / README.md)
40
+ [🇵🇱 Tiếng Ba Lan](docs / pl / README.md)
41
+ [🇧🇷 tiếng Bồ Đào Nha](docs / pt / README.md)
42
+ [🇷🇺 tiếng Nga](docs / ru / README.md)
43
+ [🇰🇪 Swahili](docs / sw / README.md)
44
+ [🇵🇭 Tagalog](docs / tl / README.md)
45
+ [🇹🇷 tiếng Thổ Nhĩ Kỳ](docs / tr / README.md)
46
+ [🇵🇰 Urdu](docs / ur / README.md)
47
+ [🇻🇳 Tiếng Việt](docs / vi / README.md)
48
+ [🇨🇳 Tiếng Trung](docs / zh / README.md)
49
+
50
+
51
+ ** [📚 ... Tất cả ngôn ngữ ...](docs / README.md) **
52
+ ----
53
+
54
+ ### Có sự cố với bản dịch README này không?
55
+ Bản dịch cụ thể này của bản gốc [README](https://github.com/cobbzilla/mobiletto/blob/master/README.md)
56
+ có thể có sai sót - * rất hoan nghênh việc sửa chữa! * Vui lòng gửi [yêu cầu kéo trên GitHub](https://github.com/cobbzilla/mobiletto/pulls),
57
+ hoặc nếu bạn không thoải mái khi làm điều đó, hãy [mở sự cố](https://github.com/cobbzilla/mobiletto/issues)
58
+
59
+ Khi bạn tạo một vấn đề GitHub mới về bản dịch, vui lòng thực hiện:
60
+ * bao gồm URL của trang (sao chép / dán từ thanh địa chỉ trình duyệt)
61
+ * bao gồm văn bản chính xác bị sai (sao chép / dán từ trình duyệt)
62
+ * vui lòng mô tả những gì là sai - bản dịch không chính xác? định dạng có bị hỏng bằng cách nào đó không?
63
+ * vui lòng đưa ra gợi ý về bản dịch tốt hơn hoặc cách văn bản phải được định dạng đúng
64
+ * **Cảm ơn bạn!**
65
+
66
+ ## Tại sao Mobiletto?
67
+
68
+ ### Tạm biệt khóa cửa nhà cung cấp!
69
+ Các nhà cung cấp dịch vụ lưu trữ đám mây khác nhau có các API không tương thích. Ngay cả những người phấn đấu cho "khả năng tương thích S3"
70
+ có những hành vi mang phong cách riêng.
71
+
72
+ Khi bạn chọn một nhà cung cấp bộ nhớ cụ thể cho ứng dụng của mình, nếu bạn viết mã trực tiếp tới API của họ, ứng dụng của bạn
73
+ bây giờ phụ thuộc vào dịch vụ đó. Khi thời gian trôi qua và mã tích lũy, việc thay đổi nhà cung cấp sẽ trở thành
74
+ ngày càng không thể kiểm soát được. Chào mừng bạn đến với thế giới thú vị của khóa nhà cung cấp!
75
+
76
+ Mobiletto được thiết kế để giải quyết vấn đề này. Bằng cách mã hóa ứng dụng của bạn thành API của mobiletto, bạn có thể dễ dàng
77
+ thay đổi nhà cung cấp bộ nhớ và biết rằng lớp lưu trữ của ứng dụng của bạn sẽ hoạt động giống hệt nhau.
78
+
79
+ ### Thử nghiệm rộng rãi
80
+ Tất cả các trình điều khiển đều được kiểm tra hành vi giống hệt nhau với hơn 60 bài kiểm tra cho mỗi trình điều khiển.
81
+ Chúng tôi kiểm tra tất cả các trình điều khiển với mọi sự kết hợp của:
82
+ * Mã hóa: cả bật và tắt
83
+ * Redis cache: cả được bật và tắt
84
+
85
+ Cách tiếp cận này giúp chúng tôi yên tâm rằng mobiletto sẽ hoạt động giống nhau bất kể bạn sử dụng trình điều khiển nào,
86
+ và bất kể bạn có bật bộ nhớ đệm và / hoặc mã hóa hay không.
87
+
88
+ ### Hỗ trợ trình điều khiển
89
+ Trình điều khiển lưu trữ Mobiletto hiện tại:
90
+ * `s3` : Amazon S3
91
+ * `b2` : Backblaze B2
92
+ * `local` : hệ thống tệp cục bộ
93
+
94
+ * Rất hoan nghênh các đóng góp để hỗ trợ thêm các nhà cung cấp dịch vụ lưu trữ đám mây! *
95
+
96
+ ## mobiletto-cli
97
+ Mobiletto dự định sẽ được sử dụng như một thư viện bằng mã JavaScript khác.
98
+
99
+ Để làm việc với mobiletto tại dòng lệnh, hãy sử dụng [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
100
+
101
+ ## Nguồn
102
+ * [mobiletto trên GitHub](https://github.com/cobbzilla/mobiletto)
103
+ * [mobiletto trên npm](https://www.npmjs.com/package/mobiletto)
104
+
105
+ ## Bắt đầu nhanh
106
+ Một ví dụ ngắn sử dụng trình điều khiển `s3` .
107
+
108
+ Mã này sẽ chạy tương tự nếu trình điều khiển là `b2` `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
+ ## Cách sử dụng cơ bản
139
+ Một ví dụ rộng hơn nhiều, hiển thị hầu hết các tính năng được cung cấp:
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
+ Lệnh `metadata` trả về siêu dữ liệu về một mục nhập hệ thống tệp.
242
+ Tương tự như vậy, giá trị trả về từ lệnh `list` là một mảng các đối tượng siêu dữ liệu.
243
+
244
+ Một đối tượng siêu dữ liệu trông giống như sau:
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
+ Thuộc tính `type` có thể `file` , `dir` , `link` hoặc `special` .
255
+
256
+ Tùy thuộc vào loại trình điều khiển, lệnh `list` có thể không trả về tất cả các trường. Thuộc tính `name` `type`
257
+ nên luôn luôn có mặt. Lệnh `metadata` tiếp theo sẽ trả về tất cả các thuộc tính có sẵn.
258
+
259
+ ## Kiểu nhập thay thế
260
+ Nhập mô-đun có phạm vi đầy đủ và sử dụng chức năng `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
+ ## Bộ nhớ đệm
268
+ Mobiletto hoạt động tốt nhất với bộ nhớ đệm <a href="https://redis.io">redis</a> .
269
+
270
+ Mobiletto sẽ cố gắng kết nối với phiên bản redis trên 127.0.0.1:6379
271
+
272
+ Bạn có thể ghi đè một trong hai cách sau:
273
+ * Đặt env var của `MOBILETTO_REDIS_HOST` , mobiletto để kết nối tại đây thay vì localhost
274
+ * Đặt var env `MOBILETTO_REDIS_PORT` , cổng này sẽ được sử dụng
275
+
276
+ Mobiletto sẽ lưu trữ tất cả các khóa redis của mình với tiền tố `_mobiletto__` . Bạn có thể thay đổi điều này
277
+ bằng cách đặt var env `MOBILETTO_REDIS_PREFIX` .
278
+
279
+ Bạn cũng có thể đặt bộ nhớ đệm cho mỗi kết nối bằng đối tượng `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
+ ### Bạn không muốn redis vào bộ nhớ đệm?
291
+ Để vô hiệu hóa: hãy truyền `enabled: false` vào đối `opts.redisConfig` của bạn khi bạn thiết lập kết nối của mình.
292
+
293
+ Như đã thảo luận bên dưới, việc tắt bộ nhớ đệm sẽ có ảnh hưởng xấu đến hiệu suất và làm phát sinh nhiều yêu cầu hơn
294
+ vào bộ nhớ mà bạn thực sự cần.
295
+
296
+ ### Hướng dẫn lưu vào bộ nhớ đệm
297
+ ** Bộ nhớ được mã hóa **: bộ nhớ được mã hóa đọc / ghi chỉ chậm hơn một chút so với bình thường,
298
+ nhưng việc điều hướng xung quanh các thư mục (một số thứ làm được) khá tốn kém. Sử dụng bộ nhớ đệm redis
299
+ sẽ giúp bạn tăng hiệu suất đáng kể.
300
+
301
+ Bộ nhớ đệm mặc định là an toàn, nhưng không hoạt động tốt nếu bạn có nhiều thao tác ghi / xóa.
302
+ Bất kỳ thao tác ghi hoặc xóa nào đều làm mất hiệu lực của toàn bộ bộ nhớ cache, đảm bảo các lần đọc tiếp theo sẽ thấy
303
+ những thay đổi mới nhất.
304
+
305
+ ### Công cụ CLI
306
+ Nếu bạn đang sử dụng công cụ CLI như [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
307
+ chắc chắn bạn sẽ muốn kích hoạt bộ nhớ cache redis, vì nó tồn tại trên các lệnh gọi của lệnh `mo` .
308
+
309
+ ## Phản chiếu
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
+ Lệnh `mirror` thực hiện sao chép một lần tất cả các tệp từ mobiletto này sang mobiletto khác.
318
+ Nó không chạy bất kỳ quy trình nào để duy trì gương theo thời gian. Chạy lại lệnh `mirror`
319
+ để đồng bộ hóa bất kỳ tệp nào bị thiếu.
320
+
321
+ Giá trị trả về từ `mirror` là một đối tượng đơn giản có bộ đếm cho số lượng tệp đã được thành công
322
+ được phản chiếu và có bao nhiêu tệp có lỗi:
323
+
324
+ {
325
+ success: count-of-files-mirrored,
326
+ errors: count-of-files-with-errors
327
+ }
328
+
329
+ CẢNH BÁO: Sao chép các tập dữ liệu lớn có thể rất tốn thời gian và băng thông
330
+
331
+ Với ngữ nghĩa cuộc gọi `mirror` , đôi khi có thể khó hiểu để hiểu ai là
332
+ người đọc và người viết. Hãy tưởng tượng nó giống như một câu lệnh gán: "mobiletto bên trái"
333
+ là thứ được gán cho (dữ liệu được phản chiếu được ghi) và "mobiletto bên phải" (
334
+ đối số cho phương thức `mirror` ) là giá trị đang được gán (dữ liệu được nhân bản được đọc).
335
+
336
+ ## Mã hóa minh bạch
337
+ Bật mã hóa phía máy khách minh bạch:
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
+ Chuyện gì đang xảy ra vậy? Thư mục "mục nhập thư mục" (chỉ thị) riêng biệt (được mã hóa) theo dõi những tệp nào có trong đó
357
+ thư mục (hay còn gọi là thư mục chỉ thị).
358
+ * Lệnh `list` đọc các tệp mục nhập thư mục, giải mã từng đường dẫn được liệt kê; sau đó trả về siêu dữ liệu cho từng tệp
359
+ Các lệnh * `list` không hiệu quả hơn, đặc biệt là đối với các thư mục có số lượng tệp lớn
360
+ * Lệnh `write` ghi các tệp chỉ thị trong mỗi thư mục lệnh của cha, một cách đệ quy; sau đó ghi tệp
361
+ * Các lệnh `write` sẽ phải ghi O (N), với N = độ sâu trong hệ thống phân cấp thư mục
362
+ * Lệnh `remove` loại bỏ tệp chỉ thị tương ứng và tệp cha của nó nếu trống, một cách đệ quy; sau đó xóa tệp
363
+ * Các lệnh `remove` không đệ quy sẽ phải chịu O (N) lần đọc và có khả năng là nhiều lần xóa, với N = độ sâu trong phân cấp thư mục
364
+ * Các lệnh `remove` đệ quy trên các hệ thống tệp lớn và sâu có thể tốn kém
365
+
366
+ Lưu ý rằng ngay cả khi kích hoạt mã hóa phía máy khách, kẻ thù vẫn có khả năng hiển thị đầy đủ phía máy chủ được mã hóa của bạn
367
+ bộ nhớ, ngay cả khi không có khóa, vẫn có thể xem tổng số thư mục và bao nhiêu tệp trong mỗi thư mục và với
368
+ một số nỗ lực, khám phá một số hoặc tất cả cấu trúc tổng thể của hệ thống phân cấp thư mục.
369
+ * Lưu ý: Sử dụng cấu trúc tương đối phẳng để bảo mật tốt hơn. *
370
+ Đối thủ sẽ không biết tên của các thư mục / tệp trừ khi họ cũng biết mã hóa của bạn
371
+ hoặc đã bẻ khóa mã hóa thành công. Tất cả các cược đã tắt sau đó!
372
+
373
+ ### Hiệu suất và bộ nhớ đệm
374
+ Các hoạt động trên bộ nhớ được mã hóa có thể bị chậm. Danh sách đệ quy và xóa có thể rất chậm.
375
+ Bộ nhớ đệm thông qua redis giúp ích rất nhiều, nhưng lưu ý rằng bộ nhớ đệm được xóa khi bất kỳ lần ghi hoặc xóa nào.
376
+
377
+ ## Xoay phím
378
+ Tạo một mobiletto bằng khóa mới của bạn, sau đó sao chép dữ liệu cũ vào đó:
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
+ ## Giao diện trình điều khiển
391
+ Trình điều khiển là bất kỳ tệp JS nào xuất một hàm 'storageClient' với chữ ký này:
392
+
393
+ function storageClient (key, secret, opts)
394
+
395
+ * `key` : một chuỗi, khóa API của bạn (đối với trình điều `local` , đây là thư mục cơ sở)
396
+ * `secret` : một chuỗi, bí mật API của bạn (có thể được bỏ qua cho trình điều `local` )
397
+ * `opts` : một đối tượng, các thuộc tính là trên mỗi trình điều khiển:
398
+ * Đối với `local` , thuộc `fileMode` và `dirMode` xác định cách tạo các tệp và thư mục mới được tạo
399
+ * Đối với `s3` , thuộc `bucket` là bắt buộc. Các thuộc tính tùy chọn là:
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
+ Đối tượng mà hàm StorageClient trả về phải xác định các hàm này:
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
+ ## Ghi nhật ký
431
+ Mobiletto sử dụng thư viện ghi nhật ký [wonton](https://www.npmjs.com/package/winston).
432
+
433
+ Nhật ký ** sẽ ** chứa đường dẫn tệp và thông báo lỗi, nhưng sẽ ** không bao giờ ** chứa khóa, bí mật,
434
+ hoặc bất kỳ thông tin cấu hình kết nối nào khác.
435
+
436
+ ### Mức đăng nhập
437
+ Sử dụng biến môi trường `MOBILETTO_LOG_LEVEL` để đặt mức nhật ký, sử dụng một
438
+ của các cấp độ `npm` được xác định trong [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
439
+
440
+ Mức mặc định là `error` . Mức độ dài dòng nhất là `silly` , mặc dù hiện tại là mobiletto
441
+ không đăng nhập ở các cấp dưới `debug`
442
+
443
+ MOBILETTO_LOG_LEVEL=silly # maximum logs!
444
+
445
+ ### Tệp nhật ký
446
+ Theo mặc định, trình ghi nhật ký ghi vào bảng điều khiển. Để gửi nhật ký vào một tệp, hãy đặt `MOBILETTO_LOG_FILE`
447
+ biến môi trường. Khi đăng nhập vào một tệp, nhật ký sẽ không còn được ghi vào bảng điều khiển.
448
+
449
+ MOBILETTO_LOG_FILE=/var/my_mobiletto_log
450
+
451
+ Để tắt ghi nhật ký:
452
+
453
+ MOBILETTO_LOG_FILE=/dev/null
454
+
455
+ </pre>