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
+ موبيليتو
2
+ =========
3
+
4
+ Mobiletto عبارة عن طبقة تجريدية لتخزين JavaScript ، مع تشفير اختياري شفاف من جانب العميل.
5
+
6
+ # محتويات
7
+ * [لماذا موبيليتو؟](# لماذا موبيليتو؟)
8
+ * [بداية سريعة](# بدء سريع)
9
+ * [Mobiletto CLI](# mobiletto-cli)
10
+ * [المصدر](# المصدر)
11
+ * [الاستخدام الأساسي](# الاستخدام الأساسي)
12
+ * [البيانات الوصفية](# بيانات وصفية)
13
+ * [نمط الاستيراد البديل](# نمط الاستيراد البديل)
14
+ * [Caching](# Caching)
15
+ * [انعكاس](# انعكاس)
16
+ * [تشفير شفاف](# تشفير شفاف)
17
+ * [Key rotation](# Key-rotation) (دوران المفتاح #)
18
+ * [واجهة السائق](# واجهة سائق)
19
+ * [تسجيل](# تسجيل)
20
+
21
+ # اقرأ هذا بلغة أخرى
22
+ تمت ترجمة هذا المستند README.md عبر [hokeylization](https://github.com/cobbzilla/hokeylization) إلى
23
+ ** [كل لغة تدعمها ترجمة Google](https://cloud.google.com/translate/docs/languages)! **
24
+
25
+ أنا متأكد من أنها ليست مثالية ، لكني آمل أن تكون أفضل من لا شيء!
26
+
27
+ [🇸🇦 عربي](docs / ar / README.md)
28
+ [🇧🇩 بنغالي](docs / bn / README.md)
29
+ [🇩🇪 ألماني](docs / de / README.md)
30
+ [🇺🇸 إنجليزي](docs / en / README.md)
31
+ [🇪🇸 إسباني](docs / es / README.md)
32
+ [🇫🇷 فرنسي](docs / fr / README.md)
33
+ [🇹🇩 الهوسا](docs / ha / README.md)
34
+ [🇮🇳 هندي](docs / hi / README.md)
35
+ [🇮🇩 إندونيسي](docs / id / README.md)
36
+ [🇮🇹 إيطالي](docs / it / README.md)
37
+ [🇯🇵 باليابانية](docs / ja / README.md)
38
+ [🇰🇷 كوري](docs / ko / README.md)
39
+ [🇮🇳 مارانثي](مستندات / السيد / README.md)
40
+ [🇵🇱 بولندي](docs / pl / README.md)
41
+ [🇧🇷 برتغالي](docs / pt / README.md)
42
+ [🇷🇺 بالروسية](docs / ru / README.md)
43
+ [🇰🇪 السواحيلية](docs / sw / README.md)
44
+ [🇵🇭 تاغالوغ](docs / tl / README.md)
45
+ [🇹🇷 التركية](docs / tr / README.md)
46
+ [🇵🇰 الأردية](docs / ur / README.md)
47
+ [🇻🇳 فيتنامي](docs / vi / README.md)
48
+ [🇨🇳 الصينية](docs / zh / README.md)
49
+
50
+
51
+ ** [📚 ... كل اللغات ...](docs / README.md) **
52
+ ----
53
+
54
+ ### هل هناك مشكلة في هذه الترجمة من README؟
55
+ هذه الترجمة المحددة لـ [README] الأصلي (https://github.com/cobbzilla/mobiletto/blob/master/README.md)
56
+ قد يكون معيبًا - * نرحب بالتصحيحات! * يُرجى إرسال [طلب سحب على GitHub](https://github.com/cobbzilla/mobiletto/pulls) ،
57
+ أو إذا لم تكن مرتاحًا لفعل ذلك ، [افتح مشكلة](https://github.com/cobbzilla/mobiletto/issues)
58
+
59
+ عند إنشاء مشكلة جديدة على GitHub بخصوص ترجمة ، يرجى القيام بما يلي:
60
+ * تضمين عنوان URL للصفحة (نسخ / لصق من شريط عنوان المتصفح)
61
+ * تضمين النص الخاطئ بالضبط (نسخ / لصق من المتصفح)
62
+ * يرجى وصف ما هو الخطأ - هل الترجمة غير صحيحة؟ هل التنسيق معطل بطريقة ما؟
63
+ * يرجى تقديم اقتراح بترجمة أفضل ، أو كيفية تنسيق النص بشكل صحيح
64
+ * **شكرًا لك!**
65
+
66
+ ## لماذا موبيليتو؟
67
+
68
+ ### وداعا حبس البائع!
69
+ لدى مختلف موفري التخزين السحابي واجهات برمجة تطبيقات غير متوافقة. حتى أولئك الذين يسعون جاهدين من أجل "التوافق مع S3"
70
+ لديهم سلوكيات خاصة.
71
+
72
+ عندما تختار بائع تخزين معين لتطبيقك ، إذا قمت بالتشفير مباشرة إلى واجهة برمجة التطبيقات الخاصة بهم ، فإن تطبيقك
73
+ تعتمد الآن على تلك الخدمة. مع مرور الوقت وتراكم الكود ، يصبح تغيير البائعين
74
+ لا يمكن الدفاع عنه على نحو متزايد. مرحبًا بك في عالم المرح من قفل البائع!
75
+
76
+ تم تصميم Mobiletto لحل هذه المشكلة. من خلال ترميز التطبيق الخاص بك إلى واجهة برمجة التطبيقات الخاصة بشركة Mobiletto ، يمكنك ذلك بسهولة
77
+ قم بتغيير موفري التخزين واعلم أن طبقة تخزين التطبيق الخاص بك سوف تتصرف بشكل متماثل.
78
+
79
+ ### اختبارات مكثفة
80
+ يتم اختبار جميع السائقين من أجل سلوك متطابق مع أكثر من 60 اختبارًا لكل سائق.
81
+ نقوم باختبار جميع السائقين مع كل مجموعة من:
82
+ * التشفير: ممكّن ومعطل
83
+ * ذاكرة التخزين المؤقت Redis: ممكّنة ومعطلة
84
+
85
+ يمنحنا هذا النهج راحة البال التي سيتصرف بها Mobiletto بغض النظر عن السائق الذي تستخدمه ،
86
+ وبغض النظر عما إذا كنت تقوم بتمكين التخزين المؤقت و / أو التشفير.
87
+
88
+ ### دعم السائق
89
+ برامج تشغيل التخزين Mobiletto الحالية:
90
+ * `s3` : Amazon S3
91
+ * `b2` : Backblaze B2
92
+ * `local` : نظام ملفات محلي
93
+
94
+ * نرحب بالمساهمات لدعم المزيد من مزودي التخزين السحابي! *
95
+
96
+ ## Mobiletto-CLI
97
+ يهدف Mobiletto إلى استخدامه كمكتبة بواسطة كود JavaScript آخر.
98
+
99
+ للعمل مع mobiletto في سطر الأوامر ، استخدم [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
100
+
101
+ ## مصدر
102
+ * [mobiletto على GitHub](https://github.com/cobbzilla/mobiletto)
103
+ * [mobiletto on npm](https://www.npmjs.com/package/mobiletto)
104
+
105
+ ## بداية سريعة
106
+ مثال قصير على استخدام مشغل mobiletto `s3` .
107
+
108
+ سيعمل هذا الرمز بنفس الطريقة إذا كان برنامج التشغيل `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
+ ## الاستخدام الأساسي
139
+ مثال أكثر شمولاً ، يُظهر معظم الميزات المعروضة:
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
+ ## البيانات الوصفية
241
+ يقوم الأمر `metadata` بإرجاع البيانات الوصفية حول إدخال واحد في نظام الملفات.
242
+ وبالمثل ، فإن القيمة المعادة من الأمر `list` هي مصفوفة من كائنات البيانات الوصفية.
243
+
244
+ يبدو كائن البيانات الوصفية كما يلي:
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
+ يمكن أن تكون خاصية `type` `file` " `link` أو " `dir` " أو `special` أو "خاص".
255
+
256
+ اعتمادًا على نوع برنامج التشغيل ، قد لا يقوم أمر `list` بإرجاع جميع الحقول. خصائص `name` الاسم" و `type`
257
+ يجب أن يكون حاضرًا دائمًا. سيعيد أمر `metadata` اللاحق جميع الخصائص المتاحة.
258
+
259
+ ## أسلوب الاستيراد البديل
260
+ قم باستيراد الوحدة كاملة النطاق `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
+ ## التخزين المؤقت
268
+ Mobiletto يعمل بشكل أفضل مع مخبأ <a href="https://redis.io">redis</a> .
269
+
270
+ سيحاول Mobiletto الاتصال بنسخة redis على 127.0.0.1:6379
271
+
272
+ يمكنك تجاوز أي مما يلي:
273
+ * اضبط `MOBILETTO_REDIS_HOST` env var ، mobiletto connect هنا بدلاً من localhost
274
+ * اضبط `MOBILETTO_REDIS_PORT` env var ، سيتم استخدام هذا المنفذ
275
+
276
+ ستقوم Mobiletto بتخزين جميع مفاتيح redis الخاصة بها بالبادئة `_mobiletto__` . يمكنك تغيير هذا
277
+ عن طريق تعيين `MOBILETTO_REDIS_PREFIX` var.
278
+
279
+ يمكنك أيضًا تعيين التخزين المؤقت لكل اتصال باستخدام الكائن `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
+ ### ألا تريد تخزين redis مؤقتًا؟
291
+ للتعطيل: قم بتمرير `enabled: false` خطأ" في كائن `opts.redisConfig` عند إنشاء اتصالك.
292
+
293
+ كما هو موضح أدناه ، سيكون لتعطيل التخزين المؤقت تأثير سلبي على الأداء وسيتسبب في المزيد من الطلبات
294
+ للتخزين الذي تحتاجه حقًا.
295
+
296
+ ### إرشادات التخزين المؤقت
297
+ ** التخزين المشفر **: قراءة / كتابة التخزين المشفر أبطأ قليلاً من المعتاد ،
298
+ لكن التنقل حول الدلائل (وهو ما تفعله بعض الأشياء) مكلف إلى حد ما. استخدام ذاكرة التخزين المؤقت redis
299
+ سيعطيك دفعة كبيرة في الأداء.
300
+
301
+ ذاكرة التخزين المؤقت الافتراضية آمنة ، ولكنها لا تعمل بشكل جيد إذا كان لديك الكثير من عمليات الكتابة / الإزالة.
302
+ تؤدي أي عملية كتابة أو إزالة إلى إبطال ذاكرة التخزين المؤقت بالكامل ، مما يضمن أن القراءات اللاحقة ستشاهد ملف
303
+ أحدث التغييرات.
304
+
305
+ ### أدوات CLI
306
+ إذا كنت تستخدم أداة CLI مثل [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli) ،
307
+ ستحتاج بالتأكيد إلى تمكين ذاكرة التخزين المؤقت redis ، لأنها تدوم عبر استدعاءات الأمر `mo` .
308
+
309
+ ## انعكاس
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
+ ينفذ الأمر `mirror` " نسخة لمرة واحدة من جميع الملفات من Mobiletto إلى آخر.
318
+ لا يتم تشغيل أي عملية للحفاظ على المرآة بمرور الوقت. قم بتشغيل أمر `mirror` مرة أخرى
319
+ لمزامنة أي ملفات مفقودة.
320
+
321
+ القيمة المعادة من `mirror` هي كائن بسيط به عدادات لعدد الملفات التي تم بنجاح
322
+ معكوسة وعدد الملفات التي بها أخطاء:
323
+
324
+ {
325
+ success: count-of-files-mirrored,
326
+ errors: count-of-files-with-errors
327
+ }
328
+
329
+ تحذير: يمكن أن يكون عكس مجموعات البيانات الكبيرة مستهلكًا للوقت ومكثفًا للنطاق الترددي
330
+
331
+ باستخدام دلالات استدعاء `mirror` ، قد يكون من المربك أحيانًا فهم من هو
332
+ القارئ ومن هو الكاتب. تخيلها مثل بيان مهمة: "left-hand mobiletto"
333
+ هو الشيء الذي يتم تخصيصه لـ (بيانات معكوسة مكتوبة) ، و "Mobiletto الأيمن" (
334
+ الوسيطة إلى طريقة `mirror` ) هي القيمة التي يتم تعيينها (تتم قراءة البيانات المنعكسة).
335
+
336
+ ## تشفير شفاف
337
+ تمكين التشفير الشفاف من جانب العميل:
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
+ ماذا يحدث؟ يتتبع دليل "إدخال الدليل" (dirent) المنفصل (المشفر) الملفات الموجودة في ذلك الدليل
357
+ الدليل (المعروف أيضًا باسم دليل dirent).
358
+ * يقرأ الأمر `list` ملفات إدخال الدليل ، ويفك تشفير كل مسار مدرج ؛ ثم يقوم بإرجاع البيانات الوصفية لكل ملف
359
+ * أوامر `list` غير فعالة بشكل أكبر ، خاصة بالنسبة للأدلة التي تحتوي على عدد كبير من الملفات
360
+ * يقوم الأمر `write` بكتابة ملفات dirent في دليل الدليل الخاص بكل والد ، بشكل متكرر ؛ ثم يكتب الملف
361
+ * أوامر `write` ستتضمن كتابة O (N) ، مع N = عمق في التسلسل الهرمي للدليل
362
+ * يقوم الأمر `remove` بإزالة ملف الدليل المقابل ، وملفه الأصلي إذا كان فارغًا ، بشكل متكرر ؛ ثم يزيل الملف
363
+ * أوامر `remove` غير العودية ستتعرض لقراءات O (N) ويحتمل أن يتم حذف العديد منها ، مع N = العمق في التسلسل الهرمي للدليل
364
+ * أوامر `remove` على أنظمة الملفات الكبيرة والعميقة يمكن أن تكون باهظة الثمن
365
+
366
+ لاحظ أنه حتى مع تمكين التشفير من جانب العميل ، فإن الخصم يتمتع برؤية كاملة من جانب الخادم المشفر
367
+ التخزين ، حتى بدون المفتاح ، لا يزال بإمكانه رؤية العدد الإجمالي للأدلة وعدد الملفات الموجودة في كل منها ومع
368
+ بعض الجهد ، اكتشف بعض أو كل الهيكل العام للتسلسل الهرمي للدليل.
369
+ * ملاحظة: استخدم هيكلًا مسطحًا نسبيًا لتحسين الأمان. *
370
+ لن يعرف الخصم أسماء الدلائل / الملفات ما لم يعرف أيضًا تشفيرك
371
+ مفتاح أو نجح في كسر التشفير. كل الرهانات بعد ذلك!
372
+
373
+ ### الأداء والتخزين المؤقت
374
+ يمكن أن تكون العمليات على التخزين المشفر بطيئة. يمكن أن تكون عمليات الإزالة والقوائم المتكررة بطيئة للغاية.
375
+ يساعد التخزين المؤقت عبر redis بشكل كبير ، ولكن لاحظ أنه يتم مسح ذاكرة التخزين المؤقت عند الكتابة أو الإزالة.
376
+
377
+ ## مفتاح التناوب
378
+ قم بإنشاء Mobiletto باستخدام مفتاحك الجديد ، ثم قم بنسخ البيانات القديمة فيه:
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
+ ## واجهة السائق
391
+ السائق هو أي ملف JS يصدر وظيفة "storageClient" بهذا التوقيع:
392
+
393
+ function storageClient (key, secret, opts)
394
+
395
+ * `key` : سلسلة ، مفتاح API الخاص بك (بالنسبة لبرنامج `local` ، هذا هو الدليل الأساسي)
396
+ * `secret` : سلسلة ، سر واجهة برمجة التطبيقات (يمكن حذفه لبرنامج `local` )
397
+ * `opts` : كائن ، الخصائص لكل سائق:
398
+ * بالنسبة إلى `local` " ، تحدد خصائص " `fileMode` " و `dirMode` كيفية إنشاء ملفات وأدلة جديدة
399
+ * بالنسبة لـ `s3` ، تكون `bucket` مطلوبة. الخصائص الاختيارية هي:
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
+ يجب أن يحدد الكائن الذي تعرضه دالة storageClient هذه الوظائف:
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
+ ## تسجيل
431
+ يستخدم Mobiletto مكتبة التسجيل [winston](https://www.npmjs.com/package/winston).
432
+
433
+ سوف تحتوي السجلات ** ** على مسارات ملفات ورسائل خطأ ، ولكنها لن ** ** أبدًا ** تحتوي على مفاتيح وأسرار ،
434
+ أو أي معلومات تكوين اتصال أخرى.
435
+
436
+ ### تسجيل مستوى
437
+ استخدم متغير البيئة `MOBILETTO_LOG_LEVEL` لتعيين مستوى السجل ، باستخدام واحد
438
+ من مستويات `npm` المحددة في [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
439
+
440
+ المستوى الافتراضي هو `error` . المستوى الأكثر تفصيلاً هو `silly` ، على الرغم من أن Mobiletto حاليًا
441
+ لا يسجل في المستويات أدناه `debug`
442
+
443
+ MOBILETTO_LOG_LEVEL=silly # maximum logs!
444
+
445
+ ### ملف تسجيل
446
+ بشكل افتراضي ، يكتب المسجل إلى وحدة التحكم. لإرسال سجلات إلى ملف ، قم بتعيين `MOBILETTO_LOG_FILE`
447
+ متغيرات البيئة. عند تسجيل الدخول إلى ملف ، لن تتم كتابة السجلات إلى وحدة التحكم.
448
+
449
+ MOBILETTO_LOG_FILE=/var/my_mobiletto_log
450
+
451
+ لإيقاف التسجيل:
452
+
453
+ MOBILETTO_LOG_FILE=/dev/null
454
+
455
+ </pre>