1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
|
# Copyright (c) 2018 crocoite contributors
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
"""
Misc tools
"""
import shutil, sys, os, logging, argparse, json
from io import BytesIO
from warcio.archiveiterator import ArchiveIterator
from warcio.warcwriter import WARCWriter
from yarl import URL
from pkg_resources import parse_version, parse_requirements
from .util import getSoftwareInfo, StrJsonEncoder
def mergeWarc (files, output):
# stats
unique = 0
revisit = 0
uniqueLength = 0
revisitLength = 0
payloadMap = {}
writer = WARCWriter (output, gzip=True)
# Add an additional warcinfo record, describing the transformations. This
# is not ideal, since
# “A ‘warcinfo’ record describes the records that
# follow it […] until next ‘warcinfo’”
# -- https://iipc.github.io/warc-specifications/specifications/warc-format/warc-1.1/#warcinfo
# A warcinfo record is expected at the beginning of every file. But it
# might have written by a different software, so we don’t want to
# strip/replace that information, but supplement it.
warcinfo = {
'software': getSoftwareInfo (),
'tool': 'crocoite-merge', # not the name of the cli tool
'parameters': {'inputs': files},
}
payload = BytesIO (json.dumps (warcinfo, indent=2).encode ('utf-8'))
record = writer.create_warc_record ('', 'warcinfo',
payload=payload,
warc_headers_dict={'Content-Type': 'text/plain; encoding=utf-8'})
writer.write_record (record)
for l in files:
with open (l, 'rb') as fd:
for record in ArchiveIterator (fd):
if record.rec_type in {'resource', 'response'}:
headers = record.rec_headers
rid = headers.get_header('WARC-Record-ID')
csum = headers.get_header('WARC-Payload-Digest')
length = int (headers.get_header ('Content-Length'))
dup = payloadMap.get (csum, None)
if dup is None:
payloadMap[csum] = {'uri': headers.get_header('WARC-Target-URI'),
'id': rid, 'date': headers.get_header('WARC-Date')}
unique += 1
uniqueLength += length
else:
logging.debug (f'Record {rid} is duplicate of {dup["id"]}')
# Payload may be identical, but HTTP headers are
# (probably) not. Include them.
record = writer.create_revisit_record (
headers.get_header('WARC-Target-URI'), digest=csum,
refers_to_uri=dup['uri'], refers_to_date=dup['date'],
http_headers=record.http_headers)
record.rec_headers.add_header ('WARC-Truncated', 'length')
record.rec_headers.add_header ('WARC-Refers-To', dup['id'])
revisit += 1
revisitLength += length
else:
unique += 1
writer.write_record (record)
json.dump (dict (
unique=dict (records=unique, bytes=uniqueLength),
revisit=dict (records=revisit, bytes=revisitLength),
ratio=dict (
records=unique/(unique+revisit),
bytes=uniqueLength/(uniqueLength+revisitLength)
),
),
sys.stdout,
cls=StrJsonEncoder)
sys.stdout.write ('\n')
def mergeWarcCli():
parser = argparse.ArgumentParser(description='Merge WARCs, reads filenames from stdin.')
parser.add_argument('--verbose', '-v', action='store_true')
parser.add_argument('output', type=argparse.FileType ('wb'), help='Output WARC')
args = parser.parse_args()
loglevel = logging.DEBUG if args.verbose else logging.INFO
logging.basicConfig (level=loglevel)
mergeWarc([l.strip() for l in sys.stdin], args.output)
def extractScreenshot ():
"""
Extract page screenshots from a WARC generated by crocoite into files
"""
parser = argparse.ArgumentParser(description='Extract screenshots from '
'WARC, write JSON info to stdout.')
parser.add_argument('-f', '--force', action='store_true',
help='Overwrite existing files')
parser.add_argument('-1', '--one', action='store_true',
help='Only extract the first screenshot into a file named prefix')
parser.add_argument('input', type=argparse.FileType ('rb'),
help='Input WARC')
parser.add_argument('prefix', help='Output file prefix')
args = parser.parse_args()
i = 0
with args.input:
for record in ArchiveIterator (args.input):
headers = record.rec_headers
if record.rec_type != 'conversion' or \
headers['Content-Type'] != 'image/png' or \
'X-Crocoite-Screenshot-Y-Offset' not in headers:
continue
url = URL (headers.get_header ('WARC-Target-URI'))
yoff = int (headers.get_header ('X-Crocoite-Screenshot-Y-Offset'))
outpath = f'{args.prefix}{i:05d}.png' if not args.one else args.prefix
if args.force or not os.path.exists (outpath):
json.dump ({'file': outpath, 'url': url, 'yoff': yoff},
sys.stdout, cls=StrJsonEncoder)
sys.stdout.write ('\n')
with open (outpath, 'wb') as out:
shutil.copyfileobj (record.raw_stream, out)
i += 1
else:
print (f'not overwriting {outpath}', file=sys.stderr)
if args.one:
break
class Errata:
__slots__ = ('uuid', 'description', 'affects')
def __init__ (self, uuid, description, affects):
self.uuid = uuid
self.description = description
# slightly abusing setuptool’s version parsing/matching here
self.affects = list (parse_requirements(affects))
def __contains__ (self, pkg):
"""
Return True if the versions in pkg are affected by this errata
pkg must be a mapping from project_name to version
"""
matchedAll = []
for a in self.affects:
haveVersion = pkg.get (a.project_name, None)
matchedAll.append (haveVersion is not None and haveVersion in a)
return all (matchedAll)
def __repr__ (self):
return f'{self.__class__.__name__}({self.uuid!r}, {self.description!r}, {self.affects!r})'
@property
def fixable (self):
return getattr (self, 'applyFix', None) is not None
def toDict (self):
return {'uuid': self.uuid,
'description': self.description,
'affects': list (map (str, self.affects)),
'fixable': self.fixable}
class FixableErrata(Errata):
def applyFix (self, records):
raise NotImplementedError () # pragma: no cover
bugs = [
Errata (uuid='34a176b3-ad3d-430f-a082-68087f304572',
description='Generated by version < 1.0. No erratas are supported for this version.',
affects=['crocoite<1.0'],
),
]
def makeReport (fd):
for record in ArchiveIterator (fd):
if record.rec_type == 'warcinfo':
try:
data = json.load (record.raw_stream)
haveVersions = dict ([(pkg['projectName'], parse_version(pkg['version'])) for pkg in data['software']['self']])
yield from filter (lambda b: haveVersions in b, bugs)
except json.decoder.JSONDecodeError:
pass
def errata ():
parser = argparse.ArgumentParser(description=f'Show/fix erratas for WARCs generated by {__package__}.')
parser.add_argument('input', type=argparse.FileType ('rb'), help='Input WARC')
args = parser.parse_args()
hasErrata = False
for item in makeReport (args.input):
json.dump (item.toDict (), sys.stdout)
sys.stdout.write ('\n')
sys.stdout.flush ()
hasErrata = True
return int (hasErrata)
|
