forked from BeOpen-project/mqa-scoring
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathmqa_submits.py
More file actions
768 lines (698 loc) · 36.5 KB
/
Copy pathmqa_submits.py
File metadata and controls
768 lines (698 loc) · 36.5 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
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
import re
import math
import json
import logging
import os
import asyncio
from rdflib import Graph
from datetime import datetime, timezone
from bson.objectid import ObjectId
from fastapi import BackgroundTasks, File, UploadFile, HTTPException, APIRouter
from pydantic import BaseModel
from typing import Optional
from pymongo_get_database import get_database
from mqa_calculators import *
from s3_storage import *
from mqa_url_guard import (
safe_fetch_text,
safe_post_json,
validate_url,
UnsafeUrlError,
FetchTooLargeError,
)
from mqa_xml_guard import assert_safe_xml, UnsafeXmlError
logger = logging.getLogger(__name__)
MAX_UPLOAD_BYTES = int(os.getenv("MQA_MAX_UPLOAD_BYTES") or 50 * 1024 * 1024)
submitRouter = APIRouter()
# converts the metric to a string containing just the name of the metric, ex: dct:title
def str_metric(val, g):
valStr=str(val)
for prefix, ns in g.namespaces():
if val.find(ns) != -1:
metStr = valStr.replace(ns,prefix+":")
return metStr
# find the nth occurrence of a substring in a string
def find_nth(haystack: str, needle: str, n: int) -> int:
start = haystack.find(needle)
while start >= 0 and n > 1:
start = haystack.find(needle, start+len(needle))
n -= 1
return start
# Base model
class Options(BaseModel):
xml: Optional[str] = None
file_url: Optional[str] = None
url: Optional[str] = None
id: Optional[str] = None
# Optional explicit title. When provided (e.g. Idra passes the catalogue name),
# it is used instead of the title parsed from the RDF, which is unreliable for
# catalogue-level dumps.
title: Optional[str] = None
# api to start a new analisys and save on db the results for both case catalogue and dataset
# accept only rdf files, as string or by url, or by file in the submit/file api
# can specify the id of the catalogue or dataset if it was already created before
# the analisys can be long, so it is sent to the user a message that the request has been accepted and if new analisys it also returns the id of the new catalogue or dataset
@submitRouter.post("/")
async def useCaseConfigurator(options: Options, background_tasks: BackgroundTasks):
try:
configuration_inputs = options
except Exception as e:
logger.exception("Error while processing request")
raise HTTPException(status_code=400, detail="Inputs not valid")
try:
if configuration_inputs.xml == None and configuration_inputs.file_url == None:
raise HTTPException(status_code=400, detail="Inputs not valid")
elif configuration_inputs.xml != None:
xml = configuration_inputs.xml
else:
try:
status, xml = await safe_fetch_text(configuration_inputs.file_url)
except UnsafeUrlError:
raise HTTPException(status_code=400, detail="URL not allowed")
except FetchTooLargeError:
raise HTTPException(status_code=413, detail="Remote file too large")
except Exception:
logger.exception("Error while processing request")
raise HTTPException(status_code=400, detail="Failed to fetch file from URL")
if status != 200:
raise HTTPException(status_code=400, detail="Failed to fetch file from URL")
try:
assert_safe_xml(xml)
except UnsafeXmlError:
raise HTTPException(status_code=400, detail="XML payload rejected")
if configuration_inputs.url != None:
try:
validate_url(configuration_inputs.url)
except UnsafeUrlError:
raise HTTPException(status_code=400, detail="Callback URL not allowed")
# sort the datasets and distributions tags to avoid problems with the rdf parser
dataset_start = [m.start() for m in re.finditer('(?=<dcat:Dataset)', xml)]
dataset_finish = [m.start() for m in re.finditer('(?=</dcat:Dataset>)', xml)]
if len(dataset_start) != len(dataset_finish):
raise HTTPException(status_code=400, detail="Could not sort datasets")
distribution_start = [m.start() for m in re.finditer('(?=<dcat:distribution>)', xml)]
distribution_finish = [m.start() for m in re.finditer('(?=</dcat:distribution>)', xml)]
if len(distribution_start) != len(distribution_finish):
raise HTTPException(status_code=400, detail="Could not sort distributions")
# on rdf files the xml tag is not always present, so it is necessary to check if it is present and if it is not
# the rdf files is always present, and need to be added for parsing, even with xml tag if present
# if xml tag is present, the closing of rdf tag is the second '>' present in the file otherwise it is the first one (closing_index)
closing_index = 2
if xml.rfind('<?xml', None, 10) == -1:
closing_index = 1
pre = xml[:find_nth(xml,'>',closing_index) ] + '>'
# check if the xml is valid
test_string = pre + xml[dataset_start[0]:dataset_finish[0]+15] + '</rdf:RDF>'
dt_copy = xml
if xml.rfind('<dcat:Catalog ') != -1:
# cut off all the tags on catalogue level, and leave just the tags on dataset level to analyze them separately
for index, item in enumerate(dataset_start):
dataset_Tag = xml[dataset_start[index]:dataset_finish[index]+15]
# create a copy with just the catalogue tags to analyze them separately
dt_copy = dt_copy.replace(dataset_Tag, '')
else:
# cut off all the tags on datasets level, and leave just the tags on distribution level to analyze them separately
for index, item in enumerate(dataset_start):
distr_tag = xml[distribution_start[index]:distribution_finish[index]+20]
# cut off the distribution tag from the dataset string to obtain just the dataset properties to analyze them separately
dt_copy = dt_copy.replace(distr_tag, '')
dt_copy = dt_copy.replace(dt_copy[dt_copy.rfind('<adms:identifier>'):dt_copy.rfind('</adms:identifier>')+18], '')
try:
g = Graph()
g.parse(data = test_string, format="application/rdf+xml")
g = Graph()
g.parse(data = dt_copy, format="application/rdf+xml")
except:
logger.exception("Error while processing request")
raise HTTPException(status_code=400, detail="Could not parse xml")
title = ""
# gets the title of the catalogue
for sub, pred, obj in g:
met = str_metric(pred, g)
if met == "dct:title":
title = obj
break
# an explicit title (e.g. the catalogue name passed by Idra) is authoritative
# and overrides the unreliable RDF-parsed title
if configuration_inputs.title:
title = configuration_inputs.title
# Get the database
try:
dbname = get_database()
collection_name = dbname["mqa"]
now = datetime.now(timezone.utc)
# print(configuration_inputs.id)
# If an id was supplied but its document no longer exists (e.g. it was
# deleted), fall back to creating a new analysis so re-submission still works.
if configuration_inputs.id is not None \
and collection_name.find_one({'_id': ObjectId(configuration_inputs.id)}) is None:
configuration_inputs.id = None
# check if the id is present, if it is not, it creates a new item in the db
if configuration_inputs.id == None:
if xml.rfind('<dcat:Catalog ') != -1:
type = "catalogue"
else:
type = "dataset"
new_item = {
"creation_date" : now.strftime("%d/%m/%Y %H:%M:%S"),
"last_modified" : now.strftime("%d/%m/%Y %H:%M:%S"),
"type": type,
"title": title,
"history": []
}
inserted_item = collection_name.insert_one(new_item)
id = str(inserted_item.inserted_id)
else:
id = configuration_inputs.id
# take the element in db by id and check if types correspond
type = collection_name.find_one({'_id': ObjectId(id)})["type"]
if xml.rfind('<dcat:Catalog ') != -1 and type == "dataset":
raise HTTPException(status_code=400, detail="The file is a catalogue, but the id is from a dataset")
elif xml.rfind('<dcat:Catalog ') == -1 and type == "catalogue":
raise HTTPException(status_code=400, detail="The file is a dataset, but the id is from a catalogue")
# check if in the db there are already 5 analisys, if yes, it deletes the oldest one
if collection_name.find_one({'_id': ObjectId(id)})["history"] != None and len(collection_name.find_one({'_id': ObjectId(id)})["history"]) > 4:
collection_name.update_one({'_id': ObjectId(id)}, {'$pop': {"history": -1}})
collection_name.update_one({'_id': ObjectId(id)}, {'$set': {"last_modified": now.strftime("%d/%m/%Y %H:%M:%S")}})
except:
logger.exception("Error while processing request")
id = None
collection_name = None
# start the analisys in background
background_tasks.add_task(run_analysis, xml, pre, dataset_start, dataset_finish, configuration_inputs.url, collection_name, id, configuration_inputs.id == None)
# send the response to the user
if configuration_inputs.id != None:
return {"message": "The request has been accepted"}
else:
return {"message": "The request has been accepted", "id" : id}
except HTTPException:
raise
except Exception:
logger.exception("Error while processing request")
raise HTTPException(status_code=500, detail="Internal Server Error")
# Auth model
class Options(BaseModel):
file_url: str = None
url: Optional[str] = None
id: Optional[str] = None
title: Optional[str] = None
# api to start a new analisys and save on db the results for both case catalogue and dataset
# accept only rdf files, as string or by url, or by file in the submit/file api
# can specify the id of the catalogue or dataset if it was already created before
# the analisys can be long, so it is sent to the user a message that the request has been accepted and if new analisys it also returns the id of the new catalogue or dataset
@submitRouter.post("/auth")
async def useCaseConfigurator(options: Options, background_tasks: BackgroundTasks):
try:
configuration_inputs = options
except Exception as e:
logger.exception("Error while processing request")
raise HTTPException(status_code=400, detail="Inputs not valid")
try:
if configuration_inputs.file_url == None:
raise HTTPException(status_code=400, detail="Inputs not valid")
else:
try:
status, xml = await safe_fetch_text(configuration_inputs.file_url)
except UnsafeUrlError:
raise HTTPException(status_code=400, detail="URL not allowed")
except FetchTooLargeError:
raise HTTPException(status_code=413, detail="Remote file too large")
except Exception:
logger.exception("Error while processing request")
raise HTTPException(status_code=401, detail="Authentication error")
if status != 200:
raise HTTPException(status_code=401, detail="Authentication error")
try:
assert_safe_xml(xml)
except UnsafeXmlError:
raise HTTPException(status_code=400, detail="XML payload rejected")
if configuration_inputs.url != None:
try:
validate_url(configuration_inputs.url)
except UnsafeUrlError:
raise HTTPException(status_code=400, detail="Callback URL not allowed")
# sort the datasets and distributions tags to avoid problems with the rdf parser
dataset_start = [m.start() for m in re.finditer('(?=<dcat:Dataset)', xml)]
dataset_finish = [m.start() for m in re.finditer('(?=</dcat:Dataset>)', xml)]
if len(dataset_start) != len(dataset_finish):
raise HTTPException(status_code=400, detail="Could not sort datasets")
distribution_start = [m.start() for m in re.finditer('(?=<dcat:distribution>)', xml)]
distribution_finish = [m.start() for m in re.finditer('(?=</dcat:distribution>)', xml)]
if len(distribution_start) != len(distribution_finish):
raise HTTPException(status_code=400, detail="Could not sort distributions")
# on rdf files the xml tag is not always present, so it is necessary to check if it is present and if it is not
# the rdf files is always present, and need to be added for parsing, even with xml tag if present
# if xml tag is present, the closing of rdf tag is the second '>' present in the file otherwise it is the first one (closing_index)
closing_index = 2
if xml.rfind('<?xml', None, 10) == -1:
closing_index = 1
pre = xml[:find_nth(xml,'>',closing_index) ] + '>'
# check if the xml is valid
test_string = pre + xml[dataset_start[0]:dataset_finish[0]+15] + '</rdf:RDF>'
dt_copy = xml
if xml.rfind('<dcat:Catalog ') != -1:
# cut off all the tags on catalogue level, and leave just the tags on dataset level to analyze them separately
for index, item in enumerate(dataset_start):
dataset_Tag = xml[dataset_start[index]:dataset_finish[index]+15]
# create a copy with just the catalogue tags to analyze them separately
dt_copy = dt_copy.replace(dataset_Tag, '')
else:
# cut off all the tags on datasets level, and leave just the tags on distribution level to analyze them separately
for index, item in enumerate(dataset_start):
distr_tag = xml[distribution_start[index]:distribution_finish[index]+20]
# cut off the distribution tag from the dataset string to obtain just the dataset properties to analyze them separately
dt_copy = dt_copy.replace(distr_tag, '')
dt_copy = dt_copy.replace(dt_copy[dt_copy.rfind('<adms:identifier>'):dt_copy.rfind('</adms:identifier>')+18], '')
try:
g = Graph()
g.parse(data = test_string, format="application/rdf+xml")
g = Graph()
g.parse(data = dt_copy, format="application/rdf+xml")
except:
logger.exception("Error while processing request")
raise HTTPException(status_code=400, detail="Could not parse xml")
title = ""
# gets the title of the catalogue
for sub, pred, obj in g:
met = str_metric(pred, g)
if met == "dct:title":
title = obj
break
# an explicit title (e.g. the catalogue name passed by Idra) is authoritative
# and overrides the unreliable RDF-parsed title
if configuration_inputs.title:
title = configuration_inputs.title
# Get the database
try:
dbname = get_database()
collection_name = dbname["mqa"]
now = datetime.now(timezone.utc)
# print(configuration_inputs.id)
# If an id was supplied but its document no longer exists (e.g. it was
# deleted), fall back to creating a new analysis so re-submission still works.
if configuration_inputs.id is not None \
and collection_name.find_one({'_id': ObjectId(configuration_inputs.id)}) is None:
configuration_inputs.id = None
# check if the id is present, if it is not, it creates a new item in the db
if configuration_inputs.id == None:
if xml.rfind('<dcat:Catalog ') != -1:
type = "catalogue"
else:
type = "dataset"
new_item = {
"creation_date" : now.strftime("%d/%m/%Y %H:%M:%S"),
"last_modified" : now.strftime("%d/%m/%Y %H:%M:%S"),
"type": type,
"title": title,
"history": []
}
inserted_item = collection_name.insert_one(new_item)
id = str(inserted_item.inserted_id)
else:
id = configuration_inputs.id
# take the element in db by id and check if types correspond
type = collection_name.find_one({'_id': ObjectId(id)})["type"]
if xml.rfind('<dcat:Catalog ') != -1 and type == "dataset":
raise HTTPException(status_code=400, detail="The file is a catalogue, but the id is from a dataset")
elif xml.rfind('<dcat:Catalog ') == -1 and type == "catalogue":
raise HTTPException(status_code=400, detail="The file is a dataset, but the id is from a catalogue")
# check if in the db there are already 5 analisys, if yes, it deletes the oldest one
if collection_name.find_one({'_id': ObjectId(id)})["history"] != None and len(collection_name.find_one({'_id': ObjectId(id)})["history"]) > 4:
collection_name.update_one({'_id': ObjectId(id)}, {'$pop': {"history": -1}})
collection_name.update_one({'_id': ObjectId(id)}, {'$set': {"last_modified": now.strftime("%d/%m/%Y %H:%M:%S")}})
except:
logger.exception("Error while processing request")
id = None
collection_name = None
# start the analisys in background
background_tasks.add_task(run_analysis, xml, pre, dataset_start, dataset_finish, configuration_inputs.url, collection_name, id, configuration_inputs.id == None)
# send the response to the user
if configuration_inputs.id != None:
return {"message": "The request has been accepted"}
else:
return {"message": "The request has been accepted", "id" : id}
except HTTPException:
raise
except Exception:
logger.exception("Error while processing request")
raise HTTPException(status_code=500, detail="Internal Server Error")
# api to start a new analisys and save on db the results for both case catalogue and single dataset
# accept only rdf files as file (format-data). Can be sent as string or by url in the /submit api
# can specify the id of the catalogue or dataset if it was already created before
# the analisys can be long, so it is sent to the user a message that the request has been accepted and if new analisys it also returns the id of the new catalogue or dataset
@submitRouter.post("/file")
async def useCaseConfigurator(background_tasks: BackgroundTasks, file: UploadFile = File(...), url: Optional[str] = None, id: Optional[str] = None):
try:
chunks = []
size = 0
while True:
chunk = file.file.read(1024 * 1024)
if not chunk:
break
size += len(chunk)
if size > MAX_UPLOAD_BYTES:
raise HTTPException(status_code=413, detail="File too large")
chunks.append(chunk)
xml = b"".join(chunks).decode("utf-8")
file.file.close()
try:
assert_safe_xml(xml)
except UnsafeXmlError:
raise HTTPException(status_code=400, detail="XML payload rejected")
if url != None:
try:
validate_url(url)
except UnsafeUrlError:
raise HTTPException(status_code=400, detail="Callback URL not allowed")
# sort the datasets and distributions tags to avoid problems with the rdf parser
try:
dataset_start = [m.start() for m in re.finditer('(?=<dcat:Dataset)', xml)]
dataset_finish = [m.start() for m in re.finditer('(?=</dcat:Dataset>)', xml)]
if len(dataset_start) != len(dataset_finish):
raise HTTPException(status_code=400, detail="Could not sort datasets")
distribution_start = [m.start() for m in re.finditer('(?=<dcat:distribution>)', xml)]
distribution_finish = [m.start() for m in re.finditer('(?=</dcat:distribution>)', xml)]
if len(distribution_start) != len(distribution_finish):
raise HTTPException(status_code=400, detail="Could not sort distributions")
# on rdf files the xml tag is not always present, so it is necessary to check if it is present and if it is not
# the rdf files is always present, and need to be added for parsing, even with xml tag if present
# if xml tag is present, the closing of rdf tag is the second '>' present in the file otherwise it is the first one (closing_index)
closing_index = 2
if xml.rfind('<?xml', None, 10) == -1:
closing_index = 1
pre = xml[:find_nth(xml,'>',closing_index) ] + '>'
# check if the xml is valid
test_string = pre + xml[dataset_start[0]:dataset_finish[0]+15] + '</rdf:RDF>'
dt_copy = xml
if xml.rfind('<dcat:Catalog ') != -1:
# cut off all the tags on catalogue level, and leave just the tags on dataset level to analyze them separately
for index, item in enumerate(dataset_start):
dataset_Tag = xml[dataset_start[index]:dataset_finish[index]+15]
# create a copy with just the catalogue tags to analyze them separately
dt_copy = dt_copy.replace(dataset_Tag, '')
else:
# cut off all the tags on datasets level, and leave just the tags on distribution level to analyze them separately
for index, item in enumerate(dataset_start):
distr_tag = xml[distribution_start[index]:distribution_finish[index]+20]
# cut off the distribution tag from the dataset string to obtain just the dataset properties to analyze them separately
dt_copy = dt_copy.replace(distr_tag, '')
dt_copy = dt_copy.replace(dt_copy[dt_copy.rfind('<adms:identifier>'):dt_copy.rfind('</adms:identifier>')+18], '')
try:
g = Graph()
g.parse(data = test_string, format="application/rdf+xml")
g = Graph()
g.parse(data = dt_copy, format="application/rdf+xml")
except:
logger.exception("Error while processing request")
raise HTTPException(status_code=400, detail="Could not parse xml")
title = ""
# gets the title of the catalogue
for sub, pred, obj in g:
met = str_metric(pred, g)
if met == "dct:title":
title = obj
break
# Get the database
try:
# check if the id is present, if it is not, it creates a new item in the db
dbname = get_database()
collection_name = dbname["mqa"]
now = datetime.now(timezone.utc)
if id == None:
if xml.rfind('<dcat:Catalog ') != -1:
type = "catalogue"
else:
type = "dataset"
new_item = {
"creation_date" : now.strftime("%d/%m/%Y %H:%M:%S"),
"last_modified" : now.strftime("%d/%m/%Y %H:%M:%S"),
"type": type,
"title": title,
"history": []
}
inserted_item = collection_name.insert_one(new_item)
new_id = str(inserted_item.inserted_id)
else:
new_id = id
# take the element in db by id and check if types correspond
type = collection_name.find_one({'_id': ObjectId(new_id)})["type"]
if xml.rfind('<dcat:Catalog ') != -1 and type == "dataset":
raise HTTPException(status_code=400, detail="The file is a catalogue, but the id is from a dataset")
elif xml.rfind('<dcat:Catalog ') == -1 and type == "catalogue":
raise HTTPException(status_code=400, detail="The file is a dataset, but the id is from a catalogue")
# check if in the db there are already 5 analisys, if yes, it deletes the oldest one
if collection_name.find_one({'_id': ObjectId(new_id)})["history"] != None and len(collection_name.find_one({'_id': ObjectId(new_id)})["history"]) > 4:
collection_name.update_one({'_id': ObjectId(new_id)}, {'$pop': {"history": -1}})
collection_name.update_one({'_id': ObjectId(new_id)}, {'$set': {"last_modified": now.strftime("%d/%m/%Y %H:%M:%S")}})
except:
logger.exception("Error while processing request")
new_id = None
collection_name = None
# start the analisys in background
background_tasks.add_task(run_analysis, xml, pre, dataset_start, dataset_finish, url, collection_name, new_id, id == None)
# send the response to the user
if id != None:
return {"message": "The request has been accepted"}
else:
return {"message": "The request has been accepted", "id" : new_id}
except HTTPException:
raise
except Exception:
logger.exception("Error while processing request")
raise HTTPException(status_code=500, detail="Internal Server Error")
except HTTPException:
raise
except Exception:
logger.exception("There was an error uploading the file")
raise HTTPException(status_code=500, detail="There was an error uploading the file")
# background task wrapper: logs failures and removes the just-created db item
# if the analysis never produced a history entry (avoids orphan documents)
#
# NOTE: this is a *synchronous* def on purpose. Starlette runs sync BackgroundTask
# callbacks in a worker thread (run_in_threadpool), whereas async callbacks run on
# the main event loop. The analysis performs many BLOCKING external HTTP calls
# (accessURL/downloadURL status checks, SHACL validation) via requests; running it
# on the event loop would freeze the whole service until every URL times out.
# Driving main() with asyncio.run() inside the worker thread keeps the HTTP server
# responsive while a (potentially long) analysis is in progress.
def run_analysis(xml, pre, dataset_start, dataset_finish, url, collection_name, id, created_new):
try:
asyncio.run(main(xml, pre, dataset_start, dataset_finish, url, collection_name, id))
except Exception:
logger.exception("Analysis failed")
if created_new and collection_name is not None and id is not None:
try:
doc = collection_name.find_one({'_id': ObjectId(id)})
if doc is not None and not doc.get("history"):
collection_name.delete_one({'_id': ObjectId(id)})
except Exception:
logger.exception("Failed to clean up orphan document")
# main function,
async def main(xml, pre, dataset_start, dataset_finish, url, collection_name, id):
# if the file is a catalogue, it needs to be analyzed on catalogue level, otherwise it needs to be analyzed just on dataset level
if xml.rfind('<dcat:Catalog ') != -1:
class Object(object):
pass
response = Object()
response.datasets = []
response.title = ''
dt_copy = xml
# cut off all the tags on catalogue level, and leave just the tags on dataset level to analyze them separately
for index, item in enumerate(dataset_start):
# variable pre is always required from rdf files and it contains at least the rdf tag: <rdf:RDF ...> and can also contain the xml tag: <?xml version="1.0"?>
dataset = pre + xml[dataset_start[index]:dataset_finish[index]+15] + '</rdf:RDF>'
result = dataset_calc(dataset, pre)
response.datasets.append(result)
dataset_Tag = xml[dataset_start[index]:dataset_finish[index]+15]
# create a copy with just the catalogue tags to analyze them separately
dt_copy = dt_copy.replace(dataset_Tag, '')
g = Graph()
g.parse(data = dt_copy, format="application/rdf+xml")
# gets the title of the catalogue
for sub, pred, obj in g:
met = str_metric(pred, g)
if met == "dct:title":
response.title = obj
break
# initial values to avoid some properties are missing
response.issued = 0
response.modified = 0
response.keyword = 0
response.theme = 0
response.spatial = 0
response.temporal = 0
response.contactPoint = 0
response.publisher = 0
response.accessRights = 0
response.accessRightsVocabulary = 0
response.accessURL = []
response.accessURL_Perc = 0
response.downloadURL = 0
response.downloadURLResponseCode = []
response.downloadURLResponseCode_Perc = 0
response.format = 0
response.dctFormat_dcatMediaType = 0
response.formatMachineReadable = 0
response.formatNonProprietary = 0
response.license = 0
response.licenseVocabulary = 0
response.mediaType = 0
response.rights = 0
response.byteSize = 0
response.shacl_validation = 0
response.score = {}
countDataset = 0
countDistr = 0
tempArrayDownloadUrl = []
tempArrayAccessUrl = []
# iterate over the datasets metrics to count positive values
for dataset in response.datasets:
countDataset += 1
if dataset.issuedDataset == True:
response.issued += 1
del dataset.issuedDataset
if dataset.modifiedDataset == True:
response.modified += 1
del dataset.modifiedDataset
if dataset.accessRights == True:
response.accessRights += 1
if dataset.accessRightsVocabulary == True:
response.accessRightsVocabulary += 1
if dataset.contactPoint == True:
response.contactPoint += 1
if dataset.publisher == True:
response.publisher += 1
if dataset.keyword == True:
response.keyword += 1
if dataset.theme == True:
response.theme += 1
if dataset.spatial == True:
response.spatial += 1
if dataset.temporal == True:
response.temporal += 1
if dataset.shacl_validation == True:
response.shacl_validation += 1
for distr in dataset.distributions:
countDistr += 1
if distr.issued == True:
response.issued += 1
if distr.modified == True:
response.modified += 1
if distr.byteSize == True:
response.byteSize += 1
if distr.rights == True:
response.rights += 1
if distr.license == True:
response.license += 1
if distr.licenseVocabulary == True:
response.licenseVocabulary += 1
if distr.downloadURL == True:
response.downloadURL += 1
tempArrayDownloadUrl.append(distr.downloadURLResponseCode)
tempArrayAccessUrl.append(distr.accessURL)
if distr.format == True:
response.format += 1
if distr.formatMachineReadable == True:
response.formatMachineReadable += 1
if distr.formatNonProprietary == True:
response.formatNonProprietary += 1
if distr.mediaType == True:
response.mediaType += 1
if distr.dctFormat_dcatMediaType == True:
response.dctFormat_dcatMediaType += 1
# percentage calculations, based on distributions counts
if(countDistr > 0):
response.byteSize = round(response.byteSize / countDistr * 100)
response.rights = round(response.rights / countDistr * 100)
response.license = round(response.license / countDistr * 100)
response.downloadURL = round(response.downloadURL / countDistr * 100)
list_unique = (list(set(tempArrayDownloadUrl)))
for el in list_unique:
if el in range(200, 399):
response.downloadURLResponseCode_Perc += round(tempArrayDownloadUrl.count(el) / countDistr * 100)
response.downloadURLResponseCode.append({"code": el, "percentage": round(tempArrayDownloadUrl.count(el) / countDistr * 100)})
list_unique = (list(set(tempArrayAccessUrl)))
for el in list_unique:
if el in range(200, 399):
response.accessURL_Perc += round(tempArrayAccessUrl.count(el) / countDistr * 100)
response.accessURL.append({"code": el, "percentage": round(tempArrayAccessUrl.count(el) / countDistr * 100)})
response.format = round(response.format / countDistr * 100)
response.formatMachineReadable = round(response.formatMachineReadable / countDistr * 100)
response.formatNonProprietary = round(response.formatNonProprietary / countDistr * 100)
response.mediaType = round(response.mediaType / countDistr * 100)
response.dctFormat_dcatMediaType = round(response.dctFormat_dcatMediaType / (countDistr*2) * 100)
if(countDataset > 0):
response.accessRights = round(response.accessRights / countDataset * 100)
response.contactPoint = round(response.contactPoint / countDataset * 100)
response.publisher = round(response.publisher / countDataset * 100)
response.keyword = round(response.keyword / countDataset * 100)
response.theme = round(response.theme / countDataset * 100)
response.spatial = round(response.spatial / countDataset * 100)
response.temporal = round(response.temporal / countDataset * 100)
response.shacl_validation = round(response.shacl_validation / countDataset * 100)
if(countDistr + countDataset > 0):
response.issued = round(response.issued / (countDataset + countDistr) * 100)
response.modified = round(response.modified / (countDataset + countDistr) * 100)
if(response.license > 0):
response.licenseVocabulary = round(response.licenseVocabulary / response.license * 100)
if(response.accessRights > 0):
response.accessRightsVocabulary = round(response.accessRightsVocabulary / response.accessRights * 100)
weights = Object()
# weights
# full list of weight can be found https://data.europa.eu/mqa/methodology?locale=en
weights.keyword_Weight = math.ceil(30 / 100 * response.keyword)
weights.theme_Weight = math.ceil(30 / 100 * response.theme)
weights.spatial_Weight = math.ceil(20 / 100 * response.spatial)
weights.temporal_Weight = math.ceil(20 / 100 * response.temporal)
weights.contactPoint_Weight = math.ceil(20 / 100 * response.contactPoint)
weights.publisher_Weight = math.ceil(10 / 100 * response.publisher)
weights.accessRights_Weight = math.ceil(10 / 100 * response.accessRights)
weights.accessRightsVocabulary_Weight = math.ceil(5 / 100 * response.accessRightsVocabulary)
weights.accessURL_Weight = math.ceil(50 / 100 * response.accessURL_Perc)
weights.downloadURL_Weight = math.ceil(20 / 100 * response.downloadURL)
weights.downloadURLResponseCode_Weight = math.ceil(30 / 100 * response.downloadURLResponseCode_Perc)
weights.format_Weight = math.ceil(20 / 100 * response.format)
weights.dctFormat_dcatMediaType_Weight = math.ceil(10 / 100 * response.dctFormat_dcatMediaType)
weights.formatMachineReadable_Weight = math.ceil(20 / 100 * response.formatMachineReadable)
weights.formatNonProprietary_Weight = math.ceil(20 / 100 * response.formatNonProprietary)
weights.license_Weight = math.ceil(20 / 100 * response.license)
weights.licenseVocabulary_Weight = math.ceil(10 / 100 * response.licenseVocabulary)
weights.mediaType_Weight = math.ceil(10 / 100 * response.mediaType)
weights.rights_Weight = math.ceil(5 / 100 * response.rights)
weights.byteSize_Weight = math.ceil(5 / 100 * response.byteSize)
weights.issued_Weight = math.ceil(5 / 100 * response.issued)
weights.modified_Weight = math.ceil(5 / 100 * response.modified)
weights.shacl_validation_Weight = math.ceil(30 / 100 * response.shacl_validation)
weights.findability = weights.keyword_Weight + weights.theme_Weight + weights.spatial_Weight + weights.temporal_Weight
weights.accessibility = weights.accessURL_Weight + weights.downloadURL_Weight + weights.downloadURLResponseCode_Weight
weights.interoperability = weights.format_Weight + weights.dctFormat_dcatMediaType_Weight + weights.formatMachineReadable_Weight + weights.formatNonProprietary_Weight + weights.mediaType_Weight + weights.shacl_validation_Weight
weights.reusability = weights.license_Weight + weights.licenseVocabulary_Weight + weights.contactPoint_Weight + weights.publisher_Weight + weights.accessRights_Weight + weights.accessRightsVocabulary_Weight
weights.contextuality = weights.rights_Weight + weights.byteSize_Weight + weights.issued_Weight + weights.modified_Weight
weights.overall = weights.findability + weights.accessibility + weights.interoperability + weights.reusability + weights.contextuality
response.score = weights.__dict__
else:
# if the file is a dataset, it needs to be analyzed on dataset level
response = dataset_calc(xml, pre)
class EmployeeEncoder(json.JSONEncoder):
def default(self, o):
return o.__dict__
# if the file is a catalogue and id is provided, it updates the catalogue history
# id should not be none because if user did not provide it, it is generated by the system before calling main function
if id != None and xml.rfind('<dcat:Catalog ') != -1:
now = datetime.now(timezone.utc)
collection_name.update_one({'_id': ObjectId(id)}, {'$push': {"history": { "created_at": now.strftime("%d/%m/%Y %H:%M:%S"),"catalogue":json.loads(json.dumps(response, indent=4, cls=EmployeeEncoder)) } }})
s3_saveFile(id, json.dumps(response, indent=4, cls=EmployeeEncoder))
# if the file is a dataset and id is provided, it updates the dataset history
elif id != None and xml.rfind('<dcat:Catalog ') == -1:
now = datetime.now(timezone.utc)
collection_name.update_one({'_id': ObjectId(id)}, {'$push': {"history": { "created_at": now.strftime("%d/%m/%Y %H:%M:%S"),"dataset":json.loads(json.dumps(response, indent=4, cls=EmployeeEncoder)) } }})
s3_saveFile(id, json.dumps(response, indent=4, cls=EmployeeEncoder))
# if url is provided, it sends the results of analisys to the url
if url != None:
try:
return await safe_post_json(url, json.dumps(response, indent=4, cls=EmployeeEncoder))
except Exception:
logger.exception("Failed to deliver analysis result to callback URL")
return None
else:
return response