| Title: | Your Friendly Solution to Managing Browser Cookies |
|---|---|
| Description: | A convenient tool to store and format browser cookies and use them in 'HTTP' requests (for example, through 'httr2', 'httr' or 'curl'). |
| Authors: | Johannes B. Gruber [aut, cre] |
| Maintainer: | Johannes B. Gruber <[email protected]> |
| License: | GPL (>= 3) |
| Version: | 0.0.3 |
| Built: | 2025-04-03 05:05:12 UTC |
| Source: | https://github.com/jbgruber/cookiemonster |
This function allows you to add browser cookies to the cookie storage. It can work with either a cookie file or a direct cookie string (e.g., copied from a CURL call). But remember, just like in real life, you can't have your cookie and eat it too - pick only one!
add_cookies(cookiefile, cookiestring, session, domain = NULL, confirm = FALSE)add_cookies(cookiefile, cookiestring, session, domain = NULL, confirm = FALSE)
cookiefile |
A character string indicating the path to the cookie file. |
cookiestring |
A character string representing the cookie in string format. |
session |
A live html session created with read_html_live (only version >= 1.0.4). |
domain |
An optional parameter that specifies the host/domain. It's only
used when |
confirm |
If |
No explicit return. Instead, this function stores the cookies using
the store_cookies function.
You can't provide both a cookiefile and a cookiestring at the same time. That's like trying to dunk two cookies in a tiny cup of milk!
Your cookies are saved in an encrypted file. See encrypt_vec for more info.
# to conform with CRAN policies, examples use a temporary location. Do not use # the options like this, except you want your cookies gone when closing R. options(cookie_dir = tempdir()) # Using a cookie file: # to conform with CRAN policies, examples use a temporary location. Do not use # the options like this, except you want your cookies gone when closing R. add_cookies(cookiefile = system.file("extdata", "cookies.txt", package = "cookiemonster")) # Using a cookie string: add_cookies(cookiestring = "username=johndoe; password=secret", domain = "www.example.com")# to conform with CRAN policies, examples use a temporary location. Do not use # the options like this, except you want your cookies gone when closing R. options(cookie_dir = tempdir()) # Using a cookie file: # to conform with CRAN policies, examples use a temporary location. Do not use # the options like this, except you want your cookies gone when closing R. add_cookies(cookiefile = system.file("extdata", "cookies.txt", package = "cookiemonster")) # Using a cookie string: add_cookies(cookiestring = "username=johndoe; password=secret", domain = "www.example.com")
This function returns the default directory (jar) for storing cookies. Users
can set their own cookie storage location by using options(cookie_dir =
"your/directory/here"). If no custom directory is specified, the default
directory used by the rappdirs package will be returned.
default_jar()default_jar()
A string representing the path to the default cookie storage directory (jar).
# Get the default jar default_jar() # Set a custom cookie storage directory options(cookie_dir = "/path/to/your/cookie/directory") # Get the custom cookie directory default_jar() # revert to the package default options(cookie_dir = rappdirs::user_cache_dir("r_cookies"))# Get the default jar default_jar() # Set a custom cookie storage directory options(cookie_dir = "/path/to/your/cookie/directory") # Get the custom cookie directory default_jar() # revert to the package default options(cookie_dir = rappdirs::user_cache_dir("r_cookies"))
Delete Cookies
delete_cookies( domain, key = "", jar = default_jar(), fixed = FALSE, ask = TRUE )delete_cookies( domain, key = "", jar = default_jar(), fixed = FALSE, ask = TRUE )
domain |
The domain for which the cookies should be deleted. |
key |
An optional filter to retrieve only certain cookies by matching
certain keys/names. Accepts regular expression depending on the value of
|
jar |
A character string of the path to the cookie jar (the default is
to use |
fixed |
If |
ask |
A logical value indicating whether the user should be asked to confirm the deletion. |
Nothing. Called to remove cookies from jar.
# to conform with CRAN policies, examples use a temporary location. Do not use # the options like this, except you want your cookies gone when closing R. options(cookie_dir = tempdir()) add_cookies(cookiefile = system.file("extdata", "cookies.txt", package = "cookiemonster")) delete_cookies("example.com", ask = FALSE)# to conform with CRAN policies, examples use a temporary location. Do not use # the options like this, except you want your cookies gone when closing R. options(cookie_dir = tempdir()) add_cookies(cookiefile = system.file("extdata", "cookies.txt", package = "cookiemonster")) delete_cookies("example.com", ask = FALSE)
Used internally to encrypt/decrypt the value column of your cookie jar.
encrypt_vec(vec) decrypt_vec(vec)encrypt_vec(vec) decrypt_vec(vec)
vec |
A vector of values to encrypt |
If you save valuable cookies, for example login information, you
should encrypt them with a personalised password. This can be set with,
e.g., Sys.setenv("COOKIE_KEY" = "megageheim") or in an
.Renviron file.
list of encrypted elements (for encrypt_vec); vector of
decrypted elements (for encrypt_vec).
enc <- encrypt_vec(c("foo", "bar")) decrypt_vec(enc)enc <- encrypt_vec(c("foo", "bar")) decrypt_vec(enc)
Imagine you're reaching into a magical jar overflowing with those scrumptious digital delights from websites you've visited. The flavour? Up to you! Just select your desired output format.
get_cookies( domain, key = "", jar = default_jar(), as = c("data.frame", "string", "vector"), fixed = FALSE )get_cookies( domain, key = "", jar = default_jar(), as = c("data.frame", "string", "vector"), fixed = FALSE )
domain |
A character string of the domain to retrieve cookies for.
Accepts regular expression depending on the value of |
key |
An optional filter to retrieve only certain cookies by matching
certain keys/names. Accepts regular expression depending on the value of
|
jar |
A character string of the path to the cookie jar (the default is
to use |
as |
A character string of the type of output to return. |
fixed |
If |
The function returns cookies in one of three formats:
data.frame: is how cookies are stored internally and can be used for manual inspection.
string: is used by curl and httr2.
vector: is used by httr.
See vignette("cookies", "cookiemonster") for how to use cookies with
these packages.
Depending on the value of as, returns either a data frame, a
character string, or a named vector.
Your cookies are saved in an encrypted file. See encrypt_vec for more info.
# to conform with CRAN policies, examples use a temporary location. Do not use the options like this options(cookie_dir = tempdir()) # put some cookies in the jar add_cookies(cookiestring = "chococookie=delicious", domain = "example.com") # Reach into your cookie jar and enjoy! get_cookies("example.com") # put different cookies into the jar (overwrites previous) add_cookies(cookiestring = "oatmeal=delicious; peanutbutter=delicious", domain = "example.com") add_cookies(cookiestring = "snickerdoodle=delicious", domain = "another.example.com") # only get cookies for example.com, not another.example.com get_cookies("^example.com") # only get some cookies from example.com get_cookies(domain = "^example.com", key = "peanut")# to conform with CRAN policies, examples use a temporary location. Do not use the options like this options(cookie_dir = tempdir()) # put some cookies in the jar add_cookies(cookiestring = "chococookie=delicious", domain = "example.com") # Reach into your cookie jar and enjoy! get_cookies("example.com") # put different cookies into the jar (overwrites previous) add_cookies(cookiestring = "oatmeal=delicious; peanutbutter=delicious", domain = "example.com") add_cookies(cookiestring = "snickerdoodle=delicious", domain = "another.example.com") # only get cookies for example.com, not another.example.com get_cookies("^example.com") # only get some cookies from example.com get_cookies(domain = "^example.com", key = "peanut")
Retrieves all cookies from a Browser (currently works with Firefox only).
get_cookies_from_browser(browser = "Firefox")get_cookies_from_browser(browser = "Firefox")
browser |
A character string specifying the browser to get cookies from. Defaults to "Firefox". |
A tibble containing the cookies from the specified browser.
## Not run: get_cookies_from_browser("Firefox") ## End(Not run)## Not run: get_cookies_from_browser("Firefox") ## End(Not run)
Store cookies in a jar
store_cookies(cookies, jar = default_jar(), confirm = FALSE)store_cookies(cookies, jar = default_jar(), confirm = FALSE)
cookies |
A data frame of cookies |
jar |
The directory to store the cookies in. Defaults to
|
confirm |
If |
No return value, called to save (encrypted) cookies on disk.
# to conform with CRAN policies, examples use a temporary location. Do not use # the options like this, except you want your cookies gone when closing R. options(cookie_dir = tempdir()) if (requireNamespace("curl", quietly = TRUE)) { # get cookies from a curl request library(curl) h <- new_handle() resp <- curl_fetch_memory("https://hb.cran.dev/cookies/set?new_cookies=moo", handle = h) cookies <- handle_cookies(h) # then store them for future use store_cookies(cookies) # then you can retrieve them and use in future calls get_cookies("hb.cran.dev") }# to conform with CRAN policies, examples use a temporary location. Do not use # the options like this, except you want your cookies gone when closing R. options(cookie_dir = tempdir()) if (requireNamespace("curl", quietly = TRUE)) { # get cookies from a curl request library(curl) h <- new_handle() resp <- curl_fetch_memory("https://hb.cran.dev/cookies/set?new_cookies=moo", handle = h) cookies <- handle_cookies(h) # then store them for future use store_cookies(cookies) # then you can retrieve them and use in future calls get_cookies("hb.cran.dev") }