/
rdf.py
988 lines (869 loc) · 41.5 KB
/
rdf.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
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
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
# Copyright (c) 2014 Ahmed H. Ismail
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
# http://www.apache.org/licenses/LICENSE-2.0
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
from __future__ import absolute_import
from __future__ import print_function
from __future__ import unicode_literals
import re
import six
from six.moves import reduce
from rdflib import Graph
from rdflib import Namespace
from rdflib import RDF
from rdflib import RDFS
from spdx import document
from spdx import utils
from spdx.parsers.builderexceptions import CardinalityError
from spdx.parsers.builderexceptions import SPDXValueError
ERROR_MESSAGES = {
'DOC_VERS_VALUE': 'Invalid specVersion \'{0}\' must be SPDX-M.N where M and N are numbers.',
'DOC_D_LICS': 'Invalid dataLicense \'{0}\' must be http://spdx.org/licenses/CC0-1.0.',
'DOC_SPDX_ID_VALUE': 'Invalid SPDXID value, SPDXID must be the document namespace appended '
'by "#SPDXRef-DOCUMENT", line: {0}',
'DOC_NAMESPACE_VALUE': 'Invalid DocumentNamespace value {0}, must contain a scheme (e.g. "https:") '
'and should not contain the "#" delimiter.',
'LL_VALUE': 'Invalid licenseListVersion \'{0}\' must be of the format N.N where N is a number',
'CREATED_VALUE': 'Invalid created value \'{0}\' must be date in ISO 8601 format.',
'CREATOR_VALUE': 'Invalid creator value \'{0}\' must be Organization, Tool or Person.',
'EXT_DOC_REF_VALUE': 'Failed to extract {0} from ExternalDocumentRef.',
'PKG_SUPPL_VALUE': 'Invalid package supplier value \'{0}\' must be Organization, Person or NOASSERTION.',
'PKG_ORIGINATOR_VALUE': 'Invalid package supplier value \'{0}\' must be Organization, Person or NOASSERTION.',
'PKG_DOWN_LOC': 'Invalid package download location value \'{0}\' must be a url or NONE or NOASSERTION',
'PKG_CONC_LIST': 'Package concluded license list must have more than one member',
'LICS_LIST_MEMBER' : 'Declaritive or Conjunctive license set member must be a license url or identifier',
'PKG_SINGLE_LICS' : 'Package concluded license must be a license url or spdx:noassertion or spdx:none.',
'PKG_LICS_INFO_FILES' : 'Package licenseInfoFromFiles must be a license or spdx:none or spdx:noassertion',
'FILE_SPDX_ID_VALUE': 'SPDXID must be "SPDXRef-[idstring]" where [idstring] is a unique string containing '
'letters, numbers, ".", "-".',
'FILE_TYPE' : 'File type must be binary, other, source or archive term.',
'FILE_SINGLE_LICS': 'File concluded license must be a license url or spdx:noassertion or spdx:none.',
'REVIEWER_VALUE' : 'Invalid reviewer value \'{0}\' must be Organization, Tool or Person.',
'REVIEW_DATE' : 'Invalid review date value \'{0}\' must be date in ISO 8601 format.',
'ANNOTATOR_VALUE': 'Invalid annotator value \'{0}\' must be Organization, Tool or Person.',
'ANNOTATION_DATE': 'Invalid annotation date value \'{0}\' must be date in ISO 8601 format.'
}
class BaseParser(object):
"""
Base class for all parsers.
Contains logger, doap_namespace, spdx_namespace and model builder.
Also provides utility functions used by the deriving parsers.
"""
def __init__(self, builder, logger):
self.logger = logger
self.doap_namespace = Namespace('http://usefulinc.com/ns/doap#')
self.spdx_namespace = Namespace("http://spdx.org/rdf/terms#")
self.builder = builder
def more_than_one_error(self, field):
"""Logs a more than one error.
field is the field/property that has more than one defined.
"""
msg = 'More than one {0} defined.'.format(field)
self.logger.log(msg)
self.error = True
def value_error(self, key, bad_value):
"""Reports a value error using ERROR_MESSAGES dict.
key - key to use for ERROR_MESSAGES.
bad_value - is passed to format which is called on what key maps to
in ERROR_MESSAGES.
"""
msg = ERROR_MESSAGES[key].format(bad_value)
self.logger.log(msg)
self.error = True
def to_special_value(self, value):
"""Checks if value is a special SPDX value such as
NONE, NOASSERTION or UNKNOWN if so returns proper model.
else returns value"""
if value == self.spdx_namespace.none:
return utils.SPDXNone()
elif value == self.spdx_namespace.noassertion:
return utils.NoAssert()
elif value == self.spdx_namespace.unknown:
return utils.UnKnown()
else:
return value
class LicenseParser(BaseParser):
"""
Helper class for parsing extracted licenses and license lists.
"""
LICS_REF_REGEX = re.compile('LicenseRef-.+', re.UNICODE)
def __init__(self, builder, logger):
super(LicenseParser, self).__init__(builder, logger)
def handle_lics(self, lics):
"""
Return a License from a `lics` license resource.
"""
# Handle extracted licensing info type.
if (lics, RDF.type, self.spdx_namespace['ExtractedLicensingInfo']) in self.graph:
return self.parse_only_extr_license(lics)
# Assume resource, hence the path separator
ident_start = lics.rfind('/') + 1
if ident_start == 0:
# special values such as spdx:noassertion
special = self.to_special_value(lics)
if special == lics:
if self.LICS_REF_REGEX.match(lics):
# Is a license ref i.e LicenseRef-1
return document.License.from_identifier(lics)
else:
# Not a known license form
raise SPDXValueError('License')
else:
# is a special value
return special
else:
# license url
return document.License.from_identifier(lics[ident_start:])
def get_extr_license_ident(self, extr_lic):
"""
Return an a license identifier from an ExtractedLicense or None.
"""
identifier_tripples = list(self.graph.triples((extr_lic, self.spdx_namespace['licenseId'], None)))
if not identifier_tripples:
self.error = True
msg = 'Extracted license must have licenseId property.'
self.logger.log(msg)
return
if len(identifier_tripples) > 1:
self.more_than_one_error('extracted license identifier_tripples')
return
identifier_tripple = identifier_tripples[0]
_s, _p, identifier = identifier_tripple
return identifier
def get_extr_license_text(self, extr_lic):
"""
Return extracted text from an ExtractedLicense or None.
"""
text_tripples = list(self.graph.triples((extr_lic, self.spdx_namespace['extractedText'], None)))
if not text_tripples:
self.error = True
msg = 'Extracted license must have extractedText property'
self.logger.log(msg)
return
if len(text_tripples) > 1:
self.more_than_one_error('extracted license text')
return
text_tripple = text_tripples[0]
_s, _p, text = text_tripple
return text
def get_extr_lic_name(self, extr_lic):
"""
Return the license name from an ExtractedLicense or None
"""
extr_name_list = list(self.graph.triples((extr_lic, self.spdx_namespace['licenseName'], None)))
if len(extr_name_list) > 1:
self.more_than_one_error('extracted license name')
return
elif len(extr_name_list) == 0:
return
return self.to_special_value(extr_name_list[0][2])
def get_extr_lics_xref(self, extr_lic):
"""
Return a list of cross references.
"""
xrefs = list(self.graph.triples((extr_lic, RDFS.seeAlso, None)))
return map(lambda xref_triple: xref_triple[2], xrefs)
def get_extr_lics_comment(self, extr_lics):
"""
Return license comment or None.
"""
comment_list = list(self.graph.triples(
(extr_lics, RDFS.comment, None)))
if len(comment_list) > 1 :
self.more_than_one_error('extracted license comment')
return
elif len(comment_list) == 1:
return comment_list[0][2]
else:
return
def parse_only_extr_license(self, extr_lic):
"""
Return an ExtractedLicense object to represent a license object.
But does not add it to the SPDXDocument model.
Return None if failed.
"""
# Grab all possible values
ident = self.get_extr_license_ident(extr_lic)
text = self.get_extr_license_text(extr_lic)
comment = self.get_extr_lics_comment(extr_lic)
xrefs = self.get_extr_lics_xref(extr_lic)
name = self.get_extr_lic_name(extr_lic)
if not ident:
# Must have identifier
return
# Set fields
# FIXME: the constructor of the license should alwas accept a name
lic = document.ExtractedLicense(ident)
if text is not None:
lic.text = text
if name is not None:
lic.full_name = name
if comment is not None:
lic.comment = comment
lic.cross_ref = map(lambda x: six.text_type(x), xrefs)
return lic
def handle_extracted_license(self, extr_lic):
"""
Build and return an ExtractedLicense or None.
Note that this function adds the license to the document.
"""
lic = self.parse_only_extr_license(extr_lic)
if lic is not None:
self.doc.add_extr_lic(lic)
return lic
def _handle_license_list(self, lics_set, cls=None):
"""
Return a license representing a `cls` object (LicenseConjunction
or LicenseDisjunction) from a list of license resources or None.
"""
licenses = []
for _, _, lics_member in self.graph.triples(
(lics_set, self.spdx_namespace['member'], None)):
try:
if (lics_member, RDF.type, self.spdx_namespace['ExtractedLicensingInfo']) in self.graph:
lics = self.handle_extracted_license(lics_member)
if lics is not None:
licenses.append(lics)
else:
licenses.append(self.handle_lics(lics_member))
except CardinalityError:
self.value_error('LICS_LIST_MEMBER', lics_member)
break
if len(licenses) > 1:
return reduce(lambda a, b: cls(a, b), licenses)
else:
self.value_error('PKG_CONC_LIST', '')
return
def handle_conjunctive_list(self, lics_set):
"""
Return a license representing the conjunction from a list of
license resources or None.
"""
return self._handle_license_list(lics_set, cls=document.LicenseConjunction)
def handle_disjunctive_list(self, lics_set):
"""
Return a license representing the disjunction from a list of
license resources or None.
"""
return self._handle_license_list(lics_set, cls=document.LicenseDisjunction)
class PackageParser(LicenseParser):
"""
Helper class for parsing packages.
"""
def __init__(self, builder, logger):
super(PackageParser, self).__init__(builder, logger)
def parse_package(self, p_term):
"""Parses package fields."""
# Check there is a pacakge name
if not (p_term, self.spdx_namespace['name'], None) in self.graph:
self.error = True
self.logger.log('Package must have a name.')
# Create dummy package so that we may continue parsing the rest of
# the package fields.
self.builder.create_package(self.doc, 'dummy_package')
else:
for _s, _p, o in self.graph.triples((p_term, self.spdx_namespace['name'], None)):
try:
self.builder.create_package(self.doc, six.text_type(o))
except CardinalityError:
self.more_than_one_error('Package name')
break
self.p_pkg_vinfo(p_term, self.spdx_namespace['versionInfo'])
self.p_pkg_fname(p_term, self.spdx_namespace['packageFileName'])
self.p_pkg_suppl(p_term, self.spdx_namespace['supplier'])
self.p_pkg_originator(p_term, self.spdx_namespace['originator'])
self.p_pkg_down_loc(p_term, self.spdx_namespace['downloadLocation'])
self.p_pkg_homepg(p_term, self.doap_namespace['homepage'])
self.p_pkg_chk_sum(p_term, self.spdx_namespace['checksum'])
self.p_pkg_src_info(p_term, self.spdx_namespace['sourceInfo'])
self.p_pkg_verif_code(p_term, self.spdx_namespace['packageVerificationCode'])
self.p_pkg_lic_conc(p_term, self.spdx_namespace['licenseConcluded'])
self.p_pkg_lic_decl(p_term, self.spdx_namespace['licenseDeclared'])
self.p_pkg_lics_info_from_files(p_term, self.spdx_namespace['licenseInfoFromFiles'])
self.p_pkg_comments_on_lics(p_term, self.spdx_namespace['licenseComments'])
self.p_pkg_cr_text(p_term, self.spdx_namespace['copyrightText'])
self.p_pkg_summary(p_term, self.spdx_namespace['summary'])
self.p_pkg_descr(p_term, self.spdx_namespace['description'])
def p_pkg_cr_text(self, p_term, predicate):
try:
for _, _, text in self.graph.triples((p_term, predicate, None)):
self.builder.set_pkg_cr_text(self.doc, self.to_special_value(six.text_type(text)))
except CardinalityError:
self.more_than_one_error('package copyright text')
def p_pkg_summary(self, p_term, predicate):
try:
for _, _, summary in self.graph.triples((p_term, predicate, None)):
self.builder.set_pkg_summary(self.doc, six.text_type(summary))
except CardinalityError:
self.more_than_one_error('package summary')
def p_pkg_descr(self, p_term, predicate):
try:
for _, _, desc in self.graph.triples(
(p_term, predicate, None)):
self.builder.set_pkg_desc(self.doc, six.text_type(desc))
except CardinalityError:
self.more_than_one_error('package description')
def p_pkg_comments_on_lics(self, p_term, predicate):
for _, _, comment in self.graph.triples((p_term, predicate, None)):
try:
self.builder.set_pkg_license_comment(self.doc, six.text_type(comment))
except CardinalityError:
self.more_than_one_error('package comments on license')
break
def p_pkg_lics_info_from_files(self, p_term, predicate):
for _, _, lics in self.graph.triples((p_term, predicate, None)):
try:
if (lics, RDF.type, self.spdx_namespace['ExtractedLicensingInfo']) in self.graph:
self.builder.set_pkg_license_from_file(self.doc, self.parse_only_extr_license(lics))
else:
self.builder.set_pkg_license_from_file(self.doc, self.handle_lics(lics))
except SPDXValueError:
self.value_error('PKG_LICS_INFO_FILES', lics)
def p_pkg_lic_decl(self, p_term, predicate):
self.handle_pkg_lic(p_term, predicate, self.builder.set_pkg_license_declared)
def handle_pkg_lic(self, p_term, predicate, builder_func):
"""Handles package lics concluded or declared."""
try:
for _, _, licenses in self.graph.triples((p_term, predicate, None)):
if (licenses, RDF.type, self.spdx_namespace['ConjunctiveLicenseSet']) in self.graph:
lics = self.handle_conjunctive_list(licenses)
builder_func(self.doc, lics)
elif (licenses, RDF.type, self.spdx_namespace['DisjunctiveLicenseSet']) in self.graph:
lics = self.handle_disjunctive_list(licenses)
builder_func(self.doc, lics)
else:
try:
lics = self.handle_lics(licenses)
builder_func(self.doc, lics)
except SPDXValueError:
self.value_error('PKG_SINGLE_LICS', licenses)
except CardinalityError:
self.more_than_one_error('package {0}'.format(predicate))
def p_pkg_lic_conc(self, p_term, predicate):
self.handle_pkg_lic(p_term, predicate, self.builder.set_pkg_licenses_concluded)
def p_pkg_verif_code(self, p_term, predicate):
for _, _, verifcode in self.graph.triples((p_term, predicate, None)):
# Parse verification code
for _, _, code in self.graph.triples((verifcode, self.spdx_namespace['packageVerificationCodeValue'], None)):
try:
self.builder.set_pkg_verif_code(self.doc, six.text_type(code))
except CardinalityError:
self.more_than_one_error('package verificaton code')
break
# Parse excluded file
for _, _, filename in self.graph.triples((verifcode, self.spdx_namespace['packageVerificationCodeExcludedFile'], None)):
try:
self.builder.set_pkg_excl_file(self.doc, six.text_type(filename))
except CardinalityError:
self.more_than_one_error('package verificaton code excluded file')
break
def p_pkg_src_info(self, p_term, predicate):
for _, _, o in self.graph.triples((p_term, predicate, None)):
try:
self.builder.set_pkg_source_info(self.doc, six.text_type(o))
except CardinalityError:
self.more_than_one_error('package source info')
break
def p_pkg_chk_sum(self, p_term, predicate):
for _s, _p, checksum in self.graph.triples((p_term, predicate, None)):
for _, _, value in self.graph.triples((checksum, self.spdx_namespace['checksumValue'], None)):
try:
self.builder.set_pkg_chk_sum(self.doc, six.text_type(value))
except CardinalityError:
self.more_than_one_error('Package checksum')
break
def p_pkg_homepg(self, p_term, predicate):
for _s, _p, o in self.graph.triples((p_term, predicate, None)):
try:
self.builder.set_pkg_home(self.doc, six.text_type(self.to_special_value(o)))
except CardinalityError:
self.more_than_one_error('Package home page')
break
except SPDXValueError:
self.value_error('PKG_HOME_PAGE', o)
def p_pkg_down_loc(self, p_term, predicate):
for _s, _p, o in self.graph.triples((p_term, predicate, None)):
try:
self.builder.set_pkg_down_location(self.doc, six.text_type(self.to_special_value(o)))
except CardinalityError:
self.more_than_one_error('Package download location')
break
except SPDXValueError:
self.value_error('PKG_DOWN_LOC', o)
def p_pkg_originator(self, p_term, predicate):
for _s, _p, o in self.graph.triples((p_term, predicate, None)):
try:
if o == "NOASSERTION":
self.builder.set_pkg_originator(self.doc, utils.NoAssert())
else:
ent = self.builder.create_entity(self.doc, six.text_type(o))
self.builder.set_pkg_originator(self.doc, ent)
except CardinalityError:
self.more_than_one_error('Package originator')
break
except SPDXValueError:
self.value_error('PKG_ORIGINATOR_VALUE', o)
def p_pkg_suppl(self, p_term, predicate):
for _s, _p, o in self.graph.triples((p_term, predicate, None)):
try:
if o == "NOASSERTION":
self.builder.set_pkg_supplier(self.doc, utils.NoAssert())
else:
ent = self.builder.create_entity(self.doc, six.text_type(o))
self.builder.set_pkg_supplier(self.doc, ent)
except CardinalityError:
self.more_than_one_error('Package supplier')
break
except SPDXValueError:
self.value_error('PKG_SUPPL_VALUE', o)
def p_pkg_fname(self, p_term, predicate):
for _s, _p, o in self.graph.triples((p_term, predicate, None)):
try:
self.builder.set_pkg_file_name(self.doc, six.text_type(o))
except CardinalityError:
self.more_than_one_error('Package file name')
break
def p_pkg_vinfo(self, p_term, predicate):
for _s, _p, o in self.graph.triples((p_term, predicate, None)):
try:
self.builder.set_pkg_vers(self.doc, six.text_type(o))
except CardinalityError:
self.more_than_one_error('Package version info')
break
class FileParser(LicenseParser):
"""
Helper class for parsing files.
"""
def __init__(self, builder, logger):
super(FileParser, self).__init__(builder, logger)
def parse_file(self, f_term):
if not (f_term, self.spdx_namespace['fileName'], None) in self.graph:
self.error = True
self.logger.log('File must have a name.')
# Dummy name to continue
self.builder.set_file_name(self.doc, 'Dummy file')
else:
for _, _, name in self.graph.triples((f_term, self.spdx_namespace['fileName'], None)):
self.builder.set_file_name(self.doc, six.text_type(name))
self.p_file_spdx_id(f_term, self.spdx_namespace['File'])
self.p_file_type(f_term, self.spdx_namespace['fileType'])
self.p_file_chk_sum(f_term, self.spdx_namespace['checksum'])
self.p_file_lic_conc(f_term, self.spdx_namespace['licenseConcluded'])
self.p_file_lic_info(f_term, self.spdx_namespace['licenseInfoInFile'])
self.p_file_comments_on_lics(f_term, self.spdx_namespace['licenseComments'])
self.p_file_cr_text(f_term, self.spdx_namespace['copyrightText'])
self.p_file_artifact(f_term, self.spdx_namespace['artifactOf'])
self.p_file_comment(f_term, RDFS.comment)
self.p_file_notice(f_term, self.spdx_namespace['noticeText'])
self.p_file_contributor(f_term, self.spdx_namespace['fileContributor'])
self.p_file_depends(f_term, self.spdx_namespace['fileDependency'])
def get_file_name(self, f_term):
"""Returns first found fileName property or None if not found."""
for _, _, name in self.graph.triples((f_term, self.spdx_namespace['fileName'], None)):
return name
return
def p_file_depends(self, f_term, predicate):
"""Sets file dependencies."""
for _, _, other_file in self.graph.triples((f_term, predicate, None)):
name = self.get_file_name(other_file)
if name is not None:
self.builder.add_file_dep(six.text_type(name))
else:
self.error = True
msg = 'File depends on file with no name'
self.logger.log(msg)
def p_file_contributor(self, f_term, predicate):
"""
Parse all file contributors and adds them to the model.
"""
for _, _, contributor in self.graph.triples((f_term, predicate, None)):
self.builder.add_file_contribution(self.doc, six.text_type(contributor))
def p_file_notice(self, f_term, predicate):
"""Sets file notice text."""
try:
for _, _, notice in self.graph.triples((f_term, predicate, None)):
self.builder.set_file_notice(self.doc, six.text_type(notice))
except CardinalityError:
self.more_than_one_error('file notice')
def p_file_comment(self, f_term, predicate):
"""Sets file comment text."""
try:
for _, _, comment in self.graph.triples((f_term, predicate, None)):
self.builder.set_file_comment(self.doc, six.text_type(comment))
except CardinalityError:
self.more_than_one_error('file comment')
def p_file_artifact(self, f_term, predicate):
"""Handles file artifactOf.
Note: does not handle artifact of project URI.
"""
for _, _, project in self.graph.triples((f_term, predicate, None)):
if (project, RDF.type, self.doap_namespace['Project']):
self.p_file_project(project)
else:
self.error = True
msg = 'File must be artifact of doap:Project'
self.logger.log(msg)
def p_file_project(self, project):
"""Helper function for parsing doap:project name and homepage.
and setting them using the file builder.
"""
for _, _, name in self.graph.triples((project, self.doap_namespace['name'], None)):
self.builder.set_file_atrificat_of_project(self.doc, 'name', six.text_type(name))
for _, _, homepage in self.graph.triples(
(project, self.doap_namespace['homepage'], None)):
self.builder.set_file_atrificat_of_project(self.doc, 'home', six.text_type(homepage))
def p_file_cr_text(self, f_term, predicate):
"""Sets file copyright text."""
try:
for _, _, cr_text in self.graph.triples((f_term, predicate, None)):
self.builder.set_file_copyright(self.doc, six.text_type(cr_text))
except CardinalityError:
self.more_than_one_error('file copyright text')
def p_file_comments_on_lics(self, f_term, predicate):
"""Sets file license comment."""
try:
for _, _, comment in self.graph.triples((f_term, predicate, None)):
self.builder.set_file_license_comment(self.doc, six.text_type(comment))
except CardinalityError:
self.more_than_one_error('file comments on license')
def p_file_lic_info(self, f_term, predicate):
"""Sets file license information."""
for _, _, info in self.graph.triples((f_term, predicate, None)):
lic = self.handle_lics(info)
if lic is not None:
self.builder.set_file_license_in_file(self.doc, lic)
def p_file_spdx_id(self, f_term, predicate):
try:
try:
self.builder.set_file_spdx_id(self.doc, f_term)
except SPDXValueError:
self.value_error('FILE_SPDX_ID_VALUE', f_term)
except CardinalityError:
self.more_than_one_error('FILE_SPDX_ID_VALUE')
def p_file_type(self, f_term, predicate):
"""Sets file type."""
try:
for _, _, ftype in self.graph.triples((f_term, predicate, None)):
try:
if ftype.endswith('binary'):
ftype = 'BINARY'
elif ftype.endswith('source'):
ftype = 'SOURCE'
elif ftype.endswith('other'):
ftype = 'OTHER'
elif ftype.endswith('archive'):
ftype = 'ARCHIVE'
self.builder.set_file_type(self.doc, ftype)
except SPDXValueError:
self.value_error('FILE_TYPE', ftype)
except CardinalityError:
self.more_than_one_error('file type')
def p_file_chk_sum(self, f_term, predicate):
"""Sets file checksum. Assumes SHA1 algorithm without checking."""
try:
for _s, _p, checksum in self.graph.triples((f_term, predicate, None)):
for _, _, value in self.graph.triples((checksum, self.spdx_namespace['checksumValue'], None)):
self.builder.set_file_chksum(self.doc, six.text_type(value))
except CardinalityError:
self.more_than_one_error('File checksum')
def p_file_lic_conc(self, f_term, predicate):
"""Sets file licenses concluded."""
try:
for _, _, licenses in self.graph.triples((f_term, predicate, None)):
if (licenses, RDF.type, self.spdx_namespace['ConjunctiveLicenseSet']) in self.graph:
lics = self.handle_conjunctive_list(licenses)
self.builder.set_concluded_license(self.doc, lics)
elif (licenses, RDF.type, self.spdx_namespace['DisjunctiveLicenseSet']) in self.graph:
lics = self.handle_disjunctive_list(licenses)
self.builder.set_concluded_license(self.doc, lics)
else:
try:
lics = self.handle_lics(licenses)
self.builder.set_concluded_license(self.doc, lics)
except SPDXValueError:
self.value_error('FILE_SINGLE_LICS', licenses)
except CardinalityError:
self.more_than_one_error('file {0}'.format(predicate))
class ReviewParser(BaseParser):
"""
Helper class for parsing review information.
"""
def __init__(self, builder, logger):
super(ReviewParser, self).__init__(builder, logger)
def parse_review(self, r_term):
reviewer = self.get_reviewer(r_term)
reviewed_date = self.get_review_date(r_term)
if reviewer is not None:
self.builder.add_reviewer(self.doc, reviewer)
if reviewed_date is not None:
try:
self.builder.add_review_date(self.doc, reviewed_date)
except SPDXValueError:
self.value_error('REVIEW_DATE', reviewed_date)
comment = self.get_review_comment(r_term)
if comment is not None:
self.builder.add_review_comment(self.doc, comment)
def get_review_comment(self, r_term):
"""Returns review comment or None if found none or more than one.
Reports errors.
"""
comment_list = list(self.graph.triples((r_term, RDFS.comment, None)))
if len(comment_list) > 1:
self.error = True
msg = 'Review can have at most one comment'
self.logger.log(msg)
return
else:
return six.text_type(comment_list[0][2])
def get_review_date(self, r_term):
"""Returns review date or None if not found.
Reports error on failure.
Note does not check value format.
"""
reviewed_list = list(self.graph.triples((r_term, self.spdx_namespace['reviewDate'], None)))
if len(reviewed_list) != 1:
self.error = True
msg = 'Review must have exactlyone review date'
self.logger.log(msg)
return
return six.text_type(reviewed_list[0][2])
def get_reviewer(self, r_term):
"""Returns reviewer as creator object or None if failed.
Reports errors on failure.
"""
reviewer_list = list(self.graph.triples((r_term, self.spdx_namespace['reviewer'], None)))
if len(reviewer_list) != 1:
self.error = True
msg = 'Review must have exactly one reviewer'
self.logger.log(msg)
return
try:
return self.builder.create_entity(self.doc, six.text_type(reviewer_list[0][2]))
except SPDXValueError:
self.value_error('REVIEWER_VALUE', reviewer_list[0][2])
class AnnotationParser(BaseParser):
"""
Helper class for parsing annotation information.
"""
def __init__(self, builder, logger):
super(AnnotationParser, self).__init__(builder, logger)
def parse_annotation(self, r_term):
annotator = self.get_annotator(r_term)
annotation_date = self.get_annotation_date(r_term)
if annotator is not None:
self.builder.add_annotator(self.doc, annotator)
if annotation_date is not None:
try:
self.builder.add_annotation_date(self.doc, annotation_date)
except SPDXValueError:
self.value_error('ANNOTATION_DATE', annotation_date)
comment = self.get_annotation_comment(r_term)
if comment is not None:
self.builder.add_annotation_comment(self.doc, comment)
annotation_type = self.get_annotation_type(r_term)
self.builder.add_annotation_type(self.doc, annotation_type)
try:
self.builder.set_annotation_spdx_id(self.doc, r_term)
except CardinalityError:
self.more_than_one_error('SPDX Identifier Reference')
def get_annotation_type(self, r_term):
"""Returns annotation type or None if found none or more than one.
Reports errors on failure."""
for _, _, typ in self.graph.triples((
r_term, self.spdx_namespace['annotationType'], None)):
if typ is not None:
return typ
else:
self.error = True
msg = 'Annotation must have exactly one annotation type.'
self.logger.log(msg)
return
def get_annotation_comment(self, r_term):
"""Returns annotation comment or None if found none or more than one.
Reports errors.
"""
comment_list = list(self.graph.triples((r_term, RDFS.comment, None)))
if len(comment_list) > 1:
self.error = True
msg = 'Annotation can have at most one comment.'
self.logger.log(msg)
return
else:
return six.text_type(comment_list[0][2])
def get_annotation_date(self, r_term):
"""Returns annotation date or None if not found.
Reports error on failure.
Note does not check value format.
"""
annotation_date_list = list(self.graph.triples((r_term, self.spdx_namespace['annotationDate'], None)))
if len(annotation_date_list) != 1:
self.error = True
msg = 'Annotation must have exactly one annotation date.'
self.logger.log(msg)
return
return six.text_type(annotation_date_list[0][2])
def get_annotator(self, r_term):
"""Returns annotator as creator object or None if failed.
Reports errors on failure.
"""
annotator_list = list(self.graph.triples((r_term, self.spdx_namespace['annotator'], None)))
if len(annotator_list) != 1:
self.error = True
msg = 'Annotation must have exactly one annotator'
self.logger.log(msg)
return
try:
return self.builder.create_entity(self.doc, six.text_type(annotator_list[0][2]))
except SPDXValueError:
self.value_error('ANNOTATOR_VALUE', annotator_list[0][2])
class Parser(PackageParser, FileParser, ReviewParser, AnnotationParser):
"""
RDF/XML file parser.
"""
def __init__(self, builder, logger):
super(Parser, self).__init__(builder, logger)
def parse(self, fil):
"""Parses a file and returns a document object.
File, a file like object.
"""
self.error = False
self.graph = Graph()
self.graph.parse(file=fil, format='xml')
self.doc = document.Document()
for s, _p, o in self.graph.triples((None, RDF.type, self.spdx_namespace['SpdxDocument'])):
self.parse_doc_fields(s)
for s, _p, o in self.graph.triples((None, RDF.type, self.spdx_namespace['ExternalDocumentRef'])):
self.parse_ext_doc_ref(s)
for s, _p, o in self.graph.triples((None, RDF.type, self.spdx_namespace['CreationInfo'])):
self.parse_creation_info(s)
for s, _p, o in self.graph.triples((None, RDF.type, self.spdx_namespace['Package'])):
self.parse_package(s)
for s, _p, o in self.graph.triples((None, self.spdx_namespace['referencesFile'], None)):
self.parse_file(o)
for s, _p, o in self.graph.triples((None, self.spdx_namespace['reviewed'], None)):
self.parse_review(o)
for s, _p, o in self.graph.triples((None, self.spdx_namespace['annotation'], None)):
self.parse_annotation(o)
validation_messages = []
# Report extra errors if self.error is False otherwise there will be
# redundent messages
validation_messages = self.doc.validate(validation_messages)
if not self.error:
if validation_messages:
for msg in validation_messages:
self.logger.log(msg)
self.error = True
return self.doc, self.error
def parse_creation_info(self, ci_term):
"""
Parse creators, created and comment.
"""
for _s, _p, o in self.graph.triples((ci_term, self.spdx_namespace['creator'], None)):
try:
ent = self.builder.create_entity(self.doc, six.text_type(o))
self.builder.add_creator(self.doc, ent)
except SPDXValueError:
self.value_error('CREATOR_VALUE', o)
for _s, _p, o in self.graph.triples((ci_term, self.spdx_namespace['created'], None)):
try:
self.builder.set_created_date(self.doc, six.text_type(o))
except SPDXValueError:
self.value_error('CREATED_VALUE', o)
except CardinalityError:
self.more_than_one_error('created')
break
for _s, _p, o in self.graph.triples((ci_term, RDFS.comment, None)):
try:
self.builder.set_creation_comment(self.doc, six.text_type(o))
except CardinalityError:
self.more_than_one_error('CreationInfo comment')
break
for _s, _p, o in self.graph.triples((ci_term, self.spdx_namespace['licenseListVersion'], None)):
try:
self.builder.set_lics_list_ver(self.doc, six.text_type(o))
except CardinalityError:
self.more_than_one_error('licenseListVersion')
break
except SPDXValueError:
self.value_error('LL_VALUE', o)
def parse_doc_fields(self, doc_term):
"""Parses the version, data license, name, SPDX Identifier, namespace,
and comment."""
try:
self.builder.set_doc_spdx_id(self.doc, doc_term)
except SPDXValueError:
self.value_error('DOC_SPDX_ID_VALUE', doc_term)
try:
if doc_term.count('#', 0, len(doc_term)) <= 1:
doc_namespace = doc_term.split('#')[0]
self.builder.set_doc_namespace(self.doc, doc_namespace)
else:
self.value_error('DOC_NAMESPACE_VALUE', doc_term)
except SPDXValueError:
self.value_error('DOC_NAMESPACE_VALUE', doc_term)
for _s, _p, o in self.graph.triples((doc_term, self.spdx_namespace['specVersion'], None)):
try:
self.builder.set_doc_version(self.doc, six.text_type(o))
except SPDXValueError:
self.value_error('DOC_VERS_VALUE', o)
except CardinalityError:
self.more_than_one_error('specVersion')
break
for _s, _p, o in self.graph.triples((doc_term, self.spdx_namespace['dataLicense'], None)):
try:
self.builder.set_doc_data_lic(self.doc, six.text_type(o))
except SPDXValueError:
self.value_error('DOC_D_LICS', o)
except CardinalityError:
self.more_than_one_error('dataLicense')
break
for _s, _p, o in self.graph.triples(
(doc_term, self.spdx_namespace['name'], None)):
try:
self.builder.set_doc_name(self.doc, six.text_type(o))
except CardinalityError:
self.more_than_one_error('name')
break
for _s, _p, o in self.graph.triples((doc_term, RDFS.comment, None)):
try:
self.builder.set_doc_comment(self.doc, six.text_type(o))
except CardinalityError:
self.more_than_one_error('Document comment')
break
def parse_ext_doc_ref(self, ext_doc_ref_term):
"""
Parses the External Document ID, SPDX Document URI and Checksum.
"""
for _s, _p, o in self.graph.triples(
(ext_doc_ref_term,
self.spdx_namespace['externalDocumentId'],
None)):
try:
self.builder.set_ext_doc_id(self.doc, six.text_type(o))
except SPDXValueError:
self.value_error('EXT_DOC_REF_VALUE', 'External Document ID')
break
for _s, _p, o in self.graph.triples(
(ext_doc_ref_term,
self.spdx_namespace['spdxDocument'],
None)):
try:
self.builder.set_spdx_doc_uri(self.doc, six.text_type(o))
except SPDXValueError:
self.value_error('EXT_DOC_REF_VALUE', 'SPDX Document URI')
break
for _s, _p, checksum in self.graph.triples(
(ext_doc_ref_term, self.spdx_namespace['checksum'], None)):
for _, _, value in self.graph.triples(
(checksum, self.spdx_namespace['checksumValue'], None)):
try:
self.builder.set_chksum(self.doc, six.text_type(value))
except SPDXValueError:
self.value_error('EXT_DOC_REF_VALUE', 'Checksum')
break