notedeck

route.rs (26294B)

---

 use egui_nav::Percent;
 use enostr::{NoteId, Pubkey};
 use notedeck::{
     tr, Localization, NoteZapTargetOwned, ReplacementType, RootNoteIdBuf, Router, WalletType,
 };
 use std::ops::Range;
 
 use crate::{
     accounts::AccountsRoute,
     timeline::{kind::ColumnTitle, ThreadSelection, TimelineKind},
     ui::add_column::{AddAlgoRoute, AddColumnRoute},
 };
 
 use tokenator::{ParseError, TokenParser, TokenSerializable, TokenWriter};
 
 /// App routing. These describe different places you can go inside Notedeck.
 #[derive(Clone, Eq, PartialEq, Debug)]
 pub enum Route {
     Timeline(TimelineKind),
     Thread(ThreadSelection),
     Accounts(AccountsRoute),
     Reply(NoteId),
     Quote(NoteId),
     RepostDecision(NoteId),
     Relays,
     Settings,
     ComposeNote,
     AddColumn(AddColumnRoute),
     EditProfile(Pubkey),
     Support,
     NewDeck,
     Search,
     EditDeck(usize),
     Wallet(WalletType),
     CustomizeZapAmount(NoteZapTargetOwned),
     Following(Pubkey),
     FollowedBy(Pubkey),
 }
 
 impl Route {
     pub fn timeline(timeline_kind: TimelineKind) -> Self {
         Route::Timeline(timeline_kind)
     }
 
     pub fn timeline_id(&self) -> Option<&TimelineKind> {
         if let Route::Timeline(tid) = self {
             Some(tid)
         } else {
             None
         }
     }
 
     pub fn relays() -> Self {
         Route::Relays
     }
 
     pub fn settings() -> Self {
         Route::Settings
     }
 
     pub fn thread(thread_selection: ThreadSelection) -> Self {
         Route::Thread(thread_selection)
     }
 
     pub fn profile(pubkey: Pubkey) -> Self {
         Route::Timeline(TimelineKind::profile(pubkey))
     }
 
     pub fn reply(replying_to: NoteId) -> Self {
         Route::Reply(replying_to)
     }
 
     pub fn quote(quoting: NoteId) -> Self {
         Route::Quote(quoting)
     }
 
     pub fn accounts() -> Self {
         Route::Accounts(AccountsRoute::Accounts)
     }
 
     pub fn add_account() -> Self {
         Route::Accounts(AccountsRoute::AddAccount)
     }
 
     pub fn serialize_tokens(&self, writer: &mut TokenWriter) {
         match self {
             Route::Timeline(timeline_kind) => timeline_kind.serialize_tokens(writer),
             Route::Thread(selection) => {
                 writer.write_token("thread");
 
                 if let Some(reply) = selection.selected_note {
                     writer.write_token("root");
                     writer.write_token(&NoteId::new(*selection.root_id.bytes()).hex());
                     writer.write_token("reply");
                     writer.write_token(&reply.hex());
                 } else {
                     writer.write_token(&NoteId::new(*selection.root_id.bytes()).hex());
                 }
             }
             Route::Accounts(routes) => routes.serialize_tokens(writer),
             Route::AddColumn(routes) => routes.serialize_tokens(writer),
             Route::Search => writer.write_token("search"),
             Route::Reply(note_id) => {
                 writer.write_token("reply");
                 writer.write_token(&note_id.hex());
             }
             Route::Quote(note_id) => {
                 writer.write_token("quote");
                 writer.write_token(&note_id.hex());
             }
             Route::EditDeck(ind) => {
                 writer.write_token("deck");
                 writer.write_token("edit");
                 writer.write_token(&ind.to_string());
             }
             Route::EditProfile(pubkey) => {
                 writer.write_token("profile");
                 writer.write_token("edit");
                 writer.write_token(&pubkey.hex());
             }
             Route::Relays => {
                 writer.write_token("relay");
             }
             Route::Settings => {
                 writer.write_token("settings");
             }
             Route::ComposeNote => {
                 writer.write_token("compose");
             }
             Route::Support => {
                 writer.write_token("support");
             }
             Route::NewDeck => {
                 writer.write_token("deck");
                 writer.write_token("new");
             }
             Route::Wallet(_) => {
                 writer.write_token("wallet");
             }
             Route::CustomizeZapAmount(_) => writer.write_token("customize zap amount"),
             Route::RepostDecision(note_id) => {
                 writer.write_token("repost_decision");
                 writer.write_token(&note_id.hex());
             }
             Route::Following(pubkey) => {
                 writer.write_token("following");
                 writer.write_token(&pubkey.hex());
             }
             Route::FollowedBy(pubkey) => {
                 writer.write_token("followed_by");
                 writer.write_token(&pubkey.hex());
             }
         }
     }
 
     pub fn parse<'a>(
         parser: &mut TokenParser<'a>,
         deck_author: &Pubkey,
     ) -> Result<Self, ParseError<'a>> {
         let tlkind =
             parser.try_parse(|p| Ok(Route::Timeline(TimelineKind::parse(p, deck_author)?)));
 
         if tlkind.is_ok() {
             return tlkind;
         }
 
         TokenParser::alt(
             parser,
             &[
                 |p| Ok(Route::Accounts(AccountsRoute::parse_from_tokens(p)?)),
                 |p| Ok(Route::AddColumn(AddColumnRoute::parse_from_tokens(p)?)),
                 |p| {
                     p.parse_all(|p| {
                         p.parse_token("deck")?;
                         p.parse_token("edit")?;
                         let ind_str = p.pull_token()?;
                         let parsed_index = ind_str
                             .parse::<usize>()
                             .map_err(|_| ParseError::DecodeFailed)?;
                         Ok(Route::EditDeck(parsed_index))
                     })
                 },
                 |p| {
                     p.parse_all(|p| {
                         p.parse_token("profile")?;
                         p.parse_token("edit")?;
                         let pubkey = Pubkey::from_hex(p.pull_token()?)
                             .map_err(|_| ParseError::HexDecodeFailed)?;
                         Ok(Route::EditProfile(pubkey))
                     })
                 },
                 |p| {
                     p.parse_all(|p| {
                         p.parse_token("relay")?;
                         Ok(Route::Relays)
                     })
                 },
                 |p| {
                     p.parse_all(|p| {
                         p.parse_token("settings")?;
                         Ok(Route::Settings)
                     })
                 },
                 |p| {
                     p.parse_all(|p| {
                         p.parse_token("repost_decision")?;
                         let note_id = NoteId::from_hex(p.pull_token()?)
                             .map_err(|_| ParseError::HexDecodeFailed)?;
                         Ok(Route::RepostDecision(note_id))
                     })
                 },
                 |p| {
                     p.parse_all(|p| {
                         p.parse_token("quote")?;
                         Ok(Route::Quote(NoteId::new(tokenator::parse_hex_id(p)?)))
                     })
                 },
                 |p| {
                     p.parse_all(|p| {
                         p.parse_token("reply")?;
                         Ok(Route::Reply(NoteId::new(tokenator::parse_hex_id(p)?)))
                     })
                 },
                 |p| {
                     p.parse_all(|p| {
                         p.parse_token("compose")?;
                         Ok(Route::ComposeNote)
                     })
                 },
                 |p| {
                     p.parse_all(|p| {
                         p.parse_token("support")?;
                         Ok(Route::Support)
                     })
                 },
                 |p| {
                     p.parse_all(|p| {
                         p.parse_token("deck")?;
                         p.parse_token("new")?;
                         Ok(Route::NewDeck)
                     })
                 },
                 |p| {
                     p.parse_all(|p| {
                         p.parse_token("search")?;
                         Ok(Route::Search)
                     })
                 },
                 |p| {
                     p.parse_all(|p| {
                         p.parse_token("thread")?;
                         p.parse_token("root")?;
 
                         let root = tokenator::parse_hex_id(p)?;
 
                         p.parse_token("reply")?;
 
                         let selected = tokenator::parse_hex_id(p)?;
 
                         Ok(Route::Thread(ThreadSelection {
                             root_id: RootNoteIdBuf::new_unsafe(root),
                             selected_note: Some(NoteId::new(selected)),
                         }))
                     })
                 },
                 |p| {
                     p.parse_all(|p| {
                         p.parse_token("thread")?;
                         Ok(Route::Thread(ThreadSelection::from_root_id(
                             RootNoteIdBuf::new_unsafe(tokenator::parse_hex_id(p)?),
                         )))
                     })
                 },
                 |p| {
                     p.parse_all(|p| {
                         p.parse_token("following")?;
                         let pubkey = Pubkey::from_hex(p.pull_token()?)
                             .map_err(|_| ParseError::HexDecodeFailed)?;
                         Ok(Route::Following(pubkey))
                     })
                 },
                 |p| {
                     p.parse_all(|p| {
                         p.parse_token("followed_by")?;
                         let pubkey = Pubkey::from_hex(p.pull_token()?)
                             .map_err(|_| ParseError::HexDecodeFailed)?;
                         Ok(Route::FollowedBy(pubkey))
                     })
                 },
             ],
         )
     }
 
     pub fn title(&self, i18n: &mut Localization) -> ColumnTitle<'_> {
         match self {
             Route::Timeline(kind) => kind.to_title(i18n),
             Route::Thread(_) => {
                 ColumnTitle::formatted(tr!(i18n, "Thread", "Column title for note thread view"))
             }
             Route::Reply(_id) => {
                 ColumnTitle::formatted(tr!(i18n, "Reply", "Column title for reply composition"))
             }
             Route::Quote(_id) => {
                 ColumnTitle::formatted(tr!(i18n, "Quote", "Column title for quote composition"))
             }
             Route::Relays => {
                 ColumnTitle::formatted(tr!(i18n, "Relays", "Column title for relay management"))
             }
             Route::Settings => {
                 ColumnTitle::formatted(tr!(i18n, "Settings", "Column title for app settings"))
             }
             Route::Accounts(amr) => match amr {
                 AccountsRoute::Accounts => ColumnTitle::formatted(tr!(
                     i18n,
                     "Accounts",
                     "Column title for account management"
                 )),
                 AccountsRoute::AddAccount => ColumnTitle::formatted(tr!(
                     i18n,
                     "Add Account",
                     "Column title for adding new account"
                 )),
                 AccountsRoute::Onboarding => ColumnTitle::formatted(tr!(
                     i18n,
                     "Onboarding",
                     "Column title for finding users to follow"
                 )),
             },
             Route::ComposeNote => ColumnTitle::formatted(tr!(
                 i18n,
                 "Compose Note",
                 "Column title for note composition"
             )),
             Route::AddColumn(c) => match c {
                 AddColumnRoute::Base => ColumnTitle::formatted(tr!(
                     i18n,
                     "Add Column",
                     "Column title for adding new column"
                 )),
                 AddColumnRoute::Algo(r) => match r {
                     AddAlgoRoute::Base => ColumnTitle::formatted(tr!(
                         i18n,
                         "Add Algo Column",
                         "Column title for adding algorithm column"
                     )),
                     AddAlgoRoute::LastPerPubkey => ColumnTitle::formatted(tr!(
                         i18n,
                         "Add Last Notes Column",
                         "Column title for adding last notes column"
                     )),
                 },
                 AddColumnRoute::UndecidedNotification => ColumnTitle::formatted(tr!(
                     i18n,
                     "Add Notifications Column",
                     "Column title for adding notifications column"
                 )),
                 AddColumnRoute::ExternalNotification => ColumnTitle::formatted(tr!(
                     i18n,
                     "Add External Notifications Column",
                     "Column title for adding external notifications column"
                 )),
                 AddColumnRoute::Hashtag => ColumnTitle::formatted(tr!(
                     i18n,
                     "Add Hashtag Column",
                     "Column title for adding hashtag column"
                 )),
                 AddColumnRoute::UndecidedIndividual => ColumnTitle::formatted(tr!(
                     i18n,
                     "Subscribe to someone's notes",
                     "Column title for subscribing to individual user"
                 )),
                 AddColumnRoute::ExternalIndividual => ColumnTitle::formatted(tr!(
                     i18n,
                     "Subscribe to someone else's notes",
                     "Column title for subscribing to external user"
                 )),
             },
             Route::Support => {
                 ColumnTitle::formatted(tr!(i18n, "Damus Support", "Column title for support page"))
             }
             Route::NewDeck => {
                 ColumnTitle::formatted(tr!(i18n, "Add Deck", "Column title for adding new deck"))
             }
             Route::EditDeck(_) => {
                 ColumnTitle::formatted(tr!(i18n, "Edit Deck", "Column title for editing deck"))
             }
             Route::EditProfile(_) => ColumnTitle::formatted(tr!(
                 i18n,
                 "Edit Profile",
                 "Column title for profile editing"
             )),
             Route::Search => {
                 ColumnTitle::formatted(tr!(i18n, "Search", "Column title for search page"))
             }
             Route::Wallet(_) => {
                 ColumnTitle::formatted(tr!(i18n, "Wallet", "Column title for wallet management"))
             }
             Route::CustomizeZapAmount(_) => ColumnTitle::formatted(tr!(
                 i18n,
                 "Customize Zap Amount",
                 "Column title for zap amount customization"
             )),
             Route::RepostDecision(_) => ColumnTitle::formatted(tr!(
                 i18n,
                 "Repost",
                 "Column title for deciding the type of repost"
             )),
             Route::Following(_) => ColumnTitle::formatted(tr!(
                 i18n,
                 "Following",
                 "Column title for users being followed"
             )),
             Route::FollowedBy(_) => {
                 ColumnTitle::formatted(tr!(i18n, "Followed by", "Column title for followers"))
             }
         }
     }
 }
 
 // TODO: add this to egui-nav so we don't have to deal with returning
 // and navigating headaches
 #[derive(Clone, Debug)]
 pub struct ColumnsRouter<R: Clone> {
     router_internal: Router<R>,
     forward_stack: Vec<R>,
 
     // An overlay captures a range of routes where only one will persist when going back, the most recent added
     overlay_ranges: Vec<Range<usize>>,
 }
 
 impl<R: Clone> ColumnsRouter<R> {
     pub fn new(routes: Vec<R>) -> Self {
         if routes.is_empty() {
             panic!("routes can't be empty")
         }
         let router_internal = Router::new(routes);
         ColumnsRouter {
             router_internal,
             forward_stack: Vec::new(),
             overlay_ranges: Vec::new(),
         }
     }
 
     pub fn route_to(&mut self, route: R) {
         self.router_internal.route_to(route);
         self.forward_stack.clear();
     }
 
     pub fn route_to_overlaid(&mut self, route: R) {
         self.route_to(route);
         self.set_overlaying();
     }
 
     pub fn route_to_overlaid_new(&mut self, route: R) {
         self.route_to(route);
         self.new_overlay();
     }
 
     // Route to R. Then when it is successfully placed, should call `remove_previous_routes` to remove all previous routes
     pub fn route_to_replaced(&mut self, route: R) {
         self.router_internal
             .route_to_replaced(route, ReplacementType::All);
     }
 
     /// Go back, start the returning process
     pub fn go_back(&mut self) -> Option<R> {
         if self.router_internal.returning || self.router_internal.len() == 1 {
             return None;
         }
 
         if let Some(range) = self.overlay_ranges.pop() {
             tracing::debug!("Going back, found overlay: {:?}", range);
             self.remove_overlay(range);
         } else {
             tracing::debug!("Going back, no overlay");
         }
 
         self.router_internal.go_back()
     }
 
     pub fn go_forward(&mut self) -> bool {
         if let Some(route) = self.forward_stack.pop() {
             self.router_internal.route_to(route);
             true
         } else {
             false
         }
     }
 
     /// Pop a route, should only be called on a NavRespose::Returned reseponse
     pub fn pop(&mut self) -> Option<R> {
         if self.router_internal.len() == 1 {
             return None;
         }
 
         let is_overlay = 's: {
             let Some(last_range) = self.overlay_ranges.last_mut() else {
                 break 's false;
             };
 
             if last_range.end != self.router_internal.len() {
                 break 's false;
             }
 
             if last_range.end - 1 <= last_range.start {
                 self.overlay_ranges.pop();
             } else {
                 last_range.end -= 1;
             }
 
             true
         };
 
         let popped = self.router_internal.pop()?;
         if !is_overlay {
             self.forward_stack.push(popped.clone());
         }
         Some(popped)
     }
 
     pub fn remove_previous_routes(&mut self) {
         self.router_internal.complete_replacement();
     }
 
     /// Removes all routes in the overlay besides the last
     fn remove_overlay(&mut self, overlay_range: Range<usize>) {
         let num_routes = self.router_internal.routes.len();
         if num_routes <= 1 {
             return;
         }
 
         if overlay_range.len() <= 1 {
             return;
         }
 
         self.router_internal
             .routes
             .drain(overlay_range.start..overlay_range.end - 1);
     }
 
     pub fn is_replacing(&self) -> bool {
         self.router_internal.is_replacing()
     }
 
     fn set_overlaying(&mut self) {
         let mut overlaying_active = None;
         let mut binding = self.overlay_ranges.last_mut();
         if let Some(range) = &mut binding {
             if range.end == self.router_internal.len() - 1 {
                 overlaying_active = Some(range);
             }
         };
 
         if let Some(range) = overlaying_active {
             range.end = self.router_internal.len();
         } else {
             let new_range = self.router_internal.len() - 1..self.router_internal.len();
             self.overlay_ranges.push(new_range);
         }
     }
 
     fn new_overlay(&mut self) {
         let new_range = self.router_internal.len() - 1..self.router_internal.len();
         self.overlay_ranges.push(new_range);
     }
 
     pub fn routes(&self) -> &Vec<R> {
         self.router_internal.routes()
     }
 
     pub fn navigating(&self) -> bool {
         self.router_internal.navigating
     }
 
     pub fn navigating_mut(&mut self, new: bool) {
         self.router_internal.navigating = new;
     }
 
     pub fn returning(&self) -> bool {
         self.router_internal.returning
     }
 
     pub fn returning_mut(&mut self, new: bool) {
         self.router_internal.returning = new;
     }
 
     pub fn top(&self) -> &R {
         self.router_internal.top()
     }
 
     pub fn prev(&self) -> Option<&R> {
         self.router_internal.prev()
     }
 }
 
 /*
 impl fmt::Display for Route {
     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
         match self {
             Route::Timeline(kind) => match kind {
                 TimelineKind::List(ListKind::Contact(_pk)) => {
                     write!(f, "{}", i18n, "Home", "Display name for home feed"))
                 }
                 TimelineKind::Algo(AlgoTimeline::LastPerPubkey(ListKind::Contact(_))) => {
                     write!(
                         f,
                         "{}",
                         tr!(
                             "Last Per Pubkey (Contact)",
                             "Display name for last notes per contact"
                         )
                     )
                 }
                 TimelineKind::Notifications(_) => write!(
                     f,
                     "{}",
                     tr!("Notifications", "Display name for notifications")
                 ),
                 TimelineKind::Universe => {
                     write!(f, "{}", tr!("Universe", "Display name for universe feed"))
                 }
                 TimelineKind::Generic(_) => {
                     write!(f, "{}", tr!("Custom", "Display name for custom timelines"))
                 }
                 TimelineKind::Search(_) => {
                     write!(f, "{}", tr!("Search", "Display name for search results"))
                 }
                 TimelineKind::Hashtag(ht) => write!(
                     f,
                     "{} ({})",
                     tr!("Hashtags", "Display name for hashtag feeds"),
                     ht.join(" ")
                 ),
                 TimelineKind::Profile(_id) => {
                     write!(f, "{}", tr!("Profile", "Display name for user profiles"))
                 }
             },
             Route::Thread(_) => write!(f, "{}", tr!("Thread", "Display name for thread view")),
             Route::Reply(_id) => {
                 write!(f, "{}", tr!("Reply", "Display name for reply composition"))
             }
             Route::Quote(_id) => {
                 write!(f, "{}", tr!("Quote", "Display name for quote composition"))
             }
             Route::Relays => write!(f, "{}", tr!("Relays", "Display name for relay management")),
             Route::Settings => write!(f, "{}", tr!("Settings", "Display name for settings management")),
             Route::Accounts(amr) => match amr {
                 AccountsRoute::Accounts => write!(
                     f,
                     "{}",
                     tr!("Accounts", "Display name for account management")
                 ),
                 AccountsRoute::AddAccount => write!(
                     f,
                     "{}",
                     tr!("Add Account", "Display name for adding account")
                 ),
             },
             Route::ComposeNote => write!(
                 f,
                 "{}",
                 tr!("Compose Note", "Display name for note composition")
             ),
             Route::AddColumn(_) => {
                 write!(f, "{}", tr!("Add Column", "Display name for adding column"))
             }
             Route::Support => write!(f, "{}", tr!("Support", "Display name for support page")),
             Route::NewDeck => write!(f, "{}", tr!("Add Deck", "Display name for adding deck")),
             Route::EditDeck(_) => {
                 write!(f, "{}", tr!("Edit Deck", "Display name for editing deck"))
             }
             Route::EditProfile(_) => write!(
                 f,
                 "{}",
                 tr!("Edit Profile", "Display name for profile editing")
             ),
             Route::Search => write!(f, "{}", tr!("Search", "Display name for search page")),
             Route::Wallet(_) => {
                 write!(f, "{}", tr!("Wallet", "Display name for wallet management"))
             }
             Route::CustomizeZapAmount(_) => write!(
                 f,
                 "{}",
                 tr!("Customize Zap Amount", "Display name for zap customization")
             ),
         }
     }
 }
 */
 
 #[derive(Clone, Debug)]
 pub struct SingletonRouter<R: Clone> {
     route: Option<R>,
     pub returning: bool,
     pub navigating: bool,
     pub after_action: Option<R>,
     pub split: egui_nav::Split,
 }
 
 impl<R: Clone> SingletonRouter<R> {
     pub fn route_to(&mut self, route: R, split: egui_nav::Split) {
         self.navigating = true;
         self.route = Some(route);
         self.split = split;
     }
 
     pub fn go_back(&mut self) {
         self.returning = true;
     }
 
     pub fn clear(&mut self) {
         *self = Self::default();
     }
 
     pub fn route(&self) -> &Option<R> {
         &self.route
     }
 }
 
 impl<R: Clone> Default for SingletonRouter<R> {
     fn default() -> Self {
         Self {
             route: None,
             returning: false,
             navigating: false,
             after_action: None,
             split: egui_nav::Split::PercentFromTop(Percent::new(35).expect("35 <= 100")),
         }
     }
 }
 
 #[cfg(test)]
 mod tests {
     use enostr::NoteId;
     use tokenator::{TokenParser, TokenWriter};
 
     use crate::{timeline::ThreadSelection, Route};
     use enostr::Pubkey;
     use notedeck::RootNoteIdBuf;
 
     #[test]
     fn test_thread_route_serialize() {
         let note_id_hex = "1c54e5b0c386425f7e017d9e068ddef8962eb2ce1bb08ed27e24b93411c12e60";
         let note_id = NoteId::from_hex(note_id_hex).unwrap();
         let data_str = format!("thread:{}", note_id_hex);
         let data = &data_str.split(":").collect::<Vec<&str>>();
         let mut token_writer = TokenWriter::default();
         let mut parser = TokenParser::new(&data);
         let parsed = Route::parse(&mut parser, &Pubkey::new(*note_id.bytes())).unwrap();
         let expected = Route::Thread(ThreadSelection::from_root_id(RootNoteIdBuf::new_unsafe(
             *note_id.bytes(),
         )));
         parsed.serialize_tokens(&mut token_writer);
         assert_eq!(expected, parsed);
         assert_eq!(token_writer.str(), data_str);
     }
 }