-/* +------------------------------------+\r * | Inspire Internet Relay Chat Daemon |\r * +------------------------------------+\r *\r * InspIRCd: (C) 2002-2007 InspIRCd Development Team\r * See: http://www.inspircd.org/wiki/index.php/Credits\r *\r * This program is free but copyrighted software; see\r * the file COPYING for details.\r *\r * ---------------------------------------------------\r */\r\r#include "inspircd.h"\r#include <mysql.h>\r#include <pthread.h>\r#include "users.h"\r#include "channels.h"\r#include "modules.h"\r#include "m_sqlv2.h"\r\r/* VERSION 2 API: With nonblocking (threaded) requests */\r\r/* $ModDesc: SQL Service Provider module for all other m_sql* modules */\r/* $CompileFlags: exec("mysql_config --include") */\r/* $LinkerFlags: exec("mysql_config --libs_r") rpath("mysql_config --libs_r") */\r/* $ModDep: m_sqlv2.h */\r\r/* THE NONBLOCKING MYSQL API!\r * \r * MySQL provides no nonblocking (asyncronous) API of its own, and its developers recommend\r * that instead, you should thread your program. This is what i've done here to allow for\r * asyncronous SQL requests via mysql. The way this works is as follows:\r *\r * The module spawns a thread via pthreads, and performs its mysql queries in this thread,\r * using a queue with priorities. There is a mutex on either end which prevents two threads\r * adjusting the queue at the same time, and crashing the ircd. Every 50 milliseconds, the\r * worker thread wakes up, and checks if there is a request at the head of its queue.\r * If there is, it processes this request, blocking the worker thread but leaving the ircd\r * thread to go about its business as usual. During this period, the ircd thread is able\r * to insert futher pending requests into the queue.\r *\r * Once the processing of a request is complete, it is removed from the incoming queue to\r * an outgoing queue, and initialized as a 'response'. The worker thread then signals the\r * ircd thread (via a loopback socket) of the fact a result is available, by sending the\r * connection ID through the connection.\r *\r * The ircd thread then mutexes the queue once more, reads the outbound response off the head\r * of the queue, and sends it on its way to the original calling module.\r *\r * XXX: You might be asking "why doesnt he just send the response from within the worker thread?"\r * The answer to this is simple. The majority of InspIRCd, and in fact most ircd's are not\r * threadsafe. This module is designed to be threadsafe and is careful with its use of threads,\r * however, if we were to call a module's OnRequest even from within a thread which was not the\r * one the module was originally instantiated upon, there is a chance of all hell breaking loose\r * if a module is ever put in a re-enterant state (stack corruption could occur, crashes, data\r * corruption, and worse, so DONT think about it until the day comes when InspIRCd is 100%\r * gauranteed threadsafe!)\r *\r * For a diagram of this system please see http://www.inspircd.org/wiki/Mysql2\r */\r\r\rclass SQLConnection;\rclass Notifier;\r\r\rtypedef std::map<std::string, SQLConnection*> ConnMap;\rbool giveup = false;\rstatic Module* SQLModule = NULL;\rstatic Notifier* MessagePipe = NULL;\rint QueueFD = -1;\r\r\r#if !defined(MYSQL_VERSION_ID) || MYSQL_VERSION_ID<32224\r#define mysql_field_count mysql_num_fields\r#endif\r\rtypedef std::deque<SQLresult*> ResultQueue;\r\r/* A mutex to wrap around queue accesses */\rpthread_mutex_t queue_mutex = PTHREAD_MUTEX_INITIALIZER;\r\rpthread_mutex_t results_mutex = PTHREAD_MUTEX_INITIALIZER;\r\rpthread_mutex_t logging_mutex = PTHREAD_MUTEX_INITIALIZER;\r\r/** Represents a mysql result set\r */\rclass MySQLresult : public SQLresult\r{\r int currentrow;\r std::vector<std::string> colnames;\r std::vector<SQLfieldList> fieldlists;\r SQLfieldMap* fieldmap;\r SQLfieldMap fieldmap2;\r SQLfieldList emptyfieldlist;\r int rows;\r public:\r\r MySQLresult(Module* self, Module* to, MYSQL_RES* res, int affected_rows, unsigned int id) : SQLresult(self, to, id), currentrow(0), fieldmap(NULL)\r {\r /* A number of affected rows from from mysql_affected_rows.\r */\r fieldlists.clear();\r rows = 0;\r if (affected_rows >= 1)\r {\r rows = affected_rows;\r fieldlists.resize(rows);\r }\r unsigned int field_count = 0;\r if (res)\r {\r MYSQL_ROW row;\r int n = 0;\r while ((row = mysql_fetch_row(res)))\r {\r if (fieldlists.size() < (unsigned int)rows+1)\r {\r fieldlists.resize(fieldlists.size()+1);\r }\r field_count = 0;\r MYSQL_FIELD *fields = mysql_fetch_fields(res);\r if(mysql_num_fields(res) == 0)\r break;\r if (fields && mysql_num_fields(res))\r {\r colnames.clear();\r while (field_count < mysql_num_fields(res))\r {\r std::string a = (fields[field_count].name ? fields[field_count].name : "");\r std::string b = (row[field_count] ? row[field_count] : "");\r SQLfield sqlf(b, !row[field_count]);\r colnames.push_back(a);\r fieldlists[n].push_back(sqlf); \r field_count++;\r }\r n++;\r }\r rows++;\r }\r mysql_free_result(res);\r }\r }\r\r MySQLresult(Module* self, Module* to, SQLerror e, unsigned int id) : SQLresult(self, to, id), currentrow(0)\r {\r rows = 0;\r error = e;\r }\r\r ~MySQLresult()\r {\r }\r\r virtual int Rows()\r {\r return rows;\r }\r\r virtual int Cols()\r {\r return colnames.size();\r }\r\r virtual std::string ColName(int column)\r {\r if (column < (int)colnames.size())\r {\r return colnames[column];\r }\r else\r {\r throw SQLbadColName();\r }\r return "";\r }\r\r virtual int ColNum(const std::string &column)\r {\r for (unsigned int i = 0; i < colnames.size(); i++)\r {\r if (column == colnames[i])\r return i;\r }\r throw SQLbadColName();\r return 0;\r }\r\r virtual SQLfield GetValue(int row, int column)\r {\r if ((row >= 0) && (row < rows) && (column >= 0) && (column < Cols()))\r {\r return fieldlists[row][column];\r }\r\r throw SQLbadColName();\r\r /* XXX: We never actually get here because of the throw */\r return SQLfield("",true);\r }\r\r virtual SQLfieldList& GetRow()\r {\r if (currentrow < rows)\r return fieldlists[currentrow];\r else\r return emptyfieldlist;\r }\r\r virtual SQLfieldMap& GetRowMap()\r {\r fieldmap2.clear();\r\r if (currentrow < rows)\r {\r for (int i = 0; i < Cols(); i++)\r {\r fieldmap2.insert(std::make_pair(colnames[i],GetValue(currentrow, i)));\r }\r currentrow++;\r }\r\r return fieldmap2;\r }\r\r virtual SQLfieldList* GetRowPtr()\r {\r SQLfieldList* fieldlist = new SQLfieldList();\r\r if (currentrow < rows)\r {\r for (int i = 0; i < Rows(); i++)\r {\r fieldlist->push_back(fieldlists[currentrow][i]);\r }\r currentrow++;\r }\r return fieldlist;\r }\r\r virtual SQLfieldMap* GetRowMapPtr()\r {\r fieldmap = new SQLfieldMap();\r \r if (currentrow < rows)\r {\r for (int i = 0; i < Cols(); i++)\r {\r fieldmap->insert(std::make_pair(colnames[i],GetValue(currentrow, i)));\r }\r currentrow++;\r }\r\r return fieldmap;\r }\r\r virtual void Free(SQLfieldMap* fm)\r {\r delete fm;\r }\r\r virtual void Free(SQLfieldList* fl)\r {\r delete fl;\r }\r};\r\rclass SQLConnection;\r\rvoid NotifyMainThread(SQLConnection* connection_with_new_result);\r\r/** Represents a connection to a mysql database\r */\rclass SQLConnection : public classbase\r{\r protected:\r\r MYSQL connection;\r MYSQL_RES *res;\r MYSQL_ROW row;\r SQLhost host;\r std::map<std::string,std::string> thisrow;\r bool Enabled;\r\r public:\r\r QueryQueue queue;\r ResultQueue rq;\r\r // This constructor creates an SQLConnection object with the given credentials, but does not connect yet.\r SQLConnection(const SQLhost &hi) : host(hi), Enabled(false)\r {\r }\r\r ~SQLConnection()\r {\r Close();\r }\r\r // This method connects to the database using the credentials supplied to the constructor, and returns\r // true upon success.\r bool Connect()\r {\r unsigned int timeout = 1;\r mysql_init(&connection);\r mysql_options(&connection,MYSQL_OPT_CONNECT_TIMEOUT,(char*)&timeout);\r 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);\r }\r\r void DoLeadingQuery()\r {\r if (!CheckConnection())\r return;\r\r /* Parse the command string and dispatch it to mysql */\r SQLrequest& req = queue.front();\r\r /* Pointer to the buffer we screw around with substitution in */\r char* query;\r\r /* Pointer to the current end of query, where we append new stuff */\r char* queryend;\r\r /* Total length of the unescaped parameters */\r unsigned long paramlen;\r\r /* Total length of query, used for binary-safety in mysql_real_query */\r unsigned long querylength = 0;\r\r paramlen = 0;\r\r for(ParamL::iterator i = req.query.p.begin(); i != req.query.p.end(); i++)\r {\r paramlen += i->size();\r }\r\r /* To avoid a lot of allocations, allocate enough memory for the biggest the escaped query could possibly be.\r * sizeofquery + (totalparamlength*2) + 1\r *\r * The +1 is for null-terminating the string for mysql_real_escape_string\r */\r\r query = new char[req.query.q.length() + (paramlen*2) + 1];\r queryend = query;\r\r /* Okay, now we have a buffer large enough we need to start copying the query into it and escaping and substituting\r * the parameters into it...\r */\r\r for(unsigned long i = 0; i < req.query.q.length(); i++)\r {\r if(req.query.q[i] == '?')\r {\r /* We found a place to substitute..what fun.\r * use mysql calls to escape and write the\r * escaped string onto the end of our query buffer,\r * then we "just" need to make sure queryend is\r * pointing at the right place.\r */\r if(req.query.p.size())\r {\r unsigned long len = mysql_real_escape_string(&connection, queryend, req.query.p.front().c_str(), req.query.p.front().length());\r\r queryend += len;\r req.query.p.pop_front();\r }\r else\r break;\r }\r else\r {\r *queryend = req.query.q[i];\r queryend++;\r }\r querylength++;\r }\r\r *queryend = 0;\r\r pthread_mutex_lock(&queue_mutex);\r req.query.q = query;\r pthread_mutex_unlock(&queue_mutex);\r\r if (!mysql_real_query(&connection, req.query.q.data(), req.query.q.length()))\r {\r /* Successfull query */\r res = mysql_use_result(&connection);\r unsigned long rows = mysql_affected_rows(&connection);\r MySQLresult* r = new MySQLresult(SQLModule, req.GetSource(), res, rows, req.id);\r r->dbid = this->GetID();\r r->query = req.query.q;\r /* Put this new result onto the results queue.\r * XXX: Remember to mutex the queue!\r */\r pthread_mutex_lock(&results_mutex);\r rq.push_back(r);\r pthread_mutex_unlock(&results_mutex);\r }\r else\r {\r /* XXX: See /usr/include/mysql/mysqld_error.h for a list of\r * possible error numbers and error messages */\r SQLerror e(QREPLY_FAIL, ConvToStr(mysql_errno(&connection)) + std::string(": ") + mysql_error(&connection));\r MySQLresult* r = new MySQLresult(SQLModule, req.GetSource(), e, req.id);\r r->dbid = this->GetID();\r r->query = req.query.q;\r\r pthread_mutex_lock(&results_mutex);\r rq.push_back(r);\r pthread_mutex_unlock(&results_mutex);\r }\r\r /* Now signal the main thread that we've got a result to process.\r * Pass them this connection id as what to examine\r */\r\r delete[] query;\r\r NotifyMainThread(this);\r }\r\r bool ConnectionLost()\r {\r if (&connection) {\r return (mysql_ping(&connection) != 0);\r }\r else return false;\r }\r\r bool CheckConnection()\r {\r if (ConnectionLost()) {\r return Connect();\r }\r else return true;\r }\r\r std::string GetError()\r {\r return mysql_error(&connection);\r }\r\r const std::string& GetID()\r {\r return host.id;\r }\r\r std::string GetHost()\r {\r return host.host;\r }\r\r void SetEnable(bool Enable)\r {\r Enabled = Enable;\r }\r\r bool IsEnabled()\r {\r return Enabled;\r }\r\r void Close()\r {\r mysql_close(&connection);\r }\r\r const SQLhost& GetConfHost()\r {\r return host;\r }\r\r};\r\rConnMap Connections;\r\rbool HasHost(const SQLhost &host)\r{\r for (ConnMap::iterator iter = Connections.begin(); iter != Connections.end(); iter++)\r {\r if (host == iter->second->GetConfHost())\r return true;\r }\r return false;\r}\r\rbool HostInConf(ConfigReader* conf, const SQLhost &h)\r{\r for(int i = 0; i < conf->Enumerate("database"); i++)\r {\r SQLhost host;\r host.id = conf->ReadValue("database", "id", i);\r host.host = conf->ReadValue("database", "hostname", i);\r host.port = conf->ReadInteger("database", "port", i, true);\r host.name = conf->ReadValue("database", "name", i);\r host.user = conf->ReadValue("database", "username", i);\r host.pass = conf->ReadValue("database", "password", i);\r host.ssl = conf->ReadFlag("database", "ssl", i);\r if (h == host)\r return true;\r }\r return false;\r}\r\rvoid ClearOldConnections(ConfigReader* conf)\r{\r ConnMap::iterator i,safei;\r for (i = Connections.begin(); i != Connections.end(); i++)\r {\r if (!HostInConf(conf, i->second->GetConfHost()))\r {\r DELETE(i->second);\r safei = i;\r --i;\r Connections.erase(safei);\r }\r }\r}\r\rvoid ClearAllConnections()\r{\r ConnMap::iterator i;\r while ((i = Connections.begin()) != Connections.end())\r {\r Connections.erase(i);\r DELETE(i->second);\r }\r}\r\rvoid ConnectDatabases(InspIRCd* ServerInstance)\r{\r for (ConnMap::iterator i = Connections.begin(); i != Connections.end(); i++)\r {\r if (i->second->IsEnabled())\r continue;\r\r i->second->SetEnable(true);\r if (!i->second->Connect())\r {\r /* XXX: MUTEX */\r pthread_mutex_lock(&logging_mutex);\r ServerInstance->Log(DEFAULT,"SQL: Failed to connect database "+i->second->GetHost()+": Error: "+i->second->GetError());\r i->second->SetEnable(false);\r pthread_mutex_unlock(&logging_mutex);\r }\r }\r}\r\rvoid LoadDatabases(ConfigReader* conf, InspIRCd* ServerInstance)\r{\r ClearOldConnections(conf);\r for (int j =0; j < conf->Enumerate("database"); j++)\r {\r SQLhost host;\r host.id = conf->ReadValue("database", "id", j);\r host.host = conf->ReadValue("database", "hostname", j);\r host.port = conf->ReadInteger("database", "port", j, true);\r host.name = conf->ReadValue("database", "name", j);\r host.user = conf->ReadValue("database", "username", j);\r host.pass = conf->ReadValue("database", "password", j);\r host.ssl = conf->ReadFlag("database", "ssl", j);\r\r if (HasHost(host))\r continue;\r\r if (!host.id.empty() && !host.host.empty() && !host.name.empty() && !host.user.empty() && !host.pass.empty())\r {\r SQLConnection* ThisSQL = new SQLConnection(host);\r Connections[host.id] = ThisSQL;\r }\r }\r ConnectDatabases(ServerInstance);\r}\r\rchar FindCharId(const std::string &id)\r{\r char i = 1;\r for (ConnMap::iterator iter = Connections.begin(); iter != Connections.end(); ++iter, ++i)\r {\r if (iter->first == id)\r {\r return i;\r }\r }\r return 0;\r}\r\rConnMap::iterator GetCharId(char id)\r{\r char i = 1;\r for (ConnMap::iterator iter = Connections.begin(); iter != Connections.end(); ++iter, ++i)\r {\r if (i == id)\r return iter;\r }\r return Connections.end();\r}\r\rvoid NotifyMainThread(SQLConnection* connection_with_new_result)\r{\r /* Here we write() to the socket the main thread has open\r * and we connect()ed back to before our thread became active.\r * The main thread is using a nonblocking socket tied into\r * the socket engine, so they wont block and they'll receive\r * nearly instant notification. Because we're in a seperate\r * thread, we can just use standard connect(), and we can\r * block if we like. We just send the connection id of the\r * connection back.\r *\r * NOTE: We only send a single char down the connection, this\r * way we know it wont get a partial read at the other end if\r * the system is especially congested (see bug #263).\r * The function FindCharId translates a connection name into a\r * one character id, and GetCharId translates a character id\r * back into an iterator.\r */\r char id = FindCharId(connection_with_new_result->GetID());\r send(QueueFD, &id, 1, 0);\r}\r\rvoid* DispatcherThread(void* arg);\r\r/** Used by m_mysql to notify one thread when the other has a result\r */\rclass Notifier : public InspSocket\r{\r insp_sockaddr sock_us;\r socklen_t uslen;\r \r\r public:\r\r /* Create a socket on a random port. Let the tcp stack allocate us an available port */\r#ifdef IPV6\r Notifier(InspIRCd* SI) : InspSocket(SI, "::1", 0, true, 3000)\r#else\r Notifier(InspIRCd* SI) : InspSocket(SI, "127.0.0.1", 0, true, 3000)\r#endif\r {\r uslen = sizeof(sock_us);\r if (getsockname(this->fd,(sockaddr*)&sock_us,&uslen))\r {\r throw ModuleException("Could not create random listening port on localhost");\r }\r }\r\r Notifier(InspIRCd* SI, int newfd, char* ip) : InspSocket(SI, newfd, ip)\r {\r }\r\r /* Using getsockname and ntohs, we can determine which port number we were allocated */\r int GetPort()\r {\r#ifdef IPV6\r return ntohs(sock_us.sin6_port);\r#else\r return ntohs(sock_us.sin_port);\r#endif\r }\r\r virtual int OnIncomingConnection(int newsock, char* ip)\r {\r Notifier* n = new Notifier(this->Instance, newsock, ip);\r n = n; /* Stop bitching at me, GCC */\r return true;\r }\r\r virtual bool OnDataReady()\r {\r char data = 0;\r /* NOTE: Only a single character is read so we know we\r * cant get a partial read. (We've been told that theres\r * data waiting, so we wont ever get EAGAIN)\r * The function GetCharId translates a single character\r * back into an iterator.\r */\r if (read(this->GetFd(), &data, 1) > 0)\r {\r ConnMap::iterator iter = GetCharId(data);\r if (iter != Connections.end())\r {\r /* Lock the mutex, send back the data */\r pthread_mutex_lock(&results_mutex);\r ResultQueue::iterator n = iter->second->rq.begin();\r (*n)->Send();\r iter->second->rq.pop_front();\r pthread_mutex_unlock(&results_mutex);\r return true;\r }\r /* No error, but unknown id */\r return true;\r }\r\r /* Erk, error on descriptor! */\r return false;\r }\r};\r\r/** MySQL module\r */\rclass ModuleSQL : public Module\r{\r public:\r \r ConfigReader *Conf;\r InspIRCd* PublicServerInstance;\r pthread_t Dispatcher;\r int currid;\r bool rehashing;\r\r ModuleSQL(InspIRCd* Me)\r : Module::Module(Me), rehashing(false)\r {\r ServerInstance->UseInterface("SQLutils");\r\r Conf = new ConfigReader(ServerInstance);\r PublicServerInstance = ServerInstance;\r currid = 0;\r SQLModule = this;\r\r MessagePipe = new Notifier(ServerInstance);\r \r pthread_attr_t attribs;\r pthread_attr_init(&attribs);\r pthread_attr_setdetachstate(&attribs, PTHREAD_CREATE_DETACHED);\r if (pthread_create(&this->Dispatcher, &attribs, DispatcherThread, (void *)this) != 0)\r {\r throw ModuleException("m_mysql: Failed to create dispatcher thread: " + std::string(strerror(errno)));\r }\r\r if (!ServerInstance->PublishFeature("SQL", this))\r {\r /* Tell worker thread to exit NOW */\r giveup = true;\r throw ModuleException("m_mysql: Unable to publish feature 'SQL'");\r }\r\r ServerInstance->PublishInterface("SQL", this);\r }\r\r virtual ~ModuleSQL()\r {\r giveup = true;\r ClearAllConnections();\r DELETE(Conf);\r ServerInstance->UnpublishInterface("SQL", this);\r ServerInstance->UnpublishFeature("SQL");\r ServerInstance->DoneWithInterface("SQLutils");\r }\r\r\r void Implements(char* List)\r {\r List[I_OnRehash] = List[I_OnRequest] = 1;\r }\r\r unsigned long NewID()\r {\r if (currid+1 == 0)\r currid++;\r return ++currid;\r }\r\r char* OnRequest(Request* request)\r {\r if(strcmp(SQLREQID, request->GetId()) == 0)\r {\r SQLrequest* req = (SQLrequest*)request;\r\r /* XXX: Lock */\r pthread_mutex_lock(&queue_mutex);\r\r ConnMap::iterator iter;\r\r char* returnval = NULL;\r\r if((iter = Connections.find(req->dbid)) != Connections.end())\r {\r req->id = NewID();\r iter->second->queue.push(*req);\r returnval = SQLSUCCESS;\r }\r else\r {\r req->error.Id(BAD_DBID);\r }\r\r pthread_mutex_unlock(&queue_mutex);\r /* XXX: Unlock */\r\r return returnval;\r }\r\r return NULL;\r }\r\r virtual void OnRehash(userrec* user, const std::string ¶meter)\r {\r rehashing = true;\r }\r \r virtual Version GetVersion()\r {\r return Version(1,1,0,0,VF_VENDOR|VF_SERVICEPROVIDER,API_VERSION);\r }\r \r};\r\rvoid* DispatcherThread(void* arg)\r{\r ModuleSQL* thismodule = (ModuleSQL*)arg;\r LoadDatabases(thismodule->Conf, thismodule->PublicServerInstance);\r\r /* Connect back to the Notifier */\r\r if ((QueueFD = socket(AF_FAMILY, SOCK_STREAM, 0)) == -1)\r {\r /* crap, we're out of sockets... */\r return NULL;\r }\r\r insp_sockaddr addr;\r\r#ifdef IPV6\r insp_aton("::1", &addr.sin6_addr);\r addr.sin6_family = AF_FAMILY;\r addr.sin6_port = htons(MessagePipe->GetPort());\r#else\r insp_inaddr ia;\r insp_aton("127.0.0.1", &ia);\r addr.sin_family = AF_FAMILY;\r addr.sin_addr = ia;\r addr.sin_port = htons(MessagePipe->GetPort());\r#endif\r\r if (connect(QueueFD, (sockaddr*)&addr,sizeof(addr)) == -1)\r {\r /* wtf, we cant connect to it, but we just created it! */\r return NULL;\r }\r\r while (!giveup)\r {\r if (thismodule->rehashing)\r {\r /* XXX: Lock */\r pthread_mutex_lock(&queue_mutex);\r thismodule->rehashing = false;\r LoadDatabases(thismodule->Conf, thismodule->PublicServerInstance);\r pthread_mutex_unlock(&queue_mutex);\r /* XXX: Unlock */\r }\r\r SQLConnection* conn = NULL;\r /* XXX: Lock here for safety */\r pthread_mutex_lock(&queue_mutex);\r for (ConnMap::iterator i = Connections.begin(); i != Connections.end(); i++)\r {\r if (i->second->queue.totalsize())\r {\r conn = i->second;\r break;\r }\r }\r pthread_mutex_unlock(&queue_mutex);\r /* XXX: Unlock */\r\r /* Theres an item! */\r if (conn)\r {\r conn->DoLeadingQuery();\r\r /* XXX: Lock */\r pthread_mutex_lock(&queue_mutex);\r conn->queue.pop();\r pthread_mutex_unlock(&queue_mutex);\r /* XXX: Unlock */\r }\r\r usleep(50);\r }\r\r return NULL;\r}\r\rMODULE_INIT(ModuleSQL);\r\r
\ No newline at end of file
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
+ *
+ * Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
+ * Copyright (C) 2006-2007, 2009 Dennis Friis <peavey@inspircd.org>
+ * Copyright (C) 2006-2009 Craig Edwards <craigedwards@brainbox.cc>
+ * Copyright (C) 2008 Robin Burchell <robin+git@viroteck.net>
+ *
+ * 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/>.
+ */
+
+
+/* Stop mysql wanting to use long long */
+#define NO_CLIENT_LONG_LONG
+
+#include "inspircd.h"
+#include <mysql.h>
+#include "sql.h"
+
+#ifdef _WIN32
+# pragma comment(lib, "mysqlclient.lib")
+# pragma comment(lib, "advapi32.lib")
+# pragma comment(linker, "/NODEFAULTLIB:LIBCMT")
+#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
+ * that instead, you should thread your program. This is what i've done here to allow for
+ * asyncronous SQL requests via mysql. The way this works is as follows:
+ *
+ * The module spawns a thread via class Thread, and performs its mysql queries in this thread,
+ * using a queue with priorities. There is a mutex on either end which prevents two threads
+ * adjusting the queue at the same time, and crashing the ircd. Every 50 milliseconds, the
+ * worker thread wakes up, and checks if there is a request at the head of its queue.
+ * If there is, it processes this request, blocking the worker thread but leaving the ircd
+ * thread to go about its business as usual. During this period, the ircd thread is able
+ * to insert futher pending requests into the queue.
+ *
+ * Once the processing of a request is complete, it is removed from the incoming queue to
+ * an outgoing queue, and initialized as a 'response'. The worker thread then signals the
+ * ircd thread (via a loopback socket) of the fact a result is available, by sending the
+ * connection ID through the connection.
+ *
+ * The ircd thread then mutexes the queue once more, reads the outbound response off the head
+ * of the queue, and sends it on its way to the original calling module.
+ *
+ * XXX: You might be asking "why doesnt he just send the response from within the worker thread?"
+ * The answer to this is simple. The majority of InspIRCd, and in fact most ircd's are not
+ * threadsafe. This module is designed to be threadsafe and is careful with its use of threads,
+ * however, if we were to call a module's OnRequest even from within a thread which was not the
+ * one the module was originally instantiated upon, there is a chance of all hell breaking loose
+ * 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;
+class MySQLresult;
+class DispatcherThread;
+
+struct QQueueItem
+{
+ SQLQuery* q;
+ std::string query;
+ SQLConnection* c;
+ QQueueItem(SQLQuery* Q, const std::string& S, SQLConnection* C) : q(Q), query(S), c(C) {}
+};
+
+struct RQueueItem
+{
+ SQLQuery* q;
+ MySQLresult* r;
+ RQueueItem(SQLQuery* Q, MySQLresult* R) : q(Q), r(R) {}
+};
+
+typedef std::map<std::string, SQLConnection*> ConnMap;
+typedef std::deque<QQueueItem> QueryQueue;
+typedef std::deque<RQueueItem> ResultQueue;
+
+/** MySQL module
+ * */
+class ModuleSQL : public Module
+{
+ public:
+ DispatcherThread* Dispatcher;
+ QueryQueue qq; // MUST HOLD MUTEX
+ ResultQueue rq; // MUST HOLD MUTEX
+ ConnMap connections; // main thread only
+
+ ModuleSQL();
+ void init();
+ ~ModuleSQL();
+ void OnRehash(User* user);
+ void OnUnloadModule(Module* mod);
+ Version GetVersion();
+};
+
+class DispatcherThread : public SocketThread
+{
+ private:
+ ModuleSQL* const Parent;
+ public:
+ DispatcherThread(ModuleSQL* CreatorModule) : Parent(CreatorModule) { }
+ ~DispatcherThread() { }
+ virtual void Run();
+ virtual void OnNotify();
+};
+
+#if !defined(MYSQL_VERSION_ID) || MYSQL_VERSION_ID<32224
+#define mysql_field_count mysql_num_fields
+#endif
+
+/** Represents a mysql result set
+ */
+class MySQLresult : public SQLResult
+{
+ public:
+ SQLerror err;
+ int currentrow;
+ int rows;
+ std::vector<std::string> colnames;
+ std::vector<SQLEntries> fieldlists;
+
+ MySQLresult(MYSQL_RES* res, int affected_rows) : err(SQL_NO_ERROR), currentrow(0), rows(0)
+ {
+ if (affected_rows >= 1)
+ {
+ rows = affected_rows;
+ fieldlists.resize(rows);
+ }
+ unsigned int field_count = 0;
+ if (res)
+ {
+ MYSQL_ROW row;
+ int n = 0;
+ while ((row = mysql_fetch_row(res)))
+ {
+ if (fieldlists.size() < (unsigned int)rows+1)
+ {
+ fieldlists.resize(fieldlists.size()+1);
+ }
+ field_count = 0;
+ MYSQL_FIELD *fields = mysql_fetch_fields(res);
+ if(mysql_num_fields(res) == 0)
+ break;
+ if (fields && mysql_num_fields(res))
+ {
+ colnames.clear();
+ while (field_count < mysql_num_fields(res))
+ {
+ std::string a = (fields[field_count].name ? fields[field_count].name : "");
+ if (row[field_count])
+ fieldlists[n].push_back(SQLEntry(row[field_count]));
+ else
+ fieldlists[n].push_back(SQLEntry());
+ colnames.push_back(a);
+ field_count++;
+ }
+ n++;
+ }
+ rows++;
+ }
+ mysql_free_result(res);
+ }
+ }
+
+ MySQLresult(SQLerror& e) : err(e)
+ {
+
+ }
+
+ ~MySQLresult()
+ {
+ }
+
+ virtual int Rows()
+ {
+ return rows;
+ }
+
+ virtual void GetCols(std::vector<std::string>& result)
+ {
+ result.assign(colnames.begin(), colnames.end());
+ }
+
+ virtual SQLEntry GetValue(int row, int column)
+ {
+ if ((row >= 0) && (row < rows) && (column >= 0) && (column < (int)fieldlists[row].size()))
+ {
+ return fieldlists[row][column];
+ }
+ return SQLEntry();
+ }
+
+ virtual bool GetRow(SQLEntries& result)
+ {
+ if (currentrow < rows)
+ {
+ result.assign(fieldlists[currentrow].begin(), fieldlists[currentrow].end());
+ currentrow++;
+ return true;
+ }
+ else
+ {
+ result.clear();
+ return false;
+ }
+ }
+};
+
+/** Represents a connection to a mysql database
+ */
+class SQLConnection : public SQLProvider
+{
+ public:
+ reference<ConfigTag> config;
+ MYSQL *connection;
+ 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")),
+ config(tag), connection(NULL)
+ {
+ }
+
+ ~SQLConnection()
+ {
+ Close();
+ }
+
+ // This method connects to the database using the credentials supplied to the constructor, and returns
+ // true upon success.
+ bool Connect()
+ {
+ unsigned int timeout = 1;
+ connection = mysql_init(connection);
+ mysql_options(connection,MYSQL_OPT_CONNECT_TIMEOUT,(char*)&timeout);
+ std::string host = config->getString("host");
+ std::string user = config->getString("user");
+ std::string pass = config->getString("pass");
+ std::string dbname = config->getString("name");
+ int port = config->getInt("port");
+ 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;
+ std::string initquery;
+ if (config->readString("initialquery", initquery))
+ {
+ mysql_query(connection,initquery.c_str());
+ }
+ return true;
+ }
+
+ ModuleSQL* Parent()
+ {
+ return (ModuleSQL*)(Module*)creator;
+ }
+
+ MySQLresult* DoBlockingQuery(const std::string& query)
+ {
+
+ /* Parse the command string and dispatch it to mysql */
+ if (CheckConnection() && !mysql_real_query(connection, query.data(), query.length()))
+ {
+ /* Successfull query */
+ MYSQL_RES* res = mysql_use_result(connection);
+ unsigned long rows = mysql_affected_rows(connection);
+ return new MySQLresult(res, rows);
+ }
+ else
+ {
+ /* 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)) + ": " + mysql_error(connection));
+ return new MySQLresult(e);
+ }
+ }
+
+ bool CheckConnection()
+ {
+ if (!connection || mysql_ping(connection) != 0)
+ return Connect();
+ return true;
+ }
+
+ std::string GetError()
+ {
+ return mysql_error(connection);
+ }
+
+ void Close()
+ {
+ mysql_close(connection);
+ }
+
+ void submit(SQLQuery* q, const std::string& qs)
+ {
+ 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)
+ {
+ std::string res;
+ unsigned int param = 0;
+ for(std::string::size_type i = 0; i < q.length(); i++)
+ {
+ if (q[i] != '?')
+ res.push_back(q[i]);
+ else
+ {
+ if (param < p.size())
+ {
+ std::string parm = p[param++];
+ // 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_escape_string() is the length of the encoded string,
+ // not including the terminating null
+ unsigned long escapedsize = mysql_escape_string(&buffer[0], parm.c_str(), parm.length());
+// mysql_real_escape_string(connection, queryend, paramscopy[paramnum].c_str(), paramscopy[paramnum].length());
+ res.append(&buffer[0], escapedsize);
+ }
+ }
+ }
+ submit(call, res);
+ }
+
+ void submit(SQLQuery* call, const std::string& q, const ParamM& p)
+ {
+ std::string res;
+ for(std::string::size_type i = 0; i < q.length(); i++)
+ {
+ 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--;
+
+ ParamM::const_iterator it = p.find(field);
+ if (it != p.end())
+ {
+ std::string parm = it->second;
+ // 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);
+ }
+};
+
+ModuleSQL::ModuleSQL()
+{
+ Dispatcher = NULL;
+}
+
+void ModuleSQL::init()
+{
+ Dispatcher = new DispatcherThread(this);
+ ServerInstance->Threads->Start(Dispatcher);
+
+ Implementation eventlist[] = { I_OnRehash, I_OnUnloadModule };
+ ServerInstance->Modules->Attach(eventlist, this, sizeof(eventlist)/sizeof(Implementation));
+
+ OnRehash(NULL);
+}
+
+ModuleSQL::~ModuleSQL()
+{
+ if (Dispatcher)
+ {
+ Dispatcher->join();
+ Dispatcher->OnNotify();
+ delete Dispatcher;
+ }
+ for(ConnMap::iterator i = connections.begin(); i != connections.end(); i++)
+ {
+ delete i->second;
+ }
+}
+
+void ModuleSQL::OnRehash(User* user)
+{
+ ConnMap conns;
+ ConfigTagList tags = ServerInstance->Config->ConfTags("database");
+ for(ConfigIter i = tags.first; i != tags.second; i++)
+ {
+ if (i->second->getString("module", "mysql") != "mysql")
+ continue;
+ std::string id = i->second->getString("id");
+ ConnMap::iterator curr = connections.find(id);
+ if (curr == connections.end())
+ {
+ SQLConnection* conn = new SQLConnection(this, i->second);
+ conns.insert(std::make_pair(id, conn));
+ ServerInstance->Modules->AddService(*conn);
+ }
+ else
+ {
+ conns.insert(*curr);
+ connections.erase(curr);
+ }
+ }
+
+ // now clean up the deleted databases
+ Dispatcher->LockQueue();
+ SQLerror err(SQL_BAD_DBID);
+ for(ConnMap::iterator i = connections.begin(); i != connections.end(); i++)
+ {
+ ServerInstance->Modules->DelService(*i->second);
+ // it might be running a query on this database. Wait for that to complete
+ i->second->lock.Lock();
+ i->second->lock.Unlock();
+ // now remove all active queries to this DB
+ for (size_t j = qq.size(); j > 0; j--)
+ {
+ size_t k = j - 1;
+ if (qq[k].c == i->second)
+ {
+ qq[k].q->OnError(err);
+ delete qq[k].q;
+ qq.erase(qq.begin() + k);
+ }
+ }
+ // finally, nuke the connection
+ delete i->second;
+ }
+ Dispatcher->UnlockQueue();
+ connections.swap(conns);
+}
+
+void ModuleSQL::OnUnloadModule(Module* mod)
+{
+ SQLerror err(SQL_BAD_DBID);
+ Dispatcher->LockQueue();
+ unsigned int i = qq.size();
+ while (i > 0)
+ {
+ i--;
+ if (qq[i].q->creator == mod)
+ {
+ if (i == 0)
+ {
+ // need to wait until the query is done
+ // (the result will be discarded)
+ qq[i].c->lock.Lock();
+ qq[i].c->lock.Unlock();
+ }
+ qq[i].q->OnError(err);
+ delete qq[i].q;
+ qq.erase(qq.begin() + i);
+ }
+ }
+ Dispatcher->UnlockQueue();
+ // clean up any result queue entries
+ Dispatcher->OnNotify();
+}
+
+Version ModuleSQL::GetVersion()
+{
+ return Version("MySQL support", VF_VENDOR);
+}
+
+void DispatcherThread::Run()
+{
+ this->LockQueue();
+ while (!this->GetExitFlag())
+ {
+ if (!Parent->qq.empty())
+ {
+ QQueueItem i = Parent->qq.front();
+ i.c->lock.Lock();
+ this->UnlockQueue();
+ MySQLresult* res = i.c->DoBlockingQuery(i.query);
+ i.c->lock.Unlock();
+
+ /*
+ * At this point, the main thread could be working on:
+ * Rehash - delete i.c out from under us. We don't care about that.
+ * UnloadModule - delete i.q and the qq item. Need to avoid reporting results.
+ */
+
+ this->LockQueue();
+ if (!Parent->qq.empty() && Parent->qq.front().q == i.q)
+ {
+ Parent->qq.pop_front();
+ Parent->rq.push_back(RQueueItem(i.q, res));
+ NotifyParent();
+ }
+ else
+ {
+ // UnloadModule ate the query
+ delete res;
+ }
+ }
+ else
+ {
+ /* We know the queue is empty, we can safely hang this thread until
+ * something happens
+ */
+ this->WaitForQueue();
+ }
+ }
+ this->UnlockQueue();
+}
+
+void DispatcherThread::OnNotify()
+{
+ // this could unlock during the dispatch, but OnResult isn't expected to take that long
+ this->LockQueue();
+ for(ResultQueue::iterator i = Parent->rq.begin(); i != Parent->rq.end(); i++)
+ {
+ MySQLresult* res = i->r;
+ if (res->err.id == SQL_NO_ERROR)
+ i->q->OnResult(*res);
+ else
+ i->q->OnError(res->err);
+ delete i->q;
+ delete i->r;
+ }
+ Parent->rq.clear();
+ this->UnlockQueue();
+}
+
+MODULE_INIT(ModuleSQL)