mirror of
https://github.com/ArchiveBox/ArchiveBox.git
synced 2025-05-14 07:04:27 -04:00
split archive.py into multiple files, refactor config system
This commit is contained in:
Nick Sweeting
parent
f33330ebbf
commit
fd1435164b
8 changed files with 580 additions and 449 deletions
0
__init__.py
Normal file
0
__init__.py
Normal file
465
archive.py
465
archive.py
|
|
@ -3,434 +3,23 @@
|
||||||
# Nick Sweeting 2017 | MIT License
|
# Nick Sweeting 2017 | MIT License
|
||||||
# https://github.com/pirate/bookmark-archiver
|
# https://github.com/pirate/bookmark-archiver
|
||||||
|
|
||||||
import re
|
|
||||||
import os
|
import os
|
||||||
import sys
|
import sys
|
||||||
import json
|
|
||||||
import time
|
|
||||||
|
|
||||||
from datetime import datetime
|
from datetime import datetime
|
||||||
from subprocess import run, PIPE, DEVNULL
|
from subprocess import run
|
||||||
|
|
||||||
__DESCRIPTION__ = 'Bookmark Archiver: Create a browsable html archive of a list of links.'
|
from parse import parse_export
|
||||||
|
from index import dump_index
|
||||||
|
from fetch import dump_website
|
||||||
|
from config import (
|
||||||
|
ARCHIVE_PERMISSIONS,
|
||||||
|
check_dependencies,
|
||||||
|
)
|
||||||
|
|
||||||
|
DESCRIPTION = 'Bookmark Archiver: Create a browsable html archive of a list of links.'
|
||||||
__DOCUMENTATION__ = 'https://github.com/pirate/bookmark-archiver'
|
__DOCUMENTATION__ = 'https://github.com/pirate/bookmark-archiver'
|
||||||
|
|
||||||
### SETTINGS
|
|
||||||
|
|
||||||
INDEX_TEMPLATE = 'index_template.html'
|
|
||||||
|
|
||||||
# os.getenv('VARIABLE', 'DEFAULT') gets the value of environment
|
|
||||||
# variable "VARIABLE" and if it is not set, sets it to 'DEFAULT'
|
|
||||||
|
|
||||||
# for boolean values, check to see if the string is 'true', and
|
|
||||||
# if so, the python variable will be True
|
|
||||||
|
|
||||||
FETCH_WGET = os.getenv('FETCH_WGET', 'True' ).lower() == 'true'
|
|
||||||
FETCH_WGET_REQUISITES = os.getenv('FETCH_WGET_REQUISITES', 'True' ).lower() == 'true'
|
|
||||||
FETCH_PDF = os.getenv('FETCH_PDF', 'True' ).lower() == 'true'
|
|
||||||
FETCH_SCREENSHOT = os.getenv('FETCH_SCREENSHOT', 'True' ).lower() == 'true'
|
|
||||||
FETCH_FAVICON = os.getenv('FETCH_FAVICON', 'True' ).lower() == 'true'
|
|
||||||
SUBMIT_ARCHIVE_DOT_ORG = os.getenv('SUBMIT_ARCHIVE_DOT_ORG', 'True' ).lower() == 'true'
|
|
||||||
RESOLUTION = os.getenv('RESOLUTION', '1440,900' )
|
|
||||||
ARCHIVE_PERMISSIONS = os.getenv('ARCHIVE_PERMISSIONS', '755' )
|
|
||||||
CHROME_BINARY = os.getenv('CHROME_BINARY', 'chromium-browser' ) # change to google-chrome browser if using google-chrome
|
|
||||||
WGET_BINARY = os.getenv('WGET_BINARY', 'wget' )
|
|
||||||
TIMEOUT = int(os.getenv('TIMEOUT', '60'))
|
|
||||||
|
|
||||||
|
|
||||||
def check_dependencies():
|
|
||||||
print('[*] Checking Dependencies:')
|
|
||||||
if FETCH_PDF or FETCH_SCREENSHOT:
|
|
||||||
if run(['which', CHROME_BINARY]).returncode:
|
|
||||||
print('[X] Missing dependency: {}'.format(CHROME_BINARY))
|
|
||||||
print(' See https://github.com/pirate/bookmark-archiver for help.')
|
|
||||||
raise SystemExit(1)
|
|
||||||
|
|
||||||
# parse chrome --version e.g. Google Chrome 61.0.3114.0 canary / Chromium 59.0.3029.110 built on Ubuntu, running on Ubuntu 16.04
|
|
||||||
result = run([CHROME_BINARY, '--version'], stdout=PIPE)
|
|
||||||
version = result.stdout.decode('utf-8').replace('Google Chrome ', '').replace('Chromium ', '').split(' ', 1)[0].split('.', 1)[0] # TODO: regex might be better
|
|
||||||
if int(version) < 59:
|
|
||||||
print('[X] Chrome version must be 59 or greater for headless PDF and screenshot saving')
|
|
||||||
print(' See https://github.com/pirate/bookmark-archiver for help.')
|
|
||||||
raise SystemExit(1)
|
|
||||||
|
|
||||||
if FETCH_WGET:
|
|
||||||
if run(['which', 'wget']).returncode:
|
|
||||||
print('[X] Missing dependency: wget')
|
|
||||||
print(' See https://github.com/pirate/bookmark-archiver for help.')
|
|
||||||
raise SystemExit(1)
|
|
||||||
|
|
||||||
if FETCH_FAVICON or SUBMIT_ARCHIVE_DOT_ORG:
|
|
||||||
if run(['which', 'curl']).returncode:
|
|
||||||
print('[X] Missing dependency: curl')
|
|
||||||
print(' See https://github.com/pirate/bookmark-archiver for help.')
|
|
||||||
raise SystemExit(1)
|
|
||||||
|
|
||||||
|
|
||||||
### PARSING READER LIST EXPORTS
|
|
||||||
|
|
||||||
def get_link_type(link):
|
|
||||||
"""Certain types of links need to be handled specially, this figures out when that's the case"""
|
|
||||||
|
|
||||||
if link['base_url'].endswith('.pdf'):
|
|
||||||
return 'PDF'
|
|
||||||
elif link['base_url'].rsplit('.', 1) in ('pdf', 'png', 'jpg', 'jpeg', 'svg', 'bmp', 'gif', 'tiff', 'webp'):
|
|
||||||
return 'image'
|
|
||||||
elif 'wikipedia.org' in link['domain']:
|
|
||||||
return 'wiki'
|
|
||||||
elif 'youtube.com' in link['domain']:
|
|
||||||
return 'youtube'
|
|
||||||
return None
|
|
||||||
|
|
||||||
def parse_pocket_export(html_file):
|
|
||||||
"""Parse Pocket-format bookmarks export files (produced by getpocket.com/export/)"""
|
|
||||||
|
|
||||||
html_file.seek(0)
|
|
||||||
pattern = re.compile("^\\s*<li><a href=\"(.+)\" time_added=\"(\\d+)\" tags=\"(.*)\">(.+)</a></li>", re.UNICODE) # see sample input in ./example_ril_export.html
|
|
||||||
for line in html_file:
|
|
||||||
match = pattern.search(line)
|
|
||||||
if match:
|
|
||||||
fixed_url = match.group(1).replace('http://www.readability.com/read?url=', '') # remove old readability prefixes to get original url
|
|
||||||
without_scheme = fixed_url.replace('http://', '').replace('https://', '')
|
|
||||||
info = {
|
|
||||||
'url': fixed_url,
|
|
||||||
'domain': without_scheme.split('/')[0], # without pathname
|
|
||||||
'base_url': without_scheme.split('?')[0], # without query args
|
|
||||||
'time': datetime.fromtimestamp(int(match.group(2))).strftime('%Y-%m-%d %H:%M'),
|
|
||||||
'timestamp': match.group(2),
|
|
||||||
'tags': match.group(3),
|
|
||||||
'title': match.group(4).replace(' — Readability', '').replace('http://www.readability.com/read?url=', '') or without_scheme,
|
|
||||||
}
|
|
||||||
info['type'] = get_link_type(info)
|
|
||||||
yield info
|
|
||||||
|
|
||||||
def parse_json_export(json_file):
|
|
||||||
"""Parse JSON-format bookmarks export files (produced by pinboard.in/export/)"""
|
|
||||||
|
|
||||||
json_file.seek(0)
|
|
||||||
json_content = json.load(json_file)
|
|
||||||
for line in json_content:
|
|
||||||
if line:
|
|
||||||
erg = line
|
|
||||||
info = {
|
|
||||||
'url': erg['href'],
|
|
||||||
'domain': erg['href'].replace('http://', '').replace('https://', '').split('/')[0],
|
|
||||||
'base_url': erg['href'].replace('https://', '').replace('http://', '').split('?')[0],
|
|
||||||
'time': datetime.fromtimestamp(int(time.mktime(time.strptime(erg['time'].split(',')[0], '%Y-%m-%dT%H:%M:%SZ')))),
|
|
||||||
'timestamp': str(int(time.mktime(time.strptime(erg['time'].split(',')[0], '%Y-%m-%dT%H:%M:%SZ')))),
|
|
||||||
'tags': erg['tags'],
|
|
||||||
'title': erg['description'].replace(' — Readability', ''),
|
|
||||||
}
|
|
||||||
info['type'] = get_link_type(info)
|
|
||||||
yield info
|
|
||||||
|
|
||||||
def parse_bookmarks_export(html_file):
|
|
||||||
"""Parse netscape-format bookmarks export files (produced by all browsers)"""
|
|
||||||
|
|
||||||
html_file.seek(0)
|
|
||||||
pattern = re.compile("<a href=\"(.+?)\" add_date=\"(\\d+)\"[^>]*>(.+)</a>", re.UNICODE | re.IGNORECASE)
|
|
||||||
for line in html_file:
|
|
||||||
match = pattern.search(line)
|
|
||||||
if match:
|
|
||||||
url = match.group(1)
|
|
||||||
secs = match.group(2)
|
|
||||||
dt = datetime.fromtimestamp(int(secs))
|
|
||||||
|
|
||||||
info = {
|
|
||||||
'url': url,
|
|
||||||
'domain': url.replace('http://', '').replace('https://', '').split('/')[0],
|
|
||||||
'base_url': url.replace('https://', '').replace('http://', '').split('?')[0],
|
|
||||||
'time': dt,
|
|
||||||
'timestamp': secs,
|
|
||||||
'tags': "",
|
|
||||||
'title': match.group(3),
|
|
||||||
}
|
|
||||||
|
|
||||||
info['type'] = get_link_type(info)
|
|
||||||
yield info
|
|
||||||
|
|
||||||
|
|
||||||
### ACHIVING FUNCTIONS
|
|
||||||
|
|
||||||
def chmod_file(path, cwd='.', permissions=ARCHIVE_PERMISSIONS):
|
|
||||||
if not os.path.exists(os.path.join(cwd, path)):
|
|
||||||
raise Exception('Failed to chmod: {} does not exist (did the previous step fail?)'.format(path))
|
|
||||||
|
|
||||||
chmod_result = run(['chmod', '-R', ARCHIVE_PERMISSIONS, path], cwd=cwd, stdout=DEVNULL, stderr=PIPE, timeout=5)
|
|
||||||
if chmod_result.returncode == 1:
|
|
||||||
print(' ', chmod_result.stderr.decode())
|
|
||||||
raise Exception('Failed to chmod {}/{}'.format(cwd, path))
|
|
||||||
|
|
||||||
def fetch_wget(out_dir, link, overwrite=False):
|
|
||||||
"""download full site using wget"""
|
|
||||||
|
|
||||||
domain = link['base_url'].split('/', 1)[0]
|
|
||||||
if not os.path.exists('{}/{}'.format(out_dir, domain)) or overwrite:
|
|
||||||
print(' - Downloading Full Site')
|
|
||||||
CMD = [
|
|
||||||
*'wget --timestamping --adjust-extension --no-parent'.split(' '), # Docs: https://www.gnu.org/software/wget/manual/wget.html
|
|
||||||
*(('--page-requisites', '--convert-links') if FETCH_WGET_REQUISITES else ()),
|
|
||||||
link['url'],
|
|
||||||
]
|
|
||||||
try:
|
|
||||||
result = run(CMD, stdout=PIPE, stderr=PIPE, cwd=out_dir, timeout=TIMEOUT) # dom.html
|
|
||||||
if result.returncode > 0:
|
|
||||||
print(' ', result.stderr.decode().split('\n')[-1])
|
|
||||||
raise Exception('Failed to wget download')
|
|
||||||
chmod_file(domain, cwd=out_dir)
|
|
||||||
except Exception as e:
|
|
||||||
print(' Run to see full output:', 'cd {}; {}'.format(out_dir, ' '.join(CMD)))
|
|
||||||
print(' Failed: {} {}'.format(e.__class__.__name__, e))
|
|
||||||
else:
|
|
||||||
print(' √ Skipping site download')
|
|
||||||
|
|
||||||
def fetch_pdf(out_dir, link, overwrite=False):
|
|
||||||
"""print PDF of site to file using chrome --headless"""
|
|
||||||
|
|
||||||
if (not os.path.exists('{}/output.pdf'.format(out_dir)) or overwrite) and link['type'] not in ('PDF', 'image'):
|
|
||||||
print(' - Printing PDF')
|
|
||||||
CMD = [
|
|
||||||
CHROME_BINARY,
|
|
||||||
*'--headless --disable-gpu --print-to-pdf'.split(' '),
|
|
||||||
link['url']
|
|
||||||
]
|
|
||||||
try:
|
|
||||||
result = run(CMD, stdout=DEVNULL, stderr=PIPE, cwd=out_dir, timeout=TIMEOUT) # output.pdf
|
|
||||||
if result.returncode:
|
|
||||||
print(' ', result.stderr.decode())
|
|
||||||
raise Exception('Failed to print PDF')
|
|
||||||
chmod_file('output.pdf', cwd=out_dir)
|
|
||||||
except Exception as e:
|
|
||||||
print(' Run to see full output:', 'cd {}; {}'.format(out_dir, ' '.join(CMD)))
|
|
||||||
print(' Failed: {} {}'.format(e.__class__.__name__, e))
|
|
||||||
else:
|
|
||||||
print(' √ Skipping PDF print')
|
|
||||||
|
|
||||||
def fetch_screenshot(out_dir, link, overwrite=False):
|
|
||||||
"""take screenshot of site using chrome --headless"""
|
|
||||||
|
|
||||||
if (not os.path.exists('{}/screenshot.png'.format(out_dir)) or overwrite) and link['type'] not in ('PDF', 'image'):
|
|
||||||
print(' - Snapping Screenshot')
|
|
||||||
CMD = [
|
|
||||||
CHROME_BINARY,
|
|
||||||
*'--headless --disable-gpu --screenshot'.split(' '),
|
|
||||||
'--window-size={}'.format(RESOLUTION),
|
|
||||||
link['url']
|
|
||||||
]
|
|
||||||
try:
|
|
||||||
result = run(CMD, stdout=DEVNULL, stderr=DEVNULL, cwd=out_dir, timeout=TIMEOUT) # sreenshot.png
|
|
||||||
if result.returncode:
|
|
||||||
print(' ', result.stderr.decode())
|
|
||||||
raise Exception('Failed to take screenshot')
|
|
||||||
chmod_file('screenshot.png', cwd=out_dir)
|
|
||||||
except Exception as e:
|
|
||||||
print(' Run to see full output:', 'cd {}; {}'.format(out_dir, ' '.join(CMD)))
|
|
||||||
print(' Failed: {} {}'.format(e.__class__.__name__, e))
|
|
||||||
else:
|
|
||||||
print(' √ Skipping screenshot')
|
|
||||||
|
|
||||||
def archive_dot_org(out_dir, link, overwrite=False):
|
|
||||||
"""submit site to archive.org for archiving via their service, save returned archive url"""
|
|
||||||
if (not os.path.exists('{}/archive.org.txt'.format(out_dir)) or overwrite):
|
|
||||||
print(' - Submitting to archive.org')
|
|
||||||
submit_url = 'https://web.archive.org/save/{}'.format(link['url'].split('?', 1)[0])
|
|
||||||
|
|
||||||
success = False
|
|
||||||
CMD = ['curl', '-I', submit_url]
|
|
||||||
try:
|
|
||||||
result = run(CMD, stdout=PIPE, stderr=DEVNULL, cwd=out_dir, timeout=TIMEOUT) # archive.org
|
|
||||||
headers = result.stdout.splitlines()
|
|
||||||
content_location = [h for h in headers if b'Content-Location: ' in h]
|
|
||||||
if content_location:
|
|
||||||
archive_path = content_location[0].split(b'Content-Location: ', 1)[-1].decode('utf-8')
|
|
||||||
saved_url = 'https://web.archive.org{}'.format(archive_path)
|
|
||||||
success = True
|
|
||||||
else:
|
|
||||||
raise Exception('Failed to find "Content-Location" URL header in Archive.org response.')
|
|
||||||
except Exception as e:
|
|
||||||
print(' Visit url to see output:', ' '.join(CMD))
|
|
||||||
print(' Failed: {} {}'.format(e.__class__.__name__, e))
|
|
||||||
|
|
||||||
if success:
|
|
||||||
with open('{}/archive.org.txt'.format(out_dir), 'w') as f:
|
|
||||||
f.write(saved_url)
|
|
||||||
chmod_file('archive.org.txt', cwd=out_dir)
|
|
||||||
|
|
||||||
else:
|
|
||||||
print(' √ Skipping archive.org')
|
|
||||||
|
|
||||||
def fetch_favicon(out_dir, link, overwrite=False):
|
|
||||||
"""download site favicon from google's favicon api"""
|
|
||||||
|
|
||||||
if not os.path.exists('{}/favicon.ico'.format(out_dir)) or overwrite:
|
|
||||||
print(' - Fetching Favicon')
|
|
||||||
CMD = 'curl https://www.google.com/s2/favicons?domain={domain}'.format(**link).split(' ')
|
|
||||||
fout = open('{}/favicon.ico'.format(out_dir), 'w')
|
|
||||||
try:
|
|
||||||
run([*CMD], stdout=fout, stderr=DEVNULL, cwd=out_dir, timeout=TIMEOUT) # favicon.ico
|
|
||||||
chmod_file('favicon.ico', cwd=out_dir)
|
|
||||||
except Exception as e:
|
|
||||||
print(' Run to see full output:', ' '.join(CMD))
|
|
||||||
print(' Failed: {} {}'.format(e.__class__.__name__, e))
|
|
||||||
fout.close()
|
|
||||||
else:
|
|
||||||
print(' √ Skipping favicon')
|
|
||||||
|
|
||||||
|
|
||||||
### ORCHESTRATION
|
|
||||||
|
|
||||||
def next_uniq_timestamp(used_timestamps, timestamp):
|
|
||||||
"""resolve duplicate timestamps by appending a decimal 1234, 1234 -> 1234.1, 1234.2"""
|
|
||||||
|
|
||||||
if timestamp not in used_timestamps:
|
|
||||||
return timestamp
|
|
||||||
|
|
||||||
if '.' in timestamp:
|
|
||||||
timestamp, nonce = timestamp.split('.')
|
|
||||||
nonce = int(nonce)
|
|
||||||
else:
|
|
||||||
nonce = 1
|
|
||||||
|
|
||||||
new_timestamp = '{}.{}'.format(timestamp, nonce)
|
|
||||||
|
|
||||||
while new_timestamp in used_timestamps:
|
|
||||||
nonce += 1
|
|
||||||
new_timestamp = '{}.{}'.format(timestamp, nonce)
|
|
||||||
|
|
||||||
return new_timestamp
|
|
||||||
|
|
||||||
def uniquefied_links(links):
|
|
||||||
"""uniqueify link timestamps by de-duping using url, returns links sorted most recent -> oldest
|
|
||||||
|
|
||||||
needed because firefox will produce exports where many links share the same timestamp, this func
|
|
||||||
ensures that all non-duplicate links have monotonically increasing timestamps
|
|
||||||
"""
|
|
||||||
|
|
||||||
links = list(reversed(sorted(links, key=lambda l: (l['timestamp'], l['url']))))
|
|
||||||
seen_timestamps = {}
|
|
||||||
|
|
||||||
for link in links:
|
|
||||||
t = link['timestamp']
|
|
||||||
if t in seen_timestamps:
|
|
||||||
if link['url'] == seen_timestamps[t]['url']:
|
|
||||||
# don't create new unique timestamp if link is the same
|
|
||||||
continue
|
|
||||||
else:
|
|
||||||
# resolve duplicate timstamp by appending a decimal
|
|
||||||
link['timestamp'] = next_uniq_timestamp(seen_timestamps, link['timestamp'])
|
|
||||||
seen_timestamps[link['timestamp']] = link
|
|
||||||
|
|
||||||
return links
|
|
||||||
|
|
||||||
def valid_links(links):
|
|
||||||
"""remove chrome://, about:// or other schemed links that cant be archived"""
|
|
||||||
return (link for link in links if link['url'].startswith('http') or link['url'].startswith('ftp'))
|
|
||||||
|
|
||||||
def calculate_archive_url(link):
|
|
||||||
"""calculate the path to the wgetted html file, since wget may
|
|
||||||
adjust some paths to be different than the base_url path.
|
|
||||||
|
|
||||||
See docs on wget --adjust-extension."""
|
|
||||||
|
|
||||||
split_url = link['url'].split('#', 1)
|
|
||||||
|
|
||||||
if re.search(".+\\.[Hh][Tt][Mm][Ll]?$", split_url[0], re.I | re.M):
|
|
||||||
# already ends in .html
|
|
||||||
return link['base_url']
|
|
||||||
else:
|
|
||||||
# .html needs to be appended
|
|
||||||
without_scheme = split_url[0].split('://', 1)[-1]
|
|
||||||
if without_scheme.endswith('/'):
|
|
||||||
return '#'.join([without_scheme + 'index.html', *split_url[1:]])
|
|
||||||
return '#'.join([without_scheme + '.html', *split_url[1:]])
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
def dump_index(links, service):
|
|
||||||
"""create index.html file for a given list of links and service"""
|
|
||||||
|
|
||||||
with open(INDEX_TEMPLATE, 'r') as f:
|
|
||||||
index_html = f.read()
|
|
||||||
|
|
||||||
# TODO: refactor this out into index_template.html
|
|
||||||
link_html = """\
|
|
||||||
<tr>
|
|
||||||
<td>{time}</td>
|
|
||||||
<td><a href="archive/{timestamp}/{archive_url}" style="font-size:1.4em;text-decoration:none;color:black;" title="{title}">
|
|
||||||
<img src="archive/{timestamp}/favicon.ico">
|
|
||||||
{title} <small style="background-color: #eee;border-radius:4px; float:right">{tags}</small>
|
|
||||||
</td>
|
|
||||||
<td style="text-align:center"><a href="archive/{timestamp}/" title="Files">📂</a></td>
|
|
||||||
<td style="text-align:center"><a href="{pdf_link}" title="PDF">📄</a></td>
|
|
||||||
<td style="text-align:center"><a href="{screenshot_link}" title="Screenshot">🖼</a></td>
|
|
||||||
<td style="text-align:center"><a href="https://web.archive.org/web/{base_url}" title="Archive.org">🏛</a></td>
|
|
||||||
<td>🔗 <img src="https://www.google.com/s2/favicons?domain={domain}" height="16px"> <a href="{url}">{url}</a></td>
|
|
||||||
</tr>"""
|
|
||||||
|
|
||||||
def get_template_vars(link):
|
|
||||||
# since we dont screenshot or PDF links that are images or PDFs, change those links to point to the wget'ed file
|
|
||||||
link_info = {**link}
|
|
||||||
|
|
||||||
# PDF and images are handled slightly differently
|
|
||||||
# wget, screenshot, & pdf urls all point to the same file
|
|
||||||
if link['type'] in ('PDF', 'image'):
|
|
||||||
link_info.update({
|
|
||||||
'archive_url': 'archive/{timestamp}/{base_url}'.format(**link),
|
|
||||||
'pdf_link': 'archive/{timestamp}/{base_url}'.format(**link),
|
|
||||||
'screenshot_link': 'archive/{timestamp}/{base_url}'.format(**link),
|
|
||||||
'title': '{title} ({type})'.format(**link),
|
|
||||||
})
|
|
||||||
else:
|
|
||||||
link_info.update({
|
|
||||||
'archive_url': calculate_archive_url(link),
|
|
||||||
'pdf_link': 'archive/{timestamp}/output.pdf'.format(**link),
|
|
||||||
'screenshot_link': 'archive/{timestamp}/screenshot.png'.format(**link)
|
|
||||||
})
|
|
||||||
return link_info
|
|
||||||
|
|
||||||
article_rows = '\n'.join(
|
|
||||||
link_html.format(**get_template_vars(link)) for link in links
|
|
||||||
)
|
|
||||||
|
|
||||||
template_vars = (datetime.now().strftime('%Y-%m-%d %H:%M'), article_rows)
|
|
||||||
|
|
||||||
with open(''.join((service, '/index.html')), 'w') as f:
|
|
||||||
f.write(index_html.format(*template_vars))
|
|
||||||
|
|
||||||
|
|
||||||
def dump_website(link, service, overwrite=False):
|
|
||||||
"""download the DOM, PDF, and a screenshot into a folder named after the link's timestamp"""
|
|
||||||
|
|
||||||
print('[+] [{timestamp} ({time})] "{title}": {base_url}'.format(**link))
|
|
||||||
|
|
||||||
out_dir = ''.join((service, '/archive/{timestamp}')).format(**link)
|
|
||||||
if not os.path.exists(out_dir):
|
|
||||||
os.makedirs(out_dir)
|
|
||||||
|
|
||||||
run(['chmod', ARCHIVE_PERMISSIONS, out_dir], timeout=5)
|
|
||||||
|
|
||||||
if link['type']:
|
|
||||||
print(' i Type: {}'.format(link['type']))
|
|
||||||
|
|
||||||
if not (link['url'].startswith('http') or link['url'].startswith('ftp')):
|
|
||||||
print(' X Skipping: invalid link.')
|
|
||||||
return
|
|
||||||
|
|
||||||
if FETCH_WGET:
|
|
||||||
fetch_wget(out_dir, link, overwrite=overwrite)
|
|
||||||
|
|
||||||
if FETCH_PDF:
|
|
||||||
fetch_pdf(out_dir, link, overwrite=overwrite)
|
|
||||||
|
|
||||||
if FETCH_SCREENSHOT:
|
|
||||||
fetch_screenshot(out_dir, link, overwrite=overwrite)
|
|
||||||
|
|
||||||
if SUBMIT_ARCHIVE_DOT_ORG:
|
|
||||||
archive_dot_org(out_dir, link, overwrite=overwrite)
|
|
||||||
|
|
||||||
if FETCH_FAVICON:
|
|
||||||
fetch_favicon(out_dir, link, overwrite=overwrite)
|
|
||||||
|
|
||||||
|
|
||||||
def create_archive(export_file, service=None, resume=None):
|
def create_archive(export_file, service=None, resume=None):
|
||||||
"""update or create index.html and download archive of all links"""
|
"""update or create index.html and download archive of all links"""
|
||||||
|
|
@ -441,28 +30,7 @@ def create_archive(export_file, service=None, resume=None):
|
||||||
export_file
|
export_file
|
||||||
))
|
))
|
||||||
|
|
||||||
# if specific service was passed via command line
|
links, service = parse_export(f, service=service)
|
||||||
if service == "pocket":
|
|
||||||
links = parse_pocket_export(f)
|
|
||||||
elif service == "pinboard":
|
|
||||||
links = parse_json_export(f)
|
|
||||||
elif service == "bookmarks":
|
|
||||||
links = parse_bookmarks_export(f)
|
|
||||||
else:
|
|
||||||
# otherwise try all parsers until one works
|
|
||||||
try:
|
|
||||||
links = list(parse_json_export(f))
|
|
||||||
service = 'pinboard'
|
|
||||||
except Exception:
|
|
||||||
links = list(parse_pocket_export(f))
|
|
||||||
if links:
|
|
||||||
service = 'pocket'
|
|
||||||
else:
|
|
||||||
links = list(parse_bookmarks_export(f))
|
|
||||||
service = 'bookmarks'
|
|
||||||
|
|
||||||
links = valid_links(links) # remove chrome://, about:, mailto: etc.
|
|
||||||
links = uniquefied_links(links) # fix duplicate timestamps, returns sorted list
|
|
||||||
|
|
||||||
if resume:
|
if resume:
|
||||||
try:
|
try:
|
||||||
|
|
@ -474,15 +42,15 @@ def create_archive(export_file, service=None, resume=None):
|
||||||
except TypeError:
|
except TypeError:
|
||||||
print('Resume value and all timestamp values must be valid numbers.')
|
print('Resume value and all timestamp values must be valid numbers.')
|
||||||
|
|
||||||
if not links:
|
if not links or not service:
|
||||||
print('[X] No links found in {}, is it a {} export file?'.format(export_file, service))
|
print('[X] No links found in {}, is it a {} export file?'.format(export_file, service))
|
||||||
raise SystemExit(1)
|
raise SystemExit(1)
|
||||||
|
|
||||||
if not os.path.exists(service):
|
if not os.path.exists(service):
|
||||||
os.makedirs(service)
|
os.makedirs(service)
|
||||||
|
|
||||||
if not os.path.exists(''.join((service, '/archive'))):
|
if not os.path.exists(os.path.join(service, 'archive')):
|
||||||
os.makedirs(''.join((service, '/archive')))
|
os.makedirs(os.path.join(service, 'archive'))
|
||||||
|
|
||||||
dump_index(links, service)
|
dump_index(links, service)
|
||||||
|
|
||||||
|
|
@ -498,15 +66,14 @@ def create_archive(export_file, service=None, resume=None):
|
||||||
for link in links:
|
for link in links:
|
||||||
dump_website(link, service)
|
dump_website(link, service)
|
||||||
|
|
||||||
print('[√] [{}] Archive update complete.'.format(datetime.now()))
|
print('[√] [{}] Archive update complete.'.format(datetime.now().strftime('%Y-%m-%d %H:%M:%S')))
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
if __name__ == '__main__':
|
if __name__ == '__main__':
|
||||||
argc = len(sys.argv)
|
argc = len(sys.argv)
|
||||||
|
|
||||||
if argc < 2 or sys.argv[1] in ('-h', '--help', 'help'):
|
if argc < 2 or sys.argv[1] in ('-h', '--help', 'help'):
|
||||||
print(__DESCRIPTION__)
|
print(DESCRIPTION)
|
||||||
print("Documentation: {}".format(__DOCUMENTATION__))
|
print("Documentation: {}".format(__DOCUMENTATION__))
|
||||||
print("")
|
print("")
|
||||||
print("Usage:")
|
print("Usage:")
|
||||||
|
|
|
||||||
59
config.py
Normal file
59
config.py
Normal file
|
|
@ -0,0 +1,59 @@
|
||||||
|
import os
|
||||||
|
from subprocess import run, PIPE
|
||||||
|
|
||||||
|
# os.getenv('VARIABLE', 'DEFAULT') gets the value of environment
|
||||||
|
# variable "VARIABLE" and if it is not set, sets it to 'DEFAULT'
|
||||||
|
|
||||||
|
# for boolean values, check to see if the string is 'true', and
|
||||||
|
# if so, the python variable will be True
|
||||||
|
|
||||||
|
FETCH_WGET = os.getenv('FETCH_WGET', 'True' ).lower() == 'true'
|
||||||
|
FETCH_WGET_REQUISITES = os.getenv('FETCH_WGET_REQUISITES', 'True' ).lower() == 'true'
|
||||||
|
FETCH_AUDIO = os.getenv('FETCH_AUDIO', 'True' ).lower() == 'true'
|
||||||
|
FETCH_VIDEO = os.getenv('FETCH_VIDEO', 'True' ).lower() == 'true'
|
||||||
|
FETCH_PDF = os.getenv('FETCH_PDF', 'True' ).lower() == 'true'
|
||||||
|
FETCH_SCREENSHOT = os.getenv('FETCH_SCREENSHOT', 'True' ).lower() == 'true'
|
||||||
|
FETCH_FAVICON = os.getenv('FETCH_FAVICON', 'True' ).lower() == 'true'
|
||||||
|
SUBMIT_ARCHIVE_DOT_ORG = os.getenv('SUBMIT_ARCHIVE_DOT_ORG', 'True' ).lower() == 'true'
|
||||||
|
RESOLUTION = os.getenv('RESOLUTION', '1440,900' )
|
||||||
|
ARCHIVE_PERMISSIONS = os.getenv('ARCHIVE_PERMISSIONS', '755' )
|
||||||
|
CHROME_BINARY = os.getenv('CHROME_BINARY', 'chromium-browser' ) # change to google-chrome browser if using google-chrome
|
||||||
|
WGET_BINARY = os.getenv('WGET_BINARY', 'wget' )
|
||||||
|
TIMEOUT = int(os.getenv('TIMEOUT', '60'))
|
||||||
|
INDEX_TEMPLATE = os.getenv('INDEX_TEMPLATE', 'templates/index.html')
|
||||||
|
INDEX_ROW_TEMPLATE = os.getenv('INDEX_ROW_TEMPLATE', 'templates/index_row.html')
|
||||||
|
|
||||||
|
|
||||||
|
def check_dependencies():
|
||||||
|
print('[*] Checking Dependencies:')
|
||||||
|
if FETCH_PDF or FETCH_SCREENSHOT:
|
||||||
|
if run(['which', CHROME_BINARY]).returncode:
|
||||||
|
print('[X] Missing dependency: {}'.format(CHROME_BINARY))
|
||||||
|
print(' See https://github.com/pirate/bookmark-archiver for help.')
|
||||||
|
raise SystemExit(1)
|
||||||
|
|
||||||
|
# parse chrome --version e.g. Google Chrome 61.0.3114.0 canary / Chromium 59.0.3029.110 built on Ubuntu, running on Ubuntu 16.04
|
||||||
|
result = run([CHROME_BINARY, '--version'], stdout=PIPE)
|
||||||
|
version = result.stdout.decode('utf-8').replace('Google Chrome ', '').replace('Chromium ', '').split(' ', 1)[0].split('.', 1)[0] # TODO: regex might be better
|
||||||
|
if int(version) < 59:
|
||||||
|
print('[X] Chrome version must be 59 or greater for headless PDF and screenshot saving')
|
||||||
|
print(' See https://github.com/pirate/bookmark-archiver for help.')
|
||||||
|
raise SystemExit(1)
|
||||||
|
|
||||||
|
if FETCH_WGET:
|
||||||
|
if run(['which', 'wget']).returncode:
|
||||||
|
print('[X] Missing dependency: wget')
|
||||||
|
print(' See https://github.com/pirate/bookmark-archiver for help.')
|
||||||
|
raise SystemExit(1)
|
||||||
|
|
||||||
|
if FETCH_FAVICON or SUBMIT_ARCHIVE_DOT_ORG:
|
||||||
|
if run(['which', 'curl']).returncode:
|
||||||
|
print('[X] Missing dependency: curl')
|
||||||
|
print(' See https://github.com/pirate/bookmark-archiver for help.')
|
||||||
|
raise SystemExit(1)
|
||||||
|
|
||||||
|
if FETCH_AUDIO or FETCH_VIDEO:
|
||||||
|
if run(['which', 'youtube-dl']).returncode:
|
||||||
|
print('[X] Missing dependency: youtube-dl')
|
||||||
|
print(' See https://github.com/pirate/bookmark-archiver for help.')
|
||||||
|
raise SystemExit(1)
|
||||||
258
fetch.py
Normal file
258
fetch.py
Normal file
|
|
@ -0,0 +1,258 @@
|
||||||
|
import os
|
||||||
|
import json
|
||||||
|
|
||||||
|
from datetime import datetime
|
||||||
|
from subprocess import run, PIPE, DEVNULL
|
||||||
|
|
||||||
|
from parse import derived_link_info
|
||||||
|
from config import (
|
||||||
|
ARCHIVE_PERMISSIONS,
|
||||||
|
FETCH_WGET,
|
||||||
|
FETCH_WGET_REQUISITES,
|
||||||
|
FETCH_PDF,
|
||||||
|
FETCH_SCREENSHOT,
|
||||||
|
RESOLUTION,
|
||||||
|
SUBMIT_ARCHIVE_DOT_ORG,
|
||||||
|
FETCH_AUDIO,
|
||||||
|
FETCH_VIDEO,
|
||||||
|
FETCH_FAVICON,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def chmod_file(path, cwd='.', permissions='755', timeout=30):
|
||||||
|
if not os.path.exists(os.path.join(cwd, path)):
|
||||||
|
raise Exception('Failed to chmod: {} does not exist (did the previous step fail?)'.format(path))
|
||||||
|
|
||||||
|
chmod_result = run(['chmod', '-R', permissions, path], cwd=cwd, stdout=DEVNULL, stderr=PIPE, timeout=timeout)
|
||||||
|
if chmod_result.returncode == 1:
|
||||||
|
print(' ', chmod_result.stderr.decode())
|
||||||
|
raise Exception('Failed to chmod {}/{}'.format(cwd, path))
|
||||||
|
|
||||||
|
def fetch_wget(out_dir, link, overwrite=False, requisites=True, timeout=60):
|
||||||
|
"""download full site using wget"""
|
||||||
|
|
||||||
|
domain = link['base_url'].split('/', 1)[0]
|
||||||
|
if not os.path.exists('{}/{}'.format(out_dir, domain)) or overwrite:
|
||||||
|
print(' - Downloading Full Site')
|
||||||
|
CMD = [
|
||||||
|
*'wget --timestamping --adjust-extension --no-parent'.split(' '), # Docs: https://www.gnu.org/software/wget/manual/wget.html
|
||||||
|
*(('--page-requisites', '--convert-links') if requisites else ()),
|
||||||
|
link['url'],
|
||||||
|
]
|
||||||
|
try:
|
||||||
|
result = run(CMD, stdout=PIPE, stderr=PIPE, cwd=out_dir, timeout=timeout) # dom.html
|
||||||
|
if result.returncode > 0:
|
||||||
|
print(' ', result.stderr.decode().split('\n')[-1])
|
||||||
|
raise Exception('Failed to wget download')
|
||||||
|
chmod_file(domain, cwd=out_dir)
|
||||||
|
except Exception as e:
|
||||||
|
print(' Run to see full output:', 'cd {}; {}'.format(out_dir, ' '.join(CMD)))
|
||||||
|
print(' Failed: {} {}'.format(e.__class__.__name__, e))
|
||||||
|
else:
|
||||||
|
print(' √ Skipping site download')
|
||||||
|
|
||||||
|
def fetch_pdf(out_dir, link, overwrite=False, timeout=60, chrome_binary='chromium-browser'):
|
||||||
|
"""print PDF of site to file using chrome --headless"""
|
||||||
|
|
||||||
|
if (not os.path.exists('{}/output.pdf'.format(out_dir)) or overwrite) and link['type'] not in ('PDF', 'image'):
|
||||||
|
print(' - Printing PDF')
|
||||||
|
CMD = [
|
||||||
|
chrome_binary,
|
||||||
|
*'--headless --disable-gpu --print-to-pdf'.split(' '),
|
||||||
|
link['url']
|
||||||
|
]
|
||||||
|
try:
|
||||||
|
result = run(CMD, stdout=DEVNULL, stderr=PIPE, cwd=out_dir, timeout=timeout) # output.pdf
|
||||||
|
if result.returncode:
|
||||||
|
print(' ', result.stderr.decode())
|
||||||
|
raise Exception('Failed to print PDF')
|
||||||
|
chmod_file('output.pdf', cwd=out_dir)
|
||||||
|
except Exception as e:
|
||||||
|
print(' Run to see full output:', 'cd {}; {}'.format(out_dir, ' '.join(CMD)))
|
||||||
|
print(' Failed: {} {}'.format(e.__class__.__name__, e))
|
||||||
|
else:
|
||||||
|
print(' √ Skipping PDF print')
|
||||||
|
|
||||||
|
def fetch_screenshot(out_dir, link, overwrite=False, timeout=60, chrome_binary='chromium-browser', resolution='1440,900'):
|
||||||
|
"""take screenshot of site using chrome --headless"""
|
||||||
|
|
||||||
|
if (not os.path.exists('{}/screenshot.png'.format(out_dir)) or overwrite) and link['type'] not in ('PDF', 'image'):
|
||||||
|
print(' - Snapping Screenshot')
|
||||||
|
CMD = [
|
||||||
|
chrome_binary,
|
||||||
|
*'--headless --disable-gpu --screenshot'.split(' '),
|
||||||
|
'--window-size={}'.format(resolution),
|
||||||
|
link['url']
|
||||||
|
]
|
||||||
|
try:
|
||||||
|
result = run(CMD, stdout=DEVNULL, stderr=DEVNULL, cwd=out_dir, timeout=timeout) # sreenshot.png
|
||||||
|
if result.returncode:
|
||||||
|
print(' ', result.stderr.decode())
|
||||||
|
raise Exception('Failed to take screenshot')
|
||||||
|
chmod_file('screenshot.png', cwd=out_dir)
|
||||||
|
except Exception as e:
|
||||||
|
print(' Run to see full output:', 'cd {}; {}'.format(out_dir, ' '.join(CMD)))
|
||||||
|
print(' Failed: {} {}'.format(e.__class__.__name__, e))
|
||||||
|
else:
|
||||||
|
print(' √ Skipping screenshot')
|
||||||
|
|
||||||
|
def archive_dot_org(out_dir, link, overwrite=False, timeout=60):
|
||||||
|
"""submit site to archive.org for archiving via their service, save returned archive url"""
|
||||||
|
if (not os.path.exists('{}/archive.org.txt'.format(out_dir)) or overwrite):
|
||||||
|
print(' - Submitting to archive.org')
|
||||||
|
submit_url = 'https://web.archive.org/save/{}'.format(link['url'].split('?', 1)[0])
|
||||||
|
|
||||||
|
success = False
|
||||||
|
CMD = ['curl', '-I', submit_url]
|
||||||
|
try:
|
||||||
|
result = run(CMD, stdout=PIPE, stderr=DEVNULL, cwd=out_dir, timeout=timeout) # archive.org
|
||||||
|
headers = result.stdout.splitlines()
|
||||||
|
content_location = [h for h in headers if b'Content-Location: ' in h]
|
||||||
|
if content_location:
|
||||||
|
archive_path = content_location[0].split(b'Content-Location: ', 1)[-1].decode('utf-8')
|
||||||
|
saved_url = 'https://web.archive.org{}'.format(archive_path)
|
||||||
|
success = True
|
||||||
|
else:
|
||||||
|
raise Exception('Failed to find "Content-Location" URL header in Archive.org response.')
|
||||||
|
except Exception as e:
|
||||||
|
print(' Visit url to see output:', ' '.join(CMD))
|
||||||
|
print(' Failed: {} {}'.format(e.__class__.__name__, e))
|
||||||
|
|
||||||
|
if success:
|
||||||
|
with open('{}/archive.org.txt'.format(out_dir), 'w') as f:
|
||||||
|
f.write(saved_url)
|
||||||
|
chmod_file('archive.org.txt', cwd=out_dir)
|
||||||
|
|
||||||
|
else:
|
||||||
|
print(' √ Skipping archive.org')
|
||||||
|
|
||||||
|
def fetch_favicon(out_dir, link, overwrite=False, timeout=60):
|
||||||
|
"""download site favicon from google's favicon api"""
|
||||||
|
|
||||||
|
if not os.path.exists('{}/favicon.ico'.format(out_dir)) or overwrite:
|
||||||
|
print(' - Fetching Favicon')
|
||||||
|
CMD = 'curl https://www.google.com/s2/favicons?domain={domain}'.format(**link).split(' ')
|
||||||
|
fout = open('{}/favicon.ico'.format(out_dir), 'w')
|
||||||
|
try:
|
||||||
|
run([*CMD], stdout=fout, stderr=DEVNULL, cwd=out_dir, timeout=timeout) # favicon.ico
|
||||||
|
chmod_file('favicon.ico', cwd=out_dir)
|
||||||
|
except Exception as e:
|
||||||
|
print(' Run to see full output:', ' '.join(CMD))
|
||||||
|
print(' Failed: {} {}'.format(e.__class__.__name__, e))
|
||||||
|
fout.close()
|
||||||
|
else:
|
||||||
|
print(' √ Skipping favicon')
|
||||||
|
|
||||||
|
def fetch_audio(out_dir, link, overwrite=False, timeout=60):
|
||||||
|
"""Download audio rip using youtube-dl"""
|
||||||
|
|
||||||
|
if link['type'] not in ('soundcloud',):
|
||||||
|
return
|
||||||
|
|
||||||
|
if (not os.path.exists('{}/audio'.format(out_dir)) or overwrite):
|
||||||
|
print(' - Downloading audio')
|
||||||
|
CMD = [
|
||||||
|
"youtube-dl -x --audio-format mp3 --audio-quality 0 -o '%(title)s.%(ext)s'",
|
||||||
|
link['url'],
|
||||||
|
]
|
||||||
|
try:
|
||||||
|
result = run(CMD, stdout=DEVNULL, stderr=DEVNULL, cwd=out_dir, timeout=timeout) # sreenshot.png
|
||||||
|
if result.returncode:
|
||||||
|
print(' ', result.stderr.decode())
|
||||||
|
raise Exception('Failed to download audio')
|
||||||
|
chmod_file('audio', cwd=out_dir)
|
||||||
|
except Exception as e:
|
||||||
|
print(' Run to see full output:', 'cd {}; {}'.format(out_dir, ' '.join(CMD)))
|
||||||
|
print(' Failed: {} {}'.format(e.__class__.__name__, e))
|
||||||
|
else:
|
||||||
|
print(' √ Skipping audio download')
|
||||||
|
|
||||||
|
def fetch_video(out_dir, link, overwrite=False, timeout=60):
|
||||||
|
"""Download video rip using youtube-dl"""
|
||||||
|
|
||||||
|
if link['type'] not in ('youtube', 'youku', 'vimeo'):
|
||||||
|
return
|
||||||
|
|
||||||
|
|
||||||
|
if (not os.path.exists('{}/video'.format(out_dir)) or overwrite):
|
||||||
|
print(' - Downloading video')
|
||||||
|
CMD = [
|
||||||
|
"youtube-dl -x --audio-format mp3 --audio-quality 0 -o '%(title)s.%(ext)s'",
|
||||||
|
link['url'],
|
||||||
|
]
|
||||||
|
try:
|
||||||
|
result = run(CMD, stdout=DEVNULL, stderr=DEVNULL, cwd=out_dir, timeout=timeout) # sreenshot.png
|
||||||
|
if result.returncode:
|
||||||
|
print(' ', result.stderr.decode())
|
||||||
|
raise Exception('Failed to download video')
|
||||||
|
chmod_file('video', cwd=out_dir)
|
||||||
|
except Exception as e:
|
||||||
|
print(' Run to see full output:', 'cd {}; {}'.format(out_dir, ' '.join(CMD)))
|
||||||
|
print(' Failed: {} {}'.format(e.__class__.__name__, e))
|
||||||
|
else:
|
||||||
|
print(' √ Skipping video download')
|
||||||
|
|
||||||
|
def dump_link_info(out_dir, link, update=True):
|
||||||
|
"""write a json file with some info about the link"""
|
||||||
|
|
||||||
|
info_file_path = os.path.join(out_dir, 'link.json')
|
||||||
|
|
||||||
|
if (not os.path.exists(info_file_path) or update):
|
||||||
|
print(' - Creating link info file')
|
||||||
|
try:
|
||||||
|
link_json = derived_link_info(link)
|
||||||
|
link_json['archived_timstamp'] = str(datetime.now().timestamp()).split('.')[0]
|
||||||
|
|
||||||
|
with open(info_file_path, 'w') as link_file:
|
||||||
|
link_file.write(json.dumps(
|
||||||
|
link_json,
|
||||||
|
indent=4,
|
||||||
|
default=str) + '\n')
|
||||||
|
|
||||||
|
chmod_file('link.json', cwd=out_dir)
|
||||||
|
except Exception as e:
|
||||||
|
print(' Failed: {} {}'.format(e.__class__.__name__, e))
|
||||||
|
else:
|
||||||
|
print(' √ Skipping link info file')
|
||||||
|
|
||||||
|
|
||||||
|
def dump_website(link, service, overwrite=False, permissions=ARCHIVE_PERMISSIONS):
|
||||||
|
"""download the DOM, PDF, and a screenshot into a folder named after the link's timestamp"""
|
||||||
|
|
||||||
|
print('[+] [{timestamp} ({time})] "{title}": {base_url}'.format(**link))
|
||||||
|
|
||||||
|
out_dir = os.path.join(service, 'archive', link['timestamp'])
|
||||||
|
if not os.path.exists(out_dir):
|
||||||
|
os.makedirs(out_dir)
|
||||||
|
|
||||||
|
run(['chmod', permissions, out_dir], timeout=5)
|
||||||
|
|
||||||
|
if link['type']:
|
||||||
|
print(' i Type: {}'.format(link['type']))
|
||||||
|
|
||||||
|
if not (link['url'].startswith('http') or link['url'].startswith('ftp')):
|
||||||
|
print(' X Skipping: invalid link.')
|
||||||
|
return
|
||||||
|
|
||||||
|
if FETCH_WGET:
|
||||||
|
fetch_wget(out_dir, link, overwrite=overwrite, requisites=FETCH_WGET_REQUISITES)
|
||||||
|
|
||||||
|
if FETCH_PDF:
|
||||||
|
fetch_pdf(out_dir, link, overwrite=overwrite)
|
||||||
|
|
||||||
|
if FETCH_SCREENSHOT:
|
||||||
|
fetch_screenshot(out_dir, link, overwrite=overwrite, resolution=RESOLUTION)
|
||||||
|
|
||||||
|
if SUBMIT_ARCHIVE_DOT_ORG:
|
||||||
|
archive_dot_org(out_dir, link, overwrite=overwrite)
|
||||||
|
|
||||||
|
if FETCH_AUDIO:
|
||||||
|
fetch_audio(out_dir, link, overwrite=overwrite)
|
||||||
|
|
||||||
|
if FETCH_VIDEO:
|
||||||
|
fetch_video(out_dir, link, overwrite=overwrite)
|
||||||
|
|
||||||
|
if FETCH_FAVICON:
|
||||||
|
fetch_favicon(out_dir, link, overwrite=overwrite)
|
||||||
|
|
||||||
|
dump_link_info(out_dir, link)
|
||||||
25
index.py
Normal file
25
index.py
Normal file
|
|
@ -0,0 +1,25 @@
|
||||||
|
import os
|
||||||
|
from datetime import datetime
|
||||||
|
|
||||||
|
from config import INDEX_TEMPLATE, INDEX_ROW_TEMPLATE
|
||||||
|
from parse import derived_link_info
|
||||||
|
|
||||||
|
|
||||||
|
def dump_index(links, service):
|
||||||
|
"""create index.html file for a given list of links and service"""
|
||||||
|
|
||||||
|
with open(INDEX_TEMPLATE, 'r') as f:
|
||||||
|
index_html = f.read()
|
||||||
|
|
||||||
|
# TODO: refactor this out into index_template.html
|
||||||
|
with open(INDEX_ROW_TEMPLATE, 'r') as f:
|
||||||
|
link_html = f.read()
|
||||||
|
|
||||||
|
article_rows = '\n'.join(
|
||||||
|
link_html.format(**derived_link_info(link)) for link in links
|
||||||
|
)
|
||||||
|
|
||||||
|
template_vars = (datetime.now().strftime('%Y-%m-%d %H:%M'), article_rows)
|
||||||
|
|
||||||
|
with open(os.path.join(service, 'index.html'), 'w') as f:
|
||||||
|
f.write(index_html.format(*template_vars))
|
||||||
210
parse.py
Normal file
210
parse.py
Normal file
|
|
@ -0,0 +1,210 @@
|
||||||
|
import re
|
||||||
|
import time
|
||||||
|
import json
|
||||||
|
|
||||||
|
from datetime import datetime
|
||||||
|
|
||||||
|
|
||||||
|
def parse_export(file, service=None):
|
||||||
|
"""parse a list of links dictionaries from a bookmark export file"""
|
||||||
|
|
||||||
|
# if specific service was passed via command line
|
||||||
|
if service == "pocket":
|
||||||
|
links = parse_pocket_export(file)
|
||||||
|
elif service == "pinboard":
|
||||||
|
links = parse_json_export(file)
|
||||||
|
elif service == "bookmarks":
|
||||||
|
links = parse_bookmarks_export(file)
|
||||||
|
else:
|
||||||
|
# otherwise try all parsers until one works
|
||||||
|
try:
|
||||||
|
links = list(parse_json_export(file))
|
||||||
|
service = 'pinboard'
|
||||||
|
except Exception:
|
||||||
|
links = list(parse_pocket_export(file))
|
||||||
|
if links:
|
||||||
|
service = 'pocket'
|
||||||
|
else:
|
||||||
|
links = list(parse_bookmarks_export(file))
|
||||||
|
service = 'bookmarks'
|
||||||
|
|
||||||
|
links = valid_links(links) # remove chrome://, about:, mailto: etc.
|
||||||
|
links = uniquefied_links(links) # fix duplicate timestamps, returns sorted list
|
||||||
|
return links, service
|
||||||
|
|
||||||
|
|
||||||
|
def get_link_type(link):
|
||||||
|
"""Certain types of links need to be handled specially, this figures out when that's the case"""
|
||||||
|
|
||||||
|
if link['base_url'].endswith('.pdf'):
|
||||||
|
return 'PDF'
|
||||||
|
elif link['base_url'].rsplit('.', 1) in ('pdf', 'png', 'jpg', 'jpeg', 'svg', 'bmp', 'gif', 'tiff', 'webp'):
|
||||||
|
return 'image'
|
||||||
|
elif 'wikipedia.org' in link['domain']:
|
||||||
|
return 'wiki'
|
||||||
|
elif 'youtube.com' in link['domain']:
|
||||||
|
return 'youtube'
|
||||||
|
elif 'soundcloud.com' in link['domain']:
|
||||||
|
return 'soundcloud'
|
||||||
|
elif 'youku.com' in link['domain']:
|
||||||
|
return 'youku'
|
||||||
|
elif 'vimeo.com' in link['domain']:
|
||||||
|
return 'vimeo'
|
||||||
|
return None
|
||||||
|
|
||||||
|
def parse_pocket_export(html_file):
|
||||||
|
"""Parse Pocket-format bookmarks export files (produced by getpocket.com/export/)"""
|
||||||
|
|
||||||
|
html_file.seek(0)
|
||||||
|
pattern = re.compile("^\\s*<li><a href=\"(.+)\" time_added=\"(\\d+)\" tags=\"(.*)\">(.+)</a></li>", re.UNICODE) # see sample input in ./example_ril_export.html
|
||||||
|
for line in html_file:
|
||||||
|
match = pattern.search(line)
|
||||||
|
if match:
|
||||||
|
fixed_url = match.group(1).replace('http://www.readability.com/read?url=', '') # remove old readability prefixes to get original url
|
||||||
|
without_scheme = fixed_url.replace('http://', '').replace('https://', '')
|
||||||
|
info = {
|
||||||
|
'url': fixed_url,
|
||||||
|
'domain': without_scheme.split('/')[0], # without pathname
|
||||||
|
'base_url': without_scheme.split('?')[0], # without query args
|
||||||
|
'time': datetime.fromtimestamp(int(match.group(2))).strftime('%Y-%m-%d %H:%M'),
|
||||||
|
'timestamp': match.group(2),
|
||||||
|
'tags': match.group(3),
|
||||||
|
'title': match.group(4).replace(' — Readability', '').replace('http://www.readability.com/read?url=', '') or without_scheme,
|
||||||
|
}
|
||||||
|
info['type'] = get_link_type(info)
|
||||||
|
yield info
|
||||||
|
|
||||||
|
def parse_json_export(json_file):
|
||||||
|
"""Parse JSON-format bookmarks export files (produced by pinboard.in/export/)"""
|
||||||
|
|
||||||
|
json_file.seek(0)
|
||||||
|
json_content = json.load(json_file)
|
||||||
|
for line in json_content:
|
||||||
|
if line:
|
||||||
|
erg = line
|
||||||
|
info = {
|
||||||
|
'url': erg['href'],
|
||||||
|
'domain': erg['href'].replace('http://', '').replace('https://', '').split('/')[0],
|
||||||
|
'base_url': erg['href'].replace('https://', '').replace('http://', '').split('?')[0],
|
||||||
|
'time': datetime.fromtimestamp(int(time.mktime(time.strptime(erg['time'].split(',')[0], '%Y-%m-%dT%H:%M:%SZ')))),
|
||||||
|
'timestamp': str(int(time.mktime(time.strptime(erg['time'].split(',')[0], '%Y-%m-%dT%H:%M:%SZ')))),
|
||||||
|
'tags': erg['tags'],
|
||||||
|
'title': erg['description'].replace(' — Readability', ''),
|
||||||
|
}
|
||||||
|
info['type'] = get_link_type(info)
|
||||||
|
yield info
|
||||||
|
|
||||||
|
def parse_bookmarks_export(html_file):
|
||||||
|
"""Parse netscape-format bookmarks export files (produced by all browsers)"""
|
||||||
|
|
||||||
|
html_file.seek(0)
|
||||||
|
pattern = re.compile("<a href=\"(.+?)\" add_date=\"(\\d+)\"[^>]*>(.+)</a>", re.UNICODE | re.IGNORECASE)
|
||||||
|
for line in html_file:
|
||||||
|
match = pattern.search(line)
|
||||||
|
if match:
|
||||||
|
url = match.group(1)
|
||||||
|
secs = match.group(2)
|
||||||
|
dt = datetime.fromtimestamp(int(secs))
|
||||||
|
|
||||||
|
info = {
|
||||||
|
'url': url,
|
||||||
|
'domain': url.replace('http://', '').replace('https://', '').split('/')[0],
|
||||||
|
'base_url': url.replace('https://', '').replace('http://', '').split('?')[0],
|
||||||
|
'time': dt,
|
||||||
|
'timestamp': secs,
|
||||||
|
'tags': "",
|
||||||
|
'title': match.group(3),
|
||||||
|
}
|
||||||
|
|
||||||
|
info['type'] = get_link_type(info)
|
||||||
|
yield info
|
||||||
|
|
||||||
|
|
||||||
|
def next_uniq_timestamp(used_timestamps, timestamp):
|
||||||
|
"""resolve duplicate timestamps by appending a decimal 1234, 1234 -> 1234.1, 1234.2"""
|
||||||
|
|
||||||
|
if timestamp not in used_timestamps:
|
||||||
|
return timestamp
|
||||||
|
|
||||||
|
if '.' in timestamp:
|
||||||
|
timestamp, nonce = timestamp.split('.')
|
||||||
|
nonce = int(nonce)
|
||||||
|
else:
|
||||||
|
nonce = 1
|
||||||
|
|
||||||
|
new_timestamp = '{}.{}'.format(timestamp, nonce)
|
||||||
|
|
||||||
|
while new_timestamp in used_timestamps:
|
||||||
|
nonce += 1
|
||||||
|
new_timestamp = '{}.{}'.format(timestamp, nonce)
|
||||||
|
|
||||||
|
return new_timestamp
|
||||||
|
|
||||||
|
def uniquefied_links(links):
|
||||||
|
"""uniqueify link timestamps by de-duping using url, returns links sorted most recent -> oldest
|
||||||
|
|
||||||
|
needed because firefox will produce exports where many links share the same timestamp, this func
|
||||||
|
ensures that all non-duplicate links have monotonically increasing timestamps
|
||||||
|
"""
|
||||||
|
|
||||||
|
links = list(reversed(sorted(links, key=lambda l: (l['timestamp'], l['url']))))
|
||||||
|
seen_timestamps = {}
|
||||||
|
|
||||||
|
for link in links:
|
||||||
|
t = link['timestamp']
|
||||||
|
if t in seen_timestamps:
|
||||||
|
if link['url'] == seen_timestamps[t]['url']:
|
||||||
|
# don't create new unique timestamp if link is the same
|
||||||
|
continue
|
||||||
|
else:
|
||||||
|
# resolve duplicate timstamp by appending a decimal
|
||||||
|
link['timestamp'] = next_uniq_timestamp(seen_timestamps, link['timestamp'])
|
||||||
|
seen_timestamps[link['timestamp']] = link
|
||||||
|
|
||||||
|
return links
|
||||||
|
|
||||||
|
def valid_links(links):
|
||||||
|
"""remove chrome://, about:// or other schemed links that cant be archived"""
|
||||||
|
return (link for link in links if link['url'].startswith('http') or link['url'].startswith('ftp'))
|
||||||
|
|
||||||
|
|
||||||
|
def calculate_archive_url(link):
|
||||||
|
"""calculate the path to the wgetted html file, since wget may
|
||||||
|
adjust some paths to be different than the base_url path.
|
||||||
|
|
||||||
|
See docs on wget --adjust-extension."""
|
||||||
|
|
||||||
|
split_url = link['url'].split('#', 1)
|
||||||
|
|
||||||
|
if re.search(".+\\.[Hh][Tt][Mm][Ll]?$", split_url[0], re.I | re.M):
|
||||||
|
# already ends in .html
|
||||||
|
return link['base_url']
|
||||||
|
else:
|
||||||
|
# .html needs to be appended
|
||||||
|
without_scheme = split_url[0].split('://', 1)[-1]
|
||||||
|
if without_scheme.endswith('/'):
|
||||||
|
return '#'.join([without_scheme + 'index.html', *split_url[1:]])
|
||||||
|
return '#'.join([without_scheme + '.html', *split_url[1:]])
|
||||||
|
|
||||||
|
|
||||||
|
def derived_link_info(link):
|
||||||
|
"""extend link info with the archive urls and other derived data"""
|
||||||
|
|
||||||
|
link_info = {**link}
|
||||||
|
|
||||||
|
# PDF and images are handled slightly differently
|
||||||
|
# wget, screenshot, & pdf urls all point to the same file
|
||||||
|
if link['type'] in ('PDF', 'image'):
|
||||||
|
link_info.update({
|
||||||
|
'archive_url': 'archive/{timestamp}/{base_url}'.format(**link),
|
||||||
|
'pdf_link': 'archive/{timestamp}/{base_url}'.format(**link),
|
||||||
|
'screenshot_link': 'archive/{timestamp}/{base_url}'.format(**link),
|
||||||
|
'title': '{title} ({type})'.format(**link),
|
||||||
|
})
|
||||||
|
else:
|
||||||
|
link_info.update({
|
||||||
|
'archive_url': calculate_archive_url(link),
|
||||||
|
'pdf_link': 'archive/{timestamp}/output.pdf'.format(**link),
|
||||||
|
'screenshot_link': 'archive/{timestamp}/screenshot.png'.format(**link)
|
||||||
|
})
|
||||||
|
return link_info
|
||||||
12
templates/index_row.html
Normal file
12
templates/index_row.html
Normal file
|
|
@ -0,0 +1,12 @@
|
||||||
|
<tr>
|
||||||
|
<td>{time}</td>
|
||||||
|
<td><a href="archive/{timestamp}/{archive_url}" style="font-size:1.4em;text-decoration:none;color:black;" title="{title}">
|
||||||
|
<img src="archive/{timestamp}/favicon.ico">
|
||||||
|
{title} <small style="background-color: #eee;border-radius:4px; float:right">{tags}</small>
|
||||||
|
</td>
|
||||||
|
<td style="text-align:center"><a href="archive/{timestamp}/" title="Files">📂</a></td>
|
||||||
|
<td style="text-align:center"><a href="{pdf_link}" title="PDF">📄</a></td>
|
||||||
|
<td style="text-align:center"><a href="{screenshot_link}" title="Screenshot">🖼</a></td>
|
||||||
|
<td style="text-align:center"><a href="https://web.archive.org/web/{base_url}" title="Archive.org">🏛</a></td>
|
||||||
|
<td>🔗 <img src="https://www.google.com/s2/favicons?domain={domain}" height="16px"> <a href="{url}">{url}</a></td>
|
||||||
|
</tr
|
||||||
Loading…
Add table
Add a link
Reference in a new issue