]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/extra/m_mysql.cpp
Pedantic safe
[user/henk/code/inspircd.git] / src / modules / extra / m_mysql.cpp
index a59ad3b6cb9f95c577837707ab12e08e7b3daf83..c63ebe7e9d3618589f7835ca75a14ca895b708db 100644 (file)
@@ -2,36 +2,29 @@
  *       | Inspire Internet Relay Chat Daemon |
  *       +------------------------------------+
  *
- *  InspIRCd is copyright (C) 2002-2004 ChatSpike-Dev.
- *                    E-mail:
- *             <brain@chatspike.net>
- *               <Craig@chatspike.net>
- *     
- * Written by Craig Edwards, Craig McLure, and others.
+ *  InspIRCd: (C) 2002-2007 InspIRCd Development Team
+ * See: http://www.inspircd.org/wiki/index.php/Credits
+ *
  * This program is free but copyrighted software; see
- *         the file COPYING for details.
+ *            the file COPYING for details.
  *
  * ---------------------------------------------------
  */
 
-using namespace std;
-
-#include <stdio.h>
-#include <string>
+#include "inspircd.h"
 #include <mysql.h>
 #include <pthread.h>
 #include "users.h"
 #include "channels.h"
 #include "modules.h"
-
-#include "inspircd.h"
 #include "m_sqlv2.h"
 
 /* VERSION 2 API: With nonblocking (threaded) requests */
 
 /* $ModDesc: SQL Service Provider module for all other m_sql* modules */
-/* $CompileFlags: `mysql_config --include` */
-/* $LinkerFlags: `mysql_config --libs_r` `perl extra/mysql_rpath.pl` */
+/* $CompileFlags: exec("mysql_config --include") */
+/* $LinkerFlags: exec("mysql_config --libs_r") rpath("mysql_config --libs_r") */
+/* $ModDep: m_sqlv2.h */
 
 /* THE NONBLOCKING MYSQL API!
  * 
@@ -85,123 +78,18 @@ int QueueFD = -1;
 
 typedef std::deque<SQLresult*> ResultQueue;
 
-class QueryQueue : public classbase
-{
-private:
-       typedef std::deque<SQLrequest> ReqDeque;
-
-       ReqDeque priority;      /* The priority queue */
-       ReqDeque normal;        /* The 'normal' queue */
-       enum { PRI, NOR, NON } which;   /* Which queue the currently active element is at the front of */
-
-public:
-       QueryQueue()
-       : which(NON)
-       {
-       }
-
-       void push(const SQLrequest &q)
-       {
-               if(q.pri)
-                       priority.push_back(q);
-               else
-                       normal.push_back(q);
-       }
-
-       void pop()
-       {
-               if((which == PRI) && priority.size())
-               {
-                       priority.pop_front();
-               }
-               else if((which == NOR) && normal.size())
-               {
-                       normal.pop_front();
-               }
-
-               /* Reset this */
-               which = NON;
-
-               /* Silently do nothing if there was no element to pop() */
-       }
-
-       SQLrequest& front()
-       {
-               switch(which)
-               {
-                       case PRI:
-                               return priority.front();
-                       case NOR:
-                               return normal.front();
-                       default:
-                               if(priority.size())
-                               {
-                                       which = PRI;
-                                       return priority.front();
-                               }
-
-                               if(normal.size())
-                               {
-                                       which = NOR;
-                                       return normal.front();
-                               }
-
-                               /* This will probably result in a segfault,
-                                * but the caller should have checked totalsize()
-                                * first so..meh - moron :p
-                                */
-
-                               return priority.front();
-               }
-       }
-
-       std::pair<int, int> size()
-       {
-               return std::make_pair(priority.size(), normal.size());
-       }
-
-       int totalsize()
-       {
-               return priority.size() + normal.size();
-       }
-
-       void PurgeModule(Module* mod)
-       {
-               DoPurgeModule(mod, priority);
-               DoPurgeModule(mod, normal);
-       }
-
-private:
-       void DoPurgeModule(Module* mod, ReqDeque& q)
-       {
-               for(ReqDeque::iterator iter = q.begin(); iter != q.end(); iter++)
-               {
-                       if(iter->GetSource() == mod)
-                       {
-                               if(iter->id == front().id)
-                               {
-                                       /* It's the currently active query.. :x */
-                                       iter->SetSource(NULL);
-                               }
-                               else
-                               {
-                                       /* It hasn't been executed yet..just remove it */
-                                       iter = q.erase(iter);
-                               }
-                       }
-               }
-       }
-};
-
 /* A mutex to wrap around queue accesses */
 pthread_mutex_t queue_mutex = PTHREAD_MUTEX_INITIALIZER;
 
 pthread_mutex_t results_mutex = PTHREAD_MUTEX_INITIALIZER;
 
+pthread_mutex_t logging_mutex = PTHREAD_MUTEX_INITIALIZER;
+
+/** Represents a mysql result set
+ */
 class MySQLresult : public SQLresult
 {
        int currentrow;
-       //std::vector<std::map<std::string,std::string> > results;
        std::vector<std::string> colnames;
        std::vector<SQLfieldList> fieldlists;
        SQLfieldMap* fieldmap;
@@ -383,6 +271,8 @@ class SQLConnection;
 
 void NotifyMainThread(SQLConnection* connection_with_new_result);
 
+/** Represents a connection to a mysql database
+ */
 class SQLConnection : public classbase
 {
  protected:
@@ -390,29 +280,23 @@ class SQLConnection : public classbase
        MYSQL connection;
        MYSQL_RES *res;
        MYSQL_ROW row;
-       std::string host;
-       std::string user;
-       std::string pass;
-       std::string db;
+       SQLhost host;
        std::map<std::string,std::string> thisrow;
        bool Enabled;
-       std::string id;
 
  public:
 
        QueryQueue queue;
        ResultQueue rq;
 
-       // This constructor creates an SQLConnection object with the given credentials, and creates the underlying
-       // MYSQL struct, but does not connect yet.
-       SQLConnection(std::string thishost, std::string thisuser, std::string thispass, std::string thisdb, const std::string &myid)
+       // This constructor creates an SQLConnection object with the given credentials, but does not connect yet.
+       SQLConnection(const SQLhost &hi) : host(hi), Enabled(false)
        {
-               this->Enabled = true;
-               this->host = thishost;
-               this->user = thisuser;
-               this->pass = thispass;
-               this->db = thisdb;
-               this->id = myid;
+       }
+
+       ~SQLConnection()
+       {
+               Close();
        }
 
        // This method connects to the database using the credentials supplied to the constructor, and returns
@@ -422,7 +306,7 @@ class SQLConnection : public classbase
                unsigned int timeout = 1;
                mysql_init(&connection);
                mysql_options(&connection,MYSQL_OPT_CONNECT_TIMEOUT,(char*)&timeout);
-               return mysql_real_connect(&connection, host.c_str(), user.c_str(), pass.c_str(), db.c_str(), 0, NULL, 0);
+               return mysql_real_connect(&connection, host.host.c_str(), host.user.c_str(), host.pass.c_str(), host.name.c_str(), host.port, NULL, 0);
        }
 
        void DoLeadingQuery()
@@ -458,7 +342,7 @@ class SQLConnection : public classbase
                 * The +1 is for null-terminating the string for mysql_real_escape_string
                 */
 
-               query = new char[req.query.q.length() + (paramlen*2)];
+               query = new char[req.query.q.length() + (paramlen*2) + 1];
                queryend = query;
 
                /* Okay, now we have a buffer large enough we need to start copying the query into it and escaping and substituting
@@ -532,6 +416,8 @@ class SQLConnection : public classbase
                 * Pass them this connection id as what to examine
                 */
 
+               delete[] query;
+
                NotifyMainThread(this);
        }
 
@@ -558,12 +444,12 @@ class SQLConnection : public classbase
 
        const std::string& GetID()
        {
-               return id;
+               return host.id;
        }
 
        std::string GetHost()
        {
-               return host;
+               return host.host;
        }
 
        void SetEnable(bool Enable)
@@ -576,52 +462,142 @@ class SQLConnection : public classbase
                return Enabled;
        }
 
+       void Close()
+       {
+               mysql_close(&connection);
+       }
+
+       const SQLhost& GetConfHost()
+       {
+               return host;
+       }
+
 };
 
 ConnMap Connections;
 
+bool HasHost(const SQLhost &host)
+{
+       for (ConnMap::iterator iter = Connections.begin(); iter != Connections.end(); iter++)
+       {
+               if (host == iter->second->GetConfHost())
+                       return true;
+       }
+       return false;
+}
+
+bool HostInConf(ConfigReader* conf, const SQLhost &h)
+{
+       for(int i = 0; i < conf->Enumerate("database"); 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);
+               host.ssl        = conf->ReadFlag("database", "ssl", i);
+               if (h == host)
+                       return true;
+       }
+       return false;
+}
+
+void ClearOldConnections(ConfigReader* conf)
+{
+       ConnMap::iterator i,safei;
+       for (i = Connections.begin(); i != Connections.end(); i++)
+       {
+               if (!HostInConf(conf, i->second->GetConfHost()))
+               {
+                       DELETE(i->second);
+                       safei = i;
+                       --i;
+                       Connections.erase(safei);
+               }
+       }
+}
+
+void ClearAllConnections()
+{
+       ConnMap::iterator i;
+       while ((i = Connections.begin()) != Connections.end())
+       {
+               Connections.erase(i);
+               DELETE(i->second);
+       }
+}
+
 void ConnectDatabases(InspIRCd* ServerInstance)
 {
        for (ConnMap::iterator i = Connections.begin(); i != Connections.end(); i++)
        {
+               if (i->second->IsEnabled())
+                       continue;
+
                i->second->SetEnable(true);
-               if (i->second->Connect())
-               {
-                       ServerInstance->Log(DEFAULT,"SQL: Successfully connected database "+i->second->GetHost());
-               }
-               else
+               if (!i->second->Connect())
                {
+                       /* XXX: MUTEX */
+                       pthread_mutex_lock(&logging_mutex);
                        ServerInstance->Log(DEFAULT,"SQL: Failed to connect database "+i->second->GetHost()+": Error: "+i->second->GetError());
                        i->second->SetEnable(false);
+                       pthread_mutex_unlock(&logging_mutex);
                }
        }
 }
 
-
-void LoadDatabases(ConfigReader* ThisConf, InspIRCd* ServerInstance)
+void LoadDatabases(ConfigReader* conf, InspIRCd* ServerInstance)
 {
-       ServerInstance->Log(DEFAULT,"SQL: Loading database settings");
-       Connections.clear();
-       ServerInstance->Log(DEBUG,"Cleared connections");
-       for (int j =0; j < ThisConf->Enumerate("database"); j++)
-       {
-               std::string db = ThisConf->ReadValue("database","name",j);
-               std::string user = ThisConf->ReadValue("database","username",j);
-               std::string pass = ThisConf->ReadValue("database","password",j);
-               std::string host = ThisConf->ReadValue("database","hostname",j);
-               std::string id = ThisConf->ReadValue("database","id",j);
-               ServerInstance->Log(DEBUG,"Read database settings");
-               if ((db != "") && (host != "") && (user != "") && (id != "") && (pass != ""))
+       ClearOldConnections(conf);
+       for (int j =0; j < conf->Enumerate("database"); j++)
+       {
+               SQLhost host;
+               host.id         = conf->ReadValue("database", "id", j);
+               host.host       = conf->ReadValue("database", "hostname", j);
+               host.port       = conf->ReadInteger("database", "port", j, true);
+               host.name       = conf->ReadValue("database", "name", j);
+               host.user       = conf->ReadValue("database", "username", j);
+               host.pass       = conf->ReadValue("database", "password", j);
+               host.ssl        = conf->ReadFlag("database", "ssl", j);
+
+               if (HasHost(host))
+                       continue;
+
+               if (!host.id.empty() && !host.host.empty() && !host.name.empty() && !host.user.empty() && !host.pass.empty())
                {
-                       SQLConnection* ThisSQL = new SQLConnection(host,user,pass,db,id);
-                       ServerInstance->Log(DEFAULT,"Loaded database: "+ThisSQL->GetHost());
-                       Connections[id] = ThisSQL;
-                       ServerInstance->Log(DEBUG,"Pushed back connection");
+                       SQLConnection* ThisSQL = new SQLConnection(host);
+                       Connections[host.id] = ThisSQL;
                }
        }
        ConnectDatabases(ServerInstance);
 }
 
+char FindCharId(const std::string &id)
+{
+       char i = 1;
+       for (ConnMap::iterator iter = Connections.begin(); iter != Connections.end(); ++iter, ++i)
+       {
+               if (iter->first == id)
+               {
+                       return i;
+               }
+       }
+       return 0;
+}
+
+ConnMap::iterator GetCharId(char id)
+{
+       char i = 1;
+       for (ConnMap::iterator iter = Connections.begin(); iter != Connections.end(); ++iter, ++i)
+       {
+               if (i == id)
+                       return iter;
+       }
+       return Connections.end();
+}
+
 void NotifyMainThread(SQLConnection* connection_with_new_result)
 {
        /* Here we write() to the socket the main thread has open
@@ -632,13 +608,23 @@ void NotifyMainThread(SQLConnection* connection_with_new_result)
         * thread, we can just use standard connect(), and we can
         * block if we like. We just send the connection id of the
         * connection back.
+        *
+        * NOTE: We only send a single char down the connection, this
+        * way we know it wont get a partial read at the other end if
+        * the system is especially congested (see bug #263).
+        * The function FindCharId translates a connection name into a
+        * one character id, and GetCharId translates a character id
+        * back into an iterator.
         */
-       send(QueueFD, connection_with_new_result->GetID().c_str(), connection_with_new_result->GetID().length()+1, 0);
+       char id = FindCharId(connection_with_new_result->GetID());
+       send(QueueFD, &id, 1, 0);
 }
 
 void* DispatcherThread(void* arg);
 
-class Notifier : public InspSocket
+/** Used by m_mysql to notify one thread when the other has a result
+ */
+class Notifier : public BufferedSocket
 {
        insp_sockaddr sock_us;
        socklen_t uslen;
@@ -648,9 +634,9 @@ class Notifier : public InspSocket
 
        /* Create a socket on a random port. Let the tcp stack allocate us an available port */
 #ifdef IPV6
-       Notifier(InspIRCd* SI) : InspSocket(SI, "::1", 0, true, 3000)
+       Notifier(InspIRCd* SI) : BufferedSocket(SI, "::1", 0, true, 3000)
 #else
-       Notifier(InspIRCd* SI) : InspSocket(SI, "127.0.0.1", 0, true, 3000)
+       Notifier(InspIRCd* SI) : BufferedSocket(SI, "127.0.0.1", 0, true, 3000)
 #endif
        {
                uslen = sizeof(sock_us);
@@ -660,9 +646,8 @@ class Notifier : public InspSocket
                }
        }
 
-       Notifier(InspIRCd* SI, int newfd, char* ip) : InspSocket(SI, newfd, ip)
+       Notifier(InspIRCd* SI, int newfd, char* ip) : BufferedSocket(SI, newfd, ip)
        {
-               Instance->Log(DEBUG,"Constructor of new socket");
        }
 
        /* Using getsockname and ntohs, we can determine which port number we were allocated */
@@ -677,7 +662,6 @@ class Notifier : public InspSocket
 
        virtual int OnIncomingConnection(int newsock, char* ip)
        {
-               Instance->Log(DEBUG,"Inbound connection on fd %d!",newsock);
                Notifier* n = new Notifier(this->Instance, newsock, ip);
                n = n; /* Stop bitching at me, GCC */
                return true;
@@ -685,18 +669,18 @@ class Notifier : public InspSocket
 
        virtual bool OnDataReady()
        {
-               Instance->Log(DEBUG,"Inbound data!");
-               char* data = this->Read();
-               ConnMap::iterator iter;
-
-               if (data && *data)
+               char data = 0;
+               /* NOTE: Only a single character is read so we know we
+                * cant get a partial read. (We've been told that theres
+                * data waiting, so we wont ever get EAGAIN)
+                * The function GetCharId translates a single character
+                * back into an iterator.
+                */
+               if (Instance->SE->Recv(this, &data, 1, 0) > 0)
                {
-                       Instance->Log(DEBUG,"Looking for connection %s",data);
-                       /* We expect to be sent a null terminated string */
-                       if((iter = Connections.find(data)) != Connections.end())
+                       ConnMap::iterator iter = GetCharId(data);
+                       if (iter != Connections.end())
                        {
-                               Instance->Log(DEBUG,"Found it!");
-
                                /* Lock the mutex, send back the data */
                                pthread_mutex_lock(&results_mutex);
                                ResultQueue::iterator n = iter->second->rq.begin();
@@ -705,12 +689,17 @@ class Notifier : public InspSocket
                                pthread_mutex_unlock(&results_mutex);
                                return true;
                        }
+                       /* No error, but unknown id */
+                       return true;
                }
 
+               /* Erk, error on descriptor! */
                return false;
        }
 };
 
+/** MySQL module
+ */
 class ModuleSQL : public Module
 {
  public:
@@ -719,6 +708,48 @@ class ModuleSQL : public Module
        InspIRCd* PublicServerInstance;
        pthread_t Dispatcher;
        int currid;
+       bool rehashing;
+
+       ModuleSQL(InspIRCd* Me)
+       : Module::Module(Me), rehashing(false)
+       {
+               ServerInstance->Modules->UseInterface("SQLutils");
+
+               Conf = new ConfigReader(ServerInstance);
+               PublicServerInstance = ServerInstance;
+               currid = 0;
+               SQLModule = this;
+
+               MessagePipe = new Notifier(ServerInstance);
+               
+               pthread_attr_t attribs;
+               pthread_attr_init(&attribs);
+               pthread_attr_setdetachstate(&attribs, PTHREAD_CREATE_DETACHED);
+               if (pthread_create(&this->Dispatcher, &attribs, DispatcherThread, (void *)this) != 0)
+               {
+                       throw ModuleException("m_mysql: Failed to create dispatcher thread: " + std::string(strerror(errno)));
+               }
+
+               if (!ServerInstance->Modules->PublishFeature("SQL", this))
+               {
+                       /* Tell worker thread to exit NOW */
+                       giveup = true;
+                       throw ModuleException("m_mysql: Unable to publish feature 'SQL'");
+               }
+
+               ServerInstance->Modules->PublishInterface("SQL", this);
+       }
+
+       virtual ~ModuleSQL()
+       {
+               giveup = true;
+               ClearAllConnections();
+               delete Conf;
+               ServerInstance->Modules->UnpublishInterface("SQL", this);
+               ServerInstance->Modules->UnpublishFeature("SQL");
+               ServerInstance->Modules->DoneWithInterface("SQLutils");
+       }
+
 
        void Implements(char* List)
        {
@@ -745,8 +776,6 @@ class ModuleSQL : public Module
 
                        char* returnval = NULL;
 
-                       ServerInstance->Log(DEBUG, "Got query: '%s' with %d replacement parameters on id '%s'", req->query.q.c_str(), req->query.p.size(), req->dbid.c_str());
-
                        if((iter = Connections.find(req->dbid)) != Connections.end())
                        {
                                req->id = NewID();
@@ -764,46 +793,12 @@ class ModuleSQL : public Module
                        return returnval;
                }
 
-               ServerInstance->Log(DEBUG, "Got unsupported API version string: %s", request->GetId());
-
                return NULL;
        }
 
-       ModuleSQL(InspIRCd* Me)
-               : Module::Module(Me)
-       {
-               
-               Conf = new ConfigReader(ServerInstance);
-               PublicServerInstance = ServerInstance;
-               currid = 0;
-               SQLModule = this;
-
-               MessagePipe = new Notifier(ServerInstance);
-               ServerInstance->Log(DEBUG,"Bound notifier to 127.0.0.1:%d",MessagePipe->GetPort());
-               
-               pthread_attr_t attribs;
-               pthread_attr_init(&attribs);
-               pthread_attr_setdetachstate(&attribs, PTHREAD_CREATE_DETACHED);
-               if (pthread_create(&this->Dispatcher, &attribs, DispatcherThread, (void *)this) != 0)
-               {
-                       throw ModuleException("m_mysql: Failed to create dispatcher thread: " + std::string(strerror(errno)));
-               }
-               if (!ServerInstance->PublishFeature("SQL", this))
-               {
-                       /* Tell worker thread to exit NOW */
-                       giveup = true;
-                       throw ModuleException("m_mysql: Unable to publish feature 'SQL'");
-               }
-       }
-       
-       virtual ~ModuleSQL()
-       {
-               DELETE(Conf);
-       }
-       
-       virtual void OnRehash(const std::string &parameter)
+       virtual void OnRehash(User* user, const std::string &parameter)
        {
-               /* TODO: set rehash bool here, which makes the dispatcher thread rehash at next opportunity */
+               rehashing = true;
        }
        
        virtual Version GetVersion()
@@ -848,6 +843,16 @@ void* DispatcherThread(void* arg)
 
        while (!giveup)
        {
+               if (thismodule->rehashing)
+               {
+               /* XXX: Lock */
+                       pthread_mutex_lock(&queue_mutex);
+                       thismodule->rehashing = false;
+                       LoadDatabases(thismodule->Conf, thismodule->PublicServerInstance);
+                       pthread_mutex_unlock(&queue_mutex);
+                       /* XXX: Unlock */
+               }
+
                SQLConnection* conn = NULL;
                /* XXX: Lock here for safety */
                pthread_mutex_lock(&queue_mutex);
@@ -880,29 +885,4 @@ void* DispatcherThread(void* arg)
        return NULL;
 }
 
-
-// stuff down here is the module-factory stuff. For basic modules you can ignore this.
-
-class ModuleSQLFactory : public ModuleFactory
-{
- public:
-       ModuleSQLFactory()
-       {
-       }
-       
-       ~ModuleSQLFactory()
-       {
-       }
-       
-       virtual Module * CreateModule(InspIRCd* Me)
-       {
-               return new ModuleSQL(Me);
-       }
-       
-};
-
-
-extern "C" void * init_module( void )
-{
-       return new ModuleSQLFactory;
-}
+MODULE_INIT(ModuleSQL)