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 module("sql")
  17
  18 local column_mt = {};
  19 local table_mt = {};
  20 local query_mt = {};
  21 --local op_mt = {};
  22 local index_mt = {};
  23
  24 function is_column(x) return getmetatable(x)==column_mt; end
  25 function is_index(x) return getmetatable(x)==index_mt; end
  26 function is_table(x) return getmetatable(x)==table_mt; end
  27 function is_query(x) return getmetatable(x)==query_mt; end
  28 function Integer(n) return "Integer()" end
  29 function String(n) return "String()" end
  30
  31 function Column(definition)
  32         return setmetatable(definition, column_mt);
  33 end
  34 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 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         local dbh, err = DBI.Connect(
 105                 params.driver, params.database,
 106                 params.username, params.password,
 107                 params.host, params.port
 108         );
 109         if not dbh then return nil, err; end
 110         dbh:autocommit(false); -- don't commit automatically
 111         self.conn = dbh;
 112         self.prepared = {};
 113         self:set_encoding();
 114         local ok, err = self:onconnect();
 115         if ok == false then
 116                 return ok, err;
 117         end
 118         return true;
 119 end
 120 function engine:onconnect()
 121         -- Override from create_engine()
 122 end
 123 function engine:execute(sql, ...)
 124         local success, err = self:connect();
 125         if not success then return success, err; end
 126         local prepared = self.prepared;
 127
 128         local stmt = prepared[sql];
 129         if not stmt then
 130                 local err;
 131                 stmt, err = self.conn:prepare(sql);
 132                 if not stmt then return stmt, err; end
 133                 prepared[sql] = stmt;
 134         end
 135
 136         local success, err = stmt:execute(...);
 137         if not success then return success, err; end
 138         return stmt;
 139 end
 140
 141 local result_mt = { __index = {
 142         affected = function(self) return self.__stmt:affected(); end;
 143         rowcount = function(self) return self.__stmt:rowcount(); end;
 144 } };
 145
 146 function engine:execute_query(sql, ...)
 147         if self.params.driver == "PostgreSQL" then
 148                 sql = sql:gsub("`", "\"");
 149         end
 150         local stmt = assert(self.conn:prepare(sql));
 151         assert(stmt:execute(...));
 152         return stmt:rows();
 153 end
 154 function engine:execute_update(sql, ...)
 155         if self.params.driver == "PostgreSQL" then
 156                 sql = sql:gsub("`", "\"");
 157         end
 158         local prepared = self.prepared;
 159         local stmt = prepared[sql];
 160         if not stmt then
 161                 stmt = assert(self.conn:prepare(sql));
 162                 prepared[sql] = stmt;
 163         end
 164         assert(stmt:execute(...));
 165         return setmetatable({ __stmt = stmt }, result_mt);
 166 end
 167 engine.insert = engine.execute_update;
 168 engine.select = engine.execute_query;
 169 engine.delete = engine.execute_update;
 170 engine.update = engine.execute_update;
 171 function engine:_transaction(func, ...)
 172         if not self.conn then
 173                 local ok, err = self:connect();
 174                 if not ok then return ok, err; end
 175         end
 176         --assert(not self.__transaction, "Recursive transactions not allowed");
 177         local args, n_args = {...}, select("#", ...);
 178         local function f() return func(unpack(args, 1, n_args)); end
 179         self.__transaction = true;
 180         local success, a, b, c = xpcall(f, debug_traceback);
 181         self.__transaction = nil;
 182         if success then
 183                 log("debug", "SQL transaction success [%s]", tostring(func));
 184                 local ok, err = self.conn:commit();
 185                 if not ok then return ok, err; end -- commit failed
 186                 return success, a, b, c;
 187         else
 188                 log("debug", "SQL transaction failure [%s]: %s", tostring(func), a);
 189                 if self.conn then self.conn:rollback(); end
 190                 return success, a;
 191         end
 192 end
 193 function engine:transaction(...)
 194         local ok, ret = self:_transaction(...);
 195         if not ok then
 196                 local conn = self.conn;
 197                 if not conn or not conn:ping() then
 198                         self.conn = nil;
 199                         ok, ret = self:_transaction(...);
 200                 end
 201         end
 202         return ok, ret;
 203 end
 204 function engine:_create_index(index)
 205         local sql = "CREATE INDEX `"..index.name.."` ON `"..index.table.."` (";
 206         for i=1,#index do
 207                 sql = sql.."`"..index[i].."`";
 208                 if i ~= #index then sql = sql..", "; end
 209         end
 210         sql = sql..");"
 211         if self.params.driver == "PostgreSQL" then
 212                 sql = sql:gsub("`", "\"");
 213         elseif self.params.driver == "MySQL" then
 214                 sql = sql:gsub("`([,)])", "`(20)%1");
 215         end
 216         if index.unique then
 217                 sql = sql:gsub("^CREATE", "CREATE UNIQUE");
 218         end
 219         --print(sql);
 220         return self:execute(sql);
 221 end
 222 function engine:_create_table(table)
 223         local sql = "CREATE TABLE `"..table.name.."` (";
 224         for i,col in ipairs(table.c) do
 225                 local col_type = col.type;
 226                 if col_type == "MEDIUMTEXT" and self.params.driver ~= "MySQL" then
 227                         col_type = "TEXT"; -- MEDIUMTEXT is MySQL-specific
 228                 end
 229                 if col.auto_increment == true and self.params.driver == "PostgreSQL" then
 230                         col_type = "BIGSERIAL";
 231                 end
 232                 sql = sql.."`"..col.name.."` "..col_type;
 233                 if col.nullable == false then sql = sql.." NOT NULL"; end
 234                 if col.primary_key == true then sql = sql.." PRIMARY KEY"; end
 235                 if col.auto_increment == true then
 236                         if self.params.driver == "MySQL" then
 237                                 sql = sql.." AUTO_INCREMENT";
 238                         elseif self.params.driver == "SQLite3" then
 239                                 sql = sql.." AUTOINCREMENT";
 240                         end
 241                 end
 242                 if i ~= #table.c then sql = sql..", "; end
 243         end
 244         sql = sql.. ");"
 245         if self.params.driver == "PostgreSQL" then
 246                 sql = sql:gsub("`", "\"");
 247         elseif self.params.driver == "MySQL" then
 248                 sql = sql:gsub(";$", " CHARACTER SET 'utf8' COLLATE 'utf8_bin';");
 249         end
 250         local success,err = self:execute(sql);
 251         if not success then return success,err; end
 252         for i,v in ipairs(table.__table__) do
 253                 if is_index(v) then
 254                         self:_create_index(v);
 255                 end
 256         end
 257         return success;
 258 end
 259 function engine:set_encoding() -- to UTF-8
 260         local driver = self.params.driver;
 261         if driver == "SQLite3" then
 262                 return self:transaction(function()
 263                         if self:select"PRAGMA encoding;"()[1] == "UTF-8" then
 264                                 self.charset = "utf8";
 265                         end
 266                 end);
 267         end
 268         local set_names_query = "SET NAMES '%s';"
 269         local charset = "utf8";
 270         if driver == "MySQL" then
 271                 set_names_query = set_names_query:gsub(";$", " COLLATE 'utf8_bin';");
 272                 local ok, charsets = self:transaction(function()
 273                         return self:select"SELECT `CHARACTER_SET_NAME` FROM `information_schema`.`CHARACTER_SETS` WHERE `CHARACTER_SET_NAME` LIKE 'utf8%' ORDER BY MAXLEN DESC LIMIT 1;";
 274                 end);
 275                 local row = ok and charsets();
 276                 charset = row and row[1] or charset;
 277         end
 278         self.charset = charset;
 279         return self:transaction(function() return self:execute(set_names_query:format(charset)); end);
 280 end
 281 local engine_mt = { __index = engine };
 282
 283 function db2uri(params)
 284         return build_url{
 285                 scheme = params.driver,
 286                 user = params.username,
 287                 password = params.password,
 288                 host = params.host,
 289                 port = params.port,
 290                 path = params.database,
 291         };
 292 end
 293
 294 function create_engine(self, params, onconnect)
 295         return setmetatable({ url = db2uri(params), params = params, onconnect = onconnect }, engine_mt);
 296 end
 297
 298 return _M;