-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathFileBucket.ts
More file actions
1725 lines (1585 loc) · 68.7 KB
/
FileBucket.ts
File metadata and controls
1725 lines (1585 loc) · 68.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import {BaseBucket} from "./BaseBucket";
import {NebulaService} from "./NebulaService";
import {Nebula} from "./Nebula";
import {_createError, _errorText, _promisify, Callbacks, nbLogger} from "./Head";
import {Acl} from "./Acl";
import {FileMetadata, FileMetadataJson} from "./FileMetadata";
import {ApiRequest, HttpRequest} from "./HttpRequest";
import {_SdeRequest} from "./SdeRequest";
import {Promise} from "es6-promise";
import {Buffer} from "buffer";
/**
* ファイル情報
*/
export interface FileInfo {
/** ファイルパス */
path: string;
/** ファイル名 */
name: string;
/** Content-Type */
type: string;
}
/**
* ファイルリクエスト用オプション
*/
export interface FileRequestOptions {
/** Raw リクエスト(trueの場合、extraResponseは無効) **/
rawRequest?: boolean;
/** ステータスコード、ヘッダ情報を含めて取得する **/
extraResponse?: boolean;
/** if-matchヘッダの付与 **/
ifMatch?: string;
/** if-range ヘッダの付与 **/
ifRange?: string;
/** 開始位置 **/
rangeStart?: number;
/** 終了位置 **/
rangeEnd?: number;
}
/**
* FileBucket 実装
* @private
*/
export class FileBucket extends BaseBucket {
_resolveId: string;
/**
* @class FileBucket
* @classdesc ファイルバケット
* @description FileBucket インスタンスを生成する
* @example
* var bucket = new Nebula.FileBucket("bucket1");
* @param name バケット名
*/
constructor(name: string, service: NebulaService = Nebula) {
super(service, name, "file");
this._resolveId = null;
}
/**
* @memberOf FileBucket
* @description
* ファイルバケットを取得する
* @example
* Nebula.FileBucket.loadBucket()
* .then(function(bucket) {....})
* .catch(function(err) {....});
* @param {String} name ファイルバケット名
* @param {Callbacks} callbacks コールバック (Option)
* @return {Promise} callbacksを指定しなかった場合、Promiseオブジェクトを返す。callback指定時は返り値なし(undefined)。
* <p>処理完了時に渡される値は以下の通り。
* <ul>
* <li>成功時: ファイルバケット(Nebula.FileBucket) インスタンス
* <li>失敗時: エラー要因(JSON)
* <pre>
* {
* "status" : ステータスコード,
* "statusText" : エラーメッセージ,
* "responseText" : レスポンスメッセージ,
* "data" : ファイルバケット名(nameに同じ)
* }
* </pre>
* </ul>
*/
static loadBucket(name:string , callbacks?: Callbacks): Promise<FileBucket> { return null; }
protected static _loadBucket(service: NebulaService, name:string , callbacks?: Callbacks): Promise<FileBucket> {
nbLogger("FileBucket.loadBucket(), name=" + name + ", callbacks=" + callbacks);
return BaseBucket._baseLoadBucket("file", service, name, Nebula.BUCKET_MODE_ONLINE, callbacks) as Promise<FileBucket>;
}
/**
* @memberOf FileBucket
* @description
* ファイルバケットのバケット名一覧を取得する
* @example
* Nebula.FileBucket.getBucketList()
* .then(function(bucketList) {....})
* .catch(function(error) {....});
* @param {Callbacks} callbacks コールバック (Option)
* @return {Promise} callbacksを指定しなかった場合、Promiseオブジェクトを返す。callback指定時は返り値なし(undefined)。
* <p>処理完了時に渡される値は以下の通り。
* <ul>
* <li>成功時: ファイルバケット名の配列
* <li>失敗時: エラー要因(JSON)
* </ul>
*/
static getBucketList(callbacks?: Callbacks): Promise<string[]> { return null; }
protected static _getBucketList(service: NebulaService, callbacks?: Callbacks): Promise<string[]> {
return BaseBucket._baseGetBucketList("file", service, false, callbacks);
}
/**
* @memberOf FileBucket
* @description
* ファイルバケットを保存する
* @example
* var bucket = new Nebula.FileBucket("Person");
* ....
* bucket.saveBucket()
* .then(function(bucket) {....})
* .catch(function(error) {....});
* @param {Callbacks} callbacks コールバック (Option)
* @return {Promise} callbacksを指定しなかった場合、Promiseオブジェクトを返す。callback指定時は返り値なし(undefined)。
* <p>処理完了時に渡される値は以下の通り。
* <ul>
* <li>成功時: ファイルバケット (Nebula.FileBucket) インスタンス
* <li>失敗時: エラー要因(JSON)
* <pre>
* {
* "status" : ステータスコード,
* "statusText" : エラーメッセージ,
* "responseText" : レスポンスメッセージ
* "data" : Nebula.FileBucket インスタンス
* }
* </pre>
* </ul>
*/
saveBucket(callbacks?: Callbacks): Promise<FileBucket> {
return super.saveBucket(callbacks) as Promise<FileBucket>;
}
/**
* @memberOf FileBucket
* @description
* ファイルバケットを削除する
* @example
* var bucket = new Nebula.FileBucket("Person");
* ....
* callbacks = {
* success: function(bucket) {....},
* error: function(err) {....}
* };
* bucket.deleteBucket(callbacks);
* @param {Callbacks} callbacks コールバック (Option)
* @return {Promise} callbacksを指定しなかった場合、Promiseオブジェクトを返す。callback指定時は返り値なし(undefined)。
* <p>処理完了時に渡される値は以下の通り。
* <ul>
* <li>成功時: ファイルバケット (Nebula.FileBucket) インスタンス
* <li>失敗時: エラー要因(JSON)
* <pre>
* {
* "status" : ステータスコード,
* "statusText" : エラーメッセージ,
* "responseText" : レスポンスメッセージ
* "data" : Nebula.FileBucket インスタンス
* }
* </pre>
* </ul>
*/
deleteBucket(callbacks?: Callbacks): Promise<FileBucket> {
return super.deleteBucket(callbacks) as Promise<FileBucket>;
}
/**
* @memberOf FileBucket
* @description
* ファイルバケットのACLを設定する.
* <p>本メソッドを呼び出しただけでは、サーバに格納されているファイルバケットは更新されない。
* <br/>サーバと同期するには、saveBucket()を呼び出す必要がある。
* @example
* var bucket = ....;
* var acl = new Nebula.Acl();
* ....
* acl.addEntry(....);
* ....
* bucket.setAcl(acl);
* @param acl {Acl} Aclインスタンス
* @return {FileBucket} this
*/
setAcl(acl: Acl): FileBucket {
super.setAcl(acl);
return this;
}
/**
* @memberOf FileBucket
* @description
* ファイルバケットのACLを取得する.
* <p>ファイルバケットのACLを取得するには、loadBucket()を使用してサーバのバケット情報をロードしておく必要がある
* @example
* var bucket = ....;
* ....
* var acl = bucket.getAcl();
* @return
* {Acl} ファイルバケットのACL
*/
getAcl(): Acl {
return super.getAcl();
}
/**
* @memberOf FileBucket
* @description
* ファイルバケットのACLレスモード有効/無効を設定する。
* <p>本メソッドを呼び出さない場合、ACLレスモードはデフォルト無効。
* <p>本メソッドを呼び出しただけでは、サーバに格納されているファイルバケットは更新されない。
* <br/>サーバと同期するには、saveBucket()を呼び出す必要がある。
* @example
* var bucket = ....;
* ....
* var noAcl = true;
* bucket.setNoAcl(noAcl);
* @param noAcl {boolean} ACLレスモードを有効にする場合はtrueを指定する。
* @return {FileBucket} this
*/
setNoAcl(noAcl: boolean): FileBucket {
super.setNoAcl(noAcl);
return this;
}
/**
* @memberOf FileBucket
* @description
* ファイルバケットのACLレスモード有効/無効を取得する。
* @example
* var bucket = ....;
* ....
* var noAcl = bucket.isNoAcl();
* @return
* {boolean} ファイルバケットがACLレスモード有効の場合はtrueを返す。
*/
isNoAcl(): boolean {
return super.isNoAcl();
}
/**
* @memberOf FileBucket
* @description
* ファイルバケットのコンテンツACLを設定する.
* <p>本メソッドを呼び出しただけでは、サーバに格納されているファイルバケットは更新されない。
* <br/>サーバと同期するには、saveBucket()を呼び出す必要がある。
* @example
* var bucket = ....;
* var acl = new Nebula.Acl();
* ....
* acl.addEntry(....);
* ....
* bucket.setContentAcl(acl);
* @param {Acl} acl Nebula.ACL のインスタンス
* @return {FileBucket} this
*/
setContentAcl(acl: Acl): FileBucket {
super.setContentAcl(acl);
return this;
}
/**
* @memberOf FileBucket
* @description
* ファイルバケットのコンテンツACLを取得する.
* <p>ファイルバケットのコンテンツACLを取得するには、loadBucket()を使用してサーバのバケット情報をロードしておく必要がある
* @example
* var bucket = ....;
* ....
* var acl = bucket.getAcl();
* @return
* {Acl} ファイルバケットのコンテンツACL
*/
getContentAcl(): Acl {
return super.getContentAcl();
}
/**
* @memberOf FileBucket
* @description
* ファイルバケットに「説明文」を設定する.
* <p>本メソッドを呼び出しただけでは、サーバに格納されているファイルバケットは更新されない。
* <br/>サーバと同期するには、saveBucket()を呼び出す必要がある。
* @example
* var bucket = ....;
* var acl = new Nebula.Acl();
* ....
* acl.addEntry(....);
* ....
* bucket.setDescription("このバケットの説明文”);
* @param {String} description 設定する「説明文」
* @return {FileBucket} this
*/
setDescription(description: string): FileBucket {
super.setDescription(description);
return this;
}
/**
* @memberOf FileBucket
* @description
* ファイルバケットの「説明文」を取得する.
* <p>ファイルバケットのコンテンツACLを取得するには、loadBucket()を使用してサーバのバケット情報をロードしておく必要がある
* @example
* var bucket = ....;
* ....
* var description = bucket.getDescription();
* @return
* {String} ファイルバケットの「説明文」
*/
getDescription(): string {
return super.getDescription();
}
/**
* @memberOf FileBucket
* @description
* ファイルバケット名を取得する
* @example
* var bucket = ....;
* ....
* var bucketName = bucket.getBucketName();
* @return
* {String} ファイルバケット名
*/
getBucketName(): string {
return super.getBucketName();
}
/**
* @memberOf FileBucket
* @description ファイルバケット名を設定する
* @private
*/
_setBucketName(name: string): FileBucket {
super.setBucketName(name);
return this;
}
private _save(fileName: string, data: any, metadata: FileMetadata, update: boolean, callbacks: Callbacks): Promise<FileMetadata> {
nbLogger("FileBucket._save()");
if (!fileName) {
nbLogger("FileBucket._save(), Parameter is invalid : fileName");
throw new Error("No fileName");
}
if (!data) {
nbLogger("FileBucket._save(), Parameter is invalid : data");
throw new Error("No data");
}
if (!(typeof Blob !== "undefined" && Blob !== null) && !(typeof Buffer !== "undefined" && Buffer !== null)) {
nbLogger("FileBucket._save(), Not supported Blob nor Buffer");
throw new Error("No Blob/Buffer support");
}
if ((typeof data !== "string")
&& (typeof Blob !== "undefined" && Blob !== null && !(data instanceof Blob))
&& (typeof Buffer !== "undefined" && Buffer !== null && !(Buffer.isBuffer(data)))) {
nbLogger("FileBucket._save(), Data is not String, Blob nor Buffer");
throw new Error("data is not String, Blob nor Buffer");
}
if (!update) {
if (!metadata || !metadata.getContentType()) {
nbLogger("FileBucket._save(), Parameter is invalid : metadata.contentType");
throw new Error("No contentType in metadata");
}
}
const path = this.getDataPath("/" + encodeURIComponent(fileName));
nbLogger("FileBucket._save(), path=" + path);
const req = new HttpRequest(this._service, path);
if (update) {
req.setMethod("PUT");
} else {
req.setMethod("POST");
req.setContentType(metadata.getContentType());
if (metadata.getAcl() != null) {
req.addRequestHeader("X-ACL", metadata.getAcl()._toString());
}
if (metadata.getOptions() != null) {
req.addRequestHeader("X-Meta-Options", JSON.stringify(metadata.getOptions()));
}
}
req.setData(data);
const promise = req.execute().then(response => {
try {
const resObj = JSON.parse(response);
if (metadata === null) {
metadata = new FileMetadata();
}
metadata._setMetadata(resObj);
return Promise.resolve(metadata);
} catch (e) {
nbLogger("FileBucket._save(), success: exception=" + e);
const error = _createError(0, "Invalid response from server", e, fileName);
return Promise.reject(error);
}
}, error => {
nbLogger(("FileBucket._save(), error: " + (_errorText(error))));
error.data = fileName;
return Promise.reject(error);
});
return _promisify(promise, callbacks);
}
/**
* @memberOf FileBucket
* @description
* ファイルバケットへファイルを新規保存する.
* <p>HTML5 File APIに対応しているブラウザ、もしくは Node.js のみで実行可能。
* @example
* var bucket = ....;
* ....
* var file = ....;
* ....
* var meta = new Nebula.FileMetadata();
* meta.setContentType("image/jpeg");
* bucket.saveAs("MyFileName.jpg", file, meta)
* .then(function(metadata) {...})
* .catch(function(err) {...});
* @param {String} fileName ファイルバケットへ保存するファイル名
* @param {Object} data 文字列、File/Blobオブジェクト、または Buffer オブジェクト。
* <p>サーバに保存するファイルのデータを以下のいずれかで指定する。
* <ul>
* <li>保存するファイルにバインドされたFileオブジェクト
* <li>保存するファイルのデータ。文字列/Blobオブジェクト/Bufferオブジェクトのいずれか。
* </ul>
* @param {FileMetadata} metadata 保存するファイルのメタデータ
* <p>指定できるメタデータは以下の通りである。(他のメタデータは参照されない)
* <ul>
* <li>ACL (オプション、省略可)
* <li>コンテンツタイプ (必須、省略不可)
* </ul>
* @param {Callbacks} callbacks コールバック (Option)
* @return {Promise} callbacksを指定しなかった場合、Promiseオブジェクトを返す。callback指定時は返り値なし(undefined)。
* <p>処理完了時に渡される値は以下の通り。
* <ul>
* <li>成功時: Nebula.FileMetadata インスタンス
* <li>失敗時: エラー要因(JSON)
* <pre>
* {
* "status" : ステータスコード,
* "statusText" : エラーメッセージ,
* "responseText" : レスポンスメッセージ
* "data" : 引数で指定されたfileName
* }
* </pre>
* </ul>
*/
saveAs(fileName: string, data: any, metadata: FileMetadata, callbacks?: Callbacks): Promise<FileMetadata> {
return this._save(fileName, data, metadata, false, callbacks);
}
/**
* @memberOf FileBucket
* @description
* ファイルバケットのファイルを保存する.
* <p>HTML5 File APIに対応しているブラウザ、または Node.js のみで実行可能。
* @example
* var bucket = ....;
* ....
* var file = ....;
* ....
* bucket.save("MyFileName.jpg", file)
* .then(function(metadata) {...})
* .catch(function(err) {...});
* @param {String} fileName ファイルバケットへ保存するファイル名
* @param {Object} data 文字列、File/Blobオブジェクト、または Buffer オブジェクト
* <p>サーバに保存するファイルのデータを以下のいずれかで指定する。
* <ul>
* <li>保存するファイルにバインドされたFileオブジェクト
* <li>保存するファイルのデータ。文字列/Blobオブジェクト/Bufferオブジェクトのいずれか。
* </ul>
* @param {Callbacks} callbacks コールバック (Option)
* @return {Promise} callbacksを指定しなかった場合、Promiseオブジェクトを返す。callback指定時は返り値なし(undefined)。
* <p>処理完了時に渡される値は以下の通り。
* <ul>
* <li>成功時: Nebula.FileMetadata インスタンス
* <li>失敗時: エラー要因(JSON)
* <pre>
* {
* "status" : ステータスコード,
* "statusText" : エラーメッセージ,
* "responseText" : レスポンスメッセージ
* "data" : 引数で指定されたfileName
* }
* </pre>
* </ul>
*/
save(fileName: string, data: any, callbacks?: Callbacks): Promise<FileMetadata> {
return this._save(fileName, data, null, true, callbacks);
}
/**
* @memberOf FileBucket
* @description
* ファイルバケットからファイルを読み込む.
* <p>HTML5 File APIに対応しているブラウザ、または Node.js のみで実行可能。
* @example
* var bucket = ....;
* ....
* bucket.load("MyFile.jpg")
* .then(function(blob) {...})
* .catch(function(err) {...});
* @param {String} fileName ファイルバケットから読み込むファイルの名前
* @param {Callbacks} callbacks コールバック (Option)
* @return {Promise} callbacksを指定しなかった場合、Promiseオブジェクトを返す。callback指定時は返り値なし(undefined)。
* <p>処理完了時に渡される値は以下の通り。
* <ul>
* <li>成功時: ファイルの内容が格納されたBlobオブジェクト (node.js の場合は Buffer オブジェクト)
* <li>失敗時: エラー要因(JSON)
* <pre>
* {
* "status" : ステータスコード,
* "statusText" : エラーメッセージ,
* "responseText" : レスポンスメッセージ
* "data" : 引数で指定されたfileName
* }
* </pre>
* </ul>
*/
load(fileName: string, callbacks?: Callbacks): Promise<any> {
return this._load(fileName, undefined, callbacks);
}
/**
* @memberOf FileBucket
* @description
* ファイルバケットからオプションを指定してファイルを読み込む.
* <p>Node.js のみで実行可能。
* @param {String} fileName ファイルバケットから読み込むファイルの名前
* @param {Object} options ファイル取得のパラメータ(オプション)。
* <p>JSONで指定する。各フィールドの説明は以下の通り。
* <ul>
* <li>"rawRequest"
* <p>ファイルをRaw messageとして読み込む場合にtrueを設定する。(オプション)
* <p>trueの場合、extraResponseは無効となる。原則として応答の取得にはPromiseを使用すること。
*
* <p>HTTP/1.1において、処理が成功した場合、Promise には http.IncomingMessage が返される。
* http.IncomingMessage に対するイベントハンドラを自身で設定、適切にハンドリングすること。
* データ読み込み時は http.IncomingMessage よりレスポンスのステータスを取得、判定を行うこと。
*
* <p>リクエスト送信が失敗した場合、Promise には error が返される。
*
* <p>HTTP/2において、処理が成功した場合、Promise には http2.ClientHttp2Stream が返される。
* ClientHttp2Stream に対するイベントハンドラを自身で設定、適切にハンドリングすること。
* HTTP/2のステータスコードを取得するには、'response'イベントの':status'を参照する。
* 具体的な指定方法はexamplesを参照。
*
* <li>"extraResponse"
* <p>レスポンスにステータスコード、ヘッダを追加する。(オプション)</p>
* <p>通常レスポンスにはBuffer オブジェクトを返却するが、
* extraResponseをtrueに設定した場合、以下のプロパティが設定されたJSONを返却する。</p>
* <ul>
* <li>status : ステータスコード,
* <li>headers : レスポンスヘッダ情報を含むオブジェクト,
* <li>body : ファイルデータが格納されたBufferオブジェクト
* </ul>
* </li>
*
* <li>"ifMatch"
* <p>If-Matchヘッダを付与する場合に指定(オプション)
* <p>値はファイルのETagを使用する。
* サーバのファイルが更新されている場合、エラーを返却する。
*
* <li>"ifRange"
* <p>If-Rangeヘッダを付与する場合に指定 (オプション)
* <p>値はファイルのETagを使用する。
* rangeStart/rangeEndを指定しない場合は無効である。
* <p>ETag不一致の場合、rangeStart/rangeEndをは参照せず更新済みの新しいファイルを取得する。
* <p>ifRange より ifMatchを優先して評価する。ファイルが更新されている場合でもファイル取得を行うには、ifRangeのみを指定すること。
*
* <li>"rangeStart
* <p>取得するファイルの開始位置(オプション)
*
* <li>"rangeEnd"
* <p>ファイルの終了位置(オプション)
* <p>rangeStartと組み合わせて、"0〜(ファイルサイズ-1)"の範囲で指定を行う。
* <p>rangeEndのみ指定した場合は、末尾の取得バイト数を表す。
* rangeStart/rangeEndの値をベースにRangeヘッダを付与する。
* <p>不正な範囲の場合、サーバでファイルのサイズに合わせて値を変更する場合がある。
* メタデータからファイルサイズを検証し、ifMatch、ifRangeと組み合わせて使用することを推奨する。
* 具体的な指定方法はexamplesを参照。
* </ul>
* @param {Callbacks} callbacks コールバック (Option)
* <ul>
* <li>optionに {rawRequest:true}を指定した場合、callbacksは指定できない。Promiseを使用すること。
* </ul>
* @return {Promise} callbacksを指定しなかった場合、Promiseオブジェクトを返す。callback指定時は返り値なし(undefined)。
* <p>処理完了時に渡される値は以下の通り。
* <ul>
* <li>成功時: option の extraResponse, rawRequest 指定により、渡される値が異なる。
* <ul>
* <li>a) ファイルのBufferオブジェクト (option の extraResponse, rawRequest を指定しない場合)</li>
*
* <li>b) ファイルデータを含む JSON オブジェクト (optionに {extraResponse:true} を指定した場合)
* <pre>
* {
* status : ステータスコード,
* headers : レスポンスヘッダ情報を含むオブジェクト,
* body : ファイルデータが格納されたオブジェクト
* }
*
* 範囲囲指定のオプションを指定した場合、以下statusが返却される。
* ・200 ファイル全体を取得
* ・206 ファイルの一部取得
*
* headersには以下をヘッダを含む。
* ・etag : ファイルのETag。
* 値はダブルクオーテーション(")で囲まれている。
* etag参照時はクオーテーションを削除して使用すること。
* 例) headers["etag"].replace(/[¥"]/g, "");
* </pre>
* </li>
* <li>c) http.IncomingMessage または http2.ClientHttpStream (option に {rawRequest: true} を指定した場合)</li>
* </ul>
* </li>
* <li>失敗時: エラー要因(JSON)
* <pre>
* {
* "status" : ステータスコード,
* "statusText" : エラーメッセージ,
* "responseText" : レスポンスメッセージ,
* "data" : 引数で指定されたfileName,
* }
* 範囲指定の読み込みでは以下statusのエラーが発生することがある。
* 内容に応じて対処を行うこと。
* 412 : ファイルが更新されているためダウンロード失敗
* 416 : 範囲指定不正のためダウンロード失敗
* </pre></li>
* </ul>
* @since 7.5.0
* @example
* // Raw Requestの例
* // for HTTP/1.1
* var bucket = ....;
* ....
* // pipe()を使用する場合
* var writable = fs.createWriteStream(....);
* bucket.loadWithOptions("MyFile.jpg", {rawRequest: true})
* .then((message) => {
* message.pipe(writable);
* });
*
* // 'data'を実装する場合
* bucket.loadWithOptions("MyFile.jpg", {rawRequest: true})
* .then((message) => {
* message.on('data', () => {....});
* message.on('end', () => {....});
* message.on('error', () => {....});
* message.on('close', () => {....});
* });
*
* // for HTTP/2
* // 'data'を実装する場合
* var statusCode;
* bucket.loadWithOptions("MyFile.jpg", {rawRequest: true})
* .then((message) => {
* message.on('response', (headers, flags) => { statusCode = headers[':status'] });
* message.on('data', () => {....});
* message.on('end', () => {....});
* message.on('error', () => {....});
* message.on('close', () => {....});
* });
* @example
* // start,end 指定の例 詳細はRFC7233を参照
* // サーバに1000 byteのファイルが格納されている場合
* // 最初の50byteを取得
* var options = { rangeStart : 0, rangeEnd: 49 };
* // 次の50byteを取得
* options = { rangeStart : 50, rangeEnd: 99 };
* // 末尾の50byteを取得する(以下指定は等価である)
* options = { rangeStart : 950 };
* options = { rangeEnd : 50 };
* options = { rangeStart : 950, rangeEnd: 999 };
* // 先頭の1byteを指定
* options = { rangeStart: 0, rangeEnd: 0 };
* // 末尾の1byteを指定
* options = { rangeEnd: 1 };
*
* options["extraResponse"] = true; // ステータスコードなどを含めて取得
* // APIコール
* var bucket = ....;
* ....
* callbacks = {
* // options["extraResponse"] がtrueでない場合、dataにはファイルデータが設定される
* success: function(data) {
* var status = data.status;
* var headers = data.headers;
* var body = data.body;
* ....
* },
* error: function(err) {....}
* };
* bucket.loadWithOptions("MyFile.jpg", options, callbacks);
*/
loadWithOptions(fileName: string, options?: FileRequestOptions, callbacks?: Callbacks): Promise<any> {
return this._load(fileName, options, callbacks);
}
_load(fileName: string, options?: FileRequestOptions, callbacks?: Callbacks): Promise<any> {
nbLogger("FileBucket._load()");
if (!(typeof fileName !== "undefined" && fileName !== null)) {
nbLogger("FileBucket._load(), Parameter is invalid : fileName");
throw new Error("No fileName");
}
let rawRequest: boolean = false;
if (typeof options !== "undefined") {
// validate options
if (options === null || typeof options !== "object") {
// typeof null -> "object"
nbLogger("FileBucket._load(), Invalid options: " + options);
throw new Error("Invalid options: " + options);
}
if (options["rawRequest"] === true) {
if (!(typeof Blob !== "undefined" && Blob !== null) && !(typeof Buffer !== "undefined" && Buffer !== null)) {
nbLogger("FileBucket._load(), Not supported Blob nor Buffer");
throw new Error("No Blob/Buffer support");
}
rawRequest = true;
}
}
const path = this.getDataPath("/" + encodeURIComponent(fileName));
nbLogger("FileBucket._load(), path=" + path);
const req = new HttpRequest(this._service, path);
req.setMethod("GET");
if (rawRequest) {
req.rawMessage = true;
} else {
if (typeof Blob !== "undefined" && Blob !== null) {
req.setResponseType("blob");
} else if (typeof Buffer !== "undefined" && Buffer !== null) {
req.setResponseType("buffer");
}
}
if (typeof options !== "undefined") {
const receiveResponse = options["extraResponse"];
if (receiveResponse === true) {
req.setReceiveResponseHeaders(true);
}
// Range
const start = options["rangeStart"];
const end = options["rangeEnd"];
const range = FileBucket._createRangeValue(start, end);
if (range !== undefined) {
// Range: bytes=range-value
req.addRequestHeader("Range", "bytes=" + range);
}
// If-Match,If-Range
const ifMatch = options["ifMatch"];
if (typeof ifMatch !== "undefined") {
// If-Match: "ETag"
req.addRequestHeader("If-Match", '"' + ifMatch + '"');
}
const ifRange = options["ifRange"];
if (typeof ifRange !== "undefined") {
// If-Range: "ETag"
req.addRequestHeader("If-Range", '"' + ifRange + '"');
}
}
const promise = req.execute().then(response => {
return response;
}, err => {
nbLogger(("FileBucket._load(), error: " + (_errorText(err))));
err.data = fileName;
return Promise.reject(err);
});
return _promisify(promise, callbacks);
}
/**
* @memberOf FileBucket
* @description start/end位置からRangeヘッダに指定する値を生成する
* @private
*/
static _createRangeValue(start: number, end: number): string {
// undefinedは許容
if (start !== undefined && (!Number.isInteger(start) || start < 0)) {
throw new Error("invalid rangeStart value: " + start);
}
if (end !== undefined && (!Number.isInteger(end) || end < 0)) {
throw new Error("invalid rangeEnd value: " + end);
}
// Rangeの範囲チェックはサーバ側で行う
let range: string = undefined;
if (start === undefined && end === undefined) {
// star,endとも未指定の場合はRangeヘッダを付与しない
// 何もしない
} else if (start !== undefined && end === undefined) {
// startのみ指定
range = start + "-";
} else if (start === undefined && end !== undefined) {
// endのみ指定
range = "-" + end;
} else {
// start,endともに指定
range = start + "-" + end;
}
return range;
}
/**
* @memberOf FileBucket
* @description
* ファイルバケットからファイルを削除する.
* @example
* var bucket = ....;
* ....
* bucket.remove("fileName")
* .then(function(fileName) {...})
* .catch(function(err) {...});
* @param {String} fileName ファイルバケットから削除するファイルの名前
* @param {Callbacks} callbacks コールバック (Option)
* @return {Promise} callbacksを指定しなかった場合、Promiseオブジェクトを返す。callback指定時は返り値なし(undefined)。
* <p>処理完了時に渡される値は以下の通り。
* <ul>
* <li>成功時: ファイル名(引数で指定されたfileNameと同じ)
* <li>失敗時: エラー要因(JSON)
* <pre>
* {
* "status" : ステータスコード,
* "statusText" : エラーメッセージ,
* "responseText" : レスポンスメッセージ,
* "data" : 引数で指定されたfileName
* }
* </pre>
* </ul>
* @since v4.0.1
*/
remove(fileName: string, callbacks?: Callbacks): Promise<string> {
nbLogger("FileBucket.remove()");
if (!(typeof fileName !== "undefined" && fileName !== null)) {
nbLogger("FileBucket.remove(), Parameter is invalid : fileName");
throw new Error("No fileName");
}
let req: ApiRequest;
if (this._service.isOffline()) {
req = new _SdeRequest(this.getClassName(), "delete");
const body = {
bucketName: this.getBucketName(),
fileName
};
req.setData(body);
} else {
const path = this.getDataPath("/" + encodeURIComponent(fileName));
nbLogger("FileBucket.remove(), path=" + path);
req = new HttpRequest(this._service, path);
req.setMethod("DELETE");
}
const promise = req.execute().then(response => {
nbLogger("FileBucket.remove(), success: " + fileName);
return fileName;
}, err => {
nbLogger(("FileBucket.remove(), error: " + (_errorText(err)) + " : " + (fileName)));
err.data = fileName;
return Promise.reject(err);
});
return _promisify(promise, callbacks);
}
/**
* @memberOf FileBucket
* @description
* ファイルバケットからファイルを削除する(Deprecated)
* <p>本APIは Deprecated である。remove() を使用すること。
* @deprecated since v4.0.1
*/
delete(fileName: string, callbacks?: Callbacks): Promise<string> {
return this.remove(fileName, callbacks);
}
/**
* @memberOf FileBucket
* @description JSONからFileMetadataインスタンスを生成する
* @private
*/
protected _createMetadata(obj: FileMetadataJson): FileMetadata {
const metadata = new FileMetadata();
metadata._setMetadata(obj);
return metadata;
}
private _publish(fileName: string, published: boolean, callbacks?: Callbacks): Promise<FileMetadata> {
nbLogger("FileBucket._publish(), fileName=" + fileName + ", setFlg=" + published);
if (!(typeof fileName !== "undefined" && fileName !== null)) {
nbLogger("FileBucket._publish(), Parameter is invalid : fileName");
throw new Error("No fileName");
}
let req: ApiRequest;
if (this._service.isOffline()) {
req = new _SdeRequest(this.getClassName(), "publish");
const body = {
bucketName: this.getBucketName(),
fileName,
published
};
req.setData(body);
} else {
const path = this.getDataPath("/" + encodeURIComponent(fileName) + "/publish");
nbLogger("FileBucket._publish(), path=" + path);
req = new HttpRequest(this._service, path);
if (published) {
req.setMethod("PUT");
} else {
req.setMethod("DELETE");
}
}
const promise = req.execute().then(response => {
nbLogger("FileBucket._publish(), success: " + fileName);
try {
const resObj = JSON.parse(response);
const metadata = this._createMetadata(resObj);
return Promise.resolve(metadata);
} catch (e) {
nbLogger("FileBucket._publish(), success: exception=" + e);
const errorResult = _createError(0, "Invalid response from server", e);
errorResult.data = fileName;
return Promise.reject(errorResult);
}
}, err => {
nbLogger(("FileBucket._publish(), error: " + (_errorText) + " : " + (fileName)));
err.data = fileName;
return Promise.reject(err);
});
return _promisify(promise, callbacks);
}
/**
* @memberOf FileBucket
* @description
* ファイルバケットのファイルを公開する.
* <p>既に公開されたファイルを再公開しても公開 URL は変更されない。
* @example
* var bucket = ....;
* ....
* bucket.publish("MyFile.jpg")
* .then(function(metadata) {...})
* .catch(function(err) {...});
* @param {String} fileName 公開するファイルの名前
* @param {Callbacks} callbacks コールバック (Option)
* @return {Promise} callbacksを指定しなかった場合、Promiseオブジェクトを返す。callback指定時は返り値なし(undefined)。
* <p>処理完了時に渡される値は以下の通り。
* <ul>
* <li>成功時: このファイルのメタデータ
* <li>失敗時: エラー要因(JSON)
* <pre>
* {
* "status" : ステータスコード,
* "statusText" : エラーメッセージ,
* "responseText" : レスポンスメッセージ,
* "data" : 引数で指定されたfileName
* }
* </pre>
* </ul>
*/
publish(fileName: string, callbacks?: Callbacks): Promise<FileMetadata> {
nbLogger("FileBucket.publish()");
return this._publish(fileName, true, callbacks);