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