]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/extra/m_mysql.cpp
Fix a few things that should be marked as override but aren't.
[user/henk/code/inspircd.git] / src / modules / extra / m_mysql.cpp
index 86d9273c3bc99f1d5d6b4990fed3fca984723026..41c3a2a65a63e2dcb994ac4634b8b30d40d0b720 100644 (file)
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/// $CompilerFlags: execute("mysql_config --include" "MYSQL_CXXFLAGS")
+/// $LinkerFlags: execute("mysql_config --libs_r" "MYSQL_LDFLAGS" "-lmysqlclient")
 
-/* Stop mysql wanting to use long long */
-#define NO_CLIENT_LONG_LONG
+/// $PackageInfo: require_system("centos" "6.0" "6.99") mysql-devel
+/// $PackageInfo: require_system("centos" "7.0") mariadb-devel
+/// $PackageInfo: require_system("darwin") mysql-connector-c
+/// $PackageInfo: require_system("debian") libmysqlclient-dev
+/// $PackageInfo: require_system("ubuntu") libmysqlclient-dev
+
+
+// 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
 
 #include "inspircd.h"
 #include <mysql.h>
-#include "sql.h"
+#include "modules/sql.h"
 
-#ifdef WINDOWS
-# pragma comment(lib, "mysqlclient.lib")
-# pragma comment(lib, "advapi32.lib")
-# pragma comment(linker, "/NODEFAULTLIB:LIBCMT")
+#ifdef _WIN32
+# pragma comment(lib, "libmysql.lib")
 #endif
 
 /* VERSION 3 API: With nonblocking (threaded) requests */
 
-/* $ModDesc: SQL Service Provider module for all other m_sql* modules */
-/* $CompileFlags: exec("mysql_config --include") */
-/* $LinkerFlags: exec("mysql_config --libs_r") rpath("mysql_config --libs_r") */
-
 /* THE NONBLOCKING MYSQL API!
  *
  * MySQL provides no nonblocking (asyncronous) API of its own, and its developers recommend
@@ -69,8 +76,6 @@
  * if a module is ever put in a re-enterant state (stack corruption could occur, crashes, data
  * corruption, and worse, so DONT think about it until the day comes when InspIRCd is 100%
  * gauranteed threadsafe!)
- *
- * For a diagram of this system please see http://wiki.inspircd.org/Mysql2
  */
 
 class SQLConnection;
@@ -79,20 +84,20 @@ class DispatcherThread;
 
 struct QQueueItem
 {
-       SQLQuery* q;
+       SQL::Query* q;
        std::string query;
        SQLConnection* c;
-       QQueueItem(SQLQuery* Q, const std::string& S, SQLConnection* C) : q(Q), query(S), c(C) {}
+       QQueueItem(SQL::Query* Q, const std::string& S, SQLConnection* C) : q(Q), query(S), c(C) {}
 };
 
 struct RQueueItem
 {
-       SQLQuery* q;
+       SQL::Query* q;
        MySQLresult* r;
-       RQueueItem(SQLQuery* Q, MySQLresult* R) : q(Q), r(R) {}
+       RQueueItem(SQL::Query* Q, MySQLresult* R) : q(Q), r(R) {}
 };
 
-typedef std::map<std::string, SQLConnection*> ConnMap;
+typedef insp::flat_map<std::string, SQLConnection*> ConnMap;
 typedef std::deque<QQueueItem> QueryQueue;
 typedef std::deque<RQueueItem> ResultQueue;
 
@@ -107,11 +112,11 @@ class ModuleSQL : public Module
        ConnMap connections; // main thread only
 
        ModuleSQL();
-       void init();
+       void init() CXX11_OVERRIDE;
        ~ModuleSQL();
-       void OnRehash(User* user);
-       void OnUnloadModule(Module* mod);
-       Version GetVersion();
+       void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE;
+       void OnUnloadModule(Module* mod) CXX11_OVERRIDE;
+       Version GetVersion() CXX11_OVERRIDE;
 };
 
 class DispatcherThread : public SocketThread
@@ -121,8 +126,8 @@ class DispatcherThread : public SocketThread
  public:
        DispatcherThread(ModuleSQL* CreatorModule) : Parent(CreatorModule) { }
        ~DispatcherThread() { }
-       virtual void Run();
-       virtual void OnNotify();
+       void Run() CXX11_OVERRIDE;
+       void OnNotify() CXX11_OVERRIDE;
 };
 
 #if !defined(MYSQL_VERSION_ID) || MYSQL_VERSION_ID<32224
@@ -131,16 +136,16 @@ class DispatcherThread : public SocketThread
 
 /** Represents a mysql result set
  */
-class MySQLresult : public SQLResult
+class MySQLresult : public SQL::Result
 {
  public:
-       SQLerror err;
+       SQL::Error err;
        int currentrow;
        int rows;
        std::vector<std::string> colnames;
-       std::vector<SQLEntries> fieldlists;
+       std::vector<SQL::Row> fieldlists;
 
-       MySQLresult(MYSQL_RES* res, int affected_rows) : err(SQL_NO_ERROR), currentrow(0), rows(0)
+       MySQLresult(MYSQL_RES* res, int affected_rows) : err(SQL::SUCCESS), currentrow(0), rows(0)
        {
                if (affected_rows >= 1)
                {
@@ -169,9 +174,9 @@ class MySQLresult : public SQLResult
                                        {
                                                std::string a = (fields[field_count].name ? fields[field_count].name : "");
                                                if (row[field_count])
-                                                       fieldlists[n].push_back(SQLEntry(row[field_count]));
+                                                       fieldlists[n].push_back(SQL::Field(row[field_count]));
                                                else
-                                                       fieldlists[n].push_back(SQLEntry());
+                                                       fieldlists[n].push_back(SQL::Field());
                                                colnames.push_back(a);
                                                field_count++;
                                        }
@@ -180,39 +185,47 @@ class MySQLresult : public SQLResult
                                rows++;
                        }
                        mysql_free_result(res);
-                       res = NULL;
                }
        }
 
-       MySQLresult(SQLerror& e) : err(e)
+       MySQLresult(SQL::Error& e) : err(e)
        {
 
        }
 
-       ~MySQLresult()
+       int Rows() CXX11_OVERRIDE
        {
+               return rows;
        }
 
-       virtual int Rows()
+       void GetCols(std::vector<std::string>& result) CXX11_OVERRIDE
        {
-               return rows;
+               result.assign(colnames.begin(), colnames.end());
        }
 
-       virtual void GetCols(std::vector<std::string>& result)
+       bool HasColumn(const std::string& column, size_t& index) CXX11_OVERRIDE
        {
-               result.assign(colnames.begin(), colnames.end());
+               for (size_t i = 0; i < colnames.size(); ++i)
+               {
+                       if (colnames[i] == column)
+                       {
+                               index = i;
+                               return true;
+                       }
+               }
+               return false;
        }
 
-       virtual SQLEntry GetValue(int row, int column)
+       SQL::Field GetValue(int row, int column)
        {
                if ((row >= 0) && (row < rows) && (column >= 0) && (column < (int)fieldlists[row].size()))
                {
                        return fieldlists[row][column];
                }
-               return SQLEntry();
+               return SQL::Field();
        }
 
-       virtual bool GetRow(SQLEntries& result)
+       bool GetRow(SQL::Row& result) CXX11_OVERRIDE
        {
                if (currentrow < rows)
                {
@@ -230,7 +243,7 @@ class MySQLresult : public SQLResult
 
 /** Represents a connection to a mysql database
  */
-class SQLConnection : public SQLProvider
+class SQLConnection : public SQL::Provider
 {
  public:
        reference<ConfigTag> config;
@@ -238,7 +251,7 @@ class SQLConnection : public SQLProvider
        Mutex lock;
 
        // This constructor creates an SQLConnection object with the given credentials, but does not connect yet.
-       SQLConnection(Module* p, ConfigTag* tag) : SQLProvider(p, "SQL/" + tag->getString("id")),
+       SQLConnection(Module* p, ConfigTag* tag) : SQL::Provider(p, "SQL/" + tag->getString("id")),
                config(tag), connection(NULL)
        {
        }
@@ -259,10 +272,16 @@ class SQLConnection : public SQLProvider
                std::string user = config->getString("user");
                std::string pass = config->getString("pass");
                std::string dbname = config->getString("name");
-               int port = config->getInt("port");
+               unsigned int port = config->getUInt("port", 3306);
                bool rv = mysql_real_connect(connection, host.c_str(), user.c_str(), pass.c_str(), dbname.c_str(), port, NULL, 0);
                if (!rv)
                        return rv;
+
+               // Enable character set settings
+               std::string charset = config->getString("charset");
+               if ((!charset.empty()) && (mysql_set_character_set(connection, charset.c_str())))
+                       ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "WARNING: Could not set character set to \"%s\"", charset.c_str());
+
                std::string initquery;
                if (config->readString("initialquery", initquery))
                {
@@ -291,7 +310,7 @@ class SQLConnection : public SQLProvider
                {
                        /* XXX: See /usr/include/mysql/mysqld_error.h for a list of
                         * possible error numbers and error messages */
-                       SQLerror e(SQL_QREPLY_FAIL, ConvToStr(mysql_errno(connection)) + std::string(": ") + mysql_error(connection));
+                       SQL::Error e(SQL::QREPLY_FAIL, InspIRCd::Format("%u: %s", mysql_errno(connection), mysql_error(connection)));
                        return new MySQLresult(e);
                }
        }
@@ -313,14 +332,14 @@ class SQLConnection : public SQLProvider
                mysql_close(connection);
        }
 
-       void submit(SQLQuery* q, const std::string& qs)
+       void Submit(SQL::Query* q, const std::string& qs) CXX11_OVERRIDE
        {
                Parent()->Dispatcher->LockQueue();
                Parent()->qq.push_back(QQueueItem(q, qs, this));
                Parent()->Dispatcher->UnlockQueueWakeup();
        }
 
-       void submit(SQLQuery* call, const std::string& q, const ParamL& p)
+       void Submit(SQL::Query* call, const std::string& q, const SQL::ParamList& p) CXX11_OVERRIDE
        {
                std::string res;
                unsigned int param = 0;
@@ -333,17 +352,21 @@ class SQLConnection : public SQLProvider
                                if (param < p.size())
                                {
                                        std::string parm = p[param++];
-                                       char buffer[MAXBUF];
-                                       mysql_escape_string(buffer, parm.c_str(), parm.length());
-//                                     mysql_real_escape_string(connection, queryend, paramscopy[paramnum].c_str(), paramscopy[paramnum].length());
-                                       res.append(buffer);
+                                       // In the worst case, each character may need to be encoded as using two bytes,
+                                       // and one byte is the terminating null
+                                       std::vector<char> buffer(parm.length() * 2 + 1);
+
+                                       // The return value of mysql_real_escape_string() is the length of the encoded string,
+                                       // not including the terminating null
+                                       unsigned long escapedsize = mysql_real_escape_string(connection, &buffer[0], parm.c_str(), parm.length());
+                                       res.append(&buffer[0], escapedsize);
                                }
                        }
                }
-               submit(call, res);
+               Submit(call, res);
        }
 
-       void submit(SQLQuery* call, const std::string& q, const ParamM& p)
+       void Submit(SQL::Query* call, const std::string& q, const SQL::ParamMap& p) CXX11_OVERRIDE
        {
                std::string res;
                for(std::string::size_type i = 0; i < q.length(); i++)
@@ -358,17 +381,18 @@ class SQLConnection : public SQLProvider
                                        field.push_back(q[i++]);
                                i--;
 
-                               ParamM::const_iterator it = p.find(field);
+                               SQL::ParamMap::const_iterator it = p.find(field);
                                if (it != p.end())
                                {
                                        std::string parm = it->second;
-                                       char buffer[MAXBUF];
-                                       mysql_escape_string(buffer, parm.c_str(), parm.length());
-                                       res.append(buffer);
+                                       // NOTE: See above
+                                       std::vector<char> buffer(parm.length() * 2 + 1);
+                                       unsigned long escapedsize = mysql_escape_string(&buffer[0], parm.c_str(), parm.length());
+                                       res.append(&buffer[0], escapedsize);
                                }
                        }
                }
-               submit(call, res);
+               Submit(call, res);
        }
 };
 
@@ -380,12 +404,7 @@ ModuleSQL::ModuleSQL()
 void ModuleSQL::init()
 {
        Dispatcher = new DispatcherThread(this);
-       ServerInstance->Threads->Start(Dispatcher);
-
-       Implementation eventlist[] = { I_OnRehash, I_OnUnloadModule };
-       ServerInstance->Modules->Attach(eventlist, this, 2);
-
-       OnRehash(NULL);
+       ServerInstance->Threads.Start(Dispatcher);
 }
 
 ModuleSQL::~ModuleSQL()
@@ -402,13 +421,13 @@ ModuleSQL::~ModuleSQL()
        }
 }
 
-void ModuleSQL::OnRehash(User* user)
+void ModuleSQL::ReadConfig(ConfigStatus& status)
 {
        ConnMap conns;
        ConfigTagList tags = ServerInstance->Config->ConfTags("database");
        for(ConfigIter i = tags.first; i != tags.second; i++)
        {
-               if (i->second->getString("module", "mysql") != "mysql")
+               if (!stdalgo::string::equalsci(i->second->getString("provider"), "mysql"))
                        continue;
                std::string id = i->second->getString("id");
                ConnMap::iterator curr = connections.find(id);
@@ -427,7 +446,7 @@ void ModuleSQL::OnRehash(User* user)
 
        // now clean up the deleted databases
        Dispatcher->LockQueue();
-       SQLerror err(SQL_BAD_DBID);
+       SQL::Error err(SQL::BAD_DBID);
        for(ConnMap::iterator i = connections.begin(); i != connections.end(); i++)
        {
                ServerInstance->Modules->DelService(*i->second);
@@ -435,13 +454,14 @@ void ModuleSQL::OnRehash(User* user)
                i->second->lock.Lock();
                i->second->lock.Unlock();
                // now remove all active queries to this DB
-               for(unsigned int j = qq.size() - 1; j >= 0; j--)
+               for (size_t j = qq.size(); j > 0; j--)
                {
-                       if (qq[j].c == i->second)
+                       size_t k = j - 1;
+                       if (qq[k].c == i->second)
                        {
-                               qq[j].q->OnError(err);
-                               delete qq[j].q;
-                               qq.erase(qq.begin() + j);
+                               qq[k].q->OnError(err);
+                               delete qq[k].q;
+                               qq.erase(qq.begin() + k);
                        }
                }
                // finally, nuke the connection
@@ -453,7 +473,7 @@ void ModuleSQL::OnRehash(User* user)
 
 void ModuleSQL::OnUnloadModule(Module* mod)
 {
-       SQLerror err(SQL_BAD_DBID);
+       SQL::Error err(SQL::BAD_DBID);
        Dispatcher->LockQueue();
        unsigned int i = qq.size();
        while (i > 0)
@@ -503,7 +523,7 @@ void DispatcherThread::Run()
                         */
 
                        this->LockQueue();
-                       if (Parent->qq.front().q == i.q)
+                       if (!Parent->qq.empty() && Parent->qq.front().q == i.q)
                        {
                                Parent->qq.pop_front();
                                Parent->rq.push_back(RQueueItem(i.q, res));
@@ -533,7 +553,7 @@ void DispatcherThread::OnNotify()
        for(ResultQueue::iterator i = Parent->rq.begin(); i != Parent->rq.end(); i++)
        {
                MySQLresult* res = i->r;
-               if (res->err.id == SQL_NO_ERROR)
+               if (res->err.code == SQL::SUCCESS)
                        i->q->OnResult(*res);
                else
                        i->q->OnError(res->err);