mobiletto 1.2.1 → 2.0.0
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.
- package/lib/cjs/index.d.ts +2 -0
- package/lib/cjs/index.js +30 -0
- package/lib/cjs/package.json +16 -0
- package/lib/esm/index.d.ts +2 -0
- package/lib/esm/index.js +12 -0
- package/package.json +27 -13
- package/.babelrc +0 -5
- package/.eslintrc.js +0 -14
- package/docs/README.md +0 -113
- package/docs/af/README.md +0 -481
- package/docs/am/README.md +0 -481
- package/docs/ar/README.md +0 -481
- package/docs/az/README.md +0 -481
- package/docs/be/README.md +0 -481
- package/docs/bg/README.md +0 -481
- package/docs/bn/README.md +0 -481
- package/docs/bs/README.md +0 -481
- package/docs/ca/README.md +0 -481
- package/docs/ceb/README.md +0 -481
- package/docs/co/README.md +0 -481
- package/docs/cs/README.md +0 -481
- package/docs/cy/README.md +0 -481
- package/docs/da/README.md +0 -481
- package/docs/de/README.md +0 -481
- package/docs/el/README.md +0 -481
- package/docs/eo/README.md +0 -481
- package/docs/es/README.md +0 -481
- package/docs/et/README.md +0 -481
- package/docs/eu/README.md +0 -481
- package/docs/fa/README.md +0 -481
- package/docs/fi/README.md +0 -481
- package/docs/fr/README.md +0 -481
- package/docs/fy/README.md +0 -481
- package/docs/ga/README.md +0 -481
- package/docs/gd/README.md +0 -481
- package/docs/gl/README.md +0 -481
- package/docs/gu/README.md +0 -481
- package/docs/ha/README.md +0 -481
- package/docs/haw/README.md +0 -481
- package/docs/he/README.md +0 -481
- package/docs/hi/README.md +0 -481
- package/docs/hmn/README.md +0 -481
- package/docs/hr/README.md +0 -481
- package/docs/ht/README.md +0 -481
- package/docs/hu/README.md +0 -481
- package/docs/hy/README.md +0 -481
- package/docs/id/README.md +0 -481
- package/docs/ig/README.md +0 -481
- package/docs/is/README.md +0 -481
- package/docs/it/README.md +0 -481
- package/docs/iw/README.md +0 -481
- package/docs/ja/README.md +0 -481
- package/docs/jv/README.md +0 -481
- package/docs/ka/README.md +0 -481
- package/docs/kk/README.md +0 -481
- package/docs/km/README.md +0 -481
- package/docs/kn/README.md +0 -481
- package/docs/ko/README.md +0 -481
- package/docs/ku/README.md +0 -481
- package/docs/ky/README.md +0 -481
- package/docs/la/README.md +0 -481
- package/docs/lb/README.md +0 -481
- package/docs/lo/README.md +0 -481
- package/docs/lt/README.md +0 -481
- package/docs/lv/README.md +0 -481
- package/docs/mg/README.md +0 -481
- package/docs/mi/README.md +0 -481
- package/docs/mk/README.md +0 -481
- package/docs/ml/README.md +0 -481
- package/docs/mn/README.md +0 -481
- package/docs/mr/README.md +0 -481
- package/docs/ms/README.md +0 -481
- package/docs/mt/README.md +0 -481
- package/docs/my/README.md +0 -481
- package/docs/ne/README.md +0 -481
- package/docs/nl/README.md +0 -481
- package/docs/no/README.md +0 -481
- package/docs/ny/README.md +0 -481
- package/docs/or/README.md +0 -481
- package/docs/pa/README.md +0 -481
- package/docs/pl/README.md +0 -481
- package/docs/ps/README.md +0 -481
- package/docs/pt/README.md +0 -481
- package/docs/ro/README.md +0 -481
- package/docs/ru/README.md +0 -481
- package/docs/rw/README.md +0 -481
- package/docs/sd/README.md +0 -481
- package/docs/si/README.md +0 -481
- package/docs/sk/README.md +0 -481
- package/docs/sl/README.md +0 -481
- package/docs/sm/README.md +0 -481
- package/docs/sn/README.md +0 -481
- package/docs/so/README.md +0 -481
- package/docs/sq/README.md +0 -481
- package/docs/sr/README.md +0 -481
- package/docs/st/README.md +0 -481
- package/docs/su/README.md +0 -481
- package/docs/sv/README.md +0 -481
- package/docs/sw/README.md +0 -481
- package/docs/ta/README.md +0 -481
- package/docs/te/README.md +0 -481
- package/docs/tg/README.md +0 -481
- package/docs/th/README.md +0 -481
- package/docs/tk/README.md +0 -481
- package/docs/tl/README.md +0 -481
- package/docs/tr/README.md +0 -481
- package/docs/tt/README.md +0 -481
- package/docs/ug/README.md +0 -481
- package/docs/uk/README.md +0 -481
- package/docs/ur/README.md +0 -481
- package/docs/uz/README.md +0 -481
- package/docs/vi/README.md +0 -481
- package/docs/xh/README.md +0 -481
- package/docs/yi/README.md +0 -481
- package/docs/yo/README.md +0 -481
- package/docs/zh/README.md +0 -481
- package/docs/zu/README.md +0 -481
- package/drivers/b2/index.js +0 -451
- package/drivers/local/index.js +0 -315
- package/drivers/s3/index.js +0 -316
- package/hokey.json +0 -16
- package/index.js +0 -29
- package/test/api.spec.js +0 -512
- package/test/crypt.spec.js +0 -67
package/docs/ms/README.md
DELETED
|
@@ -1,481 +0,0 @@
|
|
|
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
|
-
* [Pemasangan](#Pemasangan)
|
|
12
|
-
* [Sokongan dan Pembiayaan](#Sokongan-dan-Pembiayaan)
|
|
13
|
-
* [Penggunaan asas](#Penggunaan Asas)
|
|
14
|
-
* [Metadata](#Metadata)
|
|
15
|
-
* [Gaya import ganti](gaya import-ganti)
|
|
16
|
-
* [Caching](#Caching)
|
|
17
|
-
* [Mirroring](#Mirroring)
|
|
18
|
-
* [Penyulitan telus](#penyulitan telus)
|
|
19
|
-
* [Putaran kekunci](#Putaran kekunci)
|
|
20
|
-
* [Antara muka pemandu](#Antara muka Pemandu)
|
|
21
|
-
* [Logging](#Logging)
|
|
22
|
-
|
|
23
|
-
# Baca ini dalam bahasa lain
|
|
24
|
-
Dokumen README.md ini telah diterjemahkan, melalui [hokeylization](https://github.com/cobbzilla/hokeylization), ke dalam
|
|
25
|
-
**[setiap bahasa disokong oleh Terjemahan Google](https://cloud.google.com/translate/docs/languages)!**
|
|
26
|
-
|
|
27
|
-
Saya pasti ia tidak sempurna, tetapi saya harap ia lebih baik daripada tiada!
|
|
28
|
-
|
|
29
|
-
[🇸🇦 Bahasa Arab](../ar/README.md)
|
|
30
|
-
[🇧🇩 Bengali](../bn/README.md)
|
|
31
|
-
[🇩🇪 Bahasa Jerman](../de/README.md)
|
|
32
|
-
[🇺🇸 Bahasa Inggeris](../ms/README.md)
|
|
33
|
-
[🇪🇸 Bahasa Sepanyol](../es/README.md)
|
|
34
|
-
[🇫🇷 Perancis](../fr/README.md)
|
|
35
|
-
[🇹🇩 Hausa](../ha/README.md)
|
|
36
|
-
[🇮🇳 Hindi](../hi/README.md)
|
|
37
|
-
[🇮🇩 Indonesia](../id/README.md)
|
|
38
|
-
[🇮🇹 Itali](../it/README.md)
|
|
39
|
-
[🇯🇵 Bahasa Jepun](../ja/README.md)
|
|
40
|
-
[🇰🇷 Korea](../ko/README.md)
|
|
41
|
-
[🇮🇳 Marathi](../mr/README.md)
|
|
42
|
-
[🇵🇱 Poland](../pl/README.md)
|
|
43
|
-
[🇧🇷 Portugis](../pt/README.md)
|
|
44
|
-
[🇷🇺 Rusia](../ru/README.md)
|
|
45
|
-
[🇰🇪 Swahili](../sw/README.md)
|
|
46
|
-
[🇵🇭 Tagalog](../tl/README.md)
|
|
47
|
-
[🇹🇷 Turki](../tr/README.md)
|
|
48
|
-
[🇵🇰 Urdu](../ur/README.md)
|
|
49
|
-
[🇻🇳 Vietnam](../vi/README.md)
|
|
50
|
-
[🇨🇳 Cina](../zh/README.md)
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
**[📚 ... Semua Bahasa ...](../README.md)**
|
|
54
|
-
----
|
|
55
|
-
|
|
56
|
-
### Adakah terdapat masalah dengan terjemahan README ini?
|
|
57
|
-
Terjemahan khusus [README] asal ini (https://github.com/cobbzilla/mobiletto/blob/master/README.md)
|
|
58
|
-
mungkin cacat -- *pembetulan amat dialu-alukan!* Sila hantar [permintaan tarik pada GitHub](https://github.com/cobbzilla/mobiletto/pulls),
|
|
59
|
-
atau jika anda tidak selesa berbuat demikian, [buka isu](https://github.com/cobbzilla/mobiletto/issues)
|
|
60
|
-
|
|
61
|
-
Apabila anda membuat isu GitHub baharu tentang terjemahan, sila lakukan:
|
|
62
|
-
* sertakan URL halaman (salin/tampal dari bar alamat penyemak imbas)
|
|
63
|
-
* sertakan teks tepat yang salah (salin/tampal dari penyemak imbas)
|
|
64
|
-
* sila terangkan apa yang salah -- adakah terjemahan itu salah? adakah pemformatan rosak entah bagaimana?
|
|
65
|
-
* sila tawarkan cadangan terjemahan yang lebih baik, atau cara teks harus diformat dengan betul
|
|
66
|
-
* **Terima kasih!**
|
|
67
|
-
|
|
68
|
-
## Mengapa Mobiletto?
|
|
69
|
-
|
|
70
|
-
### Selamat tinggal vendor lock-in!
|
|
71
|
-
Pelbagai penyedia storan awan mempunyai API yang tidak serasi. Malah mereka yang berusaha untuk "keserasian S3"
|
|
72
|
-
mempunyai tingkah laku idiosinkratik.
|
|
73
|
-
|
|
74
|
-
Apabila anda memilih vendor storan tertentu untuk apl anda, jika anda mengekod terus ke API mereka, apl anda
|
|
75
|
-
kini bergantung kepada perkhidmatan itu. Apabila masa berlalu dan kod terkumpul, menukar vendor menjadi
|
|
76
|
-
semakin tidak dapat dipertahankan. Selamat datang ke dunia yang menyeronokkan vendor lock-in!
|
|
77
|
-
|
|
78
|
-
Mobiletto telah direka untuk menyelesaikan masalah ini. Dengan mengekodkan apl anda kepada API mobiletto, anda boleh dengan mudah
|
|
79
|
-
tukar penyedia storan dan ketahui bahawa lapisan storan apl anda akan berkelakuan sama.
|
|
80
|
-
|
|
81
|
-
### Ujian yang meluas
|
|
82
|
-
Semua pemandu diuji untuk tingkah laku yang sama dengan 60+ ujian untuk setiap pemandu.
|
|
83
|
-
Kami menguji semua pemandu dengan setiap kombinasi:
|
|
84
|
-
* Penyulitan: didayakan dan dilumpuhkan
|
|
85
|
-
* Cache Redis: kedua-duanya didayakan dan dilumpuhkan
|
|
86
|
-
|
|
87
|
-
Pendekatan ini memberi kami ketenangan fikiran bahawa mobiletto akan berkelakuan sama tanpa mengira pemandu yang anda gunakan,
|
|
88
|
-
dan tidak kira sama ada anda mendayakan caching dan/atau penyulitan.
|
|
89
|
-
|
|
90
|
-
### Sokongan pemandu
|
|
91
|
-
Pemacu storan Mobiletto semasa:
|
|
92
|
-
* `s3` : Amazon S3
|
|
93
|
-
* `b2` : Backblaze B2
|
|
94
|
-
* `local` : sistem fail tempatan
|
|
95
|
-
|
|
96
|
-
*Sumbangan untuk menyokong lebih banyak penyedia storan awan amat dialu-alukan!*
|
|
97
|
-
|
|
98
|
-
## mobiletto-cli
|
|
99
|
-
Mobiletto bertujuan untuk digunakan sebagai perpustakaan oleh kod JavaScript lain.
|
|
100
|
-
|
|
101
|
-
Untuk bekerja dengan mobiletto pada baris arahan, gunakan [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
|
|
102
|
-
|
|
103
|
-
## Sumber
|
|
104
|
-
* [mobiletto di GitHub](https://github.com/cobbzilla/mobiletto)
|
|
105
|
-
* [mobiletto on npm](https://www.npmjs.com/package/mobiletto)
|
|
106
|
-
|
|
107
|
-
## Sokongan dan Pembiayaan
|
|
108
|
-
Saya cuba menjadi pembangun perisian sumber terbuka profesional. Saya telah bekerja di
|
|
109
|
-
industri perisian selama bertahun-tahun, saya telah memulakan syarikat yang berjaya dan menjualnya kepada syarikat awam.
|
|
110
|
-
Baru-baru ini saya kehilangan pekerjaan, dan saya tidak mempunyai sebarang kerja lain yang disediakan
|
|
111
|
-
|
|
112
|
-
Jadi saya akan cuba menulis perisian yang berguna dan melihat sama ada ia berfungsi
|
|
113
|
-
|
|
114
|
-
Jika anda gemar menggunakan perisian ini, saya akan sangat berterima kasih kerana
|
|
115
|
-
terkecil [sumbangan bulanan melalui Patreon](https://www.patreon.com/cobbzilla)
|
|
116
|
-
|
|
117
|
-
*Terima kasih!*
|
|
118
|
-
|
|
119
|
-
## Pemasangan
|
|
120
|
-
Pasang menggunakan `npm` atau `yarn` . Anda mungkin mahu versi `lite` yang tidak termasuk semua
|
|
121
|
-
fail README yang diterjemahkan:
|
|
122
|
-
|
|
123
|
-
npm install mobiletto-lite
|
|
124
|
-
yarn add mobiletto-lite
|
|
125
|
-
|
|
126
|
-
Jika anda benar-benar mahukan fail README dalam setiap bahasa, pasang versi penuh:
|
|
127
|
-
|
|
128
|
-
npm install mobiletto
|
|
129
|
-
yarn add mobiletto
|
|
130
|
-
|
|
131
|
-
## Permulaan pantas
|
|
132
|
-
Contoh ringkas menggunakan pemacu `s3` .
|
|
133
|
-
|
|
134
|
-
Kod ini akan berjalan sama jika pemandu adalah `b2` atau `local` .
|
|
135
|
-
|
|
136
|
-
const storage = require('mobiletto')
|
|
137
|
-
const bucket = await storage.connect('s3', aws_key, aws_secret, {bucket: 'bk'})
|
|
138
|
-
|
|
139
|
-
// list objects: returns array of metadata objects
|
|
140
|
-
const listing = await bucket.list()
|
|
141
|
-
const dirList = await bucket.list('some/dir/')
|
|
142
|
-
const everything = await bucket.list('', {recursive: true})
|
|
143
|
-
|
|
144
|
-
// write an entire file
|
|
145
|
-
let bytesWritten = await bucket.writeFile('some/path', someBufferOfData)
|
|
146
|
-
|
|
147
|
-
// write a file from a stream/generator
|
|
148
|
-
bytesWritten = await bucket.write('some/path', streamOrGenerator)
|
|
149
|
-
|
|
150
|
-
// read an entire file
|
|
151
|
-
// returns null if an exception would otherwise be thrown
|
|
152
|
-
const bufferOrNull = await bucket.safeReadFile('some/path')
|
|
153
|
-
|
|
154
|
-
// stream-read a file, passing data to callback
|
|
155
|
-
const bytesRead = await bucket.read('some/path', (chunk) => { ...do something with chunk... } )
|
|
156
|
-
|
|
157
|
-
// remove a file, returns the path removed
|
|
158
|
-
let removed = await bucket.remove('some/path') // removed is a string
|
|
159
|
-
|
|
160
|
-
// remove a directory, returns array of paths removed
|
|
161
|
-
removed = await bucket.remove('some/directory', {recursive: true}) // removed is now an array!
|
|
162
|
-
|
|
163
|
-
----
|
|
164
|
-
## Penggunaan asas
|
|
165
|
-
Contoh yang lebih meluas, menunjukkan kebanyakan ciri yang ditawarkan:
|
|
166
|
-
|
|
167
|
-
const { mobiletto } = require('mobiletto')
|
|
168
|
-
|
|
169
|
-
// General usage
|
|
170
|
-
const api = await mobiletto(driverName, key, secret, opts)
|
|
171
|
-
|
|
172
|
-
// To use 'local' driver:
|
|
173
|
-
// * key: base directory
|
|
174
|
-
// * secret: ignored, can be null
|
|
175
|
-
// * opts object:
|
|
176
|
-
// * readOnly: optional, never change anything on the filesystem; default is false
|
|
177
|
-
// * fileMode: optional, permissions used when creating new files, default is 0600. can be string or integer
|
|
178
|
-
// * dirMode: optional, permissions used when creating new directories, default is 0700. can be string or integer
|
|
179
|
-
const local = await mobiletto('local', '/home/ubuntu/tmp', null, {fileMode: 0o0600, dirMode: '0700'})
|
|
180
|
-
|
|
181
|
-
// To use 's3' driver:
|
|
182
|
-
// * key: AWS Access Key ID
|
|
183
|
-
// * secret: AWS Secret Key
|
|
184
|
-
// * opts object:
|
|
185
|
-
// * readOnly: optional, never change anything on the bucket; default is false
|
|
186
|
-
// * bucket: required, name of the S3 bucket
|
|
187
|
-
// * region: optional, the AWS region to communicate with, default is us-east-1
|
|
188
|
-
// * prefix: optional, all read/writes within the S3 bucket will be under this prefix
|
|
189
|
-
// * delimiter: optional, directory delimiter, default is '/' (note: always '/' when encryption is enabled)
|
|
190
|
-
const s3 = await mobiletto('s3', aws_key, aws_secret, {bucket: 'bk', region: 'us-east-1'})
|
|
191
|
-
|
|
192
|
-
// To use 'b2' driver:
|
|
193
|
-
// * key: Backblaze Key ID
|
|
194
|
-
// * secret: Backblaze Application Key
|
|
195
|
-
// * opts object:
|
|
196
|
-
// * readOnly: optional, never change anything on the bucket; default is false
|
|
197
|
-
// * bucket: required, the ID (**not the name**) of the B2 bucket
|
|
198
|
-
// * prefix: optional, all read/writes within the B2 bucket will be under this prefix
|
|
199
|
-
// * delimiter: optional, directory delimiter, default is '/' (note: always '/' when encryption is enabled)
|
|
200
|
-
// * partSize: optional, large files will be split into chunks of this size when uploading
|
|
201
|
-
const b3 = await mobiletto('b2', b2_key_id, b2_app_key, {bucket: 'bk', partSize: 10000000})
|
|
202
|
-
|
|
203
|
-
// List files
|
|
204
|
-
api.list() // --> returns an array of metadata objects
|
|
205
|
-
|
|
206
|
-
// List files recursively
|
|
207
|
-
api.list({ recursive: true })
|
|
208
|
-
|
|
209
|
-
// List files in a directory
|
|
210
|
-
const path = 'some/path'
|
|
211
|
-
api.list(path)
|
|
212
|
-
api.list(path, { recursive: true }) // also supports recursive flag
|
|
213
|
-
|
|
214
|
-
// Visit files in a directory -- visitor function must be async
|
|
215
|
-
api.list(path, { visitor: myAsyncFunc })
|
|
216
|
-
api.list(path, { visitor: myAsyncFunc, recursive: true })
|
|
217
|
-
|
|
218
|
-
// The `list` method throws MobilettoNotFoundError if the path does not exist
|
|
219
|
-
// When you call `safeList` on a non-existent path, it returns an empty array
|
|
220
|
-
api.safeList('/path/that/does/not/exist') // returns []
|
|
221
|
-
|
|
222
|
-
// Read metadata for a file
|
|
223
|
-
api.metadata(path) // returns metadata object
|
|
224
|
-
|
|
225
|
-
// The `metadata` method throws MobilettoNotFoundError if the path does not exist
|
|
226
|
-
// When you call `safeMetadata` on a non-existent path, it returns null
|
|
227
|
-
api.safeMetadata('/tmp/does_not_exist') // returns null
|
|
228
|
-
|
|
229
|
-
// Read a file
|
|
230
|
-
// Provide a callback that writes the data someplace
|
|
231
|
-
const callback = (chunk) => { ... write chunk somewhere ... }
|
|
232
|
-
api.read(path, callback) // returns count of bytes read
|
|
233
|
-
|
|
234
|
-
// Read an entire file at once
|
|
235
|
-
const data = await api.readFile(path) // returns a byte Buffer of the file contents
|
|
236
|
-
|
|
237
|
-
// Read an entire file at once
|
|
238
|
-
// returns null if an exception would otherwise be thrown
|
|
239
|
-
const bufferOrNull = await bucket.safeReadFile('some/path')
|
|
240
|
-
|
|
241
|
-
// Write a file
|
|
242
|
-
// Provide a generator function that yields chunks of data
|
|
243
|
-
const generator = function* () {
|
|
244
|
-
while ( ... more-data-to-return ... ) {
|
|
245
|
-
data = ... load-data ...
|
|
246
|
-
yield data
|
|
247
|
-
}
|
|
248
|
-
}
|
|
249
|
-
local.api(path, generator) // returns count of bytes written
|
|
250
|
-
|
|
251
|
-
// Write an entire file at once (convenience method)
|
|
252
|
-
await api.writeFile(path, bufferOrString) // returns count of bytes written
|
|
253
|
-
|
|
254
|
-
// Delete a file
|
|
255
|
-
// Quiet param is optional (default false), when set errors will not be thrown if the path does not exist
|
|
256
|
-
// Always returns a value or throws an error.
|
|
257
|
-
// Return value may be a single string of the file removed, or an array of all files removed (driver-dependent)
|
|
258
|
-
const quiet = true
|
|
259
|
-
api.remove(path, {quiet}) // returns single path removed
|
|
260
|
-
|
|
261
|
-
// Recursively delete a directory and do it quietly (do not report errors)
|
|
262
|
-
const recursive = true
|
|
263
|
-
const quiet = true
|
|
264
|
-
api.remove(path, {recursive, quiet}) // returns array of paths removed
|
|
265
|
-
|
|
266
|
-
## Metadata
|
|
267
|
-
Perintah `metadata` mengembalikan metadata tentang satu kemasukan sistem fail.
|
|
268
|
-
Begitu juga, nilai pulangan daripada arahan `list` ialah tatasusunan objek metadata.
|
|
269
|
-
|
|
270
|
-
Objek metadata kelihatan seperti ini:
|
|
271
|
-
|
|
272
|
-
{
|
|
273
|
-
"name": "fully/qualified/path/to/file",
|
|
274
|
-
"type": "entry-type",
|
|
275
|
-
"size": size-in-bytes,
|
|
276
|
-
"ctime": creation-time-epoch-millis,
|
|
277
|
-
"mtime": modification-time-epoch-millis
|
|
278
|
-
}
|
|
279
|
-
|
|
280
|
-
Sifat `type` boleh menjadi `file` , `dir` , `link` , atau `special` .
|
|
281
|
-
|
|
282
|
-
Bergantung pada jenis pemacu, arahan `list` mungkin tidak mengembalikan semua medan. Sifat `name` dan `type`
|
|
283
|
-
hendaklah sentiasa ada. Perintah `metadata` seterusnya akan mengembalikan semua sifat yang tersedia.
|
|
284
|
-
|
|
285
|
-
## Gaya import ganti
|
|
286
|
-
Import modul berskop sepenuhnya dan gunakan fungsi `connect` :
|
|
287
|
-
|
|
288
|
-
const storage = require('mobiletto')
|
|
289
|
-
const opts = {bucket: 'bk', region: 'us-east-1'}
|
|
290
|
-
const s3 = await storage.connect('s3', aws_key, aws_secret, opts)
|
|
291
|
-
const objectData = await s3.readFile('some/path')
|
|
292
|
-
|
|
293
|
-
## Caching
|
|
294
|
-
Mobiletto berfungsi paling baik dengan cache <a href="https://redis.io">redis</a> .
|
|
295
|
-
|
|
296
|
-
Mobiletto akan cuba menyambung ke contoh redis pada 127.0.0.1:6379
|
|
297
|
-
|
|
298
|
-
Anda boleh mengatasi salah satu daripada ini:
|
|
299
|
-
* Tetapkan var env `MOBILETTO_REDIS_HOST` , mobiletto sambung di sini dan bukannya localhost
|
|
300
|
-
* Tetapkan env var `MOBILETTO_REDIS_PORT` , port ini akan digunakan
|
|
301
|
-
|
|
302
|
-
Mobiletto akan menyimpan semua kunci redisnya dengan awalan `_mobiletto__` . Anda boleh mengubah ini
|
|
303
|
-
dengan menetapkan var env `MOBILETTO_REDIS_PREFIX` .
|
|
304
|
-
|
|
305
|
-
Anda juga boleh menetapkan caching per sambungan dengan objek `opts.redisConfig` :
|
|
306
|
-
|
|
307
|
-
const redisConfig = {
|
|
308
|
-
enabled: true, // optional, default is true. if false other props are ignored
|
|
309
|
-
host: '127.0.0.1',
|
|
310
|
-
port: 6379,
|
|
311
|
-
prefix: '_mobiletto__'
|
|
312
|
-
}
|
|
313
|
-
const opts = { redisConfig, bucket: 'bk', region: 'us-east-1' }
|
|
314
|
-
const s3 = await storage.connect('s3', aws_key, aws_secret, opts)
|
|
315
|
-
|
|
316
|
-
### Tidak mahu caching redis?
|
|
317
|
-
Untuk melumpuhkan: `enabled: false` dalam objek `opts.redisConfig` anda apabila anda membuat sambungan anda.
|
|
318
|
-
|
|
319
|
-
Seperti yang dibincangkan di bawah, melumpuhkan caching akan memberi kesan buruk pada prestasi dan menimbulkan lebih banyak permintaan
|
|
320
|
-
kepada storan yang anda perlukan.
|
|
321
|
-
|
|
322
|
-
### Panduan caching
|
|
323
|
-
**Storan disulitkan**: membaca/menulis storan disulitkan hanya perlahan sedikit daripada biasa,
|
|
324
|
-
tetapi menavigasi di sekitar direktori (yang dilakukan oleh beberapa perkara) agak mahal. Menggunakan cache redis
|
|
325
|
-
akan memberi anda peningkatan prestasi yang ketara.
|
|
326
|
-
|
|
327
|
-
Cache lalai adalah selamat, tetapi tidak berfungsi dengan baik jika anda mempunyai banyak operasi tulis/buang.
|
|
328
|
-
Sebarang operasi tulis atau alih keluar membatalkan keseluruhan cache, memastikan bacaan seterusnya akan melihat
|
|
329
|
-
perubahan terkini.
|
|
330
|
-
|
|
331
|
-
### Alat CLI
|
|
332
|
-
Jika anda menggunakan alat CLI seperti [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
|
|
333
|
-
anda pasti mahu cache redis didayakan, kerana ia berlangsung merentasi seruan perintah `mo` .
|
|
334
|
-
|
|
335
|
-
## Mencerminkan
|
|
336
|
-
|
|
337
|
-
// Copy a local filesystem mobiletto to S3
|
|
338
|
-
s3.mirror(local)
|
|
339
|
-
|
|
340
|
-
// Mirror a local subdirectory from one mobiletto to an S3 mobiletto, with it's own subdirectory
|
|
341
|
-
local.mirror(s3, 'some/local-folder', 'some/s3-folder')
|
|
342
|
-
|
|
343
|
-
Arahan `mirror` melakukan salinan satu kali semua fail dari satu mobiletto ke yang lain.
|
|
344
|
-
Ia tidak menjalankan sebarang proses untuk mengekalkan cermin dari semasa ke semasa. Jalankan arahan `mirror` sekali lagi
|
|
345
|
-
untuk menyegerakkan mana-mana fail yang hilang.
|
|
346
|
-
|
|
347
|
-
Nilai pulangan daripada `mirror` ialah objek ringkas dengan pembilang untuk bilangan fail yang berjaya
|
|
348
|
-
dicerminkan dan bilangan fail yang mempunyai ralat:
|
|
349
|
-
|
|
350
|
-
{
|
|
351
|
-
success: count-of-files-mirrored,
|
|
352
|
-
errors: count-of-files-with-errors
|
|
353
|
-
}
|
|
354
|
-
|
|
355
|
-
AMARAN: Mencerminkan set data yang besar boleh memakan masa dan intensif lebar jalur
|
|
356
|
-
|
|
357
|
-
Dengan semantik panggilan `mirror` kadangkala boleh mengelirukan untuk memahami siapa itu
|
|
358
|
-
pembaca dan siapa penulisnya. Bayangkan ia seperti pernyataan tugasan: "mobiletto kiri"
|
|
359
|
-
ialah perkara yang ditugaskan kepada (data bercermin ditulis), dan "mobiletto kanan" (the
|
|
360
|
-
hujah kepada kaedah `mirror` ) ialah nilai yang diberikan (data bercermin dibaca).
|
|
361
|
-
|
|
362
|
-
## Penyulitan telus
|
|
363
|
-
Dayakan penyulitan sisi pelanggan yang telus:
|
|
364
|
-
|
|
365
|
-
// Pass encryption parameters
|
|
366
|
-
const encryption = {
|
|
367
|
-
// key is required, must be >= 16 chars
|
|
368
|
-
key: randomstring.generate(128),
|
|
369
|
-
|
|
370
|
-
// optional, the default is to derive IV from key
|
|
371
|
-
// when set, IV must be >= 16 chars
|
|
372
|
-
iv: randomstring.generate(128),
|
|
373
|
-
|
|
374
|
-
// optional, the default is aes-256-cbc
|
|
375
|
-
algo: 'aes-256-cbc'
|
|
376
|
-
}
|
|
377
|
-
const api = await mobiletto(driverName, key, secret, opts, encryption)
|
|
378
|
-
|
|
379
|
-
// Subsequent write operations will encrypt data (client side) when writing
|
|
380
|
-
// Subsequent read operations will decrypt data (client side) when reading
|
|
381
|
-
|
|
382
|
-
Apa yang sedang berlaku? Direktori "masukan direktori" (dirent) berasingan (disulitkan) menjejaki fail yang terdapat di dalamnya
|
|
383
|
-
direktori (aka direktori dirent).
|
|
384
|
-
* Perintah `list` membaca fail kemasukan direktori, menyahsulit setiap laluan yang disenaraikan; kemudian mengembalikan metadata untuk setiap fail
|
|
385
|
-
* Arahan `list` adalah lebih tidak cekap, terutamanya untuk direktori dengan bilangan fail yang banyak
|
|
386
|
-
* Perintah `write` menulis fail dirent dalam direktori dirent setiap ibu bapa, secara rekursif; kemudian menulis fail
|
|
387
|
-
* Arahan `write` akan dikenakan O(N) menulis, dengan N = kedalaman dalam hierarki direktori
|
|
388
|
-
* Perintah `remove` mengalih keluar fail dirent yang sepadan, dan induknya jika kosong, secara rekursif; kemudian mengeluarkan fail
|
|
389
|
-
* `remove` bukan rekursif akan dikenakan O(N) bacaan dan berkemungkinan sebanyak pemadaman, dengan N = kedalaman dalam hierarki direktori
|
|
390
|
-
* `remove` rekursif pada sistem fail besar dan dalam boleh jadi mahal
|
|
391
|
-
|
|
392
|
-
Ambil perhatian bahawa walaupun dengan penyulitan bahagian klien didayakan, musuh dengan keterlihatan penuh ke bahagian pelayan anda yang disulitkan
|
|
393
|
-
storan, walaupun tanpa kunci, masih boleh melihat jumlah direktori dan bilangan fail dalam setiap satu, dan dengan
|
|
394
|
-
sedikit usaha, temui sebahagian atau semua struktur keseluruhan hierarki direktori.
|
|
395
|
-
*Nota: Gunakan struktur yang agak rata untuk keselamatan yang lebih baik.*
|
|
396
|
-
Pihak lawan tidak akan mengetahui nama direktori/fail melainkan mereka juga mengetahui penyulitan anda
|
|
397
|
-
kunci atau telah berjaya memecahkan penyulitan. Semua pertaruhan dibatalkan!
|
|
398
|
-
|
|
399
|
-
### Prestasi dan caching
|
|
400
|
-
Operasi pada storan yang disulitkan boleh menjadi perlahan. Penyenaraian dan pengalihan keluar rekursif boleh menjadi sangat perlahan.
|
|
401
|
-
Caching melalui redis sangat membantu, tetapi ambil perhatian bahawa cache disiram apabila sebarang penulisan atau dialih keluar.
|
|
402
|
-
|
|
403
|
-
## Putaran kunci
|
|
404
|
-
Buat mobiletto dengan kunci baharu anda, kemudian cerminkan data lama ke dalamnya:
|
|
405
|
-
|
|
406
|
-
const storage = require('mobiletto')
|
|
407
|
-
|
|
408
|
-
const oldEncryption = { key: .... }
|
|
409
|
-
const oldStorage = await storage.connect('s3', aws_key, aws_secret, {bucket: 'bk', region: 'us-east-1'}, oldEncryption)
|
|
410
|
-
|
|
411
|
-
const newEncryption = { key: .... }
|
|
412
|
-
const newStorage = await storage.connect('s3', aws_key, aws_secret, {bucket: 'zz', region: 'us-east-1'}, newEncryption)
|
|
413
|
-
|
|
414
|
-
newStorage.mirror(oldStorage) // if oldStorage is very large, this may take a looooooong time...
|
|
415
|
-
|
|
416
|
-
## Antara muka pemandu
|
|
417
|
-
Pemacu ialah sebarang fail JS yang mengeksport fungsi 'storageClient' dengan tandatangan ini:
|
|
418
|
-
|
|
419
|
-
function storageClient (key, secret, opts)
|
|
420
|
-
|
|
421
|
-
* `key` : rentetan, kunci API anda (untuk pemacu `local` ini ialah direktori asas)
|
|
422
|
-
* `secret` : rentetan, rahsia API anda (boleh ditinggalkan untuk pemacu `local` )
|
|
423
|
-
* `opts` : objek, sifatnya adalah per-driver:
|
|
424
|
-
* Untuk `local` , sifat `fileMode` dan `dirMode` menentukan cara membuat fail dan direktori baharu dicipta
|
|
425
|
-
* Untuk `s3` , sifat `bucket` diperlukan. Ciri-ciri pilihan ialah:
|
|
426
|
-
* `region`: the S3 region, default is us-east-1
|
|
427
|
-
* `prefix`: a prefix to prepend to all S3 paths, default is the empty string
|
|
428
|
-
* `delimiter`: the directory delimiter, default is '/'
|
|
429
|
-
|
|
430
|
-
Objek yang dikembalikan oleh fungsi storageClient mesti menentukan fungsi ini:
|
|
431
|
-
|
|
432
|
-
// Test the driver before using, ensure proper configuration
|
|
433
|
-
async testConfig ()
|
|
434
|
-
|
|
435
|
-
// List files in path (or from base-directory)
|
|
436
|
-
// If recursive is true, list recursively
|
|
437
|
-
// If visitor is defined, it will be an async function. await the visitor function on each file found
|
|
438
|
-
// Otherwise, perform the listing and return an array of objects
|
|
439
|
-
async list (path, recursive = false, visitor = null) // path may be omitted
|
|
440
|
-
|
|
441
|
-
// Read metadata for a path
|
|
442
|
-
async metadata (path)
|
|
443
|
-
|
|
444
|
-
// Read a file
|
|
445
|
-
// callback receives a chunk of data. endCallback is called at end-of-stream
|
|
446
|
-
async read (path, callback, endCallback = null)
|
|
447
|
-
|
|
448
|
-
// Write a file
|
|
449
|
-
// driver must be able to handle a generator or a stream
|
|
450
|
-
async write (path, generatorOrReadableStream)
|
|
451
|
-
|
|
452
|
-
// Remove a file, or recursively delete a directory
|
|
453
|
-
// returns a string of a single path removed, or an array of multiple paths removed
|
|
454
|
-
async remove (path, recursive = false, quiet = false)
|
|
455
|
-
|
|
456
|
-
## Pembalakan
|
|
457
|
-
Mobiletto menggunakan perpustakaan pengelogan [winston](https://www.npmjs.com/package/winston).
|
|
458
|
-
|
|
459
|
-
Log **akan** mengandungi laluan fail dan mesej ralat, tetapi **tidak akan** mengandungi kunci, rahsia,
|
|
460
|
-
atau sebarang maklumat konfigurasi sambungan lain.
|
|
461
|
-
|
|
462
|
-
### Tahap log
|
|
463
|
-
Gunakan pembolehubah persekitaran `MOBILETTO_LOG_LEVEL` untuk menetapkan tahap log, menggunakan satu
|
|
464
|
-
daripada tahap `npm` yang ditakrifkan dalam [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
|
|
465
|
-
|
|
466
|
-
Tahap lalai ialah `error` . Tahap yang paling bertele-tele ialah `silly` , walaupun pada masa ini mobiletto
|
|
467
|
-
tidak log pada tahap di bawah `debug`
|
|
468
|
-
|
|
469
|
-
MOBILETTO_LOG_LEVEL=silly # maximum logs!
|
|
470
|
-
|
|
471
|
-
### Fail log
|
|
472
|
-
Secara lalai, logger menulis ke konsol. Untuk menghantar log ke fail, tetapkan `MOBILETTO_LOG_FILE`
|
|
473
|
-
pembolehubah persekitaran. Apabila log masuk ke fail, log tidak lagi akan ditulis ke konsol.
|
|
474
|
-
|
|
475
|
-
MOBILETTO_LOG_FILE=/var/my_mobiletto_log
|
|
476
|
-
|
|
477
|
-
Untuk mematikan pengelogan:
|
|
478
|
-
|
|
479
|
-
MOBILETTO_LOG_FILE=/dev/null
|
|
480
|
-
|
|
481
|
-
</pre>
|