leptos_use/use_cookie.rs
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
#![allow(clippy::too_many_arguments)]
use crate::core::now;
use crate::utils::get_header;
use codee::{CodecError, Decoder, Encoder};
use cookie::time::{Duration, OffsetDateTime};
pub use cookie::SameSite;
use cookie::{Cookie, CookieJar};
use default_struct_builder::DefaultBuilder;
use leptos::*;
use std::rc::Rc;
/// SSR-friendly and reactive cookie access.
///
/// You can use this function multiple times for the same cookie and their signals will synchronize
/// (even across windows/tabs). But there is no way to listen to changes to `document.cookie` directly so in case
/// something outside of this function changes the cookie, the signal will **not** be updated.
///
/// When the options `max_age` or `expire` is given then the returned signal will
/// automatically turn to `None` after that time.
///
/// ## Demo
///
/// [Link to Demo](https://github.com/Synphonyte/leptos-use/tree/main/examples/use_cookie)
///
/// ## Usage
///
/// The example below creates a cookie called `counter`. If the cookie doesn't exist, it is initially set to a random value.
/// Whenever we update the `counter` variable, the cookie will be updated accordingly.
///
/// ```
/// # use leptos::*;
/// # use leptos_use::use_cookie;
/// # use codee::string::FromToStringCodec;
/// # use rand::prelude::*;
///
/// #
/// # #[component]
/// # fn Demo() -> impl IntoView {
/// let (counter, set_counter) = use_cookie::<u32, FromToStringCodec>("counter");
///
/// let reset = move || set_counter.set(Some(random()));
///
/// if counter.get().is_none() {
/// reset();
/// }
///
/// let increase = move || {
/// set_counter.set(counter.get().map(|c| c + 1));
/// };
///
/// view! {
/// <p>Counter: {move || counter.get().map(|c| c.to_string()).unwrap_or("—".to_string())}</p>
/// <button on:click=move |_| reset()>Reset</button>
/// <button on:click=move |_| increase()>+</button>
/// }
/// # }
/// ```
///
/// Values are (en)decoded via the given codec. You can use any of the string codecs or a
/// binary codec wrapped in `Base64`.
///
/// > Please check [the codec chapter](https://leptos-use.rs/codecs.html) to see what codecs are
/// > available and what feature flags they require.
///
/// ## Cookie attributes
///
/// As part of the options when you use `use_cookie_with_options` you can specify cookie attributes.
///
/// ```
/// # use cookie::SameSite;
/// # use leptos::*;
/// # use leptos_use::{use_cookie_with_options, UseCookieOptions};
/// # use codee::string::FromToStringCodec;
/// #
/// # #[component]
/// # fn Demo() -> impl IntoView {
/// let (cookie, set_cookie) = use_cookie_with_options::<bool, FromToStringCodec>(
/// "user_info",
/// UseCookieOptions::default()
/// .max_age(3600_000) // one hour
/// .same_site(SameSite::Lax)
/// );
/// #
/// # view! {}
/// # }
/// ```
///
/// ## Server-Side Rendering
///
/// This works equally well on the server or the client.
/// On the server this function reads the cookie from the HTTP request header and writes it back into
/// the HTTP response header according to options (if provided).
/// The returned `WriteSignal` may not affect the cookie headers on the server! It will try and write
/// the headers buy if this happens after the headers have already been streamed to the client then
/// this will have no effect.
///
/// > If you're using `axum` you have to enable the `"axum"` feature in your Cargo.toml.
/// > In case it's `actix-web` enable the feature `"actix"`, for `spin` enable `"spin"`.
///
/// ### Bring your own header
///
/// In case you're neither using Axum, Actix nor Spin, or the default implementation is not to your liking,
/// you can provide your own way of reading and writing the cookie header value.
///
/// ```
/// # use cookie::Cookie;
/// # use leptos::*;
/// # use serde::{Deserialize, Serialize};
/// # use leptos_use::{use_cookie_with_options, UseCookieOptions};
/// # use codee::string::JsonSerdeCodec;
/// #
/// # #[derive(Serialize, Deserialize, Clone, Debug, PartialEq)]
/// # pub struct Auth {
/// # pub username: String,
/// # pub token: String,
/// # }
/// #
/// # #[component]
/// # fn Demo() -> impl IntoView {
/// use_cookie_with_options::<Auth, JsonSerdeCodec>(
/// "auth",
/// UseCookieOptions::default()
/// .ssr_cookies_header_getter(|| {
/// #[cfg(feature = "ssr")]
/// {
/// Some("Somehow get the value of the cookie header as a string".to_owned())
/// }
/// })
/// .ssr_set_cookie(|cookie: &Cookie| {
/// #[cfg(feature = "ssr")]
/// {
/// // somehow insert the Set-Cookie header for this cookie
/// }
/// }),
/// );
/// # view! {}
/// # }
/// ```
pub fn use_cookie<T, C>(cookie_name: &str) -> (Signal<Option<T>>, WriteSignal<Option<T>>)
where
C: Encoder<T, Encoded = String> + Decoder<T, Encoded = str>,
T: Clone,
{
use_cookie_with_options::<T, C>(cookie_name, UseCookieOptions::default())
}
/// Version of [`use_cookie`] that takes [`UseCookieOptions`].
pub fn use_cookie_with_options<T, C>(
cookie_name: &str,
options: UseCookieOptions<T, <C as Encoder<T>>::Error, <C as Decoder<T>>::Error>,
) -> (Signal<Option<T>>, WriteSignal<Option<T>>)
where
C: Encoder<T, Encoded = String> + Decoder<T, Encoded = str>,
T: Clone,
{
let UseCookieOptions {
max_age,
expires,
http_only,
secure,
domain,
path,
same_site,
ssr_cookies_header_getter,
ssr_set_cookie,
default_value,
readonly,
on_error,
} = options;
let delay = if let Some(max_age) = max_age {
Some(max_age)
} else {
expires.map(|expires| expires * 1000 - now() as i64)
};
let has_expired = if let Some(delay) = delay {
delay <= 0
} else {
false
};
let (cookie, set_cookie) = create_signal(None::<T>);
let jar = store_value(CookieJar::new());
if !has_expired {
let ssr_cookies_header_getter = Rc::clone(&ssr_cookies_header_getter);
jar.update_value(|jar| {
if let Some(new_jar) = load_and_parse_cookie_jar(ssr_cookies_header_getter) {
*jar = new_jar;
set_cookie.set(
jar.get(cookie_name)
.and_then(|c| {
C::decode(c.value())
.map_err(|err| on_error(CodecError::Decode(err)))
.ok()
})
.or(default_value),
);
}
});
handle_expiration(delay, set_cookie);
} else {
logging::debug_warn!(
"not setting cookie '{}' because it has already expired",
cookie_name
);
}
#[cfg(not(feature = "ssr"))]
{
use crate::{
use_broadcast_channel, watch_pausable, UseBroadcastChannelReturn, WatchPausableReturn,
};
use codee::string::{FromToStringCodec, OptionCodec};
let UseBroadcastChannelReturn { message, post, .. } =
use_broadcast_channel::<Option<String>, OptionCodec<FromToStringCodec>>(&format!(
"leptos-use:cookies:{cookie_name}"
));
let on_cookie_change = {
let cookie_name = cookie_name.to_owned();
let ssr_cookies_header_getter = Rc::clone(&ssr_cookies_header_getter);
let on_error = Rc::clone(&on_error);
let domain = domain.clone();
let path = path.clone();
move || {
if readonly {
return;
}
let value = cookie.with_untracked(|cookie| {
cookie.as_ref().and_then(|cookie| {
C::encode(cookie)
.map_err(|err| on_error(CodecError::Encode(err)))
.ok()
})
});
if value
== jar.with_value(|jar| jar.get(&cookie_name).map(|c| c.value().to_owned()))
{
return;
}
jar.update_value(|jar| {
write_client_cookie(
&cookie_name,
&value,
jar,
max_age,
expires,
&domain,
&path,
same_site,
secure,
http_only,
Rc::clone(&ssr_cookies_header_getter),
);
});
post(&value);
}
};
let WatchPausableReturn {
pause,
resume,
stop,
..
} = watch_pausable(move || cookie.get(), {
let on_cookie_change = on_cookie_change.clone();
move |_, _, _| {
on_cookie_change();
}
});
// listen to cookie changes from the broadcast channel
create_effect({
let ssr_cookies_header_getter = Rc::clone(&ssr_cookies_header_getter);
let cookie_name = cookie_name.to_owned();
move |_| {
if let Some(message) = message.get() {
pause();
if let Some(message) = message {
match C::decode(&message) {
Ok(value) => {
let ssr_cookies_header_getter =
Rc::clone(&ssr_cookies_header_getter);
jar.update_value(|jar| {
update_client_cookie_jar(
&cookie_name,
&Some(message),
jar,
max_age,
expires,
&domain,
&path,
same_site,
secure,
http_only,
ssr_cookies_header_getter,
);
});
set_cookie.set(Some(value));
}
Err(err) => {
on_error(CodecError::Decode(err));
}
}
} else {
let cookie_name = cookie_name.clone();
let ssr_cookies_header_getter = Rc::clone(&ssr_cookies_header_getter);
jar.update_value(|jar| {
update_client_cookie_jar(
&cookie_name,
&None,
jar,
max_age,
expires,
&domain,
&path,
same_site,
secure,
http_only,
ssr_cookies_header_getter,
);
jar.force_remove(cookie_name);
});
set_cookie.set(None);
}
resume();
}
}
});
on_cleanup(move || {
stop();
on_cookie_change();
});
let _ = ssr_set_cookie;
}
#[cfg(feature = "ssr")]
{
if !readonly {
let cookie_name = cookie_name.to_owned();
create_isomorphic_effect(move |previous_effect_value| {
let value = cookie
.with(|cookie| {
cookie.as_ref().map(|cookie| {
C::encode(cookie)
.map_err(|err| on_error(CodecError::Encode(err)))
.ok()
})
})
.flatten();
if previous_effect_value.is_some() {
jar.update_value({
let domain = domain.clone();
let path = path.clone();
let ssr_set_cookie = Rc::clone(&ssr_set_cookie);
|jar| {
write_server_cookie(
&cookie_name,
value,
jar,
max_age,
expires,
domain,
path,
same_site,
secure,
http_only,
ssr_set_cookie,
)
}
});
}
Some(())
});
}
}
(cookie.into(), set_cookie)
}
/// Options for [`use_cookie_with_options`].
#[derive(DefaultBuilder)]
pub struct UseCookieOptions<T, E, D> {
/// [`Max-Age` of the cookie](https://tools.ietf.org/html/rfc6265#section-5.2.2) in milliseconds. The returned signal will turn to `None` after the max age is reached.
/// Default: `None`
///
/// > The [cookie storage model specification](https://tools.ietf.org/html/rfc6265#section-5.3) states
/// > that if both `expires` and `max_age` is set, then `max_age` takes precedence,
/// > but not all clients may obey this, so if both are set, they should point to the same date and time!
///
/// > If neither of `expires` and `max_age` is set, the cookie will be session-only and removed when the user closes their browser.
#[builder(into)]
max_age: Option<i64>,
/// [Expiration date-time of the cookie](https://tools.ietf.org/html/rfc6265#section-5.2.1) as UNIX timestamp in seconds.
/// The signal will turn to `None` after the expiration date-time is reached.
/// Default: `None`
///
/// > The [cookie storage model specification](https://tools.ietf.org/html/rfc6265#section-5.3) states
/// > that if both `expires` and `max_age` is set, then `max_age` takes precedence,
/// > but not all clients may obey this, so if both are set, they should point to the same date and time!
///
/// > If neither of `expires` and `max_age` is set, the cookie will be session-only and removed when the user closes their browser.
#[builder(into)]
expires: Option<i64>,
/// Specifies the [`HttpOnly` cookie attribute](https://tools.ietf.org/html/rfc6265#section-5.2.6).
/// When `true`, the `HttpOnly` attribute is set; otherwise it is not.
/// By default, the `HttpOnly` attribute is not set.
///
/// > Be careful when setting this to `true`, as compliant clients will not allow client-side JavaScript to see the cookie in `document.cookie`.
http_only: bool,
/// Specifies the value for the [`Secure` cookie attribute](https://tools.ietf.org/html/rfc6265#section-5.2.5).
/// When `true`, the `Secure` attribute is set; otherwise it is not.
/// By default, the `Secure` attribute is not set.
///
/// > Be careful when setting this to `true`, as compliant clients will not send the cookie back to the
/// > server in the future if the browser does not have an HTTPS connection. This can lead to hydration errors.
secure: bool,
/// Specifies the value for the [`Domain` cookie attribute](https://tools.ietf.org/html/rfc6265#section-5.2.3).
/// By default, no domain is set, and most clients will consider applying the cookie only to the current domain.
#[builder(into)]
domain: Option<String>,
/// Specifies the value for the [`Path` cookie attribute](https://tools.ietf.org/html/rfc6265#section-5.2.4).
/// By default, the path is considered the ["default path"](https://tools.ietf.org/html/rfc6265#section-5.1.4).
#[builder(into)]
path: Option<String>,
/// Specifies the value for the [`SameSite` cookie attribute](https://tools.ietf.org/html/draft-ietf-httpbis-rfc6265bis-03#section-4.1.2.7).
///
/// - `'Some(SameSite::Lax)'` will set the `SameSite` attribute to `Lax` for lax same-site enforcement.
/// - `'Some(SameSite::None)'` will set the `SameSite` attribute to `None` for an explicit cross-site cookie.
/// - `'Some(SameSite::Strict)'` will set the `SameSite` attribute to `Strict` for strict same-site enforcement.
/// - `None` will not set the `SameSite` attribute (default).
///
/// More information about the different enforcement levels can be found in [the specification](https://tools.ietf.org/html/draft-ietf-httpbis-rfc6265bis-03#section-4.1.2.7).
#[builder(into)]
same_site: Option<SameSite>,
/// The default cookie value in case the cookie is not set.
/// Defaults to `None`.
default_value: Option<T>,
/// If `true` the returned `WriteSignal` will not affect the actual cookie.
/// Default: `false`
readonly: bool,
/// Getter function to return the string value of the cookie header.
/// When you use one of the features `"axum"`, `"actix"` or `"spin"` there's a valid default implementation provided.
ssr_cookies_header_getter: Rc<dyn Fn() -> Option<String>>,
/// Function to add a set cookie header to the response on the server.
/// When you use one of the features `"axum"`, `"actix"` or `"spin"` there's a valid default implementation provided.
ssr_set_cookie: Rc<dyn Fn(&Cookie)>,
/// Callback for encoding/decoding errors. Defaults to logging the error to the console.
on_error: Rc<dyn Fn(CodecError<E, D>)>,
}
impl<T, E, D> Default for UseCookieOptions<T, E, D> {
#[allow(dead_code)]
fn default() -> Self {
Self {
max_age: None,
expires: None,
http_only: false,
default_value: None,
readonly: false,
secure: false,
domain: None,
path: None,
same_site: None,
ssr_cookies_header_getter: Rc::new(move || {
get_header!(COOKIE, use_cookie, ssr_cookies_header_getter)
}),
ssr_set_cookie: Rc::new(|cookie: &Cookie| {
#[cfg(feature = "ssr")]
{
#[cfg(feature = "actix")]
use leptos_actix::ResponseOptions;
#[cfg(feature = "axum")]
use leptos_axum::ResponseOptions;
#[cfg(feature = "spin")]
use leptos_spin::ResponseOptions;
#[cfg(feature = "actix")]
const SET_COOKIE: http0_2::HeaderName = http0_2::header::SET_COOKIE;
#[cfg(any(feature = "axum", feature = "spin"))]
const SET_COOKIE: http1::HeaderName = http1::header::SET_COOKIE;
#[cfg(feature = "actix")]
type HeaderValue = http0_2::HeaderValue;
#[cfg(any(feature = "axum", feature = "spin"))]
type HeaderValue = http1::HeaderValue;
#[cfg(all(
not(feature = "axum"),
not(feature = "actix"),
not(feature = "spin")
))]
{
let _ = cookie;
leptos::logging::warn!("If you're using use_cookie without the feature `axum`, `actix` or `spin` enabled, you should provide the option `ssr_set_cookie`");
}
#[cfg(any(feature = "axum", feature = "actix"))]
{
if let Some(response_options) = use_context::<ResponseOptions>() {
if let Ok(header_value) =
HeaderValue::from_str(&cookie.encoded().to_string())
{
response_options.append_header(SET_COOKIE, header_value);
}
}
}
#[cfg(feature = "spin")]
{
if let Some(response_options) = use_context::<ResponseOptions>() {
let header_value = cookie.encoded().to_string().as_bytes().to_vec();
response_options.append_header(SET_COOKIE.as_str(), &header_value);
}
}
}
let _ = cookie;
}),
on_error: Rc::new(|_| {
logging::error!("cookie (de-/)serialization error");
}),
}
}
}
fn read_cookies_string(
ssr_cookies_header_getter: Rc<dyn Fn() -> Option<String>>,
) -> Option<String> {
let cookies;
#[cfg(feature = "ssr")]
{
cookies = ssr_cookies_header_getter();
}
#[cfg(not(feature = "ssr"))]
{
use wasm_bindgen::JsCast;
let _ = ssr_cookies_header_getter;
let js_value: wasm_bindgen::JsValue = leptos::document().into();
let document: web_sys::HtmlDocument = js_value.unchecked_into();
cookies = Some(document.cookie().unwrap_or_default());
}
cookies
}
fn handle_expiration<T>(delay: Option<i64>, set_cookie: WriteSignal<Option<T>>) {
if let Some(delay) = delay {
#[cfg(not(feature = "ssr"))]
{
use leptos::leptos_dom::helpers::TimeoutHandle;
use std::cell::Cell;
use std::cell::RefCell;
// The maximum value allowed on a timeout delay.
// Reference: https://developer.mozilla.org/en-US/docs/Web/API/setTimeout#maximum_delay_value
const MAX_TIMEOUT_DELAY: i64 = 2_147_483_647;
let timeout = Rc::new(Cell::new(None::<TimeoutHandle>));
let elapsed = Rc::new(Cell::new(0));
on_cleanup({
let timeout = Rc::clone(&timeout);
move || {
if let Some(timeout) = timeout.take() {
timeout.clear();
}
}
});
let create_expiration_timeout = Rc::new(RefCell::new(None::<Box<dyn Fn()>>));
create_expiration_timeout.replace(Some(Box::new({
let timeout = Rc::clone(&timeout);
let elapsed = Rc::clone(&elapsed);
let create_expiration_timeout = Rc::clone(&create_expiration_timeout);
move || {
if let Some(timeout) = timeout.take() {
timeout.clear();
}
let time_remaining = delay - elapsed.get();
let timeout_length = time_remaining.min(MAX_TIMEOUT_DELAY);
let elapsed = Rc::clone(&elapsed);
let create_expiration_timeout = Rc::clone(&create_expiration_timeout);
timeout.set(
set_timeout_with_handle(
move || {
elapsed.set(elapsed.get() + timeout_length);
if elapsed.get() < delay {
if let Some(create_expiration_timeout) =
&*create_expiration_timeout.borrow()
{
create_expiration_timeout();
}
return;
}
set_cookie.set(None);
},
std::time::Duration::from_millis(timeout_length as u64),
)
.ok(),
);
}
})));
if let Some(create_expiration_timeout) = &*create_expiration_timeout.borrow() {
create_expiration_timeout();
};
}
#[cfg(feature = "ssr")]
{
let _ = set_cookie;
let _ = delay;
}
}
}
#[cfg(not(feature = "ssr"))]
fn write_client_cookie(
name: &str,
value: &Option<String>,
jar: &mut CookieJar,
max_age: Option<i64>,
expires: Option<i64>,
domain: &Option<String>,
path: &Option<String>,
same_site: Option<SameSite>,
secure: bool,
http_only: bool,
ssr_cookies_header_getter: Rc<dyn Fn() -> Option<String>>,
) {
use wasm_bindgen::JsCast;
update_client_cookie_jar(
name,
value,
jar,
max_age,
expires,
domain,
path,
same_site,
secure,
http_only,
ssr_cookies_header_getter,
);
let document = document();
let document: &web_sys::HtmlDocument = document.unchecked_ref();
document.set_cookie(&cookie_jar_to_string(jar, name)).ok();
}
#[cfg(not(feature = "ssr"))]
fn update_client_cookie_jar(
name: &str,
value: &Option<String>,
jar: &mut CookieJar,
max_age: Option<i64>,
expires: Option<i64>,
domain: &Option<String>,
path: &Option<String>,
same_site: Option<SameSite>,
secure: bool,
http_only: bool,
ssr_cookies_header_getter: Rc<dyn Fn() -> Option<String>>,
) {
if let Some(new_jar) = load_and_parse_cookie_jar(ssr_cookies_header_getter) {
*jar = new_jar;
if let Some(value) = value {
let cookie = build_cookie_from_options(
name, max_age, expires, http_only, secure, path, same_site, domain, value,
);
jar.add_original(cookie);
} else {
let max_age = Some(0);
let expires = Some(0);
let value = "";
let cookie = build_cookie_from_options(
name, max_age, expires, http_only, secure, path, same_site, domain, value,
);
jar.add(cookie);
}
}
}
#[cfg(not(feature = "ssr"))]
fn cookie_jar_to_string(jar: &CookieJar, name: &str) -> String {
match jar.get(name) {
Some(c) => c.encoded().to_string(),
None => "".to_string(),
}
}
fn build_cookie_from_options(
name: &str,
max_age: Option<i64>,
expires: Option<i64>,
http_only: bool,
secure: bool,
path: &Option<String>,
same_site: Option<SameSite>,
domain: &Option<String>,
value: &str,
) -> Cookie<'static> {
let mut cookie = Cookie::build((name, value));
if let Some(max_age) = max_age {
cookie = cookie.max_age(Duration::milliseconds(max_age));
}
if let Some(expires) = expires {
match OffsetDateTime::from_unix_timestamp(expires) {
Ok(expires) => {
cookie = cookie.expires(expires);
}
Err(err) => {
logging::debug_warn!("failed to set cookie expiration: {:?}", err);
}
}
}
if http_only {
cookie = cookie.http_only(true);
}
if secure {
cookie = cookie.secure(true);
}
if let Some(domain) = domain {
cookie = cookie.domain(domain);
}
if let Some(path) = path {
cookie = cookie.path(path);
}
if let Some(same_site) = same_site {
cookie = cookie.same_site(same_site);
}
let cookie: Cookie = cookie.into();
cookie.into_owned()
}
#[cfg(feature = "ssr")]
fn write_server_cookie(
name: &str,
value: Option<String>,
jar: &mut CookieJar,
max_age: Option<i64>,
expires: Option<i64>,
domain: Option<String>,
path: Option<String>,
same_site: Option<SameSite>,
secure: bool,
http_only: bool,
ssr_set_cookie: Rc<dyn Fn(&Cookie)>,
) {
if let Some(value) = value {
let cookie: Cookie = build_cookie_from_options(
name, max_age, expires, http_only, secure, &path, same_site, &domain, &value,
);
jar.add(cookie.into_owned());
} else {
jar.remove(name.to_owned());
}
for cookie in jar.delta() {
ssr_set_cookie(cookie);
}
}
fn load_and_parse_cookie_jar(
ssr_cookies_header_getter: Rc<dyn Fn() -> Option<String>>,
) -> Option<CookieJar> {
read_cookies_string(ssr_cookies_header_getter).map(|cookies| {
let mut jar = CookieJar::new();
for cookie in Cookie::split_parse_encoded(cookies).flatten() {
jar.add_original(cookie);
}
jar
})
}