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
use crate::{
    create_location, matching::resolve_path, resolve_redirect_url,
    scroll_to_el, use_location, use_navigate, Branch, History, Location,
    LocationChange, RouteContext, RouterIntegrationContext, State,
};
#[cfg(not(feature = "ssr"))]
use crate::{unescape, Url};
use cfg_if::cfg_if;
use leptos::{
    server_fn::{
        error::{ServerFnErrorSerde, ServerFnUrlError},
        redirect::RedirectHook,
    },
    *,
};
#[cfg(feature = "transition")]
use leptos_reactive::use_transition;
use send_wrapper::SendWrapper;
use std::{cell::RefCell, rc::Rc};
use thiserror::Error;
#[cfg(not(feature = "ssr"))]
use wasm_bindgen::JsCast;
use wasm_bindgen::UnwrapThrowExt;

/// Provides for client-side and server-side routing. This should usually be somewhere near
/// the root of the application.
#[component]
pub fn Router(
    /// The base URL for the router. Defaults to `""`.
    #[prop(optional)]
    base: Option<&'static str>,
    /// A fallback that should be shown if no route is matched.
    #[prop(optional)]
    fallback: Option<fn() -> View>,
    /// A signal that will be set while the navigation process is underway.
    #[prop(optional, into)]
    set_is_routing: Option<SignalSetter<bool>>,
    /// How trailing slashes should be handled in [`Route`] paths.
    #[prop(optional)]
    trailing_slash: TrailingSlash,
    /// The `<Router/>` should usually wrap your whole page. It can contain
    /// any elements, and should include a [`Routes`](crate::Routes) component somewhere
    /// to define and display [`Route`](crate::Route)s.
    children: Children,
    /// A unique identifier for this router, allowing you to mount multiple Leptos apps with
    /// different routes from the same server.
    #[prop(optional)]
    id: usize,
) -> impl IntoView {
    // create a new RouterContext and provide it to every component beneath the router
    let router = RouterContext::new(id, base, fallback, trailing_slash);
    provide_context(router);
    provide_context(GlobalSuspenseContext::new());
    if let Some(set_is_routing) = set_is_routing {
        provide_context(SetIsRouting(set_is_routing));
    }

    // set server function redirect hook
    let navigate = use_navigate();
    let navigate = SendWrapper::new(navigate);
    let router_hook = Box::new(move |loc: &str| {
        let Some(url) = resolve_redirect_url(loc) else {
            return; // resolve_redirect_url() already logs an error
        };
        let current_origin =
            leptos_dom::helpers::location().origin().unwrap_throw();
        if url.origin() == current_origin {
            let navigate = navigate.clone();
            // delay by a tick here, so that the Action updates *before* the redirect
            request_animation_frame(move || {
                navigate(&url.href(), Default::default());
            });
            // Use set_href() if the conditions for client-side navigation were not satisfied
        } else if let Err(e) =
            leptos_dom::helpers::location().set_href(&url.href())
        {
            leptos::logging::error!("Failed to redirect: {e:#?}");
        }
    }) as RedirectHook;
    _ = server_fn::redirect::set_redirect_hook(router_hook);

    // provide ServerFnUrlError if it exists
    let location = use_location();
    if let (Some(path), Some(err)) = location
        .query
        .with_untracked(|q| (q.get("__path").cloned(), q.get("__err").cloned()))
    {
        let err: ServerFnError = ServerFnErrorSerde::de(&err);
        provide_context(Rc::new(ServerFnUrlError::new(path, err)))
    }

    children()
}

#[derive(Copy, Clone, Debug, PartialEq, Eq)]
pub(crate) struct SetIsRouting(pub SignalSetter<bool>);

/// Context type that contains information about the current router state.
#[derive(Debug, Clone)]
pub struct RouterContext {
    pub(crate) inner: Rc<RouterContextInner>,
}
pub(crate) struct RouterContextInner {
    id: usize,
    pub location: Location,
    pub base: RouteContext,
    trailing_slash: TrailingSlash,
    pub possible_routes: RefCell<Option<Vec<Branch>>>,
    #[allow(unused)] // used in CSR/hydrate
    base_path: String,
    history: Box<dyn History>,
    reference: ReadSignal<String>,
    set_reference: WriteSignal<String>,
    referrers: Rc<RefCell<Vec<LocationChange>>>,
    state: ReadSignal<State>,
    set_state: WriteSignal<State>,
    pub(crate) is_back: RwSignal<bool>,
    pub(crate) path_stack: StoredValue<Vec<String>>,
}

impl core::fmt::Debug for RouterContextInner {
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        f.debug_struct("RouterContextInner")
            .field("location", &self.location)
            .field("base", &self.base)
            .field("reference", &self.reference)
            .field("set_reference", &self.set_reference)
            .field("referrers", &self.referrers)
            .field("state", &self.state)
            .field("set_state", &self.set_state)
            .field("path_stack", &self.path_stack)
            .finish()
    }
}

impl RouterContext {
    #[cfg_attr(
        any(debug_assertions, feature = "ssr"),
        tracing::instrument(level = "trace", skip_all,)
    )]
    pub(crate) fn new(
        id: usize,
        base: Option<&'static str>,
        fallback: Option<fn() -> View>,
        trailing_slash: TrailingSlash,
    ) -> Self {
        cfg_if! {
            if #[cfg(any(feature = "csr", feature = "hydrate"))] {
                let history = use_context::<RouterIntegrationContext>()
                    .unwrap_or_else(|| RouterIntegrationContext(Rc::new(crate::BrowserIntegration {})));
            } else {
                let history = use_context::<RouterIntegrationContext>().unwrap_or_else(|| {
                    let msg = "No router integration found.\n\nIf you are using this in the browser, \
                        you should enable `features = [\"csr\"]` or `features = [\"hydrate\"] in your \
                        `leptos_router` import.\n\nIf you are using this on the server without a \
                        Leptos server integration, you must call provide_context::<RouterIntegrationContext>(...) \
                        somewhere above the <Router/>.";
                    leptos::logging::debug_warn!("{}", msg);
                    panic!("{}", msg);
                });
            }
        };

        // Any `History` type gives a way to get a reactive signal of the current location
        // in the browser context, this is drawn from the `popstate` event
        // different server adapters can provide different `History` implementations to allow server routing
        let source = history.location();

        // if initial route is empty, redirect to base path, if it exists
        let base = base.unwrap_or_default();
        let base_path = resolve_path("", base, None);

        if let Some(base_path) = &base_path {
            if source.with_untracked(|s| s.value.is_empty()) {
                history.navigate(&LocationChange {
                    value: base_path.to_string(),
                    replace: true,
                    scroll: false,
                    state: State(None),
                });
            }
        }

        // the current URL
        let (reference, set_reference) =
            create_signal(source.with_untracked(|s| s.value.clone()));

        // the current History.state
        let (state, set_state) =
            create_signal(source.with_untracked(|s| s.state.clone()));

        // we'll use this transition to wait for async resources to load when navigating to a new route
        #[cfg(feature = "transition")]
        let transition = use_transition();

        // Each field of `location` reactively represents a different part of the current location
        let location = create_location(reference, state);
        let referrers: Rc<RefCell<Vec<LocationChange>>> =
            Rc::new(RefCell::new(Vec::new()));

        // Create base route with fallback element
        let base_path = base_path.unwrap_or_default();
        let base = RouteContext::base(&base_path, fallback);

        // Every time the History gives us a new location,
        // 1) start a transition
        // 2) update the reference (URL)
        // 3) update the state
        // this will trigger the new route match below

        create_render_effect(move |_| {
            let LocationChange { value, state, .. } = source.get();
            untrack(move || {
                if value != reference.get() {
                    set_reference.update(move |r| *r = value);
                    set_state.update(move |s| *s = state);
                }
            });
        });

        let inner = Rc::new(RouterContextInner {
            id,
            base_path: base_path.into_owned(),
            path_stack: store_value(vec![location.pathname.get_untracked()]),
            location,
            base,
            trailing_slash,
            history: Box::new(history),

            reference,
            set_reference,
            referrers,
            state,
            set_state,
            possible_routes: Default::default(),
            is_back: create_rw_signal(false),
        });

        // handle all click events on anchor tags
        #[cfg(not(feature = "ssr"))]
        {
            let click_event = leptos::window_event_listener_untyped("click", {
                let inner = Rc::clone(&inner);
                move |ev| inner.clone().handle_anchor_click(ev)
            });
            on_cleanup(move || click_event.remove());
        }

        Self { inner }
    }

    /// The current [`pathname`](https://developer.mozilla.org/en-US/docs/Web/API/Location/pathname).
    pub fn pathname(&self) -> Memo<String> {
        self.inner.location.pathname
    }

    /// The [`RouteContext`] of the base route.
    pub fn base(&self) -> RouteContext {
        self.inner.base.clone()
    }

    pub(crate) fn id(&self) -> usize {
        self.inner.id
    }

    pub(crate) fn trailing_slash(&self) -> TrailingSlash {
        self.inner.trailing_slash.clone()
    }

    /// A list of all possible routes this router can match.
    pub fn possible_branches(&self) -> Vec<Branch> {
        self.inner
            .possible_routes
            .borrow()
            .clone()
            .unwrap_or_default()
    }
}

impl RouterContextInner {
    #[cfg_attr(
        any(debug_assertions, feature = "ssr"),
        tracing::instrument(level = "trace", skip_all,)
    )]
    pub(crate) fn navigate_from_route(
        self: Rc<Self>,
        to: &str,
        options: &NavigateOptions,
    ) -> Result<(), NavigationError> {
        let this = Rc::clone(&self);

        untrack(move || {
            let resolved_to = if options.resolve {
                this.base.resolve_path(to)
            } else {
                resolve_path("", to, None).map(String::from)
            };

            // reset count of pending resources at global level
            if let Some(global) = use_context::<GlobalSuspenseContext>() {
                global.reset();
            }

            match resolved_to {
                None => Err(NavigationError::NotRoutable(to.to_string())),
                Some(resolved_to) => {
                    if self.referrers.borrow().len() > 32 {
                        return Err(NavigationError::MaxRedirects);
                    }

                    if resolved_to != this.reference.get()
                        || options.state != (this.state).get()
                    {
                        {
                            self.referrers.borrow_mut().push(LocationChange {
                                value: self.reference.get(),
                                replace: options.replace,
                                scroll: options.scroll,
                                state: self.state.get(),
                            });
                        }
                        let len = self.referrers.borrow().len();

                        let set_reference = self.set_reference;
                        let set_state = self.set_state;
                        let referrers = self.referrers.clone();
                        let this = Rc::clone(&self);

                        let resolved = resolved_to.to_string();
                        let state = options.state.clone();
                        set_reference.update(move |r| *r = resolved);

                        set_state.update({
                            let next_state = state.clone();
                            move |state| *state = next_state
                        });

                        let global_suspense =
                            use_context::<GlobalSuspenseContext>();
                        let path_stack = self.path_stack;
                        let is_navigating_back = self.is_back.get_untracked();
                        if !is_navigating_back {
                            path_stack.update_value(|stack| {
                                stack.push(resolved_to.clone())
                            });
                        }

                        let set_is_routing = use_context::<SetIsRouting>();
                        if let Some(set_is_routing) = set_is_routing {
                            set_is_routing.0.set(true);
                        }
                        spawn_local(async move {
                            if let Some(set_is_routing) = set_is_routing {
                                if let Some(global) = global_suspense {
                                    global.with_inner(|s| s.to_future()).await;
                                }
                                set_is_routing.0.set(false);
                            }

                            if referrers.borrow().len() == len {
                                this.navigate_end(LocationChange {
                                    value: resolved_to,
                                    replace: false,
                                    scroll: true,
                                    state,
                                });
                            }
                        });
                    } else {
                        scroll_to_el(false);
                    }

                    Ok(())
                }
            }
        })
    }

    pub(crate) fn navigate_end(self: Rc<Self>, mut next: LocationChange) {
        let first = self.referrers.borrow().first().cloned();
        if let Some(first) = first {
            if next.value != first.value || next.state != first.state {
                next.replace = first.replace;
                next.scroll = first.scroll;
                self.history.navigate(&next);
            }
            self.referrers.borrow_mut().clear();
        }
    }

    #[cfg(not(feature = "ssr"))]
    pub(crate) fn handle_anchor_click(self: Rc<Self>, ev: web_sys::Event) {
        use wasm_bindgen::JsValue;

        let ev = ev.unchecked_into::<web_sys::MouseEvent>();
        if ev.default_prevented()
            || ev.button() != 0
            || ev.meta_key()
            || ev.alt_key()
            || ev.ctrl_key()
            || ev.shift_key()
        {
            return;
        }

        let composed_path = ev.composed_path();
        let mut a: Option<web_sys::HtmlAnchorElement> = None;
        for i in 0..composed_path.length() {
            if let Ok(el) = composed_path
                .get(i)
                .dyn_into::<web_sys::HtmlAnchorElement>()
            {
                a = Some(el);
            }
        }
        if let Some(a) = a {
            let href = a.href();
            let target = a.target();

            // let browser handle this event if link has target,
            // or if it doesn't have href or state
            // TODO "state" is set as a prop, not an attribute
            if !target.is_empty()
                || (href.is_empty() && !a.has_attribute("state"))
            {
                return;
            }

            let rel = a.get_attribute("rel").unwrap_or_default();
            let mut rel = rel.split([' ', '\t']);

            // let browser handle event if it has rel=external or download
            if a.has_attribute("download") || rel.any(|p| p == "external") {
                return;
            }

            let url = Url::try_from(href.as_str()).unwrap();
            let path_name = unescape(&url.pathname);

            // let browser handle this event if it leaves our domain
            // or our base path
            if url.origin
                != leptos_dom::helpers::location().origin().unwrap_or_default()
                || (!self.base_path.is_empty()
                    && !path_name.is_empty()
                    && !path_name
                        .to_lowercase()
                        .starts_with(&self.base_path.to_lowercase()))
            {
                return;
            }

            let to = path_name
                + if url.search.is_empty() { "" } else { "?" }
                + &unescape(&url.search)
                + &unescape(&url.hash);
            let state =
                leptos_dom::helpers::get_property(a.unchecked_ref(), "state")
                    .ok()
                    .and_then(|value| {
                        if value == JsValue::UNDEFINED {
                            None
                        } else {
                            Some(value)
                        }
                    });

            ev.prevent_default();

            let replace =
                leptos_dom::helpers::get_property(a.unchecked_ref(), "replace")
                    .ok()
                    .and_then(|value| value.as_bool())
                    .unwrap_or(false);
            if let Err(e) = self.navigate_from_route(
                &to,
                &NavigateOptions {
                    resolve: false,
                    replace,
                    scroll: !a.has_attribute("noscroll"),
                    state: State(state),
                },
            ) {
                leptos::logging::error!("{e:#?}");
            }
        }
    }
}

/// An error that occurs during navigation.
#[derive(Debug, Error)]
pub enum NavigationError {
    /// The given path is not routable.
    #[error("Path {0:?} is not routable")]
    NotRoutable(String),
    /// Too many redirects occurred during routing (prevents and infinite loop.)
    #[error("Too many redirects")]
    MaxRedirects,
}

/// Options that can be used to configure a navigation. Used with [use_navigate](crate::use_navigate).
#[derive(Clone, Debug)]
pub struct NavigateOptions {
    /// Whether the URL being navigated to should be resolved relative to the current route.
    pub resolve: bool,
    /// If `true` the new location will replace the current route in the history stack, meaning
    /// the "back" button will skip over the current route. (Defaults to `false`).
    pub replace: bool,
    /// If `true`, the router will scroll to the top of the window at the end of navigation.
    /// Defaults to `true`.
    pub scroll: bool,
    /// [State](https://developer.mozilla.org/en-US/docs/Web/API/History/state) that should be pushed
    /// onto the history stack during navigation.
    pub state: State,
}

impl Default for NavigateOptions {
    fn default() -> Self {
        Self {
            resolve: true,
            replace: false,
            scroll: true,
            state: State(None),
        }
    }
}

/// Declares how you would like to handle trailing slashes in Route paths. This
/// can be set on [`Router`] and overridden in [`crate::components::Route`]
#[derive(Default, Clone, Debug, PartialEq, Eq)]
pub enum TrailingSlash {
    /// This is the default behavior as of Leptos 0.5.  Trailing slashes in your
    /// `Route` path are stripped. i.e.: the following two route declarations
    /// are equivalent:
    ///  * `<Route path="/foo">`
    ///  * `<Route path="/foo/">`
    #[default]
    Drop,

    /// This mode will respect your path as it is written. Ex:
    ///  * If you specify `<Route path="/foo">`, then `/foo` matches, but
    ///    `/foo/` does not.
    ///  * If you specify `<Route path="/foo/">`, then `/foo/` matches, but
    ///    `/foo` does not.
    Exact,

    /// Like `Exact`, this mode respects your path as-written. But it will also
    /// add redirects to the specified path if a user nagivates to a URL that is
    /// off by only the trailing slash.
    ///
    /// Given `<Route path="/foo">`
    ///  * Visiting `/foo` is valid.
    ///  * Visiting `/foo/` serves a redirect to `/foo`
    ///
    /// Given `<Route path="/foo/">`
    ///  * Visiting `/foo` serves a redirect to `/foo/`
    ///  * Visiting `/foo/` is valid.
    Redirect,
}

impl TrailingSlash {
    /// Should we redirect requests that come in with the wrong (extra/missing) trailng slash?
    pub(crate) fn should_redirect(&self) -> bool {
        use TrailingSlash::*;
        match self {
            Redirect => true,
            Drop | Exact => false,
        }
    }

    pub(crate) fn normalize_route_path(&self, path: &mut String) {
        if !self.should_drop() {
            return;
        }
        while path.ends_with('/') {
            path.pop();
        }
    }

    fn should_drop(&self) -> bool {
        use TrailingSlash::*;
        match self {
            Redirect | Exact => false,
            Drop => true,
        }
    }
}