use std::{ any::Any, collections::HashSet, rc::Rc, sync::{Arc, RwLock}, }; use dioxus::prelude::*; use crate::{ navigation::NavigationTarget, prelude::{AnyHistoryProvider, IntoRoutable}, routable::Routable, router_cfg::RouterConfig, }; /// An error that can occur when navigating. #[derive(Debug, Clone)] pub struct ExternalNavigationFailure(String); /// A function the router will call after every routing update. pub(crate) type RoutingCallback = Arc) -> Option>>; pub(crate) type AnyRoutingCallback = Arc Option>>>; struct MutableRouterState { /// The current prefix. prefix: Option, history: Box, unresolved_error: Option, } /// A collection of router data that manages all routing functionality. #[derive(Clone)] pub struct RouterContext { state: Rc>, subscribers: Arc>>, subscriber_update: Arc, routing_callback: Option, failure_external_navigation: fn(Scope) -> Element, any_route_to_string: fn(&dyn Any) -> String, } impl RouterContext { pub(crate) fn new( mut cfg: RouterConfig, mark_dirty: Arc, ) -> Self where R: Clone, ::Err: std::fmt::Display, { let state = Rc::new(RefCell::new(MutableRouterState { prefix: Default::default(), history: cfg.take_history(), unresolved_error: None, })); let subscriber_update = mark_dirty.clone(); let subscribers = Arc::new(RwLock::new(HashSet::new())); let myself = Self { state, subscribers: subscribers.clone(), subscriber_update, routing_callback: cfg.on_update.map(|update| { Arc::new(move |ctx| { let ctx = GenericRouterContext { inner: ctx, _marker: std::marker::PhantomData, }; update(ctx).map(|t| match t { NavigationTarget::Internal(r) => { NavigationTarget::Internal(Rc::new(r) as Rc) } NavigationTarget::External(s) => NavigationTarget::External(s), }) }) as Arc Option>>> }), failure_external_navigation: cfg.failure_external_navigation, any_route_to_string: |route| { route .downcast_ref::() .unwrap_or_else(|| { panic!( "Route is not of the expected type: {}\n found typeid: {:?}\n expected typeid: {:?}", std::any::type_name::(), route.type_id(), std::any::TypeId::of::() ) }) .to_string() }, }; // set the updater { let mut state = myself.state.borrow_mut(); state.history.updater(Arc::new(move || { for &id in subscribers.read().unwrap().iter() { (mark_dirty)(id); } })); } myself } pub(crate) fn route_from_str(&self, route: &str) -> Result, String> { let state = self.state.borrow(); state.history.parse_route(route) } /// Check whether there is a previous page to navigate back to. #[must_use] pub fn can_go_back(&self) -> bool { self.state.borrow().history.can_go_back() } /// Check whether there is a future page to navigate forward to. #[must_use] pub fn can_go_forward(&self) -> bool { self.state.borrow().history.can_go_forward() } /// Go back to the previous location. /// /// Will fail silently if there is no previous location to go to. pub fn go_back(&self) { { self.state.borrow_mut().history.go_back(); } self.change_route(); } /// Go back to the next location. /// /// Will fail silently if there is no next location to go to. pub fn go_forward(&self) { { self.state.borrow_mut().history.go_forward(); } self.change_route(); } pub(crate) fn push_any( &self, target: NavigationTarget>, ) -> Option { match target { NavigationTarget::Internal(p) => { let mut state = self.state_mut(); state.history.push(p) } NavigationTarget::External(e) => return self.external(e), } self.change_route() } /// Push a new location. /// /// The previous location will be available to go back to. pub fn push(&self, target: impl Into) -> Option { let target = self.resolve_into_routable(target.into()); match target { NavigationTarget::Internal(p) => { let mut state = self.state_mut(); state.history.push(p) } NavigationTarget::External(e) => return self.external(e), } self.change_route() } /// Replace the current location. /// /// The previous location will **not** be available to go back to. pub fn replace(&self, target: impl Into) -> Option { let target = self.resolve_into_routable(target.into()); { let mut state = self.state_mut(); match target { NavigationTarget::Internal(p) => state.history.replace(p), NavigationTarget::External(e) => return self.external(e), } } self.change_route() } /// The route that is currently active. pub fn current(&self) -> R { self.state .borrow() .history .current_route() .downcast::() .unwrap() .as_ref() .clone() } /// The route that is currently active. pub fn current_route_string(&self) -> String { self.any_route_to_string(&*self.state.borrow().history.current_route()) } pub(crate) fn any_route_to_string(&self, route: &dyn Any) -> String { (self.any_route_to_string)(route) } pub(crate) fn resolve_into_routable( &self, into_routable: IntoRoutable, ) -> NavigationTarget> { match into_routable { IntoRoutable::FromStr(url) => { let parsed_route: NavigationTarget> = match self.route_from_str(&url) { Ok(route) => NavigationTarget::Internal(route), Err(_) => NavigationTarget::External(url), }; parsed_route } IntoRoutable::Route(route) => NavigationTarget::Internal(route), } } /// The prefix that is currently active. pub fn prefix(&self) -> Option { self.state.borrow().prefix.clone() } fn external(&self, external: String) -> Option { let mut state = self.state_mut(); match state.history.external(external.clone()) { true => None, false => { let failure = ExternalNavigationFailure(external); state.unresolved_error = Some(failure.clone()); self.update_subscribers(); Some(failure) } } } fn state_mut(&self) -> RefMut { self.state.borrow_mut() } /// Manually subscribe to the current route pub fn subscribe(&self, id: ScopeId) { self.subscribers.write().unwrap().insert(id); } /// Manually unsubscribe from the current route pub fn unsubscribe(&self, id: ScopeId) { self.subscribers.write().unwrap().remove(&id); } fn update_subscribers(&self) { for &id in self.subscribers.read().unwrap().iter() { (self.subscriber_update)(id); } } /// Clear any unresolved errors pub fn clear_error(&self) { self.state.borrow_mut().unresolved_error = None; self.update_subscribers(); } pub(crate) fn render_error<'a>(&self, cx: Scope<'a>) -> Element<'a> { self.state .borrow() .unresolved_error .as_ref() .and_then(|_| (self.failure_external_navigation)(cx)) } fn change_route(&self) -> Option { if let Some(callback) = &self.routing_callback { let myself = self.clone(); if let Some(new) = callback(myself) { let mut state = self.state_mut(); match new { NavigationTarget::Internal(p) => state.history.replace(p), NavigationTarget::External(e) => return self.external(e), } } } self.update_subscribers(); None } } pub struct GenericRouterContext { inner: RouterContext, _marker: std::marker::PhantomData, } impl GenericRouterContext where R: Routable, { /// Check whether there is a previous page to navigate back to. #[must_use] pub fn can_go_back(&self) -> bool { self.inner.can_go_back() } /// Check whether there is a future page to navigate forward to. #[must_use] pub fn can_go_forward(&self) -> bool { self.inner.can_go_forward() } /// Go back to the previous location. /// /// Will fail silently if there is no previous location to go to. pub fn go_back(&self) { self.inner.go_back(); } /// Go back to the next location. /// /// Will fail silently if there is no next location to go to. pub fn go_forward(&self) { self.inner.go_forward(); } /// Push a new location. /// /// The previous location will be available to go back to. pub fn push( &self, target: impl Into>, ) -> Option { self.inner.push(target.into()) } /// Replace the current location. /// /// The previous location will **not** be available to go back to. pub fn replace( &self, target: impl Into>, ) -> Option { self.inner.replace(target.into()) } /// The route that is currently active. pub fn current(&self) -> R where R: Clone, { self.inner.current() } /// The prefix that is currently active. pub fn prefix(&self) -> Option { self.inner.prefix() } /// Manually subscribe to the current route pub fn subscribe(&self, id: ScopeId) { self.inner.subscribe(id) } /// Manually unsubscribe from the current route pub fn unsubscribe(&self, id: ScopeId) { self.inner.unsubscribe(id) } /// Clear any unresolved errors pub fn clear_error(&self) { self.inner.clear_error() } }