package devkit
Development kit - general purpose library
Install
Dune Dependency
Authors
Maintainers
Sources
devkit-1.20240429.tbz
sha256=222f8ac131b1d970dab7eeb2714bfd6b9338b88b1082e6e01c136ae19e7eaef4
sha512=c9e6d93e3d21e5530c0f4d5baca51bf1f0a5d19248f8af7678d0665bb5cdf295d7aaaaa3e50eb2e44b8720e55097cc675af4dc8ec45acf9da39feb3eae1405d5
doc/src/devkit.core/web.ml.html
Source file web.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 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
(** web utilities *) open ExtLib open Printf open Prelude open Control open Ocamlnet_lite let log = Log.self (** percent-encode (convert space into %20) *) let rawurlencode = Netencoding.Url.encode ~plus:false (** percent-encode, but convert space into plus, not %20 *) let urlencode = Netencoding.Url.encode ~plus:true (** percent-decode (leave plus as is) *) let rawurldecode s = try Netencoding.Url.decode ~plus:false s with _ -> s (** percent-decode and convert plus into space *) let urldecode s = try Netencoding.Url.decode ~plus:true s with _ -> s let htmlencode = Netencoding.Html.encode ~in_enc:`Enc_utf8 ~out_enc:`Enc_utf8 () let htmldecode_exn = Netencoding.Html.decode ~in_enc:`Enc_utf8 ~out_enc:`Enc_utf8 () let htmldecode = (* U+FFFD REPLACEMENT CHARACTER *) let u_FFFD = "\xEF\xBF\xBD" in let subst _ = u_FFFD in let lookup _ = u_FFFD in Netencoding.Html.decode ~subst ~lookup ~in_enc:`Enc_utf8 ~out_enc:`Enc_utf8 () let htmldecode_relaxed = Netencoding.Html.decode ~in_enc:`Enc_utf8 ~out_enc:`Enc_utf8 ~lookup:(sprintf "&%s;") () (* TODO uncomment when httpev becomes less strict everywhere *) let make_url_args = String.concat "&" $ List.map (function (* (k, "") -> urlencode k | *) (k,v) -> urlencode k ^ "=" ^ urlencode v) (** Minimum strictness, Neturl will fail on malformed parameters in url *) let parse_url_args args = Stre.nsplitc_rev args '&' |> List.rev_map (fun s -> Stre.dividec s '=' |> apply2 urldecode) let url_get_args url = try String.split url "?" |> snd |> parse_url_args with _ -> [] let () = Curl.global_init Curl.CURLINIT_GLOBALALL let curl_times h = Curl.[ "Curl.dns", get_namelookuptime h; "Curl.conn", get_connecttime h; (* "Curl.app", get_appconnecttime; *) "Curl.pre", get_pretransfertime h; "Curl.start", get_starttransfertime h; "Curl.total", get_totaltime h; ] module CurlCache = Cache.Reuse(struct type t = Curl.t let create = Curl.init let reset = Curl.reset end) let curl_default_setup h = Curl.set_nosignal h true; Curl.set_connecttimeout h 30; Curl.set_timeout h 60; Curl.set_followlocation h false; Curl.set_encoding h Curl.CURL_ENCODING_ANY; () type http_action_old = [ `GET | `POST_FORM of (string * string) list | `POST of (string * string) (* content-type and body *) | `PUT of (string * string) | `DELETE | `CUSTOM of (string * string * string) (* request, content-type and body *) ] type http_body = [ `Raw of string * string (* content-type and body *) | `Form of (string * string) list (* key value *) | `Chunked of (string * (unit -> string)) (* content-type and body readfunction *) ] type http_action = [ `GET | `POST | `PUT | `PATCH | `DELETE | `CUSTOM of string ] let string_of_http_action : http_action -> string = function | `GET -> "GET" | `POST -> "POST" | `PUT -> "PUT" | `PATCH -> "PATCH" | `DELETE -> "DELETE" | `CUSTOM s -> s let http_action_of_string : string -> http_action = function | "GET" -> `GET | "POST" -> `POST | "PUT" -> `PUT | "PATCH" -> `PATCH | "DELETE" -> `DELETE | s -> Exn.fail "http_action_of_string %S" s module type IO_TYPE = sig type 'a t val return : 'a -> 'a t val ( >>= ) : 'a t -> ('a -> 'b t) -> 'b t val bracket : 'a t -> ('a -> unit t) -> ('a -> 'b t) -> 'b t val sleep : Time.t -> unit t val fail : ?exn:exn -> ('a, unit, string, 'b t) format4 -> 'a val raise : exn -> 'a t val map_s : ('a -> 'b t) -> 'a list -> 'b list t val catch : (unit -> 'a t) -> (exn -> 'a t) -> 'a t end module type CURL = sig type 'a t val perform : Curl.t -> Curl.curlCode t end type ('body,'ret) http_request_ = ?ua:string -> ?timeout:int -> ?verbose:bool -> ?setup:(Curl.t -> unit) -> ?timer:Action.timer -> ?max_size:int -> ?http_1_0:bool -> ?headers:string list -> ?body:'body -> http_action -> string -> 'ret type 'ret http_request = ([ `Form of (string * string) list | `Raw of string * string ], 'ret) http_request_ module type HTTP = sig module IO : IO_TYPE val with_curl : (Curl.t -> 'a IO.t) -> 'a IO.t val with_curl_cache : (Curl.t -> 'a IO.t) -> 'a IO.t type ('body,'ret) request_ = ('body,'ret IO.t) http_request_ type 'ret request = 'ret IO.t http_request val http_request' : [> `Error of Curl.curlCode | `Ok of int * string ] request val http_request : [> `Error of string | `Ok of string ] request val http_request_exn : string request val http_query : (string * string, [> `Error of string | `Ok of string ]) request_ val http_submit : ?ua:string -> ?timeout:int -> ?verbose:bool -> ?setup:(Curl.t -> unit) -> ?timer:Action.timer -> ?http_1_0:bool -> ?headers:string list -> ?action:http_action -> string -> (string * string) list -> [> `Error of string | `Ok of string ] IO.t end let show_result ?(verbose=false) = function | `Error code -> sprintf "(%d) %s" (Curl.errno code) (Curl.strerror code) | `Ok (n, content) -> sprintf "http %d%s" n (if verbose then ": " ^ content else "") let simple_result ?(is_ok=(fun code -> code / 100 = 2)) ?verbose = function | `Ok (code, s) when is_ok code -> `Ok s | r -> `Error (show_result ?verbose r) let nr_http = ref 0 module Http (IO : IO_TYPE) (Curl_IO : CURL with type 'a t = 'a IO.t) : HTTP with type 'a IO.t = 'a IO.t = struct module IO = IO type ('body,'ret) request_ = ('body,'ret IO.t) http_request_ type 'ret request = 'ret IO.t http_request open IO let return_unit = return () let with_curl f = bracket (return @@ Curl.init ()) (fun h -> Curl.cleanup h; return_unit) f let with_curl_cache f = bracket (return @@ CurlCache.get ()) (fun h -> CurlCache.release h; return_unit) f let update_timer h timer = match timer with | None -> () | Some t -> let total = Curl.get_totaltime h in let now = Time.now () in t#record "Curl.start" (now -. total); curl_times h |> List.iter (fun (name,time) -> t#record name (now -. total +. time)); () (* deprecated *) let http_gets ?(setup=ignore) ?timer ?max_size ?(check=(fun _ -> true)) ?(result=(fun _ _ -> return_unit)) url = with_curl_cache begin fun h -> Curl.set_url h url; curl_default_setup h; let () = setup h in let b = Buffer.create 10 in let read_size = ref 0 in Curl.set_writefunction h begin fun s -> match check h with | false -> 0 | true -> Buffer.add_string b s; let l = String.length s in read_size += l; match max_size with | Some max_size when !read_size > max_size -> Exn.fail "received too much data (%db) when max is %db" !read_size max_size | _ -> l end; timer |> Option.may (fun t -> t#mark "Web.http"); catch (fun () -> Curl_IO.perform h) (fun exn -> update_timer h timer; IO.raise exn) >>= fun code -> (update_timer h timer; result h code) >>= fun () -> return @@ match code with | Curl.CURLE_OK -> `Ok (Curl.get_httpcode h, Buffer.contents b) | code -> `Error code end let verbose_curl_result nr_http action t h code = let open Curl in let b = Buffer.create 10 in bprintf b "%s #%d %s ⇓%s ⇑%s %s " (string_of_http_action action) nr_http (Time.compact_duration t#get) (Action.bytes_string_f @@ get_sizedownload h) (Action.bytes_string_f @@ get_sizeupload h) (get_primaryip h) ; begin match code with | CURLE_OK -> bprintf b "HTTP %d %s" (get_httpcode h) (get_effectiveurl h); begin match get_redirecturl h with | "" -> () | s -> bprintf b " -> %s" s end; begin match get_redirectcount h with | 0 -> () | n -> bprintf b " after %d redirects" n end | _ -> bprintf b "error (%d) %s (errno %d)" (errno code) (strerror code) (Curl.get_oserrno h) end; log #info_s (Buffer.contents b) (* Given a list of strings, check pre-existing entry starting with `~name`; and adds the concatenation of `~name` and `~value` if not. *) let add_if_absent ~name ~value strs = match strs with | Some strs when List.exists (StringLabels.starts_with ~prefix:(name^":")) strs -> strs | Some strs -> (String.concat ": " [name; value]) :: strs | None -> [String.concat ": " [name; value]] (* NOTE don't forget to set http_1_0=true when sending requests to a Httpev-based server *) (* Don't use curl_setheaders when using ?headers option *) let http_request' ?ua ?timeout ?(verbose=false) ?(setup=ignore) ?timer ?max_size ?(http_1_0=false) ?headers ?body (action:http_action) url = let open Curl in let action_name = string_of_http_action action in let headers = match Possibly_otel.Traceparent.get_ambient () with | None -> headers | Some value -> Some Possibly_otel.Traceparent.(add_if_absent ~name ~value headers) in let set_body_and_headers h ct body = set_httpheader h (("Content-Type: "^ct) :: Option.default [] headers); set_postfields h body; set_postfieldsize h (String.length body) in let setup h = begin match body with | Some (`Form args) -> set_body_and_headers h "application/x-www-form-urlencoded" (make_url_args args) | Some (`Raw (ct,body)) -> set_body_and_headers h ct body | Some (`Chunked (ct,f)) -> set_httpheader h (("Content-Type: " ^ ct) :: "Transfer-Encoding: chunked" :: Option.default [] headers); set_readfunction h f | None -> Option.may (set_httpheader h) headers; (* prevent reading from stdin with POST without body *) set_readfunction h (fun _ -> ""); (* prevent libcurl 7.66.0+ from sending Transfer-Encoding: chunked for POST without body. See https://github.com/curl/curl/pull/4138. *) set_postfieldsize h 0 end; begin match action with | `GET | `DELETE | `CUSTOM _ -> () | `POST | `PUT | `PATCH -> set_post h true end; set_customrequest h action_name; if http_1_0 then set_httpversion h HTTP_VERSION_1_0; Option.may (set_timeout h) timeout; Option.may (set_useragent h) ua; let () = setup h in () in let nr_http = incr nr_http; !nr_http in (* XXX atomic wrt ocaml threads *) if verbose then begin let body = match body with | None -> "" | Some (`Form args) -> String.concat " " @@ List.map (fun (k,v) -> sprintf "%s=\"%s\"" k (Stre.shorten ~escape:true 64 v)) args | Some (`Raw (ct,body)) -> sprintf "%s \"%s\"" ct (Stre.shorten ~escape:true 64 body) | Some (`Chunked (ct,_f)) -> sprintf "%s chunked" ct in log #info "%s #%d %s %s" action_name nr_http url body end; let describe () = [ "otrace.spankind", `String "CLIENT"; "http.request.method", `String action_name; "url.full", `String url; ] in let sid = Possibly_otel.enter_manual_span ~__FUNCTION__ ~__FILE__ ~__LINE__ ~data:describe action_name in let t = new Action.timer in let result = Some (fun h code -> if verbose then verbose_curl_result nr_http action t h code; Trace_core.add_data_to_manual_span sid ["http.response.status_code", `Int (Curl.get_httpcode h)]; Trace_core.exit_manual_span sid; return () ) in http_gets ~setup ?timer ?result ?max_size url let http_request ?ua ?timeout ?verbose ?setup ?timer ?max_size ?http_1_0 ?headers ?body (action:http_action) url = http_request' ?ua ?timeout ?verbose ?setup ?timer ?max_size ?http_1_0 ?headers ?body action url >>= fun res -> return @@ simple_result ?verbose res let http_request_exn ?ua ?timeout ?verbose ?setup ?timer ?max_size ?http_1_0 ?headers ?body (action:http_action) url = http_request ?ua ?timeout ?verbose ?setup ?timer ?max_size ?http_1_0 ?headers ?body action url >>= function `Ok s -> return s | `Error error -> fail "%s" error let http_query ?ua ?timeout ?verbose ?setup ?timer ?max_size ?http_1_0 ?headers ?body (action:http_action) url = let body = match body with Some (ct,s) -> Some (`Raw (ct,s)) | None -> None in http_request ?ua ?timeout ?verbose ?setup ?timer ?max_size ?http_1_0 ?headers ?body action url let http_submit ?ua ?timeout ?verbose ?setup ?timer ?http_1_0 ?headers ?(action=`POST) url args = http_request ?ua ?timeout ?verbose ?setup ?timer ?http_1_0 ?headers ~body:(`Form args) action url end module IO_blocking = struct type 'a t = 'a let return = identity let ( >>= ) m f = f m let bracket = bracket let fail = Exn.fail let raise = raise let sleep = Nix.sleep let map_s = List.map let catch = fun f e -> try f () with exn -> e exn end module IO_lwt = struct type 'a t = 'a Lwt.t let return = Lwt.return let ( >>= ) = Lwt.( >>= ) let bracket mresource destroy k = let%lwt resource = mresource in (k resource) [%finally destroy resource] let fail = Exn_lwt.fail let raise = Lwt.fail let sleep = Lwt_unix.sleep let map_s = Lwt_list.map_s let catch = Lwt.catch end module Curl_blocking = struct type 'a t = 'a let perform h = try Curl.perform h; Curl.CURLE_OK with Curl.CurlException (code,_,_) -> code end module Curl_lwt_for_http = struct type 'a t = 'a Lwt.t include Curl_lwt end module Http_blocking = Http(IO_blocking)(Curl_blocking) module Http_lwt = Http(IO_lwt)(Curl_lwt_for_http) let with_curl = Http_blocking.with_curl let with_curl_cache = Http_blocking.with_curl_cache let http_request' = Http_blocking.http_request' let http_request = Http_blocking.http_request let http_request_exn = Http_blocking.http_request_exn let http_query = Http_blocking.http_query let http_submit = Http_blocking.http_submit let http_request_lwt' = Http_lwt.http_request' let http_request_lwt = Http_lwt.http_request let http_request_lwt_exn = Http_lwt.http_request_exn let http_query_lwt = Http_lwt.http_query let http_submit_lwt = Http_lwt.http_submit (* http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html *) let string_of_http_code = function | 100 -> "Continue" | 101 -> "Switching protocols" | 200 -> "OK" | 201 -> "Created" | 202 -> "Accepted" | 203 -> "Non-Authoritative Information" | 204 -> "No Content" | 205 -> "Reset Content" | 206 -> "Partial Content" | 300 -> "Multiple Choices" | 301 -> "Moved Permanently" | 302 -> "Found" | 303 -> "See Other" | 304 -> "Not Modified" | 305 -> "Use Proxy" | 306 -> "(Unused)" | 307 -> "Temporary Redirect" | 400 -> "Bad Request" | 401 -> "Unauthorized" | 402 -> "Payment Required" | 403 -> "Forbidden" | 404 -> "Not Found" | 405 -> "Method Not Allowed" | 406 -> "Not Acceptable" | 407 -> "Proxy Authentication Required" | 408 -> "Request Timeout" | 409 -> "Conflict" | 410 -> "Gone" | 411 -> "Length Required" | 412 -> "Precondition Failed" | 413 -> "Request Entity Too Large" | 414 -> "Request-URI Too Long" | 415 -> "Unsupported Media Type" | 416 -> "Requested Range Not Satisfiable" | 417 -> "Expectation Failed" | 500 -> "Internal Server Error" | 501 -> "Not Implemented" | 502 -> "Bad Gateway" | 503 -> "Service Unavailable" | 504 -> "Gateway Timeout" | 505 -> "HTTP Version Not Supported" | _ -> "(Unknown)" let class_of_http_code code = match code / 100 with | 1 -> "Informational" | 2 -> "Successful" | 3 -> "Redirection" | 4 -> "Client Error" | 5 -> "Server Error" | n -> sprintf "%dxx" n
sectionYPositions = computeSectionYPositions($el), 10)"
x-init="setTimeout(() => sectionYPositions = computeSectionYPositions($el), 10)"
>