X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=src%2Fmodules%2Fextra%2Fm_mysql.cpp;h=0a7d4d993ce6d78a4e5c91d7d86e15fa004bac4d;hb=780dda83ba3857bc3c330d4b5d38bb251a9d879b;hp=08f71c9293b299d19858fd9cef55403a2986b11a;hpb=e9808ffb01876ab0ebad383de7861899a17f1a63;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/src/modules/extra/m_mysql.cpp b/src/modules/extra/m_mysql.cpp index 08f71c929..0a7d4d993 100644 --- a/src/modules/extra/m_mysql.cpp +++ b/src/modules/extra/m_mysql.cpp @@ -1,34 +1,51 @@ -/* +------------------------------------+ - * | Inspire Internet Relay Chat Daemon | - * +------------------------------------+ +/* + * InspIRCd -- Internet Relay Chat Daemon * - * InspIRCd: (C) 2002-2010 InspIRCd Development Team - * See: http://wiki.inspircd.org/Credits + * 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 program is free but copyrighted software; see - * the file COPYING for details. + * 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 . */ -/* Stop mysql wanting to use long long */ -#define NO_CLIENT_LONG_LONG +/// $CompilerFlags: execute("mysql_config --include" "MYSQL_CXXFLAGS") +/// $LinkerFlags: execute("mysql_config --libs_r" "MYSQL_LDFLAGS" "-lmysqlclient") + +/// $PackageInfo: require_system("centos" "6.0" "6.99") mysql-devel +/// $PackageInfo: require_system("centos" "7.0") mariadb-devel +/// $PackageInfo: require_system("darwin") mysql-connector-c +/// $PackageInfo: require_system("debian") libmysqlclient-dev +/// $PackageInfo: require_system("ubuntu") libmysqlclient-dev + + +// Fix warnings about the use of `long long` on C++03. +#if defined __clang__ +# pragma clang diagnostic ignored "-Wc++11-long-long" +#elif defined __GNUC__ +# pragma GCC diagnostic ignored "-Wlong-long" +#endif #include "inspircd.h" #include -#include "sql.h" +#include "modules/sql.h" -#ifdef WINDOWS -#pragma comment(lib, "mysqlclient.lib") +#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: exec("mysql_config --include") */ -/* $LinkerFlags: exec("mysql_config --libs_r") rpath("mysql_config --libs_r") */ -/* $ModDep: m_sqlv2.h */ - /* THE NONBLOCKING MYSQL API! * * MySQL provides no nonblocking (asyncronous) API of its own, and its developers recommend @@ -59,24 +76,30 @@ * 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!) - * - * For a diagram of this system please see http://wiki.inspircd.org/Mysql2 */ class SQLConnection; class MySQLresult; class DispatcherThread; -struct QueueItem +struct QQueueItem { - SQLQuery* q; + SQL::Query* q; + std::string query; SQLConnection* c; - QueueItem(SQLQuery* Q, SQLConnection* C) : q(Q), c(C) {} + QQueueItem(SQL::Query* Q, const std::string& S, SQLConnection* C) : q(Q), query(S), c(C) {} }; -typedef std::map ConnMap; -typedef std::deque QueryQueue; -typedef std::deque ResultQueue; +struct RQueueItem +{ + SQL::Query* q; + MySQLresult* r; + RQueueItem(SQL::Query* Q, MySQLresult* R) : q(Q), r(R) {} +}; + +typedef insp::flat_map ConnMap; +typedef std::deque QueryQueue; +typedef std::deque ResultQueue; /** MySQL module * */ @@ -84,15 +107,16 @@ class ModuleSQL : public Module { public: DispatcherThread* Dispatcher; - QueryQueue qq; - ResultQueue rq; - ConnMap connections; + QueryQueue qq; // MUST HOLD MUTEX + ResultQueue rq; // MUST HOLD MUTEX + ConnMap connections; // main thread only ModuleSQL(); - void init(); + void init() CXX11_OVERRIDE; ~ModuleSQL(); - void OnRehash(User* user); - Version GetVersion(); + void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE; + void OnUnloadModule(Module* mod) CXX11_OVERRIDE; + Version GetVersion() CXX11_OVERRIDE; }; class DispatcherThread : public SocketThread @@ -102,8 +126,8 @@ class DispatcherThread : public SocketThread public: DispatcherThread(ModuleSQL* CreatorModule) : Parent(CreatorModule) { } ~DispatcherThread() { } - virtual void Run(); - virtual void OnNotify(); + void Run() CXX11_OVERRIDE; + void OnNotify() CXX11_OVERRIDE; }; #if !defined(MYSQL_VERSION_ID) || MYSQL_VERSION_ID<32224 @@ -112,17 +136,16 @@ class DispatcherThread : public SocketThread /** Represents a mysql result set */ -class MySQLresult : public SQLResult +class MySQLresult : public SQL::Result { public: - SQLQuery* query; - SQLerror err; + SQL::Error err; int currentrow; int rows; std::vector colnames; - std::vector fieldlists; + std::vector fieldlists; - MySQLresult(SQLQuery* q, MYSQL_RES* res, int affected_rows) : query(q), err(SQL_NO_ERROR), currentrow(0), rows(0) + MySQLresult(MYSQL_RES* res, int affected_rows) : err(SQL::SUCCESS), currentrow(0), rows(0) { if (affected_rows >= 1) { @@ -151,9 +174,9 @@ class MySQLresult : public SQLResult { std::string a = (fields[field_count].name ? fields[field_count].name : ""); if (row[field_count]) - fieldlists[n].push_back(SQLEntry(row[field_count])); + fieldlists[n].push_back(SQL::Field(row[field_count])); else - fieldlists[n].push_back(SQLEntry()); + fieldlists[n].push_back(SQL::Field()); colnames.push_back(a); field_count++; } @@ -162,39 +185,47 @@ class MySQLresult : public SQLResult rows++; } mysql_free_result(res); - res = NULL; } } - MySQLresult(SQLQuery* q, SQLerror& e) : query(q), err(e) + MySQLresult(SQL::Error& e) : err(e) { } - ~MySQLresult() + int Rows() CXX11_OVERRIDE { + return rows; } - virtual int Rows() + void GetCols(std::vector& result) CXX11_OVERRIDE { - return rows; + result.assign(colnames.begin(), colnames.end()); } - virtual void GetCols(std::vector& result) + bool HasColumn(const std::string& column, size_t& index) { - result.assign(colnames.begin(), colnames.end()); + for (size_t i = 0; i < colnames.size(); ++i) + { + if (colnames[i] == column) + { + index = i; + return true; + } + } + return false; } - virtual SQLEntry GetValue(int row, int column) + SQL::Field GetValue(int row, int column) { if ((row >= 0) && (row < rows) && (column >= 0) && (column < (int)fieldlists[row].size())) { return fieldlists[row][column]; } - return SQLEntry(); + return SQL::Field(); } - virtual bool GetRow(SQLEntries& result) + bool GetRow(SQL::Row& result) CXX11_OVERRIDE { if (currentrow < rows) { @@ -212,16 +243,16 @@ class MySQLresult : public SQLResult /** Represents a connection to a mysql database */ -class SQLConnection : public SQLProvider +class SQLConnection : public SQL::Provider { public: reference config; MYSQL *connection; - bool active; + 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), active(false) + SQLConnection(Module* p, ConfigTag* tag) : SQL::Provider(p, "SQL/" + tag->getString("id")), + config(tag), connection(NULL) { } @@ -241,10 +272,16 @@ class SQLConnection : public SQLProvider std::string user = config->getString("user"); std::string pass = config->getString("pass"); std::string dbname = config->getString("name"); - int port = config->getInt("port"); + unsigned int port = config->getUInt("port", 3306); 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; + + // Enable character set settings + std::string charset = config->getString("charset"); + if ((!charset.empty()) && (mysql_set_character_set(connection, charset.c_str()))) + ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "WARNING: Could not set character set to \"%s\"", charset.c_str()); + std::string initquery; if (config->readString("initialquery", initquery)) { @@ -253,97 +290,36 @@ class SQLConnection : public SQLProvider return true; } - virtual std::string FormatQuery(const std::string& q, const ParamL& p) - { - std::string res; - unsigned int param = 0; - for(std::string::size_type i = 0; i < q.length(); i++) - { - if (q[i] != '?') - res.push_back(q[i]); - else - { - // TODO numbered parameter support ('?1') - if (param < p.size()) - { - std::string parm = p[param++]; - char buffer[MAXBUF]; - mysql_escape_string(buffer, parm.c_str(), parm.length()); -// mysql_real_escape_string(connection, queryend, paramscopy[paramnum].c_str(), paramscopy[paramnum].length()); - res.append(buffer); - } - } - } - return res; - } - - std::string FormatQuery(const std::string& q, const ParamM& p) - { - std::string res; - for(std::string::size_type i = 0; i < q.length(); i++) - { - if (q[i] != '$') - res.push_back(q[i]); - else - { - std::string field; - i++; - while (i < q.length() && isalpha(q[i])) - field.push_back(q[i++]); - i--; - - ParamM::const_iterator it = p.find(field); - if (it != p.end()) - { - std::string parm = it->second; - char buffer[MAXBUF]; - mysql_escape_string(buffer, parm.c_str(), parm.length()); - res.append(buffer); - } - } - } - return res; - } - ModuleSQL* Parent() { return (ModuleSQL*)(Module*)creator; } - void DoBlockingQuery(SQLQuery* req) + MySQLresult* DoBlockingQuery(const std::string& query) { + /* Parse the command string and dispatch it to mysql */ - if (CheckConnection() && !mysql_real_query(connection, req->query.data(), req->query.length())) + 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); - MySQLresult* r = new MySQLresult(req, res, rows); - Parent()->Dispatcher->LockQueue(); - Parent()->rq.push_back(r); - Parent()->Dispatcher->NotifyParent(); - Parent()->Dispatcher->UnlockQueue(); + 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)) + std::string(": ") + mysql_error(connection)); - MySQLresult* r = new MySQLresult(req, e); - Parent()->Dispatcher->LockQueue(); - Parent()->rq.push_back(r); - Parent()->Dispatcher->NotifyParent(); - Parent()->Dispatcher->UnlockQueue(); + SQL::Error e(SQL::QREPLY_FAIL, InspIRCd::Format("%u: %s", mysql_errno(connection), mysql_error(connection))); + return new MySQLresult(e); } } bool CheckConnection() { - if (mysql_ping(connection) != 0) - { + if (!connection || mysql_ping(connection) != 0) return Connect(); - } - else return true; + return true; } std::string GetError() @@ -356,12 +332,69 @@ class SQLConnection : public SQLProvider mysql_close(connection); } - void submit(SQLQuery* q) + void Submit(SQL::Query* q, const std::string& qs) CXX11_OVERRIDE { Parent()->Dispatcher->LockQueue(); - Parent()->qq.push_back(QueueItem(q, this)); + Parent()->qq.push_back(QQueueItem(q, qs, this)); Parent()->Dispatcher->UnlockQueueWakeup(); } + + void Submit(SQL::Query* call, const std::string& q, const SQL::ParamList& p) CXX11_OVERRIDE + { + std::string res; + unsigned int param = 0; + for(std::string::size_type i = 0; i < q.length(); i++) + { + if (q[i] != '?') + res.push_back(q[i]); + else + { + 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); + } + } + } + Submit(call, res); + } + + void Submit(SQL::Query* call, const std::string& q, const SQL::ParamMap& p) CXX11_OVERRIDE + { + std::string res; + for(std::string::size_type i = 0; i < q.length(); i++) + { + if (q[i] != '$') + res.push_back(q[i]); + else + { + std::string field; + i++; + while (i < q.length() && isalnum(q[i])) + field.push_back(q[i++]); + i--; + + SQL::ParamMap::const_iterator it = p.find(field); + if (it != p.end()) + { + 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); + } + } + } + Submit(call, res); + } }; ModuleSQL::ModuleSQL() @@ -372,10 +405,7 @@ ModuleSQL::ModuleSQL() void ModuleSQL::init() { Dispatcher = new DispatcherThread(this); - ServerInstance->Threads->Start(Dispatcher); - - Implementation eventlist[] = { I_OnRehash }; - ServerInstance->Modules->Attach(eventlist, this, 1); + ServerInstance->Threads.Start(Dispatcher); } ModuleSQL::~ModuleSQL() @@ -392,9 +422,8 @@ ModuleSQL::~ModuleSQL() } } -void ModuleSQL::OnRehash(User* user) +void ModuleSQL::ReadConfig(ConfigStatus& status) { - Dispatcher->LockQueue(); ConnMap conns; ConfigTagList tags = ServerInstance->Config->ConfTags("database"); for(ConfigIter i = tags.first; i != tags.second; i++) @@ -415,21 +444,59 @@ void ModuleSQL::OnRehash(User* user) connections.erase(curr); } } + + // now clean up the deleted databases + Dispatcher->LockQueue(); + SQL::Error err(SQL::BAD_DBID); for(ConnMap::iterator i = connections.begin(); i != connections.end(); i++) { - if (i->second->active) + 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--) { - // can't delete it now. Next rehash will try to kill it again - conns.insert(*i); + size_t k = j - 1; + if (qq[k].c == i->second) + { + qq[k].q->OnError(err); + delete qq[k].q; + qq.erase(qq.begin() + k); + } } - else + // finally, nuke the connection + delete i->second; + } + Dispatcher->UnlockQueue(); + connections.swap(conns); +} + +void ModuleSQL::OnUnloadModule(Module* mod) +{ + SQL::Error err(SQL::BAD_DBID); + Dispatcher->LockQueue(); + unsigned int i = qq.size(); + while (i > 0) + { + i--; + if (qq[i].q->creator == mod) { - ServerInstance->Modules->DelService(*i->second); - delete i->second; + if (i == 0) + { + // 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); } } - connections.swap(conns); Dispatcher->UnlockQueue(); + // clean up any result queue entries + Dispatcher->OnNotify(); } Version ModuleSQL::GetVersion() @@ -444,13 +511,30 @@ void DispatcherThread::Run() { if (!Parent->qq.empty()) { - QueueItem i = Parent->qq.front(); - Parent->qq.pop_front(); - i.c->active = true; + QQueueItem i = Parent->qq.front(); + i.c->lock.Lock(); this->UnlockQueue(); - i.c->DoBlockingQuery(i.q); + 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(); - i.c->active = false; + if (!Parent->qq.empty() && Parent->qq.front().q == i.q) + { + Parent->qq.pop_front(); + Parent->rq.push_back(RQueueItem(i.q, res)); + NotifyParent(); + } + else + { + // UnloadModule ate the query + delete res; + } } else { @@ -469,13 +553,13 @@ void DispatcherThread::OnNotify() this->LockQueue(); for(ResultQueue::iterator i = Parent->rq.begin(); i != Parent->rq.end(); i++) { - MySQLresult* res = *i; - if (res->err.id == SQL_NO_ERROR) - res->query->OnResult(*res); + MySQLresult* res = i->r; + if (res->err.code == SQL::SUCCESS) + i->q->OnResult(*res); else - res->query->OnError(res->err); - delete res->query; - delete res; + i->q->OnError(res->err); + delete i->q; + delete i->r; } Parent->rq.clear(); this->UnlockQueue();