util/sql.lua

   1
   2 local setmetatable, getmetatable = setmetatable, getmetatable;
   3 local ipairs, unpack, select = ipairs, unpack, select;
   4 local tonumber, tostring = tonumber, tostring;
   5 local assert, xpcall, debug_traceback = assert, xpcall, debug.traceback;
   6 local t_concat = table.concat;
   7 local s_char = string.char;
   8 local log = require "util.logger".init("sql");
   9
  10 local DBI = require "DBI";
  11 -- This loads all available drivers while globals are unlocked
  12 -- LuaDBI should be fixed to not set globals.
  13 DBI.Drivers();
  14 local build_url = require "socket.url".build;
  15
  16 local _ENV = nil;
  17
  18 local column_mt = {};
  19 local table_mt = {};
  20 local query_mt = {};
  21 --local op_mt = {};
  22 local index_mt = {};
  23
  24 local function is_column(x) return getmetatable(x)==column_mt; end
  25 local function is_index(x) return getmetatable(x)==index_mt; end
  26 local function is_table(x) return getmetatable(x)==table_mt; end
  27 local function is_query(x) return getmetatable(x)==query_mt; end
  28 local function Integer(n) return "Integer()" end
  29 local function String(n) return "String()" end
  30
  31 local function Column(definition)
  32         return setmetatable(definition, column_mt);
  33 end
  34 local function Table(definition)
  35         local c = {}
  36         for i,col in ipairs(definition) do
  37                 if is_column(col) then
  38                         c[i], c[col.name] = col, col;
  39                 elseif is_index(col) then
  40                         col.table = definition.name;
  41                 end
  42         end
  43         return setmetatable({ __table__ = definition, c = c, name = definition.name }, table_mt);
  44 end
  45 local function Index(definition)
  46         return setmetatable(definition, index_mt);
  47 end
  48
  49 function table_mt:__tostring()
  50         local s = { 'name="'..self.__table__.name..'"' }
  51         for i,col in ipairs(self.__table__) do
  52                 s[#s+1] = tostring(col);
  53         end
  54         return 'Table{ '..t_concat(s, ", ")..' }'
  55 end
  56 table_mt.__index = {};
  57 function table_mt.__index:create(engine)
  58         return engine:_create_table(self);
  59 end
  60 function table_mt:__call(...)
  61         -- TODO
  62 end
  63 function column_mt:__tostring()
  64         return 'Column{ name="'..self.name..'", type="'..self.type..'" }'
  65 end
  66 function index_mt:__tostring()
  67         local s = 'Index{ name="'..self.name..'"';
  68         for i=1,#self do s = s..', "'..self[i]:gsub("[\\\"]", "\\%1")..'"'; end
  69         return s..' }';
  70 --      return 'Index{ name="'..self.name..'", type="'..self.type..'" }'
  71 end
  72
  73 local function urldecode(s) return s and (s:gsub("%%(%x%x)", function (c) return s_char(tonumber(c,16)); end)); end
  74 local function parse_url(url)
  75         local scheme, secondpart, database = url:match("^([%w%+]+)://([^/]*)/?(.*)");
  76         assert(scheme, "Invalid URL format");
  77         local username, password, host, port;
  78         local authpart, hostpart = secondpart:match("([^@]+)@([^@+])");
  79         if not authpart then hostpart = secondpart; end
  80         if authpart then
  81                 username, password = authpart:match("([^:]*):(.*)");
  82                 username = username or authpart;
  83                 password = password and urldecode(password);
  84         end
  85         if hostpart then
  86                 host, port = hostpart:match("([^:]*):(.*)");
  87                 host = host or hostpart;
  88                 port = port and assert(tonumber(port), "Invalid URL format");
  89         end
  90         return {
  91                 scheme = scheme:lower();
  92                 username = username; password = password;
  93                 host = host; port = port;
  94                 database = #database > 0 and database or nil;
  95         };
  96 end
  97
  98 local engine = {};
  99 function engine:connect()
 100         if self.conn then return true; end
 101
 102         local params = self.params;
 103         assert(params.driver, "no driver")
 104         log("debug", "Connecting to [%s] %s...", params.driver, params.database);
 105         local dbh, err = DBI.Connect(
 106                 params.driver, params.database,
 107                 params.username, params.password,
 108                 params.host, params.port
 109         );
 110         if not dbh then return nil, err; end
 111         dbh:autocommit(false); -- don't commit automatically
 112         self.conn = dbh;
 113         self.prepared = {};
 114         local ok, err = self:set_encoding();
 115         if not ok then
 116                 return ok, err;
 117         end
 118         local ok, err = self:onconnect();
 119         if ok == false then
 120                 return ok, err;
 121         end
 122         return true;
 123 end
 124 function engine:onconnect()
 125         -- Override from create_engine()
 126 end
 127 function engine:execute(sql, ...)
 128         local success, err = self:connect();
 129         if not success then return success, err; end
 130         local prepared = self.prepared;
 131
 132         local stmt = prepared[sql];
 133         if not stmt then
 134                 local err;
 135                 stmt, err = self.conn:prepare(sql);
 136                 if not stmt then return stmt, err; end
 137                 prepared[sql] = stmt;
 138         end
 139
 140         local success, err = stmt:execute(...);
 141         if not success then return success, err; end
 142         return stmt;
 143 end
 144
 145 local result_mt = { __index = {
 146         affected = function(self) return self.__stmt:affected(); end;
 147         rowcount = function(self) return self.__stmt:rowcount(); end;
 148 } };
 149
 150 function engine:execute_query(sql, ...)
 151         if self.params.driver == "PostgreSQL" then
 152                 sql = sql:gsub("`", "\"");
 153         end
 154         local stmt = assert(self.conn:prepare(sql));
 155         assert(stmt:execute(...));
 156         return stmt:rows();
 157 end
 158 function engine:execute_update(sql, ...)
 159         if self.params.driver == "PostgreSQL" then
 160                 sql = sql:gsub("`", "\"");
 161         end
 162         local prepared = self.prepared;
 163         local stmt = prepared[sql];
 164         if not stmt then
 165                 stmt = assert(self.conn:prepare(sql));
 166                 prepared[sql] = stmt;
 167         end
 168         assert(stmt:execute(...));
 169         return setmetatable({ __stmt = stmt }, result_mt);
 170 end
 171 engine.insert = engine.execute_update;
 172 engine.select = engine.execute_query;
 173 engine.delete = engine.execute_update;
 174 engine.update = engine.execute_update;
 175 function engine:_transaction(func, ...)
 176         if not self.conn then
 177                 local ok, err = self:connect();
 178                 if not ok then return ok, err; end
 179         end
 180         --assert(not self.__transaction, "Recursive transactions not allowed");
 181         local args, n_args = {...}, select("#", ...);
 182         local function f() return func(unpack(args, 1, n_args)); end
 183         log("debug", "SQL transaction begin [%s]", tostring(func));
 184         self.__transaction = true;
 185         local success, a, b, c = xpcall(f, debug_traceback);
 186         self.__transaction = nil;
 187         if success then
 188                 log("debug", "SQL transaction success [%s]", tostring(func));
 189                 local ok, err = self.conn:commit();
 190                 if not ok then return ok, err; end -- commit failed
 191                 return success, a, b, c;
 192         else
 193                 log("debug", "SQL transaction failure [%s]: %s", tostring(func), a);
 194                 if self.conn then self.conn:rollback(); end
 195                 return success, a;
 196         end
 197 end
 198 function engine:transaction(...)
 199         local ok, ret = self:_transaction(...);
 200         if not ok then
 201                 local conn = self.conn;
 202                 if not conn or not conn:ping() then
 203                         self.conn = nil;
 204                         ok, ret = self:_transaction(...);
 205                 end
 206         end
 207         return ok, ret;
 208 end
 209 function engine:_create_index(index)
 210         local sql = "CREATE INDEX `"..index.name.."` ON `"..index.table.."` (";
 211         for i=1,#index do
 212                 sql = sql.."`"..index[i].."`";
 213                 if i ~= #index then sql = sql..", "; end
 214         end
 215         sql = sql..");"
 216         if self.params.driver == "PostgreSQL" then
 217                 sql = sql:gsub("`", "\"");
 218         elseif self.params.driver == "MySQL" then
 219                 sql = sql:gsub("`([,)])", "`(20)%1");
 220         end
 221         if index.unique then
 222                 sql = sql:gsub("^CREATE", "CREATE UNIQUE");
 223         end
 224         --print(sql);
 225         return self:execute(sql);
 226 end
 227 function engine:_create_table(table)
 228         local sql = "CREATE TABLE `"..table.name.."` (";
 229         for i,col in ipairs(table.c) do
 230                 local col_type = col.type;
 231                 if col_type == "MEDIUMTEXT" and self.params.driver ~= "MySQL" then
 232                         col_type = "TEXT"; -- MEDIUMTEXT is MySQL-specific
 233                 end
 234                 if col.auto_increment == true and self.params.driver == "PostgreSQL" then
 235                         col_type = "BIGSERIAL";
 236                 end
 237                 sql = sql.."`"..col.name.."` "..col_type;
 238                 if col.nullable == false then sql = sql.." NOT NULL"; end
 239                 if col.primary_key == true then sql = sql.." PRIMARY KEY"; end
 240                 if col.auto_increment == true then
 241                         if self.params.driver == "MySQL" then
 242                                 sql = sql.." AUTO_INCREMENT";
 243                         elseif self.params.driver == "SQLite3" then
 244                                 sql = sql.." AUTOINCREMENT";
 245                         end
 246                 end
 247                 if i ~= #table.c then sql = sql..", "; end
 248         end
 249         sql = sql.. ");"
 250         if self.params.driver == "PostgreSQL" then
 251                 sql = sql:gsub("`", "\"");
 252         elseif self.params.driver == "MySQL" then
 253                 sql = sql:gsub(";$", (" CHARACTER SET '%s' COLLATE '%s_bin';"):format(self.charset, self.charset));
 254         end
 255         local success,err = self:execute(sql);
 256         if not success then return success,err; end
 257         for i,v in ipairs(table.__table__) do
 258                 if is_index(v) then
 259                         self:_create_index(v);
 260                 end
 261         end
 262         return success;
 263 end
 264 function engine:set_encoding() -- to UTF-8
 265         local driver = self.params.driver;
 266         if driver == "SQLite3" then
 267                 return self:transaction(function()
 268                         if self:select"PRAGMA encoding;"()[1] == "UTF-8" then
 269                                 self.charset = "utf8";
 270                         end
 271                 end);
 272         end
 273         local set_names_query = "SET NAMES '%s';"
 274         local charset = "utf8";
 275         if driver == "MySQL" then
 276                 local ok, charsets = self:transaction(function()
 277                         return self:select"SELECT `CHARACTER_SET_NAME` FROM `information_schema`.`CHARACTER_SETS` WHERE `CHARACTER_SET_NAME` LIKE 'utf8%' ORDER BY MAXLEN DESC LIMIT 1;";
 278                 end);
 279                 local row = ok and charsets();
 280                 charset = row and row[1] or charset;
 281                 set_names_query = set_names_query:gsub(";$", (" COLLATE '%s';"):format(charset.."_bin"));
 282         end
 283         self.charset = charset;
 284         log("debug", "Using encoding '%s' for database connection", charset);
 285         local ok, err = self:transaction(function() return self:execute(set_names_query:format(charset)); end);
 286         if not ok then
 287                 return ok, err;
 288         end
 289
 290         if driver == "MySQL" then
 291                 local ok, actual_charset = self:transaction(function ()
 292                         return self:select"SHOW SESSION VARIABLES LIKE 'character_set_client'";
 293                 end);
 294                 for row in actual_charset do
 295                         if row[2] ~= charset then
 296                                 log("error", "MySQL %s is actually %q (expected %q)", row[1], row[2], charset);
 297                                 return false, "Failed to set connection encoding";
 298                         end
 299                 end
 300         end
 301
 302         return true;
 303 end
 304 local engine_mt = { __index = engine };
 305
 306 local function db2uri(params)
 307         return build_url{
 308                 scheme = params.driver,
 309                 user = params.username,
 310                 password = params.password,
 311                 host = params.host,
 312                 port = params.port,
 313                 path = params.database,
 314         };
 315 end
 316
 317 local function create_engine(self, params, onconnect)
 318         return setmetatable({ url = db2uri(params), params = params, onconnect = onconnect }, engine_mt);
 319 end
 320
 321 return {
 322         is_column = is_column;
 323         is_index = is_index;
 324         is_table = is_table;
 325         is_query = is_query;
 326         Integer = Integer;
 327         String = String;
 328         Column = Column;
 329         Table = Table;
 330         Index = Index;
 331         create_engine = create_engine;
 332         db2uri = db2uri;
 333 };