aboutsummaryrefslogtreecommitdiff
path: root/rdfloader/parser2v2/parse_snippet_info.go
blob: 8db67c181365ccc81ff6f5c55a168f67fb127485 (plain)
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
// SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later

package parser2v2

import (
	"fmt"
	gordfParser "github.com/RishabhBhatnagar/gordf/rdfloader/parser"
	"github.com/spdx/tools-golang/spdx"
	"strconv"
	"strings"
)

// Snippet Information
// Cardinality: Optional, Many
func (parser *rdfParser2_2) getSnippetInformationFromTriple2_2(triple *gordfParser.Triple) (si *spdx.Snippet2_2, err error) {
	si = &spdx.Snippet2_2{}

	err = setSnippetID(triple.Subject.ID, si)
	if err != nil {
		return nil, err
	}

	for _, siTriple := range parser.nodeToTriples(triple.Subject) {
		switch siTriple.Predicate.ID {
		case RDF_TYPE:
			// cardinality: exactly 1
		case SPDX_SNIPPET_FROM_FILE:
			// cardinality: exactly 1
			// file which is associated with the snippet
			file, err := parser.getFileFromNode(siTriple.Object)
			if err != nil {
				return nil, err
			}
			si.SnippetFromFileSPDXIdentifier, err = ExtractDocElementID(getLastPartOfURI(siTriple.Object.ID))
			parser.files[file.FileSPDXIdentifier] = file
		case SPDX_NAME:
			si.SnippetName = siTriple.Object.ID
		case SPDX_COPYRIGHT_TEXT:
			si.SnippetCopyrightText = siTriple.Object.ID
		case SPDX_LICENSE_COMMENTS:
			si.SnippetLicenseComments = siTriple.Object.ID
		case SPDX_LICENSE_INFO_IN_SNIPPET:
			si.LicenseInfoInSnippet = append(si.LicenseInfoInSnippet, siTriple.Object.ID)
		case RDFS_COMMENT:
			si.SnippetComment = siTriple.Object.ID
		case SPDX_LICENSE_CONCLUDED:
			si.SnippetLicenseConcluded = siTriple.Object.ID
		case SPDX_RANGE:
			// cardinality: min 1
			err = parser.setSnippetRangeFromNode(siTriple.Object, si)
			if err != nil {
				return nil, err
			}
		default:
			return nil, fmt.Errorf("unknown predicate %v", siTriple.Predicate.ID)
		}
	}
	return si, nil
}

// given is the id of the file, sets the snippet to the file in parser.
func (parser *rdfParser2_2) setSnippetToFileWithID(snippet *spdx.Snippet2_2, fileID spdx.ElementID) error {
	if parser.files[fileID] == nil {
		return fmt.Errorf("snippet refers to an undefined file with ID: %s", fileID)
	}

	// initializing snippet of the files if it is not defined already
	if parser.files[fileID].Snippets == nil {
		parser.files[fileID].Snippets = map[spdx.ElementID]*spdx.Snippet2_2{}
	}

	// setting the snippet to the file.
	parser.files[fileID].Snippets[snippet.SnippetSPDXIdentifier] = snippet

	return nil
}

func (parser *rdfParser2_2) setSnippetRangeFromNode(node *gordfParser.Node, si *spdx.Snippet2_2) error {
	// todo: apply DRY in this method.
	rangeType := 0 // 0: undefined range, 1: byte, 2: line
	var start, end string
	for _, t := range parser.nodeToTriples(node) {
		switch t.Predicate.ID {
		case RDF_TYPE:
			if t.Object.ID != PTR_START_END_POINTER {
				return fmt.Errorf("expected range to have sub tag of type StartEndPointer, found %v", t.Object.ID)
			}
		case PTR_START_POINTER:
			for _, subTriple := range parser.nodeToTriples(t.Object) {
				switch subTriple.Predicate.ID {
				case RDF_TYPE:
					switch subTriple.Object.ID {
					case PTR_BYTE_OFFSET_POINTER:
						if rangeType == 2 {
							return fmt.Errorf("byte offset pointer merged with line offset pointer")
						}
						rangeType = 1
					case PTR_LINE_CHAR_POINTER:
						if rangeType == 1 {
							return fmt.Errorf("byte offset pointer merged with line offset pointer")
						}
						rangeType = 2
					default:
						return fmt.Errorf("illegal pointer type %v", subTriple.Object.ID)
					}
				case PTR_REFERENCE:
					err := parser.parseRangeReference(subTriple.Object, si)
					if err != nil {
						return nil
					}
				case PTR_OFFSET, PTR_LINE_NUMBER:
					start = subTriple.Object.ID
				default:
					return fmt.Errorf("undefined predicate %v while parsing range", subTriple.Predicate.ID)
				}
			}
		case PTR_END_POINTER:
			subTriples := parser.nodeToTriples(t.Object)
			for _, subTriple := range subTriples {
				switch subTriple.Predicate.ID {
				case RDF_TYPE:
					switch subTriple.Object.ID {
					case PTR_BYTE_OFFSET_POINTER:
						if rangeType == 2 {
							return fmt.Errorf("byte offset pointer merged with line offset pointer")
						}
						rangeType = 1
					case PTR_LINE_CHAR_POINTER:
						if rangeType == 1 {
							return fmt.Errorf("byte offset pointer merged with line offset pointer")
						}
						rangeType = 2
					default:
						return fmt.Errorf("illegal pointer type %v", subTriple.Object.ID)
					}
				case PTR_REFERENCE:
					err := parser.parseRangeReference(subTriple.Object, si)
					if err != nil {
						return nil
					}
				case PTR_OFFSET, PTR_LINE_NUMBER:
					end = subTriple.Object.ID
				}
			}
		default:
			return fmt.Errorf("unknown predicate %v", t.Predicate.ID)
		}
	}
	if rangeType != 1 && rangeType != 2 {
		return fmt.Errorf("undefined range type")
	}
	startNumber, err := strconv.Atoi(strings.TrimSpace(start))
	if err != nil {
		return fmt.Errorf("invalid number for range start: %v", start)
	}
	endNumber, err := strconv.Atoi(strings.TrimSpace(end))
	if err != nil {
		return fmt.Errorf("invalid number for range end: %v", end)
	}
	if rangeType == 1 {
		// byte range
		si.SnippetByteRangeStart = startNumber
		si.SnippetByteRangeEnd = endNumber
	} else {
		// line range
		si.SnippetLineRangeStart = startNumber
		si.SnippetLineRangeEnd = endNumber
	}
	return nil
}

func (parser *rdfParser2_2) parseRangeReference(node *gordfParser.Node, snippet *spdx.Snippet2_2) error {
	// reference is supposed to be either a resource reference to a file or a new file
	// Unfortunately, I didn't find field where this can be set in the tools-golang data model.
	// todo: set this reference to the snippet
	switch node.NodeType {
	case gordfParser.RESOURCELITERAL, gordfParser.LITERAL, gordfParser.BLANK:
		return nil
	}
	file, err := parser.getFileFromNode(node)
	if err != nil {
		return fmt.Errorf("error parsing a new file in a reference")
	}

	// a new file found within the pointer reference is an unpackaged file.
	if parser.doc.UnpackagedFiles == nil {
		parser.doc.UnpackagedFiles = map[spdx.ElementID]*spdx.File2_2{}
	}
	parser.doc.UnpackagedFiles[file.FileSPDXIdentifier] = file
	return nil
}

func setSnippetID(uri string, si *spdx.Snippet2_2) (err error) {
	fragment := getLastPartOfURI(uri)
	si.SnippetSPDXIdentifier, err = ExtractElementID(fragment)
	if err != nil {
		return fmt.Errorf("error setting snippet identifier: %v", uri)
	}
	return nil
}