-
Notifications
You must be signed in to change notification settings - Fork 15
Expand file tree
/
Copy pathtasks_util.py
More file actions
266 lines (216 loc) · 9.86 KB
/
Copy pathtasks_util.py
File metadata and controls
266 lines (216 loc) · 9.86 KB
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
import os
import tarfile
import tempfile
from django.contrib.auth import get_user_model
from django.core.mail import send_mail
from django.db.models import F
from django.utils import timezone
from tenacity import (
retry,
retry_if_exception_type,
stop_after_attempt,
wait_fixed,
)
from ESSArch_Core.configuration.models import Parameter
from ESSArch_Core.essxml.Generator.xmlGenerator import XMLGenerator
from ESSArch_Core.essxml.util import find_files
from ESSArch_Core.fixity.format import FormatIdentifier
from ESSArch_Core.fixity.validation.backends.checksum import ChecksumValidator
from ESSArch_Core.fixity.validation.backends.format import FormatValidator
from ESSArch_Core.ip.models import EventIP, InformationPackage
from ESSArch_Core.storage.exceptions import TapeDriveLockedError
from ESSArch_Core.storage.models import StorageMedium, TapeDrive, TapeSlot
from ESSArch_Core.storage.tape import (
create_tape_label,
mount_tape,
rewind_tape,
tape_empty,
unmount_tape,
verify_tape_label,
wait_to_come_online,
write_to_tape,
)
from ESSArch_Core.util import get_event_element_spec
User = get_user_model()
@retry(retry=retry_if_exception_type(TapeDriveLockedError), reraise=True, stop=stop_after_attempt(5),
wait=wait_fixed(60))
def unmount_tape_from_drive(drive_pk):
"""
Unmounts tape from drive into slot
Args:
drive_pk: Which drive to unmount from
"""
tape_drive = TapeDrive.objects.get(pk=drive_pk)
# Check if reverse one to one relation exists
if not hasattr(tape_drive, 'storage_medium'):
raise ValueError("No tape in tape drive to unmount")
slot = tape_drive.storage_medium.tape_slot
robot = tape_drive.robot
if tape_drive.locked:
raise TapeDriveLockedError()
tape_drive.locked = True
tape_drive.save(update_fields=['locked'])
try:
res = unmount_tape(robot.device, slot.slot_id, tape_drive.drive_id, slot.medium_id)
except BaseException:
StorageMedium.objects.filter(pk=tape_drive.storage_medium.pk).update(
status=100, last_changed_local=timezone.now(),
)
TapeDrive.objects.filter(pk=drive_pk).update(locked=False, status=100)
TapeSlot.objects.filter(pk=slot.pk).update(status=100)
raise
StorageMedium.objects.filter(pk=tape_drive.storage_medium.pk).update(
tape_drive=None, last_changed_local=timezone.now(),
)
tape_drive.last_change = timezone.now()
tape_drive.locked = False
tape_drive.save(update_fields=['last_change', 'locked'])
return res
@retry(retry=retry_if_exception_type(TapeDriveLockedError), reraise=True, stop=stop_after_attempt(5),
wait=wait_fixed(60))
def mount_tape_medium_into_drive(drive_pk, medium_pk, timeout):
"""
Mounts tape into drive
Args:
medium_pk: Which medium to mount
drive_pk: Which drive to load to
timeout: Number of times to try to mount the tape (1 sec sleep between each retry)
"""
medium = StorageMedium.objects.get(pk=medium_pk)
slot = medium.tape_slot
tape_drive = TapeDrive.objects.get(pk=drive_pk)
if tape_drive.locked:
raise TapeDriveLockedError()
tape_drive.locked = True
tape_drive.save(update_fields=['locked'])
try:
mount_tape(tape_drive.robot.device, slot.slot_id, tape_drive.drive_id, slot.medium_id)
wait_to_come_online(tape_drive.device, timeout)
except BaseException:
StorageMedium.objects.filter(pk=medium_pk).update(
status=100, last_changed_local=timezone.now(),
)
TapeDrive.objects.filter(pk=drive_pk).update(locked=False, status=100)
TapeSlot.objects.filter(pk=slot.pk).update(status=100)
raise
TapeDrive.objects.filter(pk=drive_pk).update(
num_of_mounts=F('num_of_mounts') + 1,
last_change=timezone.now(),
)
StorageMedium.objects.filter(pk=medium.pk).update(
num_of_mounts=F('num_of_mounts') + 1,
tape_drive_id=drive_pk,
last_changed_local=timezone.now(),
)
write_medium_label_to_drive(drive_pk, medium, slot, tape_drive)
def write_medium_label_to_drive(drive_pk, medium, slot, tape_drive):
xmlfile = tempfile.NamedTemporaryFile(delete=False)
try:
arcname = '%s_label.xml' % medium.medium_id
if medium.format not in [100, 101]:
if not medium.storage.exists() and tape_empty(tape_drive.device):
create_tape_label(medium, xmlfile.name)
rewind_tape(tape_drive.device)
write_to_tape(tape_drive.device, xmlfile.name, arcname=arcname)
else:
rewind_tape(tape_drive.device)
tar = tarfile.open(tape_drive.device, 'r|')
first_member = tar.getmembers()[0]
tar.close()
rewind_tape(tape_drive.device)
if first_member.name.endswith('_label.xml'):
tar = tarfile.open(tape_drive.device, 'r|')
xmlstring = tar.extractfile(first_member).read()
tar.close()
if not verify_tape_label(medium, xmlstring):
raise ValueError('Tape contains invalid label file')
elif first_member.name == 'reuse':
create_tape_label(medium, xmlfile.name)
rewind_tape(tape_drive.device)
write_to_tape(tape_drive.device, xmlfile.name, arcname=arcname)
else:
raise ValueError('Tape contains unknown information')
rewind_tape(tape_drive.device)
except BaseException:
StorageMedium.objects.filter(pk=medium.pk).update(
status=100, last_changed_local=timezone.now(),
)
TapeDrive.objects.filter(pk=drive_pk).update(locked=False, status=100)
TapeSlot.objects.filter(pk=slot.pk).update(status=100)
raise
finally:
xmlfile.close()
TapeDrive.objects.filter(pk=drive_pk).update(locked=False)
def validate_file_format(filename, format_name, format_registry_key, format_version):
"""
Validates the format of the given file
"""
fid = FormatIdentifier()
actual_format_name, actual_format_version, actual_format_registry_key = fid.identify_file_format(filename)
if format_name:
assert actual_format_name == format_name, (
"format name for %s is not valid, (%s != %s)" % filename, format_name, actual_format_name
)
if format_version:
assert actual_format_version == format_version, "format version for %s is not valid" % filename
if format_registry_key:
assert actual_format_registry_key == format_registry_key, (
"format registry key for %s is not valid" % filename
)
return "Success"
def validate_files(ip, responsible, rootdir, validate_fileformat, validate_integrity, xmlfile):
if any([validate_fileformat, validate_integrity]):
if rootdir is None:
rootdir = InformationPackage.objects.values_list('object_path', flat=True).get(pk=ip)
format_validator = FormatValidator()
for f in find_files(xmlfile, rootdir):
filename = os.path.join(rootdir, f.path)
if validate_fileformat and f.format is not None:
format_validator.validate(filename, (f.format, None, None))
if validate_integrity and f.checksum is not None and f.checksum_type is not None:
options = {'expected': f.checksum, 'algorithm': f.checksum_type}
validator = ChecksumValidator(context='checksum_str', options=options)
try:
validator.validate(filename)
except Exception as e:
recipient = User.objects.get(pk=responsible).email
if recipient and ip:
ip = InformationPackage.objects.get(pk=ip)
subject = 'Rejected "%s"' % ip.object_identifier_value
body = '"%s" was rejected:\n%s' % (ip.object_identifier_value, str(e))
send_mail(subject, body, None, [recipient], fail_silently=False)
raise
def append_events(ip, events, filename):
if not filename:
ip_obj = InformationPackage.objects.get(pk=ip)
filename = os.path.join(ip_obj.object_path, ip_obj.get_events_file_path())
generator = XMLGenerator(filepath=filename)
template = get_event_element_spec()
if not events:
events = EventIP.objects.filter(linkingObjectIdentifierValue=ip)
id_types = {}
for id_type in ['event', 'linking_agent', 'linking_object']:
entity = '%s_identifier_type' % id_type
id_types[id_type] = Parameter.objects.cached('entity', entity, 'value')
target = generator.find_element('premis')
for event in events.iterator(chunk_size=1000):
ip = InformationPackage.objects.get(pk=event.linkingObjectIdentifierValue)
objid = ip.object_identifier_value
data = {
"eventIdentifierType": id_types['event'],
"eventIdentifierValue": str(event.eventIdentifierValue),
"eventType": (
str(event.eventType.code) if event.eventType.code is not None and
event.eventType.code != '' else str(event.eventType.eventType)),
"eventDateTime": str(event.eventDateTime),
"eventDetail": event.eventType.eventDetail,
"eventOutcome": str(event.eventOutcome),
"eventOutcomeDetailNote": event.eventOutcomeDetailNote,
"linkingAgentIdentifierType": id_types['linking_agent'],
"linkingAgentIdentifierValue": event.linkingAgentIdentifierValue,
"linkingAgentRole": event.linkingAgentRole,
"linkingObjectIdentifierType": id_types['linking_object'],
"linkingObjectIdentifierValue": objid,
}
generator.insert_from_specification(target, template, data)
generator.write(filename)