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

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
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/OrthancFramework/Sources/SQLite/Statement.cpp	Wed Jun 10 20:30:34 2020 +0200
@@ -0,0 +1,370 @@
+/**
+ * Orthanc - A Lightweight, RESTful DICOM Store
+ *
+ * Copyright (C) 2012-2016 Sebastien Jodogne <s.jodogne@orthanc-labs.com>,
+ * Medical Physics Department, CHU of Liege, Belgium
+ *
+ * Copyright (c) 2012 The Chromium Authors. All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met:
+ *
+ *    * Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ *    * Redistributions in binary form must reproduce the above
+ * copyright notice, this list of conditions and the following disclaimer
+ * in the documentation and/or other materials provided with the
+ * distribution.
+ *    * Neither the name of Google Inc., the name of the CHU of Liege,
+ * nor the names of its contributors may be used to endorse or promote
+ * products derived from this software without specific prior written
+ * permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ **/
+
+
+#if ORTHANC_SQLITE_STANDALONE != 1
+#include "../PrecompiledHeaders.h"
+#endif
+
+#include "Statement.h"
+#include "Connection.h"
+
+#include <string.h>
+#include <stdio.h>
+#include <algorithm>
+
+#if (ORTHANC_SQLITE_STANDALONE == 1)
+// Trace logging is disabled if this SQLite wrapper is used
+// independently of Orthanc
+#  define LOG_CREATE(message);
+#  define LOG_APPLY(message);
+#elif defined(NDEBUG)
+// Trace logging is disabled in release builds
+#  include "../Logging.h"
+#  define LOG_CREATE(message);
+#  define LOG_APPLY(message);
+#else
+// Trace logging is enabled in debug builds
+#  include "../Logging.h"
+#  define LOG_CREATE(message)  VLOG(1) << "SQLite::Statement create: " << message;
+#  define LOG_APPLY(message);  // VLOG(1) << "SQLite::Statement apply: " << message;
+#endif
+
+#include "sqlite3.h"
+
+#if defined(_MSC_VER)
+#define snprintf _snprintf
+#endif
+
+
+namespace Orthanc
+{
+  namespace SQLite
+  {
+    int Statement::CheckError(int err, ErrorCode code) const
+    {
+      bool succeeded = (err == SQLITE_OK || err == SQLITE_ROW || err == SQLITE_DONE);
+      if (!succeeded)
+      {
+#if ORTHANC_SQLITE_STANDALONE != 1
+        char buffer[128];
+        snprintf(buffer, sizeof(buffer) - 1, "SQLite error code %d", err);
+        LOG(ERROR) << buffer;
+#endif
+
+        throw OrthancSQLiteException(code);
+      }
+
+      return err;
+    }
+
+    void Statement::CheckOk(int err, ErrorCode code) const 
+    {
+      if (err == SQLITE_RANGE)
+      {
+        // Binding to a non-existent variable is evidence of a serious error.
+        throw OrthancSQLiteException(ErrorCode_SQLiteBindOutOfRange);
+      }
+      else if (err != SQLITE_OK)
+      {
+#if ORTHANC_SQLITE_STANDALONE != 1
+        char buffer[128];
+        snprintf(buffer, sizeof(buffer) - 1, "SQLite error code %d", err);
+        LOG(ERROR) << buffer;
+#endif
+
+        throw OrthancSQLiteException(code);
+      }
+    }
+
+
+    Statement::Statement(Connection& database,
+                         const StatementId& id,
+                         const std::string& sql) : 
+      reference_(database.GetCachedStatement(id, sql.c_str()))
+    {
+      Reset(true);
+      LOG_CREATE(sql);
+    }
+
+
+    Statement::Statement(Connection& database,
+                         const StatementId& id,
+                         const char* sql) : 
+      reference_(database.GetCachedStatement(id, sql))
+    {
+      Reset(true);
+      LOG_CREATE(sql);
+    }
+
+
+    Statement::Statement(Connection& database,
+                         const std::string& sql) :
+      reference_(database.GetWrappedObject(), sql.c_str())
+    {
+      LOG_CREATE(sql);
+    }
+
+
+    Statement::Statement(Connection& database,
+                         const char* sql) :
+      reference_(database.GetWrappedObject(), sql)
+    {
+      LOG_CREATE(sql);
+    }
+
+
+    bool Statement::Run()
+    {
+      LOG_APPLY(sqlite3_sql(GetStatement()));
+
+      return CheckError(sqlite3_step(GetStatement()), ErrorCode_SQLiteCannotRun) == SQLITE_DONE;
+    }
+
+    bool Statement::Step()
+    {
+      LOG_APPLY(sqlite3_sql(GetStatement()));
+
+      return CheckError(sqlite3_step(GetStatement()), ErrorCode_SQLiteCannotStep) == SQLITE_ROW;
+    }
+
+    void Statement::Reset(bool clear_bound_vars) 
+    {
+      // We don't call CheckError() here because sqlite3_reset() returns
+      // the last error that Step() caused thereby generating a second
+      // spurious error callback.
+      if (clear_bound_vars)
+        sqlite3_clear_bindings(GetStatement());
+      //VLOG(1) << "SQLite::Statement::Reset";
+      sqlite3_reset(GetStatement());
+    }
+
+    std::string Statement::GetOriginalSQLStatement()
+    {
+      return std::string(sqlite3_sql(GetStatement()));
+    }
+
+
+    void Statement::BindNull(int col)
+    {
+      CheckOk(sqlite3_bind_null(GetStatement(), col + 1),
+              ErrorCode_BadParameterType);
+    }
+
+    void Statement::BindBool(int col, bool val) 
+    {
+      BindInt(col, val ? 1 : 0);
+    }
+
+    void Statement::BindInt(int col, int val) 
+    {
+      CheckOk(sqlite3_bind_int(GetStatement(), col + 1, val),
+              ErrorCode_BadParameterType);
+    }
+
+    void Statement::BindInt64(int col, int64_t val) 
+    {
+      CheckOk(sqlite3_bind_int64(GetStatement(), col + 1, val),
+              ErrorCode_BadParameterType);
+    }
+
+    void Statement::BindDouble(int col, double val) 
+    {
+      CheckOk(sqlite3_bind_double(GetStatement(), col + 1, val),
+              ErrorCode_BadParameterType);
+    }
+
+    void Statement::BindCString(int col, const char* val) 
+    {
+      CheckOk(sqlite3_bind_text(GetStatement(), col + 1, val, -1, SQLITE_TRANSIENT),
+              ErrorCode_BadParameterType);
+    }
+
+    void Statement::BindString(int col, const std::string& val) 
+    {
+      CheckOk(sqlite3_bind_text(GetStatement(),
+                                col + 1,
+                                val.data(),
+                                static_cast<int>(val.size()),
+                                SQLITE_TRANSIENT),
+              ErrorCode_BadParameterType);
+    }
+
+    /*void Statement::BindString16(int col, const string16& value) 
+      {
+      BindString(col, UTF16ToUTF8(value));
+      }*/
+
+    void Statement::BindBlob(int col, const void* val, int val_len) 
+    {
+      CheckOk(sqlite3_bind_blob(GetStatement(), col + 1, val, val_len, SQLITE_TRANSIENT),
+              ErrorCode_BadParameterType);
+    }
+
+
+    int Statement::ColumnCount() const 
+    {
+      return sqlite3_column_count(GetStatement());
+    }
+
+
+    ColumnType Statement::GetColumnType(int col) const 
+    {
+      // Verify that our enum matches sqlite's values.
+      assert(COLUMN_TYPE_INTEGER == SQLITE_INTEGER);
+      assert(COLUMN_TYPE_FLOAT == SQLITE_FLOAT);
+      assert(COLUMN_TYPE_TEXT == SQLITE_TEXT);
+      assert(COLUMN_TYPE_BLOB == SQLITE_BLOB);
+      assert(COLUMN_TYPE_NULL == SQLITE_NULL);
+
+      return static_cast<ColumnType>(sqlite3_column_type(GetStatement(), col));
+    }
+
+    ColumnType Statement::GetDeclaredColumnType(int col) const 
+    {
+      std::string column_type(sqlite3_column_decltype(GetStatement(), col));
+      std::transform(column_type.begin(), column_type.end(), column_type.begin(), tolower);
+
+      if (column_type == "integer")
+        return COLUMN_TYPE_INTEGER;
+      else if (column_type == "float")
+        return COLUMN_TYPE_FLOAT;
+      else if (column_type == "text")
+        return COLUMN_TYPE_TEXT;
+      else if (column_type == "blob")
+        return COLUMN_TYPE_BLOB;
+
+      return COLUMN_TYPE_NULL;
+    }
+
+    bool Statement::ColumnIsNull(int col) const 
+    {
+      return sqlite3_column_type(GetStatement(), col) == SQLITE_NULL;
+    }
+
+    bool Statement::ColumnBool(int col) const 
+    {
+      return !!ColumnInt(col);
+    }
+
+    int Statement::ColumnInt(int col) const 
+    {
+      return sqlite3_column_int(GetStatement(), col);
+    }
+
+    int64_t Statement::ColumnInt64(int col) const 
+    {
+      return sqlite3_column_int64(GetStatement(), col);
+    }
+
+    double Statement::ColumnDouble(int col) const 
+    {
+      return sqlite3_column_double(GetStatement(), col);
+    }
+
+    std::string Statement::ColumnString(int col) const 
+    {
+      const char* str = reinterpret_cast<const char*>(
+        sqlite3_column_text(GetStatement(), col));
+      int len = sqlite3_column_bytes(GetStatement(), col);
+
+      std::string result;
+      if (str && len > 0)
+        result.assign(str, len);
+      return result;
+    }
+
+    /*string16 Statement::ColumnString16(int col) const 
+      {
+      std::string s = ColumnString(col);
+      return !s.empty() ? UTF8ToUTF16(s) : string16();
+      }*/
+
+    int Statement::ColumnByteLength(int col) const 
+    {
+      return sqlite3_column_bytes(GetStatement(), col);
+    }
+
+    const void* Statement::ColumnBlob(int col) const 
+    {
+      return sqlite3_column_blob(GetStatement(), col);
+    }
+
+    bool Statement::ColumnBlobAsString(int col, std::string* blob) 
+    {
+      const void* p = ColumnBlob(col);
+      size_t len = ColumnByteLength(col);
+      blob->resize(len);
+      if (blob->size() != len) {
+        return false;
+      }
+      blob->assign(reinterpret_cast<const char*>(p), len);
+      return true;
+    }
+
+    /*bool Statement::ColumnBlobAsString16(int col, string16* val) const 
+      {
+      const void* data = ColumnBlob(col);
+      size_t len = ColumnByteLength(col) / sizeof(char16);
+      val->resize(len);
+      if (val->size() != len)
+      return false;
+      val->assign(reinterpret_cast<const char16*>(data), len);
+      return true;
+      }*/
+
+    /*bool Statement::ColumnBlobAsVector(int col, std::vector<char>* val) const 
+    {
+      val->clear();
+
+      const void* data = sqlite3_column_blob(GetStatement(), col);
+      int len = sqlite3_column_bytes(GetStatement(), col);
+      if (data && len > 0) {
+        val->resize(len);
+        memcpy(&(*val)[0], data, len);
+      }
+      return true;
+      }*/
+
+    /*bool Statement::ColumnBlobAsVector(
+      int col,
+      std::vector<unsigned char>* val) const 
+    {
+      return ColumnBlobAsVector(col, reinterpret_cast< std::vector<char>* >(val));
+      }*/
+
+  }
+}