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.
184 rows = affected_rows;
185 fieldlists.resize(rows);
186 unsigned int field_count;
191 while ((row = mysql_fetch_row(res)))
194 MYSQL_FIELD *fields = mysql_fetch_fields(res);
195 if(mysql_num_fields(res) == 0)
197 if (fields && mysql_num_fields(res))
200 while (field_count < mysql_num_fields(res))
202 std::string a = (fields[field_count].name ? fields[field_count].name : "");
203 std::string b = (row[field_count] ? row[field_count] : "");
204 SQLfield sqlf(a, !row[field_count]);
205 colnames.push_back(a);
206 fieldlists[n].push_back(sqlf);
212 cols = mysql_num_fields(res);
213 mysql_free_result(res);
216 log(DEBUG, "Created new MySQL result; %d rows, %d columns", rows, cols);
219 MySQLresult(Module* self, Module* to, SQLerror e) : SQLresult(self, to)
238 virtual std::string ColName(int column)
240 if (column < (int)colnames.size())
242 return colnames[column];
246 throw SQLbadColName();
251 virtual int ColNum(const std::string &column)
253 for (unsigned int i = 0; i < colnames.size(); i++)
255 if (column == colnames[i])
258 throw SQLbadColName();
262 virtual SQLfield GetValue(int row, int column)
264 if ((row >= 0) && (row < rows) && (column >= 0) && (column < cols))
266 return fieldlists[row][column];
269 log(DEBUG,"Danger will robinson, we don't have row %d, column %d!", row, column);
270 throw SQLbadColName();
272 /* XXX: We never actually get here because of the throw */
273 return SQLfield("",true);
276 virtual SQLfieldList& GetRow()
278 return fieldlists[currentrow];
281 virtual SQLfieldMap& GetRowMap()
283 fieldmap = new SQLfieldMap();
285 for (int i = 0; i < cols; i++)
287 fieldmap->insert(std::make_pair(colnames[cols],GetValue(currentrow, i)));
294 virtual SQLfieldList* GetRowPtr()
296 return &fieldlists[currentrow++];
299 virtual SQLfieldMap* GetRowMapPtr()
301 fieldmap = new SQLfieldMap();
303 for (int i = 0; i < cols; i++)
305 fieldmap->insert(std::make_pair(colnames[cols],GetValue(currentrow, i)));
312 virtual void Free(SQLfieldMap* fm)
317 virtual void Free(SQLfieldList* fl)
319 /* XXX: Yes, this is SUPPOSED to do nothing, we
320 * dont want to free our fieldlist until we
321 * destruct the object. Unlike the pgsql module,
322 * we only have the one.
329 void NotifyMainThread(SQLConnection* connection_with_new_result);
331 class SQLConnection : public classbase
342 std::map<std::string,std::string> thisrow;
351 // This constructor creates an SQLConnection object with the given credentials, and creates the underlying
352 // MYSQL struct, but does not connect yet.
353 SQLConnection(std::string thishost, std::string thisuser, std::string thispass, std::string thisdb, const std::string &myid)
355 this->Enabled = true;
356 this->host = thishost;
357 this->user = thisuser;
358 this->pass = thispass;
363 // This method connects to the database using the credentials supplied to the constructor, and returns
364 // true upon success.
367 unsigned int timeout = 1;
368 mysql_init(&connection);
369 mysql_options(&connection,MYSQL_OPT_CONNECT_TIMEOUT,(char*)&timeout);
370 return mysql_real_connect(&connection, host.c_str(), user.c_str(), pass.c_str(), db.c_str(), 0, NULL, 0);
373 void DoLeadingQuery()
375 /* Parse the command string and dispatch it to mysql */
376 SQLrequest& req = queue.front();
377 log(DEBUG,"DO QUERY: %s",req.query.q.c_str());
379 /* Pointer to the buffer we screw around with substitution in */
382 /* Pointer to the current end of query, where we append new stuff */
385 /* Total length of the unescaped parameters */
386 unsigned long paramlen;
388 /* Total length of query, used for binary-safety in mysql_real_query */
389 unsigned long querylength = 0;
393 for(ParamL::iterator i = req.query.p.begin(); i != req.query.p.end(); i++)
395 paramlen += i->size();
398 /* To avoid a lot of allocations, allocate enough memory for the biggest the escaped query could possibly be.
399 * sizeofquery + (totalparamlength*2) + 1
401 * The +1 is for null-terminating the string for mysql_real_escape_string
404 query = new char[req.query.q.length() + (paramlen*2)];
407 /* Okay, now we have a buffer large enough we need to start copying the query into it and escaping and substituting
408 * the parameters into it...
411 for(unsigned long i = 0; i < req.query.q.length(); i++)
413 if(req.query.q[i] == '?')
415 /* We found a place to substitute..what fun.
416 * use mysql calls to escape and write the
417 * escaped string onto the end of our query buffer,
418 * then we "just" need to make sure queryend is
419 * pointing at the right place.
421 if(req.query.p.size())
423 unsigned long len = mysql_real_escape_string(&connection, queryend, req.query.p.front().c_str(), req.query.p.front().length());
426 req.query.p.pop_front();
430 log(DEBUG, "Found a substitution location but no parameter to substitute :|");
436 *queryend = req.query.q[i];
444 log(DEBUG, "Attempting to dispatch query: %s", query);
446 pthread_mutex_lock(&queue_mutex);
447 req.query.q = std::string(query,querylength);
448 pthread_mutex_unlock(&queue_mutex);
450 if (!mysql_real_query(&connection, req.query.q.data(), req.query.q.length()))
452 /* Successfull query */
453 res = mysql_use_result(&connection);
454 unsigned long rows = mysql_affected_rows(&connection);
455 MySQLresult* r = new MySQLresult(SQLModule, req.GetSource(), res, rows);
456 r->dbid = this->GetID();
457 r->query = req.query.q;
458 /* Put this new result onto the results queue.
459 * XXX: Remember to mutex the queue!
461 pthread_mutex_lock(&results_mutex);
463 pthread_mutex_unlock(&results_mutex);
467 /* XXX: See /usr/include/mysql/mysqld_error.h for a list of
468 * possible error numbers and error messages */
469 SQLerror e((SQLerrorNum)mysql_errno(&connection), mysql_error(&connection));
470 MySQLresult* r = new MySQLresult(SQLModule, req.GetSource(), e);
471 r->dbid = this->GetID();
472 r->query = req.query.q;
474 pthread_mutex_lock(&results_mutex);
476 pthread_mutex_unlock(&results_mutex);
479 /* Now signal the main thread that we've got a result to process.
480 * Pass them this connection id as what to examine
483 NotifyMainThread(this);
486 bool ConnectionLost()
489 return (mysql_ping(&connection) != 0);
494 bool CheckConnection()
496 if (ConnectionLost()) {
502 std::string GetError()
504 return mysql_error(&connection);
507 const std::string& GetID()
512 std::string GetHost()
517 void SetEnable(bool Enable)
531 void ConnectDatabases(Server* Srv)
533 for (ConnMap::iterator i = Connections.begin(); i != Connections.end(); i++)
535 i->second->SetEnable(true);
536 if (i->second->Connect())
538 Srv->Log(DEFAULT,"SQL: Successfully connected database "+i->second->GetHost());
542 Srv->Log(DEFAULT,"SQL: Failed to connect database "+i->second->GetHost()+": Error: "+i->second->GetError());
543 i->second->SetEnable(false);
549 void LoadDatabases(ConfigReader* ThisConf, Server* Srv)
551 Srv->Log(DEFAULT,"SQL: Loading database settings");
553 Srv->Log(DEBUG,"Cleared connections");
554 for (int j =0; j < ThisConf->Enumerate("database"); j++)
556 std::string db = ThisConf->ReadValue("database","name",j);
557 std::string user = ThisConf->ReadValue("database","username",j);
558 std::string pass = ThisConf->ReadValue("database","password",j);
559 std::string host = ThisConf->ReadValue("database","hostname",j);
560 std::string id = ThisConf->ReadValue("database","id",j);
561 Srv->Log(DEBUG,"Read database settings");
562 if ((db != "") && (host != "") && (user != "") && (id != "") && (pass != ""))
564 SQLConnection* ThisSQL = new SQLConnection(host,user,pass,db,id);
565 Srv->Log(DEFAULT,"Loaded database: "+ThisSQL->GetHost());
566 Connections[id] = ThisSQL;
567 Srv->Log(DEBUG,"Pushed back connection");
570 ConnectDatabases(Srv);
573 void NotifyMainThread(SQLConnection* connection_with_new_result)
575 /* Here we write() to the socket the main thread has open
576 * and we connect()ed back to before our thread became active.
577 * The main thread is using a nonblocking socket tied into
578 * the socket engine, so they wont block and they'll receive
579 * nearly instant notification. Because we're in a seperate
580 * thread, we can just use standard connect(), and we can
581 * block if we like. We just send the connection id of the
584 log(DEBUG,"Notify of result on connection: %s",connection_with_new_result->GetID().c_str());
585 write(QueueFD, connection_with_new_result->GetID().c_str(), connection_with_new_result->GetID().length()+1); // add one for null terminator
586 log(DEBUG,"Sent it on its way via fd=%d",QueueFD);
589 void* DispatcherThread(void* arg);
591 class Notifier : public InspSocket
599 /* Create a socket on a random port. Let the tcp stack allocate us an available port */
600 Notifier(Server* S) : InspSocket("127.0.0.1", 0, true, 3000), Srv(S)
602 uslen = sizeof(sock_us);
603 if (getsockname(this->fd,(sockaddr*)&sock_us,&uslen))
605 throw ModuleException("Could not create random listening port on localhost");
609 Notifier(int newfd, char* ip, Server* S) : Srv(S)
611 log(DEBUG,"Constructor of new socket");
614 /* Using getsockname and ntohs, we can determine which port number we were allocated */
617 return ntohs(sock_us.sin_port);
620 virtual int OnIncomingConnection(int newsock, char* ip)
622 log(DEBUG,"Inbound connection!");
623 Notifier* n = new Notifier(newsock, ip, Srv);
628 virtual bool OnDataReady()
630 log(DEBUG,"Inbound data!");
631 char* data = this->Read();
632 ConnMap::iterator iter;
636 log(DEBUG,"Looking for connection %s",data);
637 /* We expect to be sent a null terminated string */
638 if((iter = Connections.find(data)) != Connections.end())
640 log(DEBUG,"Found it!");
642 /* Lock the mutex, send back the data */
643 pthread_mutex_lock(&results_mutex);
644 ResultQueue::iterator n = iter->second->rq.begin();
646 iter->second->rq.pop_front();
647 pthread_mutex_unlock(&results_mutex);
656 class ModuleSQL : public Module
661 pthread_t Dispatcher;
664 void Implements(char* List)
666 List[I_OnRehash] = List[I_OnRequest] = 1;
669 unsigned long NewID()
676 char* OnRequest(Request* request)
678 if(strcmp(SQLREQID, request->GetData()) == 0)
680 SQLrequest* req = (SQLrequest*)request;
683 pthread_mutex_lock(&queue_mutex);
685 ConnMap::iterator iter;
687 char* returnval = NULL;
689 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());
691 if((iter = Connections.find(req->dbid)) != Connections.end())
693 iter->second->queue.push(*req);
695 returnval = SQLSUCCESS;
699 req->error.Id(BAD_DBID);
702 pthread_mutex_unlock(&queue_mutex);
708 log(DEBUG, "Got unsupported API version string: %s", request->GetData());
713 ModuleSQL(Server* Me)
717 Conf = new ConfigReader();
721 MessagePipe = new Notifier(Srv);
722 Srv->AddSocket(MessagePipe);
723 log(DEBUG,"Bound notifier to 127.0.0.1:%d",MessagePipe->GetPort());
725 pthread_attr_t attribs;
726 pthread_attr_init(&attribs);
727 pthread_attr_setdetachstate(&attribs, PTHREAD_CREATE_DETACHED);
728 if (pthread_create(&this->Dispatcher, &attribs, DispatcherThread, (void *)this) != 0)
730 throw ModuleException("m_mysql: Failed to create dispatcher thread: " + std::string(strerror(errno)));
732 Srv->PublishFeature("SQL", this);
733 Srv->PublishFeature("MySQL", this);
741 virtual void OnRehash(const std::string ¶meter)
743 /* TODO: set rehash bool here, which makes the dispatcher thread rehash at next opportunity */
746 virtual Version GetVersion()
748 return Version(1,1,0,0,VF_VENDOR|VF_SERVICEPROVIDER);
753 void* DispatcherThread(void* arg)
755 ModuleSQL* thismodule = (ModuleSQL*)arg;
756 LoadDatabases(thismodule->Conf, thismodule->Srv);
758 /* Connect back to the Notifier */
760 if ((QueueFD = socket(AF_INET, SOCK_STREAM, 0)) == -1)
762 /* crap, we're out of sockets... */
763 log(DEBUG,"QueueFD cant be created");
767 log(DEBUG,"Initialize QueueFD to %d",QueueFD);
771 inet_aton("127.0.0.1", &ia);
772 addr.sin_family = AF_INET;
774 addr.sin_port = htons(MessagePipe->GetPort());
776 if (connect(QueueFD, (sockaddr*)&addr,sizeof(addr)) == -1)
778 /* wtf, we cant connect to it, but we just created it! */
779 log(DEBUG,"QueueFD cant connect!");
783 log(DEBUG,"Connect QUEUE FD");
787 SQLConnection* conn = NULL;
788 /* XXX: Lock here for safety */
789 pthread_mutex_lock(&queue_mutex);
790 for (ConnMap::iterator i = Connections.begin(); i != Connections.end(); i++)
792 if (i->second->queue.totalsize())
798 pthread_mutex_unlock(&queue_mutex);
801 /* Theres an item! */
804 log(DEBUG,"Process Leading query");
805 conn->DoLeadingQuery();
808 pthread_mutex_lock(&queue_mutex);
810 pthread_mutex_unlock(&queue_mutex);
821 // stuff down here is the module-factory stuff. For basic modules you can ignore this.
823 class ModuleSQLFactory : public ModuleFactory
834 virtual Module * CreateModule(Server* Me)
836 return new ModuleSQL(Me);
842 extern "C" void * init_module( void )
844 return new ModuleSQLFactory;