mod client; mod content; mod database; mod error; mod input; mod meta; mod navigation; mod request; mod widget; use client::Client; use content::Content; use error::Error; use input::Input; use meta::{Meta, Status}; use navigation::Navigation; use request::Request; use widget::Widget; use crate::app::browser::{ window::{tab::item::Action as TabAction, Action as WindowAction}, Action as BrowserAction, }; use crate::Profile; use gtk::{ gdk::Texture, gdk_pixbuf::Pixbuf, gio::SocketClientEvent, glib::{ gformat, GString, Priority, Regex, RegexCompileFlags, RegexMatchFlags, Uri, UriFlags, UriHideFlags, }, prelude::{EditableExt, FileExt, SocketClientExt}, }; use sqlite::Transaction; use std::{rc::Rc, time::Duration}; pub struct Page { id: GString, profile: Rc, // Actions browser_action: Rc, tab_action: Rc, // Components pub client: Rc, pub content: Rc, pub input: Rc, pub meta: Rc, pub navigation: Rc, pub widget: Rc, } impl Page { // Constructors pub fn new( id: GString, profile: Rc, action: (Rc, Rc, Rc), ) -> Self { // Init components let content = Rc::new(Content::new((action.1.clone(), action.2.clone()))); let navigation = Rc::new(Navigation::new( profile.clone(), (action.0.clone(), action.1.clone(), action.2.clone()), )); let input = Rc::new(Input::new()); let widget = Rc::new(Widget::new( &id, &navigation.widget.gobject, &content.gobject, &input.widget.clamp, )); let meta = Rc::new(Meta::new(Status::New, gformat!("New page"))); // Done Self { id, profile, // Actions browser_action: action.0, tab_action: action.2, // Components client: Rc::new(Client::new()), content, navigation, input, meta, widget, } } // Actions /// Toggle bookmark for current `profile` by navigation request value /// * return `true` on bookmark created, `false` on deleted pub fn bookmark(&self) -> Result { let result = match self .profile .bookmark .toggle(self.navigation.request.widget.entry.text().as_str()) { Ok(result) => Ok(result), Err(_) => Err(Error::Bookmark), // @TODO }; self.update(); result } /// Navigate home URL (parsed from current navigation entry) /// * this method create new history record in memory as defined in `action_page_open` action pub fn home(&self) { if let Some(url) = self.navigation.home.url() { // Update with history record self.tab_action.load.activate(Some(&url), true); } } /// Navigate back in history /// * this method does not create new history record in memory pub fn history_back(&self) { if let Some(request) = self.navigation.history.back(true) { // Update navigation entry self.navigation.request.widget.entry.set_text(&request); // Load page (without history record) self.load(false); } } /// Navigate forward in history /// * this method does not create new history record in memory pub fn history_forward(&self) { if let Some(request) = self.navigation.history.forward(true) { // Update navigation entry self.navigation.request.widget.entry.set_text(&request); // Load page (without history record) self.load(false); } } /// Used as API for external reload actions /// * this method record history to memory buffer by default pub fn reload(&self) { self.load(true); } /// Main loader for different protocols, that routed by scheme /// * every protocol has it own (children) method implementation pub fn load(&self, is_history: bool) { /// Global limit to prevent infinitive redirects (ALL protocols) /// * every protocol implementation has own value checker, according to specification const DEFAULT_MAX_REDIRECT_COUNT: usize = 10; // Reset widgets self.input.unset(); // Create shared variant value let id = self.id.clone(); // Prevent infinitive redirection if self.meta.redirects() > DEFAULT_MAX_REDIRECT_COUNT { todo!() } // Try redirect request let request = if let Some(redirect) = self.meta.redirect() { if redirect.is_foreground { self.navigation .request .widget .entry .set_text(&redirect.request); } // Return value from redirection holder Request::from(&redirect.request, redirect.referrer.as_ref()) } else { // Reset redirect counter as request value taken from user input self.meta.redirect.borrow_mut().clear(); // Return value from navigation entry Request::from(&self.navigation.request.widget.entry.text(), None) }; // Update self.meta.set_status(Status::Reload).set_title("Loading.."); self.browser_action.update.activate(Some(&id)); // Route by request match request { Request::Default(ref uri) | Request::Download(ref uri) | Request::Source(ref uri) => { // Route by scheme match uri.scheme().as_str() { "file" => todo!(), "gemini" => { let (uri, is_download, is_source) = match request { Request::Default(uri) => (uri, false, false), Request::Download(uri) => (uri, true, false), Request::Source(uri) => (uri, false, true), _ => panic!(), }; self.load_gemini(uri, is_download, is_source, is_history) } scheme => { // Define common data let status = Status::Failure; let title = "Oops"; // Add history record if is_history { snap_history(self.navigation.clone()); } // Update widget self.content .to_status_failure() .set_title(title) .set_description(Some(&format!("Scheme `{scheme}` not supported"))); // Update meta self.meta.set_status(status).set_title(title); // Update window self.browser_action.update.activate(Some(&id)); } } } Request::Search(ref query) => { // Try interpret URI manually if Regex::match_simple( r"^[^\/\s]+\.[\w]{2,}", query, RegexCompileFlags::DEFAULT, RegexMatchFlags::DEFAULT, ) { // Seems request contain some host, try append default scheme // * make sure new request conversable to valid URI match Uri::parse(&format!("gemini://{query}"), UriFlags::NONE) { Ok(uri) => { // Update navigation entry self.navigation .request .widget .entry .set_text(&uri.to_string()); // Load page (without history record) self.load(false); } Err(_) => { // @TODO any action here? } } } else { // Plain text given, make search request to default provider self.navigation.request.widget.entry.set_text(&format!( "gemini://tlgs.one/search?{}", Uri::escape_string(query, None, false) )); // Load page (without history record) self.load(false); } } }; } pub fn update(&self) { // Update components self.navigation.update(self.progress_fraction()); // @TODO self.content.update(); } pub fn clean( &self, transaction: &Transaction, app_browser_window_tab_item_id: &i64, ) -> Result<(), String> { match database::select(transaction, app_browser_window_tab_item_id) { Ok(records) => { for record in records { match database::delete(transaction, &record.id) { Ok(_) => { // Delegate clean action to the item childs self.meta.clean(transaction, &record.id)?; self.navigation.clean(transaction, &record.id)?; } Err(e) => return Err(e.to_string()), } } } Err(e) => return Err(e.to_string()), } Ok(()) } pub fn restore( &self, transaction: &Transaction, app_browser_window_tab_item_id: &i64, ) -> Result<(), String> { // Update status self.meta.set_status(Status::SessionRestore); // Begin page restore match database::select(transaction, app_browser_window_tab_item_id) { Ok(records) => { for record in records { // Delegate restore action to the item childs self.meta.restore(transaction, &record.id)?; self.navigation.restore(transaction, &record.id)?; } } Err(e) => return Err(e.to_string()), } // Update status self.meta.set_status(Status::SessionRestored); Ok(()) } pub fn save( &self, transaction: &Transaction, app_browser_window_tab_item_id: &i64, ) -> Result<(), String> { match database::insert(transaction, app_browser_window_tab_item_id) { Ok(_) => { let id = database::last_insert_id(transaction); // Delegate save action to childs self.meta.save(transaction, &id)?; self.navigation.save(transaction, &id)?; } Err(e) => return Err(e.to_string()), } Ok(()) } // Getters pub fn progress_fraction(&self) -> Option { // Interpret status to progress fraction match *self.meta.status.borrow() { Status::Reload | Status::SessionRestore => Some(0.0), Status::Resolving => Some(0.1), Status::Resolved => Some(0.2), Status::Connecting => Some(0.3), Status::Connected => Some(0.4), Status::ProxyNegotiating => Some(0.5), Status::ProxyNegotiated => Some(0.6), Status::TlsHandshaking => Some(0.7), Status::TlsHandshaked => Some(0.8), Status::Complete => Some(0.9), Status::Failure | Status::Redirect | Status::Success | Status::Input => Some(1.0), Status::New | Status::SessionRestored => None, } } pub fn is_loading(&self) -> bool { match self.progress_fraction() { Some(progress_fraction) => progress_fraction < 1.0, None => false, } } // Private helpers // @TODO move outside fn load_gemini(&self, uri: Uri, is_download: bool, is_source: bool, is_history: bool) { // Init shared clones let cancellable = self.client.cancellable(); let update = self.browser_action.update.clone(); let tab_action = self.tab_action.clone(); let navigation = self.navigation.clone(); let content = self.content.clone(); let id = self.id.clone(); let input = self.input.clone(); let meta = self.meta.clone(); // Listen for connection status updates self.client.gemini.socket.connect_event({ let id = id.clone(); let meta = meta.clone(); let update = update.clone(); move |_, event, _, _| { meta.set_status(match event { SocketClientEvent::Resolving => Status::Resolving, SocketClientEvent::Resolved => Status::Resolved, SocketClientEvent::Connecting => Status::Connecting, SocketClientEvent::Connected => Status::Connected, SocketClientEvent::ProxyNegotiating => Status::ProxyNegotiating, SocketClientEvent::ProxyNegotiated => Status::ProxyNegotiated, // TlsHandshaking have effect only for guest connections! SocketClientEvent::TlsHandshaking => Status::TlsHandshaking, SocketClientEvent::TlsHandshaked => Status::TlsHandshaked, SocketClientEvent::Complete => Status::Complete, _ => todo!(), // notice on API change }); update.activate(Some(&id)); } }); // Begin new socket request self.client.gemini.request_async( uri.clone(), Priority::DEFAULT, cancellable.clone(), // Search for user certificate match request match self.profile.identity.gemini.match_scope(&uri.to_string()) { Some(identity) => match identity.to_tls_certificate() { Ok(certificate) => Some(certificate), Err(reason) => todo!("{reason}"), }, None => None, }, move |result| match result { Ok(response) => { // Route by status match response.meta.status { // https://geminiprotocol.net/docs/protocol-specification.gmi#input-expected gemini::client::connection::response::meta::Status::Input | gemini::client::connection::response::meta::Status::SensitiveInput => { // Format response let status = Status::Input; let title = match response.meta.data { Some(data) => data.value, None => gformat!("Input expected"), }; // Toggle input form variant match response.meta.status { gemini::client::connection::response::meta::Status::SensitiveInput => input.set_new_sensitive( tab_action.clone(), uri.clone(), Some(&title), Some(1024), ), _ => input.set_new_response( tab_action.clone(), uri.clone(), Some(&title), Some(1024), ), } // Update meta meta.set_status(status) .set_title(&title); // Update page update.activate(Some(&id)); }, // https://geminiprotocol.net/docs/protocol-specification.gmi#status-20 gemini::client::connection::response::meta::Status::Success => { if is_history { snap_history(navigation.clone()); } if is_download { // Update meta meta.set_status(Status::Success).set_title("Download"); // Update window update.activate(Some(&id)); // Init download widget content.to_status_download( &uri_to_title(&uri), // grab default filename &cancellable, { let cancellable = cancellable.clone(); move |file, action| { match file.replace( None, false, gtk::gio::FileCreateFlags::NONE, Some(&cancellable) ) { Ok(file_output_stream) => { gemini::gio::file_output_stream::move_all_from_stream_async( response.connection.stream(), file_output_stream, cancellable.clone(), Priority::DEFAULT, ( 0x400, // 1024 bytes per chunk None, // unlimited 0 // initial totals ), ( // on chunk { let action = action.clone(); move |_, total| action.update.activate( &format!("Received {total} bytes...") ) }, // on complete { let action = action.clone(); move |result| match result { Ok((_, total)) => action.complete.activate( &format!("Saved to {} ({total} bytes total)", file.parse_name()) ), Err(e) => action.cancel.activate(&e.to_string()) } } ) ); }, Err(e) => action.cancel.activate(&e.to_string()) } } } ); } else { // browse match response.meta.mime { Some(gemini::client::connection::response::meta::Mime::TextGemini) => { // Read entire input stream to buffer gemini::client::connection::response::data::Text::from_stream_async( response.connection.stream(), Priority::DEFAULT, cancellable.clone(), { let content = content.clone(); let id = id.clone(); let meta = meta.clone(); let update = update.clone(); let uri = uri.clone(); move |result|{ match result { Ok(buffer) => { // Set children component, // extract title from meta parsed let title = if is_source { content.to_text_source( &buffer.data ); uri_to_title(&uri) } else { match content.to_text_gemini( &uri, &buffer.data ).meta.title { Some(meta_title) => meta_title, None => uri_to_title(&uri) } }; // Update page meta meta.set_status(Status::Success) .set_title(&title); // Update window components update.activate(Some(&id)); } Err(reason) => { // Define common data let status = Status::Failure; let title = "Oops"; let description = reason.to_string(); // Update widget content .to_status_failure() .set_title(title) .set_description(Some(&description)); // Update meta meta.set_status(status) .set_title(title); // Update window update.activate(Some(&id)); }, } } } ); }, Some( gemini::client::connection::response::meta::Mime::ImagePng | gemini::client::connection::response::meta::Mime::ImageGif | gemini::client::connection::response::meta::Mime::ImageJpeg | gemini::client::connection::response::meta::Mime::ImageWebp ) => { // Final image size unknown, show loading widget let status = content.to_status_loading( Some(Duration::from_secs(1)) // show if download time > 1 second ); // Asynchronously move `InputStream` data from `SocketConnection` into the local `MemoryInputStream` // this action allows to count the bytes for loading widget and validate max size for incoming data gemini::gio::memory_input_stream::from_stream_async( response.connection.stream(), cancellable.clone(), Priority::DEFAULT, 0x400, // 1024 bytes per chunk, optional step for images download tracking 0xA00000, // 10M bytes max to prevent memory overflow if server play with promises move |_, total| { // Update loading progress status.set_description( Some(&gformat!("Download: {total} bytes")) ); }, { let cancellable = cancellable.clone(); let content = content.clone(); let id = id.clone(); let meta = meta.clone(); let update = update.clone(); let uri = uri.clone(); move |result| match result { Ok((memory_input_stream, _)) => { Pixbuf::from_stream_async( &memory_input_stream, Some(&cancellable), move |result| { // Process buffer data match result { Ok(buffer) => { // Update page meta meta.set_status(Status::Success) .set_title(uri_to_title(&uri).as_str()); // Update page content content.to_image(&Texture::for_pixbuf(&buffer)); // Update window components update.activate(Some(&id)); } Err(reason) => { // Define common data let status = Status::Failure; let title = "Oops"; // Update widget content .to_status_failure() .set_title(title) .set_description(Some(reason.message())); // Update meta meta.set_status(status) .set_title(title); } } } ); }, Err(reason) => { // Define common data let status = Status::Failure; let title = "Oops"; let description = reason.to_string(); // Update widget content .to_status_failure() .set_title(title) .set_description(Some(&description)); // Update meta meta.set_status(status) .set_title(title); } } } ); }, _ => { // Define common data let status = Status::Failure; let title = "Oops"; let description = gformat!("Content type not supported"); // Update widget content .to_status_failure() .set_title(title) .set_description(Some(&description)); // Update meta meta.set_status(status) .set_title(title); // Update window update.activate(Some(&id)); }, } } }, // https://geminiprotocol.net/docs/protocol-specification.gmi#status-30-temporary-redirection gemini::client::connection::response::meta::Status::Redirect | // https://geminiprotocol.net/docs/protocol-specification.gmi#status-31-permanent-redirection gemini::client::connection::response::meta::Status::PermanentRedirect => { // Extract redirection URL from response data match response.meta.data { Some(unresolved_url) => { // New URL from server MAY to be relative (according to the protocol specification), // resolve to absolute URI gobject using current request as the base for parser: // https://docs.gtk.org/glib/type_func.Uri.resolve_relative.html match Uri::resolve_relative( Some(&uri.to_string()), unresolved_url.value.as_str(), UriFlags::NONE, ) { Ok(resolved_url) => { // Build valid URI from resolved URL string // this conversion wanted to simply exclude `query` and `fragment` later (as restricted by protocol specification) match Uri::parse(resolved_url.as_str(), UriFlags::NONE) { Ok(resolved_uri) => { // Client MUST prevent external redirects (by protocol specification) if is_external_uri(&resolved_uri, &uri) { // Update meta meta.set_status(Status::Failure) .set_title("Oops"); // Show placeholder with manual confirmation to continue @TODO status page? content.to_text_gemini( &uri, &gformat!( "# Redirect issue\n\nExternal redirects not allowed by protocol\n\nContinue:\n\n=> {}", resolved_uri.to_string() ) ); // Client MUST limit the number of redirects they follow to 5 (by protocol specification) } else if meta.redirects() > 5 { // Update meta meta.set_status(Status::Failure) .set_title("Oops"); // Show placeholder with manual confirmation to continue @TODO status page? content.to_text_gemini( &uri, &gformat!( "# Redirect issue\n\nLimit the number of redirects reached\n\nContinue:\n\n=> {}", resolved_uri.to_string() ) ); // Redirection value looks valid, create new redirect (stored in meta `Redirect` holder) // then call page reload action to apply it by the parental controller } else { meta.add_redirect( // skip query and fragment by protocol requirements // @TODO review fragment specification resolved_uri.to_string_partial( UriHideFlags::FRAGMENT | UriHideFlags::QUERY ), // referrer Some(navigation.request.widget.entry.text()), // set follow policy based on status code matches!(response.meta.status, gemini::client::connection::response::meta::Status::PermanentRedirect), ) .set_status(Status::Redirect) // @TODO is this status really wanted? .set_title("Redirect"); // Reload page to apply redirection (without history record request) tab_action.load.activate(None, false); } }, Err(reason) => { let status = Status::Failure; let title = "Oops"; meta.set_status(status) .set_title(title); content .to_status_failure() .set_title(title) .set_description(Some(reason.message())); } } } Err(reason) => { let status = Status::Failure; let title = "Oops"; meta.set_status(status) .set_title(title); content .to_status_failure() .set_title(title) .set_description(Some(reason.message())); }, } }, None => { let status = Status::Failure; let title = "Oops"; meta.set_status(status) .set_title(title); content .to_status_failure() .set_title(title) .set_description(Some("Redirection target not defined")); }, } update.activate(Some(&id)); }, // https://geminiprotocol.net/docs/protocol-specification.gmi#status-60 gemini::client::connection::response::meta::Status::CertificateRequest | // https://geminiprotocol.net/docs/protocol-specification.gmi#status-61-certificate-not-authorized gemini::client::connection::response::meta::Status::CertificateUnauthorized | // https://geminiprotocol.net/docs/protocol-specification.gmi#status-62-certificate-not-valid gemini::client::connection::response::meta::Status::CertificateInvalid => { // Define common data let status = Status::Success; let title = "Identity"; // Add history record if is_history { snap_history(navigation.clone()); } // Update widget content .to_status_identity() .set_title(title) .set_description(Some(&match response.meta.data { Some(data) => data.value, None => match response.meta.status { gemini::client::connection::response::meta::Status::CertificateUnauthorized => gformat!("Certificate not authorized"), gemini::client::connection::response::meta::Status::CertificateInvalid => gformat!("Certificate not valid"), _ => gformat!("Client certificate required") }, })); // Update meta meta.set_status(status) .set_title(title); // Update window update.activate(Some(&id)); } _ => { // Define common data let status = Status::Failure; let title = "Oops"; // Add history record if is_history { snap_history(navigation.clone()); } // Update widget content .to_status_failure() .set_title(title) .set_description(Some(&match response.meta.data { Some(data) => data.value, None => gformat!("Status code not supported"), })); // Update meta meta.set_status(status) .set_title(title); // Update window update.activate(Some(&id)); } } }, Err(reason) => { // Define common data let status = Status::Failure; let title = "Oops"; let description = reason.to_string(); // Add history record if is_history { snap_history(navigation.clone()); } // Update widget content .to_status_failure() .set_title(title) .set_description(Some(&description)); // Update meta meta.set_status(status) .set_title(title); // Update window update.activate(Some(&id)); } } ); } } // Tools pub fn migrate(tx: &Transaction) -> Result<(), String> { // Migrate self components if let Err(e) = database::init(tx) { return Err(e.to_string()); } // Delegate migration to childs meta::migrate(tx)?; navigation::migrate(tx)?; // Success Ok(()) } /// Helper function, extract readable title from [Uri](https://docs.gtk.org/glib/struct.Uri.html) /// /// Useful as common placeholder when page title could not be detected /// /// * this feature may be improved and moved outside @TODO fn uri_to_title(uri: &Uri) -> String { let title = uri.path().split('/').last().unwrap_or_default().to_string(); if title.is_empty() { match uri.host() { Some(host) => host.to_string(), None => "Untitled".to_string(), } } else { title } } /// Compare `subject` with `base` /// /// Return `false` on scheme, port or host mismatch fn is_external_uri(subject: &Uri, base: &Uri) -> bool { if subject.scheme() != base.scheme() { return true; } if subject.port() != base.port() { return true; } subject.host() != base.host() } /// Make new history record for given `navigation` object /// * applies on shared conditions match only fn snap_history(navigation: Rc) { let request = navigation.request.widget.entry.text(); // Apply additional filters if match navigation.history.current() { Some(current) => current != request, None => true, } { // Add new record match conditions navigation.history.add(request, true) } }