Mercurial > hg > orthanc

comparison OrthancFramework/Sources/SQLite/Statement.cpp @ 4044:d25f4c0fa160 framework

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
splitting code into OrthancFramework and OrthancServer
author Sebastien Jodogne <s.jodogne@gmail.com>
date Wed, 10 Jun 2020 20:30:34 +0200
parents Core/SQLite/Statement.cpp@113a9643e8bb
children 0ae2ca210077
comparison
equal deleted inserted replaced
4043:6c6239aec462 4044:d25f4c0fa160
1 /**
2 * Orthanc - A Lightweight, RESTful DICOM Store
3 *
4 * Copyright (C) 2012-2016 Sebastien Jodogne <s.jodogne@orthanc-labs.com>,
5 * Medical Physics Department, CHU of Liege, Belgium
6 *
7 * Copyright (c) 2012 The Chromium Authors. All rights reserved.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions are
11 * met:
12 *
13 * * Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * * Redistributions in binary form must reproduce the above
16 * copyright notice, this list of conditions and the following disclaimer
17 * in the documentation and/or other materials provided with the
18 * distribution.
19 * * Neither the name of Google Inc., the name of the CHU of Liege,
20 * nor the names of its contributors may be used to endorse or promote
21 * products derived from this software without specific prior written
22 * permission.
23 *
24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
25 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
26 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
27 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
28 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
29 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
30 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
31 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
32 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
33 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
34 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35 **/
36
37
38 #if ORTHANC_SQLITE_STANDALONE != 1
39 #include "../PrecompiledHeaders.h"
40 #endif
41
42 #include "Statement.h"
43 #include "Connection.h"
44
45 #include <string.h>
46 #include <stdio.h>
47 #include <algorithm>
48
49 #if (ORTHANC_SQLITE_STANDALONE == 1)
50 // Trace logging is disabled if this SQLite wrapper is used
51 // independently of Orthanc
52 # define LOG_CREATE(message);
53 # define LOG_APPLY(message);
54 #elif defined(NDEBUG)
55 // Trace logging is disabled in release builds
56 # include "../Logging.h"
57 # define LOG_CREATE(message);
58 # define LOG_APPLY(message);
59 #else
60 // Trace logging is enabled in debug builds
61 # include "../Logging.h"
62 # define LOG_CREATE(message) VLOG(1) << "SQLite::Statement create: " << message;
63 # define LOG_APPLY(message); // VLOG(1) << "SQLite::Statement apply: " << message;
64 #endif
65
66 #include "sqlite3.h"
67
68 #if defined(_MSC_VER)
69 #define snprintf _snprintf
70 #endif
71
72
73 namespace Orthanc
74 {
75 namespace SQLite
76 {
77 int Statement::CheckError(int err, ErrorCode code) const
78 {
79 bool succeeded = (err == SQLITE_OK || err == SQLITE_ROW || err == SQLITE_DONE);
80 if (!succeeded)
81 {
82 #if ORTHANC_SQLITE_STANDALONE != 1
83 char buffer[128];
84 snprintf(buffer, sizeof(buffer) - 1, "SQLite error code %d", err);
85 LOG(ERROR) << buffer;
86 #endif
87
88 throw OrthancSQLiteException(code);
89 }
90
91 return err;
92 }
93
94 void Statement::CheckOk(int err, ErrorCode code) const
95 {
96 if (err == SQLITE_RANGE)
97 {
98 // Binding to a non-existent variable is evidence of a serious error.
99 throw OrthancSQLiteException(ErrorCode_SQLiteBindOutOfRange);
100 }
101 else if (err != SQLITE_OK)
102 {
103 #if ORTHANC_SQLITE_STANDALONE != 1
104 char buffer[128];
105 snprintf(buffer, sizeof(buffer) - 1, "SQLite error code %d", err);
106 LOG(ERROR) << buffer;
107 #endif
108
109 throw OrthancSQLiteException(code);
110 }
111 }
112
113
114 Statement::Statement(Connection& database,
115 const StatementId& id,
116 const std::string& sql) :
117 reference_(database.GetCachedStatement(id, sql.c_str()))
118 {
119 Reset(true);
120 LOG_CREATE(sql);
121 }
122
123
124 Statement::Statement(Connection& database,
125 const StatementId& id,
126 const char* sql) :
127 reference_(database.GetCachedStatement(id, sql))
128 {
129 Reset(true);
130 LOG_CREATE(sql);
131 }
132
133
134 Statement::Statement(Connection& database,
135 const std::string& sql) :
136 reference_(database.GetWrappedObject(), sql.c_str())
137 {
138 LOG_CREATE(sql);
139 }
140
141
142 Statement::Statement(Connection& database,
143 const char* sql) :
144 reference_(database.GetWrappedObject(), sql)
145 {
146 LOG_CREATE(sql);
147 }
148
149
150 bool Statement::Run()
151 {
152 LOG_APPLY(sqlite3_sql(GetStatement()));
153
154 return CheckError(sqlite3_step(GetStatement()), ErrorCode_SQLiteCannotRun) == SQLITE_DONE;
155 }
156
157 bool Statement::Step()
158 {
159 LOG_APPLY(sqlite3_sql(GetStatement()));
160
161 return CheckError(sqlite3_step(GetStatement()), ErrorCode_SQLiteCannotStep) == SQLITE_ROW;
162 }
163
164 void Statement::Reset(bool clear_bound_vars)
165 {
166 // We don't call CheckError() here because sqlite3_reset() returns
167 // the last error that Step() caused thereby generating a second
168 // spurious error callback.
169 if (clear_bound_vars)
170 sqlite3_clear_bindings(GetStatement());
171 //VLOG(1) << "SQLite::Statement::Reset";
172 sqlite3_reset(GetStatement());
173 }
174
175 std::string Statement::GetOriginalSQLStatement()
176 {
177 return std::string(sqlite3_sql(GetStatement()));
178 }
179
180
181 void Statement::BindNull(int col)
182 {
183 CheckOk(sqlite3_bind_null(GetStatement(), col + 1),
184 ErrorCode_BadParameterType);
185 }
186
187 void Statement::BindBool(int col, bool val)
188 {
189 BindInt(col, val ? 1 : 0);
190 }
191
192 void Statement::BindInt(int col, int val)
193 {
194 CheckOk(sqlite3_bind_int(GetStatement(), col + 1, val),
195 ErrorCode_BadParameterType);
196 }
197
198 void Statement::BindInt64(int col, int64_t val)
199 {
200 CheckOk(sqlite3_bind_int64(GetStatement(), col + 1, val),
201 ErrorCode_BadParameterType);
202 }
203
204 void Statement::BindDouble(int col, double val)
205 {
206 CheckOk(sqlite3_bind_double(GetStatement(), col + 1, val),
207 ErrorCode_BadParameterType);
208 }
209
210 void Statement::BindCString(int col, const char* val)
211 {
212 CheckOk(sqlite3_bind_text(GetStatement(), col + 1, val, -1, SQLITE_TRANSIENT),
213 ErrorCode_BadParameterType);
214 }
215
216 void Statement::BindString(int col, const std::string& val)
217 {
218 CheckOk(sqlite3_bind_text(GetStatement(),
219 col + 1,
220 val.data(),
221 static_cast<int>(val.size()),
222 SQLITE_TRANSIENT),
223 ErrorCode_BadParameterType);
224 }
225
226 /*void Statement::BindString16(int col, const string16& value)
227 {
228 BindString(col, UTF16ToUTF8(value));
229 }*/
230
231 void Statement::BindBlob(int col, const void* val, int val_len)
232 {
233 CheckOk(sqlite3_bind_blob(GetStatement(), col + 1, val, val_len, SQLITE_TRANSIENT),
234 ErrorCode_BadParameterType);
235 }
236
237
238 int Statement::ColumnCount() const
239 {
240 return sqlite3_column_count(GetStatement());
241 }
242
243
244 ColumnType Statement::GetColumnType(int col) const
245 {
246 // Verify that our enum matches sqlite's values.
247 assert(COLUMN_TYPE_INTEGER == SQLITE_INTEGER);
248 assert(COLUMN_TYPE_FLOAT == SQLITE_FLOAT);
249 assert(COLUMN_TYPE_TEXT == SQLITE_TEXT);
250 assert(COLUMN_TYPE_BLOB == SQLITE_BLOB);
251 assert(COLUMN_TYPE_NULL == SQLITE_NULL);
252
253 return static_cast<ColumnType>(sqlite3_column_type(GetStatement(), col));
254 }
255
256 ColumnType Statement::GetDeclaredColumnType(int col) const
257 {
258 std::string column_type(sqlite3_column_decltype(GetStatement(), col));
259 std::transform(column_type.begin(), column_type.end(), column_type.begin(), tolower);
260
261 if (column_type == "integer")
262 return COLUMN_TYPE_INTEGER;
263 else if (column_type == "float")
264 return COLUMN_TYPE_FLOAT;
265 else if (column_type == "text")
266 return COLUMN_TYPE_TEXT;
267 else if (column_type == "blob")
268 return COLUMN_TYPE_BLOB;
269
270 return COLUMN_TYPE_NULL;
271 }
272
273 bool Statement::ColumnIsNull(int col) const
274 {
275 return sqlite3_column_type(GetStatement(), col) == SQLITE_NULL;
276 }
277
278 bool Statement::ColumnBool(int col) const
279 {
280 return !!ColumnInt(col);
281 }
282
283 int Statement::ColumnInt(int col) const
284 {
285 return sqlite3_column_int(GetStatement(), col);
286 }
287
288 int64_t Statement::ColumnInt64(int col) const
289 {
290 return sqlite3_column_int64(GetStatement(), col);
291 }
292
293 double Statement::ColumnDouble(int col) const
294 {
295 return sqlite3_column_double(GetStatement(), col);
296 }
297
298 std::string Statement::ColumnString(int col) const
299 {
300 const char* str = reinterpret_cast<const char*>(
301 sqlite3_column_text(GetStatement(), col));
302 int len = sqlite3_column_bytes(GetStatement(), col);
303
304 std::string result;
305 if (str && len > 0)
306 result.assign(str, len);
307 return result;
308 }
309
310 /*string16 Statement::ColumnString16(int col) const
311 {
312 std::string s = ColumnString(col);
313 return !s.empty() ? UTF8ToUTF16(s) : string16();
314 }*/
315
316 int Statement::ColumnByteLength(int col) const
317 {
318 return sqlite3_column_bytes(GetStatement(), col);
319 }
320
321 const void* Statement::ColumnBlob(int col) const
322 {
323 return sqlite3_column_blob(GetStatement(), col);
324 }
325
326 bool Statement::ColumnBlobAsString(int col, std::string* blob)
327 {
328 const void* p = ColumnBlob(col);
329 size_t len = ColumnByteLength(col);
330 blob->resize(len);
331 if (blob->size() != len) {
332 return false;
333 }
334 blob->assign(reinterpret_cast<const char*>(p), len);
335 return true;
336 }
337
338 /*bool Statement::ColumnBlobAsString16(int col, string16* val) const
339 {
340 const void* data = ColumnBlob(col);
341 size_t len = ColumnByteLength(col) / sizeof(char16);
342 val->resize(len);
343 if (val->size() != len)
344 return false;
345 val->assign(reinterpret_cast<const char16*>(data), len);
346 return true;
347 }*/
348
349 /*bool Statement::ColumnBlobAsVector(int col, std::vector<char>* val) const
350 {
351 val->clear();
352
353 const void* data = sqlite3_column_blob(GetStatement(), col);
354 int len = sqlite3_column_bytes(GetStatement(), col);
355 if (data && len > 0) {
356 val->resize(len);
357 memcpy(&(*val)[0], data, len);
358 }
359 return true;
360 }*/
361
362 /*bool Statement::ColumnBlobAsVector(
363 int col,
364 std::vector<unsigned char>* val) const
365 {
366 return ColumnBlobAsVector(col, reinterpret_cast< std::vector<char>* >(val));
367 }*/
368
369 }
370 }