117 lines
3.6 KiB
Python
117 lines
3.6 KiB
Python
__package__ = 'archivebox.extractors'
|
|
|
|
from pathlib import Path
|
|
|
|
from typing import Optional
|
|
import json
|
|
|
|
from ..index.schema import Link, ArchiveResult, ArchiveError
|
|
from ..system import run, chmod_file
|
|
from ..util import (
|
|
enforce_types,
|
|
is_static_file,
|
|
chrome_args,
|
|
)
|
|
from ..config import (
|
|
TIMEOUT,
|
|
SAVE_SINGLEFILE,
|
|
DEPENDENCIES,
|
|
SINGLEFILE_VERSION,
|
|
SINGLEFILE_ARGS,
|
|
CHROME_BINARY,
|
|
COOKIES_FILE,
|
|
)
|
|
from ..logging_util import TimedProgress
|
|
|
|
|
|
@enforce_types
|
|
def should_save_singlefile(link: Link, out_dir: Optional[Path]=None, overwrite: Optional[bool]=False) -> bool:
|
|
if is_static_file(link.url):
|
|
return False
|
|
|
|
out_dir = out_dir or Path(link.link_dir)
|
|
if not overwrite and (out_dir / 'singlefile.html').exists():
|
|
return False
|
|
|
|
return SAVE_SINGLEFILE
|
|
|
|
|
|
@enforce_types
|
|
def save_singlefile(link: Link, out_dir: Optional[Path]=None, timeout: int=TIMEOUT) -> ArchiveResult:
|
|
"""download full site using single-file"""
|
|
|
|
out_dir = out_dir or Path(link.link_dir)
|
|
output = "singlefile.html"
|
|
|
|
browser_args = chrome_args(CHROME_TIMEOUT=0)
|
|
|
|
# SingleFile CLI Docs: https://github.com/gildas-lormeau/SingleFile/tree/master/cli
|
|
browser_args = '--browser-args={}'.format(json.dumps(browser_args[1:]))
|
|
options = [
|
|
*SINGLEFILE_ARGS,
|
|
*(["--browser-cookies-file={}".format(COOKIES_FILE)] if COOKIES_FILE else []),
|
|
'--browser-executable-path={}'.format(CHROME_BINARY),
|
|
browser_args,
|
|
]
|
|
|
|
# Deduplicate options (single-file doesn't like when you use the same option two times)
|
|
#
|
|
# NOTE: Options names that come first clobber conflicting names that come later
|
|
# My logic is SINGLEFILE_ARGS is the option that affects the singlefile command with most
|
|
# specificity, therefore the user sets it with a lot intent, therefore it should take precedence
|
|
# kind of like the ergonomic principle of lexical scope in programming languages.
|
|
seen_option_names = []
|
|
def test_seen(argument):
|
|
option_name = argument.split("=")[0]
|
|
if option_name in seen_option_names:
|
|
return False
|
|
else:
|
|
seen_option_names.append(option_name)
|
|
return True
|
|
deduped_options = list(filter(test_seen, options))
|
|
|
|
cmd = [
|
|
DEPENDENCIES['SINGLEFILE_BINARY']['path'],
|
|
*deduped_options,
|
|
link.url,
|
|
output,
|
|
]
|
|
|
|
status = 'succeeded'
|
|
timer = TimedProgress(timeout, prefix=' ')
|
|
try:
|
|
result = run(cmd, cwd=str(out_dir), timeout=timeout)
|
|
|
|
# parse out number of files downloaded from last line of stderr:
|
|
# "Downloaded: 76 files, 4.0M in 1.6s (2.52 MB/s)"
|
|
output_tail = [
|
|
line.strip()
|
|
for line in (result.stdout + result.stderr).decode().rsplit('\n', 3)[-3:]
|
|
if line.strip()
|
|
]
|
|
hints = (
|
|
'Got single-file response code: {}.'.format(result.returncode),
|
|
*output_tail,
|
|
)
|
|
|
|
# Check for common failure cases
|
|
if (result.returncode > 0) or not (out_dir / output).is_file():
|
|
raise ArchiveError('SingleFile was not able to archive the page', hints)
|
|
chmod_file(output, cwd=str(out_dir))
|
|
except (Exception, OSError) as err:
|
|
status = 'failed'
|
|
# TODO: Make this prettier. This is necessary to run the command (escape JSON internal quotes).
|
|
cmd[2] = browser_args.replace('"', "\\\"")
|
|
output = err
|
|
finally:
|
|
timer.end()
|
|
|
|
return ArchiveResult(
|
|
cmd=cmd,
|
|
pwd=str(out_dir),
|
|
cmd_version=SINGLEFILE_VERSION,
|
|
output=output,
|
|
status=status,
|
|
**timer.stats,
|
|
)
|