File: headers.R

package info (click to toggle)
r-cran-httr2 1.2.2-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 1,684 kB
  • sloc: sh: 13; makefile: 2
file content (143 lines) | stat: -rw-r--r-- 3,542 bytes parent folder | download
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
as_headers <- function(
  x,
  redact = character(),
  lifespan,
  error_call = caller_env()
) {
  if (is.list(x)) {
    new_headers(
      x,
      redact = redact,
      lifespan = lifespan,
      error_call = error_call
    )
  } else if (is.character(x) || is.raw(x)) {
    parsed <- curl::parse_headers(x)
    valid <- parsed[grepl(":", parsed, fixed = TRUE)]
    halves <- parse_in_half(valid, ":")

    headers <- set_names(trimws(halves$right), halves$left)
    new_headers(
      as.list(headers),
      redact = redact,
      lifespan = lifespan,
      error_call = error_call
    )
  } else {
    cli::cli_abort(
      "{.arg headers} must be a list, character vector, or raw.",
      call = error_call
    )
  }
}

new_headers <- function(
  x,
  redact = character(),
  lifespan,
  error_call = caller_env()
) {
  if (!is_list(x)) {
    cli::cli_abort("{.arg x} must be a list.", call = error_call)
  }
  if (length(x) > 0 && !is_named(x)) {
    cli::cli_abort("All elements of {.arg x} must be named.", call = error_call)
  }
  for (i in seq_along(x)) {
    if (!is.atomic(x[[i]]) && !is_weakref(x[[i]])) {
      cli::cli_abort(
        c(
          "Each element of {.arg x} must be an atomic vector or a weakref.",
          i = "{.arg x[[{i}]]} is {obj_type_friendly(x[[i]])}."
        ),
        call = error_call
      )
    }
  }

  needs_redact <- !is_redacted(x) & (tolower(names(x)) %in% tolower(redact))
  x[needs_redact] <- lapply(x[needs_redact], \(x) new_weakref(lifespan, x))

  structure(x, class = "httr2_headers")
}

#' @export
print.httr2_headers <- function(x, ..., redact = TRUE) {
  cli::cat_line(cli::format_inline("{.cls {class(x)}}"))
  show_headers(x, redact = redact)
  invisible(x)
}

show_headers <- function(x, redact = TRUE) {
  if (length(x) > 0) {
    vals <- lapply(headers_flatten(x, redact), format)
    cli::cat_line(cli::style_bold(names(x)), ": ", vals)
  }
}

#' @export
str.httr2_headers <- function(object, ..., no.list = FALSE) {
  object <- unclass(headers_flatten(object))
  cat(" <httr2_headers>\n")
  utils::str(object, ..., no.list = TRUE)
}

#' @export
`[.httr2_headers` <- function(x, i, ...) {
  if (is.character(i)) {
    i <- match(tolower(i), tolower(names(x)))
  }

  new_headers(NextMethod())
}

#' @export
`[[.httr2_headers` <- function(x, i) {
  if (is.character(i)) {
    i <- match(tolower(i), tolower(names(x)))
  }
  NextMethod()
}

#' @export
"$.httr2_headers" <- function(x, name) {
  i <- match(tolower(name), tolower(names(x)))
  x[[i]]
}

is_redacted <- function(x) {
  map_lgl(x, is_weakref)
}
is_redacted_empty <- function(x) {
  map_lgl(x, \(x) is_weakref(x) && is.null(wref_value(x)))
}

which_redacted <- function(x) {
  names(x)[is_redacted(x)]
}

# Flatten headers object into a list suitable either for display (if redacted)
# or passing to curl (if not redacted).
headers_flatten <- function(x, redact = TRUE) {
  is_redacted <- is_redacted(x)

  out <- vector("list", length(x))
  names(out) <- names(x)

  # https://datatracker.ietf.org/doc/html/rfc7230#section-3.2.2
  out[!is_redacted] <- lapply(x[!is_redacted], paste, collapse = ",")

  if (redact) {
    out[is_redacted] <- list(redacted_sentinel())
  } else {
    out[is_redacted] <- lapply(x[is_redacted], wref_value)
    # also need to ensure redacted values are simple strings
    out[is_redacted] <- lapply(out[is_redacted], function(x) {
      if (!is.null(x)) paste(x, collapse = ",")
    })
    # need to strip serialized weakrefs that now yield NULL
    out <- compact(out)
  }

  out
}