4192 lines
166 KiB
Python
Executable File
4192 lines
166 KiB
Python
Executable File
#!/usr/bin/env python3
|
||
# Offpunk Offline Gemini client
|
||
# Derived from AV-98 by Solderpunk,
|
||
# (C) 2021, 2022 Ploum <offpunk@ploum.eu>
|
||
# (C) 2019, 2020 Solderpunk <solderpunk@sdf.org>
|
||
# With contributions from:
|
||
# - danceka <hannu.hartikainen@gmail.com>
|
||
# - <jprjr@tilde.club>
|
||
# - <vee@vnsf.xyz>
|
||
# - Klaus Alexander Seistrup <klaus@seistrup.dk>
|
||
# - govynnus <govynnus@sdf.org>
|
||
# - Björn Wärmedal <bjorn.warmedal@gmail.com>
|
||
# - <jake@rmgr.dev>
|
||
|
||
_VERSION = "1.2"
|
||
global BETA
|
||
BETA = False
|
||
|
||
import argparse
|
||
import cmd
|
||
import cgi
|
||
import codecs
|
||
import datetime
|
||
import fnmatch
|
||
import getpass
|
||
import glob
|
||
import hashlib
|
||
import io
|
||
import mimetypes
|
||
import os
|
||
import os.path
|
||
import filecmp
|
||
import random
|
||
import shlex
|
||
import shutil
|
||
import socket
|
||
import sqlite3
|
||
import ssl
|
||
from ssl import CertificateError
|
||
import sys
|
||
import tempfile
|
||
import time
|
||
import urllib.parse
|
||
import uuid
|
||
import webbrowser
|
||
import html
|
||
import subprocess
|
||
def run(cmd,direct_output=False):
|
||
if not direct_output:
|
||
result = subprocess.check_output(cmd,shell=True)
|
||
return result.decode()
|
||
else:
|
||
subprocess.run(cmd,shell=True)
|
||
|
||
try:
|
||
import setproctitle
|
||
setproctitle.setproctitle("offpunk")
|
||
_HAS_SETPROCTITLE = True
|
||
except ModuleNotFoundError:
|
||
_HAS_SETPROCTITLE = False
|
||
|
||
import textwrap
|
||
|
||
global TERM_WIDTH
|
||
TERM_WIDTH = 80
|
||
|
||
def term_width():
|
||
width = TERM_WIDTH
|
||
cur = shutil.get_terminal_size()[0]
|
||
if cur < width:
|
||
width = cur
|
||
return width
|
||
|
||
try:
|
||
from PIL import Image
|
||
_HAS_PIL = True
|
||
except ModuleNotFoundError:
|
||
_HAS_PIL = False
|
||
_HAS_TIMG = shutil.which('timg')
|
||
_HAS_CHAFA = shutil.which('chafa')
|
||
_NEW_CHAFA = False
|
||
|
||
# All this code to know if we render image inline or not
|
||
if _HAS_CHAFA:
|
||
# starting with 1.10, chafa can return only one frame
|
||
# which allows us to drop dependancy for PIL
|
||
output = run("chafa --version")
|
||
# with chafa < 1.10, --version was returned to stderr instead of stdout.
|
||
if output != '':
|
||
_NEW_CHAFA = True
|
||
if _NEW_CHAFA :
|
||
_RENDER_IMAGE = True
|
||
elif _HAS_TIMG :
|
||
_RENDER_IMAGE = True
|
||
elif _HAS_CHAFA and _HAS_PIL:
|
||
_RENDER_IMAGE = True
|
||
else:
|
||
_RENDER_IMAGE = False
|
||
print("To render images inline, you need either chafa or timg.")
|
||
if not _NEW_CHAFA and not _HAS_TIMG:
|
||
print("Before Chafa 1.10, you also need python-pil")
|
||
|
||
#return ANSI text that can be show by less
|
||
def inline_image(img_file,width):
|
||
#Chafa is faster than timg inline. Let use that one by default
|
||
inline = None
|
||
ansi_img = ""
|
||
if _HAS_CHAFA:
|
||
if _HAS_PIL and not _NEW_CHAFA:
|
||
# this code is a hack to remove frames from animated gif
|
||
img_obj = Image.open(img_file)
|
||
if hasattr(img_obj,"n_frames") and img_obj.n_frames > 1:
|
||
# we remove all frames but the first one
|
||
img_obj.save(img_file,format="gif",save_all=False)
|
||
inline = "chafa --bg white -s %s -f symbols"
|
||
elif _NEW_CHAFA:
|
||
inline = "chafa --bg white -s %s -f symbols --animate=off"
|
||
if not inline and _HAS_TIMG:
|
||
inline = "timg --frames=1 -p q -g %sx1000"
|
||
if inline:
|
||
cmd = inline%width+ " \"%s\""%img_file
|
||
try:
|
||
ansi_img = run(cmd)
|
||
except Exception as err:
|
||
ansi_img = "***image failed : %s***\n" %err
|
||
return ansi_img
|
||
|
||
def terminal_image(img_file):
|
||
#Render by timg is better than old chafa.
|
||
# it is also centered
|
||
cmd = None
|
||
if _HAS_TIMG:
|
||
cmd = "timg --loops=1 -C"
|
||
elif _HAS_CHAFA:
|
||
cmd = "chafa -d 0 --bg white -w 1"
|
||
if cmd:
|
||
cmd = cmd + " \"%s\""%img_file
|
||
run(cmd,direct_output=True)
|
||
|
||
|
||
_HAS_XSEL = shutil.which('xsel')
|
||
_HAS_XDGOPEN = shutil.which('xdg-open')
|
||
try:
|
||
from cryptography import x509
|
||
from cryptography.hazmat.backends import default_backend
|
||
_HAS_CRYPTOGRAPHY = True
|
||
_BACKEND = default_backend()
|
||
except ModuleNotFoundError:
|
||
_HAS_CRYPTOGRAPHY = False
|
||
|
||
try:
|
||
import requests
|
||
_DO_HTTP = True
|
||
except ModuleNotFoundError:
|
||
_DO_HTTP = False
|
||
|
||
try:
|
||
from readability import Document
|
||
_HAS_READABILITY = True
|
||
except ModuleNotFoundError:
|
||
_HAS_READABILITY = False
|
||
|
||
try:
|
||
from bs4 import BeautifulSoup
|
||
from bs4 import Comment
|
||
_HAS_SOUP = True
|
||
except ModuleNotFoundError:
|
||
_HAS_SOUP = False
|
||
|
||
_DO_HTML = _HAS_SOUP and _HAS_READABILITY
|
||
|
||
try:
|
||
import feedparser
|
||
_DO_FEED = True
|
||
except ModuleNotFoundError:
|
||
_DO_FEED = False
|
||
|
||
## Config directories
|
||
## We implement our own python-xdg to avoid conflict with existing libraries.
|
||
_home = os.path.expanduser('~')
|
||
data_home = os.environ.get('XDG_DATA_HOME') or \
|
||
os.path.join(_home,'.local','share')
|
||
config_home = os.environ.get('XDG_CONFIG_HOME') or \
|
||
os.path.join(_home,'.config')
|
||
cache_home = os.environ.get('XDG_CACHE_HOME') or\
|
||
os.path.join(_home,'.cache')
|
||
_CACHE_PATH = os.path.join(cache_home,"offpunk/")
|
||
_CONFIG_DIR = os.path.join(config_home,"offpunk/")
|
||
_DATA_DIR = os.path.join(data_home,"offpunk/")
|
||
_old_config = os.path.expanduser("~/.offpunk/")
|
||
## Look for pre-existing config directory, if any
|
||
if os.path.exists(_old_config):
|
||
_CONFIG_DIR = _old_config
|
||
#if no XDG .local/share and not XDG .config, we use the old config
|
||
if not os.path.exists(data_home) and os.path.exists(_old_config):
|
||
_DATA_DIR = _CONFIG_DIR
|
||
for f in [_CONFIG_DIR, _CACHE_PATH, _DATA_DIR]:
|
||
if not os.path.exists(f):
|
||
print("Creating config directory {}".format(f))
|
||
os.makedirs(f)
|
||
|
||
_MAX_REDIRECTS = 5
|
||
_MAX_CACHE_SIZE = 10
|
||
_MAX_CACHE_AGE_SECS = 180
|
||
|
||
_GREP = "grep"
|
||
if shutil.which("rg"):
|
||
_GREP = "rg"
|
||
less_version = 0
|
||
if not shutil.which("less"):
|
||
print("Please install the pager \"less\" to run Offpunk.")
|
||
print("If you wish to use another pager, send your request to offpunk@ploum.eu.")
|
||
print("(I’m really curious to hear about people not having \"less\" on their system.)")
|
||
sys.exit()
|
||
output = run("less --version")
|
||
# We get less Version (which is the only integer on the first line)
|
||
words = output.split("\n")[0].split()
|
||
less_version = 0
|
||
for w in words:
|
||
if w.isdigit():
|
||
less_version = int(w)
|
||
# restoring position only works for version of less > 572
|
||
if less_version >= 572:
|
||
_LESS_RESTORE_POSITION = True
|
||
else:
|
||
_LESS_RESTORE_POSITION = False
|
||
#_DEFAULT_LESS = "less -EXFRfM -PMurl\ lines\ \%lt-\%lb/\%L\ \%Pb\%$ %s"
|
||
# -E : quit when reaching end of file (to behave like "cat")
|
||
# -F : quit if content fits the screen (behave like "cat")
|
||
# -X : does not clear the screen
|
||
# -R : interpret ANSI colors correctly
|
||
# -f : suppress warning for some contents
|
||
# -M : long prompt (to have info about where you are in the file)
|
||
# -W : hilite the new first line after a page skip (space)
|
||
# -i : ignore case in search
|
||
# -S : do not wrap long lines. Wrapping is done by offpunk, longlines
|
||
# are there on purpose (surch in asciiart)
|
||
#--incsearch : incremental search starting rev581
|
||
if less_version >= 581:
|
||
less_base = "less --incsearch --save-marks -~ -XRfMWiS"
|
||
elif less_version >= 572:
|
||
less_base = "less --save-marks -XRfMWiS"
|
||
else:
|
||
less_base = "less -XRfMWiS"
|
||
_DEFAULT_LESS = less_base + " \"+''\" %s"
|
||
_DEFAULT_CAT = less_base + " -EF %s"
|
||
def less_cmd(file, histfile=None,cat=False,grep=None):
|
||
if histfile:
|
||
prefix = "LESSHISTFILE=%s "%histfile
|
||
else:
|
||
prefix = ""
|
||
if cat:
|
||
cmd_str = prefix + _DEFAULT_CAT % file
|
||
elif grep:
|
||
grep_cmd = _GREP
|
||
#case insensitive for lowercase search
|
||
if grep.islower():
|
||
grep_cmd += " -i"
|
||
cmd_str = prefix + _DEFAULT_CAT % file + "|" + grep_cmd + " %s"%grep
|
||
else:
|
||
cmd_str = prefix + _DEFAULT_LESS % file
|
||
run(cmd_str,direct_output=True)
|
||
|
||
|
||
# Command abbreviations
|
||
_ABBREVS = {
|
||
"a": "add",
|
||
"b": "back",
|
||
"bb": "blackbox",
|
||
"bm": "bookmarks",
|
||
"book": "bookmarks",
|
||
"cp": "copy",
|
||
"f": "forward",
|
||
"g": "go",
|
||
"h": "history",
|
||
"hist": "history",
|
||
"l": "view",
|
||
"less": "view",
|
||
"man": "help",
|
||
"mv": "move",
|
||
"n": "next",
|
||
"off": "offline",
|
||
"on": "online",
|
||
"p": "previous",
|
||
"prev": "previous",
|
||
"q": "quit",
|
||
"r": "reload",
|
||
"s": "save",
|
||
"se": "search",
|
||
"/": "search",
|
||
"t": "tour",
|
||
"u": "up",
|
||
"v": "view",
|
||
}
|
||
|
||
_MIME_HANDLERS = {
|
||
"application/pdf": "zathura %s",
|
||
"audio/mpeg": "mpg123 %s",
|
||
"audio/ogg": "ogg123 %s",
|
||
"image/*": "feh -. %s",
|
||
#"text/html": "lynx -dump -force_html %s",
|
||
}
|
||
|
||
# monkey-patch Gemini support in urllib.parse
|
||
# see https://github.com/python/cpython/blob/master/Lib/urllib/parse.py
|
||
urllib.parse.uses_relative.append("gemini")
|
||
urllib.parse.uses_netloc.append("gemini")
|
||
urllib.parse.uses_relative.append("spartan")
|
||
urllib.parse.uses_netloc.append("spartan")
|
||
|
||
#An IPV6 URL should be put between []
|
||
#We try to detect them has location with more than 2 ":"
|
||
def fix_ipv6_url(url):
|
||
if not url or url.startswith("mailto"):
|
||
return url
|
||
if "://" in url:
|
||
schema, schemaless = url.split("://",maxsplit=1)
|
||
else:
|
||
schema, schemaless = None, url
|
||
if "/" in schemaless:
|
||
netloc, rest = schemaless.split("/",1)
|
||
if netloc.count(":") > 2 and "[" not in netloc and "]" not in netloc:
|
||
schemaless = "[" + netloc + "]" + "/" + rest
|
||
elif schemaless.count(":") > 2:
|
||
schemaless = "[" + schemaless + "]/"
|
||
if schema:
|
||
return schema + "://" + schemaless
|
||
return schemaless
|
||
|
||
# This list is also used as a list of supported protocols
|
||
standard_ports = {
|
||
"gemini" : 1965,
|
||
"gopher" : 70,
|
||
"http" : 80,
|
||
"https" : 443,
|
||
"spartan": 300,
|
||
}
|
||
|
||
# First, we define the different content->text renderers, outside of the rest
|
||
# (They could later be factorized in other files or replaced)
|
||
class AbstractRenderer():
|
||
def __init__(self,content,url,center=True):
|
||
self.url = url
|
||
self.body = content
|
||
#there’s one rendered text and one links table per mode
|
||
self.rendered_text = {}
|
||
self.links = {}
|
||
self.images = {}
|
||
self.title = None
|
||
self.validity = True
|
||
self.temp_file = {}
|
||
self.less_histfile = {}
|
||
self.center = center
|
||
|
||
#This class hold an internal representation of the HTML text
|
||
#This is an experiment to rewrite the HTML renderer. Currently not used.
|
||
class representation:
|
||
def __init__(self,width,title=None,center=True):
|
||
#The following is just there to disable this class while developing it.
|
||
#This should result in very minimal performance fee for users while
|
||
#having the code directly at hand (git branches? What git branches…)
|
||
self.title=title
|
||
self.center = center
|
||
self.final_text = ""
|
||
self.opened = []
|
||
self.width = width
|
||
self.last_line = ""
|
||
self.last_line_colors = {}
|
||
self.last_line_center = False
|
||
self.new_paragraph = True
|
||
self.i_indent = ""
|
||
self.s_indent = ""
|
||
self.r_indent = ""
|
||
self.current_indent = ""
|
||
self.disabled_indents = None
|
||
# each color is an [open,close] pair code
|
||
self.colors = {
|
||
"bold" : ["1","22"],
|
||
"faint" : ["2","22"],
|
||
"italic" : ["3","23"],
|
||
"underline": ["4","24"],
|
||
"red" : ["31","39"],
|
||
"yellow" : ["33","39"],
|
||
"blue" : ["34","39"],
|
||
}
|
||
|
||
def _insert(self,color,open=True):
|
||
if open: o = 0
|
||
else: o = 1
|
||
pos = len(self.last_line)
|
||
#we remember the position where to insert color codes
|
||
if not pos in self.last_line_colors:
|
||
self.last_line_colors[pos] = []
|
||
#Two inverse code cancel each other
|
||
if [color,int(not o)] in self.last_line_colors[pos]:
|
||
self.last_line_colors[pos].remove([color,int(not o)])
|
||
else:
|
||
self.last_line_colors[pos].append([color,o])#+color+str(o))
|
||
|
||
# Take self.last line and add ANSI codes to it before adding it to
|
||
# self.final_text.
|
||
def _endline(self):
|
||
if len(self.last_line.strip()) > 0:
|
||
for c in self.opened:
|
||
self._insert(c,open=False)
|
||
nextline = ""
|
||
added_char = 0
|
||
#we insert the color code at the saved positions
|
||
while len (self.last_line_colors) > 0:
|
||
pos,colors = self.last_line_colors.popitem()
|
||
#popitem itterates LIFO.
|
||
#So we go, backward, to the pos (starting at the end of last_line)
|
||
nextline = self.last_line[pos:] + nextline
|
||
ansicol = "\x1b["
|
||
for c,o in colors:
|
||
ansicol += self.colors[c][o] + ";"
|
||
ansicol = ansicol[:-1]+"m"
|
||
nextline = ansicol + nextline
|
||
added_char += len(ansicol)
|
||
self.last_line = self.last_line[:pos]
|
||
nextline = self.last_line + nextline
|
||
if self.last_line_center:
|
||
#we have to care about the ansi char while centering
|
||
width = term_width() + added_char
|
||
nextline = nextline.strip().center(width)
|
||
self.last_line_center = False
|
||
else:
|
||
#should we lstrip the nextline in the addition ?
|
||
nextline = self.current_indent + nextline.lstrip() + self.r_indent
|
||
self.current_indent = self.s_indent
|
||
self.final_text += nextline
|
||
self.last_line = ""
|
||
self.final_text += "\n"
|
||
for c in self.opened:
|
||
self._insert(c,open=True)
|
||
else:
|
||
self.last_line = ""
|
||
|
||
|
||
def center_line(self):
|
||
self.last_line_center = True
|
||
|
||
def open_color(self,color):
|
||
if color in self.colors and color not in self.opened:
|
||
self._insert(color,open=True)
|
||
self.opened.append(color)
|
||
def close_color(self,color):
|
||
if color in self.colors and color in self.opened:
|
||
self._insert(color,open=False)
|
||
self.opened.remove(color)
|
||
def close_all(self):
|
||
if len(self.colors) > 0:
|
||
self.last_line += "\x1b[0m"
|
||
self.opened.clear()
|
||
|
||
def startindent(self,indent,sub=None,reverse=None):
|
||
self._endline()
|
||
self.i_indent = indent
|
||
self.current_indent = indent
|
||
if sub:
|
||
self.s_indent = sub
|
||
else:
|
||
self.s_indent = indent
|
||
if reverse:
|
||
self.r_indent = reverse
|
||
else:
|
||
self.r_indent = ""
|
||
|
||
|
||
def endindent(self):
|
||
self._endline()
|
||
self.i_indent = ""
|
||
self.s_indent = ""
|
||
self.r_indent = ""
|
||
self.current_indent = ""
|
||
|
||
def _disable_indents(self):
|
||
self.disabled_indents = []
|
||
self.disabled_indents.append(self.current_indent)
|
||
self.disabled_indents.append(self.i_indent)
|
||
self.disabled_indents.append(self.s_indent)
|
||
self.disabled_indents.append(self.r_indent)
|
||
self.endindent()
|
||
|
||
def _enable_indents(self):
|
||
if self.disabled_indents:
|
||
self.current_indent = self.disabled_indents[0]
|
||
self.i_indent = self.disabled_indents[1]
|
||
self.s_indent = self.disabled_indents[2]
|
||
self.r_indent = self.disabled_indents[3]
|
||
self.disabled_indents = None
|
||
|
||
def newline(self):
|
||
self._endline()
|
||
|
||
#A new paragraph implies 2 newlines (1 blank line between paragraphs)
|
||
#But it is only used if didn’t already started one to avoid plenty
|
||
#of blank lines. force=True allows to bypass that limit.
|
||
#new_paragraph becomes false as soon as text is entered into it
|
||
def newparagraph(self,force=False):
|
||
if force or not self.new_paragraph:
|
||
self._endline()
|
||
self.final_text += "\n"
|
||
self.new_paragraph = True
|
||
|
||
def add_space(self):
|
||
if len(self.last_line) > 0 and self.last_line[-1] != " ":
|
||
self.last_line += " "
|
||
|
||
def _title_first(self,intext=None):
|
||
if self.title:
|
||
if not self.title == intext:
|
||
self._disable_indents()
|
||
self.open_color("blue")
|
||
self.open_color("bold")
|
||
self.open_color("underline")
|
||
self.add_text(self.title)
|
||
self.close_all()
|
||
self.newparagraph()
|
||
self._enable_indents()
|
||
self.title = None
|
||
|
||
# Beware, blocks are not wrapped nor indented and left untouched!
|
||
# They are mostly useful for pictures and preformatted text.
|
||
def add_block(self,intext):
|
||
# If necessary, we add the title before a block
|
||
self._title_first()
|
||
# we don’t want to indent blocks
|
||
self._endline()
|
||
self._disable_indents()
|
||
self.final_text += self.current_indent + intext
|
||
self.new_paragraph = False
|
||
self._endline()
|
||
self._enable_indents()
|
||
|
||
def add_text(self,intext):
|
||
self._title_first(intext=intext)
|
||
lines = []
|
||
if self.last_line == "":
|
||
last = (self.last_line + intext.lstrip())
|
||
else:
|
||
last = (self.last_line + intext)
|
||
self.last_line = ""
|
||
# With the following, we basically cancel adding only spaces
|
||
# on an empty line
|
||
if len(last.strip()) > 0:
|
||
self.new_paragraph = False
|
||
else:
|
||
last = last.strip()
|
||
if len(last) > self.width:
|
||
width = self.width - len(self.current_indent) - len(self.r_indent)
|
||
spaces_left = len(last) - len(last.lstrip())
|
||
spaces_right = len(last) - len(last.rstrip())
|
||
lines = textwrap.wrap(last,width,drop_whitespace=True)
|
||
self.last_line += spaces_left*" "
|
||
while len(lines) > 1:
|
||
l = lines.pop(0)
|
||
self.last_line += l
|
||
self._endline()
|
||
if len(lines) == 1:
|
||
li = lines[0]
|
||
self.last_line += li + spaces_right*" "
|
||
else:
|
||
self.last_line = last
|
||
|
||
def get_final(self):
|
||
self.close_all()
|
||
self._endline()
|
||
#if no content, we still add the title
|
||
self._title_first()
|
||
lines = self.final_text.splitlines()
|
||
lines2 = []
|
||
termspace = shutil.get_terminal_size()[0]
|
||
#Following code instert blanck spaces to center the content
|
||
if self.center and termspace > term_width():
|
||
margin = int((termspace - term_width())//2)
|
||
else:
|
||
margin = 0
|
||
for l in lines :
|
||
lines2.append(margin*" "+l)
|
||
return "\n".join(lines2)
|
||
|
||
def get_subscribe_links(self):
|
||
return [[self.url,self.get_mime(),self.get_title()]]
|
||
def is_valid(self):
|
||
return self.validity
|
||
def get_links(self,mode="links_only"):
|
||
if mode not in self.links :
|
||
prepared_body = self.prepare(self.body,mode=mode)
|
||
results = self.render(prepared_body,mode=mode)
|
||
if results:
|
||
self.links[mode] = results[1]
|
||
return self.links[mode]
|
||
def get_title(self):
|
||
return "Abstract title"
|
||
|
||
# This function return a list of URL which should be downloaded
|
||
# before displaying the page (images in HTML pages, typically)
|
||
def get_images(self,mode="readable"):
|
||
if not mode in self.images:
|
||
self.get_body(mode=mode)
|
||
# we also invalidate the body that was done without images
|
||
self.rendered_text.pop(mode)
|
||
if mode in self.images:
|
||
return self.images[mode]
|
||
else:
|
||
return []
|
||
#This function will give gemtext to the gemtext renderer
|
||
def prepare(self,body,mode=None):
|
||
return body
|
||
|
||
def get_body(self,width=None,mode="readable"):
|
||
if not width:
|
||
width = term_width()
|
||
if mode not in self.rendered_text:
|
||
prepared_body = self.prepare(self.body,mode=mode)
|
||
result = self.render(prepared_body,width=width,mode=mode)
|
||
if result:
|
||
self.rendered_text[mode] = result[0]
|
||
self.links[mode] = result[1]
|
||
return self.rendered_text[mode]
|
||
|
||
def _window_title(self,title,info=None):
|
||
title_r = self.representation(term_width())
|
||
title_r.open_color("red")
|
||
title_r.open_color("bold")
|
||
title_r.add_text(title)
|
||
title_r.close_color("bold")
|
||
if info:
|
||
title_r.add_text(" (%s)"%info)
|
||
title_r.close_color("red")
|
||
return title_r.get_final()
|
||
|
||
def display(self,mode="readable",window_title="",window_info=None,grep=None):
|
||
wtitle = self._window_title(window_title,info=window_info)
|
||
body = wtitle + "\n" + self.get_body(mode=mode)
|
||
if not body:
|
||
return False
|
||
# We actually put the body in a tmpfile before giving it to less
|
||
if mode not in self.temp_file:
|
||
tmpf = tempfile.NamedTemporaryFile("w", encoding="UTF-8", delete=False)
|
||
self.temp_file[mode] = tmpf.name
|
||
tmpf.write(body)
|
||
tmpf.close()
|
||
if mode not in self.less_histfile:
|
||
firsttime = True
|
||
tmpf = tempfile.NamedTemporaryFile("w", encoding="UTF-8", delete=False)
|
||
self.less_histfile[mode] = tmpf.name
|
||
else:
|
||
firsttime = False
|
||
less_cmd(self.temp_file[mode], histfile=self.less_histfile[mode],cat=firsttime,grep=grep)
|
||
return True
|
||
|
||
def get_temp_file(self,mode="readable"):
|
||
if mode in self.temp_file:
|
||
return self.temp_file[mode]
|
||
else:
|
||
return None
|
||
|
||
# An instance of AbstractRenderer should have a self.render(body,width,mode) method.
|
||
# 3 modes are used : readable (by default), full and links_only (the fastest, when
|
||
# rendered content is not used, only the links are needed)
|
||
# The prepare() function is called before the rendering. It is useful if
|
||
# your renderer output in a format suitable for another existing renderer (such as gemtext)
|
||
|
||
# Gemtext Rendering Engine
|
||
class GemtextRenderer(AbstractRenderer):
|
||
def get_mime(self):
|
||
return "text/gemini"
|
||
def get_title(self):
|
||
if self.title:
|
||
return self.title
|
||
elif self.body:
|
||
lines = self.body.splitlines()
|
||
for line in lines:
|
||
if line.startswith("#"):
|
||
self.title = line.strip("#").strip()
|
||
return self.title
|
||
if len(lines) > 0:
|
||
# If not title found, we take the first 50 char
|
||
# of the first line
|
||
title_line = lines[0].strip()
|
||
if len(title_line) > 50:
|
||
title_line = title_line[:49] + "…"
|
||
self.title = title_line
|
||
return self.title
|
||
else:
|
||
self.title = "Empty Page"
|
||
return self.title
|
||
else:
|
||
return "Unknown Gopher Page"
|
||
|
||
#render_gemtext
|
||
def render(self,gemtext, width=None,mode=None):
|
||
if not width:
|
||
width = term_width()
|
||
r = self.representation(width)
|
||
links = []
|
||
preformatted = False
|
||
def format_link(url,index,name=None):
|
||
if "://" in url:
|
||
protocol,adress = url.split("://",maxsplit=1)
|
||
protocol = " %s" %protocol
|
||
else:
|
||
adress = url
|
||
protocol = ""
|
||
if "gemini" in protocol or "list" in protocol:
|
||
protocol = ""
|
||
if not name:
|
||
name = adress
|
||
line = "[%d%s] %s" % (index, protocol, name)
|
||
return line
|
||
for line in gemtext.splitlines():
|
||
r.newline()
|
||
if line.startswith("```"):
|
||
preformatted = not preformatted
|
||
elif preformatted:
|
||
# infinite line to not wrap preformated
|
||
r.add_block(line+"\n")
|
||
elif len(line.strip()) == 0:
|
||
r.newparagraph(force=True)
|
||
elif line.startswith("=>"):
|
||
strippedline = line[2:].strip()
|
||
if strippedline:
|
||
links.append(strippedline)
|
||
splitted = strippedline.split(maxsplit=1)
|
||
url = splitted[0]
|
||
name = None
|
||
if len(splitted) > 1:
|
||
name = splitted[1]
|
||
link = format_link(url,len(links),name=name)
|
||
#r.open_color("blue")
|
||
#r.open_color("faint")
|
||
#r.open_color("underline")
|
||
startpos = link.find("] ") + 2
|
||
r.startindent("",sub=startpos*" ")
|
||
r.add_text(link)
|
||
r.endindent()
|
||
#r.close_all()
|
||
elif line.startswith("* "):
|
||
line = line[1:].lstrip("\t ")
|
||
r.startindent("• ",sub=" ")
|
||
r.add_text(line)
|
||
r.endindent()
|
||
elif line.startswith(">"):
|
||
line = line[1:].lstrip("\t ")
|
||
r.startindent("> ")
|
||
r.add_text(line)
|
||
r.endindent()
|
||
elif line.startswith("###"):
|
||
line = line[3:].lstrip("\t ")
|
||
r.open_color("blue")
|
||
r.add_text(line)
|
||
r.close_color("blue")
|
||
elif line.startswith("##"):
|
||
line = line[2:].lstrip("\t ")
|
||
r.open_color("blue")
|
||
r.add_text(line)
|
||
r.close_color("blue")
|
||
elif line.startswith("#"):
|
||
line = line[1:].lstrip("\t ")
|
||
if not self.title:
|
||
self.title = line
|
||
r.open_color("bold")
|
||
r.open_color("blue")
|
||
r.open_color("underline")
|
||
r.add_text(line)
|
||
r.close_color("underline")
|
||
r.close_color("bold")
|
||
r.close_color("blue")
|
||
else:
|
||
# with the add_block, we keep leading spaces and handmade formatting.
|
||
#r.add_block(line.rstrip(),wrap=True)
|
||
# while with add_text, we justify on the left margin
|
||
r.add_text(line.rstrip())
|
||
return r.get_final(), links
|
||
|
||
class GopherRenderer(AbstractRenderer):
|
||
def get_mime(self):
|
||
return "text/gopher"
|
||
def get_title(self):
|
||
if not self.title:
|
||
self.title = ""
|
||
if self.body:
|
||
firstline = self.body.splitlines()[0]
|
||
firstline = firstline.split("\t")[0]
|
||
if firstline.startswith("i"):
|
||
firstline = firstline[1:]
|
||
self.title = firstline
|
||
return self.title
|
||
|
||
#menu_or_text
|
||
def render(self,body,width=None,mode=None):
|
||
if not width:
|
||
width = term_width()
|
||
try:
|
||
render,links = self._render_goph(body,width=width,mode=mode)
|
||
except Exception as err:
|
||
print("Error rendering Gopher ",err)
|
||
r = self.representation(width)
|
||
r.add_block(body)
|
||
render = r.get_final()
|
||
links = []
|
||
return render,links
|
||
|
||
def _render_goph(self,body,width=None,mode=None):
|
||
if not width:
|
||
width = term_width()
|
||
# This was copied straight from Agena (then later adapted)
|
||
links = []
|
||
r = self.representation(width)
|
||
for line in self.body.split("\n"):
|
||
r.newline()
|
||
if line.startswith("i"):
|
||
towrap = line[1:].split("\t")[0]
|
||
if len(towrap.strip()) > 0:
|
||
r.add_text(towrap)
|
||
else:
|
||
r.newparagraph()
|
||
elif not line.strip() in [".",""]:
|
||
parts = line.split("\t")
|
||
parts[-1] = parts[-1].strip()
|
||
if parts[-1] == "+":
|
||
parts = parts[:-1]
|
||
if len(parts) == 4:
|
||
name,path,host,port = parts
|
||
itemtype = name[0]
|
||
name = name[1:]
|
||
if port == "70":
|
||
port = ""
|
||
else:
|
||
port = ":%s"%port
|
||
if itemtype == "h" and path.startswith("URL:"):
|
||
url = path[4:]
|
||
else:
|
||
if not path.startswith("/"):
|
||
path = "/"+path
|
||
url = "gopher://%s%s/%s%s" %(host,port,itemtype,path)
|
||
linkline = url + " " + name
|
||
links.append(linkline)
|
||
towrap = "[%s] "%len(links)+ name
|
||
r.add_text(towrap)
|
||
else:
|
||
r.add_text(line)
|
||
return r.get_final(),links
|
||
|
||
|
||
class FolderRenderer(GemtextRenderer):
|
||
def get_mime(self):
|
||
return "Directory"
|
||
def prepare(self,body,mode=None):
|
||
def get_first_line(l):
|
||
path = os.path.join(listdir,l+".gmi")
|
||
with open(path) as f:
|
||
first_line = f.readline().strip()
|
||
f.close()
|
||
if first_line.startswith("#"):
|
||
return first_line
|
||
else:
|
||
return None
|
||
def write_list(l):
|
||
body = ""
|
||
for li in l:
|
||
path = "list:///%s"%li
|
||
gi = GeminiItem(path)
|
||
size = len(gi.get_links())
|
||
body += "=> %s %s (%s items)\n" %(str(path),li,size)
|
||
return body
|
||
listdir = os.path.join(_DATA_DIR,"lists")
|
||
if self.url != listdir:
|
||
return "This is folder %s" %self.url
|
||
else:
|
||
self.title = "My lists"
|
||
lists = []
|
||
if os.path.exists(listdir):
|
||
listfiles = os.listdir(listdir)
|
||
if len(listfiles) > 0:
|
||
for l in listfiles:
|
||
#removing the .gmi at the end of the name
|
||
lists.append(l[:-4])
|
||
if len(lists) > 0:
|
||
body = ""
|
||
my_lists = []
|
||
system_lists = []
|
||
subscriptions = []
|
||
frozen = []
|
||
lists.sort()
|
||
for l in lists:
|
||
if l in ["history","to_fetch","archives","tour"]:
|
||
system_lists.append(l)
|
||
else:
|
||
first_line = get_first_line(l)
|
||
if first_line and "#subscribed" in first_line:
|
||
subscriptions.append(l)
|
||
elif first_line and "#frozen" in first_line:
|
||
frozen.append(l)
|
||
else:
|
||
my_lists.append(l)
|
||
if len(my_lists) > 0:
|
||
body+= "\n## Bookmarks Lists (updated during sync)\n"
|
||
body += write_list(my_lists)
|
||
if len(subscriptions) > 0:
|
||
body +="\n## Subscriptions (new links in those are added to tour)\n"
|
||
body += write_list(subscriptions)
|
||
if len(frozen) > 0:
|
||
body +="\n## Frozen (fetched but never updated)\n"
|
||
body += write_list(frozen)
|
||
if len(system_lists) > 0:
|
||
body +="\n## System Lists\n"
|
||
body += write_list(system_lists)
|
||
return body
|
||
|
||
class FeedRenderer(GemtextRenderer):
|
||
def get_mime(self):
|
||
return "application/rss+xml"
|
||
def is_valid(self):
|
||
if _DO_FEED:
|
||
parsed = feedparser.parse(self.body)
|
||
else:
|
||
return False
|
||
if parsed.bozo:
|
||
return False
|
||
else:
|
||
#If no content, then fallback to HTML
|
||
return len(parsed.entries) > 0
|
||
|
||
def get_title(self):
|
||
if not self.title:
|
||
self.get_body()
|
||
return self.title
|
||
|
||
def prepare(self,content,mode="readable",width=None):
|
||
if not width:
|
||
width = term_width()
|
||
self.title = "RSS/Atom feed"
|
||
page = ""
|
||
if _DO_FEED:
|
||
parsed = feedparser.parse(content)
|
||
else:
|
||
page += "Please install python-feedparser to handle RSS/Atom feeds\n"
|
||
self.validity = False
|
||
return page
|
||
if parsed.bozo:
|
||
page += "Invalid RSS feed\n\n"
|
||
page += str(parsed.bozo_exception)
|
||
self.validity = False
|
||
else:
|
||
if "title" in parsed.feed:
|
||
t = parsed.feed.title
|
||
else:
|
||
t = "Unknown"
|
||
self.title = "%s (XML feed)" %t
|
||
title = "# %s"%self.title
|
||
page += title + "\n"
|
||
if "updated" in parsed.feed:
|
||
page += "Last updated on %s\n\n" %parsed.feed.updated
|
||
if "subtitle" in parsed.feed:
|
||
page += parsed.feed.subtitle + "\n"
|
||
if "link" in parsed.feed:
|
||
page += "=> %s\n" %parsed.feed.link
|
||
page += "\n## Entries\n"
|
||
if len(parsed.entries) < 1:
|
||
self.validity = False
|
||
for i in parsed.entries:
|
||
line = "=> %s " %i.link
|
||
if "published" in i:
|
||
pub_date = time.strftime("%Y-%m-%d",i.published_parsed)
|
||
line += pub_date + " : "
|
||
line += "%s" %(i.title)
|
||
if "author" in i:
|
||
line += " (by %s)"%i.author
|
||
page += line + "\n"
|
||
if mode == "full":
|
||
if "summary" in i:
|
||
html = HtmlRenderer(i.summary,self.url,center=False)
|
||
rendered = html.get_body(width=None,mode="full")
|
||
page += rendered
|
||
page += "\n"
|
||
return page
|
||
|
||
class ImageRenderer(AbstractRenderer):
|
||
def get_mime(self):
|
||
return "image/*"
|
||
def is_valid(self):
|
||
if _RENDER_IMAGE:
|
||
return True
|
||
else:
|
||
return False
|
||
def get_links(self,mode=None):
|
||
return []
|
||
def get_title(self):
|
||
return "Picture file"
|
||
def render(self,img,width=None,mode=None):
|
||
#with inline, we use symbols to be rendered with less.
|
||
#else we use the best possible renderer.
|
||
if mode == "links_only":
|
||
return "", []
|
||
if not width:
|
||
width = term_width()
|
||
spaces = 0
|
||
else:
|
||
spaces = int((term_width() - width)//2)
|
||
ansi_img = inline_image(img,width)
|
||
#Now centering the image
|
||
lines = ansi_img.splitlines()
|
||
new_img = ""
|
||
for l in lines:
|
||
new_img += spaces*" " + l + "\n"
|
||
return new_img, []
|
||
def display(self,mode=None,window_title=None,window_info=None,grep=None):
|
||
if window_title:
|
||
print(self._window_title(window_title,info=window_info))
|
||
terminal_image(self.body)
|
||
return True
|
||
|
||
class HtmlRenderer(AbstractRenderer):
|
||
def get_mime(self):
|
||
return "text/html"
|
||
def is_valid(self):
|
||
if not _DO_HTML:
|
||
print("HTML document detected. Please install python-bs4 and python-readability.")
|
||
return _DO_HTML and self.validity
|
||
def get_subscribe_links(self):
|
||
subs = [[self.url,self.get_mime(),self.get_title()]]
|
||
soup = BeautifulSoup(self.body, 'html.parser')
|
||
links = soup.find_all("link",rel="alternate",recursive=True)
|
||
for l in links:
|
||
ty = l.get("type")
|
||
if ty :
|
||
if "rss" in ty or "atom" in ty or "feed" in ty:
|
||
subs.append([l.get("href"),ty,l.get("title")])
|
||
return subs
|
||
|
||
def get_title(self):
|
||
if self.title:
|
||
return self.title
|
||
else:
|
||
readable = Document(self.body)
|
||
self.title = readable.short_title()
|
||
return self.title
|
||
|
||
# Our own HTML engine (crazy, isn’t it?)
|
||
# Return [rendered_body, list_of_links]
|
||
# mode is either links_only, readable or full
|
||
def render(self,body,mode="readable",width=None,add_title=True):
|
||
if not width:
|
||
width = term_width()
|
||
if not _DO_HTML:
|
||
print("HTML document detected. Please install python-bs4 and python-readability.")
|
||
return
|
||
# This method recursively parse the HTML
|
||
r = self.representation(width,title=self.get_title(),center=self.center)
|
||
links = []
|
||
# You know how bad html is when you realize that space sometimes meaningful, somtimes not.
|
||
# CR are not meaniningful. Except that, somethimes, they should be interpreted as spaces.
|
||
# HTML is real crap. At least the one people are generating.
|
||
def render_image(src,width=40,mode=None):
|
||
ansi_img = ""
|
||
abs_url = urllib.parse.urljoin(self.url, src)
|
||
if _RENDER_IMAGE and mode != "links_only" and src:
|
||
try:
|
||
g = GeminiItem(abs_url)
|
||
if g.is_cache_valid():
|
||
img = g.get_cache_path()
|
||
renderer = ImageRenderer(img,abs_url)
|
||
# Image are 40px wide except if terminal is smaller
|
||
if width > 40:
|
||
size = 40
|
||
else:
|
||
size = width
|
||
ansi_img = "\n" + renderer.get_body(width=size,mode="inline")
|
||
except Exception as err:
|
||
#we sometimes encounter really bad formatted files or URL
|
||
ansi_img = textwrap.fill("[BAD IMG] %s"%src,width) + "\n"
|
||
return ansi_img
|
||
def sanitize_string(string):
|
||
#never start with a "\n"
|
||
string = string.lstrip("\n")
|
||
string = string.replace("\r","").replace("\n", " ").replace("\t"," ")
|
||
endspace = string.endswith(" ") or string.endswith("\xa0")
|
||
startspace = string.startswith(" ") or string.startswith("\xa0")
|
||
toreturn = string.replace("\n", " ").replace("\t"," ").strip()
|
||
while " " in toreturn:
|
||
toreturn = toreturn.replace(" "," ")
|
||
toreturn = html.unescape(toreturn)
|
||
if endspace and not toreturn.endswith(" ") and not toreturn.endswith("\xa0"):
|
||
toreturn += " "
|
||
if startspace and not toreturn.startswith(" ") and not toreturn.startswith("\xa0"):
|
||
toreturn = " " + toreturn
|
||
return toreturn
|
||
def recursive_render(element,indent="",preformatted=False):
|
||
if element.name == "blockquote":
|
||
r.newparagraph()
|
||
r.startindent(" ",reverse=" ")
|
||
for child in element.children:
|
||
r.open_color("italic")
|
||
recursive_render(child,indent="\t")
|
||
r.close_color("italic")
|
||
r.endindent()
|
||
elif element.name in ["div","p"]:
|
||
r.newparagraph()
|
||
for child in element.children:
|
||
recursive_render(child,indent=indent)
|
||
r.newparagraph()
|
||
elif element.name in ["span"]:
|
||
r.add_space()
|
||
for child in element.children:
|
||
recursive_render(child,indent=indent)
|
||
r.add_space()
|
||
elif element.name in ["h1","h2","h3","h4","h5","h6"]:
|
||
r.open_color("blue")
|
||
if element.name in ["h1"]:
|
||
r.open_color("bold")
|
||
r.open_color("underline")
|
||
elif element.name in ["h2"]:
|
||
r.open_color("bold")
|
||
elif element.name in ["h5","h6"]:
|
||
r.open_color("faint")
|
||
for child in element.children:
|
||
r.newparagraph()
|
||
recursive_render(child)
|
||
r.newparagraph()
|
||
r.close_all()
|
||
elif element.name in ["code","tt"]:
|
||
for child in element.children:
|
||
recursive_render(child,indent=indent,preformatted=True)
|
||
elif element.name in ["pre"]:
|
||
r.newparagraph()
|
||
r.add_block(element.text)
|
||
r.newparagraph()
|
||
elif element.name in ["li"]:
|
||
r.startindent(" • ",sub=" ")
|
||
for child in element.children:
|
||
recursive_render(child,indent=indent)
|
||
r.endindent()
|
||
elif element.name in ["tr"]:
|
||
r.startindent("|",reverse="|")
|
||
for child in element.children:
|
||
recursive_render(child,indent=indent)
|
||
r.endindent()
|
||
elif element.name in ["td","th"]:
|
||
r.add_text("| ")
|
||
for child in element.children:
|
||
recursive_render(child)
|
||
r.add_text(" |")
|
||
# italics
|
||
elif element.name in ["em","i"]:
|
||
r.open_color("italic")
|
||
for child in element.children:
|
||
recursive_render(child,indent=indent,preformatted=preformatted)
|
||
r.close_color("italic")
|
||
#bold
|
||
elif element.name in ["b","strong"]:
|
||
r.open_color("bold")
|
||
for child in element.children:
|
||
recursive_render(child,indent=indent,preformatted=preformatted)
|
||
r.close_color("bold")
|
||
elif element.name == "a":
|
||
link = element.get('href')
|
||
# support for images nested in links
|
||
if link:
|
||
text = ""
|
||
imgtext = ""
|
||
#we display images first in a link
|
||
for child in element.children:
|
||
if child.name == "img":
|
||
recursive_render(child)
|
||
imgtext = "[IMG LINK %s]"
|
||
links.append(link+" "+text)
|
||
link_id = str(len(links))
|
||
r.open_color("blue")
|
||
r.open_color("faint")
|
||
for child in element.children:
|
||
if child.name != "img":
|
||
recursive_render(child,preformatted=preformatted)
|
||
if imgtext != "":
|
||
r.center_line()
|
||
r.add_text(imgtext%link_id)
|
||
else:
|
||
r.add_text(" [%s]"%link_id)
|
||
r.close_color("blue")
|
||
r.close_color("faint")
|
||
else:
|
||
#No real link found
|
||
for child in element.children:
|
||
recursive_render(child,preformatted=preformatted)
|
||
elif element.name == "img":
|
||
src = element.get("src")
|
||
text = ""
|
||
ansi_img = render_image(src,width=width,mode=mode)
|
||
alt = element.get("alt")
|
||
if alt:
|
||
alt = sanitize_string(alt)
|
||
text += "[IMG] %s"%alt
|
||
else:
|
||
text += "[IMG]"
|
||
if src:
|
||
links.append(src+" "+text)
|
||
if not mode in self.images:
|
||
self.images[mode] = []
|
||
abs_url = urllib.parse.urljoin(self.url, src)
|
||
self.images[mode].append(abs_url)
|
||
link_id = " [%s]"%(len(links))
|
||
r.add_block(ansi_img)
|
||
r.open_color("faint")
|
||
r.open_color("yellow")
|
||
r.center_line()
|
||
r.add_text(text + link_id)
|
||
r.close_color("faint")
|
||
r.close_color("yellow")
|
||
r.newline()
|
||
elif element.name == "br":
|
||
r.newline()
|
||
elif element.name not in ["script","style","template"] and type(element) != Comment:
|
||
if element.string:
|
||
if preformatted :
|
||
r.open_color("faint")
|
||
r.add_text(element.string)
|
||
r.close_color("faint")
|
||
else:
|
||
s = sanitize_string(element.string)
|
||
if len(s.strip()) > 0:
|
||
r.add_text(s)
|
||
else:
|
||
for child in element.children:
|
||
recursive_render(child,indent=indent)
|
||
# the real render_html hearth
|
||
if mode == "full":
|
||
summary = body
|
||
else:
|
||
readable = Document(body)
|
||
summary = readable.summary()
|
||
soup = BeautifulSoup(summary, 'html.parser')
|
||
#soup = BeautifulSoup(summary, 'html5lib')
|
||
if soup :
|
||
if soup.body :
|
||
recursive_render(soup.body)
|
||
else:
|
||
recursive_render(soup)
|
||
return r.get_final(),links
|
||
|
||
# Mapping mimetypes with renderers
|
||
# (any content with a mimetype text/* not listed here will be rendered with as GemText)
|
||
_FORMAT_RENDERERS = {
|
||
"text/gemini": GemtextRenderer,
|
||
"text/html" : HtmlRenderer,
|
||
"text/xml" : FeedRenderer,
|
||
"application/xml" : FeedRenderer,
|
||
"application/rss+xml" : FeedRenderer,
|
||
"application/atom+xml" : FeedRenderer,
|
||
"text/gopher": GopherRenderer,
|
||
"image/*": ImageRenderer
|
||
}
|
||
# Offpunk is organized as follow:
|
||
# - a GeminiClient instance which handles the browsing of GeminiItems (= pages).
|
||
# - There’s only one GeminiClient. Each page is a GeminiItem (name is historical, as
|
||
# it could be non-gemini content)
|
||
# - A GeminiItem is created with an URL from which it will derives content.
|
||
# - Content include : a title, a body, an ansi-rendered-body and a list of links.
|
||
# - Each GeminiItem generates a "cache_path" in which it maintains a cached version of its content.
|
||
|
||
class GeminiItem():
|
||
|
||
def __init__(self, url, name=""):
|
||
if "://" not in url and ("./" not in url and url[0] != "/"):
|
||
if not url.startswith("mailto:"):
|
||
url = "gemini://" + url
|
||
self.last_mode = None
|
||
findmode = url.split("##offpunk_mode=")
|
||
if len(findmode) > 1:
|
||
self.url = findmode[0]
|
||
if findmode[1] in ["full"] or findmode[1].isnumeric():
|
||
self.last_mode = findmode[1]
|
||
else:
|
||
self.url = url
|
||
self.url = fix_ipv6_url(self.url).strip()
|
||
self._cache_path = None
|
||
self.name = name
|
||
self.mime = None
|
||
self.renderer = None
|
||
self.body = None
|
||
parsed = urllib.parse.urlparse(self.url)
|
||
if url[0] == "/" or url.startswith("./"):
|
||
self.scheme = "file"
|
||
else:
|
||
self.scheme = parsed.scheme
|
||
if self.scheme in ["file","mailto","list"]:
|
||
self.local = True
|
||
self.host = ""
|
||
self.port = None
|
||
# file:// is 7 char
|
||
if self.url.startswith("file://"):
|
||
self.path = self.url[7:]
|
||
elif self.scheme == "mailto":
|
||
self.path = parsed.path
|
||
elif self.url.startswith("list://"):
|
||
listdir = os.path.join(_DATA_DIR,"lists")
|
||
listname = self.url[7:].lstrip("/")
|
||
if listname in [""]:
|
||
self.name = "My Lists"
|
||
self.path = listdir
|
||
else:
|
||
self.name = listname
|
||
self.path = os.path.join(listdir, "%s.gmi"%listname)
|
||
else:
|
||
self.path = self.url
|
||
else:
|
||
self.local = False
|
||
self.host = parsed.hostname
|
||
self.port = parsed.port or standard_ports.get(self.scheme, 0)
|
||
# special gopher selector case
|
||
if self.scheme == "gopher":
|
||
if parsed.path and parsed.path[0] == "/" and len(parsed.path) > 1:
|
||
splitted = parsed.path.split("/")
|
||
# We check if we have well a gopher type
|
||
if len(splitted[1]) == 1:
|
||
itemtype = parsed.path[1]
|
||
selector = parsed.path[2:]
|
||
else:
|
||
itemtype = "1"
|
||
selector = parsed.path
|
||
self.path = selector
|
||
else:
|
||
itemtype = "1"
|
||
self.path = parsed.path
|
||
if itemtype == "0":
|
||
self.mime = "text/gemini"
|
||
elif itemtype == "1":
|
||
self.mime = "text/gopher"
|
||
elif itemtype == "h":
|
||
self.mime = "text/html"
|
||
elif itemtype in ("9","g","I","s"):
|
||
self.mime = "binary"
|
||
else:
|
||
self.mime = "text/gopher"
|
||
else:
|
||
self.path = parsed.path
|
||
if parsed.query:
|
||
# we don’t add the query if path is too long because path above 260 char
|
||
# are not supported and crash python.
|
||
# Also, very long query are usually useless stuff
|
||
if len(self.path+parsed.query) < 258:
|
||
self.path += "/" + parsed.query
|
||
|
||
def get_cache_path(self):
|
||
if self._cache_path and not os.path.isdir(self._cache_path):
|
||
return self._cache_path
|
||
elif self.local:
|
||
self._cache_path = self.path
|
||
#if not local, we create a local cache path.
|
||
else:
|
||
self._cache_path = os.path.expanduser(_CACHE_PATH + self.scheme +\
|
||
"/" + self.host + self.path)
|
||
#There’s an OS limitation of 260 characters per path.
|
||
#We will thus cut the path enough to add the index afterward
|
||
self._cache_path = self._cache_path[:249]
|
||
# FIXME : this is a gross hack to give a name to
|
||
# index files. This will break if the index is not
|
||
# index.gmi. I don’t know how to know the real name
|
||
# of the file. But first, we need to ensure that the domain name
|
||
# finish by "/". Else, the cache will create a file, not a folder.
|
||
if self.scheme.startswith("http"):
|
||
index = "index.html"
|
||
elif self.scheme == "gopher":
|
||
index = "index.txt"
|
||
else:
|
||
index = "index.gmi"
|
||
if self.path == "" or os.path.isdir(self._cache_path):
|
||
if not self._cache_path.endswith("/"):
|
||
self._cache_path += "/"
|
||
if not self.url.endswith("/"):
|
||
self.url += "/"
|
||
if self._cache_path.endswith("/"):
|
||
self._cache_path += index
|
||
#sometimes, the index itself is a dir
|
||
#like when folder/index.gmi?param has been created
|
||
#and we try to access folder
|
||
if os.path.isdir(self._cache_path):
|
||
self._cache_path += "/" + index
|
||
return self._cache_path
|
||
|
||
def get_capsule_title(self):
|
||
#small intelligence to try to find a good name for a capsule
|
||
#we try to find eithe ~username or /users/username
|
||
#else we fallback to hostname
|
||
if self.local:
|
||
if self.name != "":
|
||
red_title = self.name
|
||
else:
|
||
red_title = self.path
|
||
else:
|
||
red_title = self.host
|
||
if "user" in self.path:
|
||
i = 0
|
||
splitted = self.path.split("/")
|
||
while i < (len(splitted)-1):
|
||
if splitted[i].startswith("user"):
|
||
red_title = splitted[i+1]
|
||
i += 1
|
||
if "~" in self.path:
|
||
for pp in self.path.split("/"):
|
||
if pp.startswith("~"):
|
||
red_title = pp[1:]
|
||
return red_title
|
||
|
||
def get_page_title(self):
|
||
title = ""
|
||
if not self.renderer:
|
||
self._set_renderer()
|
||
if self.renderer:
|
||
title = self.renderer.get_title()
|
||
if len(title) == 0:
|
||
title = self.get_capsule_title()
|
||
else:
|
||
title += " (%s)" %self.get_capsule_title()
|
||
return title
|
||
|
||
def is_cache_valid(self,validity=0):
|
||
# Validity is the acceptable time for
|
||
# a cache to be valid (in seconds)
|
||
# If 0, then any cache is considered as valid
|
||
# (use validity = 1 if you want to refresh everything)
|
||
cache = self.get_cache_path()
|
||
if self.local:
|
||
return os.path.exists(cache)
|
||
elif cache :
|
||
# If path is too long, we always return True to avoid
|
||
# fetching it.
|
||
if len(cache) > 259:
|
||
print("We return False because path is too long")
|
||
return False
|
||
if os.path.exists(cache) and not os.path.isdir(cache):
|
||
if validity > 0 :
|
||
last_modification = self.cache_last_modified()
|
||
now = time.time()
|
||
age = now - last_modification
|
||
return age < validity
|
||
else:
|
||
return True
|
||
else:
|
||
#Cache has not been build
|
||
return False
|
||
else:
|
||
#There’s not even a cache!
|
||
return False
|
||
|
||
def cache_last_modified(self):
|
||
path = self.get_cache_path()
|
||
if path:
|
||
return os.path.getmtime(path)
|
||
elif self.local:
|
||
return 0
|
||
else:
|
||
print("ERROR : NO CACHE in cache_last_modified")
|
||
return None
|
||
|
||
def get_body(self,as_file=False):
|
||
if self.body and not as_file:
|
||
return self.body
|
||
if self.is_cache_valid():
|
||
path = self.get_cache_path()
|
||
else:
|
||
path = None
|
||
if path:
|
||
# There’s on OS limit on path length
|
||
if len(path) > 259:
|
||
toreturn = "Path is too long. This is an OS limitation.\n\n"
|
||
toreturn += self.url
|
||
return toreturn
|
||
elif as_file:
|
||
return path
|
||
else:
|
||
with open(path) as f:
|
||
body = f.read()
|
||
f.close()
|
||
return body
|
||
else:
|
||
#print("ERROR: NO CACHE for %s" %self._cache_path)
|
||
return None
|
||
|
||
def get_images(self,mode=None):
|
||
if not self.renderer:
|
||
self._set_renderer()
|
||
if self.renderer:
|
||
return self.renderer.get_images(mode=mode)
|
||
else:
|
||
return []
|
||
|
||
# This method is used to load once the list of links in a gi
|
||
# Links can be followed, after a space, by a description/title
|
||
def get_links(self,mode=None):
|
||
links = []
|
||
toreturn = []
|
||
if not self.renderer:
|
||
self._set_renderer()
|
||
if self.renderer:
|
||
if not mode:
|
||
mode = self.last_mode
|
||
links = self.renderer.get_links(mode=mode)
|
||
for l in links:
|
||
#split between link and potential name
|
||
splitted = l.split(maxsplit=1)
|
||
url = self.absolutise_url(splitted[0])
|
||
if looks_like_url(url):
|
||
if len(splitted) > 1:
|
||
#We add a name only for Gopher items
|
||
if url.startswith("gopher://"):
|
||
newgi = GeminiItem(url,name=splitted[1])
|
||
else:
|
||
newgi = GeminiItem(url)
|
||
else:
|
||
newgi = GeminiItem(url)
|
||
toreturn.append(newgi)
|
||
return toreturn
|
||
|
||
def get_link(self,nb):
|
||
# == None allows to return False, even if the list is empty
|
||
links = self.get_links()
|
||
if len(links) < nb:
|
||
print("Index too high! No link %s for %s" %(nb,self.url))
|
||
return None
|
||
else:
|
||
return links[nb-1]
|
||
|
||
def get_subscribe_links(self):
|
||
if not self.renderer:
|
||
self._set_renderer()
|
||
if self.renderer:
|
||
subs = self.renderer.get_subscribe_links()
|
||
abssubs = []
|
||
# some rss links are relatives
|
||
for s in subs:
|
||
s[0] = self.absolutise_url(s[0])
|
||
abssubs.append(s)
|
||
return abssubs
|
||
else:
|
||
return []
|
||
|
||
def _set_renderer(self,mime=None):
|
||
if self.local and os.path.isdir(self.get_cache_path()):
|
||
self.renderer = FolderRenderer("",self.get_cache_path())
|
||
return
|
||
if not mime:
|
||
mime = self.get_mime()
|
||
#we don’t even have a mime (so probably we don’t have a cache)
|
||
if not mime:
|
||
return
|
||
mime_to_use = []
|
||
for m in _FORMAT_RENDERERS:
|
||
if fnmatch.fnmatch(mime, m):
|
||
mime_to_use.append(m)
|
||
if len(mime_to_use) > 0:
|
||
current_mime = mime_to_use[0]
|
||
func = _FORMAT_RENDERERS[current_mime]
|
||
if current_mime.startswith("text"):
|
||
self.renderer = func(self.get_body(),self.url)
|
||
# We double check if the renderer is correct.
|
||
# If not, we fallback to html
|
||
# (this is currently only for XHTML, often being
|
||
# mislabelled as xml thus RSS feeds)
|
||
if not self.renderer.is_valid():
|
||
func = _FORMAT_RENDERERS["text/html"]
|
||
#print("Set (fallback)RENDERER to html instead of %s"%mime)
|
||
self.renderer = func(self.get_body(),self.url)
|
||
else:
|
||
#we don’t parse text, we give the file to the renderer
|
||
self.renderer = func(self.get_cache_path(),self.url)
|
||
if not self.renderer.is_valid():
|
||
self.renderer = None
|
||
|
||
def display(self,mode=None,grep=None):
|
||
if not self.renderer:
|
||
self._set_renderer()
|
||
if self.renderer and self.renderer.is_valid():
|
||
if not mode:
|
||
mode = self.last_mode
|
||
else:
|
||
self.last_mode = mode
|
||
title = self.get_capsule_title()
|
||
if self.is_cache_valid(): #and self.offline_only and not self.local:
|
||
nbr = len(self.get_links(mode=mode))
|
||
if self.local:
|
||
title += " (%s items)"%nbr
|
||
str_last = "local file"
|
||
else:
|
||
str_last = "last accessed on %s" %time.ctime(self.cache_last_modified())
|
||
title += " (%s links)"%nbr
|
||
return self.renderer.display(mode=mode,window_title=title,window_info=str_last,grep=grep)
|
||
else:
|
||
return False
|
||
|
||
def get_filename(self):
|
||
filename = os.path.basename(self.get_cache_path())
|
||
return filename
|
||
|
||
def get_temp_filename(self):
|
||
tmpf = None
|
||
if not self.renderer:
|
||
self._set_renderer()
|
||
if self.renderer and self.renderer.is_valid():
|
||
tmpf = self.renderer.get_temp_file()
|
||
if not tmpf:
|
||
tmpf = self.get_cache_path()
|
||
return tmpf
|
||
|
||
def write_body(self,body,mime=None):
|
||
## body is a copy of the raw gemtext
|
||
## Write_body() also create the cache !
|
||
# DEFAULT GEMINI MIME
|
||
self.body = body
|
||
if mime:
|
||
self.mime, mime_options = cgi.parse_header(mime)
|
||
if not self.local:
|
||
if self.mime and self.mime.startswith("text/"):
|
||
mode = "w"
|
||
else:
|
||
mode = "wb"
|
||
cache_dir = os.path.dirname(self.get_cache_path())
|
||
# If the subdirectory already exists as a file (not a folder)
|
||
# We remove it (happens when accessing URL/subfolder before
|
||
# URL/subfolder/file.gmi.
|
||
# This causes loss of data in the cache
|
||
# proper solution would be to save "sufolder" as "sufolder/index.gmi"
|
||
# If the subdirectory doesn’t exist, we recursively try to find one
|
||
# until it exists to avoid a file blocking the creation of folders
|
||
root_dir = cache_dir
|
||
while not os.path.exists(root_dir):
|
||
root_dir = os.path.dirname(root_dir)
|
||
if os.path.isfile(root_dir):
|
||
os.remove(root_dir)
|
||
os.makedirs(cache_dir,exist_ok=True)
|
||
with open(self.get_cache_path(), mode=mode) as f:
|
||
f.write(body)
|
||
f.close()
|
||
|
||
def get_mime(self):
|
||
#Beware, this one is really a shaddy ad-hoc function
|
||
if self.mime:
|
||
return self.mime
|
||
elif self.is_cache_valid():
|
||
path = self.get_cache_path()
|
||
if self.scheme == "mailto":
|
||
mime = "mailto"
|
||
elif os.path.isdir(path):
|
||
mime = "Local Folder"
|
||
elif path.endswith(".gmi"):
|
||
mime = "text/gemini"
|
||
elif shutil.which("file") :
|
||
#mime = magic.from_file(path,mime=True)
|
||
mime = run("file -b --mime-type %s"%path).strip()
|
||
mime2,encoding = mimetypes.guess_type(path,strict=False)
|
||
#If we hesitate between html and xml, takes the xml one
|
||
#because the FeedRendered fallback to HtmlRenderer
|
||
if mime2 and mime != mime2 and "html" in mime and "xml" in mime2:
|
||
mime = "text/xml"
|
||
#Some xml/html document are considered as octet-stream
|
||
if mime == "application/octet-stream":
|
||
mime = "text/xml"
|
||
else:
|
||
mime,encoding = mimetypes.guess_type(path,strict=False)
|
||
#gmi Mimetype is not recognized yet
|
||
if not mime and not shutil.which("file") :
|
||
print("Cannot guess the mime type of the file. Please install \"file\".")
|
||
print("(and send me an email, I’m curious of systems without \"file\" installed!")
|
||
if mime.startswith("text") and mime not in _FORMAT_RENDERERS:
|
||
if mime2 and mime2 in _FORMAT_RENDERERS:
|
||
mime = mime2
|
||
else:
|
||
#by default, we consider it’s gemini except for html
|
||
mime = "text/gemini"
|
||
self.mime = mime
|
||
return self.mime
|
||
|
||
def set_error(self,err):
|
||
# If we get an error, we want to keep an existing cache
|
||
# but we need to touch it or to create an empty one
|
||
# to avoid hitting the error at each refresh
|
||
cache = self.get_cache_path()
|
||
if self.is_cache_valid():
|
||
os.utime(cache)
|
||
else:
|
||
cache_dir = os.path.dirname(cache)
|
||
root_dir = cache_dir
|
||
while not os.path.exists(root_dir):
|
||
root_dir = os.path.dirname(root_dir)
|
||
if os.path.isfile(root_dir):
|
||
os.remove(root_dir)
|
||
os.makedirs(cache_dir,exist_ok=True)
|
||
if os.path.isdir(cache_dir):
|
||
with open(cache, "w") as cache:
|
||
cache.write(str(datetime.datetime.now())+"\n")
|
||
cache.write("ERROR while caching %s\n\n" %self.url)
|
||
cache.write("*****\n\n")
|
||
cache.write(str(type(err)) + " = " + str(err))
|
||
#cache.write("\n" + str(err.with_traceback(None)))
|
||
cache.write("\n*****\n\n")
|
||
cache.write("If you believe this error was temporary, type ""reload"".\n")
|
||
cache.write("The ressource will be tentatively fetched during next sync.\n")
|
||
cache.close()
|
||
|
||
|
||
def root(self):
|
||
return GeminiItem(self._derive_url("/"))
|
||
|
||
def up(self,level=1):
|
||
path = self.path.rstrip('/')
|
||
count = 0
|
||
while count < level:
|
||
pathbits = list(os.path.split(path))
|
||
# Don't try to go higher than root or in config
|
||
if self.local or len(pathbits) == 1 :
|
||
return self
|
||
# Get rid of bottom component
|
||
if len(pathbits) > 1:
|
||
pathbits.pop()
|
||
path = os.path.join(*pathbits)
|
||
count += 1
|
||
if self.scheme == "gopher":
|
||
path = "/1" + path
|
||
return GeminiItem(self._derive_url(path))
|
||
|
||
def query(self, query):
|
||
query = urllib.parse.quote(query)
|
||
return GeminiItem(self._derive_url(query=query))
|
||
|
||
def _derive_url(self, path="", query=""):
|
||
"""
|
||
A thin wrapper around urlunparse which avoids inserting standard ports
|
||
into URLs just to keep things clean.
|
||
"""
|
||
if not self.port or self.port == standard_ports[self.scheme] :
|
||
host = self.host
|
||
else:
|
||
host = self.host + ":" + str(self.port)
|
||
return urllib.parse.urlunparse((self.scheme,host,path or self.path, "", query, ""))
|
||
|
||
def absolutise_url(self, relative_url):
|
||
"""
|
||
Convert a relative URL to an absolute URL by using the URL of this
|
||
GeminiItem as a base.
|
||
"""
|
||
abs_url = urllib.parse.urljoin(self.url, relative_url)
|
||
return abs_url
|
||
|
||
def url_mode(self):
|
||
url = self.url
|
||
if self.last_mode and self.last_mode != "readable":
|
||
url += "##offpunk_mode=" + self.last_mode
|
||
return url
|
||
|
||
def to_map_line(self):
|
||
return "=> {} {}\n".format(self.url_mode(), self.get_page_title())
|
||
|
||
CRLF = '\r\n'
|
||
|
||
# Cheap and cheerful URL detector
|
||
def looks_like_url(word):
|
||
try:
|
||
if not word.strip():
|
||
return False
|
||
url = fix_ipv6_url(word).strip()
|
||
parsed = urllib.parse.urlparse(url)
|
||
#sometimes, urllib crashed only when requesting the port
|
||
port = parsed.port
|
||
mailto = word.startswith("mailto:")
|
||
scheme = word.split("://")[0]
|
||
start = scheme in standard_ports
|
||
local = scheme in ["file","list"]
|
||
if not start and not local and not mailto:
|
||
return looks_like_url("gemini://"+word)
|
||
elif mailto:
|
||
return "@" in word
|
||
elif not local:
|
||
return "." in word
|
||
else:
|
||
return "/" in word
|
||
except ValueError:
|
||
return False
|
||
|
||
class UserAbortException(Exception):
|
||
pass
|
||
|
||
# GeminiClient 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
|
||
|
||
def restricted(inner):
|
||
def outer(self, *args, **kwargs):
|
||
if self.restricted:
|
||
print("Sorry, this command is not available in restricted mode!")
|
||
return None
|
||
else:
|
||
return inner(self, *args, **kwargs)
|
||
outer.__doc__ = inner.__doc__
|
||
return outer
|
||
|
||
class GeminiClient(cmd.Cmd):
|
||
|
||
def __init__(self, completekey="tab", restricted=False, synconly=False):
|
||
cmd.Cmd.__init__(self)
|
||
|
||
# Set umask so that nothing we create can be read by anybody else.
|
||
# The certificate cache and TOFU database contain "browser history"
|
||
# type sensitivie information.
|
||
os.umask(0o077)
|
||
|
||
|
||
self.no_cert_prompt = "\x1b[38;5;76m" + "ON" + "\x1b[38;5;255m" + "> " + "\x1b[0m"
|
||
self.cert_prompt = "\x1b[38;5;202m" + "ON" + "\x1b[38;5;255m"
|
||
self.offline_prompt = "\x1b[38;5;76m" + "OFF" + "\x1b[38;5;255m" + "> " + "\x1b[0m"
|
||
self.prompt = self.no_cert_prompt
|
||
self.gi = None
|
||
self.hist_index = 0
|
||
self.index = []
|
||
self.index_index = -1
|
||
self.lookup = self.index
|
||
self.marks = {}
|
||
self.page_index = 0
|
||
self.permanent_redirects = {}
|
||
self.previous_redirectors = set()
|
||
# Sync-only mode is restriced by design
|
||
self.restricted = restricted or synconly
|
||
self.visited_hosts = set()
|
||
self.offline_only = False
|
||
self.sync_only = False
|
||
self.support_http = _DO_HTTP
|
||
self.automatic_choice = "n"
|
||
|
||
self.client_certs = {
|
||
"active": None
|
||
}
|
||
self.active_cert_domains = []
|
||
self.active_is_transient = False
|
||
self.transient_certs_created = []
|
||
|
||
self.options = {
|
||
"debug" : False,
|
||
"beta" : False,
|
||
"ipv6" : True,
|
||
"timeout" : 600,
|
||
"short_timeout" : 5,
|
||
"width" : 72,
|
||
"auto_follow_redirects" : True,
|
||
"tls_mode" : "tofu",
|
||
"archives_size" : 200,
|
||
"history_size" : 200,
|
||
"max_size_download" : 10,
|
||
"editor" : None,
|
||
"download_images_first" : True,
|
||
"redirects" : True,
|
||
}
|
||
|
||
self.redirects = {
|
||
"twitter.com" : "nitter.42l.fr",
|
||
"youtube.com" : "yewtu.be",
|
||
"reddit.com" : "libredd.it",
|
||
"old.reddit.com": "libredd.it",
|
||
"medium.com" : "scribe.rip",
|
||
|
||
}
|
||
global TERM_WIDTH
|
||
TERM_WIDTH = self.options["width"]
|
||
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,
|
||
"cache_hits": 0,
|
||
}
|
||
|
||
self._connect_to_tofu_db()
|
||
|
||
def _connect_to_tofu_db(self):
|
||
|
||
db_path = os.path.join(_CONFIG_DIR, "tofu.db")
|
||
self.db_conn = sqlite3.connect(db_path)
|
||
self.db_cur = self.db_conn.cursor()
|
||
|
||
self.db_cur.execute("""CREATE TABLE IF NOT EXISTS cert_cache
|
||
(hostname text, address text, fingerprint text,
|
||
first_seen date, last_seen date, count integer)""")
|
||
|
||
def _go_to_gi(self, gi, update_hist=True, check_cache=True, handle=True,\
|
||
mode=None,limit_size=False):
|
||
"""This method might be considered "the heart of Offpunk".
|
||
Everything involved in fetching a gemini resource happens here:
|
||
sending the request over the network, parsing the response,
|
||
storing the response in a temporary file, choosing
|
||
and calling a handler program, and updating the history.
|
||
Nothing is returned."""
|
||
if not gi:
|
||
return
|
||
# Don't try to speak to servers running other protocols
|
||
elif gi.scheme == "mailto":
|
||
if handle and not self.sync_only:
|
||
resp = input("Send an email to %s Y/N? " %gi.path)
|
||
self.gi = gi
|
||
if resp.strip().lower() in ("y", "yes"):
|
||
if _HAS_XDGOPEN :
|
||
cmd = "xdg-open mailto:%s" %gi.path
|
||
run(cmd,direct_output=True)
|
||
else:
|
||
print("Cannot find a mail client to send mail to %s" %gi.path)
|
||
print("Please install xdg-open (usually from xdg-util package)")
|
||
return
|
||
elif gi.scheme not in ["file","list"] and gi.scheme not in standard_ports \
|
||
and not self.sync_only:
|
||
print("Sorry, no support for {} links.".format(gi.scheme))
|
||
return
|
||
|
||
# Obey permanent redirects
|
||
if gi.url in self.permanent_redirects:
|
||
new_gi = GeminiItem(self.permanent_redirects[gi.url], name=gi.name)
|
||
self._go_to_gi(new_gi)
|
||
return
|
||
|
||
# Use cache or mark as to_fetch if resource is not cached
|
||
# Why is this code useful ? It set the mimetype !
|
||
if self.offline_only:
|
||
if not gi.is_cache_valid():
|
||
self.get_list("to_fetch")
|
||
r = self.list_add_line("to_fetch",gi=gi,verbose=False)
|
||
if r:
|
||
print("%s not available, marked for syncing"%gi.url)
|
||
else:
|
||
print("%s already marked for syncing"%gi.url)
|
||
return
|
||
# check if local file exists.
|
||
if gi.local and not os.path.exists(gi.path):
|
||
print("Local file %s does not exist!" %gi.path)
|
||
return
|
||
|
||
elif not self.offline_only and not gi.local:
|
||
try:
|
||
if gi.scheme in ("http", "https"):
|
||
if self.support_http:
|
||
if limit_size:
|
||
# Let’s cap automatic downloads to 20Mo
|
||
max_download = int(self.options["max_size_download"])*1000000
|
||
else:
|
||
max_download = None
|
||
gi = self._fetch_http(gi,max_length=max_download)
|
||
elif handle and not self.sync_only:
|
||
if not _DO_HTTP:
|
||
print("Install python3-requests to handle http requests natively")
|
||
webbrowser.open_new_tab(gi.url)
|
||
return
|
||
else:
|
||
return
|
||
elif gi.scheme in ("gopher"):
|
||
gi = self._fetch_gopher(gi,timeout=self.options["short_timeout"])
|
||
elif gi.scheme in ("spartan"):
|
||
gi = self._fetch_spartan(gi)
|
||
else:
|
||
gi = self._fetch_over_network(gi)
|
||
except UserAbortException:
|
||
return
|
||
except Exception as err:
|
||
gi.set_error(err)
|
||
# Print an error message
|
||
# we fail silently when sync_only
|
||
print_error = not self.sync_only
|
||
if isinstance(err, socket.gaierror):
|
||
self.log["dns_failures"] += 1
|
||
if print_error:
|
||
print("ERROR: DNS error!")
|
||
elif isinstance(err, ConnectionRefusedError):
|
||
self.log["refused_connections"] += 1
|
||
if print_error:
|
||
print("ERROR1: Connection refused!")
|
||
elif isinstance(err, ConnectionResetError):
|
||
self.log["reset_connections"] += 1
|
||
if print_error:
|
||
print("ERROR2: Connection reset!")
|
||
elif isinstance(err, (TimeoutError, socket.timeout)):
|
||
self.log["timeouts"] += 1
|
||
if print_error:
|
||
print("""ERROR3: Connection timed out!
|
||
Slow internet connection? Use 'set timeout' to be more patient.""")
|
||
elif isinstance(err, FileExistsError):
|
||
print("""ERROR5: Trying to create a directory which already exists
|
||
in the cache : """)
|
||
print(err)
|
||
else:
|
||
if print_error:
|
||
print("ERROR4: " + str(type(err)) + " : " + str(err))
|
||
print("\n" + str(err.with_traceback(None)))
|
||
return
|
||
|
||
# Pass file to handler, unless we were asked not to
|
||
if gi :
|
||
display = handle and not self.sync_only
|
||
if display and _RENDER_IMAGE and self.options["download_images_first"] \
|
||
and not self.offline_only:
|
||
# We download images first
|
||
for image in gi.get_images(mode=mode):
|
||
if image:
|
||
img_gi = GeminiItem(image)
|
||
if not img_gi.is_cache_valid():
|
||
width = term_width() - 1
|
||
toprint = "Downloading %s" %image
|
||
toprint = toprint[:width]
|
||
toprint += " "*(width-len(toprint))
|
||
print(toprint,end="\r")
|
||
self._go_to_gi(img_gi, update_hist=False, check_cache=True, \
|
||
handle=False,limit_size=True)
|
||
if display and gi.display(mode=mode):
|
||
self.index = gi.get_links()
|
||
self.lookup = self.index
|
||
self.page_index = 0
|
||
self.index_index = -1
|
||
# Update state (external files are not added to history)
|
||
self.gi = gi
|
||
if update_hist and not self.sync_only:
|
||
self._update_history(gi)
|
||
elif display :
|
||
cmd_str = self._get_handler_cmd(gi.get_mime())
|
||
try:
|
||
# get tmpfile from gi !
|
||
tmpfile = gi.get_body(as_file=True)
|
||
run(cmd_str%tmpfile,direct_output=True)
|
||
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.")
|
||
|
||
def _fetch_http(self,gi,max_length=None):
|
||
def set_error(item,length,max_length):
|
||
err = "Size of %s is %s Mo\n"%(item.url,length)
|
||
err += "Offpunk only download automatically content under %s Mo\n" %(max_length/1000000)
|
||
err += "To retrieve this content anyway, type 'reload'."
|
||
item.set_error(err)
|
||
return item
|
||
header = {}
|
||
header["User-Agent"] = "Offpunk browser v%s"%_VERSION
|
||
parsed = urllib.parse.urlparse(gi.url)
|
||
# Code to translate URLs to better frontends (think twitter.com -> nitter)
|
||
if self.options["redirects"]:
|
||
netloc = parsed.netloc
|
||
if netloc.startswith("www."):
|
||
netloc = netloc[4:]
|
||
if netloc in self.redirects:
|
||
parsed = parsed._replace(netloc = self.redirects[netloc])
|
||
url = urllib.parse.urlunparse(parsed)
|
||
with requests.get(url,headers=header, stream=True,timeout=5) as response:
|
||
#print("This is header for %s"%gi.url)
|
||
#print(response.headers)
|
||
if "content-type" in response.headers:
|
||
mime = response.headers['content-type']
|
||
else:
|
||
mime = None
|
||
if "content-length" in response.headers:
|
||
length = int(response.headers['content-length'])
|
||
else:
|
||
length = 0
|
||
if max_length and length > max_length:
|
||
response.close()
|
||
return set_error(gi,str(length/1000000),max_length)
|
||
elif max_length and length == 0:
|
||
body = b''
|
||
for r in response.iter_content():
|
||
body += r
|
||
#We divide max_size for streamed content
|
||
#in order to catch them faster
|
||
if sys.getsizeof(body) > max_length/2:
|
||
response.close()
|
||
return set_error(gi,"streaming",max_length)
|
||
response.close()
|
||
else:
|
||
body = response.content
|
||
response.close()
|
||
if mime and "text/" in mime:
|
||
body = body.decode("UTF-8","replace")
|
||
gi.write_body(body,mime)
|
||
return gi
|
||
|
||
def _fetch_gopher(self,gi,timeout=10):
|
||
if not looks_like_url(gi.url):
|
||
print("%s is not a valide url" %gi.url)
|
||
parsed =urllib.parse.urlparse(gi.url)
|
||
host = parsed.hostname
|
||
port = parsed.port or 70
|
||
if parsed.path and parsed.path[0] == "/" and len(parsed.path) > 1:
|
||
splitted = parsed.path.split("/")
|
||
# We check if we have well a gopher type
|
||
if len(splitted[1]) == 1:
|
||
itemtype = parsed.path[1]
|
||
selector = parsed.path[2:]
|
||
else:
|
||
itemtype = "1"
|
||
selector = parsed.path
|
||
else:
|
||
itemtype = "1"
|
||
selector = parsed.path
|
||
addresses = socket.getaddrinfo(host, port, family=0,type=socket.SOCK_STREAM)
|
||
s = socket.create_connection((host,port))
|
||
for address in addresses:
|
||
self._debug("Connecting to: " + str(address[4]))
|
||
s = socket.socket(address[0], address[1])
|
||
s.settimeout(timeout)
|
||
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
|
||
if parsed.query:
|
||
request = selector + "\t" + parsed.query
|
||
else:
|
||
request = selector
|
||
request += "\r\n"
|
||
s.sendall(request.encode("UTF-8"))
|
||
response = s.makefile("rb").read()
|
||
# Transcode response into UTF-8
|
||
#if itemtype in ("0","1","h"):
|
||
if not itemtype in ("9","g","I","s"):
|
||
# Try most common encodings
|
||
for encoding in ("UTF-8", "ISO-8859-1"):
|
||
try:
|
||
response = response.decode("UTF-8")
|
||
break
|
||
except UnicodeDecodeError:
|
||
pass
|
||
else:
|
||
# try to find encoding
|
||
#if _HAS_CHARDET:
|
||
detected = chardet.detect(response)
|
||
response = response.decode(detected["encoding"])
|
||
#else:
|
||
#raise UnicodeDecodeError
|
||
if itemtype == "0":
|
||
mime = "text/gemini"
|
||
elif itemtype == "1":
|
||
mime = "text/gopher"
|
||
elif itemtype == "h":
|
||
mime = "text/html"
|
||
elif itemtype in ("9","g","I","s"):
|
||
mime = None
|
||
else:
|
||
# by default, we should consider Gopher
|
||
mime = "text/gopher"
|
||
gi.write_body(response,mime)
|
||
return gi
|
||
|
||
# Copied from reference spartan client by Michael Lazar
|
||
def _fetch_spartan(self,gi):
|
||
url_parts = urllib.parse.urlparse(gi.url)
|
||
host = url_parts.hostname
|
||
port = url_parts.port or 300
|
||
path = url_parts.path or "/"
|
||
query = url_parts.query
|
||
|
||
redirect_url = None
|
||
|
||
with socket.create_connection((host,port)) as sock:
|
||
if query:
|
||
data = urllib.parse.unquote_to_bytes(query)
|
||
else:
|
||
data = b""
|
||
encoded_host = host.encode("idna")
|
||
ascii_path = urllib.parse.unquote_to_bytes(path)
|
||
encoded_path = urllib.parse.quote_from_bytes(ascii_path).encode("ascii")
|
||
sock.send(b"%s %s %d\r\n" % (encoded_host,encoded_path,len(data)))
|
||
fp = sock.makefile("rb")
|
||
response = fp.readline(4096).decode("ascii").strip("\r\n")
|
||
parts = response.split(" ",maxsplit=1)
|
||
code,meta = int(parts[0]),parts[1]
|
||
if code == 2:
|
||
body = fp.read()
|
||
if meta.startswith("text"):
|
||
body = body.decode("UTF-8")
|
||
gi.write_body(body,meta)
|
||
elif code == 3:
|
||
redirect_url = url_parts._replace(path=meta).geturl()
|
||
else:
|
||
gi.set_error("Spartan code %s: Error %s"%(code,meta))
|
||
if redirect_url:
|
||
gi = GeminiItem(redirect_url)
|
||
self._fetch_spartan(gi)
|
||
return gi
|
||
|
||
# fetch_over_network will modify with gi.write_body(body,mime)
|
||
# before returning the gi
|
||
def _fetch_over_network(self, gi):
|
||
|
||
# Be careful with client certificates!
|
||
# Are we crossing a domain boundary?
|
||
if self.active_cert_domains and gi.host not in self.active_cert_domains:
|
||
if self.active_is_transient:
|
||
print("Permanently delete currently active transient certificate?")
|
||
resp = input("Y/N? ")
|
||
if resp.strip().lower() in ("y", "yes"):
|
||
print("Destroying certificate.")
|
||
self._deactivate_client_cert()
|
||
else:
|
||
print("Staying here.")
|
||
raise UserAbortException()
|
||
else:
|
||
print("PRIVACY ALERT: Deactivate client cert before connecting to a new domain?")
|
||
resp = input("Y/N? ")
|
||
if resp.strip().lower() in ("n", "no"):
|
||
print("Keeping certificate active for {}".format(gi.host))
|
||
else:
|
||
print("Deactivating certificate.")
|
||
self._deactivate_client_cert()
|
||
|
||
# Suggest reactivating previous certs
|
||
if not self.client_certs["active"] and gi.host in self.client_certs:
|
||
print("PRIVACY ALERT: Reactivate previously used client cert for {}?".format(gi.host))
|
||
resp = input("Y/N? ")
|
||
if resp.strip().lower() in ("y", "yes"):
|
||
self._activate_client_cert(*self.client_certs[gi.host])
|
||
else:
|
||
print("Remaining unidentified.")
|
||
self.client_certs.pop(gi.host)
|
||
|
||
# Is this a local file?
|
||
if gi.local:
|
||
address, f = None, open(gi.path, "rb")
|
||
else:
|
||
address, f = self._send_request(gi)
|
||
|
||
# Spec dictates <META> should not exceed 1024 bytes,
|
||
# so maximum valid header length is 1027 bytes.
|
||
header = f.readline(1027)
|
||
header = header.decode("UTF-8")
|
||
if not header or header[-1] != '\n':
|
||
raise RuntimeError("Received invalid header from server!")
|
||
header = header.strip()
|
||
self._debug("Response header: %s." % header)
|
||
# Validate header
|
||
status, meta = header.split(maxsplit=1)
|
||
if len(meta) > 1024 or len(status) != 2 or not status.isnumeric():
|
||
f.close()
|
||
raise RuntimeError("Received invalid header from server!")
|
||
|
||
# Update redirect loop/maze escaping state
|
||
if not status.startswith("3"):
|
||
self.previous_redirectors = set()
|
||
|
||
# Handle non-SUCCESS headers, which don't have a response body
|
||
# Inputs
|
||
if status.startswith("1"):
|
||
if self.sync_only:
|
||
return None
|
||
else:
|
||
print(meta)
|
||
if status == "11":
|
||
user_input = getpass.getpass("> ")
|
||
else:
|
||
user_input = input("> ")
|
||
return self._fetch_over_network(gi.query(user_input))
|
||
|
||
# Redirects
|
||
elif status.startswith("3"):
|
||
new_gi = GeminiItem(gi.absolutise_url(meta))
|
||
if new_gi.url == gi.url:
|
||
raise RuntimeError("URL redirects to itself!")
|
||
elif new_gi.url in self.previous_redirectors:
|
||
raise RuntimeError("Caught in redirect loop!")
|
||
elif len(self.previous_redirectors) == _MAX_REDIRECTS:
|
||
raise RuntimeError("Refusing to follow more than %d consecutive redirects!" % _MAX_REDIRECTS)
|
||
elif self.sync_only:
|
||
follow = self.automatic_choice
|
||
# Never follow cross-domain redirects without asking
|
||
elif new_gi.host != gi.host:
|
||
follow = input("Follow cross-domain redirect to %s? (y/n) " % new_gi.url)
|
||
# Never follow cross-protocol redirects without asking
|
||
elif new_gi.scheme != gi.scheme:
|
||
follow = input("Follow cross-protocol redirect to %s? (y/n) " % new_gi.url)
|
||
# Don't follow *any* redirect without asking if auto-follow is off
|
||
elif not self.options["auto_follow_redirects"]:
|
||
follow = input("Follow redirect to %s? (y/n) " % new_gi.url)
|
||
# Otherwise, follow away
|
||
else:
|
||
follow = "yes"
|
||
if follow.strip().lower() not in ("y", "yes"):
|
||
raise UserAbortException()
|
||
self._debug("Following redirect to %s." % new_gi.url)
|
||
self._debug("This is consecutive redirect number %d." % len(self.previous_redirectors))
|
||
self.previous_redirectors.add(gi.url)
|
||
if status == "31":
|
||
# Permanent redirect
|
||
self.permanent_redirects[gi.url] = new_gi.url
|
||
return self._fetch_over_network(new_gi)
|
||
|
||
# Errors
|
||
elif status.startswith("4") or status.startswith("5"):
|
||
raise RuntimeError(meta)
|
||
|
||
# Client cert
|
||
elif status.startswith("6"):
|
||
self._handle_cert_request(meta)
|
||
return self._fetch_over_network(gi)
|
||
|
||
# Invalid status
|
||
elif not status.startswith("2"):
|
||
raise RuntimeError("Server returned undefined status code %s!" % status)
|
||
|
||
# If we're here, this must be a success and there's a response body
|
||
assert status.startswith("2")
|
||
|
||
mime = meta
|
||
# Read the response body over the network
|
||
fbody = f.read()
|
||
# DEFAULT GEMINI MIME
|
||
if mime == "":
|
||
mime = "text/gemini; charset=utf-8"
|
||
shortmime, mime_options = cgi.parse_header(mime)
|
||
if "charset" in mime_options:
|
||
try:
|
||
codecs.lookup(mime_options["charset"])
|
||
except LookupError:
|
||
raise RuntimeError("Header declared unknown encoding %s" % value)
|
||
if shortmime.startswith("text/"):
|
||
#Get the charset and default to UTF-8 in none
|
||
encoding = mime_options.get("charset", "UTF-8")
|
||
try:
|
||
body = fbody.decode(encoding)
|
||
except UnicodeError:
|
||
raise RuntimeError("Could not decode response body using %s\
|
||
encoding declared in header!" % encoding)
|
||
else:
|
||
body = fbody
|
||
gi.write_body(body,mime)
|
||
return 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."""
|
||
host, port = gi.host, gi.port
|
||
# Do DNS resolution
|
||
addresses = self._get_addresses(host, port)
|
||
|
||
# Prepare TLS context
|
||
protocol = ssl.PROTOCOL_TLS_CLIENT if sys.version_info.minor >=6 else ssl.PROTOCOL_TLSv1_2
|
||
context = ssl.SSLContext(protocol)
|
||
# Use CAs or TOFU
|
||
if self.options["tls_mode"] == "ca":
|
||
context.verify_mode = ssl.CERT_REQUIRED
|
||
context.check_hostname = True
|
||
context.load_default_certs()
|
||
else:
|
||
context.check_hostname = False
|
||
context.verify_mode = ssl.CERT_NONE
|
||
# Impose minimum TLS version
|
||
## In 3.7 and above, this is easy...
|
||
if sys.version_info.minor >= 7:
|
||
context.minimum_version = ssl.TLSVersion.TLSv1_2
|
||
## Otherwise, it seems very hard...
|
||
## The below is less strict than it ought to be, but trying to disable
|
||
## TLS v1.1 here using ssl.OP_NO_TLSv1_1 produces unexpected failures
|
||
## with recent versions of OpenSSL. What a mess...
|
||
else:
|
||
context.options |= ssl.OP_NO_SSLv3
|
||
context.options |= ssl.OP_NO_SSLv2
|
||
# Try to enforce sensible ciphers
|
||
try:
|
||
context.set_ciphers("AESGCM+ECDHE:AESGCM+DHE:CHACHA20+ECDHE:CHACHA20+DHE:!DSS:!SHA1:!MD5:@STRENGTH")
|
||
except ssl.SSLError:
|
||
# Rely on the server to only support sensible things, I guess...
|
||
pass
|
||
# Load client certificate if needed
|
||
if self.client_certs["active"]:
|
||
certfile, keyfile = self.client_certs["active"]
|
||
context.load_cert_chain(certfile, keyfile)
|
||
|
||
# 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])
|
||
if self.sync_only:
|
||
timeout = self.options["short_timeout"]
|
||
else:
|
||
timeout = self.options["timeout"]
|
||
s.settimeout(timeout)
|
||
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
|
||
|
||
if sys.version_info.minor >=5:
|
||
self._debug("Established {} connection.".format(s.version()))
|
||
self._debug("Cipher is: {}.".format(s.cipher()))
|
||
|
||
# Do TOFU
|
||
if self.options["tls_mode"] != "ca":
|
||
cert = s.getpeercert(binary_form=True)
|
||
self._validate_cert(address[4][0], host, cert)
|
||
|
||
# Remember that we showed the current cert to this domain...
|
||
if self.client_certs["active"]:
|
||
self.active_cert_domains.append(gi.host)
|
||
self.client_certs[gi.host] = self.client_certs["active"]
|
||
|
||
# Send request and wrap response in a file descriptor
|
||
self._debug("Sending %s<CRLF>" % gi.url)
|
||
s.sendall((gi.url + CRLF).encode("UTF-8"))
|
||
mf= s.makefile(mode = "rb")
|
||
return address, mf
|
||
|
||
def _get_addresses(self, host, port):
|
||
# DNS lookup - will get IPv4 and IPv6 records if IPv6 is enabled
|
||
if ":" in 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(host, 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)
|
||
|
||
return addresses
|
||
|
||
|
||
def _handle_cert_request(self, meta):
|
||
|
||
# Don't do client cert stuff in restricted mode, as in principle
|
||
# it could be used to fill up the disk by creating a whole lot of
|
||
# certificates
|
||
if self.restricted:
|
||
print("The server is requesting a client certificate.")
|
||
print("These are not supported in restricted mode, sorry.")
|
||
raise UserAbortException()
|
||
|
||
print("SERVER SAYS: ", meta)
|
||
# Present different messages for different 6x statuses, but
|
||
# handle them the same.
|
||
if status in ("64", "65"):
|
||
print("The server rejected your certificate because it is either expired or not yet valid.")
|
||
elif status == "63":
|
||
print("The server did not accept your certificate.")
|
||
print("You may need to e.g. coordinate with the admin to get your certificate fingerprint whitelisted.")
|
||
else:
|
||
print("The site {} is requesting a client certificate.".format(gi.host))
|
||
print("This will allow the site to recognise you across requests.")
|
||
|
||
# Give the user choices
|
||
print("What do you want to do?")
|
||
print("1. Give up.")
|
||
print("2. Generate a new transient certificate.")
|
||
print("3. Generate a new persistent certificate.")
|
||
print("4. Load a previously generated persistent.")
|
||
print("5. Load certificate from an external file.")
|
||
if self.sync_only:
|
||
choice = 1
|
||
else:
|
||
choice = input("> ").strip()
|
||
if choice == "2":
|
||
self._generate_transient_cert_cert()
|
||
elif choice == "3":
|
||
self._generate_persistent_client_cert()
|
||
elif choice == "4":
|
||
self._choose_client_cert()
|
||
elif choice == "5":
|
||
self._load_client_cert()
|
||
else:
|
||
print("Giving up.")
|
||
raise UserAbortException()
|
||
|
||
def _validate_cert(self, address, host, cert):
|
||
"""
|
||
Validate a TLS certificate in TOFU mode.
|
||
|
||
If the cryptography module is installed:
|
||
- Check the certificate Common Name or SAN matches `host`
|
||
- Check the certificate's not valid before date is in the past
|
||
- Check the certificate's not valid after date is in the future
|
||
|
||
Whether the cryptography module is installed or not, check the
|
||
certificate's fingerprint against the TOFU database to see if we've
|
||
previously encountered a different certificate for this IP address and
|
||
hostname.
|
||
"""
|
||
now = datetime.datetime.utcnow()
|
||
if _HAS_CRYPTOGRAPHY:
|
||
# Using the cryptography module we can get detailed access
|
||
# to the properties of even self-signed certs, unlike in
|
||
# the standard ssl library...
|
||
c = x509.load_der_x509_certificate(cert, _BACKEND)
|
||
# Check certificate validity dates
|
||
if c.not_valid_before >= now:
|
||
raise CertificateError("Certificate not valid until: {}!".format(c.not_valid_before))
|
||
elif c.not_valid_after <= now:
|
||
raise CertificateError("Certificate expired as of: {})!".format(c.not_valid_after))
|
||
|
||
# Check certificate hostnames
|
||
names = []
|
||
common_name = c.subject.get_attributes_for_oid(x509.oid.NameOID.COMMON_NAME)
|
||
if common_name:
|
||
names.append(common_name[0].value)
|
||
try:
|
||
names.extend([alt.value for alt in c.extensions.get_extension_for_oid(x509.oid.ExtensionOID.SUBJECT_ALTERNATIVE_NAME).value])
|
||
except x509.ExtensionNotFound:
|
||
pass
|
||
names = set(names)
|
||
for name in names:
|
||
try:
|
||
ssl._dnsname_match(name, host)
|
||
break
|
||
except CertificateError:
|
||
continue
|
||
else:
|
||
# If we didn't break out, none of the names were valid
|
||
raise CertificateError("Hostname does not match certificate common name or any alternative names.")
|
||
|
||
sha = hashlib.sha256()
|
||
sha.update(cert)
|
||
fingerprint = sha.hexdigest()
|
||
|
||
# Have we been here before?
|
||
self.db_cur.execute("""SELECT fingerprint, first_seen, last_seen, count
|
||
FROM cert_cache
|
||
WHERE hostname=? AND address=?""", (host, address))
|
||
cached_certs = self.db_cur.fetchall()
|
||
|
||
# If so, check for a match
|
||
if cached_certs:
|
||
max_count = 0
|
||
most_frequent_cert = None
|
||
for cached_fingerprint, first, last, count in cached_certs:
|
||
if count > max_count:
|
||
max_count = count
|
||
most_frequent_cert = cached_fingerprint
|
||
if fingerprint == cached_fingerprint:
|
||
# Matched!
|
||
self._debug("TOFU: Accepting previously seen ({} times) certificate {}".format(count, fingerprint))
|
||
self.db_cur.execute("""UPDATE cert_cache
|
||
SET last_seen=?, count=?
|
||
WHERE hostname=? AND address=? AND fingerprint=?""",
|
||
(now, count+1, host, address, fingerprint))
|
||
self.db_conn.commit()
|
||
break
|
||
else:
|
||
if _HAS_CRYPTOGRAPHY:
|
||
# Load the most frequently seen certificate to see if it has
|
||
# expired
|
||
certdir = os.path.join(_CONFIG_DIR, "cert_cache")
|
||
with open(os.path.join(certdir, most_frequent_cert+".crt"), "rb") as fp:
|
||
previous_cert = fp.read()
|
||
previous_cert = x509.load_der_x509_certificate(previous_cert, _BACKEND)
|
||
previous_ttl = previous_cert.not_valid_after - now
|
||
print(previous_ttl)
|
||
|
||
self._debug("TOFU: Unrecognised certificate {}! Raising the alarm...".format(fingerprint))
|
||
print("****************************************")
|
||
print("[SECURITY WARNING] Unrecognised certificate!")
|
||
print("The certificate presented for {} ({}) has never been seen before.".format(host, address))
|
||
print("This MIGHT be a Man-in-the-Middle attack.")
|
||
print("A different certificate has previously been seen {} times.".format(max_count))
|
||
if _HAS_CRYPTOGRAPHY:
|
||
if previous_ttl < datetime.timedelta():
|
||
print("That certificate has expired, which reduces suspicion somewhat.")
|
||
else:
|
||
print("That certificate is still valid for: {}".format(previous_ttl))
|
||
print("****************************************")
|
||
print("Attempt to verify the new certificate fingerprint out-of-band:")
|
||
print(fingerprint)
|
||
if self.sync_only:
|
||
choice = self.automatic_choice
|
||
else:
|
||
choice = input("Accept this new certificate? Y/N ").strip().lower()
|
||
if choice in ("y", "yes"):
|
||
self.db_cur.execute("""INSERT INTO cert_cache
|
||
VALUES (?, ?, ?, ?, ?, ?)""",
|
||
(host, address, fingerprint, now, now, 1))
|
||
self.db_conn.commit()
|
||
with open(os.path.join(certdir, fingerprint+".crt"), "wb") as fp:
|
||
fp.write(cert)
|
||
else:
|
||
raise Exception("TOFU Failure!")
|
||
|
||
# If not, cache this cert
|
||
else:
|
||
self._debug("TOFU: Blindly trusting first ever certificate for this host!")
|
||
self.db_cur.execute("""INSERT INTO cert_cache
|
||
VALUES (?, ?, ?, ?, ?, ?)""",
|
||
(host, address, fingerprint, now, now, 1))
|
||
self.db_conn.commit()
|
||
certdir = os.path.join(_CONFIG_DIR, "cert_cache")
|
||
if not os.path.exists(certdir):
|
||
os.makedirs(certdir)
|
||
with open(os.path.join(certdir, fingerprint+".crt"), "wb") as fp:
|
||
fp.write(cert)
|
||
|
||
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.
|
||
if _HAS_XDGOPEN:
|
||
cmd_str = "xdg-open %s"
|
||
else:
|
||
cmd_str = "echo ""Can’t find how to open %s"""
|
||
print("Please install xdg-open (usually from xdg-util package)")
|
||
self._debug("Using handler: %s" % cmd_str)
|
||
return cmd_str
|
||
|
||
#TODO: remove format_geminiitem
|
||
def _format_geminiitem(self, index, gi, url=False):
|
||
protocol = "" if gi.scheme == "gemini" else " %s" % gi.scheme
|
||
line = "[%d%s] %s" % (index, protocol, gi.name or gi.url)
|
||
if gi.name and url:
|
||
line += " (%s)" % gi.url
|
||
return line
|
||
|
||
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):
|
||
# We never update while in sync_only
|
||
if self.sync_only:
|
||
return
|
||
# We don’t add lists to history
|
||
#if not gi or os.path.join(_DATA_DIR,"lists") in gi.url:
|
||
# return
|
||
histlist = self.get_list("history")
|
||
links = self.list_get_links("history")
|
||
# avoid duplicate
|
||
length = len(links)
|
||
if length > self.options["history_size"]:
|
||
length = self.options["history_size"]
|
||
if length > 0 and links[self.hist_index] == gi:
|
||
return
|
||
self.list_add_top("history",limit=self.options["history_size"],truncate_lines=self.hist_index)
|
||
self.hist_index = 0
|
||
|
||
|
||
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 _debug(self, debug_text):
|
||
if not self.options["debug"]:
|
||
return
|
||
debug_text = "\x1b[0;32m[DEBUG] " + debug_text + "\x1b[0m"
|
||
print(debug_text)
|
||
|
||
def _load_client_cert(self):
|
||
"""
|
||
Interactively load a TLS client certificate from the filesystem in PEM
|
||
format.
|
||
"""
|
||
print("Loading client certificate file, in PEM format (blank line to cancel)")
|
||
certfile = input("Certfile path: ").strip()
|
||
if not certfile:
|
||
print("Aborting.")
|
||
return
|
||
certfile = os.path.expanduser(certfile)
|
||
if not os.path.isfile(certfile):
|
||
print("Certificate file {} does not exist.".format(certfile))
|
||
return
|
||
print("Loading private key file, in PEM format (blank line to cancel)")
|
||
keyfile = input("Keyfile path: ").strip()
|
||
if not keyfile:
|
||
print("Aborting.")
|
||
return
|
||
keyfile = os.path.expanduser(keyfile)
|
||
if not os.path.isfile(keyfile):
|
||
print("Private key file {} does not exist.".format(keyfile))
|
||
return
|
||
self._activate_client_cert(certfile, keyfile)
|
||
|
||
def _generate_transient_cert_cert(self):
|
||
"""
|
||
Use `openssl` command to generate a new transient client certificate
|
||
with 24 hours of validity.
|
||
"""
|
||
certdir = os.path.join(_CONFIG_DIR, "transient_certs")
|
||
name = str(uuid.uuid4())
|
||
self._generate_client_cert(certdir, name, transient=True)
|
||
self.active_is_transient = True
|
||
self.transient_certs_created.append(name)
|
||
|
||
def _generate_persistent_client_cert(self):
|
||
"""
|
||
Interactively use `openssl` command to generate a new persistent client
|
||
certificate with one year of validity.
|
||
"""
|
||
certdir = os.path.join(_CONFIG_DIR, "client_certs")
|
||
print("What do you want to name this new certificate?")
|
||
print("Answering `mycert` will create `{0}/mycert.crt` and `{0}/mycert.key`".format(certdir))
|
||
name = input("> ")
|
||
if not name.strip():
|
||
print("Aborting.")
|
||
return
|
||
self._generate_client_cert(certdir, name)
|
||
|
||
def _generate_client_cert(self, certdir, basename, transient=False):
|
||
"""
|
||
Use `openssl` binary to generate a client certificate (which may be
|
||
transient or persistent) and save the certificate and private key to the
|
||
specified directory with the specified basename.
|
||
"""
|
||
if not os.path.exists(certdir):
|
||
os.makedirs(certdir)
|
||
certfile = os.path.join(certdir, basename+".crt")
|
||
keyfile = os.path.join(certdir, basename+".key")
|
||
cmd = "openssl req -x509 -newkey rsa:2048 -days {} -nodes -keyout {} -out {}".format(1 if transient else 365, keyfile, certfile)
|
||
if transient:
|
||
cmd += " -subj '/CN={}'".format(basename)
|
||
os.system(cmd)
|
||
self._activate_client_cert(certfile, keyfile)
|
||
|
||
def _choose_client_cert(self):
|
||
"""
|
||
Interactively select a previously generated client certificate and
|
||
activate it.
|
||
"""
|
||
certdir = os.path.join(_CONFIG_DIR, "client_certs")
|
||
certs = glob.glob(os.path.join(certdir, "*.crt"))
|
||
if len(certs) == 0:
|
||
print("There are no previously generated certificates.")
|
||
return
|
||
certdir = {}
|
||
for n, cert in enumerate(certs):
|
||
certdir[str(n+1)] = (cert, os.path.splitext(cert)[0] + ".key")
|
||
print("{}. {}".format(n+1, os.path.splitext(os.path.basename(cert))[0]))
|
||
choice = input("> ").strip()
|
||
if choice in certdir:
|
||
certfile, keyfile = certdir[choice]
|
||
self._activate_client_cert(certfile, keyfile)
|
||
else:
|
||
print("What?")
|
||
|
||
def _activate_client_cert(self, certfile, keyfile):
|
||
self.client_certs["active"] = (certfile, keyfile)
|
||
self.active_cert_domains = []
|
||
self.prompt = self.cert_prompt + "+" + os.path.basename(certfile).replace('.crt','') + "> " + "\x1b[0m"
|
||
self._debug("Using ID {} / {}.".format(*self.client_certs["active"]))
|
||
|
||
def _deactivate_client_cert(self):
|
||
if self.active_is_transient:
|
||
for filename in self.client_certs["active"]:
|
||
os.remove(filename)
|
||
for domain in self.active_cert_domains:
|
||
self.client_certs.pop(domain)
|
||
self.client_certs["active"] = None
|
||
self.active_cert_domains = []
|
||
self.prompt = self.no_cert_prompt
|
||
self.active_is_transient = False
|
||
|
||
# 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_find(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 access it like an URL
|
||
if looks_like_url(line):
|
||
return self.do_go(line)
|
||
# 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
|
||
@restricted
|
||
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 :
|
||
# Show current value of one specific setting
|
||
option = line.strip()
|
||
if option == "redirects":
|
||
print("redirects : %s" %self.options["redirects"])
|
||
if self.options["redirects"]:
|
||
toprint = "Redirections are enabled. (disable with \"set redirects false\")\n"
|
||
else:
|
||
toprint = "Redirections are disabled. (enable with \"set redirects true\")\n"
|
||
toprint += "--------------------------\n"
|
||
for r in self.redirects:
|
||
toprint += ("%s\t->\t%s\n" %(r,self.redirects[r]))
|
||
toprint +="\nTo add new, use \"set redirects origine.com destination.org\""
|
||
print(toprint)
|
||
elif option in self.options:
|
||
print("%s %s" % (option, self.options[option]))
|
||
else:
|
||
print("Unrecognised option %s" % option)
|
||
else:
|
||
# Set value of one specific setting
|
||
option, value = line.split(" ", 1)
|
||
if option not in self.options:
|
||
print("Unrecognised option %s" % option)
|
||
return
|
||
# Validate / convert values
|
||
elif option == "tls_mode":
|
||
if value.lower() not in ("ca", "tofu"):
|
||
print("TLS mode must be `ca` or `tofu`!")
|
||
return
|
||
elif option == "width":
|
||
if value.isnumeric():
|
||
value = int(value)
|
||
print("changing width to ",value)
|
||
global TERM_WIDTH
|
||
TERM_WIDTH = value
|
||
else:
|
||
print("%s is not a valid width (integer required)"%value)
|
||
elif option == "redirects" and len(value.split(" ")) > 1:
|
||
if len(value.split(" ")) <= 1:
|
||
if value.lower() in ["true","false"]:
|
||
if value.lower() == "true":
|
||
value = True
|
||
toprint = "Redirections are enabled\n"
|
||
toprint = "------------------------\n"
|
||
for r in self.redirects:
|
||
toprint += ("%s\t->\t%s\n" %(r,self.redirects[r]))
|
||
print(toprint)
|
||
else:
|
||
value = False
|
||
print("Redirections are disabled")
|
||
elif value in self.redirects:
|
||
print("%s is redirected to %s" %(value,self.redirects[value]))
|
||
else:
|
||
print("Please add a destination where to redirect %s" %value)
|
||
else:
|
||
orig, dest = value.split(" ",1)
|
||
self.redirects[orig] = dest
|
||
print("%s will now be redirected to %s" %(orig,dest))
|
||
elif option == "beta":
|
||
if value.lower() == "true":
|
||
global BETA
|
||
BETA = True
|
||
print("Experimental features are enabled.")
|
||
else:
|
||
# global BETA
|
||
BETA = False
|
||
print("Experimental features are disabled.")
|
||
self.options["beta"] = BETA
|
||
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
|
||
|
||
@restricted
|
||
def do_cert(self, line):
|
||
"""Manage client certificates"""
|
||
print("Managing client certificates")
|
||
if self.client_certs["active"]:
|
||
print("Active certificate: {}".format(self.client_certs["active"][0]))
|
||
print("1. Deactivate client certificate.")
|
||
print("2. Generate new certificate.")
|
||
print("3. Load previously generated certificate.")
|
||
print("4. Load externally created client certificate from file.")
|
||
print("Enter blank line to exit certificate manager.")
|
||
choice = input("> ").strip()
|
||
if choice == "1":
|
||
print("Deactivating client certificate.")
|
||
self._deactivate_client_cert()
|
||
elif choice == "2":
|
||
self._generate_persistent_client_cert()
|
||
elif choice == "3":
|
||
self._choose_client_cert()
|
||
elif choice == "4":
|
||
self._load_client_cert()
|
||
else:
|
||
print("Aborting.")
|
||
|
||
@restricted
|
||
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?")
|
||
|
||
def do_abbrevs(self, *args):
|
||
"""Print all Offpunk command abbreviations."""
|
||
header = "Command Abbreviations:"
|
||
self.stdout.write("\n{}\n".format(str(header)))
|
||
if self.ruler:
|
||
self.stdout.write("{}\n".format(str(self.ruler * len(header))))
|
||
for k, v in _ABBREVS.items():
|
||
self.stdout.write("{:<7} {}\n".format(k, v))
|
||
self.stdout.write("\n")
|
||
|
||
def do_offline(self, *args):
|
||
"""Use Offpunk offline by only accessing cached content"""
|
||
if self.offline_only:
|
||
print("Offline and undisturbed.")
|
||
else:
|
||
self.offline_only = True
|
||
self.prompt = self.offline_prompt
|
||
print("Offpunk is now offline and will only access cached content")
|
||
|
||
def do_online(self, *args):
|
||
"""Use Offpunk online with a direct connection"""
|
||
if self.offline_only:
|
||
self.offline_only = False
|
||
self.prompt = self.no_cert_prompt
|
||
print("Offpunk is online and will access the network")
|
||
else:
|
||
print("Already online. Try offline.")
|
||
|
||
def do_copy(self, arg):
|
||
"""Copy the content of the last visited page as gemtext in the clipboard.
|
||
Use with "url" as argument to only copy the adress.
|
||
Use with "raw" to copy ANSI content as seen in your terminal (not gemtext).
|
||
Use with "cache" to copy the path of the cached content."""
|
||
if self.gi:
|
||
if _HAS_XSEL:
|
||
args = arg.split()
|
||
if args and args[0] == "url":
|
||
if len(args) > 1 and args[1].isdecimal():
|
||
gi = self.index[int(args[1])-1]
|
||
url = gi.url
|
||
else:
|
||
url = self.gi.url
|
||
run("echo %s |xsel -b -i" % url,direct_output=True)
|
||
elif args and args[0] == "raw":
|
||
run("cat %s |xsel -b -i" % self.gi.get_temp_filename(),direct_output=True)
|
||
elif args and args[0] == "cache":
|
||
run("echo %s |xsel -b -i" % self.gi.get_cache_path(), direct_output=True)
|
||
else:
|
||
run("cat %s |xsel -b -i" % self.gi.get_body(as_file=True), direct_output=True)
|
||
else:
|
||
print("Please install xsel to use copy")
|
||
else:
|
||
print("No content to copy, visit a page first")
|
||
|
||
### Stuff for getting around
|
||
def do_go(self, line):
|
||
"""Go to a gemini URL or marked item."""
|
||
line = line.strip()
|
||
if not line:
|
||
if shutil.which('xsel'):
|
||
clipboards = []
|
||
urls = []
|
||
for selec in ["-p","-s","-b"]:
|
||
try:
|
||
clipboards.append(run("xsel "+selec))
|
||
except Exception as err:
|
||
#print("Skippink clipboard %s because %s"%(selec,err))
|
||
pass
|
||
for u in clipboards:
|
||
if "://" in u and looks_like_url(u) and u not in urls :
|
||
urls.append(u)
|
||
if len(urls) > 1:
|
||
self.lookup = []
|
||
for u in urls:
|
||
self.lookup.append(GeminiItem(u))
|
||
print("Where do you want to go today?")
|
||
self._show_lookup()
|
||
elif len(urls) == 1:
|
||
self.do_go(urls[0])
|
||
else:
|
||
print("Go where? (hint: simply copy an URL in your clipboard)")
|
||
else:
|
||
print("Go where? (hint: install xsel to go to copied URLs)")
|
||
|
||
# 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)):
|
||
self._go_to_gi(GeminiItem(line))
|
||
# If this isn't a mark, treat it as a URL
|
||
elif looks_like_url(line):
|
||
self._go_to_gi(GeminiItem(line))
|
||
else:
|
||
print("%s is not a valid URL to go"%line)
|
||
|
||
@needs_gi
|
||
def do_reload(self, *args):
|
||
"""Reload the current URL."""
|
||
if self.offline_only:
|
||
self.get_list("to_fetch")
|
||
r = self.list_add_line("to_fetch",gi=self.gi,verbose=False)
|
||
if r:
|
||
print("%s marked for syncing" %self.gi.url)
|
||
else:
|
||
print("%s already marked for syncing" %self.gi.url)
|
||
else:
|
||
self._go_to_gi(self.gi, check_cache=False)
|
||
|
||
@needs_gi
|
||
def do_up(self, *args):
|
||
"""Go up one directory in the path.
|
||
Take an integer as argument to go up multiple times."""
|
||
level = 1
|
||
if args[0].isnumeric():
|
||
level = int(args[0])
|
||
elif args[0] != "":
|
||
print("Up only take integer as arguments")
|
||
self._go_to_gi(self.gi.up(level=level))
|
||
|
||
def do_back(self, *args):
|
||
"""Go back to the previous gemini item."""
|
||
histfile = self.get_list("history")
|
||
links = self.list_get_links("history")
|
||
if self.hist_index >= len(links) -1:
|
||
return
|
||
self.hist_index += 1
|
||
gi = links[self.hist_index]
|
||
self._go_to_gi(gi, update_hist=False)
|
||
|
||
def do_forward(self, *args):
|
||
"""Go forward to the next gemini item."""
|
||
histfile = self.get_list("history")
|
||
links = self.list_get_links("history")
|
||
if self.hist_index <= 0:
|
||
return
|
||
self.hist_index -= 1
|
||
gi = links[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."""
|
||
self._go_to_gi(self.gi.root())
|
||
|
||
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 item can be added back to the end of the tour with `tour .`.
|
||
Current tour can be listed with `tour ls` and scrubbed with `tour clear`."""
|
||
# Creating the tour list if needed
|
||
self.get_list("tour")
|
||
line = line.strip()
|
||
if not line:
|
||
# Fly to next waypoint on tour
|
||
if len(self.list_get_links("tour")) < 1:
|
||
print("End of tour.")
|
||
else:
|
||
url = self.list_go_to_line("1","tour")
|
||
if url:
|
||
self.list_rm_url(url,"tour")
|
||
elif line == "ls":
|
||
self.list_show("tour")
|
||
elif line == "clear":
|
||
for l in self.list_get_links("tour"):
|
||
self.list_rm_url(l.url_mode(),"tour")
|
||
elif line == "*":
|
||
for l in self.lookup:
|
||
self.list_add_line("tour",gi=l,verbose=False)
|
||
elif line == ".":
|
||
self.list_add_line("tour",verbose=False)
|
||
elif looks_like_url(line):
|
||
self.list_add_line("tour",gi=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.list_add_line("tour",gi=gi,verbose=False)
|
||
elif len(pair) == 2:
|
||
# Two endpoints for a range of indices
|
||
if int(pair[0]) < int(pair[1]):
|
||
for n in range(int(pair[0]), int(pair[1]) + 1):
|
||
gi = self.lookup[n-1]
|
||
self.list_add_line("tour",gi=gi,verbose=False)
|
||
else:
|
||
for n in range(int(pair[0]), int(pair[1]) - 1, -1):
|
||
gi = self.lookup[n-1]
|
||
self.list_add_line("tour",gi=gi,verbose=False)
|
||
|
||
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'.
|
||
Marks are temporary until shutdown (not saved to disk)."""
|
||
line = line.strip()
|
||
if not line:
|
||
for mark, gi in self.marks.items():
|
||
print("[%s] %s (%s)" % (mark, gi.name, gi.url))
|
||
elif line.isalpha() and len(line) == 1:
|
||
self.marks[line] = self.gi
|
||
else:
|
||
print("Invalid mark, must be one letter")
|
||
|
||
@needs_gi
|
||
def do_info(self,line):
|
||
"""Display information about current page."""
|
||
out = self.gi.get_page_title() + "\n\n"
|
||
out += "URL : " + self.gi.url + "\n"
|
||
out += "Path : " + self.gi.path + "\n"
|
||
out += "Mime : " + self.gi.get_mime() + "\n"
|
||
out += "Cache : " + self.gi.get_cache_path() + "\n"
|
||
tmp = self.gi.get_temp_filename()
|
||
if tmp != self.gi.get_cache_path():
|
||
out += "Tempfile : " + self.gi.get_temp_filename() + "\n"
|
||
if self.gi.renderer :
|
||
rend = str(self.gi.renderer.__class__)
|
||
rend = rend.lstrip("<class '__main__.").rstrip("'>")
|
||
else:
|
||
rend = "None"
|
||
out += "Renderer : " + rend + "\n\n"
|
||
lists = []
|
||
for l in self.list_lists():
|
||
if self.list_has_url(self.gi.url,l):
|
||
lists.append(l)
|
||
if len(lists) > 0:
|
||
out += "Page appeard in following lists :\n"
|
||
for l in lists:
|
||
if not self.list_is_system(l):
|
||
status = "normal list"
|
||
if self.list_is_subscribed(l):
|
||
status = "subscription"
|
||
elif self.list_is_frozen(l):
|
||
status = "frozen list"
|
||
out += " • %s\t(%s)\n" %(l,status)
|
||
for l in lists:
|
||
if self.list_is_system(l):
|
||
out += " • %s\n" %l
|
||
else:
|
||
out += "Page is not save in any list"
|
||
print(out)
|
||
|
||
def do_version(self, line):
|
||
"""Display version and system information."""
|
||
def has(value):
|
||
if value:
|
||
return "\t\x1b[1;32mInstalled\x1b[0m\n"
|
||
else:
|
||
return "\t\x1b[1;31mNot Installed\x1b[0m\n"
|
||
output = "Offpunk " + _VERSION + "\n"
|
||
output += "===========\n"
|
||
output += "Highly recommended:\n"
|
||
output += " - python-cryptography : " + has(_HAS_CRYPTOGRAPHY)
|
||
output += " - xdg-open : " + has(_HAS_XDGOPEN)
|
||
output += "\nWeb browsing:\n"
|
||
output += " - python-requests : " + has(_DO_HTTP)
|
||
output += " - python-feedparser : " + has(_DO_FEED)
|
||
output += " - python-bs4 : " + has(_HAS_SOUP)
|
||
output += " - python-readability : " + has(_HAS_READABILITY)
|
||
output += " - timg : " + has(_HAS_TIMG)
|
||
if _NEW_CHAFA:
|
||
output += " - chafa 1.10+ : " + has(_HAS_CHAFA)
|
||
else:
|
||
output += " - chafa : " + has(_HAS_CHAFA)
|
||
output += " - python-pil : " + has(_HAS_PIL)
|
||
output += "\nNice to have:\n"
|
||
output += " - python-setproctitle : " + has(_HAS_SETPROCTITLE)
|
||
output += " - ripgrep : " + has(shutil.which("rg"))
|
||
output += " - xsel : " + has(_HAS_XSEL)
|
||
|
||
output += "\nFeatures :\n"
|
||
if _NEW_CHAFA:
|
||
output += " - Render images (chafa or timg) : " + has(_RENDER_IMAGE)
|
||
else:
|
||
output += " - Render images (python-pil, chafa or timg) : " + has(_RENDER_IMAGE)
|
||
output += " - Render HTML (bs4, readability) : " + has(_DO_HTML)
|
||
output += " - Render Atom/RSS feeds (feedparser) : " + has(_DO_FEED)
|
||
output += " - Connect to http/https (requests) : " + has(_DO_HTTP)
|
||
output += " - copy to/from clipboard (xsel) : " + has(_HAS_XSEL)
|
||
output += " - restore last position (less 572+) : " + has(_LESS_RESTORE_POSITION)
|
||
output += "\n"
|
||
output += "Config directory : " + _CONFIG_DIR + "\n"
|
||
output += "User Data directory : " + _DATA_DIR + "\n"
|
||
output += "Cache directoy : " + _CACHE_PATH
|
||
|
||
print(output)
|
||
|
||
### 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_gus(self, line):
|
||
"""Submit a search query to the geminispace.info search engine."""
|
||
gus = GeminiItem("gemini://geminispace.info/search")
|
||
self._go_to_gi(gus.query(line))
|
||
|
||
def do_history(self, *args):
|
||
"""Display history."""
|
||
self.list_show("history")
|
||
|
||
@needs_gi
|
||
def do_find(self, searchterm):
|
||
"""Find in current page by displaying only relevant lines (grep)."""
|
||
self.gi.display(grep=searchterm)
|
||
|
||
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."""
|
||
run("cat %s" % self.gi.get_temp_filename(),direct_output=True)
|
||
|
||
@needs_gi
|
||
def do_view(self, *args):
|
||
"""Run most recently visited item through "less" command, restoring \
|
||
previous position.
|
||
Use "view normal" to see the default article view on html page.
|
||
Use "view full" to see a complete html page instead of the article view.
|
||
Use "view feed" to see the the linked feed of the page (in any).
|
||
Use "view feeds" to see available feeds on this page.
|
||
(full, feed, feeds have no effect on non-html content)."""
|
||
if self.gi and args and args[0] != "":
|
||
if args[0] in ["full","debug"]:
|
||
self._go_to_gi(self.gi,mode=args[0])
|
||
elif args[0] in ["normal","readable"]:
|
||
self._go_to_gi(self.gi,mode="readable")
|
||
elif args[0] == "feed":
|
||
subs = self.gi.get_subscribe_links()
|
||
if len(subs) > 1:
|
||
self.do_go(subs[1][0])
|
||
elif "rss" in subs[0][1] or "atom" in subs[0][1]:
|
||
print("%s is already a feed" %self.gi.url)
|
||
else:
|
||
print("No other feed found on %s"%self.gi.url)
|
||
elif args[0] == "feeds":
|
||
subs = self.gi.get_subscribe_links()
|
||
stri = "Available views :\n"
|
||
counter = 0
|
||
for s in subs:
|
||
counter += 1
|
||
stri += "[%s] %s [%s]\n"%(counter,s[0],s[1])
|
||
stri += "Which view do you want to see ? >"
|
||
ans = input(stri)
|
||
if ans.isdigit() and 0 < int(ans) <= len(subs):
|
||
self.do_go(subs[int(ans)-1][0])
|
||
else:
|
||
print("Valid argument for view are : normal, full, feed, feeds")
|
||
else:
|
||
self._go_to_gi(self.gi)
|
||
|
||
@needs_gi
|
||
def do_open(self, *args):
|
||
"""Open current item with the configured handler or xdg-open.
|
||
see "handler" command to set your own."""
|
||
cmd_str = self._get_handler_cmd(self.gi.get_mime())
|
||
file_path = "\"%s\"" %self.gi.get_body(as_file=True)
|
||
cmd_str = cmd_str % file_path
|
||
run(cmd_str,direct_output=True)
|
||
|
||
@restricted
|
||
@needs_gi
|
||
def do_shell(self, line):
|
||
"""'cat' most recently visited item through a shell pipeline.
|
||
'!' is an useful shortcut."""
|
||
run("cat %s |" % self.gi.get_temp_filename() + line,direct_output=True)
|
||
|
||
@restricted
|
||
@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.gi.is_cache_valid():
|
||
print("You cannot save if not cached!")
|
||
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 = gi.get_filename()
|
||
# 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 Offpunk
|
||
# can navigate to it later.
|
||
path = gi.get_body(as_file=True)
|
||
if os.path.isdir(path):
|
||
print("Can’t save %s because it’s a folder, not a file"%path)
|
||
else:
|
||
print("Saved to %s" % filename)
|
||
shutil.copyfile(path, 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(self.gi.url)
|
||
|
||
### Bookmarking stuff
|
||
@restricted
|
||
@needs_gi
|
||
def do_add(self, line):
|
||
"""Add the current URL to the list specied as argument.
|
||
If no argument given, URL is added to Bookmarks."""
|
||
args = line.split()
|
||
if len(args) < 1 :
|
||
self.list_add_line("bookmarks")
|
||
else:
|
||
self.list_add_line(args[0])
|
||
|
||
# Get the list file name, creating or migrating it if needed.
|
||
# Migrate bookmarks/tour/to_fetch from XDG_CONFIG to XDG_DATA
|
||
# We migrate only if the file exists in XDG_CONFIG and not XDG_DATA
|
||
def get_list(self,list):
|
||
list_path = self.list_path(list)
|
||
if not list_path:
|
||
old_file_gmi = os.path.join(_CONFIG_DIR,list + ".gmi")
|
||
old_file_nogmi = os.path.join(_CONFIG_DIR,list)
|
||
target = os.path.join(_DATA_DIR,"lists")
|
||
if os.path.exists(old_file_gmi):
|
||
shutil.move(old_file_gmi,target)
|
||
elif os.path.exists(old_file_nogmi):
|
||
targetgmi = os.path.join(target,list+".gmi")
|
||
shutil.move(old_file_nogmi,targetgmi)
|
||
else:
|
||
if list == "subscribed":
|
||
title = "Subscriptions #subscribed (new links in those pages will be added to tour)"
|
||
elif list == "to_fetch":
|
||
title = "Links requested and to be fetched during the next --sync"
|
||
else:
|
||
title = None
|
||
self.list_create(list, title=title)
|
||
list_path = self.list_path(list)
|
||
return list_path
|
||
|
||
def do_subscribe(self,line):
|
||
"""Subscribe to current page by saving it in the "subscribed" list.
|
||
If a new link is found in the page during a --sync, the new link is automatically
|
||
fetched and added to your next tour.
|
||
To unsubscribe, remove the page from the "subscribed" list."""
|
||
subs = self.gi.get_subscribe_links()
|
||
if len(subs) > 1:
|
||
stri = "Multiple feeds have been found :\n"
|
||
elif "rss" in subs[0][1] or "atom" in subs[0][1] :
|
||
stri = "This page is already a feed:\n"
|
||
else:
|
||
stri = "No feed detected. You can still watch the page :\n"
|
||
counter = 0
|
||
for l in subs:
|
||
link = l[0]
|
||
already = []
|
||
for li in self.list_lists():
|
||
if self.list_is_subscribed(li):
|
||
if self.list_has_url(link,li):
|
||
already.append(li)
|
||
stri += "[%s] %s [%s]\n"%(counter+1,link,l[1])
|
||
if len(already) > 0:
|
||
stri += "\t -> (already subscribed through lists %s)\n"%(str(already))
|
||
counter += 1
|
||
stri += "\n"
|
||
stri += "Which feed do you want to subsribe ? > "
|
||
ans = input(stri)
|
||
if ans.isdigit() and 0 < int(ans) <= len(subs):
|
||
sublink,mime,title = subs[int(ans)-1]
|
||
else:
|
||
sublink,title = None,None
|
||
if sublink:
|
||
sublink = self.gi.absolutise_url(sublink)
|
||
gi = GeminiItem(sublink,name=title)
|
||
list_path = self.get_list("subscribed")
|
||
added = self.list_add_line("subscribed",gi=gi,verbose=False)
|
||
if added :
|
||
print("Subscribed to %s" %sublink)
|
||
else:
|
||
print("You are already subscribed to %s"%sublink)
|
||
else:
|
||
print("No subscription registered")
|
||
|
||
def do_bookmarks(self, line):
|
||
"""Show or access the bookmarks menu.
|
||
'bookmarks' shows all bookmarks.
|
||
'bookmarks n' navigates immediately to item n in the bookmark menu.
|
||
Bookmarks are stored using the 'add' command."""
|
||
list_path = self.get_list("bookmarks")
|
||
args = line.strip()
|
||
if len(args.split()) > 1 or (args and not args.isnumeric()):
|
||
print("bookmarks command takes a single integer argument!")
|
||
elif args:
|
||
self.list_go_to_line(args,"bookmarks")
|
||
else:
|
||
self.list_show("bookmarks")
|
||
|
||
def do_archive(self,args):
|
||
"""Archive current page by removing it from every list and adding it to
|
||
archives, which is a special historical list limited in size. It is similar to `move archives`."""
|
||
for li in self.list_lists():
|
||
if li not in ["archives", "history"]:
|
||
deleted = self.list_rm_url(self.gi.url_mode(),li)
|
||
if deleted:
|
||
print("Removed from %s"%li)
|
||
self.list_add_top("archives",limit=self.options["archives_size"])
|
||
print("Archiving: %s"%self.gi.get_page_title())
|
||
print("\x1b[2;34mCurrent maximum size of archives : %s\x1b[0m" %self.options["archives_size"])
|
||
|
||
def list_add_line(self,list,gi=None,verbose=True):
|
||
list_path = self.list_path(list)
|
||
if not list_path:
|
||
print("List %s does not exist. Create it with ""list create %s"""%(list,list))
|
||
return False
|
||
else:
|
||
if not gi:
|
||
gi = self.gi
|
||
# first we check if url already exists in the file
|
||
with open(list_path,"r") as l_file:
|
||
lines = l_file.readlines()
|
||
l_file.close()
|
||
for l in lines:
|
||
sp = l.split()
|
||
if gi.url_mode() in sp:
|
||
if verbose:
|
||
print("%s already in %s."%(gi.url,list))
|
||
return False
|
||
with open(list_path,"a") as l_file:
|
||
l_file.write(gi.to_map_line())
|
||
l_file.close()
|
||
if verbose:
|
||
print("%s added to %s" %(gi.url,list))
|
||
return True
|
||
|
||
def list_add_top(self,list,limit=0,truncate_lines=0):
|
||
if not self.gi:
|
||
return
|
||
stri = self.gi.to_map_line().strip("\n")
|
||
if list == "archives":
|
||
stri += ", archived on "
|
||
elif list == "history":
|
||
stri += ", visited on "
|
||
else:
|
||
stri += ", added to %s on "%list
|
||
stri += time.ctime() + "\n"
|
||
list_path = self.get_list(list)
|
||
with open(list_path,"r") as l_file:
|
||
lines = l_file.readlines()
|
||
l_file.close()
|
||
with open(list_path,"w") as l_file:
|
||
l_file.write("#%s\n"%list)
|
||
l_file.write(stri)
|
||
counter = 0
|
||
# Truncating is useful in case we open a new branch
|
||
# after a few back in history
|
||
to_truncate = truncate_lines
|
||
for l in lines:
|
||
if not l.startswith("#"):
|
||
if to_truncate > 0:
|
||
to_truncate -= 1
|
||
elif limit == 0 or counter < limit:
|
||
l_file.write(l)
|
||
counter += 1
|
||
l_file.close()
|
||
|
||
|
||
# remove an url from a list.
|
||
# return True if the URL was removed
|
||
# return False if the URL was not found
|
||
def list_rm_url(self,url,list):
|
||
return self.list_has_url(url,list,deletion=True)
|
||
|
||
# deletion and has_url are so similar, I made them the same method
|
||
def list_has_url(self,url,list,deletion=False):
|
||
list_path = self.list_path(list)
|
||
if list_path:
|
||
to_return = False
|
||
with open(list_path,"r") as lf:
|
||
lines = lf.readlines()
|
||
lf.close()
|
||
to_write = []
|
||
for l in lines:
|
||
# we separate components of the line
|
||
# to ensure we identify a complete URL, not a part of it
|
||
splitted = l.split()
|
||
if url not in splitted:
|
||
#sometimes, we must remove the ending "/"
|
||
if url.endswith("/") and url[:-1] in splitted:
|
||
to_return = True
|
||
else:
|
||
to_write.append(l)
|
||
else:
|
||
to_return = True
|
||
if deletion :
|
||
with open(list_path,"w") as lf:
|
||
for l in to_write:
|
||
lf.write(l)
|
||
lf.close()
|
||
return to_return
|
||
else:
|
||
return False
|
||
|
||
def list_get_links(self,list):
|
||
list_path = self.list_path(list)
|
||
if list_path:
|
||
gi = GeminiItem("list:///%s"%list)
|
||
return gi.get_links()
|
||
else:
|
||
return []
|
||
|
||
def list_go_to_line(self,line,list):
|
||
list_path = self.list_path(list)
|
||
if not list_path:
|
||
print("List %s does not exist. Create it with ""list create %s"""%(list,list))
|
||
elif not line.isnumeric():
|
||
print("go_to_line requires a number as parameter")
|
||
else:
|
||
gi = GeminiItem("list:///%s"%list)
|
||
gi = gi.get_link(int(line))
|
||
display = not self.sync_only
|
||
if gi:
|
||
self._go_to_gi(gi,handle=display)
|
||
return gi.url_mode()
|
||
|
||
def list_show(self,list):
|
||
list_path = self.list_path(list)
|
||
if not list_path:
|
||
print("List %s does not exist. Create it with ""list create %s"""%(list,list))
|
||
else:
|
||
gi = GeminiItem("list:///%s"%list)
|
||
display = not self.sync_only
|
||
self._go_to_gi(gi,handle=display)
|
||
|
||
#return the path of the list file if list exists.
|
||
#return None if the list doesn’t exist.
|
||
def list_path(self,list):
|
||
listdir = os.path.join(_DATA_DIR,"lists")
|
||
list_path = os.path.join(listdir, "%s.gmi"%list)
|
||
if os.path.exists(list_path):
|
||
return list_path
|
||
else:
|
||
return None
|
||
|
||
def list_create(self,list,title=None):
|
||
list_path = self.list_path(list)
|
||
if list in ["create","edit","delete","help"]:
|
||
print("%s is not allowed as a name for a list"%list)
|
||
elif not list_path:
|
||
listdir = os.path.join(_DATA_DIR,"lists")
|
||
os.makedirs(listdir,exist_ok=True)
|
||
list_path = os.path.join(listdir, "%s.gmi"%list)
|
||
with open(list_path,"a") as lfile:
|
||
if title:
|
||
lfile.write("# %s\n"%title)
|
||
else:
|
||
lfile.write("# %s\n"%list)
|
||
lfile.close()
|
||
print("list created. Display with `list %s`"%list)
|
||
else:
|
||
print("list %s already exists" %list)
|
||
|
||
def do_move(self,arg):
|
||
"""move LIST will add the current page to the list LIST.
|
||
With a major twist: current page will be removed from all other lists.
|
||
If current page was not in a list, this command is similar to `add LIST`."""
|
||
if not arg:
|
||
print("LIST argument is required as the target for your move")
|
||
elif arg[0] == "archives":
|
||
self.do_archive()
|
||
else:
|
||
args = arg.split()
|
||
list_path = self.list_path(args[0])
|
||
if not list_path:
|
||
print("%s is not a list, aborting the move" %args[0])
|
||
else:
|
||
lists = self.list_lists()
|
||
for l in lists:
|
||
if l != args[0] and l not in ["archives", "history"]:
|
||
isremoved = self.list_rm_url(self.gi.url_mode(),l)
|
||
if isremoved:
|
||
print("Removed from %s"%l)
|
||
self.list_add_line(args[0])
|
||
|
||
def list_lists(self):
|
||
listdir = os.path.join(_DATA_DIR,"lists")
|
||
to_return = []
|
||
if os.path.exists(listdir):
|
||
lists = os.listdir(listdir)
|
||
if len(lists) > 0:
|
||
for l in lists:
|
||
#removing the .gmi at the end of the name
|
||
to_return.append(l[:-4])
|
||
return to_return
|
||
|
||
def list_has_status(self,list,status):
|
||
path = self.list_path(list)
|
||
toreturn = False
|
||
if path:
|
||
with open(path) as f:
|
||
line = f.readline().strip()
|
||
f.close()
|
||
if line.startswith("#") and status in line:
|
||
toreturn = True
|
||
return toreturn
|
||
|
||
def list_is_subscribed(self,list):
|
||
return self.list_has_status(list,"#subscribed")
|
||
def list_is_frozen(self,list):
|
||
return self.list_has_status(list,"#frozen")
|
||
def list_is_system(self,list):
|
||
return list in ["history","to_fetch","archives","tour"]
|
||
|
||
# This modify the status of a list to one of :
|
||
# normal, frozen, subscribed
|
||
# action is either #frozen, #subscribed or None
|
||
def list_modify(self,list,action=None):
|
||
path = self.list_path(list)
|
||
with open(path) as f:
|
||
lines = f.readlines()
|
||
f.close()
|
||
if lines[0].strip().startswith("#"):
|
||
first_line = lines.pop(0).strip("\n")
|
||
else:
|
||
first_line = "# %s "%list
|
||
first_line = first_line.replace("#subscribed","").replace("#frozen","")
|
||
if action:
|
||
first_line += " " + action
|
||
print("List %s has been marked as %s"%(list,action))
|
||
else:
|
||
print("List %s is now a normal list" %list)
|
||
first_line += "\n"
|
||
lines.insert(0,first_line)
|
||
with open(path,"w") as f:
|
||
for line in lines:
|
||
f.write(line)
|
||
f.close()
|
||
def do_list(self,arg):
|
||
"""Manage list of bookmarked pages.
|
||
- list : display available lists
|
||
- list $LIST : display pages in $LIST
|
||
- list create $NEWLIST : create a new list
|
||
- list edit $LIST : edit the list
|
||
- list subscribe $LIST : during sync, add new links found in listed pages to tour
|
||
- list freeze $LIST : don’t update pages in list during sync if a cache already exists
|
||
- list normal $LIST : update pages in list during sync but don’t add anything to tour
|
||
- list delete $LIST : delete a list permanently (a confirmation is required)
|
||
- list help : print this help
|
||
See also :
|
||
- add $LIST (to add current page to $LIST or, by default, to bookmarks)
|
||
- move $LIST (to add current page to list while removing from all others)
|
||
- archive (to remove current page from all lists while adding to archives)
|
||
Note: There’s no "delete" on purpose. The use of "archive" is recommended."""
|
||
listdir = os.path.join(_DATA_DIR,"lists")
|
||
os.makedirs(listdir,exist_ok=True)
|
||
if not arg:
|
||
lists = self.list_lists()
|
||
if len(lists) > 0:
|
||
lgi = GeminiItem("list:///")
|
||
self._go_to_gi(lgi)
|
||
else:
|
||
print("No lists yet. Use `list create`")
|
||
else:
|
||
args = arg.split()
|
||
if args[0] == "create":
|
||
if len(args) > 2:
|
||
name = " ".join(args[2:])
|
||
self.list_create(args[1].lower(),title=name)
|
||
elif len(args) == 2:
|
||
self.list_create(args[1].lower())
|
||
else:
|
||
print("A name is required to create a new list. Use `list create NAME`")
|
||
elif args[0] == "edit":
|
||
editor = None
|
||
if "editor" in self.options and self.options["editor"]:
|
||
editor = self.options["editor"]
|
||
elif os.environ.get("VISUAL"):
|
||
editor = os.environ.get("VISUAL")
|
||
elif os.environ.get("EDITOR"):
|
||
editor = os.environ.get("EDITOR")
|
||
if editor:
|
||
if len(args) > 1 and args[1] in self.list_lists():
|
||
path = os.path.join(listdir,args[1]+".gmi")
|
||
try:
|
||
run("%s %s"%(editor,path),direct_output=True)
|
||
except Exception as err:
|
||
print(err)
|
||
print("Please set a valid editor with \"set editor\"")
|
||
else:
|
||
print("A valid list name is required to edit a list")
|
||
else:
|
||
print("No valid editor has been found.")
|
||
print("You can use the following command to set your favourite editor:")
|
||
print("set editor EDITOR")
|
||
print("or use the $VISUAL or $EDITOR environment variables.")
|
||
elif args[0] == "delete":
|
||
if len(args) > 1:
|
||
if self.list_is_system(args[1]):
|
||
print("%s is a system list which cannot be deleted"%args[1])
|
||
elif args[1] in self.list_lists():
|
||
size = len(self.list_get_links(args[1]))
|
||
stri = "Are you sure you want to delete %s ?\n"%args[1]
|
||
confirm = "YES"
|
||
if size > 0:
|
||
stri += "! %s items in the list will be lost !\n"%size
|
||
confirm = "YES DELETE %s" %size
|
||
else :
|
||
stri += "The list is empty, it should be safe to delete it.\n"
|
||
stri += "Type \"%s\" (in capital, without quotes) to confirm :"%confirm
|
||
answer = input(stri)
|
||
if answer == confirm:
|
||
path = os.path.join(listdir,args[1]+".gmi")
|
||
os.remove(path)
|
||
print("* * * %s has been deleted" %args[1])
|
||
else:
|
||
print("A valid list name is required to be deleted")
|
||
else:
|
||
print("A valid list name is required to be deleted")
|
||
elif args[0] in ["subscribe","freeze","normal"]:
|
||
if len(args) > 1:
|
||
if self.list_is_system(args[1]):
|
||
print("You cannot modify %s which is a system list"%args[1])
|
||
elif args[1] in self.list_lists():
|
||
if args[0] == "subscribe":
|
||
action = "#subscribed"
|
||
elif args[0] == "freeze":
|
||
action = "#frozen"
|
||
else:
|
||
action = None
|
||
self.list_modify(args[1],action=action)
|
||
else:
|
||
print("A valid list name is required after %s" %args[0])
|
||
elif args[0] == "help":
|
||
self.onecmd("help list")
|
||
elif len(args) == 1:
|
||
self.list_show(args[0].lower())
|
||
else:
|
||
self.list_go_to_line(args[1],args[0].lower())
|
||
|
||
def completedefault(self,index,line,begidx,endidx):
|
||
print("completeing %s + %s" %index,line)
|
||
return ["bépo","auc"]
|
||
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'")
|
||
elif arg in _ABBREVS:
|
||
full_cmd = _ABBREVS[arg]
|
||
print("%s is an alias for '%s'" %(arg,full_cmd))
|
||
print("See the list of aliases with 'abbrevs'")
|
||
print("'help %s':"%full_cmd)
|
||
cmd.Cmd.do_help(self, full_cmd)
|
||
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, 3600)
|
||
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(("Patrol 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"]))
|
||
lines.append(("Cache hits:", self.log["cache_hits"]))
|
||
# Print
|
||
for key, value in lines:
|
||
print(key.ljust(24) + str(value).rjust(8))
|
||
|
||
|
||
def do_sync(self, line):
|
||
"""Synchronize all bookmarks lists.
|
||
- New elements in pages in subscribed lists will be added to tour
|
||
- Elements in list to_fetch will be retrieved and added to tour
|
||
- Normal lists will be synchronized and updated
|
||
- Frozen lists will be fetched only if not present.
|
||
|
||
Argument : duration of cache validity (in seconds)."""
|
||
if self.offline_only:
|
||
print("Sync can only be achieved online. Change status with `online`.")
|
||
return
|
||
args = line.split()
|
||
if len(args) > 0:
|
||
if not args[0].isdigit():
|
||
print("sync argument should be the cache validity expressed in seconds")
|
||
return
|
||
else:
|
||
validity = int(args[0])
|
||
else:
|
||
validity = 0
|
||
self.call_sync(refresh_time=validity)
|
||
|
||
def call_sync(self,refresh_time=0,depth=1):
|
||
# fetch_gitem is the core of the sync algorithm.
|
||
# It takes as input :
|
||
# - a GeminiItem to be fetched
|
||
# - depth : the degree of recursion to build the cache (0 means no recursion)
|
||
# - validity : the age, in seconds, existing caches need to have before
|
||
# being refreshed (0 = never refreshed if it already exists)
|
||
# - savetotour : if True, newly cached items are added to tour
|
||
def add_to_tour(gitem):
|
||
if gitem.is_cache_valid():
|
||
toprint = " -> adding to tour: %s" %gitem.url
|
||
width = term_width() - 1
|
||
toprint = toprint[:width]
|
||
toprint += " "*(width-len(toprint))
|
||
print(toprint)
|
||
self.list_add_line("tour",gi=gitem,verbose=False)
|
||
return True
|
||
else:
|
||
return False
|
||
def fetch_gitem(gitem,depth=0,validity=0,savetotour=False,count=[0,0],strin=""):
|
||
#savetotour = True will save to tour newly cached content
|
||
# else, do not save to tour
|
||
#regardless of valitidy
|
||
if not gitem.is_cache_valid(validity=validity):
|
||
if strin != "":
|
||
endline = '\r'
|
||
else:
|
||
endline = None
|
||
#Did we already had a cache (even an old one) ?
|
||
isnew = not gitem.is_cache_valid()
|
||
toprint = "%s [%s/%s] Fetch "%(strin,count[0],count[1]) + gitem.url
|
||
width = term_width() - 1
|
||
toprint = toprint[:width]
|
||
toprint += " "*(width-len(toprint))
|
||
print(toprint,end=endline)
|
||
#If not saving to tour, then we should limit download size
|
||
limit = not savetotour
|
||
self._go_to_gi(gitem,update_hist=False,limit_size=limit)
|
||
if savetotour and isnew and gitem.is_cache_valid():
|
||
#we add to the next tour only if we managed to cache
|
||
#the ressource
|
||
add_to_tour(gitem)
|
||
#Now, recursive call, even if we didn’t refresh the cache
|
||
if depth > 0:
|
||
#we should only savetotour at the first level of recursion
|
||
# The code for this was removed so, currently, we savetotour
|
||
# at every level of recursion.
|
||
links = gitem.get_links()
|
||
subcount = [0,len(links)]
|
||
d = depth - 1
|
||
for k in links:
|
||
#recursive call (validity is always 0 in recursion)
|
||
substri = strin + " -->"
|
||
subcount[0] += 1
|
||
fetch_gitem(k,depth=d,validity=0,savetotour=savetotour,\
|
||
count=subcount,strin=substri)
|
||
def fetch_list(list,validity=0,depth=1,tourandremove=False,tourchildren=False):
|
||
links = self.list_get_links(list)
|
||
end = len(links)
|
||
counter = 0
|
||
print(" * * * %s to fetch in %s * * *" %(end,list))
|
||
for l in links:
|
||
counter += 1
|
||
fetch_gitem(l,depth=depth,validity=validity,savetotour=tourchildren,count=[counter,end])
|
||
if tourandremove:
|
||
if add_to_tour(l):
|
||
self.list_rm_url(l.url_mode(),list)
|
||
|
||
self.sync_only = True
|
||
lists = self.list_lists()
|
||
# We will fetch all the lists except "archives" and "history"
|
||
# We keep tour for the last round
|
||
subscriptions = []
|
||
normal_lists = []
|
||
fridge = []
|
||
for l in lists:
|
||
if not self.list_is_system(l):
|
||
if self.list_is_frozen(l):
|
||
fridge.append(l)
|
||
elif self.list_is_subscribed(l):
|
||
subscriptions.append(l)
|
||
else:
|
||
normal_lists.append(l)
|
||
# We start with the "subscribed" as we need to find new items
|
||
starttime = int(time.time())
|
||
for l in subscriptions:
|
||
fetch_list(l,validity=refresh_time,depth=depth,tourchildren=True)
|
||
#Then the fetch list (item are removed from the list after fetch)
|
||
# We fetch regarless of the refresh_time
|
||
if "to_fetch" in lists:
|
||
nowtime = int(time.time())
|
||
short_valid = nowtime - starttime
|
||
fetch_list("to_fetch",validity=short_valid,depth=depth,tourandremove=True)
|
||
#then we fetch all the rest (including bookmarks and tour)
|
||
for l in normal_lists:
|
||
fetch_list(l,validity=refresh_time,depth=depth)
|
||
for l in fridge:
|
||
fetch_list(l,validity=0,depth=depth)
|
||
#tour should be the last one as item my be added to it by others
|
||
fetch_list("tour",validity=refresh_time,depth=depth)
|
||
print("End of sync")
|
||
self.sync_only = False
|
||
|
||
### The end!
|
||
def do_quit(self, *args):
|
||
"""Exit Offpunk."""
|
||
def unlink(filename):
|
||
if filename and os.path.exists(filename):
|
||
os.unlink(filename)
|
||
# Close TOFU DB
|
||
self.db_conn.commit()
|
||
self.db_conn.close()
|
||
# Clean up after ourself
|
||
|
||
for cert in self.transient_certs_created:
|
||
for ext in (".crt", ".key"):
|
||
certfile = os.path.join(_CONFIG_DIR, "transient_certs", cert+ext)
|
||
if os.path.exists(certfile):
|
||
os.remove(certfile)
|
||
print("You can close your screen!")
|
||
sys.exit()
|
||
|
||
do_exit = do_quit
|
||
|
||
|
||
|
||
# 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('--tls-cert', metavar='FILE', help='TLS client certificate file')
|
||
parser.add_argument('--tls-key', metavar='FILE', help='TLS client certificate private key file')
|
||
parser.add_argument('--restricted', action="store_true", help='Disallow shell, add, and save commands')
|
||
parser.add_argument('--sync', action='store_true',
|
||
help='run non-interactively to build cache by exploring bookmarks')
|
||
parser.add_argument('--assume-yes', action='store_true',
|
||
help='assume-yes when asked questions about certificates/redirections during sync')
|
||
parser.add_argument('--disable-http',action='store_true',
|
||
help='do not try to get http(s) links (but already cached will be displayed)')
|
||
parser.add_argument('--fetch-later', action='store_true',
|
||
help='run non-interactively with an URL as argument to fetch it later')
|
||
parser.add_argument('--depth',
|
||
help='depth of the cache to build. Default is 1. More is crazy. Use at your own risks!')
|
||
parser.add_argument('--cache-validity',
|
||
help='duration for which a cache is valid before sync (seconds)')
|
||
parser.add_argument('--version', action='store_true',
|
||
help='display version information and quit')
|
||
parser.add_argument('url', metavar='URL', nargs='*',
|
||
help='start with this URL')
|
||
args = parser.parse_args()
|
||
|
||
# Handle --version
|
||
if args.version:
|
||
print("Offpunk " + _VERSION)
|
||
sys.exit()
|
||
|
||
# Instantiate client
|
||
gc = GeminiClient(restricted=args.restricted,synconly=args.sync)
|
||
torun_queue = []
|
||
|
||
# Act on args
|
||
if args.tls_cert:
|
||
# If tls_key is None, python will attempt to load the key from tls_cert.
|
||
gc._activate_client_cert(args.tls_cert, args.tls_key)
|
||
if args.bookmarks:
|
||
torun_queue.append("bookmarks")
|
||
elif args.url:
|
||
if len(args.url) == 1:
|
||
torun_queue.append("go %s" % args.url[0])
|
||
else:
|
||
for url in args.url:
|
||
torun_queue.append("tour %s" % url)
|
||
torun_queue.append("tour")
|
||
|
||
if args.disable_http:
|
||
gc.support_http = False
|
||
|
||
# Endless interpret loop (except while --sync or --fetch-later)
|
||
if args.fetch_later:
|
||
if args.url:
|
||
gc.sync_only = True
|
||
for u in args.url:
|
||
gi = GeminiItem(u)
|
||
if gi and gi.is_cache_valid():
|
||
gc.list_add_line("tour",gi)
|
||
else:
|
||
gc.list_add_line("to_fetch",gi)
|
||
else:
|
||
print("--fetch-later requires an URL (or a list of URLS) as argument")
|
||
elif args.sync:
|
||
if args.assume_yes:
|
||
gc.automatic_choice = "y"
|
||
if args.cache_validity:
|
||
refresh_time = int(args.cache_validity)
|
||
else:
|
||
# if no refresh time, a default of 0 is used (which means "infinite")
|
||
refresh_time = 0
|
||
if args.depth:
|
||
depth = int(args.depth)
|
||
else:
|
||
depth = 1
|
||
gc.call_sync(refresh_time=refresh_time,depth=depth)
|
||
gc.onecmd("blackbox")
|
||
else:
|
||
# We are in the normal mode. First process config file
|
||
rcfile = os.path.join(_CONFIG_DIR, "offpunkrc")
|
||
if os.path.exists(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
|
||
torun_queue.append(line)
|
||
print("Welcome to Offpunk!")
|
||
if args.restricted:
|
||
print("Restricted mode engaged!")
|
||
print("Type `help` to get the list of available command.")
|
||
for line in torun_queue:
|
||
gc.onecmd(line)
|
||
|
||
while True:
|
||
try:
|
||
gc.cmdloop()
|
||
except KeyboardInterrupt:
|
||
print("")
|
||
|
||
if __name__ == '__main__':
|
||
main()
|