X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=src%2Fmodules%2Fextra%2Fm_mysql.cpp;h=159a0b8b2318b1b336300a243da7e00c2c848cc8;hb=a5d110282a864fd2e91b51ce360a977cd0643657;hp=aef6abca9410cf69740a4cd42495d30566d5f760;hpb=221934729eba613b1a845771a0a6aabf3eb6390c;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/src/modules/extra/m_mysql.cpp b/src/modules/extra/m_mysql.cpp index aef6abca9..159a0b8b2 100644 --- a/src/modules/extra/m_mysql.cpp +++ b/src/modules/extra/m_mysql.cpp @@ -1,403 +1,549 @@ -/* +------------------------------------+ - * | Inspire Internet Relay Chat Daemon | - * +------------------------------------+ +/* + * InspIRCd -- Internet Relay Chat Daemon * - * InspIRCd is copyright (C) 2002-2004 ChatSpike-Dev. - * E-mail: - * - * - * - * Written by Craig Edwards, Craig McLure, and others. - * This program is free but copyrighted software; see - * the file COPYING for details. + * Copyright (C) 2009-2010 Daniel De Graaf + * Copyright (C) 2006-2007, 2009 Dennis Friis + * Copyright (C) 2006-2009 Craig Edwards + * Copyright (C) 2008 Robin Burchell * - * --------------------------------------------------- + * 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 . */ -using namespace std; -#include -#include +/* Stop mysql wanting to use long long */ +#define NO_CLIENT_LONG_LONG + +#include "inspircd.h" #include -#include -#include "users.h" -#include "channels.h" -#include "modules.h" -#include "helperfuncs.h" -#include "m_sqlv2.h" +#include "sql.h" -/* VERSION 2 API: With nonblocking (threaded) requests */ +#ifdef _WIN32 +# pragma comment(lib, "libmysql.lib") +#endif + +/* VERSION 3 API: With nonblocking (threaded) requests */ /* $ModDesc: SQL Service Provider module for all other m_sql* modules */ -/* $CompileFlags: -pthread `mysql_config --include` */ -/* $LinkerFlags: -pthread `mysql_config --libs_r` `perl ../mysql_rpath.pl` */ +/* $CompileFlags: exec("mysql_config --include") */ +/* $LinkerFlags: exec("mysql_config --libs_r") rpath("mysql_config --libs_r") */ -/** SQLConnection represents one mysql session. - * Each session has its own persistent connection to the database. +/* 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!) */ -#if !defined(MYSQL_VERSION_ID) || MYSQL_VERSION_ID<32224 -#define mysql_field_count mysql_num_fields -#endif +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) {} +}; -class SQLConnection : public classbase +struct RQueueItem { - protected: - - MYSQL connection; - MYSQL_RES *res; - MYSQL_ROW row; - std::string host; - std::string user; - std::string pass; - std::string db; - std::map thisrow; - bool Enabled; - long id; + SQLQuery* q; + MySQLresult* r; + RQueueItem(SQLQuery* Q, MySQLresult* R) : q(Q), r(R) {} +}; + +typedef std::map ConnMap; +typedef std::deque QueryQueue; +typedef std::deque 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(); +}; - // This constructor creates an SQLConnection object with the given credentials, and creates the underlying - // MYSQL struct, but does not connect yet. - SQLConnection(std::string thishost, std::string thisuser, std::string thispass, std::string thisdb, long myid) - { - this->Enabled = true; - this->host = thishost; - this->user = thisuser; - this->pass = thispass; - this->db = thisdb; - this->id = myid; - } +class DispatcherThread : public SocketThread +{ + private: + ModuleSQL* const Parent; + public: + DispatcherThread(ModuleSQL* CreatorModule) : Parent(CreatorModule) { } + ~DispatcherThread() { } + virtual void Run(); + virtual void OnNotify(); +}; - // This method connects to the database using the credentials supplied to the constructor, and returns - // true upon success. - bool Connect() - { - unsigned int timeout = 1; - mysql_init(&connection); - mysql_options(&connection,MYSQL_OPT_CONNECT_TIMEOUT,(char*)&timeout); - return mysql_real_connect(&connection, host.c_str(), user.c_str(), pass.c_str(), db.c_str(), 0, NULL, 0); - } +#if !defined(MYSQL_VERSION_ID) || MYSQL_VERSION_ID<32224 +#define mysql_field_count mysql_num_fields +#endif - // This method issues a query that expects multiple rows of results. Use GetRow() and QueryDone() to retrieve - // multiple rows. - bool QueryResult(std::string query) - { - if (!CheckConnection()) return false; - - int r = mysql_query(&connection, query.c_str()); - if (!r) - { - res = mysql_use_result(&connection); - } - return (!r); - } +/** Represents a mysql result set + */ +class MySQLresult : public SQLResult +{ + public: + SQLerror err; + int currentrow; + int rows; + std::vector colnames; + std::vector fieldlists; - // This method issues a query that just expects a number of 'effected' rows (e.g. UPDATE or DELETE FROM). - // the number of effected rows is returned in the return value. - long QueryCount(std::string query) + MySQLresult(MYSQL_RES* res, int affected_rows) : err(SQL_NO_ERROR), currentrow(0), rows(0) { - /* If the connection is down, we return a negative value - New to 1.1 */ - if (!CheckConnection()) return -1; - - int r = mysql_query(&connection, query.c_str()); - if (!r) + if (affected_rows >= 1) { - res = mysql_store_result(&connection); - unsigned long rows = mysql_affected_rows(&connection); - mysql_free_result(res); - return rows; + rows = affected_rows; + fieldlists.resize(rows); } - return 0; - } - - // This method fetches a row, if available from the database. You must issue a query - // using QueryResult() first! The row's values are returned as a map of std::string - // where each item is keyed by the column name. - std::map GetRow() - { - thisrow.clear(); + unsigned int field_count = 0; if (res) { - row = mysql_fetch_row(res); - if (row) + MYSQL_ROW row; + int n = 0; + while ((row = mysql_fetch_row(res))) { - unsigned int field_count = 0; + if (fieldlists.size() < (unsigned int)rows+1) + { + fieldlists.resize(fieldlists.size()+1); + } + field_count = 0; MYSQL_FIELD *fields = mysql_fetch_fields(res); - if(mysql_field_count(&connection) == 0) - return thisrow; - if (fields && mysql_field_count(&connection)) + if(mysql_num_fields(res) == 0) + break; + if (fields && mysql_num_fields(res)) { - while (field_count < mysql_field_count(&connection)) + colnames.clear(); + while (field_count < mysql_num_fields(res)) { std::string a = (fields[field_count].name ? fields[field_count].name : ""); - std::string b = (row[field_count] ? row[field_count] : ""); - thisrow[a] = b; + if (row[field_count]) + fieldlists[n].push_back(SQLEntry(row[field_count])); + else + fieldlists[n].push_back(SQLEntry()); + colnames.push_back(a); field_count++; } - return thisrow; + n++; } + rows++; } + mysql_free_result(res); } - return thisrow; } - bool QueryDone() + MySQLresult(SQLerror& e) : err(e) { - if (res) - { - mysql_free_result(res); - res = NULL; - return true; - } - else return false; + + } + + ~MySQLresult() + { + } + + virtual int Rows() + { + return rows; + } + + virtual void GetCols(std::vector& result) + { + result.assign(colnames.begin(), colnames.end()); } - bool ConnectionLost() + virtual SQLEntry GetValue(int row, int column) { - if (&connection) { - return (mysql_ping(&connection) != 0); + if ((row >= 0) && (row < rows) && (column >= 0) && (column < (int)fieldlists[row].size())) + { + return fieldlists[row][column]; } - else return false; + return SQLEntry(); } - bool CheckConnection() + virtual bool GetRow(SQLEntries& result) { - if (ConnectionLost()) { - return Connect(); + if (currentrow < rows) + { + result.assign(fieldlists[currentrow].begin(), fieldlists[currentrow].end()); + currentrow++; + return true; + } + else + { + result.clear(); + return false; } - else return true; } +}; - std::string GetError() +/** Represents a connection to a mysql database + */ +class SQLConnection : public SQLProvider +{ + public: + reference 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) { - return mysql_error(&connection); } - long GetID() + ~SQLConnection() { - return id; + Close(); } - std::string GetHost() + // This method connects to the database using the credentials supplied to the constructor, and returns + // true upon success. + bool Connect() { - return host; + 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; } - void Enable() + ModuleSQL* Parent() { - Enabled = true; + return (ModuleSQL*)(Module*)creator; } - void Disable() + MySQLresult* DoBlockingQuery(const std::string& query) { - Enabled = false; + + /* 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 IsEnabled() + bool CheckConnection() { - return Enabled; + if (!connection || mysql_ping(connection) != 0) + return Connect(); + return true; } -}; + std::string GetError() + { + return mysql_error(connection); + } -typedef std::vector ConnectionList; + void Close() + { + mysql_close(connection); + } -class ModuleSQL : public Module -{ - Server *Srv; - ConfigReader *Conf; - ConnectionList Connections; - - public: - void ConnectDatabases() + void submit(SQLQuery* q, const std::string& qs) { - for (ConnectionList::iterator i = Connections.begin(); i != Connections.end(); i++) - { - i->Enable(); - if (i->Connect()) - { - Srv->Log(DEFAULT,"SQL: Successfully connected database "+i->GetHost()); - } - else - { - Srv->Log(DEFAULT,"SQL: Failed to connect database "+i->GetHost()+": Error: "+i->GetError()); - i->Disable(); - } - } + Parent()->Dispatcher->LockQueue(); + Parent()->qq.push_back(QQueueItem(q, qs, this)); + Parent()->Dispatcher->UnlockQueueWakeup(); } - void LoadDatabases(ConfigReader* ThisConf) + void submit(SQLQuery* call, const std::string& q, const ParamL& p) { - Srv->Log(DEFAULT,"SQL: Loading database settings"); - Connections.clear(); - Srv->Log(DEBUG,"Cleared connections"); - for (int j =0; j < ThisConf->Enumerate("database"); j++) + std::string res; + unsigned int param = 0; + for(std::string::size_type i = 0; i < q.length(); i++) { - std::string db = ThisConf->ReadValue("database","name",j); - std::string user = ThisConf->ReadValue("database","username",j); - std::string pass = ThisConf->ReadValue("database","password",j); - std::string host = ThisConf->ReadValue("database","hostname",j); - std::string id = ThisConf->ReadValue("database","id",j); - Srv->Log(DEBUG,"Read database settings"); - if ((db != "") && (host != "") && (user != "") && (id != "") && (pass != "")) + if (q[i] != '?') + res.push_back(q[i]); + else { - SQLConnection ThisSQL(host,user,pass,db,atoi(id.c_str())); - Srv->Log(DEFAULT,"Loaded database: "+ThisSQL.GetHost()); - Connections.push_back(ThisSQL); - Srv->Log(DEBUG,"Pushed back connection"); + 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 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); + } } } - ConnectDatabases(); + submit(call, res); } - void ResultType(SQLRequest *r, SQLResult *res) + void submit(SQLQuery* call, const std::string& q, const ParamM& p) { - for (ConnectionList::iterator i = Connections.begin(); i != Connections.end(); i++) + std::string res; + for(std::string::size_type i = 0; i < q.length(); i++) { - if ((i->GetID() == r->GetConnID()) && (i->IsEnabled())) + if (q[i] != '$') + res.push_back(q[i]); + else { - bool xr = i->QueryResult(r->GetQuery()); - if (!xr) + 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()) { - res->SetType(SQL_ERROR); - res->SetError(i->GetError()); - return; + std::string parm = it->second; + // NOTE: See above + std::vector buffer(parm.length() * 2 + 1); + unsigned long escapedsize = mysql_escape_string(&buffer[0], parm.c_str(), parm.length()); + res.append(&buffer[0], escapedsize); } - res->SetType(SQL_OK); - return; } } + 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 CountType(SQLRequest *r, SQLResult* res) +void ModuleSQL::OnRehash(User* user) +{ + ConnMap conns; + ConfigTagList tags = ServerInstance->Config->ConfTags("database"); + for(ConfigIter i = tags.first; i != tags.second; i++) { - for (ConnectionList::iterator i = Connections.begin(); i != Connections.end(); 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()) { - if ((i->GetID() == r->GetConnID()) && (i->IsEnabled())) - { - res->SetType(SQL_COUNT); - res->SetCount(i->QueryCount(r->GetQuery())); - return; - } + 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); } } - void DoneType(SQLRequest *r, SQLResult* res) + // now clean up the deleted databases + Dispatcher->LockQueue(); + SQLerror err(SQL_BAD_DBID); + for(ConnMap::iterator i = connections.begin(); i != connections.end(); i++) { - for (ConnectionList::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--) { - if ((i->GetID() == r->GetConnID()) && (i->IsEnabled())) + size_t k = j - 1; + if (qq[k].c == i->second) { - res->SetType(SQL_DONE); - if (!i->QueryDone()) - res->SetType(SQL_ERROR); + 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 RowType(SQLRequest *r, SQLResult* res) +void ModuleSQL::OnUnloadModule(Module* mod) +{ + SQLerror err(SQL_BAD_DBID); + Dispatcher->LockQueue(); + unsigned int i = qq.size(); + while (i > 0) { - for (ConnectionList::iterator i = Connections.begin(); i != Connections.end(); i++) + i--; + if (qq[i].q->creator == mod) { - if ((i->GetID() == r->GetConnID()) && (i->IsEnabled())) + if (i == 0) { - log(DEBUG,"*** FOUND MATCHING ROW"); - std::map row = i->GetRow(); - res->SetRow(row); - res->SetType(SQL_ROW); - if (!row.size()) - { - log(DEBUG,"ROW SIZE IS 0"); - res->SetType(SQL_END); - } - return; + // 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(); +} - void Implements(char* List) - { - List[I_OnRehash] = List[I_OnRequest] = 1; - } +Version ModuleSQL::GetVersion() +{ + return Version("MySQL support", VF_VENDOR); +} - char* OnRequest(Request* request) +void DispatcherThread::Run() +{ + this->LockQueue(); + while (!this->GetExitFlag()) { - if (request) + if (!Parent->qq.empty()) { - SQLResult* Result = new SQLResult(); - SQLRequest *r = (SQLRequest*)request->GetData(); - switch (r->GetQueryType()) + 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) { - case SQL_RESULT: - ResultType(r,Result); - break; - case SQL_COUNT: - CountType(r,Result); - break; - case SQL_ROW: - RowType(r,Result); - break; - case SQL_DONE: - DoneType(r,Result); - break; + Parent->qq.pop_front(); + Parent->rq.push_back(RQueueItem(i.q, res)); + NotifyParent(); + } + else + { + // UnloadModule ate the query + delete res; } - return (char*)Result; } - return NULL; - } - - ModuleSQL(Server* Me) - : Module::Module(Me) - { - Srv = Me; - Conf = new ConfigReader(); - LoadDatabases(Conf); - } - - virtual ~ModuleSQL() - { - Connections.clear(); - DELETE(Conf); - } - - virtual void OnRehash(const std::string ¶meter) - { - DELETE(Conf); - Conf = new ConfigReader(); - LoadDatabases(Conf); - } - - virtual Version GetVersion() - { - return Version(1,0,0,0,VF_VENDOR|VF_SERVICEPROVIDER); + else + { + /* We know the queue is empty, we can safely hang this thread until + * something happens + */ + this->WaitForQueue(); + } } - -}; - -// stuff down here is the module-factory stuff. For basic modules you can ignore this. + this->UnlockQueue(); +} -class ModuleSQLFactory : public ModuleFactory +void DispatcherThread::OnNotify() { - public: - ModuleSQLFactory() - { - } - - ~ModuleSQLFactory() - { - } - - virtual Module * CreateModule(Server* Me) + // 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++) { - return new ModuleSQL(Me); + 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; } - -}; - - -extern "C" void * init_module( void ) -{ - return new ModuleSQLFactory; + Parent->rq.clear(); + this->UnlockQueue(); } +MODULE_INIT(ModuleSQL)