mobiletto 1.1.8 → 1.1.11

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (117) hide show
  1. package/README.md +56 -4
  2. package/docs/README.md +113 -0
  3. package/docs/af/README.md +455 -0
  4. package/docs/am/README.md +455 -0
  5. package/docs/ar/README.md +455 -0
  6. package/docs/az/README.md +455 -0
  7. package/docs/be/README.md +455 -0
  8. package/docs/bg/README.md +455 -0
  9. package/docs/bn/README.md +455 -0
  10. package/docs/bs/README.md +455 -0
  11. package/docs/ca/README.md +455 -0
  12. package/docs/ceb/README.md +455 -0
  13. package/docs/co/README.md +455 -0
  14. package/docs/cs/README.md +455 -0
  15. package/docs/cy/README.md +455 -0
  16. package/docs/da/README.md +455 -0
  17. package/docs/de/README.md +455 -0
  18. package/docs/el/README.md +455 -0
  19. package/docs/eo/README.md +455 -0
  20. package/docs/es/README.md +455 -0
  21. package/docs/et/README.md +455 -0
  22. package/docs/eu/README.md +455 -0
  23. package/docs/fa/README.md +455 -0
  24. package/docs/fi/README.md +455 -0
  25. package/docs/fr/README.md +455 -0
  26. package/docs/fy/README.md +455 -0
  27. package/docs/ga/README.md +455 -0
  28. package/docs/gd/README.md +455 -0
  29. package/docs/gl/README.md +455 -0
  30. package/docs/gu/README.md +455 -0
  31. package/docs/ha/README.md +455 -0
  32. package/docs/haw/README.md +455 -0
  33. package/docs/he/README.md +455 -0
  34. package/docs/hi/README.md +455 -0
  35. package/docs/hmn/README.md +455 -0
  36. package/docs/hr/README.md +455 -0
  37. package/docs/ht/README.md +455 -0
  38. package/docs/hu/README.md +455 -0
  39. package/docs/hy/README.md +455 -0
  40. package/docs/id/README.md +455 -0
  41. package/docs/ig/README.md +455 -0
  42. package/docs/is/README.md +455 -0
  43. package/docs/it/README.md +455 -0
  44. package/docs/iw/README.md +455 -0
  45. package/docs/ja/README.md +455 -0
  46. package/docs/jv/README.md +455 -0
  47. package/docs/ka/README.md +455 -0
  48. package/docs/kk/README.md +455 -0
  49. package/docs/km/README.md +455 -0
  50. package/docs/kn/README.md +455 -0
  51. package/docs/ko/README.md +455 -0
  52. package/docs/ku/README.md +455 -0
  53. package/docs/ky/README.md +455 -0
  54. package/docs/la/README.md +455 -0
  55. package/docs/lb/README.md +455 -0
  56. package/docs/lo/README.md +455 -0
  57. package/docs/lt/README.md +455 -0
  58. package/docs/lv/README.md +455 -0
  59. package/docs/mg/README.md +455 -0
  60. package/docs/mi/README.md +455 -0
  61. package/docs/mk/README.md +455 -0
  62. package/docs/ml/README.md +455 -0
  63. package/docs/mn/README.md +455 -0
  64. package/docs/mr/README.md +455 -0
  65. package/docs/ms/README.md +455 -0
  66. package/docs/mt/README.md +455 -0
  67. package/docs/my/README.md +455 -0
  68. package/docs/ne/README.md +455 -0
  69. package/docs/nl/README.md +455 -0
  70. package/docs/no/README.md +455 -0
  71. package/docs/ny/README.md +455 -0
  72. package/docs/or/README.md +455 -0
  73. package/docs/pa/README.md +455 -0
  74. package/docs/pl/README.md +455 -0
  75. package/docs/ps/README.md +455 -0
  76. package/docs/pt/README.md +455 -0
  77. package/docs/ro/README.md +455 -0
  78. package/docs/ru/README.md +455 -0
  79. package/docs/rw/README.md +455 -0
  80. package/docs/sd/README.md +455 -0
  81. package/docs/si/README.md +455 -0
  82. package/docs/sk/README.md +455 -0
  83. package/docs/sl/README.md +455 -0
  84. package/docs/sm/README.md +455 -0
  85. package/docs/sn/README.md +455 -0
  86. package/docs/so/README.md +455 -0
  87. package/docs/sq/README.md +455 -0
  88. package/docs/sr/README.md +455 -0
  89. package/docs/st/README.md +455 -0
  90. package/docs/su/README.md +455 -0
  91. package/docs/sv/README.md +455 -0
  92. package/docs/sw/README.md +455 -0
  93. package/docs/ta/README.md +455 -0
  94. package/docs/te/README.md +455 -0
  95. package/docs/tg/README.md +455 -0
  96. package/docs/th/README.md +455 -0
  97. package/docs/tk/README.md +455 -0
  98. package/docs/tl/README.md +455 -0
  99. package/docs/tr/README.md +455 -0
  100. package/docs/tt/README.md +455 -0
  101. package/docs/ug/README.md +455 -0
  102. package/docs/uk/README.md +455 -0
  103. package/docs/ur/README.md +455 -0
  104. package/docs/uz/README.md +455 -0
  105. package/docs/vi/README.md +455 -0
  106. package/docs/xh/README.md +455 -0
  107. package/docs/yi/README.md +455 -0
  108. package/docs/yo/README.md +455 -0
  109. package/docs/zh/README.md +455 -0
  110. package/docs/zu/README.md +455 -0
  111. package/drivers/b2/index.js +24 -6
  112. package/hokey.json +16 -0
  113. package/index.js +33 -17
  114. package/package.json +3 -2
  115. package/test/api.spec.js +319 -306
  116. package/util/logger.js +1 -1
  117. package/util/redis.js +1 -1
@@ -0,0 +1,455 @@
1
+ موبایلتو
2
+ =========
3
+
4
+ Mobiletto یک لایه انتزاعی ذخیره سازی جاوا اسکریپت است، با رمزگذاری شفاف اختیاری سمت مشتری.
5
+
6
+ # فهرست
7
+ * [چرا Mobiletto؟](#Why-Mobiletto؟)
8
+ * [شروع سریع](#Quick-start)
9
+ * [Mobiletto CLI](#mobiletto-cli)
10
+ * [منبع](#منبع)
11
+ * [استفاده پایه](#استفاده پایه)
12
+ * [فراداده](#فراداده)
13
+ * [سبک واردات جایگزین](#Alternate-import-style)
14
+ * [Caching](#Caching)
15
+ * [آینه کاری](#آینه کاری)
16
+ * [رمزگذاری شفاف](#Transparent-encryption)
17
+ * [چرخش کلید](#چرخش کلید)
18
+ * [رابط درایور](#رابط راننده)
19
+ * [Logging](#Logging)
20
+
21
+ # این را به زبان دیگری بخوانید
22
+ این سند README.md از طریق [hokeylization](https://github.com/cobbzilla/hokeylization) به
23
+ **[هر زبانی که توسط Google Translate پشتیبانی می‌شود](https://cloud.google.com/translate/docs/languages)!**
24
+
25
+ من مطمئنم که کامل نیست، اما امیدوارم از هیچی بهتر باشد!
26
+
27
+ [🇸🇦 عربی](../ar/README.md)
28
+ [🇧🇩 بنگالی](../bn/README.md)
29
+ [🇩🇪 آلمانی](../de/README.md)
30
+ [🇺🇸 انگلیسی](../en/README.md)
31
+ [🇪🇸 اسپانیایی](../es/README.md)
32
+ [🇫🇷 فرانسوی](../fr/README.md)
33
+ [🇹🇩 هاوسا](../ha/README.md)
34
+ [🇮🇳 هندی](../hi/README.md)
35
+ [🇮🇩 اندونزیایی](../id/README.md)
36
+ [🇮🇹 ایتالیایی](../it/README.md)
37
+ [🇯🇵 ژاپنی](../ja/README.md)
38
+ [🇰🇷 کره ای](../ko/README.md)
39
+ [🇮🇳 Maranthi](../mr/README.md)
40
+ [🇵🇱 لهستانی](../pl/README.md)
41
+ [🇧🇷 پرتغالی](../pt/README.md)
42
+ [🇷🇺 روسی](../ru/README.md)
43
+ [🇰🇪 سواحیلی](../sw/README.md)
44
+ [🇵🇭 تاگالوگ](../tl/README.md)
45
+ [🇹🇷 ترکی](../tr/README.md)
46
+ [🇵🇰 اردو](../ur/README.md)
47
+ [🇻🇳 ویتنامی](../vi/README.md)
48
+ [🇨🇳 چینی](../zh/README.md)
49
+
50
+
51
+ **[📚 ... همه زبان ها ...](../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
+ ## چرا Mobiletto؟
67
+
68
+ ### خداحافظ قفل فروشنده!
69
+ ارائه دهندگان مختلف ذخیره سازی ابری دارای APIهای ناسازگار هستند. حتی آنهایی که برای "سازگاری S3" تلاش می کنند
70
+ رفتارهای خاص دارند
71
+
72
+ هنگامی که یک فروشنده فضای ذخیره‌سازی خاص را برای برنامه خود انتخاب می‌کنید، اگر مستقیماً به API آنها کدنویسی کنید، برنامه شما
73
+ اکنون به آن سرویس وابسته است. با گذشت زمان و انباشت کد، فروشندگان تغییر می کنند
74
+ به طور فزاینده ای غیر قابل دفاع به دنیای سرگرم کننده قفل فروشنده خوش آمدید!
75
+
76
+ Mobiletto برای حل این مشکل طراحی شده است. با کدگذاری برنامه خود در API mobiletto، به راحتی می توانید
77
+ ارائه دهندگان فضای ذخیره سازی را تغییر دهید و بدانید که لایه ذخیره سازی برنامه شما یکسان عمل می کند.
78
+
79
+ ### آزمایش گسترده
80
+ همه رانندگان برای رفتار یکسان با بیش از 60 تست برای هر راننده آزمایش می شوند.
81
+ ما همه درایورها را با هر ترکیبی از موارد زیر آزمایش می کنیم:
82
+ * رمزگذاری: هم فعال و هم غیرفعال است
83
+ * حافظه پنهان Redis: هم فعال و هم غیرفعال است
84
+
85
+ این رویکرد به ما آرامش می دهد که mobiletto صرف نظر از اینکه از کدام درایور استفاده می کنید یکسان رفتار خواهد کرد.
86
+ و صرف نظر از اینکه آیا ذخیره و/یا رمزگذاری را فعال می کنید.
87
+
88
+ ### پشتیبانی از درایور
89
+ درایورهای فعلی ذخیره سازی Mobiletto:
90
+ * `s3` : آمازون S3
91
+ * `b2` : Backblaze B2
92
+ * `local` : فایل سیستم محلی
93
+
94
+ *مشارکت برای حمایت بیشتر از ارائه دهندگان فضای ذخیره سازی ابری بسیار خوش آمدید!*
95
+
96
+ ## mobiletto-cli
97
+ Mobiletto برای استفاده به عنوان یک کتابخانه توسط سایر کدهای جاوا اسکریپت در نظر گرفته شده است.
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` `dir` ، «dir»، `link` » یا `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، mobile را تنظیم کنید تا به جای localhost به اینجا متصل شوید
274
+ * `MOBILETTO_REDIS_PORT` env var را تنظیم کنید، این پورت استفاده خواهد شد
275
+
276
+ Mobiletto همه کلیدهای redis خود را با پیشوند `_mobiletto__` می کند. شما می توانید این را تغییر دهید
277
+ با تنظیم `MOBILETTO_REDIS_PREFIX` env 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
+ اما پیمایش در دایرکتوری ها (که برخی کارها انجام می دهند) نسبتاً گران است. استفاده از کش ردیس
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` یک کپی یکباره از همه فایل ها از یک موبایل به موبایل دیگر را انجام می دهد.
318
+ هیچ فرآیندی برای نگهداری آینه در طول زمان اجرا نمی کند. دوباره دستور `mirror` را اجرا کنید
319
+ برای همگام سازی فایل های از دست رفته
320
+
321
+ مقدار بازگشتی از `mirror` یک شی ساده با شمارنده‌های تعداد فایل‌هایی است که با موفقیت انجام شده‌اند
322
+ mirrored و چند فایل خطا داشتند:
323
+
324
+ {
325
+ success: count-of-files-mirrored,
326
+ errors: count-of-files-with-errors
327
+ }
328
+
329
+ هشدار: انعکاس مجموعه داده های بزرگ می تواند بسیار زمان بر و پهنای باند فشرده باشد.
330
+
331
+ با نام `mirror` معناشناسی گاهی اوقات می‌تواند گیج‌کننده باشد که بفهمیم کیست
332
+ خواننده و نویسنده کیست آن را مانند یک بیانیه تکلیف تصور کنید: "موبایل دست چپ"
333
+ چیزی است که به آن اختصاص داده می شود (داده های آینه ای نوشته شده) و "موبایل سمت راست" (
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
+ چه اتفاقی می افتد؟ یک دایرکتوری جداگانه "ورود دایرکتوری" (دایرنت) (رمزگذاری شده) فایل های موجود در آن را ردیابی می کند
357
+ دایرکتوری (معروف به دایرکتوری dirent).
358
+ * دستور `list` فایل های ورودی دایرکتوری را می خواند، هر مسیر فهرست شده را رمزگشایی می کند. سپس متادیتا را برای هر فایل برمی گرداند
359
+ * دستورات `list` ناکارآمدتر هستند، به خصوص برای دایرکتوری هایی که تعداد فایل های زیادی دارند
360
+ * دستور `write` فایل‌های dirent را در دایرکتوری dirent هر والد به صورت بازگشتی می‌نویسد. سپس فایل را می نویسد
361
+ * دستورات `write` O(N) همراه با N = عمق در سلسله مراتب دایرکتوری مواجه می شوند.
362
+ * دستور `remove` فایل dirent مربوطه را حذف می کند و اگر خالی باشد، والد آن را به صورت بازگشتی حذف می کند. سپس فایل را حذف می کند
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` : یک رشته، راز API شما (برای درایور `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 از کتابخانه logging [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` است، اگرچه در حال حاضر قابل حمل است
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>