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
use super::{Feature, Page};
use ggemini::client::connection::response::{
failure::{Permanent, Temporary},
Certificate, Failure, Input, Redirect,
};
use ggemini::{
client::{Client, Request, Response},
gio::{file_output_stream, memory_input_stream},
};
use gtk::{
gdk::Texture,
gdk_pixbuf::Pixbuf,
gio::{Cancellable, SocketClientEvent},
glib::{Priority, Uri},
prelude::{FileExt, SocketClientExt},
};
use sourceview::prelude::InputStreamExtManual;
use std::{cell::Cell, path::MAIN_SEPARATOR, rc::Rc, time::Duration};
/// [Gemini protocol](https://geminiprotocol.net/docs/protocol-specification.gmi) client driver
pub struct Gemini {
/// Should be initiated once
client: Rc<Client>,
/// Validate redirection count by Gemini protocol specification
redirects: Rc<Cell<usize>>,
/// Handle target
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.set_progress(match event {
// 0.1 reserved for handle begin
SocketClientEvent::Resolving => 0.2,
SocketClientEvent::Resolved => 0.3,
SocketClientEvent::Connecting => 0.4,
SocketClientEvent::Connected => 0.5,
SocketClientEvent::ProxyNegotiating => 0.6,
SocketClientEvent::ProxyNegotiated => 0.7,
// * `TlsHandshaking` | `TlsHandshaked` has effect only for guest connections!
SocketClientEvent::TlsHandshaking => 0.8,
SocketClientEvent::TlsHandshaked => 0.9,
SocketClientEvent::Complete => 1.0,
_ => todo!(), // alert on API change
})
}
});
Self {
client,
redirects: Rc::new(Cell::new(0)),
page: page.clone(),
}
}
// Actions
pub fn handle(&self, uri: Uri, feature: Rc<Feature>, cancellable: Cancellable) {
use ggemini::client::connection::Request;
match uri.scheme().as_str() {
"gemini" => handle(
Request::Gemini { uri },
self.client.clone(),
self.page.clone(),
self.redirects.clone(),
feature,
cancellable,
None,
),
"titan" => {
self.page.input.set_new_titan({
let client = self.client.clone();
let page = self.page.clone();
let redirects = self.redirects.clone();
move |header, bytes, on_failure| {
handle(
Request::Titan {
uri: uri.clone(),
data: bytes,
mime: header.mime.map(|mime| mime.into()),
token: header.token.map(|token| token.into()),
},
client.clone(),
page.clone(),
redirects.clone(),
feature.clone(),
cancellable.clone(),
Some(on_failure),
)
}
});
self.page.set_title("Titan input");
self.page.set_progress(0.0);
}
_ => panic!(), // unexpected
}
}
}
fn handle(
request: Request,
client: Rc<Client>,
page: Rc<Page>,
redirects: Rc<Cell<usize>>,
feature: Rc<Feature>,
cancellable: Cancellable,
on_failure: Option<Box<dyn Fn()>>,
) {
let uri = request.uri().clone();
client.request_async(
request,
Priority::DEFAULT,
cancellable.clone(),
// Search for user certificate match request
// * @TODO this feature does not support multi-protocol yet
match page
.profile
.identity
.get(&uri.to_string())
{
Some(identity) => match identity.to_tls_certificate() {
Ok(certificate) => Some(certificate),
Err(_) => panic!(), // unexpected
},
None => None,
},
{
let page = page.clone();
let redirects = redirects.clone();
move |result| match result {
Ok((response, connection)) => match response {
// https://geminiprotocol.net/docs/protocol-specification.gmi#input-expected
Response::Input(input) => {
let title = input.to_string();
page.set_progress(0.0);
page.set_title(&title);
redirects.replace(0); // reset
match input {
// https://geminiprotocol.net/docs/protocol-specification.gmi#status-10
Input::Default { message } => page.input.set_new_response(
page.item_action.clone(),
uri,
Some(message.as_ref().unwrap_or(&title)),
Some(1024),
),
// https://geminiprotocol.net/docs/protocol-specification.gmi#status-11-sensitive-input
Input::Sensitive { message } => page.input.set_new_sensitive(
page.item_action.clone(),
uri,
Some(message.as_ref().unwrap_or(&title)),
Some(1024),
)
}
}
// https://geminiprotocol.net/docs/protocol-specification.gmi#status-20
Response::Success(success) => match *feature {
Feature::Download => {
// Init download widget
let status = page.content.to_status_download(
crate::tool::uri_to_title(&uri).trim_matches(MAIN_SEPARATOR), // grab default filename from base URI,
// format FS entities
&cancellable,
{
let cancellable = cancellable.clone();
let stream = connection.stream();
move |file, action| {
match file.replace(
None,
false,
gtk::gio::FileCreateFlags::NONE,
Some(&cancellable),
) {
Ok(file_output_stream) => {
use crate::tool::Format;
// 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
file_output_stream::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 {}...",
total.bytes()
))
},
// on complete
{
let action = action.clone();
move |result| match result {
Ok((_, total)) => {
action.complete.activate(&format!(
"Saved to {} ({} total)",
file.parse_name(),
total.bytes()
))
}
Err(e) => action.cancel.activate(&e.to_string())
}
},
),
)
}
Err(e) => action.cancel.activate(&e.to_string()),
}
}
},
);
page.set_progress(0.0);
page.set_title(&status.title());
redirects.replace(0); // reset
},
_ => match success.mime() {
"text/gemini" | "text/plain" => memory_input_stream::from_stream_async(
connection.stream(),
Priority::DEFAULT,
cancellable.clone(),
(
0x400, // 1024 chunk
0xfffff, // 1M limit
),
(
|_, _| {}, // on chunk (maybe nothing to count yet @TODO)
move |result| match result { // on complete
Ok((memory_input_stream, total)) => memory_input_stream.read_all_async(
vec![0;total],
Priority::DEFAULT,
Some(&cancellable),
move |result| match result {
Ok((buffer, _ ,_)) => match std::str::from_utf8(&buffer) {
Ok(data) => {
let widget = if matches!(*feature, Feature::Source) {
page.content.to_text_source(data)
} else {
match success.mime() {
"text/gemini" => page.content.to_text_gemini(&uri, data),
"text/plain" => page.content.to_text_plain(data),
_ => panic!() // unexpected
}
};
page.search.set(Some(widget.text_view));
page.set_title(&match widget.meta.title {
Some(title) => title.into(), // @TODO
None => crate::tool::uri_to_title(&uri),
});
page.set_progress(0.0);
page.window_action
.find
.simple_action
.set_enabled(true);
redirects.replace(0); // reset
},
Err(e) => {
let status = page.content.to_status_failure();
status.set_description(Some(&e.to_string()));
page.set_progress(0.0);
page.set_title(&status.title());
redirects.replace(0); // reset
},
},
Err((_, e)) => {
let status = page.content.to_status_failure();
status.set_description(Some(&e.to_string()));
page.set_progress(0.0);
page.set_title(&status.title());
redirects.replace(0); // reset
}
}
),
Err(e) => {
let status = page.content.to_status_failure();
status.set_description(Some(&e.to_string()));
page.set_progress(0.0);
page.set_title(&status.title());
redirects.replace(0); // reset
},
}
)
),
"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
memory_input_stream::from_stream_async(
connection.stream(),
Priority::DEFAULT,
cancellable.clone(),
(
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| 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| {
match result {
Ok(buffer) => {
page.set_title(&crate::tool::uri_to_title(&uri));
page.content.to_image(&Texture::for_pixbuf(&buffer));
}
Err(e) => {
let status = page.content.to_status_failure();
status.set_description(Some(e.message()));
page.set_title(&status.title());
}
}
page.set_progress(0.0);
redirects.replace(0); // reset
},
)
}
Err(e) => {
let status = page.content.to_status_failure();
status.set_description(Some(&e.to_string()));
page.set_progress(0.0);
page.set_title(&status.title());
redirects.replace(0); // reset
}
}
}
),
)
}
mime => {
let status = page
.content
.to_status_mime(mime, Some((&page.item_action, &uri)));
status.set_description(Some(&format!("Content type `{mime}` yet not supported")));
page.set_progress(0.0);
page.set_title(&status.title());
redirects.replace(0); // reset
},
}
},
// https://geminiprotocol.net/docs/protocol-specification.gmi#status-30-temporary-redirection
// https://geminiprotocol.net/docs/protocol-specification.gmi#status-31-permanent-redirection
Response::Redirect(redirect) => match redirect.to_uri(&uri) {
Ok(target) => {
// Increase client redirection counter
let total = redirects.take() + 1;
// > Client MUST limit the number of redirections they follow to 5 redirections
// > https://geminiprotocol.net/docs/protocol-specification.gmi#redirection
if total > 5 {
let status = page.content.to_status_failure();
status.set_description(Some("Redirection limit reached"));
page.set_progress(0.0);
page.set_title(&status.title());
redirects.replace(0); // reset
/* @TODO can't find that in specification, implement manual confirmation status page:
// Disallow external redirection by protocol restrictions
} else if "gemini" != target.scheme()
|| uri.port() != target.port()
|| uri.host() != target.host() {
let status = page.content.to_status_failure();
status.set_description(Some("External redirects not allowed by protocol specification"));
page.set_progress(0.0);
page.set_title(&status.title());
redirects.replace(0); // reset
*/
// Valid
} else {
if matches!(redirect, Redirect::Permanent { .. }) {
page.navigation.set_request(&target.to_string());
}
redirects.replace(total);
page.item_action.load.activate(Some(&target.to_string()), false);
}
}
Err(e) => {
let status = page.content.to_status_failure();
status.set_description(Some(&e.to_string()));
page.set_progress(0.0);
page.set_title(&status.title());
redirects.replace(0); // reset
}
}
Response::Certificate(ref certificate) => match certificate {
// https://geminiprotocol.net/docs/protocol-specification.gmi#status-60
Certificate::Required { message } |
// https://geminiprotocol.net/docs/protocol-specification.gmi#status-61-certificate-not-authorized
Certificate::NotAuthorized { message } |
// https://geminiprotocol.net/docs/protocol-specification.gmi#status-62-certificate-not-valid
Certificate::NotValid { message } => {
let status = page.content.to_status_identity();
status.set_description(Some(message.as_ref().unwrap_or(&certificate.to_string())));
page.set_progress(0.0);
page.set_title(&status.title());
redirects.replace(0); // reset
}
}
Response::Failure(failure) => match failure {
Failure::Temporary(ref temporary) => match temporary {
Temporary::CgiError { message } |
Temporary::Default { message } |
Temporary::ProxyError { message } |
Temporary::ServerUnavailable { message } |
Temporary::SlowDown { message } => {
let status = page.content.to_status_failure();
status.set_description(Some(message.as_ref().unwrap_or(&temporary.to_string())));
page.set_progress(0.0);
page.set_title(&status.title());
redirects.replace(0); // reset
if let Some(callback) = on_failure {
callback()
}
}
}
Failure::Permanent(ref permanent) => match permanent {
Permanent::BadRequest { message } |
Permanent::Default { message } |
Permanent::Gone { message } |
Permanent::NotFound { message } |
Permanent::ProxyRequestRefused { message } => {
let status = page.content.to_status_failure();
status.set_description(Some(message.as_ref().unwrap_or(&permanent.to_string())));
page.set_progress(0.0);
page.set_title(&status.title());
redirects.replace(0); // reset
if let Some(callback) = on_failure {
callback()
}
}
}
}
}
Err(e) => {
let status = page.content.to_status_failure();
status.set_description(Some(&e.to_string()));
page.set_progress(0.0);
page.set_title(&status.title());
redirects.replace(0); // reset
}
}
},
)
}