add poetry for dependency management and shell.nix for use on nix systems
This commit is contained in:
commit
eeea6fd44f
|
|
@ -0,0 +1,3 @@
|
|||
__pycache__
|
||||
wiki
|
||||
*.lock
|
||||
|
|
@ -0,0 +1,269 @@
|
|||
#! /usr/bin/env python3
|
||||
|
||||
""" Module extending generic MediaWiki interface with stuff specific to ArchWiki
|
||||
and some convenient generic methods.
|
||||
"""
|
||||
|
||||
import os.path
|
||||
import re
|
||||
import hashlib
|
||||
|
||||
from simplemediawiki import MediaWiki
|
||||
|
||||
__all__ = ["ArchWiki"]
|
||||
|
||||
url = "https://wiki.archlinux.org/api.php"
|
||||
local_language = "English"
|
||||
language_names = {
|
||||
"العربية": {"subtag": "ar", "english": "Arabic"},
|
||||
"Bosanski": {"subtag": "bs", "english": "Bosnian"},
|
||||
"Български": {"subtag": "bg", "english": "Bulgarian"},
|
||||
"Català": {"subtag": "ca", "english": "Catalan"},
|
||||
"Čeština": {"subtag": "cs", "english": "Czech"},
|
||||
"Dansk": {"subtag": "da", "english": "Danish"},
|
||||
"Deutsch": {"subtag": "de", "english": "German"},
|
||||
"Ελληνικά": {"subtag": "el", "english": "Greek"},
|
||||
"English": {"subtag": "en", "english": "English"},
|
||||
"Esperanto": {"subtag": "eo", "english": "Esperanto"},
|
||||
"Español": {"subtag": "es", "english": "Spanish"},
|
||||
"فارسی": {"subtag": "fa", "english": "Persian"},
|
||||
"Suomi": {"subtag": "fi", "english": "Finnish"},
|
||||
"Français": {"subtag": "fr", "english": "French"},
|
||||
"עברית": {"subtag": "he", "english": "Hebrew"},
|
||||
"Hrvatski": {"subtag": "hr", "english": "Croatian"},
|
||||
"Magyar": {"subtag": "hu", "english": "Hungarian"},
|
||||
"Bahasa Indonesia": {"subtag": "id", "english": "Indonesian"},
|
||||
"Italiano": {"subtag": "it", "english": "Italian"},
|
||||
"日本語": {"subtag": "ja", "english": "Japanese"},
|
||||
"한국어": {"subtag": "ko", "english": "Korean"},
|
||||
"Lietuvių": {"subtag": "lt", "english": "Lithuanian"},
|
||||
"Norsk Bokmål": {"subtag": "nb", "english": "Norwegian (Bokmål)"},
|
||||
"Nederlands": {"subtag": "nl", "english": "Dutch"},
|
||||
"Polski": {"subtag": "pl", "english": "Polish"},
|
||||
"Português": {"subtag": "pt", "english": "Portuguese"},
|
||||
"Română": {"subtag": "ro", "english": "Romanian"},
|
||||
"Русский": {"subtag": "ru", "english": "Russian"},
|
||||
"Slovenčina": {"subtag": "sk", "english": "Slovak"},
|
||||
"Српски": {"subtag": "sr", "english": "Serbian"},
|
||||
"Svenska": {"subtag": "sv", "english": "Swedish"},
|
||||
"ไทย": {"subtag": "th", "english": "Thai"},
|
||||
"Türkçe": {"subtag": "tr", "english": "Turkish"},
|
||||
"Українська": {"subtag": "uk", "english": "Ukrainian"},
|
||||
"Tiếng Việt": {"subtag": "vi", "english": "Vietnamese"},
|
||||
"粵語": {"subtag": "yue", "english": "Cantonese"},
|
||||
"简体中文": {"subtag": "zh-hans", "english": "Chinese (Simplified)"},
|
||||
"正體中文": {"subtag": "zh-hant", "english": "Chinese (Traditional)"}
|
||||
}
|
||||
interlanguage_external = ["de", "fa", "ja", "sv"]
|
||||
interlanguage_internal = ["ar", "bs", "bg", "cs", "da", "el", "en", "es", "fi", "fr",
|
||||
"he", "hr", "hu", "id", "it", "ko", "lt", "nl", "pl", "pt",
|
||||
"ru", "sk", "sr", "th", "tr", "uk", "zh-hans", "zh-hant"]
|
||||
|
||||
def is_ascii(text):
|
||||
try:
|
||||
text.encode("ascii")
|
||||
return True
|
||||
except:
|
||||
return False
|
||||
|
||||
class ArchWiki(MediaWiki):
|
||||
|
||||
def __init__(self, safe_filenames=False, langs=None, **kwargs):
|
||||
""" Parameters:
|
||||
@safe_filenames: force self.get_local_filename() to return ASCII string
|
||||
+ all keyword arguments of simplemediawiki.MediaWiki
|
||||
"""
|
||||
super().__init__(url, **kwargs)
|
||||
|
||||
self._safe_filenames = safe_filenames
|
||||
self._namespaces = None
|
||||
self._redirects = None
|
||||
|
||||
if langs is not None:
|
||||
self._language_names = {}
|
||||
for lang, metadata in language_names.items():
|
||||
if not set(metadata.values()).isdisjoint(langs):
|
||||
self._language_names[lang] = metadata
|
||||
else:
|
||||
self._language_names = language_names
|
||||
|
||||
def query_continue(self, query):
|
||||
""" Generator for MediaWiki's query-continue feature.
|
||||
ref: https://www.mediawiki.org/wiki/API:Query#Continuing_queries
|
||||
"""
|
||||
last_continue = {"continue": ""}
|
||||
|
||||
while True:
|
||||
# clone the original params to clean up old continue params
|
||||
query_copy = query.copy()
|
||||
# and update with the last continue -- it may involve multiple params,
|
||||
# hence the clean up with params.copy()
|
||||
query_copy.update(last_continue)
|
||||
# call the API and handle the result
|
||||
result = self.call(query_copy)
|
||||
if "error" in result:
|
||||
raise Exception(result["error"])
|
||||
if "warnings" in result:
|
||||
print(result["warnings"])
|
||||
if "query" in result:
|
||||
yield result["query"]
|
||||
if "continue" not in result:
|
||||
break
|
||||
last_continue = result["continue"]
|
||||
|
||||
def namespaces(self):
|
||||
""" Force the Main namespace to have name instead of empty string.
|
||||
"""
|
||||
if self._namespaces is None:
|
||||
self._namespaces = super().namespaces()
|
||||
self._namespaces[0] = "Main"
|
||||
return self._namespaces
|
||||
|
||||
def print_namespaces(self):
|
||||
nsmap = self.namespaces()
|
||||
print("Available namespaces:")
|
||||
for ns in sorted(nsmap.keys()):
|
||||
print(" %2d -- %s" % (ns, nsmap[ns]))
|
||||
|
||||
def detect_namespace(self, title, safe=True):
|
||||
""" Detect namespace of a given title.
|
||||
"""
|
||||
pure_title = title
|
||||
detected_namespace = self.namespaces()[0]
|
||||
match = re.match("^((.+):)?(.+)$", title)
|
||||
ns = match.group(2)
|
||||
if ns:
|
||||
ns = ns.replace("_", " ")
|
||||
if ns in self.namespaces().values():
|
||||
detected_namespace = ns
|
||||
pure_title = match.group(3)
|
||||
return pure_title, detected_namespace
|
||||
|
||||
def detect_language(self, title, *, strip_all_subpage_parts=True):
|
||||
"""
|
||||
Detect language of a given title. The matching is case-sensitive and spaces are
|
||||
treated the same way as underscores.
|
||||
|
||||
:param title: page title to work with
|
||||
:returns: a ``(pure, lang)`` tuple, where ``pure`` is the pure page title without
|
||||
the language suffix and ``lang`` is the detected language in long, localized form
|
||||
"""
|
||||
title_regex = r"(?P<pure>.*?)[ _]\((?P<lang>[^\(\)]+)\)"
|
||||
pure_suffix = ""
|
||||
# matches "Page name/Subpage (Language)"
|
||||
match = re.fullmatch(title_regex, title)
|
||||
# matches "Page name (Language)/Subpage"
|
||||
if not match and "/" in title:
|
||||
base, pure_suffix = title.split("/", maxsplit=1)
|
||||
pure_suffix = "/" + pure_suffix
|
||||
match = re.fullmatch(title_regex, base)
|
||||
# matches "Category:Language"
|
||||
if not match:
|
||||
match = re.fullmatch(r"(?P<pure>[Cc]ategory[ _]?\:[ _]?(?P<lang>[^\(\)]+))", title)
|
||||
if match:
|
||||
pure = match.group("pure")
|
||||
lang = match.group("lang")
|
||||
if lang in language_names:
|
||||
# strip "(Language)" from all subpage components to handle cases like
|
||||
# "Page name (Language)/Subpage (Language)"
|
||||
if strip_all_subpage_parts is True and "/" in pure:
|
||||
parts = pure.split("/")
|
||||
new_parts = []
|
||||
for p in parts:
|
||||
match = re.fullmatch(title_regex, p)
|
||||
if match:
|
||||
part_lang = match.group("lang")
|
||||
if part_lang == lang:
|
||||
new_parts.append(match.group("pure"))
|
||||
else:
|
||||
new_parts.append(p)
|
||||
else:
|
||||
new_parts.append(p)
|
||||
pure = "/".join(new_parts)
|
||||
return pure + pure_suffix, lang
|
||||
return title, local_language
|
||||
|
||||
def get_local_filename(self, title, basepath):
|
||||
""" Return file name where the given page should be stored, relative to 'basepath'.
|
||||
"""
|
||||
title, lang = self.detect_language(title)
|
||||
|
||||
if lang not in self._language_names:
|
||||
return None
|
||||
|
||||
title, namespace = self.detect_namespace(title)
|
||||
|
||||
# be safe and use '_' instead of ' ' in filenames (MediaWiki style)
|
||||
title = title.replace(" ", "_")
|
||||
namespace = namespace.replace(" ", "_")
|
||||
|
||||
# force ASCII filename
|
||||
if self._safe_filenames and not is_ascii(title):
|
||||
h = hashlib.md5()
|
||||
h.update(title.encode("utf-8"))
|
||||
title = h.hexdigest()
|
||||
|
||||
# select pattern per namespace
|
||||
if namespace == "Main":
|
||||
pattern = "{base}/{langsubtag}/{title}.{ext}"
|
||||
elif namespace in ["Talk", "ArchWiki", "ArchWiki_talk", "Template", "Template_talk", "Help", "Help_talk", "Category", "Category_talk"]:
|
||||
pattern = "{base}/{langsubtag}/{namespace}:{title}.{ext}"
|
||||
elif namespace == "File":
|
||||
pattern = "{base}/{namespace}:{title}"
|
||||
else:
|
||||
pattern = "{base}/{namespace}:{title}.{ext}"
|
||||
|
||||
path = pattern.format(
|
||||
base=basepath,
|
||||
langsubtag=self._language_names[lang]["subtag"],
|
||||
namespace=namespace,
|
||||
title=title,
|
||||
ext="html"
|
||||
)
|
||||
return os.path.normpath(path)
|
||||
|
||||
def _fetch_redirects(self):
|
||||
""" Fetch dictionary of redirect pages and their targets
|
||||
"""
|
||||
query_allredirects = {
|
||||
"action": "query",
|
||||
"generator": "allpages",
|
||||
"gaplimit": "max",
|
||||
"gapfilterredir": "nonredirects",
|
||||
"prop": "redirects",
|
||||
"rdprop": "title|fragment",
|
||||
"rdlimit": "max",
|
||||
}
|
||||
namespaces = ["0", "4", "12", "14"]
|
||||
|
||||
self._redirects = {}
|
||||
|
||||
for ns in namespaces:
|
||||
query_allredirects["gapnamespace"] = ns
|
||||
|
||||
for pages_snippet in self.query_continue(query_allredirects):
|
||||
pages_snippet = sorted(pages_snippet["pages"].values(), key=lambda d: d["title"])
|
||||
for page in pages_snippet:
|
||||
# construct the mapping, the query result is somewhat reversed...
|
||||
target_title = page["title"]
|
||||
for redirect in page.get("redirects", []):
|
||||
source_title = redirect["title"]
|
||||
target_fragment = redirect.get("fragment")
|
||||
if target_fragment:
|
||||
self._redirects[source_title] = "{}#{}".format(target_title, target_fragment)
|
||||
else:
|
||||
self._redirects[source_title] = target_title
|
||||
|
||||
def redirects(self):
|
||||
if self._redirects is None:
|
||||
self._fetch_redirects()
|
||||
return self._redirects
|
||||
|
||||
def resolve_redirect(self, title):
|
||||
""" Returns redirect target title, or given title if it is not redirect.
|
||||
The returned title will always contain spaces instead of underscores.
|
||||
"""
|
||||
# the given title must match the format of titles used in self._redirects
|
||||
title = title.replace("_", " ")
|
||||
|
||||
return self.redirects().get(title, title)
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
#! /usr/bin/env python3
|
||||
|
||||
__author__ = "Jakub Klinkovský <lahwaacz at archlinux dot org>"
|
||||
__url__ = "https://github.com/lahwaacz/arch-wiki-docs"
|
||||
__version__ = "0.2"
|
||||
|
||||
from .ArchWiki import *
|
||||
from .downloader import *
|
||||
from .optimizer import *
|
||||
|
|
@ -0,0 +1,157 @@
|
|||
#! /usr/bin/env python3
|
||||
|
||||
import os
|
||||
import subprocess
|
||||
|
||||
# for filter_pre
|
||||
import lxml.etree
|
||||
import lxml.html
|
||||
|
||||
# for filter_in
|
||||
import json
|
||||
import pandocfilters
|
||||
|
||||
class PandocError(Exception):
|
||||
def __init__(self, retcode, errs):
|
||||
Exception.__init__(self, "pandoc failed with return code %s\nstderr:\n%s" % (retcode, errs))
|
||||
|
||||
class ManFilter:
|
||||
format = "man"
|
||||
|
||||
def filter_pre(self, instring):
|
||||
root = lxml.html.fromstring(instring)
|
||||
|
||||
# force headers to start from level 1
|
||||
content = root.cssselect("#bodyContent")[0]
|
||||
headers = content.cssselect("h1, h2, h3, h4, h5, h6")
|
||||
if len(headers) > 0:
|
||||
top_level = int(headers[0].tag[-1])
|
||||
for h in headers:
|
||||
level = int(h.tag[-1]) - top_level + 1
|
||||
h.tag = "h%d" % max(level, 1)
|
||||
|
||||
# add some headers to distinguish divs in output formats like man
|
||||
for catlinks in root.cssselect("#catlinks"):
|
||||
h = lxml.etree.Element("h1")
|
||||
h.text = "Categories"
|
||||
catlinks.insert(0, h)
|
||||
for footer in root.cssselect("#footer"):
|
||||
h = lxml.etree.Element("h1")
|
||||
h.text = "Notes"
|
||||
footer.insert(0, h)
|
||||
|
||||
return lxml.etree.tostring(root, encoding="unicode", method="html", doctype="<!DOCTYPE html>")
|
||||
|
||||
def filter_in(self, instring):
|
||||
def _filter(key, value, format, meta):
|
||||
# remove HTML specific stuff
|
||||
if key == "Link":
|
||||
# remove relative path prefix and .html suffix
|
||||
internal, [href, text] = value
|
||||
if href.endswith(".html"):
|
||||
href = href[:-5]
|
||||
# FIXME: this stupid detection will not work
|
||||
# or just leave the full path?
|
||||
# if href.startswith("./"):
|
||||
# href = href[2:]
|
||||
# elif href.startswith("../"):
|
||||
# href = href[3:]
|
||||
return pandocfilters.Link(internal, [href, text])
|
||||
|
||||
# TODO: it's implemented in filter_pre, but could be useful anyway since html may not be
|
||||
# the only input format; the most generic way should be implemented
|
||||
# if key == "Header":
|
||||
# level, classes, internal = value
|
||||
#
|
||||
# # record top level
|
||||
# if self.heading_top_level == 0:
|
||||
# self.heading_top_level = level
|
||||
#
|
||||
# # ensure we start from h1 in output
|
||||
# if level > self.heading_top_level:
|
||||
# level -= self.heading_top_level
|
||||
#
|
||||
# return pandocfilters.Header(level, classes, internal)
|
||||
|
||||
doc = json.loads(instring)
|
||||
altered = pandocfilters.walk(doc, _filter, self.format, doc[0]["unMeta"])
|
||||
return json.dumps(altered)
|
||||
|
||||
def filter_post(self, instring):
|
||||
return instring
|
||||
|
||||
class Converter:
|
||||
def __init__(self, filter_inst, input_dir, output_dir, output_format):
|
||||
self.filter = filter_inst
|
||||
self.input_dir = os.path.abspath(input_dir)
|
||||
self.output_dir = os.path.abspath(output_dir)
|
||||
self.output_format = output_format
|
||||
|
||||
# ensure output directory always exists
|
||||
if not os.path.isdir(self.output_dir):
|
||||
os.mkdir(self.output_dir)
|
||||
|
||||
def convert(self):
|
||||
failed = []
|
||||
|
||||
for path, dirs, files in os.walk(self.input_dir):
|
||||
for f in files:
|
||||
infile = os.path.join(path, f)
|
||||
outdir = os.path.join(self.output_dir, os.path.relpath(path, self.input_dir))
|
||||
outfile = os.path.join(os.path.normpath(outdir), f)
|
||||
outfile = os.path.splitext(outfile)[0] + "." + self.output_format
|
||||
if infile.endswith(".html"):
|
||||
try:
|
||||
self.convert_file(infile, outfile)
|
||||
except PandocError as e:
|
||||
failed.append(infile)
|
||||
print(e)
|
||||
print(" [conv failed] %s" % infile)
|
||||
else:
|
||||
print(" [skip conv] %s" % infile)
|
||||
|
||||
if len(failed) > 0:
|
||||
print("failed to convert %d pages:" % len(failed))
|
||||
for f in failed:
|
||||
print(" %s" % f)
|
||||
|
||||
def convert_file(self, infile, outfile):
|
||||
print(" [converting] %s" % infile)
|
||||
|
||||
# ensure that target directory exists (necessary for subpages)
|
||||
try:
|
||||
os.makedirs(os.path.split(outfile)[0])
|
||||
except FileExistsError:
|
||||
pass
|
||||
|
||||
content = open(infile, "r").read()
|
||||
content = self.filter.filter_pre(content)
|
||||
content = self.pandoc_first(content)
|
||||
content = self.filter.filter_in(content)
|
||||
content = self.pandoc_last(content)
|
||||
content = self.filter.filter_post(content)
|
||||
|
||||
f = open(outfile, "w")
|
||||
f.write(content)
|
||||
f.close()
|
||||
|
||||
def run_pandoc(self, cmd, instring):
|
||||
popen = subprocess.Popen(cmd, shell=True, universal_newlines=True,
|
||||
stdin=subprocess.PIPE, stdout=subprocess.PIPE)
|
||||
outs, errs = popen.communicate(instring)
|
||||
|
||||
if popen.returncode != 0:
|
||||
raise PandocError(popen.returncode, errs)
|
||||
|
||||
return outs
|
||||
|
||||
def pandoc_first(self, instring):
|
||||
return self.run_pandoc("pandoc -s -f html -t json", instring)
|
||||
|
||||
def pandoc_last(self, instring):
|
||||
return self.run_pandoc("pandoc -s -f json -t %s" % self.output_format, instring)
|
||||
|
||||
if __name__ == "__main__":
|
||||
f = ManFilter()
|
||||
c = Converter(f, "./wiki/", "./output/", "man")
|
||||
c.convert()
|
||||
|
|
@ -0,0 +1,157 @@
|
|||
#! /usr/bin/env python3
|
||||
|
||||
import os
|
||||
import datetime
|
||||
|
||||
import requests
|
||||
from requests.packages.urllib3.util.retry import Retry
|
||||
|
||||
class Downloader:
|
||||
query_allpages = {
|
||||
"action": "query",
|
||||
"generator": "allpages",
|
||||
"gaplimit": "max",
|
||||
"gapfilterredir": "nonredirects",
|
||||
"gapnamespace": "0",
|
||||
"prop": "info",
|
||||
"inprop": "url",
|
||||
"continue": "",
|
||||
}
|
||||
|
||||
query_allimages = {
|
||||
"action": "query",
|
||||
"list": "allimages",
|
||||
"ailimit": "max",
|
||||
"aiprop": "url|timestamp",
|
||||
"continue": "",
|
||||
}
|
||||
|
||||
css_links = {
|
||||
"https://wiki.archlinux.org/load.php?lang=en&modules=site.styles|skins.vector.icons,styles|zzz.ext.archLinux.styles&only=styles&skin=vector-2022": "ArchWikiOffline.css",
|
||||
}
|
||||
|
||||
def __init__(self, wiki, output_directory, epoch, *, optimizer=None):
|
||||
""" Parameters:
|
||||
@wiki: ArchWiki instance to work with
|
||||
@output_directory: where to store the downloaded files
|
||||
@epoch: force update of every file older than this date (must be instance
|
||||
of 'datetime')
|
||||
@optimizer: callback function for HTML post-processing
|
||||
"""
|
||||
|
||||
self.wiki = wiki
|
||||
self.output_directory = output_directory
|
||||
self.epoch = epoch
|
||||
self.optimizer = optimizer
|
||||
|
||||
# ensure output directory always exists
|
||||
if not os.path.isdir(self.output_directory):
|
||||
os.mkdir(self.output_directory)
|
||||
|
||||
# list of valid files
|
||||
self.files = []
|
||||
|
||||
self.session = requests.Session()
|
||||
# granular control over requests' retries: https://stackoverflow.com/a/35504626
|
||||
retries = Retry(total=3, backoff_factor=1, status_forcelist=[429, 500, 502, 503, 504])
|
||||
adapter = requests.adapters.HTTPAdapter(max_retries=retries)
|
||||
self.session.mount("https://", adapter)
|
||||
self.session.mount("http://", adapter)
|
||||
|
||||
def needs_update(self, fname, timestamp):
|
||||
""" determine if it is necessary to download a page
|
||||
"""
|
||||
|
||||
if not os.path.exists(fname):
|
||||
return True
|
||||
local = datetime.datetime.utcfromtimestamp(os.path.getmtime(fname))
|
||||
if local < timestamp or local < self.epoch:
|
||||
return True
|
||||
return False
|
||||
|
||||
def process_namespace(self, namespace):
|
||||
""" walk all pages in given namespace, download if necessary
|
||||
"""
|
||||
|
||||
print(f"Processing namespace {namespace}...")
|
||||
|
||||
query = self.query_allpages.copy()
|
||||
query["gapnamespace"] = namespace
|
||||
for pages_snippet in self.wiki.query_continue(query):
|
||||
for page in sorted(pages_snippet["pages"].values(), key=lambda d: d["title"]):
|
||||
title = page["title"]
|
||||
fname = self.wiki.get_local_filename(title, self.output_directory)
|
||||
if not fname:
|
||||
print(f" [skipping] {title}")
|
||||
continue
|
||||
self.files.append(fname)
|
||||
timestamp = self.wiki.parse_date(page["touched"])
|
||||
if self.needs_update(fname, timestamp):
|
||||
print(f" [downloading] {title}")
|
||||
fullurl = page["fullurl"]
|
||||
|
||||
r = self.session.get(fullurl)
|
||||
if self.optimizer is not None:
|
||||
text = self.optimizer.optimize(fname, r.text)
|
||||
else:
|
||||
text = r.text
|
||||
|
||||
# ensure that target directory exists (necessary for subpages)
|
||||
os.makedirs(os.path.dirname(fname), exist_ok=True)
|
||||
|
||||
with open(fname, "w") as fd:
|
||||
fd.write(text)
|
||||
else:
|
||||
print(f" [up-to-date] {title}")
|
||||
|
||||
def download_css(self):
|
||||
print("Downloading CSS...")
|
||||
for link, dest in self.css_links.items():
|
||||
print(" ", dest)
|
||||
fname = os.path.join(self.output_directory, dest)
|
||||
if fname:
|
||||
self.files.append(fname)
|
||||
r = self.session.get(link)
|
||||
with open(fname, "w") as fd:
|
||||
fd.write(r.text)
|
||||
|
||||
def download_images(self):
|
||||
print("Downloading images...")
|
||||
query = self.query_allimages.copy()
|
||||
for images_snippet in self.wiki.query_continue(query):
|
||||
for image in images_snippet["allimages"]:
|
||||
title = image["title"]
|
||||
fname = self.wiki.get_local_filename(title, self.output_directory)
|
||||
if not fname:
|
||||
print(f" [skipping] {title}")
|
||||
continue
|
||||
self.files.append(fname)
|
||||
timestamp = self.wiki.parse_date(image["timestamp"])
|
||||
if self.needs_update(fname, timestamp):
|
||||
print(f" [downloading] {title}")
|
||||
r = self.session.get(image["url"])
|
||||
with open(fname, "wb") as fd:
|
||||
fd.write(r.content)
|
||||
else:
|
||||
print(f" [up-to-date] {title}")
|
||||
|
||||
def clean_output_directory(self):
|
||||
""" Walk output_directory and delete all files not found on the wiki.
|
||||
Should be run _after_ downloading, otherwise all files will be deleted!
|
||||
"""
|
||||
|
||||
print("Deleting unwanted files (deleted/moved on the wiki)...")
|
||||
valid_files = self.files.copy()
|
||||
|
||||
for path, dirs, files in os.walk(self.output_directory, topdown=False):
|
||||
# handle files
|
||||
for f in files:
|
||||
fpath = os.path.join(path, f)
|
||||
if fpath not in valid_files:
|
||||
print(f" [deleting] {fpath}")
|
||||
os.unlink(fpath)
|
||||
|
||||
# remove empty directories
|
||||
if len(os.listdir(path)) == 0:
|
||||
print(f" [deleting] {path}/")
|
||||
os.rmdir(path)
|
||||
|
|
@ -0,0 +1,124 @@
|
|||
#! /usr/bin/env python3
|
||||
|
||||
import os
|
||||
import re
|
||||
import lxml.etree
|
||||
import lxml.html
|
||||
import urllib.parse
|
||||
|
||||
class Optimizer:
|
||||
def __init__(self, wiki, base_directory):
|
||||
""" @wiki: ArchWiki instance to work with
|
||||
@base_directory: absolute path to base output directory, used for
|
||||
computation of relative links
|
||||
"""
|
||||
self.wiki = wiki
|
||||
self.base_directory = base_directory
|
||||
|
||||
def optimize(self, title, html_content):
|
||||
# path relative from the HTML file to base output directory
|
||||
relbase = os.path.relpath(self.base_directory, os.path.dirname(title))
|
||||
|
||||
css_path = os.path.join(relbase, "ArchWikiOffline.css")
|
||||
|
||||
# parse the HTML
|
||||
root = lxml.html.document_fromstring(html_content)
|
||||
|
||||
# optimize
|
||||
self.strip_page(root)
|
||||
self.fix_layout(root)
|
||||
self.replace_css_links(root, css_path)
|
||||
self.update_links(root, relbase)
|
||||
self.fix_footer(root)
|
||||
|
||||
# return output
|
||||
return lxml.etree.tostring(root,
|
||||
pretty_print=True,
|
||||
encoding="unicode",
|
||||
method="html",
|
||||
doctype="<!DOCTYPE html>")
|
||||
|
||||
def strip_page(self, root):
|
||||
""" remove elements useless in offline browsing
|
||||
"""
|
||||
|
||||
for e in root.cssselect("#archnavbar, #mw-navigation, header.mw-header, .vector-sitenotice-container, .vector-page-toolbar"):
|
||||
e.getparent().remove(e)
|
||||
|
||||
# strip comments (including IE 6/7 fixes, which are useless for an Arch package)
|
||||
lxml.etree.strip_elements(root, lxml.etree.Comment)
|
||||
|
||||
# strip <script> tags
|
||||
lxml.etree.strip_elements(root, "script")
|
||||
|
||||
def fix_layout(self, root):
|
||||
""" fix page layout after removing some elements
|
||||
"""
|
||||
|
||||
# in case of select-by-id a list with max one element is returned
|
||||
for c in root.cssselect("#content"):
|
||||
c.set("style", "margin: 0")
|
||||
for f in root.cssselect("#footer"):
|
||||
f.set("style", "margin: 0")
|
||||
|
||||
def replace_css_links(self, root, css_path):
|
||||
""" force using local CSS
|
||||
"""
|
||||
|
||||
links = root.xpath("//head/link[@rel=\"stylesheet\"]")
|
||||
|
||||
# overwrite first
|
||||
links[0].set("href", css_path)
|
||||
|
||||
# remove the rest
|
||||
for link in links[1:]:
|
||||
link.getparent().remove(link)
|
||||
|
||||
def update_links(self, root, relbase):
|
||||
""" change "internal" wiki links into relative
|
||||
"""
|
||||
|
||||
for a in root.cssselect("a"):
|
||||
href = a.get("href")
|
||||
if href is not None:
|
||||
href = urllib.parse.unquote(href)
|
||||
# matching full URL is necessary for interlanguage links
|
||||
match = re.match("^(https://wiki.archlinux.org)?/title/(?P<title>.+?)(?:#(?P<fragment>.+))?$", str(href))
|
||||
if match:
|
||||
title = self.wiki.resolve_redirect(match.group("title"))
|
||||
try:
|
||||
title, fragment = title.split("#", maxsplit=1)
|
||||
# FIXME has to be dot-encoded
|
||||
fragment = fragment.replace(" ", "_")
|
||||
except ValueError:
|
||||
fragment = ""
|
||||
# explicit fragment overrides the redirect
|
||||
if match.group("fragment"):
|
||||
fragment = match.group("fragment")
|
||||
href = self.wiki.get_local_filename(title, relbase)
|
||||
# get_local_filename returns None for skipped pages
|
||||
if href is None:
|
||||
continue
|
||||
if fragment:
|
||||
href += "#" + fragment
|
||||
a.set("href", href)
|
||||
|
||||
for i in root.cssselect("img"):
|
||||
src = i.get("src")
|
||||
if src and src.startswith("/images/"):
|
||||
src = os.path.join(relbase, "File:" + os.path.split(src)[1])
|
||||
i.set("src", src)
|
||||
|
||||
def fix_footer(self, root):
|
||||
""" move content from 'div.printfooter' into item in '#footer-info'
|
||||
(normally 'div.printfooter' is given 'display:none' and is separated by
|
||||
the categories list from the real footer)
|
||||
"""
|
||||
|
||||
for printfooter in root.cssselect("div.printfooter"):
|
||||
printfooter.attrib.pop("class")
|
||||
printfooter.tag = "li"
|
||||
f_list = root.cssselect("#footer-info")[0]
|
||||
f_list.insert(0, printfooter)
|
||||
br = lxml.etree.Element("br")
|
||||
f_list.insert(3, br)
|
||||
|
|
@ -0,0 +1,674 @@
|
|||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU General Public License is a free, copyleft license for
|
||||
software and other kinds of works.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
the GNU General Public License is intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users. We, the Free Software Foundation, use the
|
||||
GNU General Public License for most of our software; it applies also to
|
||||
any other work released this way by its authors. You can apply it to
|
||||
your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
them if you wish), that you receive source code or can get it if you
|
||||
want it, that you can change the software or use pieces of it in new
|
||||
free programs, and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to prevent others from denying you
|
||||
these rights or asking you to surrender the rights. Therefore, you have
|
||||
certain responsibilities if you distribute copies of the software, or if
|
||||
you modify it: responsibilities to respect the freedom of others.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must pass on to the recipients the same
|
||||
freedoms that you received. You must make sure that they, too, receive
|
||||
or can get the source code. And you must show them these terms so they
|
||||
know their rights.
|
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps:
|
||||
(1) assert copyright on the software, and (2) offer you this License
|
||||
giving you legal permission to copy, distribute and/or modify it.
|
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains
|
||||
that there is no warranty for this free software. For both users' and
|
||||
authors' sake, the GPL requires that modified versions be marked as
|
||||
changed, so that their problems will not be attributed erroneously to
|
||||
authors of previous versions.
|
||||
|
||||
Some devices are designed to deny users access to install or run
|
||||
modified versions of the software inside them, although the manufacturer
|
||||
can do so. This is fundamentally incompatible with the aim of
|
||||
protecting users' freedom to change the software. The systematic
|
||||
pattern of such abuse occurs in the area of products for individuals to
|
||||
use, which is precisely where it is most unacceptable. Therefore, we
|
||||
have designed this version of the GPL to prohibit the practice for those
|
||||
products. If such problems arise substantially in other domains, we
|
||||
stand ready to extend this provision to those domains in future versions
|
||||
of the GPL, as needed to protect the freedom of users.
|
||||
|
||||
Finally, every program is threatened constantly by software patents.
|
||||
States should not allow patents to restrict development and use of
|
||||
software on general-purpose computers, but in those that do, we wish to
|
||||
avoid the special danger that patents applied to a free program could
|
||||
make it effectively proprietary. To prevent this, the GPL assures that
|
||||
patents cannot be used to render the program non-free.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this
|
||||
License. Each licensee is addressed as "you". "Licensees" and
|
||||
"recipients" may be individuals or organizations.
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work
|
||||
in a fashion requiring copyright permission, other than the making of an
|
||||
exact copy. The resulting work is called a "modified version" of the
|
||||
earlier work or a work "based on" the earlier work.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
|
||||
To "propagate" a work means to do anything with it that, without
|
||||
permission, would make you directly or secondarily liable for
|
||||
infringement under applicable copyright law, except executing it on a
|
||||
computer or modifying a private copy. Propagation includes copying,
|
||||
distribution (with or without modification), making available to the
|
||||
public, and in some countries other activities as well.
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other
|
||||
parties to make or receive copies. Mere interaction with a user through
|
||||
a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices"
|
||||
to the extent that it includes a convenient and prominently visible
|
||||
feature that (1) displays an appropriate copyright notice, and (2)
|
||||
tells the user that there is no warranty for the work (except to the
|
||||
extent that warranties are provided), that licensees may convey the
|
||||
work under this License, and how to view a copy of this License. If
|
||||
the interface presents a list of user commands or options, such as a
|
||||
menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
|
||||
The "source code" for a work means the preferred form of the work
|
||||
for making modifications to it. "Object code" means any non-source
|
||||
form of a work.
|
||||
|
||||
A "Standard Interface" means an interface that either is an official
|
||||
standard defined by a recognized standards body, or, in the case of
|
||||
interfaces specified for a particular programming language, one that
|
||||
is widely used among developers working in that language.
|
||||
|
||||
The "System Libraries" of an executable work include anything, other
|
||||
than the work as a whole, that (a) is included in the normal form of
|
||||
packaging a Major Component, but which is not part of that Major
|
||||
Component, and (b) serves only to enable use of the work with that
|
||||
Major Component, or to implement a Standard Interface for which an
|
||||
implementation is available to the public in source code form. A
|
||||
"Major Component", in this context, means a major essential component
|
||||
(kernel, window system, and so on) of the specific operating system
|
||||
(if any) on which the executable work runs, or a compiler used to
|
||||
produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all
|
||||
the source code needed to generate, install, and (for an executable
|
||||
work) run the object code and to modify the work, including scripts to
|
||||
control those activities. However, it does not include the work's
|
||||
System Libraries, or general-purpose tools or generally available free
|
||||
programs which are used unmodified in performing those activities but
|
||||
which are not part of the work. For example, Corresponding Source
|
||||
includes interface definition files associated with source files for
|
||||
the work, and the source code for shared libraries and dynamically
|
||||
linked subprograms that the work is specifically designed to require,
|
||||
such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users
|
||||
can regenerate automatically from other parts of the Corresponding
|
||||
Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that
|
||||
same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
copyright on the Program, and are irrevocable provided the stated
|
||||
conditions are met. This License explicitly affirms your unlimited
|
||||
permission to run the unmodified Program. The output from running a
|
||||
covered work is covered by this License only if the output, given its
|
||||
content, constitutes a covered work. This License acknowledges your
|
||||
rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not
|
||||
convey, without conditions so long as your license otherwise remains
|
||||
in force. You may convey covered works to others for the sole purpose
|
||||
of having them make modifications exclusively for you, or provide you
|
||||
with facilities for running those works, provided that you comply with
|
||||
the terms of this License in conveying all material for which you do
|
||||
not control copyright. Those thus making or running the covered works
|
||||
for you must do so exclusively on your behalf, under your direction
|
||||
and control, on terms that prohibit them from making any copies of
|
||||
your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under
|
||||
the conditions stated below. Sublicensing is not allowed; section 10
|
||||
makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
measure under any applicable law fulfilling obligations under article
|
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||
similar laws prohibiting or restricting circumvention of such
|
||||
measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid
|
||||
circumvention of technological measures to the extent such circumvention
|
||||
is effected by exercising rights under this License with respect to
|
||||
the covered work, and you disclaim any intention to limit operation or
|
||||
modification of the work as a means of enforcing, against the work's
|
||||
users, your or third parties' legal rights to forbid circumvention of
|
||||
technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey verbatim copies of the Program's source code as you
|
||||
receive it, in any medium, provided that you conspicuously and
|
||||
appropriately publish on each copy an appropriate copyright notice;
|
||||
keep intact all notices stating that this License and any
|
||||
non-permissive terms added in accord with section 7 apply to the code;
|
||||
keep intact all notices of the absence of any warranty; and give all
|
||||
recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey,
|
||||
and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
produce it from the Program, in the form of source code under the
|
||||
terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified
|
||||
it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is
|
||||
released under this License and any conditions added under section
|
||||
7. This requirement modifies the requirement in section 4 to
|
||||
"keep intact all notices".
|
||||
|
||||
c) You must license the entire work, as a whole, under this
|
||||
License to anyone who comes into possession of a copy. This
|
||||
License will therefore apply, along with any applicable section 7
|
||||
additional terms, to the whole of the work, and all its parts,
|
||||
regardless of how they are packaged. This License gives no
|
||||
permission to license the work in any other way, but it does not
|
||||
invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display
|
||||
Appropriate Legal Notices; however, if the Program has interactive
|
||||
interfaces that do not display Appropriate Legal Notices, your
|
||||
work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
works, which are not by their nature extensions of the covered work,
|
||||
and which are not combined with it such as to form a larger program,
|
||||
in or on a volume of a storage or distribution medium, is called an
|
||||
"aggregate" if the compilation and its resulting copyright are not
|
||||
used to limit the access or legal rights of the compilation's users
|
||||
beyond what the individual works permit. Inclusion of a covered work
|
||||
in an aggregate does not cause this License to apply to the other
|
||||
parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms
|
||||
of sections 4 and 5, provided that you also convey the
|
||||
machine-readable Corresponding Source under the terms of this License,
|
||||
in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by the
|
||||
Corresponding Source fixed on a durable physical medium
|
||||
customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by a
|
||||
written offer, valid for at least three years and valid for as
|
||||
long as you offer spare parts or customer support for that product
|
||||
model, to give anyone who possesses the object code either (1) a
|
||||
copy of the Corresponding Source for all the software in the
|
||||
product that is covered by this License, on a durable physical
|
||||
medium customarily used for software interchange, for a price no
|
||||
more than your reasonable cost of physically performing this
|
||||
conveying of source, or (2) access to copy the
|
||||
Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the
|
||||
written offer to provide the Corresponding Source. This
|
||||
alternative is allowed only occasionally and noncommercially, and
|
||||
only if you received the object code with such an offer, in accord
|
||||
with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated
|
||||
place (gratis or for a charge), and offer equivalent access to the
|
||||
Corresponding Source in the same way through the same place at no
|
||||
further charge. You need not require recipients to copy the
|
||||
Corresponding Source along with the object code. If the place to
|
||||
copy the object code is a network server, the Corresponding Source
|
||||
may be on a different server (operated by you or a third party)
|
||||
that supports equivalent copying facilities, provided you maintain
|
||||
clear directions next to the object code saying where to find the
|
||||
Corresponding Source. Regardless of what server hosts the
|
||||
Corresponding Source, you remain obligated to ensure that it is
|
||||
available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided
|
||||
you inform other peers where the object code and Corresponding
|
||||
Source of the work are being offered to the general public at no
|
||||
charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded
|
||||
from the Corresponding Source as a System Library, need not be
|
||||
included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any
|
||||
tangible personal property which is normally used for personal, family,
|
||||
or household purposes, or (2) anything designed or sold for incorporation
|
||||
into a dwelling. In determining whether a product is a consumer product,
|
||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||
product received by a particular user, "normally used" refers to a
|
||||
typical or common use of that class of product, regardless of the status
|
||||
of the particular user or of the way in which the particular user
|
||||
actually uses, or expects or is expected to use, the product. A product
|
||||
is a consumer product regardless of whether the product has substantial
|
||||
commercial, industrial or non-consumer uses, unless such uses represent
|
||||
the only significant mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods,
|
||||
procedures, authorization keys, or other information required to install
|
||||
and execute modified versions of a covered work in that User Product from
|
||||
a modified version of its Corresponding Source. The information must
|
||||
suffice to ensure that the continued functioning of the modified object
|
||||
code is in no case prevented or interfered with solely because
|
||||
modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or
|
||||
specifically for use in, a User Product, and the conveying occurs as
|
||||
part of a transaction in which the right of possession and use of the
|
||||
User Product is transferred to the recipient in perpetuity or for a
|
||||
fixed term (regardless of how the transaction is characterized), the
|
||||
Corresponding Source conveyed under this section must be accompanied
|
||||
by the Installation Information. But this requirement does not apply
|
||||
if neither you nor any third party retains the ability to install
|
||||
modified object code on the User Product (for example, the work has
|
||||
been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a
|
||||
requirement to continue to provide support service, warranty, or updates
|
||||
for a work that has been modified or installed by the recipient, or for
|
||||
the User Product in which it has been modified or installed. Access to a
|
||||
network may be denied when the modification itself materially and
|
||||
adversely affects the operation of the network or violates the rules and
|
||||
protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided,
|
||||
in accord with this section must be in a format that is publicly
|
||||
documented (and with an implementation available to the public in
|
||||
source code form), and must require no special password or key for
|
||||
unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
|
||||
"Additional permissions" are terms that supplement the terms of this
|
||||
License by making exceptions from one or more of its conditions.
|
||||
Additional permissions that are applicable to the entire Program shall
|
||||
be treated as though they were included in this License, to the extent
|
||||
that they are valid under applicable law. If additional permissions
|
||||
apply only to part of the Program, that part may be used separately
|
||||
under those permissions, but the entire Program remains governed by
|
||||
this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option
|
||||
remove any additional permissions from that copy, or from any part of
|
||||
it. (Additional permissions may be written to require their own
|
||||
removal in certain cases when you modify the work.) You may place
|
||||
additional permissions on material, added by you to a covered work,
|
||||
for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you
|
||||
add to a covered work, you may (if authorized by the copyright holders of
|
||||
that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the
|
||||
terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or
|
||||
author attributions in that material or in the Appropriate Legal
|
||||
Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or
|
||||
requiring that modified versions of such material be marked in
|
||||
reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or
|
||||
authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some
|
||||
trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that
|
||||
material by anyone who conveys the material (or modified versions of
|
||||
it) with contractual assumptions of liability to the recipient, for
|
||||
any liability that these contractual assumptions directly impose on
|
||||
those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further
|
||||
restrictions" within the meaning of section 10. If the Program as you
|
||||
received it, or any part of it, contains a notice stating that it is
|
||||
governed by this License along with a term that is a further
|
||||
restriction, you may remove that term. If a license document contains
|
||||
a further restriction but permits relicensing or conveying under this
|
||||
License, you may add to a covered work material governed by the terms
|
||||
of that license document, provided that the further restriction does
|
||||
not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you
|
||||
must place, in the relevant source files, a statement of the
|
||||
additional terms that apply to those files, or a notice indicating
|
||||
where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the
|
||||
form of a separately written license, or stated as exceptions;
|
||||
the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
provided under this License. Any attempt otherwise to propagate or
|
||||
modify it is void, and will automatically terminate your rights under
|
||||
this License (including any patent licenses granted under the third
|
||||
paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your
|
||||
license from a particular copyright holder is reinstated (a)
|
||||
provisionally, unless and until the copyright holder explicitly and
|
||||
finally terminates your license, and (b) permanently, if the copyright
|
||||
holder fails to notify you of the violation by some reasonable means
|
||||
prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, you do not qualify to receive new licenses for the same
|
||||
material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or
|
||||
run a copy of the Program. Ancillary propagation of a covered work
|
||||
occurring solely as a consequence of using peer-to-peer transmission
|
||||
to receive a copy likewise does not require acceptance. However,
|
||||
nothing other than this License grants you permission to propagate or
|
||||
modify any covered work. These actions infringe copyright if you do
|
||||
not accept this License. Therefore, by modifying or propagating a
|
||||
covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
receives a license from the original licensors, to run, modify and
|
||||
propagate that work, subject to this License. You are not responsible
|
||||
for enforcing compliance by third parties with this License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an
|
||||
organization, or substantially all assets of one, or subdividing an
|
||||
organization, or merging organizations. If propagation of a covered
|
||||
work results from an entity transaction, each party to that
|
||||
transaction who receives a copy of the work also receives whatever
|
||||
licenses to the work the party's predecessor in interest had or could
|
||||
give under the previous paragraph, plus a right to possession of the
|
||||
Corresponding Source of the work from the predecessor in interest, if
|
||||
the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the
|
||||
rights granted or affirmed under this License. For example, you may
|
||||
not impose a license fee, royalty, or other charge for exercise of
|
||||
rights granted under this License, and you may not initiate litigation
|
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||
any patent claim is infringed by making, using, selling, offering for
|
||||
sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this
|
||||
License of the Program or a work on which the Program is based. The
|
||||
work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims
|
||||
owned or controlled by the contributor, whether already acquired or
|
||||
hereafter acquired, that would be infringed by some manner, permitted
|
||||
by this License, of making, using, or selling its contributor version,
|
||||
but do not include claims that would be infringed only as a
|
||||
consequence of further modification of the contributor version. For
|
||||
purposes of this definition, "control" includes the right to grant
|
||||
patent sublicenses in a manner consistent with the requirements of
|
||||
this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||
patent license under the contributor's essential patent claims, to
|
||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||
propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any express
|
||||
agreement or commitment, however denominated, not to enforce a patent
|
||||
(such as an express permission to practice a patent or covenant not to
|
||||
sue for patent infringement). To "grant" such a patent license to a
|
||||
party means to make such an agreement or commitment not to enforce a
|
||||
patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license,
|
||||
and the Corresponding Source of the work is not available for anyone
|
||||
to copy, free of charge and under the terms of this License, through a
|
||||
publicly available network server or other readily accessible means,
|
||||
then you must either (1) cause the Corresponding Source to be so
|
||||
available, or (2) arrange to deprive yourself of the benefit of the
|
||||
patent license for this particular work, or (3) arrange, in a manner
|
||||
consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. "Knowingly relying" means you have
|
||||
actual knowledge that, but for the patent license, your conveying the
|
||||
covered work in a country, or your recipient's use of the covered work
|
||||
in a country, would infringe one or more identifiable patents in that
|
||||
country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or
|
||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||
covered work, and grant a patent license to some of the parties
|
||||
receiving the covered work authorizing them to use, propagate, modify
|
||||
or convey a specific copy of the covered work, then the patent license
|
||||
you grant is automatically extended to all recipients of the covered
|
||||
work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within
|
||||
the scope of its coverage, prohibits the exercise of, or is
|
||||
conditioned on the non-exercise of one or more of the rights that are
|
||||
specifically granted under this License. You may not convey a covered
|
||||
work if you are a party to an arrangement with a third party that is
|
||||
in the business of distributing software, under which you make payment
|
||||
to the third party based on the extent of your activity of conveying
|
||||
the work, and under which the third party grants, to any of the
|
||||
parties who would receive the covered work from you, a discriminatory
|
||||
patent license (a) in connection with copies of the covered work
|
||||
conveyed by you (or copies made from those copies), or (b) primarily
|
||||
for and in connection with specific products or compilations that
|
||||
contain the covered work, unless you entered into that arrangement,
|
||||
or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting
|
||||
any implied license or other defenses to infringement that may
|
||||
otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot convey a
|
||||
covered work so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you may
|
||||
not convey it at all. For example, if you agree to terms that obligate you
|
||||
to collect a royalty for further conveying from those to whom you convey
|
||||
the Program, the only way you could satisfy both those terms and this
|
||||
License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Use with the GNU Affero General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU Affero General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the special requirements of the GNU Affero General Public License,
|
||||
section 13, concerning interaction through a network will apply to the
|
||||
combination as such.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU General Public License from time to time. Such new versions will
|
||||
be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Program specifies that a certain numbered version of the GNU General
|
||||
Public License "or any later version" applies to it, you have the
|
||||
option of following the terms and conditions either of that numbered
|
||||
version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of the
|
||||
GNU General Public License, you may choose any version ever published
|
||||
by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future
|
||||
versions of the GNU General Public License can be used, that proxy's
|
||||
public statement of acceptance of a version permanently authorizes you
|
||||
to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different
|
||||
permissions. However, no additional obligations are imposed on any
|
||||
author or copyright holder as a result of your choosing to follow a
|
||||
later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||
SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
above cannot be given local legal effect according to their terms,
|
||||
reviewing courts shall apply local law that most closely approximates
|
||||
an absolute waiver of all civil liability in connection with the
|
||||
Program, unless a warranty or assumption of liability accompanies a
|
||||
copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
state the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program does terminal interaction, make it output a short
|
||||
notice like this when it starts in an interactive mode:
|
||||
|
||||
<program> Copyright (C) <year> <name of author>
|
||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it
|
||||
under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||
parts of the General Public License. Of course, your program's commands
|
||||
might be different; for a GUI interface, you would use an "about box".
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school,
|
||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||
For more information on this, and how to apply and follow the GNU GPL, see
|
||||
<http://www.gnu.org/licenses/>.
|
||||
|
||||
The GNU General Public License does not permit incorporating your program
|
||||
into proprietary programs. If your program is a subroutine library, you
|
||||
may consider it more useful to permit linking proprietary applications with
|
||||
the library. If this is what you want to do, use the GNU Lesser General
|
||||
Public License instead of this License. But first, please read
|
||||
<http://www.gnu.org/philosophy/why-not-lgpl.html>.
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
# arch-wiki-docs
|
||||
### Fork of https://github.com/lahwaacz/arch-wiki-docs for use on Nix systems using poetry for dependency management
|
||||
|
||||
### example usage:
|
||||
```shell
|
||||
nix-shell --command zsh
|
||||
mkdir .venv
|
||||
poetry install
|
||||
poetry shell
|
||||
./arch-wiki-docs.py --langs en --output-directory ~/.local/share/docs/archwiki/
|
||||
```
|
||||
|
||||
When the command is run a second time, it will only download updates
|
||||
|
|
@ -0,0 +1,46 @@
|
|||
#! /usr/bin/env python3
|
||||
|
||||
import datetime
|
||||
import argparse
|
||||
import sys
|
||||
|
||||
from simplemediawiki import build_user_agent
|
||||
|
||||
import ArchWiki
|
||||
from ArchWiki.ArchWiki import language_names
|
||||
|
||||
if __name__ == "__main__":
|
||||
aparser = argparse.ArgumentParser(description="Download pages from Arch Wiki and optimize them for offline browsing")
|
||||
aparser.add_argument("--output-directory", type=str, required=True, help="Path where the downloaded pages should be stored.")
|
||||
aparser.add_argument("--force", action="store_true", help="Ignore timestamp, always download the page from the wiki.")
|
||||
aparser.add_argument("--clean", action="store_true", help="Clean the output directory after downloading, useful for removing pages deleted/moved on the wiki. Warning: any unknown files found in the output directory will be deleted!")
|
||||
aparser.add_argument("--safe-filenames", action="store_true", help="Force using ASCII file names instead of the default Unicode.")
|
||||
aparser.add_argument("--langs", type=str, nargs='+', help="Download only pages of specified languages")
|
||||
aparser.add_argument("--list-langs", action="store_true", help="List supported languages")
|
||||
|
||||
args = aparser.parse_args()
|
||||
if args.list_langs:
|
||||
for lang in language_names.values():
|
||||
print(lang['subtag'], lang['english'])
|
||||
sys.exit()
|
||||
|
||||
if args.force:
|
||||
epoch = datetime.datetime.utcnow()
|
||||
else:
|
||||
# this should be the date of the latest incompatible change
|
||||
epoch = datetime.datetime(2016, 3, 3, 18, 0, 0)
|
||||
|
||||
user_agent = build_user_agent(__file__, ArchWiki.__version__, ArchWiki.__url__)
|
||||
aw = ArchWiki.ArchWiki(user_agent=user_agent, safe_filenames=args.safe_filenames, langs=args.langs)
|
||||
optimizer = ArchWiki.Optimizer(aw, args.output_directory)
|
||||
|
||||
downloader = ArchWiki.Downloader(aw, args.output_directory, epoch, optimizer=optimizer)
|
||||
downloader.download_css()
|
||||
aw.print_namespaces()
|
||||
for ns in ["0", "4", "12", "14"]:
|
||||
downloader.process_namespace(ns)
|
||||
|
||||
downloader.download_images()
|
||||
|
||||
if args.clean:
|
||||
downloader.clean_output_directory()
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
[tool.poetry]
|
||||
name = "arch-wiki-docs"
|
||||
version = "0.1.0"
|
||||
description = ""
|
||||
authors = ["Sam <samual.shop@proton.me>"]
|
||||
readme = "README.md"
|
||||
package-mode = false
|
||||
|
||||
[virtualenvs]
|
||||
in-project = true
|
||||
|
||||
[tool.poetry.dependencies]
|
||||
python = "^3.11"
|
||||
simplemediawiki = "1.2.0b2"
|
||||
lxml = "^5.3.0"
|
||||
cssselect = "^1.2.0"
|
||||
requests = "^2.32.3"
|
||||
|
||||
|
||||
[build-system]
|
||||
requires = ["poetry-core"]
|
||||
build-backend = "poetry.core.masonry.api"
|
||||
Loading…
Reference in New Issue