sqlite3 1.5.0-arm64-darwin

data/ext/sqlite3/database.h

@@ -0,0 +1,17 @@
+#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();
+void set_sqlite3_func_result(sqlite3_context * ctx, VALUE result);
+VALUE sqlite3val2rb(sqlite3_value * val);
+
+#endif

data/ext/sqlite3/exception.c

@@ -0,0 +1,98 @@
+#include <sqlite3_ruby.h>
+
+void rb_sqlite3_raise(sqlite3 * db, int status)
+{
+  VALUE klass = Qnil;
+
+  /* Consider only lower 8 bits, to work correctly when
+     extended result codes are enabled. */
+  switch(status & 0xff) {
+    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;
+  }
+
+  klass = rb_exc_new2(klass, sqlite3_errmsg(db));
+  rb_iv_set(klass, "@code", INT2FIX(status));
+  rb_exc_raise(klass);
+}

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,252 @@
+require "mkmf"
+require "mini_portile2"
+
+module Sqlite3
+  module ExtConf
+    ENV_ALLOWLIST = ["CC", "CFLAGS", "LDFLAGS", "LIBS", "CPPFLAGS", "LT_SYS_LIBRARY_PATH", "CPP"]
+
+    class << self
+      def configure
+        configure_cross_compiler
+
+        if system_libraries?
+          message "Building sqlite3-ruby using system #{libname}.\n"
+          configure_system_libraries
+        else
+          message "Building sqlite3-ruby using packaged sqlite3.\n"
+          configure_packaged_libraries
+        end
+
+        configure_extension
+
+        create_makefile('sqlite3/sqlite3_native')
+      end
+
+      def configure_cross_compiler
+        RbConfig::CONFIG["CC"] = RbConfig::MAKEFILE_CONFIG["CC"] = ENV["CC"] if ENV["CC"]
+        ENV["CC"] = RbConfig::CONFIG["CC"]
+      end
+
+      def system_libraries?
+        sqlcipher? || enable_config("system-libraries")
+      end
+
+      def libname
+        sqlcipher? ? "sqlcipher" : "sqlite3"
+      end
+
+      def sqlcipher?
+        with_config("sqlcipher") ||
+          with_config("sqlcipher-dir") ||
+          with_config("sqlcipher-include") ||
+          with_config("sqlcipher-lib")
+      end
+
+      def configure_system_libraries
+        pkg_config(libname)
+        append_cppflags("-DUSING_SQLCIPHER") if sqlcipher?
+      end
+
+      def configure_packaged_libraries
+        minimal_recipe.tap do |recipe|
+          recipe.configure_options += ["--enable-shared=no", "--enable-static=yes"]
+          ENV.to_h.tap do |env|
+            additional_cflags = [
+              "-fPIC", # needed for linking the static library into a shared library
+              "-O2", # see https://github.com/sparklemotion/sqlite3-ruby/issues/335 for some benchmarks
+            ]
+            env["CFLAGS"] = [env["CFLAGS"], additional_cflags].flatten.join(" ")
+            recipe.configure_options += env.select { |k,v| ENV_ALLOWLIST.include?(k) }
+                                           .map { |key, value| "#{key}=#{value.strip}" }
+          end
+
+          unless File.exist?(File.join(recipe.target, recipe.host, recipe.name, recipe.version))
+            recipe.cook
+          end
+          recipe.activate
+
+          ENV["PKG_CONFIG_ALLOW_SYSTEM_CFLAGS"] = "t" # on macos, pkg-config will not return --cflags without this
+          pcfile = File.join(recipe.path, "lib", "pkgconfig", "sqlite3.pc")
+          if pkg_config(pcfile)
+            # see https://bugs.ruby-lang.org/issues/18490
+            libs = xpopen(["pkg-config", "--libs", "--static", pcfile], err: [:child, :out], &:read)
+            libs.split.each { |lib| append_ldflags(lib) } if $?.success?
+          else
+            abort("\nCould not configure the build properly. Please install either the `pkg-config` utility or the `pkg-config` rubygem.\n\n")
+          end
+        end
+      end
+
+      def configure_extension
+        if Gem::Requirement.new("< 2.7").satisfied_by?(Gem::Version.new(RUBY_VERSION))
+          append_cppflags("-DTAINTING_SUPPORT")
+        end
+
+        if find_header("sqlite3.h")
+          # noop
+        elsif sqlcipher? && find_header("sqlcipher/sqlite3.h")
+          append_cppflags("-DUSING_SQLCIPHER_INC_SUBDIR")
+        else
+          abort_could_not_find("sqlite3.h")
+        end
+
+        abort_could_not_find(libname) unless find_library(libname, "sqlite3_libversion_number", "sqlite3.h")
+
+        # Functions defined in 1.9 but not 1.8
+        have_func('rb_proc_arity')
+
+        # Functions defined in 2.1 but not 2.0
+        have_func('rb_integer_pack')
+
+        # 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')
+
+        unless have_func('sqlite3_open_v2') # https://www.sqlite.org/releaselog/3_5_0.html
+          abort("\nPlease use a version of SQLite3 >= 3.5.0\n\n")
+        end
+
+        have_func('sqlite3_prepare_v2')
+        have_type('sqlite3_int64', 'sqlite3.h')
+        have_type('sqlite3_uint64', 'sqlite3.h')
+      end
+
+      def minimal_recipe
+        MiniPortile.new(libname, sqlite3_config[:version]).tap do |recipe|
+          recipe.files = sqlite3_config[:files]
+          recipe.target = File.join(package_root_dir, "ports")
+          recipe.patch_files = Dir[File.join(package_root_dir, "patches", "*.patch")].sort
+        end
+      end
+
+      def package_root_dir
+        File.expand_path(File.join(File.dirname(__FILE__), "..", ".."))
+      end
+
+      def sqlite3_config
+        mini_portile_config[:sqlite3]
+      end
+
+      def mini_portile_config
+        {
+          sqlite3: {
+            # checksum verified by first checking the published sha3(256) checksum against https://sqlite.org/download.html:
+            #
+            # $ sha3sum -a 256 ports/archives/sqlite-autoconf-3390300.tar.gz
+            # dfa055c70724cd63f0b7da6e9f53530d8da51fe021e3f864d58c7c847d590e1d  ports/archives/sqlite-autoconf-3390300.tar.gz
+            #
+            # $ sha256sum ports/archives/sqlite-autoconf-3390300.tar.gz
+            # 7868fb3082be3f2cf4491c6fba6de2bddcbc293a35fefb0624ee3c13f01422b9  ports/archives/sqlite-autoconf-3390300.tar.gz
+            #
+            version: "3.39.3",
+            files: [{
+                      url: "https://www.sqlite.org/2022/sqlite-autoconf-3390300.tar.gz",
+                      sha256: "7868fb3082be3f2cf4491c6fba6de2bddcbc293a35fefb0624ee3c13f01422b9",
+                    }],
+          }
+        }
+      end
+
+      def abort_could_not_find(missing)
+        abort("\nCould not find #{missing}.\nPlease visit https://github.com/sparklemotion/sqlite3-ruby for installation instructions.\n\n")
+      end
+
+      def cross_build?
+        enable_config("cross-build")
+      end
+
+      def download
+        minimal_recipe.download
+      end
+
+      def print_help
+        print(<<~TEXT)
+          USAGE: ruby #{$PROGRAM_NAME} [options]
+
+            Flags that are always valid:
+
+                --disable-system-libraries
+                    Use the packaged libraries, and ignore the system libraries.
+                    (This is the default behavior.)
+
+                --enable-system-libraries
+                    Use system libraries instead of building and using the packaged libraries.
+
+                --with-sqlcipher
+                    Use libsqlcipher instead of libsqlite3.
+                    (Implies `--enable-system-libraries`.)
+
+                --help
+                    Display this message.
+
+
+            Flags only used when using system libraries:
+
+                General (applying to all system libraries):
+
+                    --with-opt-dir=DIRECTORY
+                        Look for headers and libraries in DIRECTORY.
+
+                    --with-opt-lib=DIRECTORY
+                        Look for libraries in DIRECTORY.
+
+                    --with-opt-include=DIRECTORY
+                        Look for headers in DIRECTORY.
+
+                Related to sqlcipher:
+
+                    --with-sqlcipher-dir=DIRECTORY
+                        Look for sqlcipher headers and library in DIRECTORY.
+                        (Implies `--with-sqlcipher` and `--enable-system-libraries`.)
+
+                    --with-sqlcipher-lib=DIRECTORY
+                        Look for sqlcipher library in DIRECTORY.
+                        (Implies `--with-sqlcipher` and `--enable-system-libraries`.)
+
+                    --with-sqlcipher-include=DIRECTORY
+                        Look for sqlcipher headers in DIRECTORY.
+                        (Implies `--with-sqlcipher` and `--enable-system-libraries`.)
+
+
+            Flags only used when building and using the packaged libraries:
+
+                --enable-cross-build
+                    Enable cross-build mode. (You probably do not want to set this manually.)
+
+
+            Environment variables used for compiling the C extension:
+
+                CC
+                    Use this path to invoke the compiler instead of `RbConfig::CONFIG['CC']`
+
+
+            Environment variables passed through to the compilation of packaged libraries:
+
+                CC
+                CPPFLAGS
+                CFLAGS
+                LDFLAGS
+                LIBS
+                LT_SYS_LIBRARY_PATH
+                CPP
+
+        TEXT
+      end
+    end
+  end
+end
+
+if arg_config("--help")
+  Sqlite3::ExtConf.print_help
+  exit!(0)
+end
+
+if arg_config("--download-dependencies")
+  Sqlite3::ExtConf.download
+  exit!(0)
+end
+
+Sqlite3::ExtConf.configure

data/ext/sqlite3/sqlite3.c

@@ -0,0 +1,163 @@
+#include <sqlite3_ruby.h>
+
+VALUE mSqlite3;
+VALUE cSqlite3Blob;
+
+int bignum_to_int64(VALUE value, sqlite3_int64 *result)
+{
+#ifdef HAVE_RB_INTEGER_PACK
+  const int nails = 0;
+  int t = rb_integer_pack(value, result, 1, sizeof(*result), nails,
+			  INTEGER_PACK_NATIVE_BYTE_ORDER|
+			  INTEGER_PACK_2COMP);
+  switch (t) {
+  case -2: case +2:
+    return 0;
+  case +1:
+    if (!nails) {
+      if (*result < 0) return 0;
+    }
+    break;
+  case -1:
+    if (!nails) {
+      if (*result >= 0) return 0;
+    }
+    else {
+      *result += INT64_MIN;
+    }
+    break;
+  }
+  return 1;
+#else
+# ifndef RBIGNUM_LEN
+#   define RBIGNUM_LEN(x) RBIGNUM(x)->len
+# endif
+  const long len = RBIGNUM_LEN(value);
+  if (len == 0) {
+    *result = 0;
+    return 1;
+  }
+  if (len > 63 / (SIZEOF_BDIGITS * CHAR_BIT) + 1) return 0;
+  if (len == 63 / (SIZEOF_BDIGITS * CHAR_BIT) + 1) {
+    const BDIGIT *digits = RBIGNUM_DIGITS(value);
+    BDIGIT blast = digits[len-1];
+    BDIGIT bmax = (BDIGIT)1UL << (63 % (CHAR_BIT * SIZEOF_BDIGITS));
+    if (blast > bmax) return 0;
+    if (blast == bmax) {
+      if (RBIGNUM_POSITIVE_P(value)) {
+	return 0;
+      }
+      else {
+	long i = len-1;
+	while (i) {
+	  if (digits[--i]) return 0;
+	}
+      }
+    }
+  }
+  *result = (sqlite3_int64)NUM2LL(value);
+  return 1;
+#endif
+}
+
+static VALUE libversion(VALUE UNUSED(klass))
+{
+  return INT2NUM(sqlite3_libversion_number());
+}
+
+static VALUE using_sqlcipher(VALUE UNUSED(klass))
+{
+#ifdef USING_SQLCIPHER
+  return Qtrue;
+#else
+  return Qfalse;
+#endif
+}
+
+/* Returns the compile time setting of the SQLITE_THREADSAFE flag.
+ * See: https://www.sqlite.org/c3ref/threadsafe.html
+ */
+static VALUE threadsafe_p(VALUE UNUSED(klass))
+{
+  return INT2NUM(sqlite3_threadsafe());
+}
+
+void init_sqlite3_constants()
+{
+  VALUE mSqlite3Constants;
+  VALUE mSqlite3Open;
+
+  mSqlite3Constants = rb_define_module_under(mSqlite3, "Constants");
+
+  /* sqlite3_open_v2 flags for Database::new */
+  mSqlite3Open = rb_define_module_under(mSqlite3Constants, "Open");
+
+  /* symbols = IO.readlines('sqlite3.h').map { |n| /\A#define\s+(SQLITE_OPEN_\w+)\s/ =~ n && $1 }.compact
+   * pad = symbols.map(&:length).max - 9
+   * symbols.each { |s| printf %Q{  rb_define_const(mSqlite3Open, %-#{pad}s INT2FIX(#{s}));\n}, '"' + s[12..-1] + '",' }
+   */
+  rb_define_const(mSqlite3Open, "READONLY",       INT2FIX(SQLITE_OPEN_READONLY));
+  rb_define_const(mSqlite3Open, "READWRITE",      INT2FIX(SQLITE_OPEN_READWRITE));
+  rb_define_const(mSqlite3Open, "CREATE",         INT2FIX(SQLITE_OPEN_CREATE));
+  rb_define_const(mSqlite3Open, "DELETEONCLOSE",  INT2FIX(SQLITE_OPEN_DELETEONCLOSE));
+  rb_define_const(mSqlite3Open, "EXCLUSIVE",      INT2FIX(SQLITE_OPEN_EXCLUSIVE));
+  rb_define_const(mSqlite3Open, "MAIN_DB",        INT2FIX(SQLITE_OPEN_MAIN_DB));
+  rb_define_const(mSqlite3Open, "TEMP_DB",        INT2FIX(SQLITE_OPEN_TEMP_DB));
+  rb_define_const(mSqlite3Open, "TRANSIENT_DB",   INT2FIX(SQLITE_OPEN_TRANSIENT_DB));
+  rb_define_const(mSqlite3Open, "MAIN_JOURNAL",   INT2FIX(SQLITE_OPEN_MAIN_JOURNAL));
+  rb_define_const(mSqlite3Open, "TEMP_JOURNAL",   INT2FIX(SQLITE_OPEN_TEMP_JOURNAL));
+  rb_define_const(mSqlite3Open, "SUBJOURNAL",     INT2FIX(SQLITE_OPEN_SUBJOURNAL));
+  rb_define_const(mSqlite3Open, "MASTER_JOURNAL", INT2FIX(SQLITE_OPEN_MASTER_JOURNAL));
+  rb_define_const(mSqlite3Open, "NOMUTEX",        INT2FIX(SQLITE_OPEN_NOMUTEX));
+  rb_define_const(mSqlite3Open, "FULLMUTEX",      INT2FIX(SQLITE_OPEN_FULLMUTEX));
+#ifdef SQLITE_OPEN_AUTOPROXY
+  /* SQLITE_VERSION_NUMBER>=3007002 */
+  rb_define_const(mSqlite3Open, "AUTOPROXY",      INT2FIX(SQLITE_OPEN_AUTOPROXY));
+  rb_define_const(mSqlite3Open, "SHAREDCACHE",    INT2FIX(SQLITE_OPEN_SHAREDCACHE));
+  rb_define_const(mSqlite3Open, "PRIVATECACHE",   INT2FIX(SQLITE_OPEN_PRIVATECACHE));
+  rb_define_const(mSqlite3Open, "WAL",            INT2FIX(SQLITE_OPEN_WAL));
+#endif
+#ifdef SQLITE_OPEN_URI
+  /* SQLITE_VERSION_NUMBER>=3007007 */
+  rb_define_const(mSqlite3Open, "URI",            INT2FIX(SQLITE_OPEN_URI));
+#endif
+#ifdef SQLITE_OPEN_MEMORY
+  /* SQLITE_VERSION_NUMBER>=3007013 */
+  rb_define_const(mSqlite3Open, "MEMORY",         INT2FIX(SQLITE_OPEN_MEMORY));
+#endif
+}
+
+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_constants();
+  init_sqlite3_database();
+  init_sqlite3_statement();
+#ifdef HAVE_SQLITE3_BACKUP_INIT
+  init_sqlite3_backup();
+#endif
+  rb_define_singleton_method(mSqlite3, "sqlcipher?", using_sqlcipher, 0);
+  rb_define_singleton_method(mSqlite3, "libversion", libversion, 0);
+  rb_define_singleton_method(mSqlite3, "threadsafe", threadsafe_p, 0);
+  rb_define_const(mSqlite3, "SQLITE_VERSION", rb_str_new2(SQLITE_VERSION));
+  rb_define_const(mSqlite3, "SQLITE_VERSION_NUMBER", INT2FIX(SQLITE_VERSION_NUMBER));
+  rb_define_const(mSqlite3, "SQLITE_LOADED_VERSION", rb_str_new2(sqlite3_libversion()));
+
+}

data/ext/sqlite3/sqlite3_ruby.h

@@ -0,0 +1,48 @@
+#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
+
+#include <ruby/encoding.h>
+
+#define USASCII_P(_obj) (rb_enc_get_index(_obj) == rb_usascii_encindex())
+#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()))
+
+#ifdef USING_SQLCIPHER_INC_SUBDIR
+#  include <sqlcipher/sqlite3.h>
+#else
+#  include <sqlite3.h>
+#endif
+
+#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>
+
+int bignum_to_int64(VALUE big, sqlite3_int64 *result);
+
+#endif