-/* +------------------------------------+
- * | Inspire Internet Relay Chat Daemon |
- * +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
*
- * InspIRCd: (C) 2002-2007 InspIRCd Development Team
- * See: http://www.inspircd.org/wiki/index.php/Credits
+ * Copyright (C) 2019 linuxdaemon <linuxdaemon.irc@gmail.com>
+ * Copyright (C) 2015 Daniel Vassdal <shutter@canternet.org>
+ * Copyright (C) 2014, 2016 Adam <Adam@anope.org>
+ * Copyright (C) 2013-2014 Attila Molnar <attilamolnar@hush.com>
+ * Copyright (C) 2013, 2016-2020 Sadie Powell <sadie@witchery.services>
+ * Copyright (C) 2012 Robby <robby@chatbelgie.be>
+ * Copyright (C) 2012 ChrisTX <xpipe@hotmail.de>
+ * Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
+ * Copyright (C) 2009 Uli Schlachter <psychon@inspircd.org>
+ * Copyright (C) 2007, 2009 Dennis Friis <peavey@inspircd.org>
+ * Copyright (C) 2005, 2008-2010 Craig Edwards <brain@inspircd.org>
*
- * 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 <http://www.gnu.org/licenses/>.
*/
-#include <stdio.h>
-#include <string>
-#include <mysql.h>
-#include <pthread.h>
-#include "users.h"
-#include "channels.h"
-#include "modules.h"
+/// $CompilerFlags: execute("mysql_config --include" "MYSQL_CXXFLAGS")
+/// $LinkerFlags: execute("mysql_config --libs_r" "MYSQL_LDFLAGS" "-lmysqlclient")
+
+/// $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 "m_sqlv2.h"
+#include <mysql.h>
+#include "modules/sql.h"
-/* VERSION 2 API: With nonblocking (threaded) requests */
+#ifdef __GNUC__
+# pragma GCC diagnostic pop
+#endif
-/* $ModDesc: SQL Service Provider module for all other m_sql* modules */
-/* $CompileFlags: `mysql_config --include` */
-/* $LinkerFlags: `mysql_config --libs_r` `perl extra/mysql_rpath.pl` */
-/* $ModDep: m_sqlv2.h */
+#ifdef _WIN32
+# pragma comment(lib, "libmysql.lib")
+#endif
+
+/* VERSION 3 API: With nonblocking (threaded) requests */
/* 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 pthreads, and performs its mysql queries in this thread,
+ * 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.
+ * 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
* 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://www.inspircd.org/wiki/Mysql2
+ * guaranteed threadsafe!)
*/
-
class SQLConnection;
-class Notifier;
-
-
-typedef std::map<std::string, SQLConnection*> ConnMap;
-bool giveup = false;
-static Module* SQLModule = NULL;
-static Notifier* MessagePipe = NULL;
-int QueueFD = -1;
-
-
-#if !defined(MYSQL_VERSION_ID) || MYSQL_VERSION_ID<32224
-#define mysql_field_count mysql_num_fields
-#endif
-
-typedef std::deque<SQLresult*> ResultQueue;
+class MySQLresult;
+class DispatcherThread;
-/** Represents a mysql query queue
- */
-class QueryQueue : public classbase
+struct QueryQueueItem
{
-private:
- typedef std::deque<SQLrequest> ReqDeque;
+ // An SQL database which this query is executed on.
+ SQLConnection* connection;
- ReqDeque priority; /* The priority queue */
- ReqDeque normal; /* The 'normal' queue */
- enum { PRI, NOR, NON } which; /* Which queue the currently active element is at the front of */
+ // An object which handles the result of the query.
+ SQL::Query* query;
-public:
- QueryQueue()
- : which(NON)
- {
- }
-
- void push(const SQLrequest &q)
- {
- if(q.pri)
- priority.push_back(q);
- else
- normal.push_back(q);
- }
+ // The SQL query which is to be executed.
+ std::string querystr;
- void pop()
+ QueryQueueItem(SQL::Query* q, const std::string& s, SQLConnection* c)
+ : connection(c)
+ , query(q)
+ , querystr(s)
{
- if((which == PRI) && priority.size())
- {
- priority.pop_front();
- }
- else if((which == NOR) && normal.size())
- {
- normal.pop_front();
- }
-
- /* Reset this */
- which = NON;
-
- /* Silently do nothing if there was no element to pop() */
- }
-
- SQLrequest& front()
- {
- switch(which)
- {
- case PRI:
- return priority.front();
- case NOR:
- return normal.front();
- default:
- if(priority.size())
- {
- which = PRI;
- return priority.front();
- }
-
- if(normal.size())
- {
- which = NOR;
- return normal.front();
- }
-
- /* This will probably result in a segfault,
- * but the caller should have checked totalsize()
- * first so..meh - moron :p
- */
-
- return priority.front();
- }
- }
-
- std::pair<int, int> size()
- {
- return std::make_pair(priority.size(), normal.size());
}
+};
- int totalsize()
- {
- return priority.size() + normal.size();
- }
+struct ResultQueueItem
+{
+ // An object which handles the result of the query.
+ SQL::Query* query;
- void PurgeModule(Module* mod)
- {
- DoPurgeModule(mod, priority);
- DoPurgeModule(mod, normal);
- }
+ // The result returned from executing the MySQL query.
+ MySQLresult* result;
-private:
- void DoPurgeModule(Module* mod, ReqDeque& q)
+ ResultQueueItem(SQL::Query* q, MySQLresult* r)
+ : query(q)
+ , result(r)
{
- for(ReqDeque::iterator iter = q.begin(); iter != q.end(); iter++)
- {
- if(iter->GetSource() == mod)
- {
- if(iter->id == front().id)
- {
- /* It's the currently active query.. :x */
- iter->SetSource(NULL);
- }
- else
- {
- /* It hasn't been executed yet..just remove it */
- iter = q.erase(iter);
- }
- }
- }
}
};
-/* A mutex to wrap around queue accesses */
-pthread_mutex_t queue_mutex = PTHREAD_MUTEX_INITIALIZER;
+typedef insp::flat_map<std::string, SQLConnection*> ConnMap;
+typedef std::deque<QueryQueueItem> QueryQueue;
+typedef std::deque<ResultQueueItem> ResultQueue;
-pthread_mutex_t results_mutex = PTHREAD_MUTEX_INITIALIZER;
+/** 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() CXX11_OVERRIDE;
+ ~ModuleSQL();
+ void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE;
+ void OnUnloadModule(Module* mod) CXX11_OVERRIDE;
+ Version GetVersion() CXX11_OVERRIDE;
+};
-pthread_mutex_t logging_mutex = PTHREAD_MUTEX_INITIALIZER;
+class DispatcherThread : public SocketThread
+{
+ private:
+ ModuleSQL* const Parent;
+ public:
+ DispatcherThread(ModuleSQL* CreatorModule) : Parent(CreatorModule) { }
+ ~DispatcherThread() { }
+ void Run() CXX11_OVERRIDE;
+ void OnNotify() CXX11_OVERRIDE;
+};
/** Represents a mysql result set
*/
-class MySQLresult : public SQLresult
+class MySQLresult : public SQL::Result
{
+ public:
+ SQL::Error err;
int currentrow;
- //std::vector<std::map<std::string,std::string> > results;
- std::vector<std::string> colnames;
- std::vector<SQLfieldList> fieldlists;
- SQLfieldMap* fieldmap;
- SQLfieldMap fieldmap2;
- SQLfieldList emptyfieldlist;
int rows;
- public:
+ std::vector<std::string> colnames;
+ std::vector<SQL::Row> fieldlists;
- MySQLresult(Module* self, Module* to, MYSQL_RES* res, int affected_rows, unsigned int id) : SQLresult(self, to, id), currentrow(0), fieldmap(NULL)
+ MySQLresult(MYSQL_RES* res, int affected_rows)
+ : err(SQL::SUCCESS)
+ , currentrow(0)
+ , rows(0)
{
- /* A number of affected rows from from mysql_affected_rows.
- */
- fieldlists.clear();
- rows = 0;
if (affected_rows >= 1)
{
rows = affected_rows;
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] : "");
- SQLfield sqlf(b, !row[field_count]);
+ if (row[field_count])
+ fieldlists[n].push_back(SQL::Field(row[field_count]));
+ else
+ fieldlists[n].push_back(SQL::Field());
colnames.push_back(a);
- fieldlists[n].push_back(sqlf);
field_count++;
}
n++;
}
}
- MySQLresult(Module* self, Module* to, SQLerror e, unsigned int id) : SQLresult(self, to, id), currentrow(0)
+ MySQLresult(SQL::Error& e)
+ : err(e)
+ , currentrow(0)
+ , rows(0)
{
- rows = 0;
- error = e;
- }
- ~MySQLresult()
- {
}
- virtual int Rows()
+ int Rows() CXX11_OVERRIDE
{
return rows;
}
- virtual int Cols()
+ void GetCols(std::vector<std::string>& result) CXX11_OVERRIDE
{
- return colnames.size();
- }
-
- virtual std::string ColName(int column)
- {
- if (column < (int)colnames.size())
- {
- return colnames[column];
- }
- else
- {
- throw SQLbadColName();
- }
- return "";
+ result.assign(colnames.begin(), colnames.end());
}
- virtual int ColNum(const std::string &column)
+ bool HasColumn(const std::string& column, size_t& index) CXX11_OVERRIDE
{
- for (unsigned int i = 0; i < colnames.size(); i++)
+ for (size_t i = 0; i < colnames.size(); ++i)
{
- if (column == colnames[i])
- return i;
+ if (colnames[i] == column)
+ {
+ index = i;
+ return true;
+ }
}
- throw SQLbadColName();
- return 0;
+ return false;
}
- virtual SQLfield GetValue(int row, int column)
+ SQL::Field GetValue(int row, int column)
{
- if ((row >= 0) && (row < rows) && (column >= 0) && (column < Cols()))
+ if ((row >= 0) && (row < rows) && (column >= 0) && (column < (int)fieldlists[row].size()))
{
return fieldlists[row][column];
}
-
- throw SQLbadColName();
-
- /* XXX: We never actually get here because of the throw */
- return SQLfield("",true);
+ return SQL::Field();
}
- virtual SQLfieldList& GetRow()
+ bool GetRow(SQL::Row& result) CXX11_OVERRIDE
{
- if (currentrow < rows)
- return fieldlists[currentrow];
- else
- return emptyfieldlist;
- }
-
- virtual SQLfieldMap& GetRowMap()
- {
- fieldmap2.clear();
-
if (currentrow < rows)
{
- for (int i = 0; i < Cols(); i++)
- {
- fieldmap2.insert(std::make_pair(colnames[i],GetValue(currentrow, i)));
- }
- currentrow++;
- }
-
- return fieldmap2;
- }
-
- virtual SQLfieldList* GetRowPtr()
- {
- SQLfieldList* fieldlist = new SQLfieldList();
-
- if (currentrow < rows)
- {
- for (int i = 0; i < Rows(); i++)
- {
- fieldlist->push_back(fieldlists[currentrow][i]);
- }
+ result.assign(fieldlists[currentrow].begin(), fieldlists[currentrow].end());
currentrow++;
+ return true;
}
- return fieldlist;
- }
-
- virtual SQLfieldMap* GetRowMapPtr()
- {
- fieldmap = new SQLfieldMap();
-
- if (currentrow < rows)
+ else
{
- for (int i = 0; i < Cols(); i++)
- {
- fieldmap->insert(std::make_pair(colnames[i],GetValue(currentrow, i)));
- }
- currentrow++;
+ result.clear();
+ return false;
}
-
- return fieldmap;
- }
-
- virtual void Free(SQLfieldMap* fm)
- {
- delete fm;
- }
-
- virtual void Free(SQLfieldList* fl)
- {
- delete fl;
}
};
-class SQLConnection;
-
-void NotifyMainThread(SQLConnection* connection_with_new_result);
-
/** Represents a connection to a mysql database
*/
-class SQLConnection : public classbase
+class SQLConnection : public SQL::Provider
{
- protected:
+ 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<char> 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<unsigned long>(-1))
+ {
+ SQL::Error err(SQL::QSEND_FAIL, InspIRCd::Format("%u: %s", mysql_errno(connection), mysql_error(connection)));
+ query->OnError(err);
+ return false;
+ }
- MYSQL connection;
- MYSQL_RES *res;
- MYSQL_ROW row;
- SQLhost host;
- std::map<std::string,std::string> thisrow;
- bool Enabled;
+ out.append(&buffer[0], escapedsize);
+ return true;
+ }
public:
-
- QueryQueue queue;
- ResultQueue rq;
+ reference<ConfigTag> config;
+ MYSQL *connection;
+ Mutex lock;
// This constructor creates an SQLConnection object with the given credentials, but does not connect yet.
- SQLConnection(const SQLhost &hi) : host(hi), Enabled(false)
+ 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;
- mysql_init(&connection);
- mysql_options(&connection,MYSQL_OPT_CONNECT_TIMEOUT,(char*)&timeout);
- return mysql_real_connect(&connection, host.host.c_str(), host.user.c_str(), host.pass.c_str(), host.name.c_str(), host.port, NULL, 0);
- }
-
- void DoLeadingQuery()
- {
- if (!CheckConnection())
- return;
-
- /* Parse the command string and dispatch it to mysql */
- SQLrequest& req = queue.front();
-
- /* Pointer to the buffer we screw around with substitution in */
- char* query;
-
- /* Pointer to the current end of query, where we append new stuff */
- char* queryend;
-
- /* Total length of the unescaped parameters */
- unsigned long paramlen;
+ connection = mysql_init(connection);
- /* Total length of query, used for binary-safety in mysql_real_query */
- unsigned long querylength = 0;
+ // Set the connection timeout.
+ unsigned int timeout = config->getDuration("timeout", 5, 1, 30);
+ mysql_options(connection, MYSQL_OPT_CONNECT_TIMEOUT, &timeout);
- paramlen = 0;
-
- for(ParamL::iterator i = req.query.p.begin(); i != req.query.p.end(); i++)
+ // 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))
{
- paramlen += i->size();
+ ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Unable to connect to the %s MySQL server: %s",
+ GetId().c_str(), mysql_error(connection));
+ return false;
}
- /* To avoid a lot of allocations, allocate enough memory for the biggest the escaped query could possibly be.
- * sizeofquery + (totalparamlength*2) + 1
- *
- * The +1 is for null-terminating the string for mysql_real_escape_string
- */
-
- query = new char[req.query.q.length() + (paramlen*2) + 1];
- queryend = query;
-
- /* Okay, now we have a buffer large enough we need to start copying the query into it and escaping and substituting
- * the parameters into it...
- */
-
- for(unsigned long i = 0; i < req.query.q.length(); i++)
+ // Set the default character set.
+ const std::string charset = config->getString("charset");
+ if (!charset.empty() && mysql_set_character_set(connection, charset.c_str()))
{
- if(req.query.q[i] == '?')
- {
- /* We found a place to substitute..what fun.
- * use mysql calls to escape and write the
- * escaped string onto the end of our query buffer,
- * then we "just" need to make sure queryend is
- * pointing at the right place.
- */
- if(req.query.p.size())
- {
- unsigned long len = mysql_real_escape_string(&connection, queryend, req.query.p.front().c_str(), req.query.p.front().length());
+ 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;
+ }
- queryend += len;
- req.query.p.pop_front();
- }
- else
- break;
- }
- else
- {
- *queryend = req.query.q[i];
- queryend++;
- }
- querylength++;
+ // 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;
}
- *queryend = 0;
+ return true;
+ }
+
+ ModuleSQL* Parent()
+ {
+ return (ModuleSQL*)(Module*)creator;
+ }
- pthread_mutex_lock(&queue_mutex);
- req.query.q = query;
- pthread_mutex_unlock(&queue_mutex);
+ MySQLresult* DoBlockingQuery(const std::string& query)
+ {
- if (!mysql_real_query(&connection, req.query.q.data(), req.query.q.length()))
+ /* Parse the command string and dispatch it to mysql */
+ if (CheckConnection() && !mysql_real_query(connection, query.data(), query.length()))
{
- /* Successfull query */
- res = mysql_use_result(&connection);
- unsigned long rows = mysql_affected_rows(&connection);
- MySQLresult* r = new MySQLresult(SQLModule, req.GetSource(), res, rows, req.id);
- r->dbid = this->GetID();
- r->query = req.query.q;
- /* Put this new result onto the results queue.
- * XXX: Remember to mutex the queue!
- */
- pthread_mutex_lock(&results_mutex);
- rq.push_back(r);
- pthread_mutex_unlock(&results_mutex);
+ /* Successful 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(QREPLY_FAIL, ConvToStr(mysql_errno(&connection)) + std::string(": ") + mysql_error(&connection));
- MySQLresult* r = new MySQLresult(SQLModule, req.GetSource(), e, req.id);
- r->dbid = this->GetID();
- r->query = req.query.q;
-
- pthread_mutex_lock(&results_mutex);
- rq.push_back(r);
- pthread_mutex_unlock(&results_mutex);
+ SQL::Error e(SQL::QREPLY_FAIL, InspIRCd::Format("%u: %s", mysql_errno(connection), mysql_error(connection)));
+ return new MySQLresult(e);
}
-
- /* Now signal the main thread that we've got a result to process.
- * Pass them this connection id as what to examine
- */
-
- delete[] query;
-
- NotifyMainThread(this);
- }
-
- bool ConnectionLost()
- {
- if (&connection) {
- return (mysql_ping(&connection) != 0);
- }
- else return false;
}
bool CheckConnection()
{
- if (ConnectionLost()) {
+ if (!connection || mysql_ping(connection) != 0)
return Connect();
- }
- else return true;
- }
-
- std::string GetError()
- {
- return mysql_error(&connection);
- }
-
- const std::string& GetID()
- {
- return host.id;
- }
-
- std::string GetHost()
- {
- return host.host;
- }
-
- void SetEnable(bool Enable)
- {
- Enabled = Enable;
+ return true;
}
- bool IsEnabled()
+ void Submit(SQL::Query* q, const std::string& qs) CXX11_OVERRIDE
{
- return Enabled;
+ ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Executing MySQL query: " + qs);
+ Parent()->Dispatcher->LockQueue();
+ Parent()->qq.push_back(QueryQueueItem(q, qs, this));
+ Parent()->Dispatcher->UnlockQueueWakeup();
}
- void Close()
+ void Submit(SQL::Query* call, const std::string& q, const SQL::ParamList& p) CXX11_OVERRIDE
{
- mysql_close(&connection);
+ 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() && !EscapeString(call, p[param++], res))
+ return;
+ }
+ Submit(call, res);
}
- const SQLhost& GetConfHost()
+ void Submit(SQL::Query* call, const std::string& q, const SQL::ParamMap& p) CXX11_OVERRIDE
{
- return host;
+ 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() && !EscapeString(call, it->second, res))
+ return;
+ }
+ }
+ Submit(call, res);
}
-
};
-ConnMap Connections;
-
-bool HasHost(const SQLhost &host)
+ModuleSQL::ModuleSQL()
+ : Dispatcher(NULL)
{
- for (ConnMap::iterator iter = Connections.begin(); iter != Connections.end(); iter++)
- {
- if (host == iter->second->GetConfHost())
- return true;
- }
- return false;
}
-bool HostInConf(ConfigReader* conf, const SQLhost &h)
+void ModuleSQL::init()
{
- for(int i = 0; i < conf->Enumerate("database"); i++)
- {
- SQLhost host;
- host.id = conf->ReadValue("database", "id", i);
- host.host = conf->ReadValue("database", "hostname", i);
- host.port = conf->ReadInteger("database", "port", i, true);
- host.name = conf->ReadValue("database", "name", i);
- host.user = conf->ReadValue("database", "username", i);
- host.pass = conf->ReadValue("database", "password", i);
- host.ssl = conf->ReadFlag("database", "ssl", i);
- if (h == host)
- return true;
- }
- return false;
-}
+ if (mysql_library_init(0, NULL, NULL))
+ throw ModuleException("Unable to initialise the MySQL library!");
-void ClearOldConnections(ConfigReader* conf)
-{
- ConnMap::iterator i,safei;
- for (i = Connections.begin(); i != Connections.end(); i++)
- {
- if (!HostInConf(conf, i->second->GetConfHost()))
- {
- DELETE(i->second);
- safei = i;
- --i;
- Connections.erase(safei);
- }
- }
+ Dispatcher = new DispatcherThread(this);
+ ServerInstance->Threads.Start(Dispatcher);
}
-void ClearAllConnections()
+ModuleSQL::~ModuleSQL()
{
- ConnMap::iterator i;
- while ((i = Connections.begin()) != Connections.end())
+ if (Dispatcher)
{
- Connections.erase(i);
- DELETE(i->second);
+ Dispatcher->join();
+ Dispatcher->OnNotify();
+ delete Dispatcher;
}
-}
-void ConnectDatabases(InspIRCd* ServerInstance)
-{
- for (ConnMap::iterator i = Connections.begin(); i != Connections.end(); i++)
+ for(ConnMap::iterator i = connections.begin(); i != connections.end(); i++)
{
- if (i->second->IsEnabled())
- continue;
-
- i->second->SetEnable(true);
- if (!i->second->Connect())
- {
- /* XXX: MUTEX */
- pthread_mutex_lock(&logging_mutex);
- ServerInstance->Log(DEFAULT,"SQL: Failed to connect database "+i->second->GetHost()+": Error: "+i->second->GetError());
- i->second->SetEnable(false);
- pthread_mutex_unlock(&logging_mutex);
- }
+ delete i->second;
}
+
+ mysql_library_end();
}
-void LoadDatabases(ConfigReader* conf, InspIRCd* ServerInstance)
+void ModuleSQL::ReadConfig(ConfigStatus& status)
{
- ClearOldConnections(conf);
- for (int j =0; j < conf->Enumerate("database"); j++)
+ ConnMap conns;
+ ConfigTagList tags = ServerInstance->Config->ConfTags("database");
+ for(ConfigIter i = tags.first; i != tags.second; i++)
{
- SQLhost host;
- host.id = conf->ReadValue("database", "id", j);
- host.host = conf->ReadValue("database", "hostname", j);
- host.port = conf->ReadInteger("database", "port", j, true);
- host.name = conf->ReadValue("database", "name", j);
- host.user = conf->ReadValue("database", "username", j);
- host.pass = conf->ReadValue("database", "password", j);
- host.ssl = conf->ReadFlag("database", "ssl", j);
-
- if (HasHost(host))
+ if (!stdalgo::string::equalsci(i->second->getString("module"), "mysql"))
continue;
-
- if (!host.id.empty() && !host.host.empty() && !host.name.empty() && !host.user.empty() && !host.pass.empty())
+ std::string id = i->second->getString("id");
+ ConnMap::iterator curr = connections.find(id);
+ if (curr == connections.end())
{
- SQLConnection* ThisSQL = new SQLConnection(host);
- Connections[host.id] = ThisSQL;
+ SQLConnection* conn = new SQLConnection(this, i->second);
+ conns.insert(std::make_pair(id, conn));
+ ServerInstance->Modules->AddService(*conn);
}
- }
- ConnectDatabases(ServerInstance);
-}
-
-void NotifyMainThread(SQLConnection* connection_with_new_result)
-{
- /* Here we write() to the socket the main thread has open
- * and we connect()ed back to before our thread became active.
- * The main thread is using a nonblocking socket tied into
- * the socket engine, so they wont block and they'll receive
- * nearly instant notification. Because we're in a seperate
- * thread, we can just use standard connect(), and we can
- * block if we like. We just send the connection id of the
- * connection back.
- */
- send(QueueFD, connection_with_new_result->GetID().c_str(), connection_with_new_result->GetID().length()+1, 0);
-}
-
-void* DispatcherThread(void* arg);
-
-/** Used by m_mysql to notify one thread when the other has a result
- */
-class Notifier : public InspSocket
-{
- insp_sockaddr sock_us;
- socklen_t uslen;
-
-
- public:
-
- /* Create a socket on a random port. Let the tcp stack allocate us an available port */
-#ifdef IPV6
- Notifier(InspIRCd* SI) : InspSocket(SI, "::1", 0, true, 3000)
-#else
- Notifier(InspIRCd* SI) : InspSocket(SI, "127.0.0.1", 0, true, 3000)
-#endif
- {
- uslen = sizeof(sock_us);
- if (getsockname(this->fd,(sockaddr*)&sock_us,&uslen))
+ else
{
- throw ModuleException("Could not create random listening port on localhost");
+ conns.insert(*curr);
+ connections.erase(curr);
}
}
- Notifier(InspIRCd* SI, int newfd, char* ip) : InspSocket(SI, newfd, ip)
- {
- Instance->Log(DEBUG,"Constructor of new socket");
- }
-
- /* Using getsockname and ntohs, we can determine which port number we were allocated */
- int GetPort()
- {
-#ifdef IPV6
- return ntohs(sock_us.sin6_port);
-#else
- return ntohs(sock_us.sin_port);
-#endif
- }
-
- virtual int OnIncomingConnection(int newsock, char* ip)
- {
- Instance->Log(DEBUG,"Inbound connection on fd %d!",newsock);
- Notifier* n = new Notifier(this->Instance, newsock, ip);
- n = n; /* Stop bitching at me, GCC */
- return true;
- }
-
- virtual bool OnDataReady()
+ // now clean up the deleted databases
+ Dispatcher->LockQueue();
+ SQL::Error err(SQL::BAD_DBID);
+ for(ConnMap::iterator i = connections.begin(); i != connections.end(); i++)
{
- Instance->Log(DEBUG,"Inbound data!");
- char* data = this->Read();
- ConnMap::iterator iter;
-
- if (data && *data)
+ 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--)
{
- Instance->Log(DEBUG,"Looking for connection %s",data);
- /* We expect to be sent a null terminated string */
- if((iter = Connections.find(data)) != Connections.end())
+ size_t k = j - 1;
+ if (qq[k].connection == i->second)
{
- Instance->Log(DEBUG,"Found it!");
-
- /* Lock the mutex, send back the data */
- pthread_mutex_lock(&results_mutex);
- ResultQueue::iterator n = iter->second->rq.begin();
- (*n)->Send();
- iter->second->rq.pop_front();
- pthread_mutex_unlock(&results_mutex);
- return true;
+ qq[k].query->OnError(err);
+ delete qq[k].query;
+ qq.erase(qq.begin() + k);
}
}
-
- return false;
+ // finally, nuke the connection
+ delete i->second;
}
-};
+ Dispatcher->UnlockQueue();
+ connections.swap(conns);
+}
-/** MySQL module
- */
-class ModuleSQL : public Module
+void ModuleSQL::OnUnloadModule(Module* mod)
{
- public:
-
- ConfigReader *Conf;
- InspIRCd* PublicServerInstance;
- pthread_t Dispatcher;
- int currid;
- bool rehashing;
-
- ModuleSQL(InspIRCd* Me)
- : Module::Module(Me), rehashing(false)
+ SQL::Error err(SQL::BAD_DBID);
+ Dispatcher->LockQueue();
+ unsigned int i = qq.size();
+ while (i > 0)
{
- ServerInstance->UseInterface("SQLutils");
-
- Conf = new ConfigReader(ServerInstance);
- PublicServerInstance = ServerInstance;
- currid = 0;
- SQLModule = this;
-
- MessagePipe = new Notifier(ServerInstance);
- ServerInstance->Log(DEBUG,"Bound notifier to 127.0.0.1:%d",MessagePipe->GetPort());
-
- pthread_attr_t attribs;
- pthread_attr_init(&attribs);
- pthread_attr_setdetachstate(&attribs, PTHREAD_CREATE_DETACHED);
- if (pthread_create(&this->Dispatcher, &attribs, DispatcherThread, (void *)this) != 0)
+ i--;
+ if (qq[i].query->creator == mod)
{
- throw ModuleException("m_mysql: Failed to create dispatcher thread: " + std::string(strerror(errno)));
- }
-
- if (!ServerInstance->PublishFeature("SQL", this))
- {
- /* Tell worker thread to exit NOW */
- giveup = true;
- throw ModuleException("m_mysql: Unable to publish feature 'SQL'");
- }
-
- ServerInstance->PublishInterface("SQL", this);
- }
-
- virtual ~ModuleSQL()
- {
- giveup = true;
- ClearAllConnections();
- DELETE(Conf);
- ServerInstance->UnpublishInterface("SQL", this);
- ServerInstance->UnpublishFeature("SQL");
- ServerInstance->DoneWithInterface("SQLutils");
- }
-
-
- void Implements(char* List)
- {
- List[I_OnRehash] = List[I_OnRequest] = 1;
- }
-
- unsigned long NewID()
- {
- if (currid+1 == 0)
- currid++;
- return ++currid;
- }
-
- char* OnRequest(Request* request)
- {
- if(strcmp(SQLREQID, request->GetId()) == 0)
- {
- SQLrequest* req = (SQLrequest*)request;
-
- /* XXX: Lock */
- pthread_mutex_lock(&queue_mutex);
-
- ConnMap::iterator iter;
-
- char* returnval = NULL;
-
- ServerInstance->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());
-
- if((iter = Connections.find(req->dbid)) != Connections.end())
+ if (i == 0)
{
- req->id = NewID();
- iter->second->queue.push(*req);
- returnval = SQLSUCCESS;
+ // need to wait until the query is done
+ // (the result will be discarded)
+ qq[i].connection->lock.Lock();
+ qq[i].connection->lock.Unlock();
}
- else
- {
- req->error.Id(BAD_DBID);
- }
-
- pthread_mutex_unlock(&queue_mutex);
- /* XXX: Unlock */
-
- return returnval;
+ qq[i].query->OnError(err);
+ delete qq[i].query;
+ qq.erase(qq.begin() + i);
}
-
- ServerInstance->Log(DEBUG, "Got unsupported API version string: %s", request->GetId());
-
- return NULL;
- }
-
- virtual void OnRehash(userrec* user, const std::string ¶meter)
- {
- rehashing = true;
}
-
- virtual Version GetVersion()
- {
- return Version(1,1,0,0,VF_VENDOR|VF_SERVICEPROVIDER,API_VERSION);
- }
-
-};
+ Dispatcher->UnlockQueue();
+ // clean up any result queue entries
+ Dispatcher->OnNotify();
+}
-void* DispatcherThread(void* arg)
+Version ModuleSQL::GetVersion()
{
- ModuleSQL* thismodule = (ModuleSQL*)arg;
- LoadDatabases(thismodule->Conf, thismodule->PublicServerInstance);
-
- /* Connect back to the Notifier */
-
- if ((QueueFD = socket(AF_FAMILY, SOCK_STREAM, 0)) == -1)
- {
- /* crap, we're out of sockets... */
- return NULL;
- }
-
- insp_sockaddr addr;
-
-#ifdef IPV6
- insp_aton("::1", &addr.sin6_addr);
- addr.sin6_family = AF_FAMILY;
- addr.sin6_port = htons(MessagePipe->GetPort());
-#else
- insp_inaddr ia;
- insp_aton("127.0.0.1", &ia);
- addr.sin_family = AF_FAMILY;
- addr.sin_addr = ia;
- addr.sin_port = htons(MessagePipe->GetPort());
-#endif
-
- if (connect(QueueFD, (sockaddr*)&addr,sizeof(addr)) == -1)
- {
- /* wtf, we cant connect to it, but we just created it! */
- return NULL;
- }
+ return Version("Provides the ability for SQL modules to query a MySQL database.", VF_VENDOR);
+}
- while (!giveup)
+void DispatcherThread::Run()
+{
+ this->LockQueue();
+ while (!this->GetExitFlag())
{
- if (thismodule->rehashing)
+ if (!Parent->qq.empty())
{
- /* XXX: Lock */
- pthread_mutex_lock(&queue_mutex);
- thismodule->rehashing = false;
- LoadDatabases(thismodule->Conf, thismodule->PublicServerInstance);
- pthread_mutex_unlock(&queue_mutex);
- /* XXX: Unlock */
- }
+ QueryQueueItem i = Parent->qq.front();
+ i.connection->lock.Lock();
+ this->UnlockQueue();
+ MySQLresult* res = i.connection->DoBlockingQuery(i.querystr);
+ i.connection->lock.Unlock();
+
+ /*
+ * At this point, the main thread could be working on:
+ * 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.
+ */
- SQLConnection* conn = NULL;
- /* XXX: Lock here for safety */
- pthread_mutex_lock(&queue_mutex);
- for (ConnMap::iterator i = Connections.begin(); i != Connections.end(); i++)
- {
- if (i->second->queue.totalsize())
+ this->LockQueue();
+ if (!Parent->qq.empty() && Parent->qq.front().query == i.query)
+ {
+ Parent->qq.pop_front();
+ Parent->rq.push_back(ResultQueueItem(i.query, res));
+ NotifyParent();
+ }
+ else
{
- conn = i->second;
- break;
+ // UnloadModule ate the query
+ delete res;
}
}
- pthread_mutex_unlock(&queue_mutex);
- /* XXX: Unlock */
-
- /* Theres an item! */
- if (conn)
+ else
{
- conn->DoLeadingQuery();
-
- /* XXX: Lock */
- pthread_mutex_lock(&queue_mutex);
- conn->queue.pop();
- pthread_mutex_unlock(&queue_mutex);
- /* XXX: Unlock */
+ /* We know the queue is empty, we can safely hang this thread until
+ * something happens
+ */
+ this->WaitForQueue();
}
-
- usleep(50);
}
-
- return NULL;
+ this->UnlockQueue();
}
-
-// stuff down here is the module-factory stuff. For basic modules you can ignore this.
-
-class ModuleSQLFactory : public ModuleFactory
+void DispatcherThread::OnNotify()
{
- public:
- ModuleSQLFactory()
+ // 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++)
{
+ MySQLresult* res = i->result;
+ if (res->err.code == SQL::SUCCESS)
+ i->query->OnResult(*res);
+ else
+ i->query->OnError(res->err);
+ delete i->query;
+ delete i->result;
}
-
- ~ModuleSQLFactory()
- {
- }
-
- virtual Module * CreateModule(InspIRCd* Me)
- {
- return new ModuleSQL(Me);
- }
-
-};
-
-
-extern "C" void * init_module( void )
-{
- return new ModuleSQLFactory;
+ Parent->rq.clear();
+ this->UnlockQueue();
}
+
+MODULE_INIT(ModuleSQL)
projects / user / henk / code / inspircd.git / blobdiff