mirror of
https://github.com/internetarchive/warcprox.git
synced 2025-01-18 13:22:09 +01:00
1c50235305
It is necessary to pass cookies to the CDX Server we use for deduplication. To do this, we add the optional CLI argument ``--cdxserver-dedup-cookies="cookie1=val1;cookie2=val2"`` and if it is available, its used in the `Cookie` HTTP header in CDX server requests.
439 lines
18 KiB
Python
439 lines
18 KiB
Python
'''
|
|
warcprox/dedup.py - identical payload digest deduplication using sqlite db
|
|
|
|
Copyright (C) 2013-2018 Internet Archive
|
|
|
|
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 2
|
|
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, write to the Free Software
|
|
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
|
|
USA.
|
|
'''
|
|
|
|
from __future__ import absolute_import
|
|
|
|
import logging
|
|
import os
|
|
import json
|
|
from hanzo import warctools
|
|
import warcprox
|
|
import warcprox.trough
|
|
import sqlite3
|
|
import doublethink
|
|
import datetime
|
|
import urllib3
|
|
from urllib3.exceptions import HTTPError
|
|
import collections
|
|
|
|
urllib3.disable_warnings()
|
|
|
|
class DedupLoader(warcprox.BaseStandardPostfetchProcessor):
|
|
def __init__(self, dedup_db, options=warcprox.Options()):
|
|
warcprox.BaseStandardPostfetchProcessor.__init__(self, options=options)
|
|
self.dedup_db = dedup_db
|
|
|
|
def _process_url(self, recorded_url):
|
|
decorate_with_dedup_info(
|
|
self.dedup_db, recorded_url, self.options.base32)
|
|
|
|
class DedupDb(object):
|
|
logger = logging.getLogger("warcprox.dedup.DedupDb")
|
|
|
|
def __init__(
|
|
self, file='./warcprox.sqlite', options=warcprox.Options()):
|
|
self.file = file
|
|
self.options = options
|
|
|
|
def start(self):
|
|
if os.path.exists(self.file):
|
|
self.logger.info(
|
|
'opening existing deduplication database %s',
|
|
self.file)
|
|
else:
|
|
self.logger.info(
|
|
'creating new deduplication database %s', self.file)
|
|
|
|
conn = sqlite3.connect(self.file)
|
|
conn.execute(
|
|
'create table if not exists dedup ('
|
|
' key varchar(300) primary key,'
|
|
' value varchar(4000)'
|
|
');')
|
|
conn.commit()
|
|
conn.close()
|
|
|
|
def loader(self, *args, **kwargs):
|
|
return DedupLoader(self, self.options)
|
|
|
|
def storer(self, *args, **kwargs):
|
|
return warcprox.ListenerPostfetchProcessor(self, self.options)
|
|
|
|
def save(self, digest_key, response_record, bucket=""):
|
|
record_id = response_record.get_header(warctools.WarcRecord.ID).decode('latin1')
|
|
url = response_record.get_header(warctools.WarcRecord.URL).decode('latin1')
|
|
date = response_record.get_header(warctools.WarcRecord.DATE).decode('latin1')
|
|
|
|
key = digest_key.decode('utf-8') + "|" + bucket
|
|
|
|
py_value = {'id':record_id, 'url':url, 'date':date}
|
|
json_value = json.dumps(py_value, separators=(',',':'))
|
|
|
|
conn = sqlite3.connect(self.file)
|
|
conn.execute(
|
|
'insert or replace into dedup (key, value) values (?, ?)',
|
|
(key, json_value))
|
|
conn.commit()
|
|
conn.close()
|
|
self.logger.debug('dedup db saved %s:%s', key, json_value)
|
|
|
|
def lookup(self, digest_key, bucket="", url=None):
|
|
result = None
|
|
key = digest_key.decode('utf-8') + '|' + bucket
|
|
conn = sqlite3.connect(self.file)
|
|
cursor = conn.execute('select value from dedup where key = ?', (key,))
|
|
result_tuple = cursor.fetchone()
|
|
conn.close()
|
|
if result_tuple:
|
|
result = json.loads(result_tuple[0])
|
|
result['id'] = result['id'].encode('latin1')
|
|
result['url'] = result['url'].encode('latin1')
|
|
result['date'] = result['date'].encode('latin1')
|
|
self.logger.debug('dedup db lookup of key=%s returning %s', key, result)
|
|
return result
|
|
|
|
def notify(self, recorded_url, records):
|
|
if (records and records[0].type == b'response'
|
|
and recorded_url.response_recorder.payload_size() > 0):
|
|
digest_key = warcprox.digest_str(
|
|
recorded_url.payload_digest, self.options.base32)
|
|
if recorded_url.warcprox_meta and "captures-bucket" in recorded_url.warcprox_meta:
|
|
self.save(
|
|
digest_key, records[0],
|
|
bucket=recorded_url.warcprox_meta["captures-bucket"])
|
|
else:
|
|
self.save(digest_key, records[0])
|
|
|
|
def decorate_with_dedup_info(dedup_db, recorded_url, base32=False):
|
|
if (recorded_url.response_recorder
|
|
and recorded_url.payload_digest
|
|
and recorded_url.response_recorder.payload_size() > 0):
|
|
digest_key = warcprox.digest_str(recorded_url.payload_digest, base32)
|
|
if recorded_url.warcprox_meta and "captures-bucket" in recorded_url.warcprox_meta:
|
|
recorded_url.dedup_info = dedup_db.lookup(
|
|
digest_key, recorded_url.warcprox_meta["captures-bucket"],
|
|
recorded_url.url)
|
|
else:
|
|
recorded_url.dedup_info = dedup_db.lookup(
|
|
digest_key, url=recorded_url.url)
|
|
|
|
class RethinkDedupDb(DedupDb):
|
|
logger = logging.getLogger("warcprox.dedup.RethinkDedupDb")
|
|
|
|
def __init__(self, options=warcprox.Options()):
|
|
parsed = doublethink.parse_rethinkdb_url(options.rethinkdb_dedup_url)
|
|
self.rr = doublethink.Rethinker(
|
|
servers=parsed.hosts, db=parsed.database)
|
|
self.table = parsed.table
|
|
self._ensure_db_table()
|
|
self.options = options
|
|
|
|
def _ensure_db_table(self):
|
|
dbs = self.rr.db_list().run()
|
|
if not self.rr.dbname in dbs:
|
|
self.logger.info("creating rethinkdb database %r", self.rr.dbname)
|
|
self.rr.db_create(self.rr.dbname).run()
|
|
tables = self.rr.table_list().run()
|
|
if not self.table in tables:
|
|
self.logger.info(
|
|
"creating rethinkdb table %r in database %r shards=%r "
|
|
"replicas=%r", self.table, self.rr.dbname,
|
|
len(self.rr.servers), min(3, len(self.rr.servers)))
|
|
self.rr.table_create(
|
|
self.table, primary_key="key", shards=len(self.rr.servers),
|
|
replicas=min(3, len(self.rr.servers))).run()
|
|
|
|
def start(self):
|
|
pass
|
|
|
|
def save(self, digest_key, response_record, bucket=""):
|
|
k = digest_key.decode("utf-8") if isinstance(digest_key, bytes) else digest_key
|
|
k = "{}|{}".format(k, bucket)
|
|
record_id = response_record.get_header(warctools.WarcRecord.ID).decode('latin1')
|
|
url = response_record.get_header(warctools.WarcRecord.URL).decode('latin1')
|
|
date = response_record.get_header(warctools.WarcRecord.DATE).decode('latin1')
|
|
record = {'key':k,'url':url,'date':date,'id':record_id}
|
|
result = self.rr.table(self.table).insert(
|
|
record, conflict="replace").run()
|
|
if sorted(result.values()) != [0,0,0,0,0,1] and [result["deleted"],result["skipped"],result["errors"]] != [0,0,0]:
|
|
raise Exception("unexpected result %s saving %s", result, record)
|
|
self.logger.debug('dedup db saved %s:%s', k, record)
|
|
|
|
def lookup(self, digest_key, bucket="", url=None):
|
|
k = digest_key.decode("utf-8") if isinstance(digest_key, bytes) else digest_key
|
|
k = "{}|{}".format(k, bucket)
|
|
result = self.rr.table(self.table).get(k).run()
|
|
if result:
|
|
for x in result:
|
|
result[x] = result[x].encode("utf-8")
|
|
self.logger.debug('dedup db lookup of key=%s returning %s', k, result)
|
|
return result
|
|
|
|
def notify(self, recorded_url, records):
|
|
if (records and records[0].type == b'response'
|
|
and recorded_url.response_recorder.payload_size() > 0):
|
|
digest_key = warcprox.digest_str(
|
|
recorded_url.payload_digest, self.options.base32)
|
|
if recorded_url.warcprox_meta and "captures-bucket" in recorded_url.warcprox_meta:
|
|
self.save(digest_key, records[0], bucket=recorded_url.warcprox_meta["captures-bucket"])
|
|
else:
|
|
self.save(digest_key, records[0])
|
|
|
|
class CdxServerDedup(DedupDb):
|
|
"""Query a CDX server to perform deduplication.
|
|
"""
|
|
logger = logging.getLogger("warcprox.dedup.CdxServerDedup")
|
|
cookies = None
|
|
|
|
def __init__(self, cdx_url="https://web.archive.org/cdx/search",
|
|
maxsize=200, options=warcprox.Options()):
|
|
self.cdx_url = cdx_url
|
|
self.options = options
|
|
self.http_pool = urllib3.PoolManager(maxsize=maxsize)
|
|
if options.cdxserver_dedup_cookies:
|
|
self.cookies = options.cdxserver_dedup_cookies
|
|
|
|
def start(self):
|
|
pass
|
|
|
|
def save(self, digest_key, response_record, bucket=""):
|
|
"""Does not apply to CDX server, as it is obviously read-only.
|
|
"""
|
|
pass
|
|
|
|
def lookup(self, digest_key, url):
|
|
"""Compare `sha1` with SHA1 hash of fetched content (note SHA1 must be
|
|
computed on the original content, after decoding Content-Encoding and
|
|
Transfer-Encoding, if any), if they match, write a revisit record.
|
|
|
|
Get only the last item (limit=-1) because Wayback Machine has special
|
|
performance optimisation to handle that. limit < 0 is very inefficient
|
|
in general. Maybe it could be configurable in the future.
|
|
|
|
:param digest_key: b'sha1:<KEY-VALUE>' (prefix is optional).
|
|
Example: b'sha1:B2LTWWPUOYAH7UIPQ7ZUPQ4VMBSVC36A'
|
|
:param url: Target URL string
|
|
Result must contain:
|
|
{"url": <URL>, "date": "%Y-%m-%dT%H:%M:%SZ"}
|
|
"""
|
|
u = url.decode("utf-8") if isinstance(url, bytes) else url
|
|
try:
|
|
headers = {'Cookie': self.cookies} if self.cookies else {}
|
|
result = self.http_pool.request('GET', self.cdx_url, fields=dict(
|
|
url=u, fl="timestamp,digest", filter="!mimetype:warc/revisit",
|
|
limit=-1), headers=headers)
|
|
assert result.status == 200
|
|
if isinstance(digest_key, bytes):
|
|
dkey = digest_key
|
|
else:
|
|
dkey = digest_key.encode('utf-8')
|
|
dkey = dkey[5:] if dkey.startswith(b'sha1:') else dkey
|
|
line = result.data.strip()
|
|
if line:
|
|
(cdx_ts, cdx_digest) = line.split(b' ')
|
|
if cdx_digest == dkey:
|
|
dt = datetime.datetime.strptime(
|
|
cdx_ts.decode('ascii'), '%Y%m%d%H%M%S')
|
|
date = dt.strftime('%Y-%m-%dT%H:%M:%SZ').encode('utf-8')
|
|
return dict(url=url, date=date)
|
|
except (HTTPError, AssertionError, ValueError) as exc:
|
|
self.logger.error('CdxServerDedup request failed for url=%s %s',
|
|
url, exc)
|
|
return None
|
|
|
|
def notify(self, recorded_url, records):
|
|
"""Since we don't save anything to CDX server, this does not apply.
|
|
"""
|
|
pass
|
|
|
|
class BatchTroughStorer(warcprox.BaseBatchPostfetchProcessor):
|
|
def __init__(self, trough_dedup_db, options=warcprox.Options()):
|
|
warcprox.BaseBatchPostfetchProcessor.__init__(self, options)
|
|
self.trough_dedup_db = trough_dedup_db
|
|
|
|
def _filter_and_bucketize(self, batch):
|
|
'''
|
|
Returns `{bucket: [recorded_url, ...]}`, excluding urls that should
|
|
have dedup info stored.
|
|
'''
|
|
buckets = collections.defaultdict(list)
|
|
for recorded_url in batch:
|
|
if (recorded_url.warc_records
|
|
and recorded_url.warc_records[0].type == b'response'
|
|
and recorded_url.response_recorder.payload_size() > 0):
|
|
if (recorded_url.warcprox_meta
|
|
and 'captures-bucket' in recorded_url.warcprox_meta):
|
|
bucket = recorded_url.warcprox_meta['captures-bucket']
|
|
else:
|
|
bucket = '__unspecified__'
|
|
buckets[bucket].append(recorded_url)
|
|
return buckets
|
|
|
|
def _process_batch(self, batch):
|
|
buckets = self._filter_and_bucketize(batch)
|
|
for bucket in buckets:
|
|
self.trough_dedup_db.batch_save(buckets[bucket], bucket)
|
|
|
|
class BatchTroughLoader(warcprox.BaseBatchPostfetchProcessor):
|
|
def __init__(self, trough_dedup_db, options=warcprox.Options()):
|
|
warcprox.BaseBatchPostfetchProcessor.__init__(self, options)
|
|
self.trough_dedup_db = trough_dedup_db
|
|
|
|
def _startup(self):
|
|
self.trough_dedup_db.start()
|
|
|
|
def _filter_and_bucketize(self, batch):
|
|
'''
|
|
Returns `{bucket: [recorded_url, ...]}`, excluding urls that should not
|
|
be looked up.
|
|
'''
|
|
buckets = collections.defaultdict(list)
|
|
for recorded_url in batch:
|
|
if (recorded_url.response_recorder
|
|
and recorded_url.payload_digest
|
|
and recorded_url.response_recorder.payload_size() > 0):
|
|
if (recorded_url.warcprox_meta
|
|
and 'captures-bucket' in recorded_url.warcprox_meta):
|
|
bucket = recorded_url.warcprox_meta['captures-bucket']
|
|
else:
|
|
bucket = '__unspecified__'
|
|
buckets[bucket].append(recorded_url)
|
|
return buckets
|
|
|
|
def _build_key_index(self, batch):
|
|
'''
|
|
Returns `{digest_key: [recorded_url, ...]}`.
|
|
'''
|
|
key_index = collections.defaultdict(list)
|
|
for recorded_url in batch:
|
|
digest_key = warcprox.digest_str(
|
|
recorded_url.payload_digest, self.options.base32)
|
|
key_index[digest_key].append(recorded_url)
|
|
return key_index
|
|
|
|
def _process_batch(self, batch):
|
|
buckets = self._filter_and_bucketize(batch)
|
|
for bucket in buckets:
|
|
key_index = self._build_key_index(buckets[bucket])
|
|
results = self.trough_dedup_db.batch_lookup(
|
|
key_index.keys(), bucket)
|
|
for result in results:
|
|
for recorded_url in key_index[result['digest_key']]:
|
|
recorded_url.dedup_info = result
|
|
|
|
class TroughDedupDb(DedupDb):
|
|
'''
|
|
https://github.com/internetarchive/trough
|
|
'''
|
|
logger = logging.getLogger("warcprox.dedup.TroughDedupDb")
|
|
|
|
SCHEMA_ID = 'warcprox-dedup-v1'
|
|
SCHEMA_SQL = ('create table dedup (\n'
|
|
' digest_key varchar(100) primary key,\n'
|
|
' url varchar(2100) not null,\n'
|
|
' date datetime not null,\n'
|
|
' id varchar(100));\n') # warc record id
|
|
WRITE_SQL_TMPL = ('insert or ignore into dedup\n'
|
|
'(digest_key, url, date, id)\n'
|
|
'values (%s, %s, %s, %s);')
|
|
|
|
def __init__(self, options=warcprox.Options()):
|
|
self.options = options
|
|
self._trough_cli = warcprox.trough.TroughClient(
|
|
options.rethinkdb_trough_db_url, promotion_interval=60*60)
|
|
|
|
def loader(self, *args, **kwargs):
|
|
return BatchTroughLoader(self, self.options)
|
|
|
|
def storer(self, *args, **kwargs):
|
|
return BatchTroughStorer(self, self.options)
|
|
|
|
def start(self):
|
|
self._trough_cli.register_schema(self.SCHEMA_ID, self.SCHEMA_SQL)
|
|
|
|
def save(self, digest_key, response_record, bucket='__unspecified__'):
|
|
record_id = response_record.get_header(warctools.WarcRecord.ID)
|
|
url = response_record.get_header(warctools.WarcRecord.URL)
|
|
warc_date = response_record.get_header(warctools.WarcRecord.DATE)
|
|
self._trough_cli.write(
|
|
bucket, self.WRITE_SQL_TMPL,
|
|
(digest_key, url, warc_date, record_id), self.SCHEMA_ID)
|
|
|
|
def batch_save(self, batch, bucket='__unspecified__'):
|
|
sql_tmpl = ('insert or ignore into dedup\n'
|
|
'(digest_key, url, date, id)\n'
|
|
'values %s;' % ','.join(
|
|
'(%s,%s,%s,%s)' for i in range(len(batch))))
|
|
values = []
|
|
for recorded_url in batch:
|
|
values.extend([
|
|
warcprox.digest_str(
|
|
recorded_url.payload_digest, self.options.base32),
|
|
recorded_url.url,
|
|
recorded_url.warc_records[0].date,
|
|
recorded_url.warc_records[0].id,])
|
|
self._trough_cli.write(bucket, sql_tmpl, values, self.SCHEMA_ID)
|
|
|
|
def lookup(self, digest_key, bucket='__unspecified__', url=None):
|
|
results = self._trough_cli.read(
|
|
bucket, 'select * from dedup where digest_key=%s;',
|
|
(digest_key,))
|
|
if results:
|
|
assert len(results) == 1 # sanity check (digest_key is primary key)
|
|
result = results[0]
|
|
result['id'] = result['id'].encode('ascii')
|
|
result['url'] = result['url'].encode('ascii')
|
|
result['date'] = result['date'].encode('ascii')
|
|
self.logger.debug(
|
|
'trough lookup of key=%r returning %r', digest_key, result)
|
|
return result
|
|
else:
|
|
return None
|
|
|
|
def batch_lookup(self, digest_keys, bucket='__unspecified__'):
|
|
sql_tmpl = 'select * from dedup where digest_key in (%s)' % (
|
|
','.join('%s' for i in range(len(digest_keys))))
|
|
results = self._trough_cli.read(bucket, sql_tmpl, digest_keys)
|
|
if results is None:
|
|
return []
|
|
self.logger.debug(
|
|
'trough batch lookup of %s keys returned %s results',
|
|
len(digest_keys), len(results))
|
|
assert len(results) >= 0 and len(results) <= len(digest_keys)
|
|
for result in results:
|
|
result['id'] = result['id'].encode('ascii')
|
|
result['url'] = result['url'].encode('ascii')
|
|
result['date'] = result['date'].encode('ascii')
|
|
result['digest_key'] = result['digest_key'].encode('ascii')
|
|
return results
|
|
|
|
def notify(self, recorded_url, records):
|
|
if (records and records[0].type == b'response'
|
|
and recorded_url.response_recorder.payload_size() > 0):
|
|
digest_key = warcprox.digest_str(
|
|
recorded_url.payload_digest, self.options.base32)
|
|
if recorded_url.warcprox_meta and 'captures-bucket' in recorded_url.warcprox_meta:
|
|
self.save(
|
|
digest_key, records[0],
|
|
bucket=recorded_url.warcprox_meta['captures-bucket'])
|
|
else:
|
|
self.save(digest_key, records[0])
|