mirror of
https://github.com/YGGverse/Yoda.git
synced 2026-04-01 00:55:28 +00:00
begin multi-driver page client implementation
This commit is contained in:
yggverse
parent
df8dea9534
commit
0c08a0fb2f
39 changed files with 741 additions and 1712 deletions
470
src/app/browser/window/tab/item/client/driver/gemini.rs
Normal file
470
src/app/browser/window/tab/item/client/driver/gemini.rs
Normal file
|
|
@ -0,0 +1,470 @@
|
|||
use crate::tool::now;
|
||||
|
||||
use super::super::super::page::status::Status as PageStatus; // @TODO
|
||||
|
||||
use super::{Feature, Page};
|
||||
use gtk::glib::GString;
|
||||
use gtk::prelude::{EditableExt, FileExt};
|
||||
use gtk::{
|
||||
gdk::Texture,
|
||||
gdk_pixbuf::Pixbuf,
|
||||
gio::{Cancellable, SocketClientEvent},
|
||||
glib::{Priority, Uri},
|
||||
prelude::{EntryExt, SocketClientExt},
|
||||
};
|
||||
use std::{path::MAIN_SEPARATOR, rc::Rc, time::Duration};
|
||||
|
||||
/// Multi-protocol client API for `Page` object
|
||||
pub struct Gemini {
|
||||
client: Rc<ggemini::Client>,
|
||||
page: Rc<Page>,
|
||||
}
|
||||
|
||||
impl Gemini {
|
||||
// Constructors
|
||||
|
||||
/// Create new `Self`
|
||||
pub fn init(page: &Rc<Page>) -> Self {
|
||||
// Init supported protocol libraries
|
||||
let client = Rc::new(ggemini::Client::new());
|
||||
|
||||
// Listen for [SocketClient](https://docs.gtk.org/gio/class.SocketClient.html) updates
|
||||
client.socket.connect_event({
|
||||
let page = page.clone();
|
||||
move |_, event, _, _| {
|
||||
page.navigation
|
||||
.request
|
||||
.widget
|
||||
.entry
|
||||
.set_progress_fraction(match event {
|
||||
SocketClientEvent::Resolving => 0.1,
|
||||
SocketClientEvent::Resolved => 0.2,
|
||||
SocketClientEvent::Connecting => 0.3,
|
||||
SocketClientEvent::Connected => 0.4,
|
||||
SocketClientEvent::ProxyNegotiating => 0.5,
|
||||
SocketClientEvent::ProxyNegotiated => 0.6,
|
||||
// * `TlsHandshaking` | `TlsHandshaked` has effect only for guest connections!
|
||||
SocketClientEvent::TlsHandshaking => 0.7,
|
||||
SocketClientEvent::TlsHandshaked => 0.8,
|
||||
SocketClientEvent::Complete => 0.9,
|
||||
_ => todo!(), // alert on API change
|
||||
})
|
||||
}
|
||||
});
|
||||
|
||||
Self {
|
||||
client,
|
||||
page: page.clone(),
|
||||
}
|
||||
}
|
||||
|
||||
// Actions
|
||||
|
||||
pub fn handle(&self, uri: Uri, feature: Feature, cancellable: Cancellable, is_history: bool) {
|
||||
use ggemini::client::connection::response::{data::Text, meta::Status};
|
||||
|
||||
// Move focus out from navigation entry
|
||||
self.page
|
||||
.browser_action
|
||||
.escape
|
||||
.activate_stateful_once(Some(self.page.id.as_str().into()));
|
||||
|
||||
// Initially disable find action
|
||||
self.page
|
||||
.window_action
|
||||
.find
|
||||
.simple_action
|
||||
.set_enabled(false);
|
||||
|
||||
// Reset widgets
|
||||
self.page.search.unset();
|
||||
self.page.input.unset();
|
||||
self.page
|
||||
.status
|
||||
.replace(PageStatus::Loading { time: now() });
|
||||
self.page.title.replace("Loading..".into());
|
||||
self.page
|
||||
.browser_action
|
||||
.update
|
||||
.activate(Some(&self.page.id));
|
||||
|
||||
if is_history {
|
||||
snap_history(&self.page, None);
|
||||
}
|
||||
|
||||
self.client.request_async(
|
||||
ggemini::client::Request::gemini(uri.clone()),
|
||||
Priority::DEFAULT,
|
||||
cancellable.clone(),
|
||||
// Search for user certificate match request
|
||||
// * @TODO this feature does not support multi-protocol yet
|
||||
match self
|
||||
.page
|
||||
.profile
|
||||
.identity
|
||||
.gemini
|
||||
.match_scope(&uri.to_string())
|
||||
{
|
||||
Some(identity) => match identity.to_tls_certificate() {
|
||||
Ok(certificate) => Some(certificate),
|
||||
Err(_) => panic!(), // unexpected
|
||||
},
|
||||
None => None,
|
||||
},
|
||||
{
|
||||
let uri = uri.clone();
|
||||
let page = self.page.clone();
|
||||
move |result| match result {
|
||||
Ok(response) => {
|
||||
match response.meta.status {
|
||||
// https://geminiprotocol.net/docs/protocol-specification.gmi#input-expected
|
||||
Status::Input => {
|
||||
let title = match response.meta.data {
|
||||
Some(data) => data.to_string(),
|
||||
None => Status::Input.to_string(),
|
||||
};
|
||||
page.input.set_new_response(
|
||||
page.tab_action.clone(),
|
||||
uri,
|
||||
Some(&title),
|
||||
Some(1024),
|
||||
);
|
||||
page.title.replace(title.into()); // @TODO
|
||||
page.status.replace(PageStatus::Input { time: now() });
|
||||
page.browser_action.update.activate(Some(&page.id));
|
||||
}
|
||||
Status::SensitiveInput => {
|
||||
let title = match response.meta.data {
|
||||
Some(data) => data.to_string(),
|
||||
None => Status::Input.to_string(),
|
||||
};
|
||||
page.input.set_new_sensitive(
|
||||
page.tab_action.clone(),
|
||||
uri,
|
||||
Some(&title),
|
||||
Some(1024),
|
||||
);
|
||||
page.title.replace(title.into()); // @TODO
|
||||
page.status.replace(PageStatus::Input { time: now() });
|
||||
page.browser_action.update.activate(Some(&page.id));
|
||||
}
|
||||
// https://geminiprotocol.net/docs/protocol-specification.gmi#status-20
|
||||
Status::Success => match feature {
|
||||
Feature::Download => {
|
||||
// Init download widget
|
||||
let status = page.content.to_status_download(
|
||||
uri_to_title(&uri).trim_matches(MAIN_SEPARATOR), // grab default filename from base URI,
|
||||
// format FS entities
|
||||
&cancellable,
|
||||
{
|
||||
let cancellable = cancellable.clone();
|
||||
let stream = response.connection.stream();
|
||||
move |file, action| {
|
||||
match file.replace(
|
||||
None,
|
||||
false,
|
||||
gtk::gio::FileCreateFlags::NONE,
|
||||
Some(&cancellable),
|
||||
) {
|
||||
Ok(file_output_stream) => {
|
||||
// Asynchronously read [IOStream](https://docs.gtk.org/gio/class.IOStream.html)
|
||||
// to local [MemoryInputStream](https://docs.gtk.org/gio/class.MemoryInputStream.html)
|
||||
// show bytes count in loading widget, validate max size for incoming data
|
||||
// * no dependency of Gemini library here, feel free to use any other `IOStream` processor
|
||||
ggemini::gio::file_output_stream::move_all_from_stream_async(
|
||||
stream.clone(),
|
||||
file_output_stream,
|
||||
cancellable.clone(),
|
||||
Priority::DEFAULT,
|
||||
(
|
||||
0x100000, // 1M bytes per chunk
|
||||
None, // unlimited
|
||||
0, // initial totals
|
||||
),
|
||||
(
|
||||
// on chunk
|
||||
{
|
||||
let action = action.clone();
|
||||
move |_, total| {
|
||||
action.update.activate(&format!(
|
||||
"Received {}...",
|
||||
crate::tool::format_bytes(total)
|
||||
))
|
||||
}
|
||||
},
|
||||
// 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()),
|
||||
}
|
||||
}
|
||||
},
|
||||
);
|
||||
page.status.replace(PageStatus::Success { time: now() });
|
||||
page.title.replace(status.title());
|
||||
page.browser_action.update.activate(Some(&page.id));
|
||||
},
|
||||
_ => match response.meta.mime {
|
||||
Some(mime) => match mime.as_str() {
|
||||
"text/gemini" => Text::from_stream_async(
|
||||
response.connection.stream(),
|
||||
Priority::DEFAULT,
|
||||
cancellable.clone(),
|
||||
move |result| match result {
|
||||
Ok(text) => {
|
||||
/* @TODO refactor features
|
||||
let widget = if is_source_request {
|
||||
page.content.to_text_source(&data)
|
||||
} else {
|
||||
page.content.to_text_gemini(&uri, &data)
|
||||
};*/
|
||||
|
||||
let widget = page
|
||||
.content
|
||||
.to_text_gemini(&uri, &text.to_string());
|
||||
|
||||
// Connect `TextView` widget, update `search` model
|
||||
page.search.set(Some(widget.text_view));
|
||||
|
||||
// Update page meta
|
||||
page.status
|
||||
.replace(PageStatus::Success { time: now() });
|
||||
page.title.replace(match widget.meta.title {
|
||||
Some(title) => title.into(), // @TODO
|
||||
None => uri_to_title(&uri),
|
||||
});
|
||||
|
||||
// Deactivate progress fraction
|
||||
page.navigation.request.widget.entry.set_progress_fraction(0.0);
|
||||
|
||||
// Update window components
|
||||
page.window_action
|
||||
.find
|
||||
.simple_action
|
||||
.set_enabled(true);
|
||||
|
||||
page.browser_action.update.activate(Some(&page.id));
|
||||
}
|
||||
Err(e) => {
|
||||
let status = page.content.to_status_failure();
|
||||
status.set_description(Some(&e.to_string()));
|
||||
|
||||
page.status.replace(PageStatus::Failure { time: now() });
|
||||
page.title.replace(status.title());
|
||||
page.browser_action.update.activate(Some(&page.id));
|
||||
},
|
||||
},
|
||||
),
|
||||
"image/png" | "image/gif" | "image/jpeg" | "image/webp" => {
|
||||
// Final image size unknown, show loading widget
|
||||
let status = page.content.to_status_loading(
|
||||
Some(Duration::from_secs(1)), // show if download time > 1 second
|
||||
);
|
||||
|
||||
// Asynchronously read [IOStream](https://docs.gtk.org/gio/class.IOStream.html)
|
||||
// to local [MemoryInputStream](https://docs.gtk.org/gio/class.MemoryInputStream.html)
|
||||
// show bytes count in loading widget, validate max size for incoming data
|
||||
// * no dependency of Gemini library here, feel free to use any other `IOStream` processor
|
||||
ggemini::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(&format!("Download: {total} bytes")));
|
||||
},
|
||||
{
|
||||
let page = page.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) => {
|
||||
page.status
|
||||
.replace(PageStatus::Success { time: now() });
|
||||
page.title.replace(uri_to_title(&uri));
|
||||
page.content
|
||||
.to_image(&Texture::for_pixbuf(&buffer));
|
||||
page.browser_action
|
||||
.update
|
||||
.activate(Some(&page.id));
|
||||
}
|
||||
Err(e) => {
|
||||
let status = page.content.to_status_failure();
|
||||
status.set_description(Some(e.message()));
|
||||
|
||||
page.status
|
||||
.replace(PageStatus::Failure { time: now() });
|
||||
page.title.replace(status.title());
|
||||
}
|
||||
};
|
||||
page.browser_action.update.activate(Some(&page.id));
|
||||
},
|
||||
)
|
||||
}
|
||||
Err(e) => {
|
||||
let status = page.content.to_status_failure();
|
||||
status.set_description(Some(&e.to_string()));
|
||||
|
||||
page.status.replace(PageStatus::Failure { time: now() });
|
||||
page.title.replace(status.title());
|
||||
page.browser_action.update.activate(Some(&page.id));
|
||||
}
|
||||
}
|
||||
},
|
||||
);
|
||||
}
|
||||
mime => {
|
||||
let status = page
|
||||
.content
|
||||
.to_status_mime(&mime, Some((&page.tab_action, &uri)));
|
||||
status.set_description(Some(&format!("Content type `{mime}` yet not supported")));
|
||||
|
||||
page.status.replace(PageStatus::Failure { time: now() });
|
||||
page.title.replace(status.title());
|
||||
page.browser_action.update.activate(Some(&page.id));
|
||||
},
|
||||
},
|
||||
None => {
|
||||
let status = page.content.to_status_failure();
|
||||
status.set_description(Some("MIME type not found"));
|
||||
|
||||
page.status.replace(PageStatus::Failure { time: now() });
|
||||
page.title.replace(status.title());
|
||||
page.browser_action.update.activate(Some(&page.id));
|
||||
},
|
||||
}
|
||||
},
|
||||
// https://geminiprotocol.net/docs/protocol-specification.gmi#status-30-temporary-redirection
|
||||
Status::Redirect => todo!(),
|
||||
// https://geminiprotocol.net/docs/protocol-specification.gmi#status-31-permanent-redirection
|
||||
Status::PermanentRedirect => {
|
||||
page.navigation
|
||||
.request
|
||||
.widget
|
||||
.entry
|
||||
.set_text(&uri.to_string());
|
||||
todo!()
|
||||
},
|
||||
// https://geminiprotocol.net/docs/protocol-specification.gmi#status-60
|
||||
Status::CertificateRequest => {
|
||||
let status = page.content.to_status_identity();
|
||||
status.set_description(Some(&match response.meta.data {
|
||||
Some(data) => data.to_string(),
|
||||
None => Status::CertificateRequest.to_string(),
|
||||
}));
|
||||
|
||||
page.status.replace(PageStatus::Success { time: now() });
|
||||
page.title.replace(status.title());
|
||||
page.browser_action.update.activate(Some(&page.id));
|
||||
}
|
||||
// https://geminiprotocol.net/docs/protocol-specification.gmi#status-61-certificate-not-authorized
|
||||
Status::CertificateUnauthorized => {
|
||||
let status = page.content.to_status_identity();
|
||||
status.set_description(Some(&match response.meta.data {
|
||||
Some(data) => data.to_string(),
|
||||
None => Status::CertificateUnauthorized.to_string(),
|
||||
}));
|
||||
|
||||
page.status.replace(PageStatus::Success { time: now() });
|
||||
page.title.replace(status.title());
|
||||
page.browser_action.update.activate(Some(&page.id));
|
||||
}
|
||||
// https://geminiprotocol.net/docs/protocol-specification.gmi#status-62-certificate-not-valid
|
||||
Status::CertificateInvalid => {
|
||||
let status = page.content.to_status_identity();
|
||||
status.set_description(Some(&match response.meta.data {
|
||||
Some(data) => data.to_string(),
|
||||
None => Status::CertificateInvalid.to_string(),
|
||||
}));
|
||||
|
||||
page.status.replace(PageStatus::Success { time: now() });
|
||||
page.title.replace(status.title());
|
||||
page.browser_action.update.activate(Some(&page.id));
|
||||
}
|
||||
status => {
|
||||
let _status = page.content.to_status_failure();
|
||||
_status.set_description(Some(&format!("Undefined status code `{status}`")));
|
||||
|
||||
page.status.replace(PageStatus::Failure { time: now() });
|
||||
page.title.replace(_status.title());
|
||||
page.browser_action.update.activate(Some(&page.id));
|
||||
},
|
||||
}
|
||||
}
|
||||
Err(e) => {
|
||||
let status = page.content.to_status_failure();
|
||||
status.set_description(Some(&e.to_string()));
|
||||
|
||||
page.status.replace(PageStatus::Failure { time: now() });
|
||||
page.title.replace(status.title());
|
||||
page.browser_action.update.activate(Some(&page.id));
|
||||
},
|
||||
}
|
||||
},
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
/// 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) -> GString {
|
||||
let path = uri.path();
|
||||
if path.split('/').last().unwrap_or_default().is_empty() {
|
||||
match uri.host() {
|
||||
Some(host) => host,
|
||||
None => "Untitled".into(),
|
||||
}
|
||||
} else {
|
||||
path
|
||||
}
|
||||
}
|
||||
|
||||
/// Make new history record in related components
|
||||
/// * optional [Uri](https://docs.gtk.org/glib/struct.Uri.html) reference wanted only for performance reasons, to not parse it twice
|
||||
fn snap_history(page: &Page, uri: Option<&Uri>) {
|
||||
let request = page.navigation.request.widget.entry.text();
|
||||
|
||||
// Add new record into the global memory index (used in global menu)
|
||||
// * if the `Uri` is `None`, try parse it from `request`
|
||||
match uri {
|
||||
Some(uri) => page.profile.history.memory.request.set(uri.clone()),
|
||||
None => {
|
||||
// this case especially useful for some routes that contain redirects
|
||||
// maybe some parental optimization wanted @TODO
|
||||
if let Some(uri) = page.navigation.request.as_uri() {
|
||||
page.profile.history.memory.request.set(uri);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Add new record into the page navigation history
|
||||
if match page.navigation.history.current() {
|
||||
Some(current) => current != request, // apply additional filters
|
||||
None => true,
|
||||
} {
|
||||
page.navigation.history.add(request, true)
|
||||
}
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue