Merge 0.10->trunk

[prosody.git] / util / sql.lua

diff --git a/util/sql.lua b/util/sql.lua
index 5aa12f94f9a8d55e8e1b8690d3ca49369bb8d391..2d5e17743a6a90f448499804330741924b5caad5 100644 (file)
--- a/util/sql.lua
+++ b/util/sql.lua
@@ -13,7 +13,7 @@ local DBI = require "DBI";
 DBI.Drivers();
 local build_url = require "socket.url".build;
 
-module("sql")
+local _ENV = nil;
 
 local column_mt = {};
 local table_mt = {};
@@ -21,17 +21,17 @@ local query_mt = {};
 --local op_mt = {};
 local index_mt = {};
 
-function is_column(x) return getmetatable(x)==column_mt; end
-function is_index(x) return getmetatable(x)==index_mt; end
-function is_table(x) return getmetatable(x)==table_mt; end
-function is_query(x) return getmetatable(x)==query_mt; end
-function Integer(n) return "Integer()" end
-function String(n) return "String()" end
+local function is_column(x) return getmetatable(x)==column_mt; end
+local function is_index(x) return getmetatable(x)==index_mt; end
+local function is_table(x) return getmetatable(x)==table_mt; end
+local function is_query(x) return getmetatable(x)==query_mt; end
+local function Integer(n) return "Integer()" end
+local function String(n) return "String()" end
 
-function Column(definition)
+local function Column(definition)
        return setmetatable(definition, column_mt);
 end
-function Table(definition)
+local function Table(definition)
        local c = {}
        for i,col in ipairs(definition) do
                if is_column(col) then
@@ -42,7 +42,7 @@ function Table(definition)
        end
        return setmetatable({ __table__ = definition, c = c, name = definition.name }, table_mt);
 end
-function Index(definition)
+local function Index(definition)
        return setmetatable(definition, index_mt);
 end
 
@@ -101,6 +101,7 @@ function engine:connect()
 
        local params = self.params;
        assert(params.driver, "no driver")
+       log("debug", "Connecting to [%s] %s...", params.driver, params.database);
        local dbh, err = DBI.Connect(
                params.driver, params.database,
                params.username, params.password,
@@ -110,9 +111,19 @@ function engine:connect()
        dbh:autocommit(false); -- don't commit automatically
        self.conn = dbh;
        self.prepared = {};
-       self:set_encoding();
+       local ok, err = self:set_encoding();
+       if not ok then
+               return ok, err;
+       end
+       local ok, err = self:onconnect();
+       if ok == false then
+               return ok, err;
+       end
        return true;
 end
+function engine:onconnect()
+       -- Override from create_engine()
+end
 function engine:execute(sql, ...)
        local success, err = self:connect();
        if not success then return success, err; end
@@ -169,6 +180,7 @@ function engine:_transaction(func, ...)
        --assert(not self.__transaction, "Recursive transactions not allowed");
        local args, n_args = {...}, select("#", ...);
        local function f() return func(unpack(args, 1, n_args)); end
+       log("debug", "SQL transaction begin [%s]", tostring(func));
        self.__transaction = true;
        local success, a, b, c = xpcall(f, debug_traceback);
        self.__transaction = nil;
@@ -238,7 +250,7 @@ function engine:_create_table(table)
        if self.params.driver == "PostgreSQL" then
                sql = sql:gsub("`", "\"");
        elseif self.params.driver == "MySQL" then
-               sql = sql:gsub(";$", " CHARACTER SET 'utf8' COLLATE 'utf8_bin';");
+               sql = sql:gsub(";$", (" CHARACTER SET '%s' COLLATE '%s_bin';"):format(self.charset, self.charset));
        end
        local success,err = self:execute(sql);
        if not success then return success,err; end
@@ -261,19 +273,37 @@ function engine:set_encoding() -- to UTF-8
        local set_names_query = "SET NAMES '%s';"
        local charset = "utf8";
        if driver == "MySQL" then
-               set_names_query = set_names_query:gsub(";$", " COLLATE 'utf8_bin';");
                local ok, charsets = self:transaction(function()
                        return self:select"SELECT `CHARACTER_SET_NAME` FROM `information_schema`.`CHARACTER_SETS` WHERE `CHARACTER_SET_NAME` LIKE 'utf8%' ORDER BY MAXLEN DESC LIMIT 1;";
                end);
                local row = ok and charsets();
                charset = row and row[1] or charset;
+               set_names_query = set_names_query:gsub(";$", (" COLLATE '%s';"):format(charset.."_bin"));
        end
        self.charset = charset;
-       return self:transaction(function() return self:execute(set_names_query:format(charset)); end);
+       log("debug", "Using encoding '%s' for database connection", charset);
+       local ok, err = self:transaction(function() return self:execute(set_names_query:format(charset)); end);
+       if not ok then
+               return ok, err;
+       end
+
+       if driver == "MySQL" then
+               local ok, actual_charset = self:transaction(function ()
+                       return self:select"SHOW SESSION VARIABLES LIKE 'character_set_client'";
+               end);
+               for row in actual_charset do
+                       if row[2] ~= charset then
+                               log("error", "MySQL %s is actually %q (expected %q)", row[1], row[2], charset);
+                               return false, "Failed to set connection encoding";
+                       end
+               end
+       end
+
+       return true;
 end
 local engine_mt = { __index = engine };
 
-function db2uri(params)
+local function db2uri(params)
        return build_url{
                scheme = params.driver,
                user = params.username,
@@ -284,8 +314,20 @@ function db2uri(params)
        };
 end
 
-function create_engine(self, params, onconnect)
+local function create_engine(self, params, onconnect)
        return setmetatable({ url = db2uri(params), params = params, onconnect = onconnect }, engine_mt);
 end
 
-return _M;
+return {
+       is_column = is_column;
+       is_index = is_index;
+       is_table = is_table;
+       is_query = is_query;
+       Integer = Integer;
+       String = String;
+       Column = Column;
+       Table = Table;
+       Index = Index;
+       create_engine = create_engine;
+       db2uri = db2uri;
+};