AV-98/av98.py

992 lines
35 KiB
Python
Raw Normal View History

2019-06-22 12:58:21 +00:00
#!/usr/bin/env python3
# AV-98 Gemini client
# (C) 2019 Solderpunk <solderpunk@sdf.org>
# Dervied from VF-1 (https://github.com/solderpunk/VF-1),
# which features contributions from:
# - Alex Schroeder <alex@gnu.org>
# - Joseph Lyman <tfurrows@sdf.org>
# - Adam Mayer (https://github.com/phooky)
# - Paco Estaban <paco@onna.be>
import argparse
import cmd
import cgi
2019-06-22 12:58:21 +00:00
import codecs
import collections
import fnmatch
import io
import mimetypes
import os.path
import random
import shlex
import shutil
import socket
import subprocess
import sys
import tempfile
import urllib.parse
import ssl
import time
# Command abbreviations
_ABBREVS = {
"a": "add",
"b": "back",
"bb": "blackbox",
"bm": "bookmarks",
"book": "bookmarks",
"f": "fold",
"fo": "forward",
"g": "go",
"h": "history",
"hist": "history",
"l": "less",
"n": "next",
"p": "previous",
"prev": "previous",
"q": "quit",
"r": "reload",
"s": "save",
"se": "search",
"/": "search",
"t": "tour",
"u": "up",
}
_MIME_HANDLERS = {
"application/pdf": "xpdf %s",
"audio/mpeg": "mpg123 %s",
"audio/ogg": "ogg123 %s",
"image/*": "feh %s",
"text/html": "lynx -dump -force_html %s",
"text/plain": "cat %s",
"text/gemini": "cat %s",
}
_ANSI_COLORS = {
"red": "\x1b[0;31m",
"green": "\x1b[0;32m",
"yellow": "\x1b[0;33m",
"blue": "\x1b[0;34m",
"purple": "\x1b[0;35m",
"cyan": "\x1b[0;36m",
"white": "\x1b[0;37m",
"black": "\x1b[0;30m",
}
_ITEMTYPE_COLORS = {
"0": _ANSI_COLORS["green"], # Text File
"1": _ANSI_COLORS["blue"], # Sub-menu
"7": _ANSI_COLORS["red"], # Search / Input
"8": _ANSI_COLORS["purple"], # Telnet
"9": _ANSI_COLORS["cyan"], # Binary
"g": _ANSI_COLORS["blue"], # Gif
"h": _ANSI_COLORS["green"], # HTML
"s": _ANSI_COLORS["cyan"], # Sound
"I": _ANSI_COLORS["cyan"], # Gif
"T": _ANSI_COLORS["purple"], # Telnet
}
CRLF = '\r\n'
# Lightweight representation of an item in Geminispace
GeminiItem = collections.namedtuple("GeminiItem",
("host", "port", "path", "name"))
def url_to_geminiitem(url, name=None):
# urllibparse.urlparse can handle IPv6 addresses, but only if they
# are formatted very carefully, in a way that users almost
# certainly won't expect. So, catch them early and try to fix
# them...
if url.count(":") > 2: # Best way to detect them?
url = fix_ipv6_url(url)
# Prepend a gemini schema if none given
if "://" not in url:
url = "gemini://" + url
u = urllib.parse.urlparse(url)
# https://tools.ietf.org/html/rfc4266#section-2.1
path = u.path
return GeminiItem(u.hostname, u.port or 1965, path, name)
def fix_ipv6_url(url):
# If there's a pair of []s in there, it's probably fine as is.
if "[" in url and "]" in url:
return url
# Easiest case is a raw address, no schema, no path.
# Just wrap it in square brackets and whack a slash on the end
if "/" not in url:
return "[" + url + "]/"
# Now the trickier cases...
if "://" in url:
schema, schemaless = url.split("://")
else:
schema, schemaless = None, url
if "/" in schemaless:
netloc, rest = schemaless.split("/",1)
schemaless = "[" + netloc + "]" + "/" + rest
if schema:
return schema + "://" + schemaless
return schemaless
def geminiitem_to_url(gi):
if gi and gi.host:
2019-08-11 19:25:48 +00:00
return ("gemini://%s:%d%s%s" % (
gi.host, int(gi.port), "" if gi.path.startswith("/") else "/",
gi.path))
2019-06-22 12:58:21 +00:00
elif gi:
return gi.path
else:
return ""
def geminiitem_from_line(line, menu_gi):
2019-07-21 21:02:18 +00:00
assert line.startswith("=>")
assert line[2:].strip()
bits = line[2:].strip().split(maxsplit=1)
link = bits[0]
name = bits[1] if len(bits) == 2 else link
2019-06-22 12:58:21 +00:00
if "://" in link:
return url_to_geminiitem(link, name)
else:
return GeminiItem(menu_gi.host, menu_gi.port, link, name)
def geminiitem_to_line(gi, name=""):
name = ((name or gi.name) or geminiitem_to_url(gi))
path = gi.path
2019-07-21 21:02:18 +00:00
return "=> %s %s" % (geminiitem_to_url(gi), name)
2019-06-22 12:58:21 +00:00
# Cheap and cheerful URL detector
def looks_like_url(word):
return "." in word and word.startswith("gemini://")
2019-06-22 12:58:21 +00:00
# Decorators
def needs_gi(inner):
def outer(self, *args, **kwargs):
if not self.gi:
print("You need to 'go' somewhere, first")
return None
else:
return inner(self, *args, **kwargs)
outer.__doc__ = inner.__doc__
return outer
class GeminiClient(cmd.Cmd):
def __init__(self):
cmd.Cmd.__init__(self)
self.prompt = "\x1b[38;5;202m" + "AV-98" + "\x1b[38;5;255m" + "> " + "\x1b[0m"
self.gi = None
self.history = []
self.hist_index = 0
self.idx_filename = ""
self.index = []
self.index_index = -1
self.lookup = self.index
self.marks = {}
self.mirrors = {}
self.page_index = 0
self.tmp_filename = ""
self.visited_hosts = set()
self.waypoints = []
self.options = {
"color_menus" : False,
"debug" : False,
"ipv6" : False,
"timeout" : 10,
}
self.log = {
"start_time": time.time(),
"requests": 0,
"ipv4_requests": 0,
"ipv6_requests": 0,
"bytes_recvd": 0,
"ipv4_bytes_recvd": 0,
"ipv6_bytes_recvd": 0,
"dns_failures": 0,
"refused_connections": 0,
"reset_connections": 0,
"timeouts": 0,
}
def _go_to_gi(self, gi, update_hist=True, handle=True):
"""This method might be considered "the heart of AV-98".
Everything involved in fetching a gemini resource happens here:
sending the request over the network, parsing the response if
its a menu, storing the response in a temporary file, choosing
and calling a handler program, and updating the history."""
# Do everything which touches the network in one block,
# so we only need to catch exceptions once
try:
# Is this a local file?
if not gi.host:
address, f = None, open(gi.path, "rb")
else:
address, f = self._send_request(gi)
# Attempt to decode something that is supposed to be text
# (which involves reading the entire file over the network
# first)
header = f.readline()
header = header.decode("UTF-8").strip()
self._debug("Response header: %s." % header)
body = f.read()
# Catch network errors which may be recoverable if a redundant
# mirror is specified
except (socket.gaierror, ConnectionRefusedError,
ConnectionResetError, TimeoutError, socket.timeout,
) as network_error:
# Print an error message
if isinstance(network_error, socket.gaierror):
self.log["dns_failures"] += 1
print("ERROR: DNS error!")
elif isinstance(network_error, ConnectionRefusedError):
self.log["refused_connections"] += 1
print("ERROR: Connection refused!")
elif isinstance(network_error, ConnectionResetError):
self.log["reset_connections"] += 1
print("ERROR: Connection reset!")
elif isinstance(network_error, (TimeoutError, socket.timeout)):
self.log["timeouts"] += 1
print("""ERROR: Connection timed out!
Slow internet connection? Use 'set timeout' to be more patient.""")
# Try to fall back on a redundant mirror
new_gi = self._get_mirror_gi(gi)
if new_gi:
print("Trying redundant mirror %s..." % geminiitem_to_url(new_gi))
self._go_to_gi(new_gi)
return
# Catch non-recoverable errors
except Exception as err:
print("ERROR: " + str(err))
return
2019-06-22 14:36:35 +00:00
# Look at what we got
status, mime = header.split("\t")
# Handle different statuses.
2019-08-08 18:23:58 +00:00
# Everything other than success
if status.startswith("2"):
2019-06-22 14:36:35 +00:00
if mime == "":
mime = "text/gemini; charset=utf-8"
mime, mime_options = cgi.parse_header(mime)
if "charset" in mime_options:
try:
codecs.lookup(mime_options["charset"])
except LookupError:
print("Header declared unknown encoding %s" % value)
return
2019-06-22 13:02:11 +00:00
# Handle redirects
2019-08-08 18:23:58 +00:00
elif status.startswith("3"):
2019-06-22 13:02:11 +00:00
self._debug("Following redirect to %s." % mime)
new_gi = GeminiItem(gi.host, gi.port, mime, None)
self._go_to_gi(new_gi)
return
2019-06-22 14:36:35 +00:00
# Not found
2019-08-08 18:23:58 +00:00
elif status.startswith("4") or status.startswith("5"):
print("Error: %s" % mime)
2019-06-22 13:02:11 +00:00
return
2019-08-08 18:23:58 +00:00
# If we're still here, this is a success and there's a response body
2019-06-22 14:36:35 +00:00
2019-06-22 12:58:21 +00:00
# Save the result in a temporary file
## Delete old file
if self.tmp_filename:
os.unlink(self.tmp_filename)
## Set file mode
if mime.startswith("text/"):
mode = "w"
encoding = mime_options.get("charset", "UTF-8")
try:
body = body.decode(encoding)
except UnicodeError:
print("Could not decode response body using %s encoding declared in header!" % encoding)
return
2019-06-22 12:58:21 +00:00
else:
mode = "wb"
encoding = None
## Write
tmpf = tempfile.NamedTemporaryFile(mode, encoding=encoding, delete=False)
size = tmpf.write(body)
tmpf.close()
self.tmp_filename = tmpf.name
self._debug("Wrote %d byte response to %s." % (size, self.tmp_filename))
# Pass file to handler, unless we were asked not to
if handle:
if mime == "text/gemini":
self._handle_index(body, gi)
else:
cmd_str = self._get_handler_cmd(mime)
try:
subprocess.call(shlex.split(cmd_str % tmpf.name))
except FileNotFoundError:
print("Handler program %s not found!" % shlex.split(cmd_str)[0])
print("You can use the ! command to specify another handler program or pipeline.")
# Update state
self.gi = gi
self.mime = mime
2019-06-22 12:58:21 +00:00
self._log_visit(gi, address, size)
if update_hist:
self._update_history(gi)
def _send_request(self, gi):
"""Send a selector to a given host and port.
Returns the resolved address and binary file with the reply."""
# DNS lookup - will get IPv4 and IPv6 records if IPv6 is enabled
if ":" in gi.host:
# This is likely a literal IPv6 address, so we can *only* ask for
# IPv6 addresses or getaddrinfo will complain
family_mask = socket.AF_INET6
elif socket.has_ipv6 and self.options["ipv6"]:
# Accept either IPv4 or IPv6 addresses
family_mask = 0
else:
# IPv4 only
family_mask = socket.AF_INET
addresses = socket.getaddrinfo(gi.host, gi.port, family=family_mask,
type=socket.SOCK_STREAM)
# Sort addresses so IPv6 ones come first
addresses.sort(key=lambda add: add[0] == socket.AF_INET6, reverse=True)
# Verify that this sort works
if any(add[0] == socket.AF_INET6 for add in addresses):
assert addresses[0][0] == socket.AF_INET6
# Connect to remote host by any address possible
err = None
for address in addresses:
self._debug("Connecting to: " + str(address[4]))
s = socket.socket(address[0], address[1])
s.settimeout(self.options["timeout"])
context = ssl.SSLContext()
context.check_hostname = False
context.verify_mode = ssl.CERT_NONE
s = context.wrap_socket(s, server_hostname = gi.host)
try:
s.connect(address[4])
break
except OSError as e:
err = e
else:
# If we couldn't connect to *any* of the addresses, just
# bubble up the exception from the last attempt and deny
# knowledge of earlier failures.
raise err
# Send request and wrap response in a file descriptor
2019-08-11 19:26:14 +00:00
url = geminiitem_to_url(gi)
self._debug("Sending %s<CRLF>" % url)
s.sendall((url + CRLF).encode("UTF-8"))
2019-06-22 12:58:21 +00:00
return address, s.makefile(mode = "rb")
def _get_handler_cmd(self, mimetype):
# Now look for a handler for this mimetype
# Consider exact matches before wildcard matches
exact_matches = []
wildcard_matches = []
for handled_mime, cmd_str in _MIME_HANDLERS.items():
if "*" in handled_mime:
wildcard_matches.append((handled_mime, cmd_str))
else:
exact_matches.append((handled_mime, cmd_str))
for handled_mime, cmd_str in exact_matches + wildcard_matches:
if fnmatch.fnmatch(mimetype, handled_mime):
break
else:
# Use "xdg-open" as a last resort.
cmd_str = "xdg-open %s"
self._debug("Using handler: %s" % cmd_str)
return cmd_str
def _handle_index(self, body, menu_gi):
self.index = []
if self.idx_filename:
os.unlink(self.idx_filename)
tmpf = tempfile.NamedTemporaryFile("w", encoding="UTF-8", delete=False)
self.idx_filename = tmpf.name
for line in body.splitlines():
2019-06-24 19:26:53 +00:00
line = line.strip()
2019-07-21 21:02:18 +00:00
if line.startswith("=>"):
2019-06-22 12:58:21 +00:00
try:
gi = geminiitem_from_line(line, menu_gi)
self.index.append(gi)
tmpf.write(self._format_geminiitem(len(self.index), gi) + "\n")
except:
self._debug("Skipping possible link: %s" % line)
else:
tmpf.write(line + "\n")
tmpf.close()
self.lookup = self.index
self.page_index = 0
self.index_index = -1
cmd_str = _MIME_HANDLERS["text/plain"]
subprocess.call(shlex.split(cmd_str % self.idx_filename))
def _format_geminiitem(self, index, gi, url=False):
line = "[%d] " % index
# Add item name
if gi.name:
line += gi.name
# Use URL in place of name if we didn't get here from a menu
else:
line += geminiitem_to_url(gi)
# Add URL if requested
if gi.name and url:
line += " (%s)" % geminiitem_to_url(gi)
return line
def _register_redundant_server(self, gi):
# This mirrors the last non-mirror item
target = self.index[-1]
target = (target.host, target.port, target.path)
if target not in self.mirrors:
self.mirrors[target] = []
self.mirrors[target].append((gi.host, gi.port, gi.path))
self._debug("Registered redundant mirror %s" % geminiitemi_to_url(gi))
def _get_mirror_gi(self, gi):
# Search for a redundant mirror that matches this GI
for (host, port, path_prefix), mirrors in self.mirrors.items():
if (host == gi.host and port == gi.port and
gi.path.startswith(path_prefix)):
break
else:
# If there are no mirrors, we're done
return None
# Pick a mirror at random and build a new GI for it
mirror_host, mirror_port, mirror_path = random.sample(mirrors, 1)[0]
new_gi = GeminiItem(mirror_host, mirror_port,
mirror_path + "/" + gi.path[len(path_prefix):],
gi.name)
return new_gi
def _show_lookup(self, offset=0, end=None, url=False):
for n, gi in enumerate(self.lookup[offset:end]):
print(self._format_geminiitem(n+offset+1, gi, url))
def _update_history(self, gi):
# Don't duplicate
if self.history and self.history[self.hist_index] == gi:
return
self.history = self.history[0:self.hist_index+1]
self.history.append(gi)
self.hist_index = len(self.history) - 1
def _log_visit(self, gi, address, size):
if not address:
return
self.log["requests"] += 1
self.log["bytes_recvd"] += size
self.visited_hosts.add(address)
if address[0] == socket.AF_INET:
self.log["ipv4_requests"] += 1
self.log["ipv4_bytes_recvd"] += size
elif address[0] == socket.AF_INET6:
self.log["ipv6_requests"] += 1
self.log["ipv6_bytes_recvd"] += size
def _get_active_tmpfile(self):
if self.mime == "text/gemini":
return self.idx_filename
else:
return self.tmp_filename
2019-06-22 12:58:21 +00:00
def _debug(self, debug_text):
if not self.options["debug"]:
return
debug_text = "\x1b[0;32m[DEBUG] " + debug_text + "\x1b[0m"
print(debug_text)
# Cmd implementation follows
def default(self, line):
if line.strip() == "EOF":
return self.onecmd("quit")
elif line.strip() == "..":
return self.do_up()
elif line.startswith("/"):
return self.do_search(line[1:])
# Expand abbreviated commands
first_word = line.split()[0].strip()
if first_word in _ABBREVS:
full_cmd = _ABBREVS[first_word]
expanded = line.replace(first_word, full_cmd, 1)
return self.onecmd(expanded)
# Try to parse numerical index for lookup table
try:
n = int(line.strip())
except ValueError:
print("What?")
return
try:
gi = self.lookup[n-1]
except IndexError:
print ("Index too high!")
return
self.index_index = n
self._go_to_gi(gi)
### Settings
def do_set(self, line):
"""View or set various options."""
if not line.strip():
# Show all current settings
for option in sorted(self.options.keys()):
print("%s %s" % (option, self.options[option]))
elif len(line.split()) == 1:
option = line.strip()
if option in self.options:
print("%s %s" % (option, self.options[option]))
else:
print("Unrecognised option %s" % option)
else:
option, value = line.split(" ", 1)
if option not in self.options:
print("Unrecognised option %s" % option)
return
elif value.isnumeric():
value = int(value)
elif value.lower() == "false":
value = False
elif value.lower() == "true":
value = True
else:
try:
value = float(value)
except ValueError:
pass
self.options[option] = value
def do_handler(self, line):
"""View or set handler commands for different MIME types."""
if not line.strip():
# Show all current handlers
for mime in sorted(_MIME_HANDLERS.keys()):
print("%s %s" % (mime, _MIME_HANDLERS[mime]))
elif len(line.split()) == 1:
mime = line.strip()
if mime in _MIME_HANDLERS:
print("%s %s" % (mime, _MIME_HANDLERS[mime]))
else:
print("No handler set for MIME type %s" % mime)
else:
mime, handler = line.split(" ", 1)
_MIME_HANDLERS[mime] = handler
if "%s" not in handler:
print("Are you sure you don't want to pass the filename to the handler?")
### Stuff for getting around
def do_go(self, line):
"""Go to a gemini URL or marked item."""
line = line.strip()
if not line:
print("Go where?")
# First, check for possible marks
elif line in self.marks:
gi = self.marks[line]
self._go_to_gi(gi)
# or a local file
elif os.path.exists(os.path.expanduser(line)):
gi = GeminiItem(None, None, os.path.expanduser(line),
"1", line, False)
self._go_to_gi(gi)
# If this isn't a mark, treat it as a URL
else:
url = line
gi = url_to_geminiitem(url)
self._go_to_gi(gi)
@needs_gi
def do_reload(self, *args):
"""Reload the current URL."""
self._go_to_gi(self.gi)
@needs_gi
def do_up(self, *args):
"""Go up one directory in the path."""
gi = self.gi
pathbits = os.path.split(self.gi.path)
new_path = os.path.join(*pathbits[0:-1])
new_gi = GeminiItem(gi.host, gi.port, new_path, "1", gi.name)
self._go_to_gi(new_gi)
def do_back(self, *args):
"""Go back to the previous gemini item."""
if not self.history or self.hist_index == 0:
return
self.hist_index -= 1
gi = self.history[self.hist_index]
self._go_to_gi(gi, update_hist=False)
def do_forward(self, *args):
"""Go forward to the next gemini item."""
if not self.history or self.hist_index == len(self.history) - 1:
return
self.hist_index += 1
gi = self.history[self.hist_index]
self._go_to_gi(gi, update_hist=False)
def do_next(self, *args):
"""Go to next item after current in index."""
return self.onecmd(str(self.index_index+1))
def do_previous(self, *args):
"""Go to previous item before current in index."""
self.lookup = self.index
return self.onecmd(str(self.index_index-1))
@needs_gi
def do_root(self, *args):
"""Go to root selector of the server hosting current item."""
2019-06-22 17:24:06 +00:00
gi = GeminiItem(self.gi.host, self.gi.port, "",
2019-06-22 12:58:21 +00:00
"Root of %s" % self.gi.host)
self._go_to_gi(gi)
def do_tour(self, line):
"""Add index items as waypoints on a tour, which is basically a FIFO
queue of gemini items.
Items can be added with `tour 1 2 3 4` or ranges like `tour 1-4`.
All items in current menu can be added with `tour *`.
Current tour can be listed with `tour ls` and scrubbed with `tour clear`."""
line = line.strip()
if not line:
# Fly to next waypoint on tour
if not self.waypoints:
print("End of tour.")
else:
gi = self.waypoints.pop(0)
self._go_to_gi(gi)
elif line == "ls":
old_lookup = self.lookup
self.lookup = self.waypoints
self._show_lookup()
self.lookup = old_lookup
elif line == "clear":
self.waypoints = []
elif line == "*":
self.waypoints.extend(self.lookup)
elif looks_like_url(line):
self.waypoints.append(url_to_geminiitem(line))
else:
for index in line.split():
try:
pair = index.split('-')
if len(pair) == 1:
# Just a single index
n = int(index)
gi = self.lookup[n-1]
self.waypoints.append(gi)
elif len(pair) == 2:
# Two endpoints for a range of indices
for n in range(int(pair[0]), int(pair[1]) + 1):
gi = self.lookup[n-1]
self.waypoints.append(gi)
else:
# Syntax error
print("Invalid use of range syntax %s, skipping" % index)
except ValueError:
print("Non-numeric index %s, skipping." % index)
except IndexError:
print("Invalid index %d, skipping." % n)
@needs_gi
def do_mark(self, line):
"""Mark the current item with a single letter. This letter can then
be passed to the 'go' command to return to the current item later.
Think of it like marks in vi: 'mark a'='ma' and 'go a'=''a'."""
line = line.strip()
if not line:
for mark, gi in self.marks.items():
print("[%s] %s (%s)" % (mark, gi.name, geminiitem_to_url(gi)))
elif line.isalpha() and len(line) == 1:
self.marks[line] = self.gi
else:
print("Invalid mark, must be one letter")
### Stuff that modifies the lookup table
def do_ls(self, line):
"""List contents of current index.
Use 'ls -l' to see URLs."""
self.lookup = self.index
self._show_lookup(url = "-l" in line)
self.page_index = 0
def do_history(self, *args):
"""Display history."""
self.lookup = self.history
self._show_lookup(url=True)
self.page_index = 0
def do_search(self, searchterm):
"""Search index (case insensitive)."""
results = [
gi for gi in self.lookup if searchterm.lower() in gi.name.lower()]
if results:
self.lookup = results
self._show_lookup()
self.page_index = 0
else:
print("No results found.")
def emptyline(self):
"""Page through index ten lines at a time."""
i = self.page_index
if i > len(self.lookup):
return
self._show_lookup(offset=i, end=i+10)
self.page_index += 10
### Stuff that does something to most recently viewed item
@needs_gi
def do_cat(self, *args):
"""Run most recently visited item through "cat" command."""
subprocess.call(shlex.split("cat %s" % self._get_active_tmpfile()))
@needs_gi
def do_less(self, *args):
"""Run most recently visited item through "less" command."""
cmd_str = self._get_handler_cmd(self.mime)
2019-06-22 12:58:21 +00:00
cmd_str = cmd_str % self._get_active_tmpfile()
subprocess.call("%s | less -R" % cmd_str, shell=True)
@needs_gi
def do_fold(self, *args):
"""Run most recently visited item through "fold" command."""
cmd_str = self._get_handler_cmd(self.mime)
2019-06-22 12:58:21 +00:00
cmd_str = cmd_str % self._get_active_tmpfile()
subprocess.call("%s | fold -w 70 -s" % cmd_str, shell=True)
@needs_gi
def do_shell(self, line):
"""'cat' most recently visited item through a shell pipeline."""
subprocess.call(("cat %s |" % self._get_active_tmpfile()) + line, shell=True)
@needs_gi
def do_save(self, line):
"""Save an item to the filesystem.
'save n filename' saves menu item n to the specified filename.
'save filename' saves the last viewed item to the specified filename.
'save n' saves menu item n to an automagic filename."""
args = line.strip().split()
# First things first, figure out what our arguments are
if len(args) == 0:
# No arguments given at all
# Save current item, if there is one, to a file whose name is
# inferred from the gemini path
if not self.tmp_filename:
print("You need to visit an item first!")
return
else:
index = None
filename = None
elif len(args) == 1:
# One argument given
# If it's numeric, treat it as an index, and infer the filename
try:
index = int(args[0])
filename = None
# If it's not numeric, treat it as a filename and
# save the current item
except ValueError:
index = None
filename = os.path.expanduser(args[0])
elif len(args) == 2:
# Two arguments given
# Treat first as an index and second as filename
index, filename = args
try:
index = int(index)
except ValueError:
print("First argument is not a valid item index!")
return
filename = os.path.expanduser(filename)
else:
print("You must provide an index, a filename, or both.")
return
# Next, fetch the item to save, if it's not the current one.
if index:
last_gi = self.gi
try:
gi = self.lookup[index-1]
self._go_to_gi(gi, update_hist = False, handle = False)
except IndexError:
print ("Index too high!")
self.gi = last_gi
return
else:
gi = self.gi
# Derive filename from current GI's path, if one hasn't been set
if not filename:
filename = os.path.basename(gi.path)
# Check for filename collisions and actually do the save if safe
if os.path.exists(filename):
print("File %s already exists!" % filename)
else:
# Don't use _get_active_tmpfile() here, because we want to save the
# "source code" of menus, not the rendered view - this way AV-98
# can navigate to it later.
shutil.copyfile(self.tmp_filename, filename)
print("Saved to %s" % filename)
# Restore gi if necessary
if index != None:
self._go_to_gi(last_gi, handle=False)
@needs_gi
def do_url(self, *args):
"""Print URL of most recently visited item."""
print(geminiitem_to_url(self.gi))
### Bookmarking stuff
@needs_gi
def do_add(self, line):
"""Add the current URL to the bookmarks menu.
Bookmarks are stored in the ~/.av98-bookmarks.txt file.
Optionally, specify the new name for the bookmark."""
with open(os.path.expanduser("~/.av98-bookmarks.txt"), "a") as fp:
fp.write(geminiitem_to_line(self.gi, name=line))
def do_bookmarks(self, *args):
"""Show the current bookmarks menu.
Bookmarks are stored in the ~/.av98-bookmarks.txt file."""
file_name = "~/.av98-bookmarks.txt"
if not os.path.isfile(os.path.expanduser(file_name)):
print("You need to 'add' some bookmarks, first")
else:
gi = GeminiItem(None, None, os.path.expanduser(file_name),
2019-08-08 18:23:58 +00:00
file_name)
2019-06-22 12:58:21 +00:00
self._go_to_gi(gi)
### Help
def do_help(self, arg):
"""ALARM! Recursion detected! ALARM! Prepare to eject!"""
if arg == "!":
print("! is an alias for 'shell'")
elif arg == "?":
print("? is an alias for 'help'")
else:
cmd.Cmd.do_help(self, arg)
### Flight recorder
def do_blackbox(self, *args):
"""Display contents of flight recorder, showing statistics for the
current gemini browsing session."""
lines = []
# Compute flight time
now = time.time()
delta = now - self.log["start_time"]
hours, remainder = divmod(delta, 36060)
minutes, seconds = divmod(remainder, 60)
# Count hosts
ipv4_hosts = len([host for host in self.visited_hosts if host[0] == socket.AF_INET])
ipv6_hosts = len([host for host in self.visited_hosts if host[0] == socket.AF_INET6])
# Assemble lines
lines.append(("Flight duration", "%02d:%02d:%02d" % (hours, minutes, seconds)))
lines.append(("Requests sent:", self.log["requests"]))
lines.append((" IPv4 requests:", self.log["ipv4_requests"]))
lines.append((" IPv6 requests:", self.log["ipv6_requests"]))
lines.append(("Bytes received:", self.log["bytes_recvd"]))
lines.append((" IPv4 bytes:", self.log["ipv4_bytes_recvd"]))
lines.append((" IPv6 bytes:", self.log["ipv6_bytes_recvd"]))
lines.append(("Unique hosts visited:", len(self.visited_hosts)))
lines.append((" IPv4 hosts:", ipv4_hosts))
lines.append((" IPv6 hosts:", ipv6_hosts))
lines.append(("DNS failures:", self.log["dns_failures"]))
lines.append(("Timeouts:", self.log["timeouts"]))
lines.append(("Refused connections:", self.log["refused_connections"]))
lines.append(("Reset connections:", self.log["reset_connections"]))
# Print
for key, value in lines:
print(key.ljust(24) + str(value).rjust(8))
### The end!
def do_quit(self, *args):
"""Exit AV-98."""
# Clean up after ourself
if self.tmp_filename:
os.unlink(self.tmp_filename)
if self.idx_filename:
os.unlink(self.idx_filename)
print()
print("Thank you for flying AV-98!")
sys.exit()
do_exit = do_quit
# Config file finder
def get_rcfile():
rc_paths = ("~/.config/av98/av98rc", "~/.config/.av98rc", "~/.av98rc")
for rc_path in rc_paths:
rcfile = os.path.expanduser(rc_path)
if os.path.exists(rcfile):
return rcfile
return None
# Main function
def main():
# Parse args
parser = argparse.ArgumentParser(description='A command line gemini client.')
parser.add_argument('--bookmarks', action='store_true',
help='start with your list of bookmarks')
parser.add_argument('url', metavar='URL', nargs='*',
help='start with this URL')
args = parser.parse_args()
# Instantiate client
gc = GeminiClient()
# Process config file
rcfile = get_rcfile()
if rcfile:
print("Using config %s" % rcfile)
with open(rcfile, "r") as fp:
for line in fp:
line = line.strip()
if ((args.bookmarks or args.url) and
any((line.startswith(x) for x in ("go", "g", "tour", "t")))
):
if args.bookmarks:
print("Skipping rc command \"%s\" due to --bookmarks option." % line)
else:
print("Skipping rc command \"%s\" due to provided URLs." % line)
continue
gc.cmdqueue.append(line)
# Say hi
print("Welcome to AV-98!")
print("Enjoy your patrol through Geminispace...")
# Act on args
if args.bookmarks:
gc.cmdqueue.append("bookmarks")
elif args.url:
if len(args.url) == 1:
gc.cmdqueue.append("go %s" % args.url[0])
else:
for url in args.url:
if not url.startswith("gemini://"):
url = "gemini://" + url
gc.cmdqueue.append("tour %s" % url)
gc.cmdqueue.append("tour")
# Endless interpret loop
while True:
try:
gc.cmdloop()
except KeyboardInterrupt:
print("")
if __name__ == '__main__':
main()