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");
185 rows = affected_rows;
186 fieldlists.resize(rows);
187 unsigned int field_count;
192 while ((row = mysql_fetch_row(res)))
195 MYSQL_FIELD *fields = mysql_fetch_fields(res);
196 if(mysql_num_fields(res) == 0)
198 if (fields && mysql_num_fields(res))
201 while (field_count < mysql_num_fields(res))
203 std::string a = (fields[field_count].name ? fields[field_count].name : "");
204 std::string b = (row[field_count] ? row[field_count] : "");
205 SQLfield sqlf(a, !row[field_count]);
206 colnames.push_back(a);
207 fieldlists[n].push_back(sqlf);
213 cols = mysql_num_fields(res);
214 mysql_free_result(res);
217 log(DEBUG, "Created new MySQL result; %d rows, %d columns", rows, cols);
220 MySQLresult(Module* self, Module* to, SQLerror e) : SQLresult(self, to), currentrow(0)
225 log(DEBUG,"Created new MySQLresult of error type");
242 virtual std::string ColName(int column)
244 if (column < (int)colnames.size())
246 return colnames[column];
250 throw SQLbadColName();
255 virtual int ColNum(const std::string &column)
257 for (unsigned int i = 0; i < colnames.size(); i++)
259 if (column == colnames[i])
262 throw SQLbadColName();
266 virtual SQLfield GetValue(int row, int column)
268 if ((row >= 0) && (row < rows) && (column >= 0) && (column < cols))
270 return fieldlists[row][column];
273 log(DEBUG,"Danger will robinson, we don't have row %d, column %d!", row, column);
274 throw SQLbadColName();
276 /* XXX: We never actually get here because of the throw */
277 return SQLfield("",true);
280 virtual SQLfieldList& GetRow()
282 return fieldlists[currentrow];
285 virtual SQLfieldMap& GetRowMap()
287 fieldmap = new SQLfieldMap();
289 for (int i = 0; i < cols; i++)
291 fieldmap->insert(std::make_pair(colnames[cols],GetValue(currentrow, i)));
298 virtual SQLfieldList* GetRowPtr()
300 return &fieldlists[currentrow++];
303 virtual SQLfieldMap* GetRowMapPtr()
305 fieldmap = new SQLfieldMap();
307 for (int i = 0; i < cols; i++)
309 fieldmap->insert(std::make_pair(colnames[cols],GetValue(currentrow, i)));
316 virtual void Free(SQLfieldMap* fm)
321 virtual void Free(SQLfieldList* fl)
323 /* XXX: Yes, this is SUPPOSED to do nothing, we
324 * dont want to free our fieldlist until we
325 * destruct the object. Unlike the pgsql module,
326 * we only have the one.
333 void NotifyMainThread(SQLConnection* connection_with_new_result);
335 class SQLConnection : public classbase
346 std::map<std::string,std::string> thisrow;
355 // This constructor creates an SQLConnection object with the given credentials, and creates the underlying
356 // MYSQL struct, but does not connect yet.
357 SQLConnection(std::string thishost, std::string thisuser, std::string thispass, std::string thisdb, const std::string &myid)
359 this->Enabled = true;
360 this->host = thishost;
361 this->user = thisuser;
362 this->pass = thispass;
367 // This method connects to the database using the credentials supplied to the constructor, and returns
368 // true upon success.
371 unsigned int timeout = 1;
372 mysql_init(&connection);
373 mysql_options(&connection,MYSQL_OPT_CONNECT_TIMEOUT,(char*)&timeout);
374 return mysql_real_connect(&connection, host.c_str(), user.c_str(), pass.c_str(), db.c_str(), 0, NULL, 0);
377 void DoLeadingQuery()
379 /* Parse the command string and dispatch it to mysql */
380 SQLrequest& req = queue.front();
381 log(DEBUG,"DO QUERY: %s",req.query.q.c_str());
383 /* Pointer to the buffer we screw around with substitution in */
386 /* Pointer to the current end of query, where we append new stuff */
389 /* Total length of the unescaped parameters */
390 unsigned long paramlen;
392 /* Total length of query, used for binary-safety in mysql_real_query */
393 unsigned long querylength = 0;
397 for(ParamL::iterator i = req.query.p.begin(); i != req.query.p.end(); i++)
399 paramlen += i->size();
402 /* To avoid a lot of allocations, allocate enough memory for the biggest the escaped query could possibly be.
403 * sizeofquery + (totalparamlength*2) + 1
405 * The +1 is for null-terminating the string for mysql_real_escape_string
408 query = new char[req.query.q.length() + (paramlen*2)];
411 /* Okay, now we have a buffer large enough we need to start copying the query into it and escaping and substituting
412 * the parameters into it...
415 for(unsigned long i = 0; i < req.query.q.length(); i++)
417 if(req.query.q[i] == '?')
419 /* We found a place to substitute..what fun.
420 * use mysql calls to escape and write the
421 * escaped string onto the end of our query buffer,
422 * then we "just" need to make sure queryend is
423 * pointing at the right place.
425 if(req.query.p.size())
427 unsigned long len = mysql_real_escape_string(&connection, queryend, req.query.p.front().c_str(), req.query.p.front().length());
430 req.query.p.pop_front();
434 log(DEBUG, "Found a substitution location but no parameter to substitute :|");
440 *queryend = req.query.q[i];
448 log(DEBUG, "Attempting to dispatch query: %s", query);
450 pthread_mutex_lock(&queue_mutex);
451 req.query.q = std::string(query,querylength);
452 pthread_mutex_unlock(&queue_mutex);
454 if (!mysql_real_query(&connection, req.query.q.data(), req.query.q.length()))
456 /* Successfull query */
457 res = mysql_use_result(&connection);
458 unsigned long rows = mysql_affected_rows(&connection);
459 MySQLresult* r = new MySQLresult(SQLModule, req.GetSource(), res, rows);
460 r->dbid = this->GetID();
461 r->query = req.query.q;
462 /* Put this new result onto the results queue.
463 * XXX: Remember to mutex the queue!
465 pthread_mutex_lock(&results_mutex);
467 pthread_mutex_unlock(&results_mutex);
471 /* XXX: See /usr/include/mysql/mysqld_error.h for a list of
472 * possible error numbers and error messages */
473 SQLerror e((SQLerrorNum)mysql_errno(&connection), mysql_error(&connection));
474 MySQLresult* r = new MySQLresult(SQLModule, req.GetSource(), e);
475 r->dbid = this->GetID();
476 r->query = req.query.q;
478 pthread_mutex_lock(&results_mutex);
480 pthread_mutex_unlock(&results_mutex);
483 /* Now signal the main thread that we've got a result to process.
484 * Pass them this connection id as what to examine
487 NotifyMainThread(this);
490 bool ConnectionLost()
493 return (mysql_ping(&connection) != 0);
498 bool CheckConnection()
500 if (ConnectionLost()) {
506 std::string GetError()
508 return mysql_error(&connection);
511 const std::string& GetID()
516 std::string GetHost()
521 void SetEnable(bool Enable)
535 void ConnectDatabases(Server* Srv)
537 for (ConnMap::iterator i = Connections.begin(); i != Connections.end(); i++)
539 i->second->SetEnable(true);
540 if (i->second->Connect())
542 Srv->Log(DEFAULT,"SQL: Successfully connected database "+i->second->GetHost());
546 Srv->Log(DEFAULT,"SQL: Failed to connect database "+i->second->GetHost()+": Error: "+i->second->GetError());
547 i->second->SetEnable(false);
553 void LoadDatabases(ConfigReader* ThisConf, Server* Srv)
555 Srv->Log(DEFAULT,"SQL: Loading database settings");
557 Srv->Log(DEBUG,"Cleared connections");
558 for (int j =0; j < ThisConf->Enumerate("database"); j++)
560 std::string db = ThisConf->ReadValue("database","name",j);
561 std::string user = ThisConf->ReadValue("database","username",j);
562 std::string pass = ThisConf->ReadValue("database","password",j);
563 std::string host = ThisConf->ReadValue("database","hostname",j);
564 std::string id = ThisConf->ReadValue("database","id",j);
565 Srv->Log(DEBUG,"Read database settings");
566 if ((db != "") && (host != "") && (user != "") && (id != "") && (pass != ""))
568 SQLConnection* ThisSQL = new SQLConnection(host,user,pass,db,id);
569 Srv->Log(DEFAULT,"Loaded database: "+ThisSQL->GetHost());
570 Connections[id] = ThisSQL;
571 Srv->Log(DEBUG,"Pushed back connection");
574 ConnectDatabases(Srv);
577 void NotifyMainThread(SQLConnection* connection_with_new_result)
579 /* Here we write() to the socket the main thread has open
580 * and we connect()ed back to before our thread became active.
581 * The main thread is using a nonblocking socket tied into
582 * the socket engine, so they wont block and they'll receive
583 * nearly instant notification. Because we're in a seperate
584 * thread, we can just use standard connect(), and we can
585 * block if we like. We just send the connection id of the
588 log(DEBUG,"Notify of result on connection: %s",connection_with_new_result->GetID().c_str());
589 if (send(QueueFD, connection_with_new_result->GetID().c_str(), connection_with_new_result->GetID().length()+1, 0) < 1) // add one for null terminator
591 log(DEBUG,"Error writing to QueueFD: %s",strerror(errno));
593 log(DEBUG,"Sent it on its way via fd=%d",QueueFD);
596 void* DispatcherThread(void* arg);
598 class Notifier : public InspSocket
606 /* Create a socket on a random port. Let the tcp stack allocate us an available port */
607 Notifier(Server* S) : InspSocket("127.0.0.1", 0, true, 3000), Srv(S)
609 uslen = sizeof(sock_us);
610 if (getsockname(this->fd,(sockaddr*)&sock_us,&uslen))
612 throw ModuleException("Could not create random listening port on localhost");
616 Notifier(int newfd, char* ip, Server* S) : InspSocket(newfd, ip), Srv(S)
618 log(DEBUG,"Constructor of new socket");
621 /* Using getsockname and ntohs, we can determine which port number we were allocated */
624 return ntohs(sock_us.sin_port);
627 virtual int OnIncomingConnection(int newsock, char* ip)
629 log(DEBUG,"Inbound connection on fd %d!",newsock);
630 Notifier* n = new Notifier(newsock, ip, Srv);
635 virtual bool OnDataReady()
637 log(DEBUG,"Inbound data!");
638 char* data = this->Read();
639 ConnMap::iterator iter;
643 log(DEBUG,"Looking for connection %s",data);
644 /* We expect to be sent a null terminated string */
645 if((iter = Connections.find(data)) != Connections.end())
647 log(DEBUG,"Found it!");
649 /* Lock the mutex, send back the data */
650 pthread_mutex_lock(&results_mutex);
651 ResultQueue::iterator n = iter->second->rq.begin();
653 iter->second->rq.pop_front();
654 pthread_mutex_unlock(&results_mutex);
663 class ModuleSQL : public Module
668 pthread_t Dispatcher;
671 void Implements(char* List)
673 List[I_OnRehash] = List[I_OnRequest] = 1;
676 unsigned long NewID()
683 char* OnRequest(Request* request)
685 if(strcmp(SQLREQID, request->GetData()) == 0)
687 SQLrequest* req = (SQLrequest*)request;
690 pthread_mutex_lock(&queue_mutex);
692 ConnMap::iterator iter;
694 char* returnval = NULL;
696 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());
698 if((iter = Connections.find(req->dbid)) != Connections.end())
700 iter->second->queue.push(*req);
702 returnval = SQLSUCCESS;
706 req->error.Id(BAD_DBID);
709 pthread_mutex_unlock(&queue_mutex);
715 log(DEBUG, "Got unsupported API version string: %s", request->GetData());
720 ModuleSQL(Server* Me)
724 Conf = new ConfigReader();
728 MessagePipe = new Notifier(Srv);
729 Srv->AddSocket(MessagePipe);
730 log(DEBUG,"Bound notifier to 127.0.0.1:%d",MessagePipe->GetPort());
732 pthread_attr_t attribs;
733 pthread_attr_init(&attribs);
734 pthread_attr_setdetachstate(&attribs, PTHREAD_CREATE_DETACHED);
735 if (pthread_create(&this->Dispatcher, &attribs, DispatcherThread, (void *)this) != 0)
737 throw ModuleException("m_mysql: Failed to create dispatcher thread: " + std::string(strerror(errno)));
739 Srv->PublishFeature("SQL", this);
740 Srv->PublishFeature("MySQL", this);
748 virtual void OnRehash(const std::string ¶meter)
750 /* TODO: set rehash bool here, which makes the dispatcher thread rehash at next opportunity */
753 virtual Version GetVersion()
755 return Version(1,1,0,0,VF_VENDOR|VF_SERVICEPROVIDER);
760 void* DispatcherThread(void* arg)
762 ModuleSQL* thismodule = (ModuleSQL*)arg;
763 LoadDatabases(thismodule->Conf, thismodule->Srv);
765 /* Connect back to the Notifier */
767 if ((QueueFD = socket(AF_INET, SOCK_STREAM, 0)) == -1)
769 /* crap, we're out of sockets... */
770 log(DEBUG,"QueueFD cant be created");
774 log(DEBUG,"Initialize QueueFD to %d",QueueFD);
778 inet_aton("127.0.0.1", &ia);
779 addr.sin_family = AF_INET;
781 addr.sin_port = htons(MessagePipe->GetPort());
783 if (connect(QueueFD, (sockaddr*)&addr,sizeof(addr)) == -1)
785 /* wtf, we cant connect to it, but we just created it! */
786 log(DEBUG,"QueueFD cant connect!");
790 log(DEBUG,"Connect QUEUE FD");
794 SQLConnection* conn = NULL;
795 /* XXX: Lock here for safety */
796 pthread_mutex_lock(&queue_mutex);
797 for (ConnMap::iterator i = Connections.begin(); i != Connections.end(); i++)
799 if (i->second->queue.totalsize())
805 pthread_mutex_unlock(&queue_mutex);
808 /* Theres an item! */
811 log(DEBUG,"Process Leading query");
812 conn->DoLeadingQuery();
815 pthread_mutex_lock(&queue_mutex);
817 pthread_mutex_unlock(&queue_mutex);
828 // stuff down here is the module-factory stuff. For basic modules you can ignore this.
830 class ModuleSQLFactory : public ModuleFactory
841 virtual Module * CreateModule(Server* Me)
843 return new ModuleSQL(Me);
849 extern "C" void * init_module( void )
851 return new ModuleSQLFactory;