franta-hg@16
|
1 |
/**
|
franta-hg@16
|
2 |
* SQL-DK
|
franta-hg@16
|
3 |
* Copyright © 2013 František Kučera (frantovo.cz)
|
franta-hg@16
|
4 |
*
|
franta-hg@16
|
5 |
* This program is free software: you can redistribute it and/or modify
|
franta-hg@16
|
6 |
* it under the terms of the GNU General Public License as published by
|
franta-hg@16
|
7 |
* the Free Software Foundation, either version 3 of the License, or
|
franta-hg@16
|
8 |
* (at your option) any later version.
|
franta-hg@16
|
9 |
*
|
franta-hg@16
|
10 |
* This program is distributed in the hope that it will be useful,
|
franta-hg@16
|
11 |
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
franta-hg@16
|
12 |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
franta-hg@16
|
13 |
* GNU General Public License for more details.
|
franta-hg@16
|
14 |
*
|
franta-hg@16
|
15 |
* You should have received a copy of the GNU General Public License
|
franta-hg@16
|
16 |
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
franta-hg@16
|
17 |
*/
|
franta-hg@1
|
18 |
package info.globalcode.sql.dk;
|
franta-hg@1
|
19 |
|
franta-hg@49
|
20 |
import static info.globalcode.sql.dk.Functions.findByName;
|
franta-hg@49
|
21 |
import java.sql.Connection;
|
franta-hg@1
|
22 |
import java.sql.PreparedStatement;
|
franta-hg@34
|
23 |
import java.sql.SQLException;
|
franta-hg@49
|
24 |
import java.util.ArrayList;
|
franta-hg@34
|
25 |
import java.util.List;
|
franta-hg@51
|
26 |
import java.util.logging.Level;
|
franta-hg@51
|
27 |
import java.util.logging.Logger;
|
franta-hg@49
|
28 |
import java.util.regex.Matcher;
|
franta-hg@49
|
29 |
import java.util.regex.Pattern;
|
franta-hg@61
|
30 |
import java.util.regex.PatternSyntaxException;
|
franta-hg@1
|
31 |
|
franta-hg@1
|
32 |
/**
|
franta-hg@1
|
33 |
*
|
franta-hg@1
|
34 |
* @author Ing. František Kučera (frantovo.cz)
|
franta-hg@1
|
35 |
*/
|
franta-hg@1
|
36 |
public class SQLCommandNamed extends SQLCommand {
|
franta-hg@1
|
37 |
|
franta-hg@51
|
38 |
private static final Logger log = Logger.getLogger(SQLCommandNamed.class.getName());
|
franta-hg@49
|
39 |
private String namePrefix;
|
franta-hg@49
|
40 |
private String nameSuffix;
|
franta-hg@34
|
41 |
private List<NamedParameter> parameters;
|
franta-hg@49
|
42 |
private List<NamedParameter> parametersUsed = new ArrayList<>();
|
franta-hg@49
|
43 |
private StringBuilder updatedQuery;
|
franta-hg@49
|
44 |
private Pattern pattern;
|
franta-hg@143
|
45 |
private SQLCommandNumbered numbered;
|
franta-hg@34
|
46 |
|
franta-hg@49
|
47 |
public SQLCommandNamed(String query, List<NamedParameter> parameters, String namePrefix, String nameSuffix) {
|
franta-hg@37
|
48 |
super(query);
|
franta-hg@49
|
49 |
this.updatedQuery = new StringBuilder(query.length());
|
franta-hg@34
|
50 |
this.parameters = parameters;
|
franta-hg@49
|
51 |
this.namePrefix = namePrefix;
|
franta-hg@49
|
52 |
this.nameSuffix = nameSuffix;
|
franta-hg@49
|
53 |
}
|
franta-hg@49
|
54 |
|
franta-hg@49
|
55 |
@Override
|
franta-hg@49
|
56 |
public PreparedStatement prepareStatement(Connection c) throws SQLException {
|
franta-hg@143
|
57 |
return getSQLCommandNumbered().prepareStatement(c);
|
franta-hg@143
|
58 |
}
|
franta-hg@143
|
59 |
|
franta-hg@143
|
60 |
@Override
|
franta-hg@143
|
61 |
public void parametrize(PreparedStatement ps) throws SQLException {
|
franta-hg@143
|
62 |
getSQLCommandNumbered().parametrize(ps);
|
franta-hg@143
|
63 |
}
|
franta-hg@143
|
64 |
|
franta-hg@143
|
65 |
private void prepare() throws SQLException {
|
franta-hg@61
|
66 |
try {
|
franta-hg@61
|
67 |
buildPattern();
|
franta-hg@61
|
68 |
placeParametersAndUpdateQuery();
|
franta-hg@61
|
69 |
logPossiblyMissingParameters();
|
franta-hg@61
|
70 |
} catch (PatternSyntaxException e) {
|
franta-hg@61
|
71 |
throw new SQLException("Name prefix „" + namePrefix + "“ or suffix „" + nameSuffix + "“ contain a wrong regular expression. " + e.getLocalizedMessage(), e);
|
franta-hg@61
|
72 |
}
|
franta-hg@34
|
73 |
}
|
franta-hg@34
|
74 |
|
franta-hg@143
|
75 |
/**
|
franta-hg@143
|
76 |
* @return SQL command with named parameters converted to SQL command with numbered parameters
|
franta-hg@143
|
77 |
*/
|
franta-hg@143
|
78 |
public SQLCommandNumbered getSQLCommandNumbered() throws SQLException {
|
franta-hg@143
|
79 |
if (numbered == null) {
|
franta-hg@143
|
80 |
prepare();
|
franta-hg@143
|
81 |
numbered = new SQLCommandNumbered(updatedQuery.toString(), parametersUsed);
|
franta-hg@49
|
82 |
}
|
franta-hg@143
|
83 |
|
franta-hg@143
|
84 |
return numbered;
|
franta-hg@49
|
85 |
}
|
franta-hg@49
|
86 |
|
franta-hg@49
|
87 |
/**
|
franta-hg@49
|
88 |
* Builds a regexp pattern that matches all parameter names (with prefix/suffix) and which has
|
franta-hg@49
|
89 |
* one group: parameter name (without prefix/suffix)
|
franta-hg@49
|
90 |
*/
|
franta-hg@143
|
91 |
private void buildPattern() throws PatternSyntaxException {
|
franta-hg@49
|
92 |
StringBuilder patternString = new StringBuilder();
|
franta-hg@49
|
93 |
|
franta-hg@54
|
94 |
patternString.append(namePrefix);
|
franta-hg@54
|
95 |
patternString.append("(?<paramName>");
|
franta-hg@49
|
96 |
for (int i = 0; i < parameters.size(); i++) {
|
franta-hg@51
|
97 |
patternString.append(Pattern.quote(parameters.get(i).getName()));
|
franta-hg@51
|
98 |
if (i < parameters.size() - 1) {
|
franta-hg@49
|
99 |
patternString.append("|");
|
franta-hg@49
|
100 |
}
|
franta-hg@49
|
101 |
}
|
franta-hg@49
|
102 |
patternString.append(")");
|
franta-hg@54
|
103 |
patternString.append(nameSuffix);
|
franta-hg@49
|
104 |
|
franta-hg@49
|
105 |
pattern = Pattern.compile(patternString.toString());
|
franta-hg@49
|
106 |
}
|
franta-hg@49
|
107 |
|
franta-hg@143
|
108 |
private void placeParametersAndUpdateQuery() {
|
franta-hg@49
|
109 |
final String originalQuery = getQuery();
|
franta-hg@49
|
110 |
Matcher m = pattern.matcher(originalQuery);
|
franta-hg@49
|
111 |
|
franta-hg@49
|
112 |
int lastPosition = 0;
|
franta-hg@49
|
113 |
while (m.find(lastPosition)) {
|
franta-hg@54
|
114 |
String name = m.group("paramName");
|
franta-hg@49
|
115 |
|
franta-hg@49
|
116 |
updatedQuery.append(originalQuery.substring(lastPosition, m.start()));
|
franta-hg@49
|
117 |
updatedQuery.append("?");
|
franta-hg@49
|
118 |
|
franta-hg@49
|
119 |
parametersUsed.add(findByName(parameters, name));
|
franta-hg@49
|
120 |
|
franta-hg@49
|
121 |
lastPosition = m.end();
|
franta-hg@49
|
122 |
}
|
franta-hg@49
|
123 |
updatedQuery.append(originalQuery.substring(lastPosition, originalQuery.length()));
|
franta-hg@49
|
124 |
|
franta-hg@49
|
125 |
for (NamedParameter definedParameter : parameters) {
|
franta-hg@49
|
126 |
if (findByName(parametersUsed, definedParameter.getName()) == null) {
|
franta-hg@54
|
127 |
/**
|
franta-hg@54
|
128 |
* User can have predefined set of parameters and use them with different SQL
|
franta-hg@54
|
129 |
* queries that use only subset of these parameters → just warning, not exception.
|
franta-hg@54
|
130 |
*/
|
franta-hg@54
|
131 |
log.log(Level.WARNING, "Parameter „{0}“ is defined but not used in the query: „{1}“", new Object[]{definedParameter.getName(), originalQuery});
|
franta-hg@49
|
132 |
}
|
franta-hg@49
|
133 |
}
|
franta-hg@1
|
134 |
}
|
franta-hg@34
|
135 |
|
franta-hg@51
|
136 |
private void logPossiblyMissingParameters() {
|
franta-hg@78
|
137 |
Pattern p = Pattern.compile(namePrefix + "(?<paramName>.+?)" + nameSuffix);
|
franta-hg@51
|
138 |
Matcher m = p.matcher(updatedQuery);
|
franta-hg@51
|
139 |
int lastPosition = 0;
|
franta-hg@51
|
140 |
while (m.find(lastPosition)) {
|
franta-hg@54
|
141 |
/**
|
franta-hg@54
|
142 |
* We have not parsed and understood the SQL query; the parameter-like looking string
|
franta-hg@54
|
143 |
* could be inside a literal part of the query → just warning, not exception.
|
franta-hg@54
|
144 |
*/
|
franta-hg@54
|
145 |
log.log(Level.WARNING, "Possibly missing parameter „{0}“ in the query: „{1}“", new Object[]{m.group("paramName"), getQuery()});
|
franta-hg@51
|
146 |
lastPosition = m.end();
|
franta-hg@51
|
147 |
}
|
franta-hg@51
|
148 |
}
|
franta-hg@51
|
149 |
|
franta-hg@34
|
150 |
@Override
|
franta-hg@34
|
151 |
public List<NamedParameter> getParameters() {
|
franta-hg@34
|
152 |
return parameters;
|
franta-hg@34
|
153 |
}
|
franta-hg@1
|
154 |
}
|