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
|
#!/usr/bin/env python3
"""
Tool for bulk copying of PDFs (or other files) from GWB to AWS S3.
See unpaywall delivery README (in bnewbold's scratch repo) for notes on running
this script for that specific use-case.
Script takes:
- input TSV: `sha1_hex, file:cdx (json)`
=> usually from dumpfilemeta, filtered down (eg, by join by SHA-1) to a specific manifest
- AWS S3 bucket and prefix
AWS S3 credentials are passed via environment variables (AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY)
GWB credentials from environment variable PETABOX_WEBDATA_SECRET, else looks in /opt/.petabox/.
20x threads on a single machine can process about 340k files in 3 hours; that's
roughly 6 hours per million per host with 32 threads, or 5k files an hour
(1.6/second) per thread. Two large machines should be able to upload 10 million
files in about 30 hours.
Output:
- errors/stats to stderr
- log to stdout (redirect to file), prefixed by sha1
Requires:
- sentry-sdk
- boto3 (AWS S3 client library)
- wayback/GWB libraries
"""
# XXX: some broken MRO thing going on in here due to python3 object wrangling
# in `wayback` library. Means we can't run pylint.
# pylint: skip-file
import argparse
import base64
import hashlib
import json
import os
import sys
from collections import Counter
from http.client import IncompleteRead
import boto3
import sentry_sdk
import wayback.exception
from gwb.loader import CDXLoaderFactory
from wayback.resourcestore import ResourceStore
class DeliverGwbS3:
def __init__(self, s3_bucket, **kwargs):
self.warc_uri_prefix = kwargs.get("warc_uri_prefix")
self.rstore = None
self.count = Counter()
# /serve/ instead of /download/ doesn't record view count
self.petabox_base_url = kwargs.get("petabox_base_url", "http://archive.org/serve/")
# gwb library will fall back to reading from /opt/.petabox/webdata.secret
self.petabox_webdata_secret = kwargs.get(
"petabox_webdata_secret", os.environ.get("PETABOX_WEBDATA_SECRET")
)
self.s3_bucket = s3_bucket
self.s3_prefix = kwargs.get("s3_prefix", "pdf/")
self.s3_suffix = kwargs.get("s3_suffix", ".pdf")
self.s3 = boto3.resource("s3")
self.bucket = self.s3.Bucket(self.s3_bucket)
def fetch_warc_content(self, warc_path, offset, c_size):
warc_uri = self.warc_uri_prefix + warc_path
if not self.rstore:
self.rstore = ResourceStore(
loaderfactory=CDXLoaderFactory(
webdata_secret=self.petabox_webdata_secret,
download_base_url=self.petabox_base_url,
)
)
try:
gwb_record = self.rstore.load_resource(warc_uri, offset, c_size)
except wayback.exception.ResourceUnavailable:
return None, dict(
status="error",
reason="failed to load file contents from wayback/petabox (ResourceUnavailable)",
)
except ValueError as ve:
return None, dict(
status="error",
reason="failed to load file contents from wayback/petabox (ValueError: {})".format(
ve
),
)
except EOFError as eofe:
return None, dict(
status="error",
reason="failed to load file contents from wayback/petabox (EOFError: {})".format(
eofe
),
)
except TypeError as te:
return None, dict(
status="error",
reason="failed to load file contents from wayback/petabox (TypeError: {}; likely a bug in wayback python code)".format(
te
),
)
# Note: could consider a generic "except Exception" here, as we get so
# many petabox errors. Do want jobs to fail loud and clear when the
# whole cluster is down though.
if gwb_record.get_status()[0] != 200:
return None, dict(
status="error",
reason="archived HTTP response (WARC) was not 200",
warc_status=gwb_record.get_status()[0],
)
try:
raw_content = gwb_record.open_raw_content().read()
except IncompleteRead as ire:
return None, dict(
status="error",
reason="failed to read actual file contents from wayback/petabox (IncompleteRead: {})".format(
ire
),
)
return raw_content, None
def run(self, manifest_file):
sys.stderr.write("Starting...\n")
for line in manifest_file:
self.count["total"] += 1
line = line.strip().split("\t")
if len(line) != 2:
self.count["skip-line"] += 1
continue
sha1_hex, cdx_json = line[0], line[1]
assert len(sha1_hex) == 40
file_cdx = json.loads(cdx_json)
# If warc is not item/file.(w)arc.gz form, skip it
if len(file_cdx["warc"].split("/")) != 2:
sys.stderr.write("WARC path not petabox item/file: {}".format(file_cdx["warc"]))
print("{}\tskip warc\t{}".format(sha1_hex, file_cdx["warc"]))
self.count["skip-warc"] += 1
continue
# fetch from GWB/petabox via HTTP range-request
blob, status = self.fetch_warc_content(
file_cdx["warc"], file_cdx["offset"], file_cdx["c_size"]
)
if blob is None and status:
print(
"{}\terror petabox\t{}\t{}".format(
sha1_hex, file_cdx["warc"], status["reason"]
)
)
self.count["err-petabox-fetch"] += 1
continue
elif not blob:
print("{}\tskip-empty-blob".format(sha1_hex))
self.count["skip-empty-blob"] += 1
continue
# verify sha1
if sha1_hex != hashlib.sha1(blob).hexdigest():
# assert sha1_hex == hashlib.sha1(blob).hexdigest()
# sys.stderr.write("{}\terror petabox-mismatch\n".format(sha1_hex))
print("{}\terror petabox-hash-mismatch".format(sha1_hex))
self.count["err-petabox-hash-mismatch"] += 1
self.count["petabox-ok"] += 1
# upload to AWS S3
obj = self.bucket.put_object(
Key="{}{}/{}{}".format(self.s3_prefix, sha1_hex[0:4], sha1_hex, self.s3_suffix),
Body=blob,
)
print("{}\tsuccess\t{}\t{}".format(sha1_hex, obj.key, len(blob)))
self.count["success-s3"] += 1
sys.stderr.write("{}\n".format(self.count))
def main():
parser = argparse.ArgumentParser()
parser.add_argument(
"--s3-bucket", required=True, type=str, help="AWS S3 bucket to upload into"
)
parser.add_argument(
"--s3-prefix", type=str, default="pdf/", help="key prefix for items created in bucket"
)
parser.add_argument(
"--s3-suffix", type=str, default=".pdf", help="file suffix for created objects"
)
parser.add_argument(
"--warc-uri-prefix",
type=str,
default="https://archive.org/serve/",
help="URI where WARCs can be found",
)
parser.add_argument(
"manifest_file",
help="TSV/JSON manifest file",
default=sys.stdin,
type=argparse.FileType("r"),
)
args = parser.parse_args()
sentry_sdk.init()
worker = DeliverGwbS3(**args.__dict__)
worker.run(args.manifest_file)
if __name__ == "__main__": # pragma: no cover
main()
|
