X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=src%2Fmodules%2Fextra%2Fm_mysql.cpp;h=377ffee7e026e10553a93da519fdc7a79828c30f;hb=d848034590bc402277da975b7efdbc78ce1722fc;hp=01b1553b0b1d36b0e15433f5b8bb17793ca22cd7;hpb=b6a3477a44dd7c47a9b29cbfe07e3a7886a97141;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/src/modules/extra/m_mysql.cpp b/src/modules/extra/m_mysql.cpp index 01b1553b0..377ffee7e 100644 --- a/src/modules/extra/m_mysql.cpp +++ b/src/modules/extra/m_mysql.cpp @@ -1,10 +1,17 @@ /* * InspIRCd -- Internet Relay Chat Daemon * + * Copyright (C) 2019 linuxdaemon + * Copyright (C) 2015 Daniel Vassdal + * Copyright (C) 2014, 2016 Adam + * Copyright (C) 2013-2014 Attila Molnar + * Copyright (C) 2013, 2016-2020 Sadie Powell + * Copyright (C) 2012 Robby + * Copyright (C) 2012 ChrisTX * 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 + * Copyright (C) 2009 Uli Schlachter + * Copyright (C) 2007, 2009 Dennis Friis + * Copyright (C) 2005, 2008-2010 Craig Edwards * * 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 @@ -19,13 +26,34 @@ * along with this program. If not, see . */ +/// $CompilerFlags: execute("mysql_config --include" "MYSQL_CXXFLAGS") +/// $LinkerFlags: execute("mysql_config --libs_r" "MYSQL_LDFLAGS" "-lmysqlclient") -/* Stop mysql wanting to use long long */ -#define NO_CLIENT_LONG_LONG +/// $PackageInfo: require_system("arch") mariadb-libs +/// $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 + +#ifdef __GNUC__ +# pragma GCC diagnostic push +#endif + +// 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 __GNUC__ +# pragma GCC diagnostic pop +#endif #ifdef _WIN32 # pragma comment(lib, "libmysql.lib") @@ -33,10 +61,6 @@ /* 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") */ - /* THE NONBLOCKING MYSQL API! * * MySQL provides no nonblocking (asyncronous) API of its own, and its developers recommend @@ -49,7 +73,7 @@ * 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. + * to insert further 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 @@ -59,40 +83,57 @@ * 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?" + * XXX: You might be asking "why doesnt it 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!) - * - * For a diagram of this system please see http://wiki.inspircd.org/Mysql2 + * guaranteed threadsafe!) */ class SQLConnection; class MySQLresult; class DispatcherThread; -struct QQueueItem +struct QueryQueueItem { - SQLQuery* q; - std::string query; - SQLConnection* c; - QQueueItem(SQLQuery* Q, const std::string& S, SQLConnection* C) : q(Q), query(S), c(C) {} + // An SQL database which this query is executed on. + SQLConnection* connection; + + // An object which handles the result of the query. + SQL::Query* query; + + // The SQL query which is to be executed. + std::string querystr; + + QueryQueueItem(SQL::Query* q, const std::string& s, SQLConnection* c) + : connection(c) + , query(q) + , querystr(s) + { + } }; -struct RQueueItem +struct ResultQueueItem { - SQLQuery* q; - MySQLresult* r; - RQueueItem(SQLQuery* Q, MySQLresult* R) : q(Q), r(R) {} + // An object which handles the result of the query. + SQL::Query* query; + + // The result returned from executing the MySQL query. + MySQLresult* result; + + ResultQueueItem(SQL::Query* q, MySQLresult* r) + : query(q) + , result(r) + { + } }; -typedef std::map ConnMap; -typedef std::deque QueryQueue; -typedef std::deque ResultQueue; +typedef insp::flat_map ConnMap; +typedef std::deque QueryQueue; +typedef std::deque ResultQueue; /** MySQL module * */ @@ -105,11 +146,11 @@ class ModuleSQL : public Module ConnMap connections; // main thread only ModuleSQL(); - void init(); + void init() CXX11_OVERRIDE; ~ModuleSQL(); - void OnRehash(User* user); - void OnUnloadModule(Module* mod); - Version GetVersion(); + void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE; + void OnUnloadModule(Module* mod) CXX11_OVERRIDE; + Version GetVersion() CXX11_OVERRIDE; }; class DispatcherThread : public SocketThread @@ -119,26 +160,25 @@ 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 -#define mysql_field_count mysql_num_fields -#endif - /** Represents a mysql result set */ -class MySQLresult : public SQLResult +class MySQLresult : public SQL::Result { public: - SQLerror err; + SQL::Error err; int currentrow; int rows; std::vector colnames; - std::vector fieldlists; + std::vector fieldlists; - MySQLresult(MYSQL_RES* res, int affected_rows) : 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) { @@ -167,9 +207,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++; } @@ -181,35 +221,47 @@ class MySQLresult : public SQLResult } } - MySQLresult(SQLerror& e) : err(e) + MySQLresult(SQL::Error& e) + : err(e) + , currentrow(0) + , rows(0) { } - ~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) CXX11_OVERRIDE { - 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) { @@ -227,44 +279,92 @@ class MySQLresult : public SQLResult /** Represents a connection to a mysql database */ -class SQLConnection : public SQLProvider +class SQLConnection : public SQL::Provider { + private: + bool EscapeString(SQL::Query* query, const std::string& in, std::string& out) + { + // In the worst case each character may need to be encoded as using two bytes and one + // byte is the NUL terminator. + std::vector buffer(in.length() * 2 + 1); + + // The return value of mysql_escape_string() is either an error or the length of the + // encoded string not including the NUL terminator. + // + // Unfortunately, someone genius decided that mysql_escape_string should return an + // unsigned type even though -1 is returned on error so checking whether an error + // happened is a bit cursed. + unsigned long escapedsize = mysql_escape_string(&buffer[0], in.c_str(), in.length()); + if (escapedsize == static_cast(-1)) + { + SQL::Error err(SQL::QSEND_FAIL, InspIRCd::Format("%u: %s", mysql_errno(connection), mysql_error(connection))); + query->OnError(err); + return false; + } + + out.append(&buffer[0], escapedsize); + return true; + } + 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) + SQLConnection(Module* p, ConfigTag* tag) + : SQL::Provider(p, tag->getString("id")) + , config(tag) + , connection(NULL) { } ~SQLConnection() { - Close(); + mysql_close(connection); } // This method connects to the database using the credentials supplied to the constructor, and returns // true upon success. bool Connect() { - 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)) + + // Set the connection timeout. + unsigned int timeout = config->getDuration("timeout", 5, 1, 30); + mysql_options(connection, MYSQL_OPT_CONNECT_TIMEOUT, &timeout); + + // Attempt to connect to the database. + const std::string host = config->getString("host"); + const std::string user = config->getString("user"); + const std::string pass = config->getString("pass"); + const std::string dbname = config->getString("name"); + unsigned int port = config->getUInt("port", 3306, 1, 65535); + if (!mysql_real_connect(connection, host.c_str(), user.c_str(), pass.c_str(), dbname.c_str(), port, NULL, CLIENT_IGNORE_SIGPIPE)) { - mysql_query(connection,initquery.c_str()); + ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Unable to connect to the %s MySQL server: %s", + GetId().c_str(), mysql_error(connection)); + return false; + } + + // Set the default character set. + const std::string charset = config->getString("charset"); + if (!charset.empty() && mysql_set_character_set(connection, charset.c_str())) + { + ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Could not set character set for %s to \"%s\": %s", + GetId().c_str(), charset.c_str(), mysql_error(connection)); + return false; } + + // Execute the initial SQL query. + const std::string initialquery = config->getString("initialquery"); + if (!initialquery.empty() && mysql_real_query(connection, initialquery.data(), initialquery.length())) + { + ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Could not execute initial query \"%s\" for %s: %s", + initialquery.c_str(), name.c_str(), mysql_error(connection)); + return false; + } + return true; } @@ -279,7 +379,7 @@ class SQLConnection : public SQLProvider /* Parse the command string and dispatch it to mysql */ if (CheckConnection() && !mysql_real_query(connection, query.data(), query.length())) { - /* Successfull query */ + /* Successful query */ MYSQL_RES* res = mysql_use_result(connection); unsigned long rows = mysql_affected_rows(connection); return new MySQLresult(res, rows); @@ -288,7 +388,7 @@ class SQLConnection : public SQLProvider { /* 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)); + SQL::Error e(SQL::QREPLY_FAIL, InspIRCd::Format("%u: %s", mysql_errno(connection), mysql_error(connection))); return new MySQLresult(e); } } @@ -300,24 +400,15 @@ class SQLConnection : public SQLProvider return true; } - std::string GetError() - { - return mysql_error(connection); - } - - void Close() - { - mysql_close(connection); - } - - void submit(SQLQuery* q, const std::string& qs) + void Submit(SQL::Query* q, const std::string& qs) CXX11_OVERRIDE { + ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Executing MySQL query: " + qs); Parent()->Dispatcher->LockQueue(); - Parent()->qq.push_back(QQueueItem(q, qs, this)); + Parent()->qq.push_back(QueryQueueItem(q, qs, this)); Parent()->Dispatcher->UnlockQueueWakeup(); } - void submit(SQLQuery* call, const std::string& q, const ParamL& p) + void Submit(SQL::Query* call, const std::string& q, const SQL::ParamList& p) CXX11_OVERRIDE { std::string res; unsigned int param = 0; @@ -325,27 +416,13 @@ class SQLConnection : public SQLProvider { 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); - } - } + else if (param < p.size() && !EscapeString(call, p[param++], res)) + return; } - submit(call, res); + Submit(call, res); } - void submit(SQLQuery* call, const std::string& q, const ParamM& p) + 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++) @@ -360,35 +437,27 @@ class SQLConnection : public SQLProvider field.push_back(q[i++]); i--; - ParamM::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); - } + SQL::ParamMap::const_iterator it = p.find(field); + if (it != p.end() && !EscapeString(call, it->second, res)) + return; } } - submit(call, res); + Submit(call, res); } }; ModuleSQL::ModuleSQL() + : Dispatcher(NULL) { - Dispatcher = NULL; } void ModuleSQL::init() { - Dispatcher = new DispatcherThread(this); - ServerInstance->Threads->Start(Dispatcher); + if (mysql_library_init(0, NULL, NULL)) + throw ModuleException("Unable to initialise the MySQL library!"); - Implementation eventlist[] = { I_OnRehash, I_OnUnloadModule }; - ServerInstance->Modules->Attach(eventlist, this, sizeof(eventlist)/sizeof(Implementation)); - - OnRehash(NULL); + Dispatcher = new DispatcherThread(this); + ServerInstance->Threads.Start(Dispatcher); } ModuleSQL::~ModuleSQL() @@ -399,19 +468,22 @@ ModuleSQL::~ModuleSQL() Dispatcher->OnNotify(); delete Dispatcher; } + for(ConnMap::iterator i = connections.begin(); i != connections.end(); i++) { delete i->second; } + + mysql_library_end(); } -void ModuleSQL::OnRehash(User* user) +void ModuleSQL::ReadConfig(ConfigStatus& status) { ConnMap conns; ConfigTagList tags = ServerInstance->Config->ConfTags("database"); for(ConfigIter i = tags.first; i != tags.second; i++) { - if (i->second->getString("module", "mysql") != "mysql") + if (!stdalgo::string::equalsci(i->second->getString("module"), "mysql")) continue; std::string id = i->second->getString("id"); ConnMap::iterator curr = connections.find(id); @@ -430,7 +502,7 @@ void ModuleSQL::OnRehash(User* user) // now clean up the deleted databases Dispatcher->LockQueue(); - SQLerror err(SQL_BAD_DBID); + SQL::Error err(SQL::BAD_DBID); for(ConnMap::iterator i = connections.begin(); i != connections.end(); i++) { ServerInstance->Modules->DelService(*i->second); @@ -441,10 +513,10 @@ void ModuleSQL::OnRehash(User* user) for (size_t j = qq.size(); j > 0; j--) { size_t k = j - 1; - if (qq[k].c == i->second) + if (qq[k].connection == i->second) { - qq[k].q->OnError(err); - delete qq[k].q; + qq[k].query->OnError(err); + delete qq[k].query; qq.erase(qq.begin() + k); } } @@ -457,23 +529,23 @@ void ModuleSQL::OnRehash(User* user) void ModuleSQL::OnUnloadModule(Module* mod) { - SQLerror err(SQL_BAD_DBID); + SQL::Error err(SQL::BAD_DBID); Dispatcher->LockQueue(); unsigned int i = qq.size(); while (i > 0) { i--; - if (qq[i].q->creator == mod) + if (qq[i].query->creator == mod) { 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].connection->lock.Lock(); + qq[i].connection->lock.Unlock(); } - qq[i].q->OnError(err); - delete qq[i].q; + qq[i].query->OnError(err); + delete qq[i].query; qq.erase(qq.begin() + i); } } @@ -484,7 +556,7 @@ void ModuleSQL::OnUnloadModule(Module* mod) Version ModuleSQL::GetVersion() { - return Version("MySQL support", VF_VENDOR); + return Version("Provides the ability for SQL modules to query a MySQL database.", VF_VENDOR); } void DispatcherThread::Run() @@ -494,23 +566,23 @@ void DispatcherThread::Run() { if (!Parent->qq.empty()) { - QQueueItem i = Parent->qq.front(); - i.c->lock.Lock(); + QueryQueueItem i = Parent->qq.front(); + i.connection->lock.Lock(); this->UnlockQueue(); - MySQLresult* res = i.c->DoBlockingQuery(i.query); - i.c->lock.Unlock(); + MySQLresult* res = i.connection->DoBlockingQuery(i.querystr); + i.connection->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. + * Rehash - delete i.connection out from under us. We don't care about that. + * UnloadModule - delete i.query and the qq item. Need to avoid reporting results. */ this->LockQueue(); - if (!Parent->qq.empty() && Parent->qq.front().q == i.q) + if (!Parent->qq.empty() && Parent->qq.front().query == i.query) { Parent->qq.pop_front(); - Parent->rq.push_back(RQueueItem(i.q, res)); + Parent->rq.push_back(ResultQueueItem(i.query, res)); NotifyParent(); } else @@ -536,13 +608,13 @@ void DispatcherThread::OnNotify() this->LockQueue(); for(ResultQueue::iterator i = Parent->rq.begin(); i != Parent->rq.end(); i++) { - MySQLresult* res = i->r; - if (res->err.id == SQL_NO_ERROR) - i->q->OnResult(*res); + MySQLresult* res = i->result; + if (res->err.code == SQL::SUCCESS) + i->query->OnResult(*res); else - i->q->OnError(res->err); - delete i->q; - delete i->r; + i->query->OnError(res->err); + delete i->query; + delete i->result; } Parent->rq.clear(); this->UnlockQueue();