Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add digest_algorithm option in writer #119

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions test/test_writer.py
Original file line number Diff line number Diff line change
Expand Up @@ -687,6 +687,22 @@ def test_response_warc_1_1(self, is_gzip, builder_factory):
assert '.' in recs[0].rec_headers['WARC-Date']
assert len(recs[0].rec_headers['WARC-Date']) == 27

def test_response_digest_sha256(self, is_gzip, builder_factory):
writer = BufferWARCWriter(gzip=is_gzip, warc_version='WARC/1.1', digest_algorithm='sha256')

builder = builder_factory(writer, warc_version='WARC/1.1', digest_algorithm='sha256')
resp = sample_response(builder)
writer.write_record(resp)

stream = writer.get_stream()

reader = ArchiveIterator(stream)
recs = list(reader)

assert len(recs) == 1
assert recs[0].rec_headers.get('WARC-Block-Digest') == 'sha256:HB3IP2QLBZJ45JMKAYFDDVME5MTC2WX2JJLQZSJYR575CFMRDDHA===='
assert recs[0].rec_headers.get('WARC-Payload-Digest') == 'sha256:5DS36RD4GUWABAHBIREZJMGMD67HUJPT5JRXYXEJ6WK3NKK4SJJQ===='

def _conv_to_streaming_record(self, record_buff, rec_type):
# strip-off the two empty \r\n\r\n added at the end of uncompressed record
record_buff = record_buff[:-4]
Expand Down
16 changes: 12 additions & 4 deletions warcio/recordbuilder.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,16 @@ class RecordBuilder(object):
}

NO_PAYLOAD_DIGEST_TYPES = ('warcinfo', 'revisit')

# default digest algorithm
DIGEST_ALGORITHM = 'sha1'


def __init__(self, warc_version=None, header_filter=None):
def __init__(self, warc_version=None, header_filter=None, digest_algorithm=None):
self.warc_version = self._parse_warc_version(warc_version)

self.header_filter = header_filter
self.digest_algorithm = self._parse_digest_algorithm(digest_algorithm)

def create_warcinfo_record(self, filename, info):
warc_headers = StatusAndHeaders('', [], protocol=self.warc_version)
Expand Down Expand Up @@ -146,6 +150,11 @@ def _parse_warc_version(self, version):
return version

return 'WARC/' + version

def _parse_digest_algorithm(self, algorithm):
if not algorithm:
return self.DIGEST_ALGORITHM
return algorithm

@classmethod
def _make_warc_id(cls):
Expand Down Expand Up @@ -221,9 +230,8 @@ def _iter_stream(stream):

yield buf

@staticmethod
def _create_digester():
return Digester('sha1')
def _create_digester(self):
return Digester(self.digest_algorithm)

@staticmethod
def _create_temp_file():
Expand Down
3 changes: 2 additions & 1 deletion warcio/warcwriter.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@ class BaseWARCWriter(RecordBuilder):

def __init__(self, gzip=True, *args, **kwargs):
super(BaseWARCWriter, self).__init__(warc_version=kwargs.get('warc_version'),
header_filter=kwargs.get('header_filter'))
header_filter=kwargs.get('header_filter'),
digest_algorithm=kwargs.get('digest_algorithm'))
self.gzip = gzip
self.hostname = gethostname()

Expand Down