/
ClientMessage.java
331 lines (305 loc) · 10.5 KB
/
ClientMessage.java
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
// SPDX-License-Identifier: LGPL-2.1-or-later
// Copyright (c) 2012-2014 Monty Program Ab
// Copyright (c) 2015-2021 MariaDB Corporation Ab
package org.mariadb.jdbc.message;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.InputStream;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.util.concurrent.locks.ReentrantLock;
import java.util.regex.Pattern;
import org.mariadb.jdbc.BasePreparedStatement;
import org.mariadb.jdbc.Statement;
import org.mariadb.jdbc.client.*;
import org.mariadb.jdbc.client.impl.StandardReadableByteBuf;
import org.mariadb.jdbc.client.result.CompleteResult;
import org.mariadb.jdbc.client.result.StreamingResult;
import org.mariadb.jdbc.client.result.UpdatableResult;
import org.mariadb.jdbc.client.socket.Reader;
import org.mariadb.jdbc.client.socket.Writer;
import org.mariadb.jdbc.client.util.Parameters;
import org.mariadb.jdbc.export.ExceptionFactory;
import org.mariadb.jdbc.message.server.ErrorPacket;
import org.mariadb.jdbc.message.server.OkPacket;
import org.mariadb.jdbc.util.constants.ServerStatus;
public interface ClientMessage {
/**
* Encode client message to socket.
*
* @param writer socket writer
* @param context connection context
* @return number of client message written
* @throws IOException if socket error occur
* @throws SQLException if any issue occurs
*/
int encode(Writer writer, Context context) throws IOException, SQLException;
/**
* Number of parameter rows, and so expected return length
*
* @return batch update length
*/
default int batchUpdateLength() {
return 0;
}
/**
* Message description
*
* @return description
*/
default String description() {
return null;
}
/**
* Are return value encoded in binary protocol
*
* @return use binary protocol
*/
default boolean binaryProtocol() {
return false;
}
/**
* Can skip metadata
*
* @return can skip metadata
*/
default boolean canSkipMeta() {
return false;
}
/**
* default packet resultset parser
*
* @param stmt caller
* @param fetchSize fetch size
* @param maxRows maximum number of rows
* @param resultSetConcurrency resultset concurrency
* @param resultSetType resultset type
* @param closeOnCompletion must close caller on result parsing end
* @param reader packet reader
* @param writer packet writer
* @param context connection context
* @param exceptionFactory connection exception factory
* @param lock thread safe locks
* @param traceEnable is logging trace enable
* @param message client message
* @return results
* @throws IOException if any socket error occurs
* @throws SQLException for other kind of errors
*/
default Completion readPacket(
Statement stmt,
int fetchSize,
long maxRows,
int resultSetConcurrency,
int resultSetType,
boolean closeOnCompletion,
Reader reader,
Writer writer,
Context context,
ExceptionFactory exceptionFactory,
ReentrantLock lock,
boolean traceEnable,
ClientMessage message)
throws IOException, SQLException {
ReadableByteBuf buf = reader.readReusablePacket(traceEnable);
switch (buf.getByte()) {
// *********************************************************************************************************
// * OK response
// *********************************************************************************************************
case (byte) 0x00:
return new OkPacket(buf, context);
// *********************************************************************************************************
// * ERROR response
// *********************************************************************************************************
case (byte) 0xff:
// force current status to in transaction to ensure rollback/commit, since command may
// have issue a transaction
ErrorPacket errorPacket = new ErrorPacket(buf, context);
throw exceptionFactory
.withSql(this.description())
.create(
errorPacket.getMessage(), errorPacket.getSqlState(), errorPacket.getErrorCode());
case (byte) 0xfb:
buf.skip(1); // skip header
SQLException exception = null;
reader.getSequence().set((byte) 1);
InputStream is = getLocalInfileInputStream();
if (is == null) {
String fileName = buf.readStringNullEnd();
if (!message.validateLocalFileName(fileName, context)) {
exception =
exceptionFactory
.withSql(this.description())
.create(
String.format(
"LOAD DATA LOCAL INFILE asked for file '%s' that doesn't correspond to initial query %s. Possible malicious proxy changing server answer ! Command interrupted",
fileName, this.description()),
"HY000");
} else {
try {
is = new FileInputStream(fileName);
} catch (FileNotFoundException f) {
exception =
exceptionFactory
.withSql(this.description())
.create("Could not send file : " + f.getMessage(), "HY000", f);
}
}
}
// sending stream
if (is != null) {
try {
byte[] fileBuf = new byte[8192];
int len;
while ((len = is.read(fileBuf)) > 0) {
writer.writeBytes(fileBuf, 0, len);
writer.flush();
}
} finally {
is.close();
}
}
// after file send / having an error, sending an empty packet to keep connection state ok
writer.writeEmptyPacket();
Completion completion =
readPacket(
stmt,
fetchSize,
maxRows,
resultSetConcurrency,
resultSetType,
closeOnCompletion,
reader,
writer,
context,
exceptionFactory,
lock,
traceEnable,
message);
if (exception != null) {
throw exception;
}
return completion;
// *********************************************************************************************************
// * ResultSet
// *********************************************************************************************************
default:
int fieldCount = buf.readIntLengthEncodedNotNull();
ColumnDecoder[] ci;
boolean canSkipMeta = context.canSkipMeta() && this.canSkipMeta();
boolean skipMeta = canSkipMeta ? buf.readByte() == 0 : false;
if (canSkipMeta && skipMeta) {
ci = ((BasePreparedStatement) stmt).getMeta();
} else {
// read columns information's
ci = new ColumnDecoder[fieldCount];
for (int i = 0; i < fieldCount; i++) {
ci[i] =
ColumnDecoder.decode(
new StandardReadableByteBuf(reader.readPacket(traceEnable)),
context.isExtendedInfo());
}
}
if (canSkipMeta && !skipMeta) ((BasePreparedStatement) stmt).updateMeta(ci);
// intermediate EOF
if (!context.isEofDeprecated()) {
reader.skipPacket();
}
// read resultSet
if (resultSetConcurrency == ResultSet.CONCUR_UPDATABLE) {
return new UpdatableResult(
stmt,
binaryProtocol(),
maxRows,
ci,
reader,
context,
resultSetType,
closeOnCompletion,
traceEnable);
}
if (fetchSize != 0) {
if ((context.getServerStatus() & ServerStatus.MORE_RESULTS_EXISTS) > 0) {
context.setServerStatus(context.getServerStatus() - ServerStatus.MORE_RESULTS_EXISTS);
}
return new StreamingResult(
stmt,
binaryProtocol(),
maxRows,
ci,
reader,
context,
fetchSize,
lock,
resultSetType,
closeOnCompletion,
traceEnable);
} else {
return new CompleteResult(
stmt,
binaryProtocol(),
maxRows,
ci,
reader,
context,
resultSetType,
closeOnCompletion,
traceEnable);
}
}
}
/**
* Get current local infile input stream.
*
* @return default to null
*/
default InputStream getLocalInfileInputStream() {
return null;
}
/**
* Request for local file to be validated from current query.
*
* @param fileName server file request path
* @param context current connection context
* @return true if file name correspond to demand and query is a load local infile
*/
default boolean validateLocalFileName(String fileName, Context context) {
return false;
}
/**
* Check that file requested correspond to request.
*
* @param sql current command sql
* @param parameters current command parameter
* @param fileName file path request
* @param context current connection context
* @return true if file name correspond to demand and query is a load local infile
*/
static boolean validateLocalFileName(
String sql, Parameters parameters, String fileName, Context context) {
Pattern pattern =
Pattern.compile(
"^(\\s*\\/\\*([^\\*]|\\*[^\\/])*\\*\\/)*\\s*LOAD\\s+(DATA|XML)\\s+((LOW_PRIORITY|CONCURRENT)\\s+)?LOCAL\\s+INFILE\\s+'"
+ fileName
+ "'",
Pattern.CASE_INSENSITIVE);
if (pattern.matcher(sql).find()) {
return true;
}
if (parameters != null) {
pattern =
Pattern.compile(
"^(\\s*\\/\\*([^\\*]|\\*[^\\/])*\\*\\/)*\\s*LOAD\\s+(DATA|XML)\\s+((LOW_PRIORITY|CONCURRENT)\\s+)?LOCAL\\s+INFILE\\s+\\?",
Pattern.CASE_INSENSITIVE);
if (pattern.matcher(sql).find() && parameters.size() > 0) {
String paramString = parameters.get(0).bestEffortStringValue(context);
if (paramString != null) {
return paramString.toLowerCase().equals("'" + fileName.toLowerCase() + "'");
}
return true;
}
}
return false;
}
}