-
Notifications
You must be signed in to change notification settings - Fork 0
/
io_util.py
283 lines (232 loc) · 9.38 KB
/
io_util.py
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
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
import logging
import os
from pathlib import Path
import requests
import shutil
import time
from typing import Dict, List, Optional
from urllib.parse import urlparse
from dane.config import cfg
from dane.provenance import PROVENANCE_FILE, Provenance
from dane.s3_util import S3Store, parse_s3_uri, validate_s3_uri
from models import OutputType, DownloadResult
logger = logging.getLogger(__name__)
DANE_DOWNLOAD_TASK_KEY = "DOWNLOAD"
OUTPUT_FILE_BASE_NAME = "visxp_prep"
S3_OUTPUT_TYPES: List[OutputType] = [OutputType.PROVENANCE, OutputType.METADATA]
# only upload this output to S3
if cfg.VISXP_PREP.RUN_KEYFRAME_EXTRACTION:
S3_OUTPUT_TYPES.append(OutputType.KEYFRAMES)
if cfg.VISXP_PREP.RUN_AUDIO_EXTRACTION:
S3_OUTPUT_TYPES.append(OutputType.SPECTROGRAMS)
if cfg.VISXP_PREP.GENERATE_SPECTROGRAM_IMAGES:
S3_OUTPUT_TYPES.append(OutputType.SPECTROGRAM_IMAGES)
if cfg.VISXP_PREP.EXTRACT_AUDIO_SAMPLES:
S3_OUTPUT_TYPES.append(OutputType.AUDIO)
# make sure the necessary base dirs are there
def validate_data_dirs() -> bool:
i_dir = Path(get_download_dir())
o_dir = Path(get_base_output_dir())
logger.info(
f"Making sure the input ({i_dir}) & output ({o_dir}) dirs are available"
)
if not os.path.exists(i_dir.parent.absolute()):
logger.info(
"{} does not exist. Make sure BASE_MOUNT_DIR exists before retrying".format(
i_dir.parent.absolute()
)
)
return False
# make sure the input and output dirs are there
try:
os.makedirs(i_dir, 0o755)
logger.info("created VisXP input dir: {}".format(i_dir))
except FileExistsError as e:
logger.info(e)
try:
os.makedirs(o_dir, 0o755)
logger.info("created VisXP output dir: {}".format(o_dir))
except FileExistsError as e:
logger.info(e)
return True
def get_download_dir():
return os.path.join(cfg.FILE_SYSTEM.BASE_MOUNT, cfg.FILE_SYSTEM.INPUT_DIR)
def get_provenance_file(input_file_path: str) -> str:
return os.path.join(
get_base_output_dir(get_source_id(input_file_path)),
OutputType.PROVENANCE.value,
PROVENANCE_FILE,
)
# returns the basename of the input file path without an extension
# throughout processing this is then used as a unique ID to keep track of the input/output
def get_source_id(input_file_path: str) -> str:
fn = os.path.basename(input_file_path)
return fn[0 : fn.rfind(".")] if "." in fn else fn
# below this dir each processing module will put its output data in a subfolder
def get_base_output_dir(source_id: str = "") -> str:
path_elements = [cfg.FILE_SYSTEM.BASE_MOUNT, cfg.FILE_SYSTEM.OUTPUT_DIR]
if source_id:
path_elements.append(source_id)
return os.path.join(*path_elements)
# output file name of the final tar.gz that will be uploaded to S3
def get_output_file_name(source_id: str) -> str:
return f"{OUTPUT_FILE_BASE_NAME}__{source_id}.tar.gz"
# e.g. s3://<bucket>/assets/<source_id>
def get_s3_base_uri(source_id: str) -> str:
return f"s3://{os.path.join(cfg.OUTPUT.S3_BUCKET, cfg.OUTPUT.S3_FOLDER_IN_BUCKET, source_id)}"
# e.g. s3://<bucket>/assets/<source_id>/visxp_prep__<source_id>.tar.gz
def get_s3_output_file_uri(source_id: str) -> str:
return f"{get_s3_base_uri(source_id)}/{get_output_file_name(source_id)}"
# for each OutputType a subdir is created inside the base output dir
def generate_output_dirs(source_id: str) -> Dict[str, str]:
base_output_dir = get_base_output_dir(source_id)
output_dirs = {}
logger.info(f"Creating output dirs for {S3_OUTPUT_TYPES}")
for output_type in OutputType:
if output_type not in S3_OUTPUT_TYPES:
# Only create it if you will, in the end, upload it too (experimental)
continue
output_dir = os.path.join(base_output_dir, output_type.value)
if not os.path.isdir(output_dir):
os.makedirs(output_dir)
output_dirs[output_type.value] = output_dir
return output_dirs
def delete_local_output(source_id: str) -> bool:
output_dir = get_base_output_dir(source_id)
logger.info(f"Deleting output folder: {output_dir}")
if output_dir == os.sep or output_dir == ".":
logger.warning(f"Rejected deletion of: {output_dir}")
return False
if not _is_valid_visxp_output(output_dir):
logger.warning(
f"Tried to delete a dir that did not contain VisXP output: {output_dir}"
)
return False
try:
shutil.rmtree(output_dir)
logger.info(f"Cleaned up folder {output_dir}")
except Exception:
logger.exception(f"Failed to delete output dir {output_dir}")
return False
return True
# TODO implement some more, now checks presence of provenance dir
def _is_valid_visxp_output(output_dir: str) -> bool:
return os.path.exists(os.path.join(output_dir, OutputType.PROVENANCE.value))
def _validate_transfer_config() -> bool:
if any(
[
not x
for x in [
cfg.OUTPUT.S3_ENDPOINT_URL,
cfg.OUTPUT.S3_BUCKET,
cfg.OUTPUT.S3_FOLDER_IN_BUCKET,
]
]
):
logger.warning(
"TRANSFER_ON_COMPLETION configured without all the necessary S3 settings"
)
return False
return True
# compresses all desired output dirs into a single tar and uploads it to S3
def transfer_output(source_id: str) -> bool:
output_dir = get_base_output_dir(source_id)
logger.info(f"Transferring {output_dir} to S3 (asset={source_id})")
if not _validate_transfer_config():
return False
s3 = S3Store(cfg.OUTPUT.S3_ENDPOINT_URL)
file_list = [os.path.join(output_dir, ot.value) for ot in S3_OUTPUT_TYPES]
tar_file = os.path.join(output_dir, get_output_file_name(source_id))
success = s3.transfer_to_s3(
cfg.OUTPUT.S3_BUCKET,
os.path.join(
cfg.OUTPUT.S3_FOLDER_IN_BUCKET, source_id
), # assets/<program ID>__<carrier ID>
file_list, # this list of subdirs will be compressed into the tar below
tar_file, # this file will be uploaded
)
if not success:
logger.error(f"Failed to upload: {tar_file}")
return False
return True
def delete_input_file(input_file: str, actually_delete: bool) -> bool:
logger.info(f"Verifying deletion of input file: {input_file}")
if actually_delete is False:
logger.info("Configured to leave the input alone, skipping deletion")
return True
# first remove the input file
try:
os.remove(input_file)
logger.info(f"Deleted VisXP input file: {input_file}")
except OSError:
logger.exception("Could not delete input file")
return False
return True # return True even if empty dirs were not removed
def download_uri(uri: str) -> Optional[DownloadResult]:
logger.info(f"Trying to download {uri}")
if validate_s3_uri(uri):
logger.info("URI seems to be an s3 uri")
return s3_download(uri)
return http_download(uri)
# TODO test this!
def http_download(url: str) -> Optional[DownloadResult]:
logger.info(f"Downloading {url}")
fn = os.path.basename(urlparse(url).path)
# fn = unquote(fn)
# fn = doc.target['url'][doc.target['url'].rfind('/') +1:]
output_file = os.path.join(get_download_dir(), fn)
logger.info(f"Saving to file {fn}")
# download if the file is not present (preventing unnecessary downloads)
start_time = time.time()
if not os.path.exists(output_file):
with open(output_file, "wb") as file:
response = requests.get(url)
file.write(response.content)
file.close()
download_time = (time.time() - start_time) * 1000 # time in ms
return DownloadResult(
output_file, # NOTE or output_file? hmmm
download_time, # TODO add mime_type and content_length
)
# e.g. s3://dane-asset-staging-gb/assets/2101608170158176431__NOS_JOURNAAL_-WON01513227.mp4
def s3_download(s3_uri: str) -> Optional[DownloadResult]:
logger.info(f"Downloading {s3_uri}")
if not validate_s3_uri(s3_uri):
logger.error(f"Invalid S3 URI: {s3_uri}")
return None
# source_id = get_source_id(s3_uri)
start_time = time.time()
output_folder = get_download_dir()
# TODO download the content into get_download_dir()
s3 = S3Store(cfg.OUTPUT.S3_ENDPOINT_URL)
bucket, object_name = parse_s3_uri(s3_uri)
logger.info(f"OBJECT NAME: {object_name}")
input_file_path = os.path.join(
get_download_dir(),
# source_id,
os.path.basename(object_name), # i.e. visxp_prep__<source_id>.tar.gz
)
success = s3.download_file(bucket, object_name, output_folder)
if success:
download_time = time.time() - start_time
return DownloadResult(
input_file_path,
download_time,
)
logger.error("Failed to download input data from S3")
return None
def to_download_provenance(
download_result: DownloadResult,
input_file_path: str,
start_time: float,
software_version: str,
) -> Provenance:
return Provenance(
activity_name="Download VisXP input",
activity_description="Download source AV media",
start_time_unix=start_time,
processing_time_ms=download_result.download_time,
software_version=software_version,
input_data={"input_file_path": input_file_path},
output_data={"file_path": download_result.file_path},
)