femto-sqlite3 1.3.7

data/ext/sqlite3/database.h

@@ -0,0 +1,15 @@
+#ifndef SQLITE3_DATABASE_RUBY
+#define SQLITE3_DATABASE_RUBY
+
+#include <sqlite3_ruby.h>
+
+struct _sqlite3Ruby {
+  sqlite3 *db;
+};
+
+typedef struct _sqlite3Ruby sqlite3Ruby;
+typedef sqlite3Ruby * sqlite3RubyPtr;
+
+void init_sqlite3_database();
+
+#endif

data/ext/sqlite3/exception.c

@@ -0,0 +1,94 @@
+#include <sqlite3_ruby.h>
+
+void rb_sqlite3_raise(sqlite3 * db, int status)
+{
+  VALUE klass = Qnil;
+
+  switch(status) {
+    case SQLITE_OK:
+      return;
+      break;
+    case SQLITE_ERROR:
+      klass = rb_path2class("SQLite3::SQLException");
+      break;
+    case SQLITE_INTERNAL:
+      klass = rb_path2class("SQLite3::InternalException");
+      break;
+    case SQLITE_PERM:
+      klass = rb_path2class("SQLite3::PermissionException");
+      break;
+    case SQLITE_ABORT:
+      klass = rb_path2class("SQLite3::AbortException");
+      break;
+    case SQLITE_BUSY:
+      klass = rb_path2class("SQLite3::BusyException");
+      break;
+    case SQLITE_LOCKED:
+      klass = rb_path2class("SQLite3::LockedException");
+      break;
+    case SQLITE_NOMEM:
+      klass = rb_path2class("SQLite3::MemoryException");
+      break;
+    case SQLITE_READONLY:
+      klass = rb_path2class("SQLite3::ReadOnlyException");
+      break;
+    case SQLITE_INTERRUPT:
+      klass = rb_path2class("SQLite3::InterruptException");
+      break;
+    case SQLITE_IOERR:
+      klass = rb_path2class("SQLite3::IOException");
+      break;
+    case SQLITE_CORRUPT:
+      klass = rb_path2class("SQLite3::CorruptException");
+      break;
+    case SQLITE_NOTFOUND:
+      klass = rb_path2class("SQLite3::NotFoundException");
+      break;
+    case SQLITE_FULL:
+      klass = rb_path2class("SQLite3::FullException");
+      break;
+    case SQLITE_CANTOPEN:
+      klass = rb_path2class("SQLite3::CantOpenException");
+      break;
+    case SQLITE_PROTOCOL:
+      klass = rb_path2class("SQLite3::ProtocolException");
+      break;
+    case SQLITE_EMPTY:
+      klass = rb_path2class("SQLite3::EmptyException");
+      break;
+    case SQLITE_SCHEMA:
+      klass = rb_path2class("SQLite3::SchemaChangedException");
+      break;
+    case SQLITE_TOOBIG:
+      klass = rb_path2class("SQLite3::TooBigException");
+      break;
+    case SQLITE_CONSTRAINT:
+      klass = rb_path2class("SQLite3::ConstraintException");
+      break;
+    case SQLITE_MISMATCH:
+      klass = rb_path2class("SQLite3::MismatchException");
+      break;
+    case SQLITE_MISUSE:
+      klass = rb_path2class("SQLite3::MisuseException");
+      break;
+    case SQLITE_NOLFS:
+      klass = rb_path2class("SQLite3::UnsupportedException");
+      break;
+    case SQLITE_AUTH:
+      klass = rb_path2class("SQLite3::AuthorizationException");
+      break;
+    case SQLITE_FORMAT:
+      klass = rb_path2class("SQLite3::FormatException");
+      break;
+    case SQLITE_RANGE:
+      klass = rb_path2class("SQLite3::RangeException");
+      break;
+    case SQLITE_NOTADB:
+      klass = rb_path2class("SQLite3::NotADatabaseException");
+      break;
+    default:
+      klass = rb_eRuntimeError;
+  }
+
+  rb_raise(klass, "%s", sqlite3_errmsg(db));
+}

data/ext/sqlite3/exception.h

@@ -0,0 +1,8 @@
+#ifndef SQLITE3_EXCEPTION_RUBY
+#define SQLITE3_EXCEPTION_RUBY
+
+#define CHECK(_db, _status) rb_sqlite3_raise(_db, _status);
+
+void rb_sqlite3_raise(sqlite3 * db, int status);
+
+#endif

data/ext/sqlite3/extconf.rb

@@ -0,0 +1,51 @@
+ENV['RC_ARCHS'] = '' if RUBY_PLATFORM =~ /darwin/
+
+require 'mkmf'
+
+# :stopdoc:
+
+RbConfig::MAKEFILE_CONFIG['CC'] = ENV['CC'] if ENV['CC']
+
+# --with-sqlite3-{dir,include,lib}
+dir_config("sqlite3")
+
+# prioritize local builds
+if enable_config("local", false)
+  $LDFLAGS = ENV.fetch("LDFLAGS", "")
+end
+
+if RbConfig::CONFIG["host_os"] =~ /mswin/
+  $CFLAGS << ' -W3'
+end
+
+def asplode missing
+  if RUBY_PLATFORM =~ /mingw|mswin/
+    abort "#{missing} is missing. Install SQLite3 from " +
+          "http://www.sqlite.org/ first."
+  else
+    abort <<-error
+#{missing} is missing. Try 'port install sqlite3 +universal'
+or 'yum install sqlite-devel' and check your shared library search path (the
+location where your sqlite3 shared library is located).
+    error
+  end
+end
+
+asplode('sqlite3.h')  unless find_header  'sqlite3.h'
+asplode('sqlite3') unless find_library 'sqlite3', 'sqlite3_libversion_number'
+
+# Functions defined in 1.9 but not 1.8
+have_func('rb_proc_arity')
+
+# These functions may not be defined
+have_func('sqlite3_initialize')
+have_func('sqlite3_backup_init')
+have_func('sqlite3_column_database_name')
+have_func('sqlite3_enable_load_extension')
+have_func('sqlite3_load_extension')
+have_func('sqlite3_open_v2')
+have_func('sqlite3_prepare_v2')
+have_type('sqlite3_int64', 'sqlite3.h')
+have_type('sqlite3_uint64', 'sqlite3.h')
+
+create_makefile('sqlite3/sqlite3_native')

data/ext/sqlite3/sqlite3.c

@@ -0,0 +1,40 @@
+#include <sqlite3_ruby.h>
+
+VALUE mSqlite3;
+VALUE cSqlite3Blob;
+
+static VALUE libversion(VALUE UNUSED(klass))
+{
+  return INT2NUM(sqlite3_libversion_number());
+}
+
+void Init_sqlite3_native()
+{
+  /*
+   * SQLite3 is a wrapper around the popular database
+   * sqlite[http://sqlite.org].
+   *
+   * For an example of usage, see SQLite3::Database.
+   */
+  mSqlite3     = rb_define_module("SQLite3");
+
+  /* A class for differentiating between strings and blobs, when binding them
+   * into statements.
+   */
+  cSqlite3Blob = rb_define_class_under(mSqlite3, "Blob", rb_cString);
+
+  /* Initialize the sqlite3 library */
+#ifdef HAVE_SQLITE3_INITIALIZE
+  sqlite3_initialize();
+#endif
+
+  init_sqlite3_database();
+  init_sqlite3_statement();
+#ifdef HAVE_SQLITE3_BACKUP_INIT
+  init_sqlite3_backup();
+#endif
+
+  rb_define_singleton_method(mSqlite3, "libversion", libversion, 0);
+  rb_define_const(mSqlite3, "SQLITE_VERSION", rb_str_new2(SQLITE_VERSION));
+  rb_define_const(mSqlite3, "SQLITE_VERSION_NUMBER", INT2FIX(SQLITE_VERSION_NUMBER));
+}

data/ext/sqlite3/sqlite3_ruby.h

@@ -0,0 +1,53 @@
+#ifndef SQLITE3_RUBY
+#define SQLITE3_RUBY
+
+#include <ruby.h>
+
+#ifdef UNUSED
+#elif defined(__GNUC__)
+# define UNUSED(x) UNUSED_ ## x __attribute__((unused))
+#elif defined(__LCLINT__)
+# define UNUSED(x) /*@unused@*/ x
+#else
+# define UNUSED(x) x
+#endif
+
+#ifndef RBIGNUM_LEN
+#define RBIGNUM_LEN(x) RBIGNUM(x)->len
+#endif
+
+#ifdef HAVE_RUBY_ENCODING_H
+#include <ruby/encoding.h>
+
+#define UTF8_P(_obj) (rb_enc_get_index(_obj) == rb_utf8_encindex())
+#define UTF16_LE_P(_obj) (rb_enc_get_index(_obj) == rb_enc_find_index("UTF-16LE"))
+#define UTF16_BE_P(_obj) (rb_enc_get_index(_obj) == rb_enc_find_index("UTF-16BE"))
+#define SQLITE3_UTF8_STR_NEW2(_obj) \
+    (rb_enc_associate_index(rb_str_new2(_obj), rb_utf8_encindex()))
+
+#else
+
+#define SQLITE3_UTF8_STR_NEW2(_obj) (rb_str_new2(_obj))
+
+#endif
+
+
+#include <sqlite3.h>
+
+#ifndef HAVE_TYPE_SQLITE3_INT64
+typedef sqlite_int64 sqlite3_int64;
+#endif
+
+#ifndef HAVE_TYPE_SQLITE3_UINT64
+typedef sqlite_uint64 sqlite3_uint64;
+#endif
+
+extern VALUE mSqlite3;
+extern VALUE cSqlite3Blob;
+
+#include <database.h>
+#include <statement.h>
+#include <exception.h>
+#include <backup.h>
+
+#endif

data/ext/sqlite3/statement.c

@@ -0,0 +1,438 @@
+#include <sqlite3_ruby.h>
+
+#define REQUIRE_OPEN_STMT(_ctxt) \
+  if(!_ctxt->st) \
+    rb_raise(rb_path2class("SQLite3::Exception"), "cannot use a closed statement");
+
+VALUE cSqlite3Statement;
+
+static void deallocate(void * ctx)
+{
+  sqlite3StmtRubyPtr c = (sqlite3StmtRubyPtr)ctx;
+  xfree(c);
+}
+
+static VALUE allocate(VALUE klass)
+{
+  sqlite3StmtRubyPtr ctx = xcalloc((size_t)1, sizeof(sqlite3StmtRuby));
+  ctx->st     = NULL;
+  ctx->done_p = 0;
+
+  return Data_Wrap_Struct(klass, NULL, deallocate, ctx);
+}
+
+/* call-seq: SQLite3::Statement.new(db, sql)
+ *
+ * Create a new statement attached to the given Database instance, and which
+ * encapsulates the given SQL text. If the text contains more than one
+ * statement (i.e., separated by semicolons), then the #remainder property
+ * will be set to the trailing text.
+ */
+static VALUE initialize(VALUE self, VALUE db, VALUE sql)
+{
+  sqlite3RubyPtr db_ctx;
+  sqlite3StmtRubyPtr ctx;
+  const char *tail = NULL;
+  int status;
+
+  StringValue(sql);
+
+  Data_Get_Struct(db, sqlite3Ruby, db_ctx);
+  Data_Get_Struct(self, sqlite3StmtRuby, ctx);
+
+  if(!db_ctx->db)
+    rb_raise(rb_eArgError, "prepare called on a closed database");
+
+#ifdef HAVE_RUBY_ENCODING_H
+  if(!UTF8_P(sql)) {
+    sql               = rb_str_export_to_enc(sql, rb_utf8_encoding());
+  }
+#endif
+
+#ifdef HAVE_SQLITE3_PREPARE_V2
+  status = sqlite3_prepare_v2(
+#else
+  status = sqlite3_prepare(
+#endif
+      db_ctx->db,
+      (const char *)StringValuePtr(sql),
+      (int)RSTRING_LEN(sql),
+      &ctx->st,
+      &tail
+  );
+
+  CHECK(db_ctx->db, status);
+
+  rb_iv_set(self, "@connection", db);
+  rb_iv_set(self, "@remainder", rb_str_new2(tail));
+  rb_iv_set(self, "@columns", Qnil);
+  rb_iv_set(self, "@types", Qnil);
+
+  return self;
+}
+
+/* call-seq: stmt.close
+ *
+ * Closes the statement by finalizing the underlying statement
+ * handle. The statement must not be used after being closed.
+ */
+static VALUE sqlite3_rb_close(VALUE self)
+{
+  sqlite3StmtRubyPtr ctx;
+  sqlite3 * db;
+
+  Data_Get_Struct(self, sqlite3StmtRuby, ctx);
+
+  REQUIRE_OPEN_STMT(ctx);
+
+  sqlite3_finalize(ctx->st);
+  ctx->st = NULL;
+
+  return self;
+}
+
+/* call-seq: stmt.closed?
+ *
+ * Returns true if the statement has been closed.
+ */
+static VALUE closed_p(VALUE self)
+{
+  sqlite3StmtRubyPtr ctx;
+  Data_Get_Struct(self, sqlite3StmtRuby, ctx);
+
+  if(!ctx->st) return Qtrue;
+
+  return Qfalse;
+}
+
+static VALUE step(VALUE self)
+{
+  sqlite3StmtRubyPtr ctx;
+  sqlite3_stmt *stmt;
+  int value, length;
+  VALUE list;
+#ifdef HAVE_RUBY_ENCODING_H
+  rb_encoding * internal_encoding;
+  int enc_index;
+#endif
+
+  Data_Get_Struct(self, sqlite3StmtRuby, ctx);
+
+  REQUIRE_OPEN_STMT(ctx);
+
+  if(ctx->done_p) return Qnil;
+
+#ifdef HAVE_RUBY_ENCODING_H
+  {
+      VALUE db          = rb_iv_get(self, "@connection");
+      VALUE encoding    = rb_funcall(db, rb_intern("encoding"), 0);
+      enc_index = NIL_P(encoding) ? rb_utf8_encindex() : rb_to_encoding_index(encoding);
+      internal_encoding = rb_default_internal_encoding();
+  }
+#endif
+
+  stmt = ctx->st;
+
+  value = sqlite3_step(stmt);
+  length = sqlite3_column_count(stmt);
+  list = rb_ary_new2((long)length);
+
+  switch(value) {
+    case SQLITE_ROW:
+      {
+        int i;
+        for(i = 0; i < length; i++) {
+          switch(sqlite3_column_type(stmt, i)) {
+            case SQLITE_INTEGER:
+              rb_ary_push(list, LL2NUM(sqlite3_column_int64(stmt, i)));
+              break;
+            case SQLITE_FLOAT:
+              rb_ary_push(list, rb_float_new(sqlite3_column_double(stmt, i)));
+              break;
+            case SQLITE_TEXT:
+              {
+                VALUE str = rb_tainted_str_new(
+                    (const char *)sqlite3_column_text(stmt, i),
+                    (long)sqlite3_column_bytes(stmt, i)
+                );
+#ifdef HAVE_RUBY_ENCODING_H
+                rb_enc_associate_index(str, enc_index);
+                if(internal_encoding)
+                  str = rb_str_export_to_enc(str, internal_encoding);
+#endif
+                rb_ary_push(list, str);
+              }
+              break;
+            case SQLITE_BLOB:
+              {
+                VALUE str = rb_tainted_str_new(
+                    (const char *)sqlite3_column_blob(stmt, i),
+                    (long)sqlite3_column_bytes(stmt, i)
+                );
+                rb_ary_push(list, str);
+              }
+              break;
+            case SQLITE_NULL:
+              rb_ary_push(list, Qnil);
+              break;
+            default:
+              rb_raise(rb_eRuntimeError, "bad type");
+          }
+        }
+      }
+      break;
+    case SQLITE_DONE:
+      ctx->done_p = 1;
+      return Qnil;
+      break;
+    default:
+      CHECK(sqlite3_db_handle(ctx->st), value);
+  }
+
+  return list;
+}
+
+/* call-seq: stmt.bind_param(key, value)
+ *
+ * Binds value to the named (or positional) placeholder. If +param+ is a
+ * Fixnum, it is treated as an index for a positional placeholder.
+ * Otherwise it is used as the name of the placeholder to bind to.
+ *
+ * See also #bind_params.
+ */
+static VALUE bind_param(VALUE self, VALUE key, VALUE value)
+{
+  sqlite3StmtRubyPtr ctx;
+  int status;
+  int index;
+
+  Data_Get_Struct(self, sqlite3StmtRuby, ctx);
+  REQUIRE_OPEN_STMT(ctx);
+
+  switch(TYPE(key)) {
+    case T_SYMBOL:
+      key = rb_funcall(key, rb_intern("to_s"), 0);
+    case T_STRING:
+      if(RSTRING_PTR(key)[0] != ':') key = rb_str_plus(rb_str_new2(":"), key);
+      index = sqlite3_bind_parameter_index(ctx->st, StringValuePtr(key));
+      break;
+    default:
+      index = (int)NUM2INT(key);
+  }
+
+  if(index == 0)
+    rb_raise(rb_path2class("SQLite3::Exception"), "no such bind parameter");
+
+  switch(TYPE(value)) {
+    case T_STRING:
+      if(CLASS_OF(value) == cSqlite3Blob
+#ifdef HAVE_RUBY_ENCODING_H
+              || rb_enc_get_index(value) == rb_ascii8bit_encindex()
+#endif
+        ) {
+        status = sqlite3_bind_blob(
+            ctx->st,
+            index,
+            (const char *)StringValuePtr(value),
+            (int)RSTRING_LEN(value),
+            SQLITE_TRANSIENT
+            );
+      } else {
+#ifdef HAVE_RUBY_ENCODING_H
+        if(!UTF8_P(value)) {
+              VALUE db          = rb_iv_get(self, "@connection");
+              VALUE encoding    = rb_funcall(db, rb_intern("encoding"), 0);
+              rb_encoding * enc = rb_to_encoding(encoding);
+              value = rb_str_export_to_enc(value, enc);
+          }
+#endif
+
+        status = sqlite3_bind_text(
+            ctx->st,
+            index,
+            (const char *)StringValuePtr(value),
+            (int)RSTRING_LEN(value),
+            SQLITE_TRANSIENT
+            );
+      }
+      break;
+    case T_BIGNUM:
+      if (RBIGNUM_LEN(value) * SIZEOF_BDIGITS <= 8) {
+          status = sqlite3_bind_int64(ctx->st, index, (sqlite3_int64)NUM2LL(value));
+          break;
+      }
+    case T_FLOAT:
+      status = sqlite3_bind_double(ctx->st, index, NUM2DBL(value));
+      break;
+    case T_FIXNUM:
+      status = sqlite3_bind_int64(ctx->st, index, (sqlite3_int64)FIX2LONG(value));
+      break;
+    case T_NIL:
+      status = sqlite3_bind_null(ctx->st, index);
+      break;
+    default:
+      rb_raise(rb_eRuntimeError, "can't prepare %s",
+          rb_class2name(CLASS_OF(value)));
+      break;
+  }
+
+  CHECK(sqlite3_db_handle(ctx->st), status);
+
+  return self;
+}
+
+/* call-seq: stmt.reset!
+ *
+ * Resets the statement. This is typically done internally, though it might
+ * occassionally be necessary to manually reset the statement.
+ */
+static VALUE reset_bang(VALUE self)
+{
+  sqlite3StmtRubyPtr ctx;
+  int status;
+
+  Data_Get_Struct(self, sqlite3StmtRuby, ctx);
+  REQUIRE_OPEN_STMT(ctx);
+
+  status = sqlite3_reset(ctx->st);
+
+  ctx->done_p = 0;
+
+  return self;
+}
+
+/* call-seq: stmt.clear_bindings!
+ *
+ * Resets the statement. This is typically done internally, though it might
+ * occassionally be necessary to manually reset the statement.
+ */
+static VALUE clear_bindings(VALUE self)
+{
+  sqlite3StmtRubyPtr ctx;
+  int status;
+
+  Data_Get_Struct(self, sqlite3StmtRuby, ctx);
+  REQUIRE_OPEN_STMT(ctx);
+
+  status = sqlite3_clear_bindings(ctx->st);
+
+  ctx->done_p = 0;
+
+  return self;
+}
+
+/* call-seq: stmt.done?
+ *
+ * returns true if all rows have been returned.
+ */
+static VALUE done_p(VALUE self)
+{
+  sqlite3StmtRubyPtr ctx;
+  Data_Get_Struct(self, sqlite3StmtRuby, ctx);
+
+  if(ctx->done_p) return Qtrue;
+  return Qfalse;
+}
+
+/* call-seq: stmt.column_count
+ *
+ * Returns the number of columns to be returned for this statement
+ */
+static VALUE column_count(VALUE self)
+{
+  sqlite3StmtRubyPtr ctx;
+  Data_Get_Struct(self, sqlite3StmtRuby, ctx);
+  REQUIRE_OPEN_STMT(ctx);
+
+  return INT2NUM((long)sqlite3_column_count(ctx->st));
+}
+
+/* call-seq: stmt.column_name(index)
+ *
+ * Get the column name at +index+.  0 based.
+ */
+static VALUE column_name(VALUE self, VALUE index)
+{
+  sqlite3StmtRubyPtr ctx;
+  const char * name;
+
+  Data_Get_Struct(self, sqlite3StmtRuby, ctx);
+  REQUIRE_OPEN_STMT(ctx);
+
+  name = sqlite3_column_name(ctx->st, (int)NUM2INT(index));
+
+  if(name) return SQLITE3_UTF8_STR_NEW2(name);
+  return Qnil;
+}
+
+/* call-seq: stmt.column_decltype(index)
+ *
+ * Get the column type at +index+.  0 based.
+ */
+static VALUE column_decltype(VALUE self, VALUE index)
+{
+  sqlite3StmtRubyPtr ctx;
+  const char * name;
+
+  Data_Get_Struct(self, sqlite3StmtRuby, ctx);
+  REQUIRE_OPEN_STMT(ctx);
+
+  name = sqlite3_column_decltype(ctx->st, (int)NUM2INT(index));
+
+  if(name) return rb_str_new2(name);
+  return Qnil;
+}
+
+/* call-seq: stmt.bind_parameter_count
+ *
+ * Return the number of bind parameters
+ */
+static VALUE bind_parameter_count(VALUE self)
+{
+  sqlite3StmtRubyPtr ctx;
+  Data_Get_Struct(self, sqlite3StmtRuby, ctx);
+  REQUIRE_OPEN_STMT(ctx);
+
+  return INT2NUM((long)sqlite3_bind_parameter_count(ctx->st));
+}
+
+#ifdef HAVE_SQLITE3_COLUMN_DATABASE_NAME
+
+/* call-seq: stmt.database_name(column_index)
+ *
+ * Return the database name for the column at +column_index+
+ */
+static VALUE database_name(VALUE self, VALUE index)
+{
+  sqlite3StmtRubyPtr ctx;
+  Data_Get_Struct(self, sqlite3StmtRuby, ctx);
+  REQUIRE_OPEN_STMT(ctx);
+
+  return SQLITE3_UTF8_STR_NEW2(
+      sqlite3_column_database_name(ctx->st, NUM2INT(index)));
+}
+
+#endif
+
+void init_sqlite3_statement()
+{
+  cSqlite3Statement = rb_define_class_under(mSqlite3, "Statement", rb_cObject);
+
+  rb_define_alloc_func(cSqlite3Statement, allocate);
+  rb_define_method(cSqlite3Statement, "initialize", initialize, 2);
+  rb_define_method(cSqlite3Statement, "close", sqlite3_rb_close, 0);
+  rb_define_method(cSqlite3Statement, "closed?", closed_p, 0);
+  rb_define_method(cSqlite3Statement, "bind_param", bind_param, 2);
+  rb_define_method(cSqlite3Statement, "reset!", reset_bang, 0);
+  rb_define_method(cSqlite3Statement, "clear_bindings!", clear_bindings, 0);
+  rb_define_method(cSqlite3Statement, "step", step, 0);
+  rb_define_method(cSqlite3Statement, "done?", done_p, 0);
+  rb_define_method(cSqlite3Statement, "column_count", column_count, 0);
+  rb_define_method(cSqlite3Statement, "column_name", column_name, 1);
+  rb_define_method(cSqlite3Statement, "column_decltype", column_decltype, 1);
+  rb_define_method(cSqlite3Statement, "bind_parameter_count", bind_parameter_count, 0);
+
+#ifdef HAVE_SQLITE3_COLUMN_DATABASE_NAME
+  rb_define_method(cSqlite3Statement, "database_name", database_name, 1);
+#endif
+}