ruby-mysql-ext 2.9.7

data/lib/mysql/charset.rb

@@ -0,0 +1,290 @@
+# Copyright (C) 2008-2010 TOMITA Masahiro
+# mailto:tommy@tmtm.org
+
+class Mysql
+  class Charset
+    def initialize(number, name, csname)
+      @number, @name, @csname = number, name, csname
+      @unsafe = false
+    end
+    attr_reader :number, :name, :csname
+    attr_accessor :unsafe
+
+    # [[charset_number, charset_name, collation_name, default], ...]
+    CHARSETS = [
+      [  1, "big5",     "big5_chinese_ci",       true ],
+      [  2, "latin2",   "latin2_czech_cs",       false],
+      [  3, "dec8",     "dec8_swedish_ci",       true ],
+      [  4, "cp850",    "cp850_general_ci",      true ],
+      [  5, "latin1",   "latin1_german1_ci",     false],
+      [  6, "hp8",      "hp8_english_ci",        true ],
+      [  7, "koi8r",    "koi8r_general_ci",      true ],
+      [  8, "latin1",   "latin1_swedish_ci",     true ],
+      [  9, "latin2",   "latin2_general_ci",     true ],
+      [ 10, "swe7",     "swe7_swedish_ci",       true ],
+      [ 11, "ascii",    "ascii_general_ci",      true ],
+      [ 12, "ujis",     "ujis_japanese_ci",      true ],
+      [ 13, "sjis",     "sjis_japanese_ci",      true ],
+      [ 14, "cp1251",   "cp1251_bulgarian_ci",   false],
+      [ 15, "latin1",   "latin1_danish_ci",      false],
+      [ 16, "hebrew",   "hebrew_general_ci",     true ],
+      [ 17, "filename", "filename",              true ],
+      [ 18, "tis620",   "tis620_thai_ci",        true ],
+      [ 19, "euckr",    "euckr_korean_ci",       true ],
+      [ 20, "latin7",   "latin7_estonian_cs",    false],
+      [ 21, "latin2",   "latin2_hungarian_ci",   false],
+      [ 22, "koi8u",    "koi8u_general_ci",      true ],
+      [ 23, "cp1251",   "cp1251_ukrainian_ci",   false],
+      [ 24, "gb2312",   "gb2312_chinese_ci",     true ],
+      [ 25, "greek",    "greek_general_ci",      true ],
+      [ 26, "cp1250",   "cp1250_general_ci",     true ],
+      [ 27, "latin2",   "latin2_croatian_ci",    false],
+      [ 28, "gbk",      "gbk_chinese_ci",        true ],
+      [ 29, "cp1257",   "cp1257_lithuanian_ci",  false],
+      [ 30, "latin5",   "latin5_turkish_ci",     true ],
+      [ 31, "latin1",   "latin1_german2_ci",     false],
+      [ 32, "armscii8", "armscii8_general_ci",   true ],
+      [ 33, "utf8",     "utf8_general_ci",       true ],
+      [ 34, "cp1250",   "cp1250_czech_cs",       false],
+      [ 35, "ucs2",     "ucs2_general_ci",       true ],
+      [ 36, "cp866",    "cp866_general_ci",      true ],
+      [ 37, "keybcs2",  "keybcs2_general_ci",    true ],
+      [ 38, "macce",    "macce_general_ci",      true ],
+      [ 39, "macroman", "macroman_general_ci",   true ],
+      [ 40, "cp852",    "cp852_general_ci",      true ],
+      [ 41, "latin7",   "latin7_general_ci",     true ],
+      [ 42, "latin7",   "latin7_general_cs",     false],
+      [ 43, "macce",    "macce_bin",             false],
+      [ 44, "cp1250",   "cp1250_croatian_ci",    false],
+      [ 47, "latin1",   "latin1_bin",            false],
+      [ 48, "latin1",   "latin1_general_ci",     false],
+      [ 49, "latin1",   "latin1_general_cs",     false],
+      [ 50, "cp1251",   "cp1251_bin",            false],
+      [ 51, "cp1251",   "cp1251_general_ci",     true ],
+      [ 52, "cp1251",   "cp1251_general_cs",     false],
+      [ 53, "macroman", "macroman_bin",          false],
+      [ 57, "cp1256",   "cp1256_general_ci",     true ],
+      [ 58, "cp1257",   "cp1257_bin",            false],
+      [ 59, "cp1257",   "cp1257_general_ci",     true ],
+      [ 63, "binary",   "binary",                true ],
+      [ 64, "armscii8", "armscii8_bin",          false],
+      [ 65, "ascii",    "ascii_bin",             false],
+      [ 66, "cp1250",   "cp1250_bin",            false],
+      [ 67, "cp1256",   "cp1256_bin",            false],
+      [ 68, "cp866",    "cp866_bin",             false],
+      [ 69, "dec8",     "dec8_bin",              false],
+      [ 70, "greek",    "greek_bin",             false],
+      [ 71, "hebrew",   "hebrew_bin",            false],
+      [ 72, "hp8",      "hp8_bin",               false],
+      [ 73, "keybcs2",  "keybcs2_bin",           false],
+      [ 74, "koi8r",    "koi8r_bin",             false],
+      [ 75, "koi8u",    "koi8u_bin",             false],
+      [ 77, "latin2",   "latin2_bin",            false],
+      [ 78, "latin5",   "latin5_bin",            false],
+      [ 79, "latin7",   "latin7_bin",            false],
+      [ 80, "cp850",    "cp850_bin",             false],
+      [ 81, "cp852",    "cp852_bin",             false],
+      [ 82, "swe7",     "swe7_bin",              false],
+      [ 83, "utf8",     "utf8_bin",              false],
+      [ 84, "big5",     "big5_bin",              false],
+      [ 85, "euckr",    "euckr_bin",             false],
+      [ 86, "gb2312",   "gb2312_bin",            false],
+      [ 87, "gbk",      "gbk_bin",               false],
+      [ 88, "sjis",     "sjis_bin",              false],
+      [ 89, "tis620",   "tis620_bin",            false],
+      [ 90, "ucs2",     "ucs2_bin",              false],
+      [ 91, "ujis",     "ujis_bin",              false],
+      [ 92, "geostd8",  "geostd8_general_ci",    true ],
+      [ 93, "geostd8",  "geostd8_bin",           false],
+      [ 94, "latin1",   "latin1_spanish_ci",     false],
+      [ 95, "cp932",    "cp932_japanese_ci",     true ],
+      [ 96, "cp932",    "cp932_bin",             false],
+      [ 97, "eucjpms",  "eucjpms_japanese_ci",   true ],
+      [ 98, "eucjpms",  "eucjpms_bin",           false],
+      [ 99, "cp1250",   "cp1250_polish_ci",      false],
+      [128, "ucs2",     "ucs2_unicode_ci",       false],
+      [129, "ucs2",     "ucs2_icelandic_ci",     false],
+      [130, "ucs2",     "ucs2_latvian_ci",       false],
+      [131, "ucs2",     "ucs2_romanian_ci",      false],
+      [132, "ucs2",     "ucs2_slovenian_ci",     false],
+      [133, "ucs2",     "ucs2_polish_ci",        false],
+      [134, "ucs2",     "ucs2_estonian_ci",      false],
+      [135, "ucs2",     "ucs2_spanish_ci",       false],
+      [136, "ucs2",     "ucs2_swedish_ci",       false],
+      [137, "ucs2",     "ucs2_turkish_ci",       false],
+      [138, "ucs2",     "ucs2_czech_ci",         false],
+      [139, "ucs2",     "ucs2_danish_ci",        false],
+      [140, "ucs2",     "ucs2_lithuanian_ci",    false],
+      [141, "ucs2",     "ucs2_slovak_ci",        false],
+      [142, "ucs2",     "ucs2_spanish2_ci",      false],
+      [143, "ucs2",     "ucs2_roman_ci",         false],
+      [144, "ucs2",     "ucs2_persian_ci",       false],
+      [145, "ucs2",     "ucs2_esperanto_ci",     false],
+      [146, "ucs2",     "ucs2_hungarian_ci",     false],
+      [192, "utf8",     "utf8_unicode_ci",       false],
+      [193, "utf8",     "utf8_icelandic_ci",     false],
+      [194, "utf8",     "utf8_latvian_ci",       false],
+      [195, "utf8",     "utf8_romanian_ci",      false],
+      [196, "utf8",     "utf8_slovenian_ci",     false],
+      [197, "utf8",     "utf8_polish_ci",        false],
+      [198, "utf8",     "utf8_estonian_ci",      false],
+      [199, "utf8",     "utf8_spanish_ci",       false],
+      [200, "utf8",     "utf8_swedish_ci",       false],
+      [201, "utf8",     "utf8_turkish_ci",       false],
+      [202, "utf8",     "utf8_czech_ci",         false],
+      [203, "utf8",     "utf8_danish_ci",        false],
+      [204, "utf8",     "utf8_lithuanian_ci",    false],
+      [205, "utf8",     "utf8_slovak_ci",        false],
+      [206, "utf8",     "utf8_spanish2_ci",      false],
+      [207, "utf8",     "utf8_roman_ci",         false],
+      [208, "utf8",     "utf8_persian_ci",       false],
+      [209, "utf8",     "utf8_esperanto_ci",     false],
+      [210, "utf8",     "utf8_hungarian_ci",     false],
+      [211, "utf8",     "utf8_sinhala_ci",       false],
+      [224, "utf8mb4",  "utf8mb4_unicode_ci",    false],
+      [225, "utf8mb4",  "utf8mb4_icelandic_ci",  false],
+      [226, "utf8mb4",  "utf8mb4_latvian_ci",    false],
+      [227, "utf8mb4",  "utf8mb4_romanian_ci",   false],
+      [228, "utf8mb4",  "utf8mb4_slovenian_ci",  false],
+      [229, "utf8mb4",  "utf8mb4_polish_ci",     false],
+      [230, "utf8mb4",  "utf8mb4_estonian_ci",   false],
+      [231, "utf8mb4",  "utf8mb4_spanish_ci",    false],
+      [232, "utf8mb4",  "utf8mb4_swedish_ci",    false],
+      [233, "utf8mb4",  "utf8mb4_turkish_ci",    false],
+      [234, "utf8mb4",  "utf8mb4_czech_ci",      false],
+      [235, "utf8mb4",  "utf8mb4_danish_ci",     false],
+      [236, "utf8mb4",  "utf8mb4_lithuanian_ci", false],
+      [237, "utf8mb4",  "utf8mb4_slovak_ci",     false],
+      [238, "utf8mb4",  "utf8mb4_spanish2_ci",   false],
+      [239, "utf8mb4",  "utf8mb4_roman_ci",      false],
+      [240, "utf8mb4",  "utf8mb4_persian_ci",    false],
+      [241, "utf8mb4",  "utf8mb4_esperanto_ci",  false],
+      [242, "utf8mb4",  "utf8mb4_hungarian_ci",  false],
+      [243, "utf8mb4",  "utf8mb4_sinhala_ci",    false],
+      [254, "utf8",     "utf8_general_cs",       false],
+    ]
+
+    UNSAFE_CHARSET = [
+      "big5", "sjis", "filename", "gbk", "ucs2", "cp932",
+    ]
+
+    NUMBER_TO_CHARSET = {}
+    COLLATION_TO_CHARSET = {}
+    CHARSET_DEFAULT = {}
+    CHARSETS.each do |number, csname, clname, default|
+      cs = Charset.new number, csname, clname
+      cs.unsafe = true if UNSAFE_CHARSET.include? csname
+      NUMBER_TO_CHARSET[number] = cs
+      COLLATION_TO_CHARSET[clname] = cs
+      CHARSET_DEFAULT[csname] = cs if default
+    end
+
+    BINARY_CHARSET_NUMBER = CHARSET_DEFAULT['binary'].number
+
+    def self.by_number(n)
+      raise ClientError, "unknown charset number: #{n}" unless NUMBER_TO_CHARSET.key? n
+      NUMBER_TO_CHARSET[n]
+    end
+
+    def self.by_name(str)
+      ret = COLLATION_TO_CHARSET[str] || CHARSET_DEFAULT[str]
+      raise ClientError, "unknown charset: #{str}" unless ret
+      ret
+    end
+
+    if defined? Encoding
+
+      # MySQL Charset -> Ruby's Encodeing
+      CHARSET_ENCODING = {
+        "armscii8" => nil,
+        "ascii"    => Encoding::US_ASCII,
+        "big5"     => Encoding::Big5,
+        "binary"   => Encoding::ASCII_8BIT,
+        "cp1250"   => Encoding::Windows_1250,
+        "cp1251"   => Encoding::Windows_1251,
+        "cp1256"   => Encoding::Windows_1256,
+        "cp1257"   => Encoding::Windows_1257,
+        "cp850"    => Encoding::CP850,
+        "cp852"    => Encoding::CP852,
+        "cp866"    => Encoding::IBM866,
+        "cp932"    => Encoding::Windows_31J,
+        "dec8"     => nil,
+        "eucjpms"  => Encoding::EucJP_ms,
+        "euckr"    => Encoding::EUC_KR,
+        "gb2312"   => Encoding::EUC_CN,
+        "gbk"      => Encoding::GBK,
+        "geostd8"  => nil,
+        "greek"    => Encoding::ISO_8859_7,
+        "hebrew"   => Encoding::ISO_8859_8,
+        "hp8"      => nil,
+        "keybcs2"  => nil,
+        "koi8r"    => Encoding::KOI8_R,
+        "koi8u"    => Encoding::KOI8_U,
+        "latin1"   => Encoding::ISO_8859_1,
+        "latin2"   => Encoding::ISO_8859_2,
+        "latin5"   => Encoding::ISO_8859_9,
+        "latin7"   => Encoding::ISO_8859_13,
+        "macce"    => Encoding::MacCentEuro,
+        "macroman" => Encoding::MacRoman,
+        "sjis"     => Encoding::SHIFT_JIS,
+        "swe7"     => nil,
+        "tis620"   => Encoding::TIS_620,
+        "ucs2"     => Encoding::UTF_16BE,
+        "ujis"     => Encoding::EucJP_ms,
+        "utf8"     => Encoding::UTF_8,
+        "utf8mb4"  => Encoding::UTF_8,
+      }
+
+      def self.to_binary(value)
+        value.force_encoding Encoding::ASCII_8BIT
+      end
+
+      # convert raw to encoding and convert to Encoding.default_internal
+      # === Argument
+      # raw :: [String]
+      # charset :: [Mysql::Charset]
+      # === Return
+      # result [String]
+      def self.convert_encoding(raw, encoding)
+        raw.force_encoding(encoding).encode
+      end
+
+      # retrun corresponding Ruby encoding
+      # === Return
+      # encoding [Encoding]
+      def encoding
+        enc = CHARSET_ENCODING[@name.downcase]
+        raise Mysql::ClientError, "unsupported charset: #{@name}" unless enc
+        enc
+      end
+
+      # convert encoding to corrensponding to MySQL charset
+      def convert(value)
+        if value.is_a? String and value.encoding != Encoding::ASCII_8BIT
+          value = value.encode encoding
+        end
+        value
+      end
+
+    else
+      # for Ruby 1.8
+
+      def self.to_binary(value)
+        value
+      end
+
+      def self.convert_encoding(raw, encoding)
+        raw
+      end
+
+      def encoding
+        nil
+      end
+
+      def convert(value)
+        value
+      end
+
+    end
+  end
+end

data/lib/mysql/constants.rb

@@ -0,0 +1,164 @@
+# Copyright (C) 2003-2008 TOMITA Masahiro
+# mailto:tommy@tmtm.org
+
+class Mysql
+  # Command
+  COM_SLEEP               = 0
+  COM_QUIT                = 1
+  COM_INIT_DB             = 2
+  COM_QUERY               = 3
+  COM_FIELD_LIST          = 4
+  COM_CREATE_DB           = 5
+  COM_DROP_DB             = 6
+  COM_REFRESH             = 7
+  COM_SHUTDOWN            = 8
+  COM_STATISTICS          = 9
+  COM_PROCESS_INFO        = 10
+  COM_CONNECT             = 11
+  COM_PROCESS_KILL        = 12
+  COM_DEBUG               = 13
+  COM_PING                = 14
+  COM_TIME                = 15
+  COM_DELAYED_INSERT      = 16
+  COM_CHANGE_USER         = 17
+  COM_BINLOG_DUMP         = 18
+  COM_TABLE_DUMP          = 19
+  COM_CONNECT_OUT         = 20
+  COM_REGISTER_SLAVE      = 21
+  COM_STMT_PREPARE        = 22
+  COM_STMT_EXECUTE        = 23
+  COM_STMT_SEND_LONG_DATA = 24
+  COM_STMT_CLOSE          = 25
+  COM_STMT_RESET          = 26
+  COM_SET_OPTION          = 27
+  COM_STMT_FETCH          = 28
+
+  # Client flag
+  CLIENT_LONG_PASSWORD     = 1         # new more secure passwords
+  CLIENT_FOUND_ROWS        = 1 << 1    # Found instead of affected rows
+  CLIENT_LONG_FLAG         = 1 << 2    # Get all column flags
+  CLIENT_CONNECT_WITH_DB   = 1 << 3    # One can specify db on connect
+  CLIENT_NO_SCHEMA         = 1 << 4    # Don't allow database.table.column
+  CLIENT_COMPRESS          = 1 << 5    # Can use compression protocol
+  CLIENT_ODBC              = 1 << 6    # Odbc client
+  CLIENT_LOCAL_FILES       = 1 << 7    # Can use LOAD DATA LOCAL
+  CLIENT_IGNORE_SPACE      = 1 << 8    # Ignore spaces before '('
+  CLIENT_PROTOCOL_41       = 1 << 9    # New 4.1 protocol
+  CLIENT_INTERACTIVE       = 1 << 10   # This is an interactive client
+  CLIENT_SSL               = 1 << 11   # Switch to SSL after handshake
+  CLIENT_IGNORE_SIGPIPE    = 1 << 12   # IGNORE sigpipes
+  CLIENT_TRANSACTIONS      = 1 << 13   # Client knows about transactions
+  CLIENT_RESERVED          = 1 << 14   # Old flag for 4.1 protocol
+  CLIENT_SECURE_CONNECTION = 1 << 15   # New 4.1 authentication
+  CLIENT_MULTI_STATEMENTS  = 1 << 16   # Enable/disable multi-stmt support
+  CLIENT_MULTI_RESULTS     = 1 << 17   # Enable/disable multi-results
+
+  # Connection Option
+  OPT_CONNECT_TIMEOUT         = 0
+  OPT_COMPRESS                = 1
+  OPT_NAMED_PIPE              = 2
+  INIT_COMMAND                = 3
+  READ_DEFAULT_FILE           = 4
+  READ_DEFAULT_GROUP          = 5
+  SET_CHARSET_DIR             = 6
+  SET_CHARSET_NAME            = 7
+  OPT_LOCAL_INFILE            = 8
+  OPT_PROTOCOL                = 9
+  SHARED_MEMORY_BASE_NAME     = 10
+  OPT_READ_TIMEOUT            = 11
+  OPT_WRITE_TIMEOUT           = 12
+  OPT_USE_RESULT              = 13
+  OPT_USE_REMOTE_CONNECTION   = 14
+  OPT_USE_EMBEDDED_CONNECTION = 15
+  OPT_GUESS_CONNECTION        = 16
+  SET_CLIENT_IP               = 17
+  SECURE_AUTH                 = 18
+  REPORT_DATA_TRUNCATION      = 19
+  OPT_RECONNECT               = 20
+  OPT_SSL_VERIFY_SERVER_CERT  = 21
+
+  # Server Option
+  OPTION_MULTI_STATEMENTS_ON  = 0
+  OPTION_MULTI_STATEMENTS_OFF = 1
+
+  # Server Status
+  SERVER_STATUS_IN_TRANS             = 1
+  SERVER_STATUS_AUTOCOMMIT           = 1 << 1
+  SERVER_MORE_RESULTS_EXISTS         = 1 << 3
+  SERVER_QUERY_NO_GOOD_INDEX_USED    = 1 << 4
+  SERVER_QUERY_NO_INDEX_USED         = 1 << 5
+  SERVER_STATUS_CURSOR_EXISTS        = 1 << 6
+  SERVER_STATUS_LAST_ROW_SENT        = 1 << 7
+  SERVER_STATUS_DB_DROPPED           = 1 << 8
+  SERVER_STATUS_NO_BACKSLASH_ESCAPES = 1 << 9
+
+  # Refresh parameter
+  REFRESH_GRANT     = 1
+  REFRESH_LOG       = 1 << 1
+  REFRESH_TABLES    = 1 << 2
+  REFRESH_HOSTS     = 1 << 3
+  REFRESH_STATUS    = 1 << 4
+  REFRESH_THREADS   = 1 << 5
+  REFRESH_SLAVE     = 1 << 6
+  REFRESH_MASTER    = 1 << 7
+  REFRESH_READ_LOCK = 1 << 14
+  REFRESH_FAST      = 1 << 15
+
+  class Field
+    # Field type
+    TYPE_DECIMAL     = 0
+    TYPE_TINY        = 1
+    TYPE_SHORT       = 2
+    TYPE_LONG        = 3
+    TYPE_FLOAT       = 4
+    TYPE_DOUBLE      = 5
+    TYPE_NULL        = 6
+    TYPE_TIMESTAMP   = 7
+    TYPE_LONGLONG    = 8
+    TYPE_INT24       = 9
+    TYPE_DATE        = 10
+    TYPE_TIME        = 11
+    TYPE_DATETIME    = 12
+    TYPE_YEAR        = 13
+    TYPE_NEWDATE     = 14
+    TYPE_VARCHAR     = 15
+    TYPE_BIT         = 16
+    TYPE_NEWDECIMAL  = 246
+    TYPE_ENUM        = 247
+    TYPE_SET         = 248
+    TYPE_TINY_BLOB   = 249
+    TYPE_MEDIUM_BLOB = 250
+    TYPE_LONG_BLOB   = 251
+    TYPE_BLOB        = 252
+    TYPE_VAR_STRING  = 253
+    TYPE_STRING      = 254
+    TYPE_GEOMETRY    = 255
+    TYPE_CHAR        = TYPE_TINY
+    TYPE_INTERVAL    = TYPE_ENUM
+
+    # Flag
+    NOT_NULL_FLAG       = 1
+    PRI_KEY_FLAG        = 2
+    UNIQUE_KEY_FLAG     = 4
+    MULTIPLE_KEY_FLAG   = 8
+    BLOB_FLAG           = 16
+    UNSIGNED_FLAG       = 32
+    ZEROFILL_FLAG       = 64
+    BINARY_FLAG         = 128
+    ENUM_FLAG           = 256
+    AUTO_INCREMENT_FLAG = 512
+    TIMESTAMP_FLAG      = 1024
+    SET_FLAG            = 2048
+    NUM_FLAG            = 32768
+    PART_KEY_FLAG       = 16384
+    GROUP_FLAG          = 32768
+    UNIQUE_FLAG         = 65536
+    BINCMP_FLAG         = 131072
+  end
+
+  class Stmt
+    # Cursor type
+    CURSOR_TYPE_NO_CURSOR = 0
+    CURSOR_TYPE_READ_ONLY = 1
+  end
+end