1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2009 InspIRCd Development Team
6 * See: http://wiki.inspircd.org/Credits
8 * This program is free but copyrighted software; see
9 * the file COPYING for details.
11 * ---------------------------------------------------
14 /* Stop mysql wanting to use long long */
15 #define NO_CLIENT_LONG_LONG
22 #pragma comment(lib, "mysqlclient.lib")
25 /* VERSION 2 API: With nonblocking (threaded) requests */
27 /* $ModDesc: SQL Service Provider module for all other m_sql* modules */
28 /* $CompileFlags: exec("mysql_config --include") */
29 /* $LinkerFlags: exec("mysql_config --libs_r") rpath("mysql_config --libs_r") */
30 /* $ModDep: m_sqlv2.h */
32 /* THE NONBLOCKING MYSQL API!
34 * MySQL provides no nonblocking (asyncronous) API of its own, and its developers recommend
35 * that instead, you should thread your program. This is what i've done here to allow for
36 * asyncronous SQL requests via mysql. The way this works is as follows:
38 * The module spawns a thread via class Thread, and performs its mysql queries in this thread,
39 * using a queue with priorities. There is a mutex on either end which prevents two threads
40 * adjusting the queue at the same time, and crashing the ircd. Every 50 milliseconds, the
41 * worker thread wakes up, and checks if there is a request at the head of its queue.
42 * If there is, it processes this request, blocking the worker thread but leaving the ircd
43 * thread to go about its business as usual. During this period, the ircd thread is able
44 * to insert futher pending requests into the queue.
46 * Once the processing of a request is complete, it is removed from the incoming queue to
47 * an outgoing queue, and initialized as a 'response'. The worker thread then signals the
48 * ircd thread (via a loopback socket) of the fact a result is available, by sending the
49 * connection ID through the connection.
51 * The ircd thread then mutexes the queue once more, reads the outbound response off the head
52 * of the queue, and sends it on its way to the original calling module.
54 * XXX: You might be asking "why doesnt he just send the response from within the worker thread?"
55 * The answer to this is simple. The majority of InspIRCd, and in fact most ircd's are not
56 * threadsafe. This module is designed to be threadsafe and is careful with its use of threads,
57 * however, if we were to call a module's OnRequest even from within a thread which was not the
58 * one the module was originally instantiated upon, there is a chance of all hell breaking loose
59 * if a module is ever put in a re-enterant state (stack corruption could occur, crashes, data
60 * corruption, and worse, so DONT think about it until the day comes when InspIRCd is 100%
61 * gauranteed threadsafe!)
63 * For a diagram of this system please see http://wiki.inspircd.org/Mysql2
68 class DispatcherThread;
70 typedef std::map<std::string, SQLConnection*> ConnMap;
71 typedef std::deque<SQLresult*> ResultQueue;
73 unsigned long count(const char * const str, char a)
76 for (const char *p = reinterpret_cast<const char *>(str); *p; ++p)
87 class ModuleSQL : public Module
92 InspIRCd* PublicServerInstance;
95 DispatcherThread* Dispatcher;
100 ModuleSQL(InspIRCd* Me);
102 unsigned long NewID();
103 const char* OnRequest(Request* request);
104 void OnRehash(User* user);
105 Version GetVersion();
109 #if !defined(MYSQL_VERSION_ID) || MYSQL_VERSION_ID<32224
110 #define mysql_field_count mysql_num_fields
113 /** Represents a mysql result set
115 class MySQLresult : public SQLresult
118 std::vector<std::string> colnames;
119 std::vector<SQLfieldList> fieldlists;
120 SQLfieldMap* fieldmap;
121 SQLfieldMap fieldmap2;
122 SQLfieldList emptyfieldlist;
126 MySQLresult(Module* self, Module* to, MYSQL_RES* res, int affected_rows, unsigned int rid) : SQLresult(self, to, rid), currentrow(0), fieldmap(NULL)
128 /* A number of affected rows from from mysql_affected_rows.
132 if (affected_rows >= 1)
134 rows = affected_rows;
135 fieldlists.resize(rows);
137 unsigned int field_count = 0;
142 while ((row = mysql_fetch_row(res)))
144 if (fieldlists.size() < (unsigned int)rows+1)
146 fieldlists.resize(fieldlists.size()+1);
149 MYSQL_FIELD *fields = mysql_fetch_fields(res);
150 if(mysql_num_fields(res) == 0)
152 if (fields && mysql_num_fields(res))
155 while (field_count < mysql_num_fields(res))
157 std::string a = (fields[field_count].name ? fields[field_count].name : "");
158 std::string b = (row[field_count] ? row[field_count] : "");
159 SQLfield sqlf(b, !row[field_count]);
160 colnames.push_back(a);
161 fieldlists[n].push_back(sqlf);
168 mysql_free_result(res);
173 MySQLresult(Module* self, Module* to, SQLerror e, unsigned int rid) : SQLresult(self, to, rid), currentrow(0)
190 return colnames.size();
193 virtual std::string ColName(int column)
195 if (column < (int)colnames.size())
197 return colnames[column];
201 throw SQLbadColName();
206 virtual int ColNum(const std::string &column)
208 for (unsigned int i = 0; i < colnames.size(); i++)
210 if (column == colnames[i])
213 throw SQLbadColName();
217 virtual SQLfield GetValue(int row, int column)
219 if ((row >= 0) && (row < rows) && (column >= 0) && (column < Cols()))
221 return fieldlists[row][column];
224 throw SQLbadColName();
226 /* XXX: We never actually get here because of the throw */
227 return SQLfield("",true);
230 virtual SQLfieldList& GetRow()
232 if (currentrow < rows)
233 return fieldlists[currentrow++];
235 return emptyfieldlist;
238 virtual SQLfieldMap& GetRowMap()
242 if (currentrow < rows)
244 for (int i = 0; i < Cols(); i++)
246 fieldmap2.insert(std::make_pair(colnames[i],GetValue(currentrow, i)));
254 virtual SQLfieldList* GetRowPtr()
256 SQLfieldList* fieldlist = new SQLfieldList();
258 if (currentrow < rows)
260 for (int i = 0; i < Rows(); i++)
262 fieldlist->push_back(fieldlists[currentrow][i]);
269 virtual SQLfieldMap* GetRowMapPtr()
271 fieldmap = new SQLfieldMap();
273 if (currentrow < rows)
275 for (int i = 0; i < Cols(); i++)
277 fieldmap->insert(std::make_pair(colnames[i],GetValue(currentrow, i)));
285 virtual void Free(SQLfieldMap* fm)
290 virtual void Free(SQLfieldList* fl)
296 /** Represents a connection to a mysql database
298 class SQLConnection : public classbase
305 std::map<std::string,std::string> thisrow;
314 // This constructor creates an SQLConnection object with the given credentials, but does not connect yet.
315 SQLConnection(const SQLhost &hi, ModuleSQL* Creator) : connection(NULL), host(hi), Enabled(false), Parent(Creator)
324 // This method connects to the database using the credentials supplied to the constructor, and returns
325 // true upon success.
328 unsigned int timeout = 1;
329 connection = mysql_init(connection);
330 mysql_options(connection,MYSQL_OPT_CONNECT_TIMEOUT,(char*)&timeout);
331 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);
334 void DoLeadingQuery()
336 if (!CheckConnection())
339 /* Parse the command string and dispatch it to mysql */
340 SQLrequest& req = queue.front();
342 /* Pointer to the buffer we screw around with substitution in */
345 /* Pointer to the current end of query, where we append new stuff */
348 /* Total length of the unescaped parameters */
349 unsigned long maxparamlen, paramcount;
351 /* The length of the longest parameter */
354 for(ParamL::iterator i = req.query.p.begin(); i != req.query.p.end(); i++)
356 if (i->size() > maxparamlen)
357 maxparamlen = i->size();
360 /* How many params are there in the query? */
361 paramcount = count(req.query.q.c_str(), '?');
363 /* This stores copy of params to be inserted with using numbered params 1;3B*/
364 ParamL paramscopy(req.query.p);
366 /* To avoid a lot of allocations, allocate enough memory for the biggest the escaped query could possibly be.
367 * sizeofquery + (maxtotalparamlength*2) + 1
369 * The +1 is for null-terminating the string for mysql_real_escape_string
372 query = new char[req.query.q.length() + (maxparamlen*paramcount*2) + 1];
375 /* Okay, now we have a buffer large enough we need to start copying the query into it and escaping and substituting
376 * the parameters into it...
379 for(unsigned long i = 0; i < req.query.q.length(); i++)
381 if(req.query.q[i] == '?')
383 /* We found a place to substitute..what fun.
384 * use mysql calls to escape and write the
385 * escaped string onto the end of our query buffer,
386 * then we "just" need to make sure queryend is
387 * pointing at the right place.
390 /* Is it numbered parameter?
396 /* Numbered parameter number :|
398 unsigned int paramnum;
401 /* Let's check if it's a numbered param. And also calculate it's number.
404 while ((i < req.query.q.length() - 1) && (req.query.q[i+1] >= '0') && (req.query.q[i+1] <= '9'))
408 paramnum = paramnum * 10 + req.query.q[i] - '0';
411 if (paramnum > paramscopy.size() - 1)
413 /* index is out of range!
420 unsigned long len = mysql_real_escape_string(connection, queryend, paramscopy[paramnum].c_str(), paramscopy[paramnum].length());
424 else if (req.query.p.size())
426 unsigned long len = mysql_real_escape_string(connection, queryend, req.query.p.front().c_str(), req.query.p.front().length());
429 req.query.p.pop_front();
436 *queryend = req.query.q[i];
445 if (!mysql_real_query(connection, req.query.q.data(), req.query.q.length()))
447 /* Successfull query */
448 res = mysql_use_result(connection);
449 unsigned long rows = mysql_affected_rows(connection);
450 MySQLresult* r = new MySQLresult(Parent, req.GetSource(), res, rows, req.id);
451 r->dbid = this->GetID();
452 r->query = req.query.q;
453 /* Put this new result onto the results queue.
454 * XXX: Remember to mutex the queue!
456 Parent->ResultsMutex.Lock();
458 Parent->ResultsMutex.Unlock();
462 /* XXX: See /usr/include/mysql/mysqld_error.h for a list of
463 * possible error numbers and error messages */
464 SQLerror e(SQL_QREPLY_FAIL, ConvToStr(mysql_errno(connection)) + std::string(": ") + mysql_error(connection));
465 MySQLresult* r = new MySQLresult(Parent, req.GetSource(), e, req.id);
466 r->dbid = this->GetID();
467 r->query = req.query.q;
469 Parent->ResultsMutex.Lock();
471 Parent->ResultsMutex.Unlock();
477 bool ConnectionLost()
481 return (mysql_ping(connection) != 0);
486 bool CheckConnection()
488 if (ConnectionLost())
495 std::string GetError()
497 return mysql_error(connection);
500 const std::string& GetID()
505 std::string GetHost()
510 void SetEnable(bool Enable)
522 mysql_close(connection);
525 const SQLhost& GetConfHost()
534 bool HasHost(const SQLhost &host)
536 for (ConnMap::iterator iter = Connections.begin(); iter != Connections.end(); iter++)
538 if (host == iter->second->GetConfHost())
544 bool HostInConf(ConfigReader* conf, const SQLhost &h)
546 for(int i = 0; i < conf->Enumerate("database"); i++)
549 host.id = conf->ReadValue("database", "id", i);
550 host.host = conf->ReadValue("database", "hostname", i);
551 host.port = conf->ReadInteger("database", "port", i, true);
552 host.name = conf->ReadValue("database", "name", i);
553 host.user = conf->ReadValue("database", "username", i);
554 host.pass = conf->ReadValue("database", "password", i);
555 host.ssl = conf->ReadFlag("database", "ssl", i);
562 void ClearOldConnections(ConfigReader* conf)
564 ConnMap::iterator i,safei;
565 for (i = Connections.begin(); i != Connections.end(); i++)
567 if (!HostInConf(conf, i->second->GetConfHost()))
572 Connections.erase(safei);
577 void ClearAllConnections()
580 while ((i = Connections.begin()) != Connections.end())
582 Connections.erase(i);
587 void ConnectDatabases(InspIRCd* ServerInstance, ModuleSQL* Parent)
589 for (ConnMap::iterator i = Connections.begin(); i != Connections.end(); i++)
591 if (i->second->IsEnabled())
594 i->second->SetEnable(true);
595 if (!i->second->Connect())
598 Parent->LoggingMutex.Lock();
599 ServerInstance->Logs->Log("m_mysql",DEFAULT,"SQL: Failed to connect database "+i->second->GetHost()+": Error: "+i->second->GetError());
600 i->second->SetEnable(false);
601 Parent->LoggingMutex.Unlock();
606 void LoadDatabases(ConfigReader* conf, InspIRCd* ServerInstance, ModuleSQL* Parent)
608 Parent->ConnMutex.Lock();
609 ClearOldConnections(conf);
610 for (int j =0; j < conf->Enumerate("database"); j++)
613 host.id = conf->ReadValue("database", "id", j);
614 host.host = conf->ReadValue("database", "hostname", j);
615 host.port = conf->ReadInteger("database", "port", j, true);
616 host.name = conf->ReadValue("database", "name", j);
617 host.user = conf->ReadValue("database", "username", j);
618 host.pass = conf->ReadValue("database", "password", j);
619 host.ssl = conf->ReadFlag("database", "ssl", j);
624 if (!host.id.empty() && !host.host.empty() && !host.name.empty() && !host.user.empty() && !host.pass.empty())
626 SQLConnection* ThisSQL = new SQLConnection(host, Parent);
627 Connections[host.id] = ThisSQL;
630 ConnectDatabases(ServerInstance, Parent);
631 Parent->ConnMutex.Unlock();
634 char FindCharId(const std::string &id)
637 for (ConnMap::iterator iter = Connections.begin(); iter != Connections.end(); ++iter, ++i)
639 if (iter->first == id)
647 ConnMap::iterator GetCharId(char id)
650 for (ConnMap::iterator iter = Connections.begin(); iter != Connections.end(); ++iter, ++i)
655 return Connections.end();
660 class DispatcherThread : public SocketThread
664 InspIRCd* ServerInstance;
666 DispatcherThread(InspIRCd* Instance, ModuleSQL* CreatorModule) : SocketThread(Instance), Parent(CreatorModule), ServerInstance(Instance) { }
667 ~DispatcherThread() { }
669 virtual void OnNotify();
672 ModuleSQL::ModuleSQL(InspIRCd* Me) : Module(Me), rehashing(false)
674 ServerInstance->Modules->UseInterface("SQLutils");
676 Conf = new ConfigReader(ServerInstance);
677 PublicServerInstance = ServerInstance;
680 Dispatcher = new DispatcherThread(ServerInstance, this);
681 ServerInstance->Threads->Start(Dispatcher);
683 if (!ServerInstance->Modules->PublishFeature("SQL", this))
685 /* Tell worker thread to exit NOW,
686 * Automatically joins */
688 ServerInstance->Modules->DoneWithInterface("SQLutils");
689 throw ModuleException("m_mysql: Unable to publish feature 'SQL'");
692 ServerInstance->Modules->PublishInterface("SQL", this);
693 Implementation eventlist[] = { I_OnRehash, I_OnRequest };
694 ServerInstance->Modules->Attach(eventlist, this, 2);
697 ModuleSQL::~ModuleSQL()
700 ClearAllConnections();
702 ServerInstance->Modules->UnpublishInterface("SQL", this);
703 ServerInstance->Modules->UnpublishFeature("SQL");
704 ServerInstance->Modules->DoneWithInterface("SQLutils");
707 unsigned long ModuleSQL::NewID()
714 const char* ModuleSQL::OnRequest(Request* request)
716 if(strcmp(SQLREQID, request->GetId()) == 0)
718 SQLrequest* req = (SQLrequest*)request;
720 ConnMap::iterator iter;
722 const char* returnval = NULL;
724 Dispatcher->LockQueue();
726 if((iter = Connections.find(req->dbid)) != Connections.end())
729 iter->second->queue.push(*req);
730 returnval = SQLSUCCESS;
734 req->error.Id(SQL_BAD_DBID);
738 Dispatcher->UnlockQueueWakeup();
739 /* Yes, it's possible this will generate a spurious wakeup.
740 * That's fine, it'll just get ignored.
749 void ModuleSQL::OnRehash(User* user)
751 Dispatcher->LockQueue();
753 Dispatcher->UnlockQueueWakeup();
756 Version ModuleSQL::GetVersion()
758 return Version("$Id$", VF_VENDOR | VF_SERVICEPROVIDER, API_VERSION);
761 void DispatcherThread::Run()
763 LoadDatabases(Parent->Conf, Parent->PublicServerInstance, Parent);
765 SQLConnection* conn = NULL;
768 while (!this->GetExitFlag())
770 if (Parent->rehashing)
772 Parent->rehashing = false;
773 LoadDatabases(Parent->Conf, Parent->PublicServerInstance, Parent);
777 Parent->ConnMutex.Lock();
778 for (ConnMap::iterator i = Connections.begin(); i != Connections.end(); i++)
780 if (i->second->queue.totalsize())
786 Parent->ConnMutex.Unlock();
790 /* There's an item! */
792 conn->DoLeadingQuery();
793 this->NotifyParent();
799 /* We know the queue is empty, we can safely hang this thread until
802 this->WaitForQueue();
808 void DispatcherThread::OnNotify()
814 Parent->ConnMutex.Lock();
815 for (ConnMap::iterator iter = Connections.begin(); iter != Connections.end(); iter++)
817 if (!iter->second->rq.empty())
823 Parent->ConnMutex.Unlock();
828 Parent->ResultsMutex.Lock();
829 ResultQueue::iterator n = conn->rq.begin();
830 Parent->ResultsMutex.Unlock();
835 Parent->ResultsMutex.Lock();
836 conn->rq.pop_front();
837 Parent->ResultsMutex.Unlock();
841 MODULE_INIT(ModuleSQL)