]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/extra/m_sqlite3.cpp
Some more text fixes and improvements (#1618).
[user/henk/code/inspircd.git] / src / modules / extra / m_sqlite3.cpp
index e97e884ea4fc62c3cda7606b034274349c4f059b..e81e990252c7e9b115f1865c6b3fe038306e1bec 100644 (file)
-/*              +------------------------------------+
- *              | Inspire Internet Relay Chat Daemon |
- *              +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
  *
- *     InspIRCd: (C) 2002-2010 InspIRCd Development Team
- * See: http://wiki.inspircd.org/Credits
+ *   Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
+ *   Copyright (C) 2007-2009 Dennis Friis <peavey@inspircd.org>
+ *   Copyright (C) 2007, 2009 Craig Edwards <craigedwards@brainbox.cc>
+ *   Copyright (C) 2008 Pippijn van Steenhoven <pip88nl@gmail.com>
  *
- * This program is free but copyrighted software; see
- *                       the file COPYING for details.
+ * This file is part of InspIRCd.  InspIRCd is free software: you can
+ * redistribute it and/or modify it under the terms of the GNU General Public
+ * License as published by the Free Software Foundation, version 2.
  *
- * ---------------------------------------------------
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/// $CompilerFlags: find_compiler_flags("sqlite3")
+/// $LinkerFlags: find_linker_flags("sqlite3" "-lsqlite3")
+
+/// $PackageInfo: require_system("centos") pkgconfig sqlite-devel
+/// $PackageInfo: require_system("darwin") pkg-config sqlite3
+/// $PackageInfo: require_system("debian") libsqlite3-dev pkg-config
+/// $PackageInfo: require_system("ubuntu") libsqlite3-dev pkg-config
+
 #include "inspircd.h"
-#include <sqlite3.h>
-#include "m_sqlv2.h"
+#include "modules/sql.h"
 
-/* $ModDesc: sqlite3 provider */
-/* $CompileFlags: pkgconfversion("sqlite3","3.3") pkgconfincludes("sqlite3","/sqlite3.h","") */
-/* $LinkerFlags: pkgconflibs("sqlite3","/libsqlite3.so","-lsqlite3") */
-/* $ModDep: m_sqlv2.h */
-/* $NoPedantic */
+// Fix warnings about the use of `long long` on C++03.
+#if defined __clang__
+# pragma clang diagnostic ignored "-Wc++11-long-long"
+#elif defined __GNUC__
+# pragma GCC diagnostic ignored "-Wlong-long"
+#endif
 
-class SQLConn;
-class SQLite3Result;
-class ResultNotifier;
-class SQLiteListener;
-class ModuleSQLite3;
+#include <sqlite3.h>
 
-typedef std::map<std::string, SQLConn*> ConnMap;
-typedef std::deque<classbase*> paramlist;
-typedef std::deque<SQLite3Result*> ResultQueue;
+#ifdef _WIN32
+# pragma comment(lib, "sqlite3.lib")
+#endif
 
-static unsigned long count(const char * const str, char a)
-{
-       unsigned long n = 0;
-       for (const char *p = str; *p; ++p)
-       {
-               if (*p == '?')
-                       ++n;
-       }
-       return n;
-}
+class SQLConn;
+typedef insp::flat_map<std::string, SQLConn*> ConnMap;
 
-class SQLite3Result : public SQLresult
+class SQLite3Result : public SQL::Result
 {
- private:
+ public:
        int currentrow;
        int rows;
-       int cols;
+       std::vector<std::string> columns;
+       std::vector<SQL::Row> fieldlists;
 
-       std::vector<std::string> colnames;
-       std::vector<SQLfieldList> fieldlists;
-       SQLfieldList emptyfieldlist;
-
-       SQLfieldList* fieldlist;
-       SQLfieldMap* fieldmap;
-
- public:
-       SQLite3Result(Module* self, Module* to, unsigned int rid)
-       : SQLresult(self, to, rid), currentrow(0), rows(0), cols(0), fieldlist(NULL), fieldmap(NULL)
+       SQLite3Result() : currentrow(0), rows(0)
        {
        }
 
-       ~SQLite3Result()
-       {
-       }
-
-       void AddRow(int colsnum, char **dat, char **colname)
-       {
-               colnames.clear();
-               cols = colsnum;
-               for (int i = 0; i < colsnum; i++)
-               {
-                       fieldlists.resize(fieldlists.size()+1);
-                       colnames.push_back(colname[i]);
-                       SQLfield sf(dat[i] ? dat[i] : "", dat[i] ? false : true);
-                       fieldlists[rows].push_back(sf);
-               }
-               rows++;
-       }
-
-       void UpdateAffectedCount()
-       {
-               rows++;
-       }
-
-       virtual int Rows()
+       int Rows() CXX11_OVERRIDE
        {
                return rows;
        }
 
-       virtual int Cols()
-       {
-               return cols;
-       }
-
-       virtual std::string ColName(int column)
-       {
-               if (column < (int)colnames.size())
-               {
-                       return colnames[column];
-               }
-               else
-               {
-                       throw SQLbadColName();
-               }
-               return "";
-       }
-
-       virtual int ColNum(const std::string &column)
-       {
-               for (unsigned int i = 0; i < colnames.size(); i++)
-               {
-                       if (column == colnames[i])
-                               return i;
-               }
-               throw SQLbadColName();
-               return 0;
-       }
-
-       virtual SQLfield GetValue(int row, int column)
-       {
-               if ((row >= 0) && (row < rows) && (column >= 0) && (column < Cols()))
-               {
-                       return fieldlists[row][column];
-               }
-
-               throw SQLbadColName();
-
-               /* XXX: We never actually get here because of the throw */
-               return SQLfield("",true);
-       }
-
-       virtual SQLfieldList& GetRow()
+       bool GetRow(SQL::Row& result) CXX11_OVERRIDE
        {
                if (currentrow < rows)
-                       return fieldlists[currentrow];
-               else
-                       return emptyfieldlist;
-       }
-
-       virtual SQLfieldMap& GetRowMap()
-       {
-               /* In an effort to reduce overhead we don't actually allocate the map
-                * until the first time it's needed...so...
-                */
-               if(fieldmap)
                {
-                       fieldmap->clear();
+                       result.assign(fieldlists[currentrow].begin(), fieldlists[currentrow].end());
+                       currentrow++;
+                       return true;
                }
                else
                {
-                       fieldmap = new SQLfieldMap;
+                       result.clear();
+                       return false;
                }
-
-               if (currentrow < rows)
-               {
-                       for (int i = 0; i < Cols(); i++)
-                       {
-                               fieldmap->insert(std::make_pair(ColName(i), GetValue(currentrow, i)));
-                       }
-                       currentrow++;
-               }
-
-               return *fieldmap;
        }
 
-       virtual SQLfieldList* GetRowPtr()
+       void GetCols(std::vector<std::string>& result) CXX11_OVERRIDE
        {
-               fieldlist = new SQLfieldList();
-
-               if (currentrow < rows)
-               {
-                       for (int i = 0; i < Rows(); i++)
-                       {
-                               fieldlist->push_back(fieldlists[currentrow][i]);
-                       }
-                       currentrow++;
-               }
-               return fieldlist;
+               result.assign(columns.begin(), columns.end());
        }
 
-       virtual SQLfieldMap* GetRowMapPtr()
+       bool HasColumn(const std::string& column, size_t& index) CXX11_OVERRIDE
        {
-               fieldmap = new SQLfieldMap();
-
-               if (currentrow < rows)
+               for (size_t i = 0; i < columns.size(); ++i)
                {
-                       for (int i = 0; i < Cols(); i++)
+                       if (columns[i] == column)
                        {
-                               fieldmap->insert(std::make_pair(colnames[i],GetValue(currentrow, i)));
+                               index = i;
+                               return true;
                        }
-                       currentrow++;
                }
-
-               return fieldmap;
-       }
-
-       virtual void Free(SQLfieldMap* fm)
-       {
-               delete fm;
-       }
-
-       virtual void Free(SQLfieldList* fl)
-       {
-               delete fl;
+               return false;
        }
-
-
 };
 
-class SQLConn : public classbase
+class SQLConn : public SQL::Provider
 {
- private:
-       ResultQueue results;
-       Module* mod;
-       SQLhost host;
        sqlite3* conn;
+       reference<ConfigTag> config;
 
  public:
-       SQLConn(Module* m, const SQLhost& hi)
-       : mod(m), host(hi)
+       SQLConn(Module* Parent, ConfigTag* tag) : SQL::Provider(Parent, "SQL/" + tag->getString("id")), config(tag)
        {
-               if (OpenDB() != SQLITE_OK)
+               std::string host = tag->getString("hostname");
+               if (sqlite3_open_v2(host.c_str(), &conn, SQLITE_OPEN_READWRITE, 0) != SQLITE_OK)
                {
-                       ServerInstance->Logs->Log("m_sqlite3",DEFAULT, "WARNING: Could not open DB with id: " + host.id);
-                       CloseDB();
+                       // Even in case of an error conn must be closed
+                       sqlite3_close(conn);
+                       conn = NULL;
+                       ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "WARNING: Could not open DB with id: " + tag->getString("id"));
                }
        }
 
        ~SQLConn()
        {
-               CloseDB();
+               if (conn)
+               {
+                       sqlite3_interrupt(conn);
+                       sqlite3_close(conn);
+               }
        }
 
-       SQLerror Query(SQLrequest &req)
+       void Query(SQL::Query* query, const std::string& q)
        {
-               /* Pointer to the buffer we screw around with substitution in */
-               char* query;
-
-               /* Pointer to the current end of query, where we append new stuff */
-               char* queryend;
-
-               /* Total length of the unescaped parameters */
-               unsigned long maxparamlen, paramcount;
-
-               /* The length of the longest parameter */
-               maxparamlen = 0;
-
-               for(ParamL::iterator i = req.query.p.begin(); i != req.query.p.end(); i++)
+               SQLite3Result res;
+               sqlite3_stmt *stmt;
+               int err = sqlite3_prepare_v2(conn, q.c_str(), q.length(), &stmt, NULL);
+               if (err != SQLITE_OK)
                {
-                       if (i->size() > maxparamlen)
-                               maxparamlen = i->size();
+                       SQL::Error error(SQL::QSEND_FAIL, sqlite3_errmsg(conn));
+                       query->OnError(error);
+                       return;
                }
-
-               /* How many params are there in the query? */
-               paramcount = count(req.query.q.c_str(), '?');
-
-               /* This stores copy of params to be inserted with using numbered params 1;3B*/
-               ParamL paramscopy(req.query.p);
-
-               /* To avoid a lot of allocations, allocate enough memory for the biggest the escaped query could possibly be.
-                * sizeofquery + (maxtotalparamlength*2) + 1
-                *
-                * The +1 is for null-terminating the string
-                */
-
-               query = new char[req.query.q.length() + (maxparamlen*paramcount*2) + 1];
-               queryend = query;
-
-               for(unsigned long i = 0; i < req.query.q.length(); i++)
+               int cols = sqlite3_column_count(stmt);
+               res.columns.resize(cols);
+               for(int i=0; i < cols; i++)
+               {
+                       res.columns[i] = sqlite3_column_name(stmt, i);
+               }
+               while (1)
                {
-                       if(req.query.q[i] == '?')
+                       err = sqlite3_step(stmt);
+                       if (err == SQLITE_ROW)
                        {
-                               /* We found a place to substitute..what fun.
-                                * use sqlite calls to escape and write the
-                                * escaped string onto the end of our query buffer,
-                                * then we "just" need to make sure queryend is
-                                * pointing at the right place.
-                                */
-
-                               /* Is it numbered parameter?
-                                */
-
-                               bool numbered;
-                               numbered = false;
-
-                               /* Numbered parameter number :|
-                                */
-                               unsigned int paramnum;
-                               paramnum = 0;
-
-                               /* Let's check if it's a numbered param. And also calculate it's number.
-                                */
-
-                               while ((i < req.query.q.length() - 1) && (req.query.q[i+1] >= '0') && (req.query.q[i+1] <= '9'))
-                               {
-                                       numbered = true;
-                                       ++i;
-                                       paramnum = paramnum * 10 + req.query.q[i] - '0';
-                               }
-
-                               if (paramnum > paramscopy.size() - 1)
-                               {
-                                       /* index is out of range!
-                                        */
-                                       numbered = false;
-                               }
-
-
-                               if (numbered)
+                               // Add the row
+                               res.fieldlists.resize(res.rows + 1);
+                               res.fieldlists[res.rows].resize(cols);
+                               for(int i=0; i < cols; i++)
                                {
-                                       char* escaped;
-                                       escaped = sqlite3_mprintf("%q", paramscopy[paramnum].c_str());
-                                       for (char* n = escaped; *n; n++)
-                                       {
-                                               *queryend = *n;
-                                               queryend++;
-                                       }
-                                       sqlite3_free(escaped);
+                                       const char* txt = (const char*)sqlite3_column_text(stmt, i);
+                                       if (txt)
+                                               res.fieldlists[res.rows][i] = SQL::Field(txt);
                                }
-                               else if (req.query.p.size())
-                               {
-                                       char* escaped;
-                                       escaped = sqlite3_mprintf("%q", req.query.p.front().c_str());
-                                       for (char* n = escaped; *n; n++)
-                                       {
-                                               *queryend = *n;
-                                               queryend++;
-                                       }
-                                       sqlite3_free(escaped);
-                                       req.query.p.pop_front();
-                               }
-                               else
-                                       break;
+                               res.rows++;
+                       }
+                       else if (err == SQLITE_DONE)
+                       {
+                               query->OnResult(res);
+                               break;
                        }
                        else
                        {
-                               *queryend = req.query.q[i];
-                               queryend++;
+                               SQL::Error error(SQL::QREPLY_FAIL, sqlite3_errmsg(conn));
+                               query->OnError(error);
+                               break;
                        }
                }
-               *queryend = 0;
-               req.query.q = query;
-
-               SQLite3Result* res = new SQLite3Result(mod, req.source, req.id);
-               res->dbid = host.id;
-               res->query = req.query.q;
-               paramlist params;
-               params.push_back(this);
-               params.push_back(res);
-
-               char *errmsg = 0;
-               sqlite3_update_hook(conn, QueryUpdateHook, &params);
-               if (sqlite3_exec(conn, req.query.q.data(), QueryResult, &params, &errmsg) != SQLITE_OK)
-               {
-                       std::string error(errmsg);
-                       sqlite3_free(errmsg);
-                       delete[] query;
-                       delete res;
-                       return SQLerror(SQL_QSEND_FAIL, error);
-               }
-               delete[] query;
-
-               results.push_back(res);
-               SendResults();
-               return SQLerror();
+               sqlite3_finalize(stmt);
        }
 
-       static int QueryResult(void *params, int argc, char **argv, char **azColName)
+       void Submit(SQL::Query* query, const std::string& q) CXX11_OVERRIDE
        {
-               paramlist* p = (paramlist*)params;
-               ((SQLConn*)(*p)[0])->ResultReady(((SQLite3Result*)(*p)[1]), argc, argv, azColName);
-               return 0;
+               Query(query, q);
+               delete query;
        }
 
-       static void QueryUpdateHook(void *params, int eventid, char const * azSQLite, char const * azColName, sqlite_int64 rowid)
+       void Submit(SQL::Query* query, const std::string& q, const SQL::ParamList& p) CXX11_OVERRIDE
        {
-               paramlist* p = (paramlist*)params;
-               ((SQLConn*)(*p)[0])->AffectedReady(((SQLite3Result*)(*p)[1]));
-       }
-
-       void ResultReady(SQLite3Result *res, int cols, char **data, char **colnames)
-       {
-               res->AddRow(cols, data, colnames);
-       }
-
-       void AffectedReady(SQLite3Result *res)
-       {
-               res->UpdateAffectedCount();
-       }
-
-       int OpenDB()
-       {
-               return sqlite3_open_v2(host.host.c_str(), &conn, SQLITE_OPEN_READWRITE, 0);
-       }
-
-       void CloseDB()
-       {
-               sqlite3_interrupt(conn);
-               sqlite3_close(conn);
-       }
-
-       SQLhost GetConfHost()
-       {
-               return host;
-       }
-
-       void SendResults()
-       {
-               while (results.size())
+               std::string res;
+               unsigned int param = 0;
+               for(std::string::size_type i = 0; i < q.length(); i++)
                {
-                       SQLite3Result* res = results[0];
-                       if (res->dest)
-                       {
-                               res->Send();
-                       }
+                       if (q[i] != '?')
+                               res.push_back(q[i]);
                        else
                        {
-                               /* If the client module is unloaded partway through a query then the provider will set
-                                * the pointer to NULL. We cannot just cancel the query as the result will still come
-                                * through at some point...and it could get messy if we play with invalid pointers...
-                                */
-                               delete res;
+                               if (param < p.size())
+                               {
+                                       char* escaped = sqlite3_mprintf("%q", p[param++].c_str());
+                                       res.append(escaped);
+                                       sqlite3_free(escaped);
+                               }
                        }
-                       results.pop_front();
                }
+               Submit(query, res);
        }
 
-       void ClearResults()
+       void Submit(SQL::Query* query, const std::string& q, const SQL::ParamMap& p) CXX11_OVERRIDE
        {
-               while (results.size())
+               std::string res;
+               for(std::string::size_type i = 0; i < q.length(); i++)
                {
-                       SQLite3Result* res = results[0];
-                       delete res;
-                       results.pop_front();
+                       if (q[i] != '$')
+                               res.push_back(q[i]);
+                       else
+                       {
+                               std::string field;
+                               i++;
+                               while (i < q.length() && isalnum(q[i]))
+                                       field.push_back(q[i++]);
+                               i--;
+
+                               SQL::ParamMap::const_iterator it = p.find(field);
+                               if (it != p.end())
+                               {
+                                       char* escaped = sqlite3_mprintf("%q", it->second.c_str());
+                                       res.append(escaped);
+                                       sqlite3_free(escaped);
+                               }
+                       }
                }
+               Submit(query, res);
        }
-
 };
 
-
 class ModuleSQLite3 : public Module
 {
- private:
-       ConnMap connections;
-       unsigned long currid;
-       ServiceProvider sqlserv;
+       ConnMap conns;
 
  public:
-       ModuleSQLite3()
-       : currid(0), sqlserv(this, "SQL/sqlite", SERVICE_DATA)
-       {
-
-               ReadConf();
-
-               Implementation eventlist[] = { I_OnRehash };
-               ServerInstance->Modules->Attach(eventlist, this, 1);
-       }
-
-       virtual ~ModuleSQLite3()
-       {
-               ClearQueue();
-               ClearAllConnections();
-       }
-
-       void ClearQueue()
-       {
-               for (ConnMap::iterator iter = connections.begin(); iter != connections.end(); iter++)
-               {
-                       iter->second->ClearResults();
-               }
-       }
-
-       bool HasHost(const SQLhost &host)
+       ~ModuleSQLite3()
        {
-               for (ConnMap::iterator iter = connections.begin(); iter != connections.end(); iter++)
-               {
-                       if (host == iter->second->GetConfHost())
-                               return true;
-               }
-               return false;
+               ClearConns();
        }
 
-       bool HostInConf(const SQLhost &h)
+       void ClearConns()
        {
-               ConfigReader conf;
-               for(int i = 0; i < conf.Enumerate("database"); i++)
+               for(ConnMap::iterator i = conns.begin(); i != conns.end(); i++)
                {
-                       SQLhost host;
-                       host.id         = conf.ReadValue("database", "id", i);
-                       host.host       = conf.ReadValue("database", "hostname", i);
-                       host.port       = conf.ReadInteger("database", "port", i, true);
-                       host.name       = conf.ReadValue("database", "name", i);
-                       host.user       = conf.ReadValue("database", "username", i);
-                       host.pass       = conf.ReadValue("database", "password", i);
-                       if (h == host)
-                               return true;
+                       SQLConn* conn = i->second;
+                       ServerInstance->Modules->DelService(*conn);
+                       delete conn;
                }
-               return false;
+               conns.clear();
        }
 
-       void ReadConf()
+       void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
        {
-               ClearOldConnections();
-
-               ConfigReader conf;
-               for(int i = 0; i < conf.Enumerate("database"); i++)
+               ClearConns();
+               ConfigTagList tags = ServerInstance->Config->ConfTags("database");
+               for(ConfigIter i = tags.first; i != tags.second; i++)
                {
-                       SQLhost host;
-
-                       host.id         = conf.ReadValue("database", "id", i);
-                       host.host       = conf.ReadValue("database", "hostname", i);
-                       host.port       = conf.ReadInteger("database", "port", i, true);
-                       host.name       = conf.ReadValue("database", "name", i);
-                       host.user       = conf.ReadValue("database", "username", i);
-                       host.pass       = conf.ReadValue("database", "password", i);
-
-                       if (HasHost(host))
+                       if (!stdalgo::string::equalsci(i->second->getString("module"), "sqlite"))
                                continue;
-
-                       this->AddConn(host);
+                       SQLConn* conn = new SQLConn(this, i->second);
+                       conns.insert(std::make_pair(i->second->getString("id"), conn));
+                       ServerInstance->Modules->AddService(*conn);
                }
        }
 
-       void AddConn(const SQLhost& hi)
+       Version GetVersion() CXX11_OVERRIDE
        {
-               if (HasHost(hi))
-               {
-                       ServerInstance->Logs->Log("m_sqlite3",DEFAULT, "WARNING: A sqlite connection with id: %s already exists. Aborting database open attempt.", hi.id.c_str());
-                       return;
-               }
-
-               SQLConn* newconn;
-
-               newconn = new SQLConn(this, hi);
-
-               connections.insert(std::make_pair(hi.id, newconn));
-       }
-
-       void ClearOldConnections()
-       {
-               ConnMap::iterator iter,safei;
-               for (iter = connections.begin(); iter != connections.end(); iter++)
-               {
-                       if (!HostInConf(iter->second->GetConfHost()))
-                       {
-                               delete iter->second;
-                               safei = iter;
-                               --iter;
-                               connections.erase(safei);
-                       }
-               }
+               return Version("Provides SQLite3 support", VF_VENDOR);
        }
-
-       void ClearAllConnections()
-       {
-               ConnMap::iterator i;
-               while ((i = connections.begin()) != connections.end())
-               {
-                       connections.erase(i);
-                       delete i->second;
-               }
-       }
-
-       virtual void OnRehash(User* user)
-       {
-               ReadConf();
-       }
-
-       void OnRequest(Request& request)
-       {
-               if(strcmp(SQLREQID, request.id) == 0)
-               {
-                       SQLrequest* req = (SQLrequest*)&request;
-                       ConnMap::iterator iter;
-                       if((iter = connections.find(req->dbid)) != connections.end())
-                       {
-                               req->id = NewID();
-                               req->error = iter->second->Query(*req);
-                       }
-                       else
-                       {
-                               req->error.Id(SQL_BAD_DBID);
-                       }
-               }
-       }
-
-       unsigned long NewID()
-       {
-               if (currid+1 == 0)
-                       currid++;
-
-               return ++currid;
-       }
-
-       virtual Version GetVersion()
-       {
-               return Version("sqlite3 provider", VF_VENDOR);
-       }
-
 };
 
 MODULE_INIT(ModuleSQLite3)