1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd is copyright (C) 2002-2004 ChatSpike-Dev.
7 * <brain@chatspike.net>
8 * <Craig@chatspike.net>
10 * Written by Craig Edwards, Craig McLure, and others.
11 * This program is free but copyrighted software; see
12 * the file COPYING for details.
14 * ---------------------------------------------------
26 #include "helperfuncs.h"
29 /* VERSION 2 API: With nonblocking (threaded) requests */
31 /* $ModDesc: SQL Service Provider module for all other m_sql* modules */
32 /* $CompileFlags: `mysql_config --include` */
33 /* $LinkerFlags: `mysql_config --libs_r` `perl ../mysql_rpath.pl` */
39 extern InspIRCd* ServerInstance;
40 typedef std::map<std::string, SQLConnection*> ConnMap;
42 static Module* SQLModule = NULL;
43 static Notifier* MessagePipe = NULL;
47 #if !defined(MYSQL_VERSION_ID) || MYSQL_VERSION_ID<32224
48 #define mysql_field_count mysql_num_fields
51 typedef std::deque<SQLresult*> ResultQueue;
53 class QueryQueue : public classbase
56 typedef std::deque<SQLrequest> ReqDeque;
58 ReqDeque priority; /* The priority queue */
59 ReqDeque normal; /* The 'normal' queue */
60 enum { PRI, NOR, NON } which; /* Which queue the currently active element is at the front of */
68 void push(const SQLrequest &q)
70 log(DEBUG, "QueryQueue::push(): Adding %s query to queue: %s", ((q.pri) ? "priority" : "non-priority"), q.query.q.c_str());
73 priority.push_back(q);
80 if((which == PRI) && priority.size())
84 else if((which == NOR) && normal.size())
92 /* Silently do nothing if there was no element to pop() */
100 return priority.front();
102 return normal.front();
107 return priority.front();
113 return normal.front();
116 /* This will probably result in a segfault,
117 * but the caller should have checked totalsize()
118 * first so..meh - moron :p
121 return priority.front();
125 std::pair<int, int> size()
127 return std::make_pair(priority.size(), normal.size());
132 return priority.size() + normal.size();
135 void PurgeModule(Module* mod)
137 DoPurgeModule(mod, priority);
138 DoPurgeModule(mod, normal);
142 void DoPurgeModule(Module* mod, ReqDeque& q)
144 for(ReqDeque::iterator iter = q.begin(); iter != q.end(); iter++)
146 if(iter->GetSource() == mod)
148 if(iter->id == front().id)
150 /* It's the currently active query.. :x */
151 iter->SetSource(NULL);
155 /* It hasn't been executed yet..just remove it */
156 iter = q.erase(iter);
163 /* A mutex to wrap around queue accesses */
164 pthread_mutex_t queue_mutex = PTHREAD_MUTEX_INITIALIZER;
166 pthread_mutex_t results_mutex = PTHREAD_MUTEX_INITIALIZER;
168 class MySQLresult : public SQLresult
171 //std::vector<std::map<std::string,std::string> > results;
172 std::vector<std::string> colnames;
173 std::vector<SQLfieldList> fieldlists;
174 SQLfieldMap* fieldmap;
179 MySQLresult(Module* self, Module* to, MYSQL_RES* res, int affected_rows) : SQLresult(self, to), currentrow(0), fieldmap(NULL)
181 /* A number of affected rows from from mysql_affected_rows.
183 log(DEBUG,"Created new MySQLresult of non-error type");
186 if (affected_rows >= 1)
188 rows = affected_rows;
189 fieldlists.resize(rows);
191 unsigned int field_count;
196 while ((row = mysql_fetch_row(res)))
198 if (fieldlists.size() < (unsigned int)rows+1)
200 fieldlists.resize(fieldlists.size()+1);
203 MYSQL_FIELD *fields = mysql_fetch_fields(res);
204 if(mysql_num_fields(res) == 0)
206 if (fields && mysql_num_fields(res))
209 while (field_count < mysql_num_fields(res))
211 std::string a = (fields[field_count].name ? fields[field_count].name : "");
212 std::string b = (row[field_count] ? row[field_count] : "");
213 SQLfield sqlf(b, !row[field_count]);
214 colnames.push_back(a);
215 fieldlists[n].push_back(sqlf);
222 cols = mysql_num_fields(res);
223 mysql_free_result(res);
226 log(DEBUG, "Created new MySQL result; %d rows, %d columns", rows, cols);
229 MySQLresult(Module* self, Module* to, SQLerror e) : SQLresult(self, to), currentrow(0)
234 log(DEBUG,"Created new MySQLresult of error type");
251 virtual std::string ColName(int column)
253 if (column < (int)colnames.size())
255 return colnames[column];
259 throw SQLbadColName();
264 virtual int ColNum(const std::string &column)
266 for (unsigned int i = 0; i < colnames.size(); i++)
268 if (column == colnames[i])
271 throw SQLbadColName();
275 virtual SQLfield GetValue(int row, int column)
277 if ((row >= 0) && (row < rows) && (column >= 0) && (column < cols))
279 return fieldlists[row][column];
282 log(DEBUG,"Danger will robinson, we don't have row %d, column %d!", row, column);
283 throw SQLbadColName();
285 /* XXX: We never actually get here because of the throw */
286 return SQLfield("",true);
289 virtual SQLfieldList& GetRow()
291 return fieldlists[currentrow];
294 virtual SQLfieldMap& GetRowMap()
296 fieldmap = new SQLfieldMap();
298 for (int i = 0; i < cols; i++)
300 fieldmap->insert(std::make_pair(colnames[cols],GetValue(currentrow, i)));
307 virtual SQLfieldList* GetRowPtr()
309 return &fieldlists[currentrow++];
312 virtual SQLfieldMap* GetRowMapPtr()
314 fieldmap = new SQLfieldMap();
316 for (int i = 0; i < cols; i++)
318 fieldmap->insert(std::make_pair(colnames[cols],GetValue(currentrow, i)));
325 virtual void Free(SQLfieldMap* fm)
330 virtual void Free(SQLfieldList* fl)
332 /* XXX: Yes, this is SUPPOSED to do nothing, we
333 * dont want to free our fieldlist until we
334 * destruct the object. Unlike the pgsql module,
335 * we only have the one.
342 void NotifyMainThread(SQLConnection* connection_with_new_result);
344 class SQLConnection : public classbase
355 std::map<std::string,std::string> thisrow;
364 // This constructor creates an SQLConnection object with the given credentials, and creates the underlying
365 // MYSQL struct, but does not connect yet.
366 SQLConnection(std::string thishost, std::string thisuser, std::string thispass, std::string thisdb, const std::string &myid)
368 this->Enabled = true;
369 this->host = thishost;
370 this->user = thisuser;
371 this->pass = thispass;
376 // This method connects to the database using the credentials supplied to the constructor, and returns
377 // true upon success.
380 unsigned int timeout = 1;
381 mysql_init(&connection);
382 mysql_options(&connection,MYSQL_OPT_CONNECT_TIMEOUT,(char*)&timeout);
383 return mysql_real_connect(&connection, host.c_str(), user.c_str(), pass.c_str(), db.c_str(), 0, NULL, 0);
386 void DoLeadingQuery()
388 /* Parse the command string and dispatch it to mysql */
389 SQLrequest& req = queue.front();
390 log(DEBUG,"DO QUERY: %s",req.query.q.c_str());
392 /* Pointer to the buffer we screw around with substitution in */
395 /* Pointer to the current end of query, where we append new stuff */
398 /* Total length of the unescaped parameters */
399 unsigned long paramlen;
401 /* Total length of query, used for binary-safety in mysql_real_query */
402 unsigned long querylength = 0;
406 for(ParamL::iterator i = req.query.p.begin(); i != req.query.p.end(); i++)
408 paramlen += i->size();
411 /* To avoid a lot of allocations, allocate enough memory for the biggest the escaped query could possibly be.
412 * sizeofquery + (totalparamlength*2) + 1
414 * The +1 is for null-terminating the string for mysql_real_escape_string
417 query = new char[req.query.q.length() + (paramlen*2)];
420 /* Okay, now we have a buffer large enough we need to start copying the query into it and escaping and substituting
421 * the parameters into it...
424 for(unsigned long i = 0; i < req.query.q.length(); i++)
426 if(req.query.q[i] == '?')
428 /* We found a place to substitute..what fun.
429 * use mysql calls to escape and write the
430 * escaped string onto the end of our query buffer,
431 * then we "just" need to make sure queryend is
432 * pointing at the right place.
434 if(req.query.p.size())
436 unsigned long len = mysql_real_escape_string(&connection, queryend, req.query.p.front().c_str(), req.query.p.front().length());
439 req.query.p.pop_front();
443 log(DEBUG, "Found a substitution location but no parameter to substitute :|");
449 *queryend = req.query.q[i];
457 log(DEBUG, "Attempting to dispatch query: %s", query);
459 pthread_mutex_lock(&queue_mutex);
461 pthread_mutex_unlock(&queue_mutex);
463 if (!mysql_real_query(&connection, req.query.q.data(), req.query.q.length()))
465 /* Successfull query */
466 res = mysql_use_result(&connection);
467 unsigned long rows = mysql_affected_rows(&connection);
468 MySQLresult* r = new MySQLresult(SQLModule, req.GetSource(), res, rows);
469 r->dbid = this->GetID();
470 r->query = req.query.q;
471 /* Put this new result onto the results queue.
472 * XXX: Remember to mutex the queue!
474 pthread_mutex_lock(&results_mutex);
476 pthread_mutex_unlock(&results_mutex);
480 /* XXX: See /usr/include/mysql/mysqld_error.h for a list of
481 * possible error numbers and error messages */
482 log(DEBUG,"SQL ERROR: %s",mysql_error(&connection));
483 SQLerror e((SQLerrorNum)mysql_errno(&connection), mysql_error(&connection));
484 MySQLresult* r = new MySQLresult(SQLModule, req.GetSource(), e);
485 r->dbid = this->GetID();
486 r->query = req.query.q;
488 pthread_mutex_lock(&results_mutex);
490 pthread_mutex_unlock(&results_mutex);
493 /* Now signal the main thread that we've got a result to process.
494 * Pass them this connection id as what to examine
497 NotifyMainThread(this);
500 bool ConnectionLost()
503 return (mysql_ping(&connection) != 0);
508 bool CheckConnection()
510 if (ConnectionLost()) {
516 std::string GetError()
518 return mysql_error(&connection);
521 const std::string& GetID()
526 std::string GetHost()
531 void SetEnable(bool Enable)
545 void ConnectDatabases(Server* Srv)
547 for (ConnMap::iterator i = Connections.begin(); i != Connections.end(); i++)
549 i->second->SetEnable(true);
550 if (i->second->Connect())
552 Srv->Log(DEFAULT,"SQL: Successfully connected database "+i->second->GetHost());
556 Srv->Log(DEFAULT,"SQL: Failed to connect database "+i->second->GetHost()+": Error: "+i->second->GetError());
557 i->second->SetEnable(false);
563 void LoadDatabases(ConfigReader* ThisConf, Server* Srv)
565 Srv->Log(DEFAULT,"SQL: Loading database settings");
567 Srv->Log(DEBUG,"Cleared connections");
568 for (int j =0; j < ThisConf->Enumerate("database"); j++)
570 std::string db = ThisConf->ReadValue("database","name",j);
571 std::string user = ThisConf->ReadValue("database","username",j);
572 std::string pass = ThisConf->ReadValue("database","password",j);
573 std::string host = ThisConf->ReadValue("database","hostname",j);
574 std::string id = ThisConf->ReadValue("database","id",j);
575 Srv->Log(DEBUG,"Read database settings");
576 if ((db != "") && (host != "") && (user != "") && (id != "") && (pass != ""))
578 SQLConnection* ThisSQL = new SQLConnection(host,user,pass,db,id);
579 Srv->Log(DEFAULT,"Loaded database: "+ThisSQL->GetHost());
580 Connections[id] = ThisSQL;
581 Srv->Log(DEBUG,"Pushed back connection");
584 ConnectDatabases(Srv);
587 void NotifyMainThread(SQLConnection* connection_with_new_result)
589 /* Here we write() to the socket the main thread has open
590 * and we connect()ed back to before our thread became active.
591 * The main thread is using a nonblocking socket tied into
592 * the socket engine, so they wont block and they'll receive
593 * nearly instant notification. Because we're in a seperate
594 * thread, we can just use standard connect(), and we can
595 * block if we like. We just send the connection id of the
598 log(DEBUG,"Notify of result on connection: %s",connection_with_new_result->GetID().c_str());
599 if (send(QueueFD, connection_with_new_result->GetID().c_str(), connection_with_new_result->GetID().length()+1, 0) < 1) // add one for null terminator
601 log(DEBUG,"Error writing to QueueFD: %s",strerror(errno));
603 log(DEBUG,"Sent it on its way via fd=%d",QueueFD);
606 void* DispatcherThread(void* arg);
608 class Notifier : public InspSocket
616 /* Create a socket on a random port. Let the tcp stack allocate us an available port */
617 Notifier(Server* S) : InspSocket("127.0.0.1", 0, true, 3000), Srv(S)
619 uslen = sizeof(sock_us);
620 if (getsockname(this->fd,(sockaddr*)&sock_us,&uslen))
622 throw ModuleException("Could not create random listening port on localhost");
626 Notifier(int newfd, char* ip, Server* S) : InspSocket(newfd, ip), Srv(S)
628 log(DEBUG,"Constructor of new socket");
631 /* Using getsockname and ntohs, we can determine which port number we were allocated */
634 return ntohs(sock_us.sin_port);
637 virtual int OnIncomingConnection(int newsock, char* ip)
639 log(DEBUG,"Inbound connection on fd %d!",newsock);
640 Notifier* n = new Notifier(newsock, ip, Srv);
645 virtual bool OnDataReady()
647 log(DEBUG,"Inbound data!");
648 char* data = this->Read();
649 ConnMap::iterator iter;
653 log(DEBUG,"Looking for connection %s",data);
654 /* We expect to be sent a null terminated string */
655 if((iter = Connections.find(data)) != Connections.end())
657 log(DEBUG,"Found it!");
659 /* Lock the mutex, send back the data */
660 pthread_mutex_lock(&results_mutex);
661 ResultQueue::iterator n = iter->second->rq.begin();
663 iter->second->rq.pop_front();
664 pthread_mutex_unlock(&results_mutex);
673 class ModuleSQL : public Module
678 pthread_t Dispatcher;
681 void Implements(char* List)
683 List[I_OnRehash] = List[I_OnRequest] = 1;
686 unsigned long NewID()
693 char* OnRequest(Request* request)
695 if(strcmp(SQLREQID, request->GetData()) == 0)
697 SQLrequest* req = (SQLrequest*)request;
700 pthread_mutex_lock(&queue_mutex);
702 ConnMap::iterator iter;
704 char* returnval = NULL;
706 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());
708 if((iter = Connections.find(req->dbid)) != Connections.end())
710 iter->second->queue.push(*req);
712 returnval = SQLSUCCESS;
716 req->error.Id(BAD_DBID);
719 pthread_mutex_unlock(&queue_mutex);
725 log(DEBUG, "Got unsupported API version string: %s", request->GetData());
730 ModuleSQL(Server* Me)
734 Conf = new ConfigReader();
738 MessagePipe = new Notifier(Srv);
739 Srv->AddSocket(MessagePipe);
740 log(DEBUG,"Bound notifier to 127.0.0.1:%d",MessagePipe->GetPort());
742 pthread_attr_t attribs;
743 pthread_attr_init(&attribs);
744 pthread_attr_setdetachstate(&attribs, PTHREAD_CREATE_DETACHED);
745 if (pthread_create(&this->Dispatcher, &attribs, DispatcherThread, (void *)this) != 0)
747 throw ModuleException("m_mysql: Failed to create dispatcher thread: " + std::string(strerror(errno)));
749 Srv->PublishFeature("SQL", this);
750 Srv->PublishFeature("MySQL", this);
758 virtual void OnRehash(const std::string ¶meter)
760 /* TODO: set rehash bool here, which makes the dispatcher thread rehash at next opportunity */
763 virtual Version GetVersion()
765 return Version(1,1,0,0,VF_VENDOR|VF_SERVICEPROVIDER);
770 void* DispatcherThread(void* arg)
772 log(DEBUG,"Starting Dispatcher thread, mysql version %d",mysql_get_client_version());
773 ModuleSQL* thismodule = (ModuleSQL*)arg;
774 LoadDatabases(thismodule->Conf, thismodule->Srv);
776 /* Connect back to the Notifier */
778 if ((QueueFD = socket(AF_INET, SOCK_STREAM, 0)) == -1)
780 /* crap, we're out of sockets... */
781 log(DEBUG,"QueueFD cant be created");
785 log(DEBUG,"Initialize QueueFD to %d",QueueFD);
789 inet_aton("127.0.0.1", &ia);
790 addr.sin_family = AF_INET;
792 addr.sin_port = htons(MessagePipe->GetPort());
794 if (connect(QueueFD, (sockaddr*)&addr,sizeof(addr)) == -1)
796 /* wtf, we cant connect to it, but we just created it! */
797 log(DEBUG,"QueueFD cant connect!");
801 log(DEBUG,"Connect QUEUE FD");
805 SQLConnection* conn = NULL;
806 /* XXX: Lock here for safety */
807 pthread_mutex_lock(&queue_mutex);
808 for (ConnMap::iterator i = Connections.begin(); i != Connections.end(); i++)
810 if (i->second->queue.totalsize())
816 pthread_mutex_unlock(&queue_mutex);
819 /* Theres an item! */
822 log(DEBUG,"Process Leading query");
823 conn->DoLeadingQuery();
826 pthread_mutex_lock(&queue_mutex);
828 pthread_mutex_unlock(&queue_mutex);
839 // stuff down here is the module-factory stuff. For basic modules you can ignore this.
841 class ModuleSQLFactory : public ModuleFactory
852 virtual Module * CreateModule(Server* Me)
854 return new ModuleSQL(Me);
860 extern "C" void * init_module( void )
862 return new ModuleSQLFactory;