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
|
/**
* ============LICENSE_START=======================================================
* org.onap.aai
* ================================================================================
* Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved.
* ================================================================================
* 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.
* ============LICENSE_END=========================================================
*/
package org.onap.aai.rest.dsl;
import java.io.ByteArrayInputStream;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.lang.reflect.InvocationTargetException;
import java.nio.charset.StandardCharsets;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.antlr.v4.runtime.*;
import org.antlr.v4.runtime.misc.ParseCancellationException;
import org.antlr.v4.runtime.tree.ParseTree;
import org.antlr.v4.runtime.tree.ParseTreeListener;
import org.antlr.v4.runtime.tree.ParseTreeWalker;
import org.onap.aai.exceptions.AAIException;
import org.onap.aai.rest.dsl.v2.DslListener;
import org.onap.aai.rest.dsl.validation.DslValidator;
import org.onap.aai.rest.enums.QueryVersion;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* The Class DslQueryProcessor.
*/
public class DslQueryProcessor {
private static final Logger LOGGER = LoggerFactory.getLogger(DslQueryProcessor.class);
private Map<QueryVersion, ParseTreeListener> dslListeners;
private boolean startNodeValidationFlag = true;
private String validationRules = "";
private String packageName = "org.onap.aai.dsl.";
private static final String LEXER = "AAIDslLexer";
private static final String PARSER = "AAIDslParser";
private static final String EOF_TOKEN = "<EOF>";
private boolean isAggregate = false;
public DslQueryProcessor(Map<QueryVersion, ParseTreeListener> dslListeners) {
this.dslListeners = dslListeners;
}
public Map<String, Object> parseAaiQuery(QueryVersion version, String aaiQuery)
throws AAIException {
Map<String, Object> resultMap = new HashMap<>();
try {
// Create a input stream that reads our string
InputStream stream =
new ByteArrayInputStream(aaiQuery.getBytes(StandardCharsets.UTF_8));
packageName = packageName + version.toString().toLowerCase() + ".";
Class<?> lexerClass = Class.forName(packageName + LEXER);
Class<?> parserClass = Class.forName(packageName + PARSER);
Lexer lexer = (Lexer) lexerClass.getConstructor(CharStream.class)
.newInstance(CharStreams.fromStream(stream, StandardCharsets.UTF_8));
lexer.removeErrorListeners();
lexer.addErrorListener(new AAIDslErrorListener());
CommonTokenStream tokens = new CommonTokenStream(lexer);
// Parser that feeds off of the tokens buffer
Parser parser =
(Parser) parserClass.getConstructor(TokenStream.class).newInstance(tokens);
parser.removeErrorListeners();
parser.addErrorListener(new AAIDslErrorListener());
ParseTreeListener dslListener = dslListeners.get(version);
dslListener.getClass().getMethod("setValidationFlag", boolean.class).invoke(dslListener,
isStartNodeValidationFlag());
dslListener.getClass().getMethod("setAggregateFlag", boolean.class).invoke(dslListener,
isAggregate());
if (!getValidationRules().isEmpty() && !"none".equals(getValidationRules())) {
DslValidator validator = new DslValidator.Builder().create();
dslListener.getClass()
.getMethod("setQueryValidator", DslValidator.class, String.class)
.invoke(dslListener, validator, getValidationRules());
}
// Specify our entry point
ParseTree ptree = (ParseTree) parserClass.getMethod("aaiquery").invoke(parser);
// Check if there is no EOF token at the end of the parsed aaiQuery
// If none, DSL query may have not been parsed correctly and omitted part of the query
// out. If so error out.
// If it wasn't expecting a opening parens after a closing bracket for union, it will
// drop the proceeding part of the query.
Token eofToken = tokens.get(tokens.size() - 1);
if (eofToken != null && !eofToken.getText().equals(EOF_TOKEN)) {
if (eofToken.getText().equals("(")) {
throw new AAIException("AAI_6153",
"DSL Syntax Error while processing the query: DSL Query could not be parsed correctly. Please check your syntax.");
}
}
if (LOGGER.isInfoEnabled()) {
LOGGER.info("QUERY-interim {}", ptree.toStringTree(parser));
}
// Walk it and attach our listener
ParseTreeWalker walker = new ParseTreeWalker();
walker.walk(dslListener, ptree);
String query =
(String) dslListener.getClass().getMethod("getQuery").invoke(dslListener);
resultMap.put("query", query);
if (version.equals(QueryVersion.V2)) {
Map<String, List<String>> selectKeys = ((DslListener) dslListener).getSelectKeys();
if (selectKeys != null && !selectKeys.isEmpty()) {
resultMap.put("propertiesMap", selectKeys);
}
}
LOGGER.info("Final QUERY {}", query);
return resultMap;
} catch (InvocationTargetException e) {
if (e.getTargetException() instanceof ParseCancellationException) {
throw new AAIException("AAI_6153", "DSL Syntax Error while processing the query :"
+ e.getTargetException().getMessage());
} else if (e.getTargetException() instanceof AAIException) {
AAIException ex = (AAIException) e.getTargetException();
throw new AAIException((ex.getCode().isEmpty() ? "AAI_6149" : ex.getCode()),
"DSL Error while processing the query :" + ex.getMessage());
} else {
throw new AAIException("AAI_6152", "Exception while processing DSL query");
}
} catch (ParseCancellationException e) {
throw new AAIException("AAI_6153",
"DSL Syntax Error while processing the query: " + e.getMessage());
} catch (Exception e) {
throw new AAIException("AAI_6152",
"Error while processing the query: " + e.getMessage());
}
}
public boolean isStartNodeValidationFlag() {
return startNodeValidationFlag;
}
public void setStartNodeValidationFlag(boolean startNodeValidationFlag) {
this.startNodeValidationFlag = startNodeValidationFlag;
}
public boolean isAggregate() {
return isAggregate;
}
public void setAggregate(boolean aggregate) {
this.isAggregate = aggregate;
}
public String getValidationRules() {
return validationRules;
}
public void setValidationRules(String validationRules) {
this.validationRules = validationRules;
}
}
|
