package awskit-s3

  1. Overview
  2. Docs
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Source file bucket_request.ml

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
open Common
open Headers
open Response
open Tagging_xml
module Create_bucket = Bucket.Create
module Delete_bucket = Bucket.Delete
module Head_bucket = Bucket.Head
module List_buckets = Bucket.List_buckets
module Get_bucket_location = Bucket.Get_location

module Make (C : Request_context.S) = struct
  open C

  let ( let* ) = bind

  type nonrec connection = connection
  type 'a io = 'a R.t

  let bucket_root_request conn bucket =
    bucket_request conn ~bucket ~suffix:"/" ~signing_suffix:"/"

  let content_md5_header body = ("content-md5", content_md5 body)

  let expected_owner_headers expected_bucket_owner =
    [] |> add_opt_header "x-amz-expected-bucket-owner" expected_bucket_owner

  let get_xml ?expected_bucket_owner conn ~bucket ~subresource ~max_size ~parse
      =
    match validate_bucket bucket with
    | Error error -> return_error error
    | Ok () -> (
        match bucket_root_request conn bucket with
        | Error error -> return_error error
        | Ok request ->
            with_empty_response conn ~method_:`GET ~request
              ~query:[ (subresource, []) ]
              ~headers:(expected_owner_headers expected_bucket_owner)
              ~f:(fun response body ->
                let* body = read_response_body body ~max_size in
                match body with
                | Error error -> return_error error
                | Ok body -> return (parse body response)))

  let put_xml ?expected_bucket_owner conn ~bucket ~subresource ~body =
    match validate_bucket bucket with
    | Error error -> return_error error
    | Ok () -> (
        let upload = R.Request_body.of_string body in
        let headers =
          [ content_md5_header body; ("content-type", "application/xml") ]
          |> add_opt_header "x-amz-expected-bucket-owner" expected_bucket_owner
        in
        match bucket_root_request conn bucket with
        | Error error -> return_error error
        | Ok request ->
            with_response conn ~method_:`PUT ~request
              ~query:[ (subresource, []) ]
              ~headers
              ~payload_hash:(R.Request_body.descriptor upload).payload_hash
              upload
              ~f:(fun response body ->
                let* discarded = discard_response_body body in
                match discarded with
                | Error error -> return_error error
                | Ok () -> return_ok response))

  let delete_subresource ?expected_bucket_owner conn ~bucket ~subresource =
    match validate_bucket bucket with
    | Error error -> return_error error
    | Ok () -> (
        match bucket_root_request conn bucket with
        | Error error -> return_error error
        | Ok request ->
            with_empty_response conn ~method_:`DELETE ~request
              ~query:[ (subresource, []) ]
              ~headers:(expected_owner_headers expected_bucket_owner)
              ~f:(fun response body ->
                let* discarded = discard_response_body body in
                match discarded with
                | Error error -> return_error error
                | Ok () -> return_ok response))

  let create conn ~bucket ?options () =
    let options = Option.value ~default:Create_bucket.default_options options in
    match validate_bucket bucket with
    | Error error -> return_error error
    | Ok () -> (
        let region = Option.value ~default:(R.region conn) options.region in
        let body =
          if
            Awskit.Region.equal region (Awskit.Region.of_string_exn "us-east-1")
          then ""
          else Bucket_result_xml.create_config region
        in
        let upload = R.Request_body.of_string body in
        let headers =
          if body = "" then [] else [ ("content-type", "application/xml") ]
        in
        match bucket_root_request conn bucket with
        | Error error -> return_error error
        | Ok request ->
            with_response conn ~method_:`PUT ~request ~query:[] ~headers
              ~payload_hash:(R.Request_body.descriptor upload).payload_hash
              upload ~f:(fun response body ->
                let* discarded = discard_response_body body in
                match discarded with
                | Error error -> return_error error
                | Ok () -> return_ok { Create_bucket.response }))

  let delete ?expected_bucket_owner conn ~bucket =
    match validate_bucket bucket with
    | Error error -> return_error error
    | Ok () -> (
        match bucket_root_request conn bucket with
        | Error error -> return_error error
        | Ok request ->
            with_empty_response conn ~method_:`DELETE ~request ~query:[]
              ~headers:(expected_owner_headers expected_bucket_owner)
              ~f:(fun response body ->
                let* discarded = discard_response_body body in
                match discarded with
                | Error error -> return_error error
                | Ok () -> return_ok { Delete_bucket.response }))

  let head ?expected_bucket_owner conn ~bucket =
    match validate_bucket bucket with
    | Error error -> return_error error
    | Ok () -> (
        match bucket_root_request conn bucket with
        | Error error -> return_error error
        | Ok request ->
            with_empty_response conn ~method_:`HEAD ~request ~query:[]
              ~headers:(expected_owner_headers expected_bucket_owner)
              ~f:(fun response body ->
                let* discarded = discard_response_body body in
                match discarded with
                | Error error -> return_error error
                | Ok () ->
                    let region =
                      Option.bind
                        (Awskit.Response.header response "x-amz-bucket-region")
                        (fun value ->
                          Result.to_option (Awskit.Region.of_string value))
                    in
                    return_ok { Head_bucket.name = bucket; region; response }))

  let exists ?expected_bucket_owner conn ~bucket =
    let* result = head ?expected_bucket_owner conn ~bucket in
    match result with
    | Ok _ -> return_ok true
    | Error error when Error.is_not_found error -> return_ok false
    | Error error -> return_error error

  let list conn =
    match root_request conn with
    | Error error -> return_error error
    | Ok request ->
        with_empty_response conn ~method_:`GET ~request ~query:[] ~headers:[]
          ~f:(fun response body ->
            let* body = read_response_body body ~max_size:4_194_304L in
            match body with
            | Error error -> return_error error
            | Ok body ->
                return
                  (Result.map
                     (fun buckets -> { List_buckets.buckets; response })
                     (Bucket_result_xml.parse_list body)))

  let get_location ?expected_bucket_owner conn ~bucket =
    match validate_bucket bucket with
    | Error error -> return_error error
    | Ok () -> (
        match bucket_root_request conn bucket with
        | Error error -> return_error error
        | Ok request ->
            with_empty_response conn ~method_:`GET ~request
              ~query:[ ("location", []) ]
              ~headers:(expected_owner_headers expected_bucket_owner)
              ~f:(fun response body ->
                let* body = read_response_body body ~max_size:1_048_576L in
                match body with
                | Error error -> return_error error
                | Ok body ->
                    return
                      (Result.map
                         (fun region ->
                           { Get_bucket_location.region; response })
                         (Bucket_result_xml.parse_location body))))

  module Policy = struct
    let get ?expected_bucket_owner conn ~bucket =
      match validate_bucket bucket with
      | Error error -> return_error error
      | Ok () -> (
          match bucket_root_request conn bucket with
          | Error error -> return_error error
          | Ok request ->
              with_empty_response conn ~method_:`GET ~request
                ~query:[ ("policy", []) ]
                ~headers:(expected_owner_headers expected_bucket_owner)
                ~f:(fun _response body ->
                  let* body = read_response_body body ~max_size:1_048_576L in
                  match body with
                  | Error error -> return_error error
                  | Ok body -> return (Policy.of_json body)))

    let put conn ~bucket ?expected_bucket_owner policy =
      match validate_bucket bucket with
      | Error error -> return_error error
      | Ok () -> (
          let body = Policy.to_json policy in
          let upload = R.Request_body.of_string body in
          let headers =
            [ content_md5_header body; ("content-type", "application/json") ]
            |> add_opt_header "x-amz-expected-bucket-owner"
                 expected_bucket_owner
          in
          match bucket_root_request conn bucket with
          | Error error -> return_error error
          | Ok request ->
              with_response conn ~method_:`PUT ~request
                ~query:[ ("policy", []) ]
                ~headers
                ~payload_hash:(R.Request_body.descriptor upload).payload_hash
                upload
                ~f:(fun response body ->
                  let* discarded = discard_response_body body in
                  match discarded with
                  | Error error -> return_error error
                  | Ok () -> return_ok response))

    let delete ?expected_bucket_owner conn ~bucket =
      delete_subresource ?expected_bucket_owner conn ~bucket
        ~subresource:"policy"
  end

  module Versioning = struct
    let get ?expected_bucket_owner conn ~bucket =
      get_xml ?expected_bucket_owner conn ~bucket ~subresource:"versioning"
        ~max_size:1_048_576L ~parse:Bucket_versioning_xml.parse

    let put conn ~bucket ?expected_bucket_owner status =
      put_xml ?expected_bucket_owner conn ~bucket ~subresource:"versioning"
        ~body:(Bucket_versioning_xml.xml (Some status))
  end

  module Tagging = struct
    let parse body response =
      Result.map
        (fun tags -> { Bucket.Tagging.tags; response })
        (parse_tags body)

    let get ?expected_bucket_owner conn ~bucket =
      get_xml ?expected_bucket_owner conn ~bucket ~subresource:"tagging"
        ~max_size:1_048_576L ~parse

    let put conn ~bucket ?expected_bucket_owner tags =
      match validate_tags tags with
      | Error error -> return_error error
      | Ok () ->
          put_xml ?expected_bucket_owner conn ~bucket ~subresource:"tagging"
            ~body:(xml_tags tags)

    let delete ?expected_bucket_owner conn ~bucket =
      delete_subresource ?expected_bucket_owner conn ~bucket
        ~subresource:"tagging"
  end

  module Encryption = struct
    let get ?expected_bucket_owner conn ~bucket =
      get_xml ?expected_bucket_owner conn ~bucket ~subresource:"encryption"
        ~max_size:1_048_576L ~parse:Bucket_encryption_xml.parse

    let put conn ~bucket ?expected_bucket_owner config =
      match Bucket_encryption_xml.validate_config config with
      | Error error -> return_error error
      | Ok () ->
          put_xml ?expected_bucket_owner conn ~bucket ~subresource:"encryption"
            ~body:(Bucket_encryption_xml.xml config)

    let delete ?expected_bucket_owner conn ~bucket =
      delete_subresource ?expected_bucket_owner conn ~bucket
        ~subresource:"encryption"
  end

  module Cors = struct
    let get ?expected_bucket_owner conn ~bucket =
      get_xml ?expected_bucket_owner conn ~bucket ~subresource:"cors"
        ~max_size:1_048_576L ~parse:Bucket_cors_xml.parse

    let put conn ~bucket ?expected_bucket_owner config =
      match Bucket_cors_xml.validate_config config with
      | Error error -> return_error error
      | Ok () ->
          put_xml ?expected_bucket_owner conn ~bucket ~subresource:"cors"
            ~body:(Bucket_cors_xml.xml config)

    let delete ?expected_bucket_owner conn ~bucket =
      delete_subresource ?expected_bucket_owner conn ~bucket ~subresource:"cors"
  end

  module Public_access_block = struct
    let get ?expected_bucket_owner conn ~bucket =
      get_xml ?expected_bucket_owner conn ~bucket
        ~subresource:"publicAccessBlock" ~max_size:1_048_576L
        ~parse:Bucket_access_xml.Public_access_block.parse

    let put conn ~bucket ?expected_bucket_owner config =
      put_xml ?expected_bucket_owner conn ~bucket
        ~subresource:"publicAccessBlock"
        ~body:(Bucket_access_xml.Public_access_block.xml config)

    let delete ?expected_bucket_owner conn ~bucket =
      delete_subresource ?expected_bucket_owner conn ~bucket
        ~subresource:"publicAccessBlock"
  end

  module Ownership_controls = struct
    let get ?expected_bucket_owner conn ~bucket =
      get_xml ?expected_bucket_owner conn ~bucket
        ~subresource:"ownershipControls" ~max_size:1_048_576L
        ~parse:Bucket_access_xml.Ownership_controls.parse

    let put conn ~bucket ?expected_bucket_owner config =
      put_xml ?expected_bucket_owner conn ~bucket
        ~subresource:"ownershipControls"
        ~body:(Bucket_access_xml.Ownership_controls.xml config)

    let delete ?expected_bucket_owner conn ~bucket =
      delete_subresource ?expected_bucket_owner conn ~bucket
        ~subresource:"ownershipControls"
  end
end