Files
ArchiveBox/archivebox/plugins/papersdl/on_Crawl__00_validate_papersdl.py
2025-12-26 18:25:52 -08:00

130 lines
3.6 KiB
Python
Executable File

#!/usr/bin/env python3
"""
Validation hook for papers-dl.
Runs at crawl start to verify papers-dl binary is available.
Outputs JSONL for InstalledBinary and Machine config updates.
"""
import os
import sys
import json
import shutil
import hashlib
import subprocess
from pathlib import Path
def get_binary_version(abspath: str, version_flag: str = '--version') -> str | None:
"""Get version string from binary."""
try:
result = subprocess.run(
[abspath, version_flag],
capture_output=True,
text=True,
timeout=5,
)
if result.returncode == 0 and result.stdout:
first_line = result.stdout.strip().split('\n')[0]
return first_line[:64]
except Exception:
pass
return None
def get_binary_hash(abspath: str) -> str | None:
"""Get SHA256 hash of binary."""
try:
with open(abspath, 'rb') as f:
return hashlib.sha256(f.read()).hexdigest()
except Exception:
return None
def find_papersdl() -> dict | None:
"""Find papers-dl binary."""
try:
from abx_pkg import Binary, PipProvider, EnvProvider
class PapersdlBinary(Binary):
name: str = 'papers-dl'
binproviders_supported = [PipProvider(), EnvProvider()]
binary = PapersdlBinary()
loaded = binary.load()
if loaded and loaded.abspath:
return {
'name': 'papers-dl',
'abspath': str(loaded.abspath),
'version': str(loaded.version) if loaded.version else None,
'sha256': loaded.sha256 if hasattr(loaded, 'sha256') else None,
'binprovider': loaded.binprovider.name if loaded.binprovider else 'env',
}
except ImportError:
pass
except Exception:
pass
# Fallback to shutil.which
abspath = shutil.which('papers-dl') or os.environ.get('PAPERSDL_BINARY', '')
if abspath and Path(abspath).is_file():
return {
'name': 'papers-dl',
'abspath': abspath,
'version': get_binary_version(abspath),
'sha256': get_binary_hash(abspath),
'binprovider': 'env',
}
return None
def main():
# Check for papers-dl (required)
papersdl_result = find_papersdl()
missing_deps = []
# Emit results for papers-dl
if papersdl_result and papersdl_result.get('abspath'):
print(json.dumps({
'type': 'InstalledBinary',
'name': papersdl_result['name'],
'abspath': papersdl_result['abspath'],
'version': papersdl_result['version'],
'sha256': papersdl_result['sha256'],
'binprovider': papersdl_result['binprovider'],
}))
print(json.dumps({
'type': 'Machine',
'_method': 'update',
'key': 'config/PAPERSDL_BINARY',
'value': papersdl_result['abspath'],
}))
if papersdl_result['version']:
print(json.dumps({
'type': 'Machine',
'_method': 'update',
'key': 'config/PAPERSDL_VERSION',
'value': papersdl_result['version'],
}))
else:
print(json.dumps({
'type': 'Dependency',
'bin_name': 'papers-dl',
'bin_providers': 'pip,env',
}))
missing_deps.append('papers-dl')
if missing_deps:
print(f"Missing dependencies: {', '.join(missing_deps)}", file=sys.stderr)
sys.exit(1)
else:
sys.exit(0)
if __name__ == '__main__':
main()