-/* +------------------------------------+
- * | Inspire Internet Relay Chat Daemon |
- * +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
*
- * InspIRCd is copyright (C) 2002-2004 ChatSpike-Dev.
- * E-mail:
- * <brain@chatspike.net>
- * <Craig@chatspike.net>
- * <omster@gmail.com>
- *
- * 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 <danieldg@inspircd.org>
+ * Copyright (C) 2006-2007, 2009 Dennis Friis <peavey@inspircd.org>
+ * Copyright (C) 2006-2007, 2009 Craig Edwards <craigedwards@brainbox.cc>
+ * Copyright (C) 2008 Robin Burchell <robin+git@viroteck.net>
+ * Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
+ * Copyright (C) 2006 Oliver Lupton <oliverlupton@gmail.com>
*
- * ---------------------------------------------------
+ * 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 "inspircd.h"
#include <cstdlib>
#include <sstream>
-#include <string>
-#include <deque>
-#include <map>
#include <libpq-fe.h>
-
-#include "users.h"
-#include "channels.h"
-#include "modules.h"
-
-#include "inspircd.h"
-#include "configreader.h"
-
-#include "m_sqlv2.h"
+#include "sql.h"
/* $ModDesc: PostgreSQL Service Provider module for all other m_sql* modules, uses v2 of the SQL API */
-/* $CompileFlags: -I`pg_config --includedir` `perl extra/pgsql_config.pl` */
-/* $LinkerFlags: -L`pg_config --libdir` -lpq */
-
-/* UGH, UGH, UGH, UGH, UGH, UGH
- * I'm having trouble seeing how I
- * can avoid this. The core-defined
- * constructors for InspSocket just
- * aren't suitable...and if I'm
- * reimplementing them I need this so
- * I can access the socket engine :\
+/* $CompileFlags: -Iexec("pg_config --includedir") eval("my $s = `pg_config --version`;$s =~ /^.*?(\d+)\.(\d+)\.(\d+).*?$/;my $v = hex(sprintf("0x%02x%02x%02x", $1, $2, $3));print "-DPGSQL_HAS_ESCAPECONN" if(($v >= 0x080104) || ($v >= 0x07030F && $v < 0x070400) || ($v >= 0x07040D && $v < 0x080000) || ($v >= 0x080008 && $v < 0x080100));") */
+/* $LinkerFlags: -Lexec("pg_config --libdir") -lpq */
+
+/* SQLConn rewritten by peavey to
+ * use EventHandler instead of
+ * BufferedSocket. This is much neater
+ * and gives total control of destroy
+ * and delete of resources.
*/
/* Forward declare, so we can have the typedef neatly at the top */
class SQLConn;
-/* Also needs forward declaration, as it's used inside SQLconn */
class ModulePgSQL;
typedef std::map<std::string, SQLConn*> ConnMap;
*/
enum SQLstatus { CREAD, CWRITE, WREAD, WWRITE, RREAD, RWRITE };
-/** SQLhost, simple structure to store information about a SQL-connection-to-be
- * We use this struct simply to make it neater passing around host information
- * when we're creating connections and resolving hosts.
- * Rather than giving SQLresolver a parameter for every field here so it can in
- * turn call SQLConn's constructor with them all, both can simply use a SQLhost.
- */
-class SQLhost
-{
- public:
- std::string id; /* Database handle id */
- std::string host; /* Database server hostname */
- unsigned int port; /* Database server port */
- std::string name; /* Database name */
- std::string user; /* Database username */
- std::string pass; /* Database password */
- bool ssl; /* If we should require SSL */
-
- SQLhost()
- {
- }
-
- SQLhost(const std::string& i, const std::string& h, unsigned int p, const std::string& n, const std::string& u, const std::string& pa, bool s)
- : id(i), host(h), port(p), name(n), user(u), pass(pa), ssl(s)
- {
- }
-};
-
-/** Used to resolve sql server hostnames
- */
-class SQLresolver : public Resolver
+class ReconnectTimer : public Timer
{
private:
- SQLhost host;
ModulePgSQL* mod;
public:
- SQLresolver(ModulePgSQL* m, InspIRCd* Instance, const SQLhost& hi)
- : Resolver(Instance, hi.host, DNS_QUERY_FORWARD, (Module*)m), host(hi), mod(m)
- {
- }
-
- virtual void OnLookupComplete(const std::string &result);
-
- virtual void OnError(ResolverError e, const std::string &errormessage)
- {
- ServerInstance->Log(DEBUG, "DNS lookup failed (%s), dying horribly", errormessage.c_str());
- }
-
- virtual ~SQLresolver()
+ ReconnectTimer(ModulePgSQL* m) : Timer(5, ServerInstance->Time(), false), mod(m)
{
}
+ virtual void Tick(time_t TIME);
};
-/** QueryQueue, a queue of queries waiting to be executed.
- * This maintains two queues internally, one for 'priority'
- * queries and one for less important ones. Each queue has
- * new queries appended to it and ones to execute are popped
- * off the front. This keeps them flowing round nicely and no
- * query should ever get 'stuck' for too long. If there are
- * queries in the priority queue they will be executed first,
- * 'unimportant' queries will only be executed when the
- * priority queue is empty.
- *
- * We store lists of SQLrequest's here, by value as we want to avoid storing
- * any data allocated inside the client module (in case that module is unloaded
- * while the query is in progress).
- *
- * Because we want to work on the current SQLrequest in-situ, we need a way
- * of accessing the request we are currently processing, QueryQueue::front(),
- * but that call needs to always return the same request until that request
- * is removed from the queue, this is what the 'which' variable is. New queries are
- * always added to the back of one of the two queues, but if when front()
- * is first called then the priority queue is empty then front() will return
- * a query from the normal queue, but if a query is then added to the priority
- * queue then front() must continue to return the front of the *normal* queue
- * until pop() is called.
- */
-
-class QueryQueue : public classbase
+struct QueueItem
{
-private:
- typedef std::deque<SQLrequest> ReqDeque;
-
- 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 */
-
-public:
- QueryQueue()
- : which(NON)
- {
- }
-
- void push(const SQLrequest &q)
- {
- //ServerInstance->Log(DEBUG, "QueryQueue::push(): Adding %s query to queue: %s", ((q.pri) ? "priority" : "non-priority"), q.query.q.c_str());
-
- if(q.pri)
- priority.push_back(q);
- else
- normal.push_back(q);
- }
-
- void pop()
- {
- 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();
- }
-
- void PurgeModule(Module* mod)
- {
- DoPurgeModule(mod, priority);
- DoPurgeModule(mod, normal);
- }
-
-private:
- void DoPurgeModule(Module* mod, ReqDeque& q)
- {
- 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);
- }
- }
- }
- }
+ SQLQuery* c;
+ std::string q;
+ QueueItem(SQLQuery* C, const std::string& Q) : c(C), q(Q) {}
};
/** PgSQLresult is a subclass of the mostly-pure-virtual class SQLresult.
* data is passes to the module nearly as directly as if it was using the API directly itself.
*/
-class PgSQLresult : public SQLresult
+class PgSQLresult : public SQLResult
{
PGresult* res;
int currentrow;
int rows;
- int cols;
-
- SQLfieldList* fieldlist;
- SQLfieldMap* fieldmap;
-public:
- PgSQLresult(Module* self, Module* to, unsigned long id, PGresult* result)
- : SQLresult(self, to, id), res(result), currentrow(0), fieldlist(NULL), fieldmap(NULL)
+ public:
+ PgSQLresult(PGresult* result) : res(result), currentrow(0)
{
rows = PQntuples(res);
- cols = PQnfields(res);
-
- //ServerInstance->Log(DEBUG, "Created new PgSQL result; %d rows, %d columns, %s affected", rows, cols, PQcmdTuples(res));
+ if (!rows)
+ rows = atoi(PQcmdTuples(res));
}
-
+
~PgSQLresult()
{
- /* If we allocated these, free them... */
- if(fieldlist)
- DELETE(fieldlist);
-
- if(fieldmap)
- DELETE(fieldmap);
-
PQclear(res);
}
-
+
virtual int Rows()
{
- if(!cols && !rows)
- {
- return atoi(PQcmdTuples(res));
- }
- else
- {
- return rows;
- }
+ return rows;
}
-
- virtual int Cols()
+
+ virtual void GetCols(std::vector<std::string>& result)
{
- return PQnfields(res);
+ result.resize(PQnfields(res));
+ for(unsigned int i=0; i < result.size(); i++)
+ {
+ result[i] = PQfname(res, i);
+ }
}
-
- virtual std::string ColName(int column)
+
+ virtual SQLEntry GetValue(int row, int column)
{
- char* name = PQfname(res, column);
-
- return (name) ? name : "";
+ char* v = PQgetvalue(res, row, column);
+ if (!v || PQgetisnull(res, row, column))
+ return SQLEntry();
+
+ return SQLEntry(std::string(v, PQgetlength(res, row, column)));
}
-
- virtual int ColNum(const std::string &column)
+
+ virtual bool GetRow(SQLEntries& result)
{
- int n = PQfnumber(res, column.c_str());
-
- if(n == -1)
- {
- throw SQLbadColName();
- }
- else
+ if (currentrow >= PQntuples(res))
+ return false;
+ int ncols = PQnfields(res);
+
+ for(int i = 0; i < ncols; i++)
{
- return n;
+ result.push_back(GetValue(currentrow, i));
}
+ currentrow++;
+
+ return true;
}
-
- virtual SQLfield GetValue(int row, int column)
+};
+
+/** SQLConn represents one SQL session.
+ */
+class SQLConn : public SQLProvider, public EventHandler
+{
+ public:
+ reference<ConfigTag> conf; /* The <database> entry */
+ std::deque<QueueItem> queue;
+ PGconn* sql; /* PgSQL database connection handle */
+ SQLstatus status; /* PgSQL database connection status */
+ QueueItem qinprog; /* If there is currently a query in progress */
+
+ SQLConn(Module* Creator, ConfigTag* tag)
+ : SQLProvider(Creator, "SQL/" + tag->getString("id")), conf(tag), sql(NULL), status(CWRITE), qinprog(NULL, "")
{
- char* v = PQgetvalue(res, row, column);
-
- if(v)
+ if (!DoConnect())
{
- return SQLfield(std::string(v, PQgetlength(res, row, column)), PQgetisnull(res, row, column));
- }
- else
- {
- //ServerInstance->Log(DEBUG, "PQgetvalue returned a null pointer..nobody wants to tell us what this means");
- throw SQLbadColName();
+ ServerInstance->Logs->Log("m_pgsql",DEFAULT, "WARNING: Could not connect to database " + tag->getString("id"));
+ DelayReconnect();
}
}
-
- virtual SQLfieldList& GetRow()
+
+ CullResult cull()
{
- /* In an effort to reduce overhead we don't actually allocate the list
- * until the first time it's needed...so...
- */
- if(fieldlist)
- {
- fieldlist->clear();
- }
- else
- {
- fieldlist = new SQLfieldList;
- }
-
- if(currentrow < PQntuples(res))
- {
- int cols = PQnfields(res);
-
- for(int i = 0; i < cols; i++)
- {
- fieldlist->push_back(GetValue(currentrow, i));
- }
-
- currentrow++;
- }
-
- return *fieldlist;
+ this->SQLProvider::cull();
+ ServerInstance->Modules->DelService(*this);
+ return this->EventHandler::cull();
}
-
- virtual SQLfieldMap& GetRowMap()
+
+ ~SQLConn()
{
- /* In an effort to reduce overhead we don't actually allocate the map
- * until the first time it's needed...so...
- */
- if(fieldmap)
+ SQLerror err(SQL_BAD_DBID);
+ if (qinprog.c)
{
- fieldmap->clear();
+ qinprog.c->OnError(err);
+ delete qinprog.c;
}
- else
+ for(std::deque<QueueItem>::iterator i = queue.begin(); i != queue.end(); i++)
{
- fieldmap = new SQLfieldMap;
+ SQLQuery* q = i->c;
+ q->OnError(err);
+ delete q;
}
-
- if(currentrow < PQntuples(res))
- {
- int cols = PQnfields(res);
-
- for(int i = 0; i < cols; i++)
- {
- fieldmap->insert(std::make_pair(ColName(i), GetValue(currentrow, i)));
- }
-
- currentrow++;
- }
-
- return *fieldmap;
- }
-
- virtual SQLfieldList* GetRowPtr()
- {
- SQLfieldList* fl = new SQLfieldList;
-
- if(currentrow < PQntuples(res))
- {
- int cols = PQnfields(res);
-
- for(int i = 0; i < cols; i++)
- {
- fl->push_back(GetValue(currentrow, i));
- }
-
- currentrow++;
- }
-
- return fl;
}
-
- virtual SQLfieldMap* GetRowMapPtr()
+
+ virtual void HandleEvent(EventType et, int errornum)
{
- SQLfieldMap* fm = new SQLfieldMap;
-
- if(currentrow < PQntuples(res))
+ switch (et)
{
- int cols = PQnfields(res);
-
- for(int i = 0; i < cols; i++)
- {
- fm->insert(std::make_pair(ColName(i), GetValue(currentrow, i)));
- }
-
- currentrow++;
+ case EVENT_READ:
+ case EVENT_WRITE:
+ DoEvent();
+ break;
+
+ case EVENT_ERROR:
+ DelayReconnect();
}
-
- return fm;
}
-
- virtual void Free(SQLfieldMap* fm)
+
+ std::string GetDSN()
{
- DELETE(fm);
+ std::ostringstream conninfo("connect_timeout = '5'");
+ std::string item;
+
+ if (conf->readString("host", item))
+ conninfo << " host = '" << item << "'";
+
+ if (conf->readString("port", item))
+ conninfo << " port = '" << item << "'";
+
+ if (conf->readString("name", item))
+ conninfo << " dbname = '" << item << "'";
+
+ if (conf->readString("user", item))
+ conninfo << " user = '" << item << "'";
+
+ if (conf->readString("pass", item))
+ conninfo << " password = '" << item << "'";
+
+ if (conf->getBool("ssl"))
+ conninfo << " sslmode = 'require'";
+ else
+ conninfo << " sslmode = 'disable'";
+
+ return conninfo.str();
}
-
- virtual void Free(SQLfieldList* fl)
+
+ bool DoConnect()
{
- DELETE(fl);
- }
-};
+ sql = PQconnectStart(GetDSN().c_str());
+ if (!sql)
+ return false;
-/** SQLConn represents one SQL session.
- * Each session has its own persistent connection to the database.
- * This is a subclass of InspSocket so it can easily recieve read/write events from the core socket
- * engine, unlike the original MySQL module this module does not block. Ever. It gets a mild stabbing
- * if it dares to.
- */
+ if(PQstatus(sql) == CONNECTION_BAD)
+ return false;
-class SQLConn : public InspSocket
-{
-private:
- ModulePgSQL* us; /* Pointer to the SQL provider itself */
- std::string dbhost; /* Database server hostname */
- unsigned int dbport; /* Database server port */
- std::string dbname; /* Database name */
- std::string dbuser; /* Database username */
- std::string dbpass; /* Database password */
- bool ssl; /* If we should require SSL */
- PGconn* sql; /* PgSQL database connection handle */
- SQLstatus status; /* PgSQL database connection status */
- bool qinprog;/* If there is currently a query in progress */
- QueryQueue queue; /* Queue of queries waiting to be executed on this connection */
- time_t idle; /* Time we last heard from the database */
-
-public:
-
- /* This class should only ever be created inside this module, using this constructor, so we don't have to worry about the default ones */
-
- SQLConn(InspIRCd* SI, ModulePgSQL* self, const SQLhost& hostinfo);
-
- ~SQLConn();
-
- bool DoConnect();
-
- virtual void Close();
-
- bool DoPoll();
-
- bool DoConnectedPoll();
-
- bool DoResetPoll();
-
- void ShowStatus();
-
- virtual bool OnDataReady();
-
- virtual bool OnWriteReady();
-
- virtual bool OnConnected();
-
- bool DoEvent();
-
- bool Reconnect();
-
- std::string MkInfoStr();
-
- const char* StatusStr();
-
- SQLerror DoQuery(SQLrequest &req);
-
- SQLerror Query(const SQLrequest &req);
-
- void OnUnloadModule(Module* mod);
-};
+ if(PQsetnonblocking(sql, 1) == -1)
+ return false;
-class ModulePgSQL : public Module
-{
-private:
-
- ConnMap connections;
- unsigned long currid;
- char* sqlsuccess;
+ /* OK, we've initalised the connection, now to get it hooked into the socket engine
+ * and then start polling it.
+ */
+ this->fd = PQsocket(sql);
-public:
- ModulePgSQL(InspIRCd* Me)
- : Module::Module(Me), currid(0)
- {
- ServerInstance->Log(DEBUG, "%s 'SQL' feature", ServerInstance->PublishFeature("SQL", this) ? "Published" : "Couldn't publish");
-
- sqlsuccess = new char[strlen(SQLSUCCESS)+1];
-
- strlcpy(sqlsuccess, SQLSUCCESS, strlen(SQLSUCCESS)+1);
+ if(this->fd <= -1)
+ return false;
+
+ if (!ServerInstance->SE->AddFd(this, FD_WANT_NO_WRITE | FD_WANT_NO_READ))
+ {
+ ServerInstance->Logs->Log("m_pgsql",DEBUG, "BUG: Couldn't add pgsql socket to socket engine");
+ return false;
+ }
- OnRehash("");
+ /* Socket all hooked into the engine, now to tell PgSQL to start connecting */
+ return DoPoll();
}
- void Implements(char* List)
+ bool DoPoll()
{
- List[I_OnUnloadModule] = List[I_OnRequest] = List[I_OnRehash] = List[I_OnUserRegister] = List[I_OnCheckReady] = List[I_OnUserDisconnect] = 1;
+ switch(PQconnectPoll(sql))
+ {
+ case PGRES_POLLING_WRITING:
+ ServerInstance->SE->ChangeEventMask(this, FD_WANT_POLL_WRITE | FD_WANT_NO_READ);
+ status = CWRITE;
+ return true;
+ case PGRES_POLLING_READING:
+ ServerInstance->SE->ChangeEventMask(this, FD_WANT_POLL_READ | FD_WANT_NO_WRITE);
+ status = CREAD;
+ return true;
+ case PGRES_POLLING_FAILED:
+ return false;
+ case PGRES_POLLING_OK:
+ ServerInstance->SE->ChangeEventMask(this, FD_WANT_POLL_READ | FD_WANT_NO_WRITE);
+ status = WWRITE;
+ DoConnectedPoll();
+ default:
+ return true;
+ }
}
- virtual void OnRehash(const std::string ¶meter)
+ void DoConnectedPoll()
{
- ConfigReader conf(ServerInstance);
-
- /* Delete all the SQLConn objects in the connection lists,
- * this will call their destructors where they can handle
- * closing connections and such.
- */
- for(ConnMap::iterator iter = connections.begin(); iter != connections.end(); iter++)
+restart:
+ while (qinprog.q.empty() && !queue.empty())
{
- DELETE(iter->second);
+ /* There's no query currently in progress, and there's queries in the queue. */
+ DoQuery(queue.front());
+ queue.pop_front();
}
-
- /* Empty out our list of connections */
- connections.clear();
- for(int i = 0; i < conf.Enumerate("database"); i++)
+ if (PQconsumeInput(sql))
{
- SQLhost host;
- int ipvalid;
- insp_inaddr blargle;
-
- 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);
-
- ipvalid = insp_aton(host.host.c_str(), &blargle);
-
- if(ipvalid > 0)
+ if (PQisBusy(sql))
{
- /* The conversion succeeded, we were given an IP and we can give it straight to SQLConn */
- this->AddConn(host);
+ /* Nothing happens here */
}
- else if(ipvalid == 0)
+ else if (qinprog.c)
{
- /* Conversion failed, assume it's a host */
- SQLresolver* resolver;
-
- try
+ /* Fetch the result.. */
+ PGresult* result = PQgetResult(sql);
+
+ /* PgSQL would allow a query string to be sent which has multiple
+ * queries in it, this isn't portable across database backends and
+ * we don't want modules doing it. But just in case we make sure we
+ * drain any results there are and just use the last one.
+ * If the module devs are behaving there will only be one result.
+ */
+ while (PGresult* temp = PQgetResult(sql))
{
- resolver = new SQLresolver(this, ServerInstance, host);
-
- ServerInstance->AddResolver(resolver);
+ PQclear(result);
+ result = temp;
}
- catch(...)
+
+ /* ..and the result */
+ PgSQLresult reply(result);
+ switch(PQresultStatus(result))
{
- ServerInstance->Log(DEBUG, "Couldn't make a SQLresolver..this connection is gonna diiiiiie...actually we just won't create it");
+ case PGRES_EMPTY_QUERY:
+ case PGRES_BAD_RESPONSE:
+ case PGRES_FATAL_ERROR:
+ {
+ SQLerror err(SQL_QREPLY_FAIL, PQresultErrorMessage(result));
+ qinprog.c->OnError(err);
+ break;
+ }
+ default:
+ /* Other values are not errors */
+ qinprog.c->OnResult(reply);
}
- }
- else
- {
- /* Invalid address family, die horribly. */
- ServerInstance->Log(DEBUG, "insp_aton failed returning -1, oh noes.");
- }
- }
- }
-
- void AddConn(const SQLhost& hi)
- {
- SQLConn* newconn;
-
- /* The conversion succeeded, we were given an IP and we can give it straight to SQLConn */
- newconn = new SQLConn(ServerInstance, this, hi);
-
- connections.insert(std::make_pair(hi.id, newconn));
- }
-
- virtual char* OnRequest(Request* request)
- {
- if(strcmp(SQLREQID, request->GetId()) == 0)
- {
- SQLrequest* req = (SQLrequest*)request;
- ConnMap::iterator iter;
-
- 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())
- {
- /* Execute query */
- req->id = NewID();
- req->error = iter->second->Query(*req);
-
- return (req->error.Id() == NO_ERROR) ? sqlsuccess : NULL;
+ delete qinprog.c;
+ qinprog = QueueItem(NULL, "");
+ goto restart;
}
else
{
- req->error.Id(BAD_DBID);
- return NULL;
+ qinprog.q.clear();
}
}
-
- ServerInstance->Log(DEBUG, "Got unsupported API version string: %s", request->GetId());
-
- return NULL;
- }
-
- virtual void OnUnloadModule(Module* mod, const std::string& name)
- {
- /* When a module unloads we have to check all the pending queries for all our connections
- * and set the Module* specifying where the query came from to NULL. If the query has already
- * been dispatched then when it is processed it will be dropped if the pointer is NULL.
- *
- * If the queries we find are not already being executed then we can simply remove them immediately.
- */
- for(ConnMap::iterator iter = connections.begin(); iter != connections.end(); iter++)
+ else
{
- iter->second->OnUnloadModule(mod);
+ /* I think we'll assume this means the server died...it might not,
+ * but I think that any error serious enough we actually get here
+ * deserves to reconnect [/excuse]
+ * Returning true so the core doesn't try and close the connection.
+ */
+ DelayReconnect();
}
}
- unsigned long NewID()
+ bool DoResetPoll()
{
- if (currid+1 == 0)
- currid++;
-
- return ++currid;
- }
-
- virtual Version GetVersion()
- {
- return Version(1, 1, 0, 0, VF_VENDOR|VF_SERVICEPROVIDER, API_VERSION);
- }
-
- virtual ~ModulePgSQL()
- {
- DELETE(sqlsuccess);
- }
-};
-
-SQLConn::SQLConn(InspIRCd* SI, ModulePgSQL* self, const SQLhost& hi)
-: InspSocket::InspSocket(SI), us(self), dbhost(hi.host), dbport(hi.port), dbname(hi.name), dbuser(hi.user), dbpass(hi.pass), ssl(hi.ssl), sql(NULL), status(CWRITE), qinprog(false)
-{
- //ServerInstance->Log(DEBUG, "Creating new PgSQL connection to database %s on %s:%u (%s/%s)", dbname.c_str(), dbhost.c_str(), dbport, dbuser.c_str(), dbpass.c_str());
-
- /* Some of this could be reviewed, unsure if I need to fill 'host' etc...
- * just copied this over from the InspSocket constructor.
- */
- strlcpy(this->host, dbhost.c_str(), MAXBUF);
- strlcpy(this->IP, dbhost.c_str(), MAXBUF);
- this->port = dbport;
- idle = this->Instance->Time();
-
- this->ClosePending = false;
-
- Instance->Log(DEBUG,"No need to resolve %s", this->host);
-
-
- if(!this->DoConnect())
- {
- throw ModuleException("Connect failed");
+ switch(PQresetPoll(sql))
+ {
+ case PGRES_POLLING_WRITING:
+ ServerInstance->SE->ChangeEventMask(this, FD_WANT_POLL_WRITE | FD_WANT_NO_READ);
+ status = CWRITE;
+ return DoPoll();
+ case PGRES_POLLING_READING:
+ ServerInstance->SE->ChangeEventMask(this, FD_WANT_POLL_READ | FD_WANT_NO_WRITE);
+ status = CREAD;
+ return true;
+ case PGRES_POLLING_FAILED:
+ return false;
+ case PGRES_POLLING_OK:
+ ServerInstance->SE->ChangeEventMask(this, FD_WANT_POLL_READ | FD_WANT_NO_WRITE);
+ status = WWRITE;
+ DoConnectedPoll();
+ default:
+ return true;
+ }
}
-}
-SQLConn::~SQLConn()
-{
- Close();
-}
+ void DelayReconnect();
-bool SQLConn::DoConnect()
-{
- //ServerInstance->Log(DEBUG, "SQLConn::DoConnect()");
-
- if(!(sql = PQconnectStart(MkInfoStr().c_str())))
- {
- Instance->Log(DEBUG, "Couldn't allocate PGconn structure, aborting: %s", PQerrorMessage(sql));
- Close();
- return false;
- }
-
- if(PQstatus(sql) == CONNECTION_BAD)
- {
- Instance->Log(DEBUG, "PQconnectStart failed: %s", PQerrorMessage(sql));
- Close();
- return false;
- }
-
- ShowStatus();
-
- if(PQsetnonblocking(sql, 1) == -1)
- {
- Instance->Log(DEBUG, "Couldn't set connection nonblocking: %s", PQerrorMessage(sql));
- Close();
- return false;
- }
-
- /* OK, we've initalised the connection, now to get it hooked into the socket engine
- * and then start polling it.
- */
-
- //ServerInstance->Log(DEBUG, "Old DNS socket: %d", this->fd);
- this->fd = PQsocket(sql);
- Instance->Log(DEBUG, "New SQL socket: %d", this->fd);
-
- if(this->fd <= -1)
- {
- Instance->Log(DEBUG, "PQsocket says we have an invalid FD: %d", this->fd);
- Close();
- return false;
- }
-
- this->state = I_CONNECTING;
- if (!this->Instance->SE->AddFd(this))
+ void DoEvent()
{
- Instance->Log(DEBUG, "A PQsocket cant be added to the socket engine!");
- Close();
- return false;
- }
-
- /* Socket all hooked into the engine, now to tell PgSQL to start connecting */
-
- return DoPoll();
-}
-
-void SQLConn::Close()
-{
- Instance->Log(DEBUG,"SQLConn::Close");
-
- this->fd = -1;
- this->state = I_ERROR;
- this->OnError(I_ERR_SOCKET);
- this->ClosePending = true;
-
- if(sql)
- {
- PQfinish(sql);
- sql = NULL;
+ if((status == CREAD) || (status == CWRITE))
+ {
+ DoPoll();
+ }
+ else if((status == RREAD) || (status == RWRITE))
+ {
+ DoResetPoll();
+ }
+ else
+ {
+ DoConnectedPoll();
+ }
}
-
- return;
-}
-bool SQLConn::DoPoll()
-{
- switch(PQconnectPoll(sql))
+ void submit(SQLQuery *req, const std::string& q)
{
- case PGRES_POLLING_WRITING:
- //ServerInstance->Log(DEBUG, "PGconnectPoll: PGRES_POLLING_WRITING");
- WantWrite();
- status = CWRITE;
- return DoPoll();
- case PGRES_POLLING_READING:
- //ServerInstance->Log(DEBUG, "PGconnectPoll: PGRES_POLLING_READING");
- status = CREAD;
- return true;
- case PGRES_POLLING_FAILED:
- //ServerInstance->Log(DEBUG, "PGconnectPoll: PGRES_POLLING_FAILED: %s", PQerrorMessage(sql));
- return false;
- case PGRES_POLLING_OK:
- //ServerInstance->Log(DEBUG, "PGconnectPoll: PGRES_POLLING_OK");
- status = WWRITE;
- return DoConnectedPoll();
- default:
- //ServerInstance->Log(DEBUG, "PGconnectPoll: wtf?");
- return true;
+ if (qinprog.q.empty())
+ {
+ DoQuery(QueueItem(req,q));
+ }
+ else
+ {
+ // wait your turn.
+ queue.push_back(QueueItem(req,q));
+ }
}
-}
-bool SQLConn::DoConnectedPoll()
-{
- if(!qinprog && queue.totalsize())
+ void submit(SQLQuery *req, const std::string& q, const ParamL& p)
{
- /* There's no query currently in progress, and there's queries in the queue. */
- SQLrequest& query = queue.front();
- DoQuery(query);
- }
-
- if(PQconsumeInput(sql))
- {
- Instance->Log(DEBUG, "PQconsumeInput succeeded");
-
- /* We just read stuff from the server, that counts as it being alive
- * so update the idle-since time :p
- */
- idle = this->Instance->Time();
-
- if(PQisBusy(sql))
- {
- //ServerInstance->Log(DEBUG, "Still busy processing command though");
- }
- else if(qinprog)
+ std::string res;
+ unsigned int param = 0;
+ for(std::string::size_type i = 0; i < q.length(); i++)
{
- //ServerInstance->Log(DEBUG, "Looks like we have a result to process!");
-
- /* Grab the request we're processing */
- SQLrequest& query = queue.front();
-
- Instance->Log(DEBUG, "ID is %lu", query.id);
-
- /* Get a pointer to the module we're about to return the result to */
- Module* to = query.GetSource();
-
- /* Fetch the result.. */
- PGresult* result = PQgetResult(sql);
-
- /* PgSQL would allow a query string to be sent which has multiple
- * queries in it, this isn't portable across database backends and
- * we don't want modules doing it. But just in case we make sure we
- * drain any results there are and just use the last one.
- * If the module devs are behaving there will only be one result.
- */
- while (PGresult* temp = PQgetResult(sql))
- {
- PQclear(result);
- result = temp;
- }
-
- if(to)
+ if (q[i] != '?')
+ res.push_back(q[i]);
+ else
{
- /* ..and the result */
- PgSQLresult reply(us, to, query.id, result);
-
- /* Fix by brain, make sure the original query gets sent back in the reply */
- reply.query = query.query.q;
-
- Instance->Log(DEBUG, "Got result, status code: %s; error message: %s", PQresStatus(PQresultStatus(result)), PQresultErrorMessage(result));
-
- switch(PQresultStatus(result))
+ if (param < p.size())
{
- case PGRES_EMPTY_QUERY:
- case PGRES_BAD_RESPONSE:
- case PGRES_FATAL_ERROR:
- reply.error.Id(QREPLY_FAIL);
- reply.error.Str(PQresultErrorMessage(result));
- default:;
- /* No action, other values are not errors */
+ std::string parm = p[param++];
+ char buffer[MAXBUF];
+#ifdef PGSQL_HAS_ESCAPECONN
+ int error;
+ PQescapeStringConn(sql, buffer, parm.c_str(), parm.length(), &error);
+ if (error)
+ ServerInstance->Logs->Log("m_pgsql", DEBUG, "BUG: Apparently PQescapeStringConn() failed");
+#else
+ PQescapeString (buffer, parm.c_str(), parm.length());
+#endif
+ res.append(buffer);
}
-
- reply.Send();
-
- /* PgSQLresult's destructor will free the PGresult */
}
+ }
+ submit(req, res);
+ }
+
+ void submit(SQLQuery *req, 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
{
- /* If the client module is unloaded partway through a query then the provider will set
- * the pointer to NULL. We cannot just cancel the query as the result will still come
- * through at some point...and it could get messy if we play with invalid pointers...
- */
- Instance->Log(DEBUG, "Looks like we're handling a zombie query from a module which unloaded before it got a result..fun. ID: %lu", query.id);
- PQclear(result);
+ 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())
+ {
+ std::string parm = it->second;
+ char buffer[MAXBUF];
+#ifdef PGSQL_HAS_ESCAPECONN
+ int error;
+ PQescapeStringConn(sql, buffer, parm.c_str(), parm.length(), &error);
+ if (error)
+ ServerInstance->Logs->Log("m_pgsql", DEBUG, "BUG: Apparently PQescapeStringConn() failed");
+#else
+ PQescapeString (buffer, parm.c_str(), parm.length());
+#endif
+ res.append(buffer);
+ }
}
-
- qinprog = false;
- queue.pop();
- DoConnectedPoll();
+ }
+ submit(req, res);
+ }
+
+ void DoQuery(const QueueItem& req)
+ {
+ if (status != WREAD && status != WWRITE)
+ {
+ // whoops, not connected...
+ SQLerror err(SQL_BAD_CONN);
+ req.c->OnError(err);
+ delete req.c;
+ return;
+ }
+
+ if(PQsendQuery(sql, req.q.c_str()))
+ {
+ qinprog = req;
}
else
{
- Instance->Log(DEBUG, "Eh!? We just got a read event, and connection isn't busy..but no result :(");
+ SQLerror err(SQL_QSEND_FAIL, PQerrorMessage(sql));
+ req.c->OnError(err);
+ delete req.c;
}
-
- return true;
}
- else
+
+ void Close()
{
- /* I think we'll assume this means the server died...it might not,
- * but I think that any error serious enough we actually get here
- * deserves to reconnect [/excuse]
- * Returning true so the core doesn't try and close the connection.
- */
- Instance->Log(DEBUG, "PQconsumeInput failed: %s", PQerrorMessage(sql));
- Reconnect();
- return true;
+ ServerInstance->SE->DelFd(this);
+
+ if(sql)
+ {
+ PQfinish(sql);
+ sql = NULL;
+ }
}
-}
+};
-bool SQLConn::DoResetPoll()
+class ModulePgSQL : public Module
{
- switch(PQresetPoll(sql))
+ public:
+ ConnMap connections;
+ ReconnectTimer* retimer;
+
+ ModulePgSQL()
{
- case PGRES_POLLING_WRITING:
- //ServerInstance->Log(DEBUG, "PGresetPoll: PGRES_POLLING_WRITING");
- WantWrite();
- status = CWRITE;
- return DoPoll();
- case PGRES_POLLING_READING:
- //ServerInstance->Log(DEBUG, "PGresetPoll: PGRES_POLLING_READING");
- status = CREAD;
- return true;
- case PGRES_POLLING_FAILED:
- //ServerInstance->Log(DEBUG, "PGresetPoll: PGRES_POLLING_FAILED: %s", PQerrorMessage(sql));
- return false;
- case PGRES_POLLING_OK:
- //ServerInstance->Log(DEBUG, "PGresetPoll: PGRES_POLLING_OK");
- status = WWRITE;
- return DoConnectedPoll();
- default:
- //ServerInstance->Log(DEBUG, "PGresetPoll: wtf?");
- return true;
}
-}
-void SQLConn::ShowStatus()
-{
- switch(PQstatus(sql))
+ void init()
{
- case CONNECTION_STARTED:
- Instance->Log(DEBUG, "PQstatus: CONNECTION_STARTED: Waiting for connection to be made.");
- break;
+ ReadConf();
- case CONNECTION_MADE:
- Instance->Log(DEBUG, "PQstatus: CONNECTION_MADE: Connection OK; waiting to send.");
- break;
-
- case CONNECTION_AWAITING_RESPONSE:
- Instance->Log(DEBUG, "PQstatus: CONNECTION_AWAITING_RESPONSE: Waiting for a response from the server.");
- break;
-
- case CONNECTION_AUTH_OK:
- Instance->Log(DEBUG, "PQstatus: CONNECTION_AUTH_OK: Received authentication; waiting for backend start-up to finish.");
- break;
-
- case CONNECTION_SSL_STARTUP:
- Instance->Log(DEBUG, "PQstatus: CONNECTION_SSL_STARTUP: Negotiating SSL encryption.");
- break;
-
- case CONNECTION_SETENV:
- Instance->Log(DEBUG, "PQstatus: CONNECTION_SETENV: Negotiating environment-driven parameter settings.");
- break;
-
- default:
- Instance->Log(DEBUG, "PQstatus: ???");
+ Implementation eventlist[] = { I_OnUnloadModule, I_OnRehash };
+ ServerInstance->Modules->Attach(eventlist, this, 2);
}
-}
-
-bool SQLConn::OnDataReady()
-{
- /* Always return true here, false would close the socket - we need to do that ourselves with the pgsql API */
- Instance->Log(DEBUG, "OnDataReady(): status = %s", StatusStr());
-
- return DoEvent();
-}
-
-bool SQLConn::OnWriteReady()
-{
- /* Always return true here, false would close the socket - we need to do that ourselves with the pgsql API */
- Instance->Log(DEBUG, "OnWriteReady(): status = %s", StatusStr());
-
- return DoEvent();
-}
-
-bool SQLConn::OnConnected()
-{
- Instance->Log(DEBUG, "OnConnected(): status = %s", StatusStr());
-
- return DoEvent();
-}
-bool SQLConn::Reconnect()
-{
- Instance->Log(DEBUG, "Initiating reconnect");
-
- if(PQresetStart(sql))
+ virtual ~ModulePgSQL()
{
- /* Successfully initiatied database reconnect,
- * set flags so PQresetPoll() will be called appropriately
- */
- status = RWRITE;
- qinprog = false;
- return true;
+ if (retimer)
+ ServerInstance->Timers->DelTimer(retimer);
+ ClearAllConnections();
}
- else
- {
- Instance->Log(DEBUG, "Failed to initiate reconnect...fun");
- return false;
- }
-}
-bool SQLConn::DoEvent()
-{
- bool ret;
-
- if((status == CREAD) || (status == CWRITE))
- {
- ret = DoPoll();
- }
- else if((status == RREAD) || (status == RWRITE))
+ virtual void OnRehash(User* user)
{
- ret = DoResetPoll();
+ ReadConf();
}
- else
+
+ void ReadConf()
{
- ret = DoConnectedPoll();
+ ConnMap conns;
+ ConfigTagList tags = ServerInstance->Config->ConfTags("database");
+ for(ConfigIter i = tags.first; i != tags.second; i++)
+ {
+ if (i->second->getString("module", "pgsql") != "pgsql")
+ continue;
+ std::string id = i->second->getString("id");
+ ConnMap::iterator curr = connections.find(id);
+ if (curr == connections.end())
+ {
+ SQLConn* conn = new SQLConn(this, i->second);
+ conns.insert(std::make_pair(id, conn));
+ ServerInstance->Modules->AddService(*conn);
+ }
+ else
+ {
+ conns.insert(*curr);
+ connections.erase(curr);
+ }
+ }
+ ClearAllConnections();
+ conns.swap(connections);
}
-
- switch(PQflush(sql))
+
+ void ClearAllConnections()
{
- case -1:
- Instance->Log(DEBUG, "Error flushing write queue: %s", PQerrorMessage(sql));
- break;
- case 0:
- Instance->Log(DEBUG, "Successfully flushed write queue (or there was nothing to write)");
- break;
- case 1:
- Instance->Log(DEBUG, "Not all of the write queue written, triggering write event so we can have another go");
- WantWrite();
- break;
+ for(ConnMap::iterator i = connections.begin(); i != connections.end(); i++)
+ {
+ i->second->cull();
+ delete i->second;
+ }
+ connections.clear();
}
- return ret;
-}
-
-std::string SQLConn::MkInfoStr()
-{
- std::ostringstream conninfo("connect_timeout = '2'");
-
- if(dbhost.length())
- conninfo << " hostaddr = '" << dbhost << "'";
-
- if(dbport)
- conninfo << " port = '" << dbport << "'";
-
- if(dbname.length())
- conninfo << " dbname = '" << dbname << "'";
-
- if(dbuser.length())
- conninfo << " user = '" << dbuser << "'";
-
- if(dbpass.length())
- conninfo << " password = '" << dbpass << "'";
-
- if(ssl)
- conninfo << " sslmode = 'require'";
-
- return conninfo.str();
-}
-
-const char* SQLConn::StatusStr()
-{
- if(status == CREAD) return "CREAD";
- if(status == CWRITE) return "CWRITE";
- if(status == WREAD) return "WREAD";
- if(status == WWRITE) return "WWRITE";
- return "Err...what, erm..BUG!";
-}
-
-SQLerror SQLConn::DoQuery(SQLrequest &req)
-{
- if((status == WREAD) || (status == WWRITE))
+ void OnUnloadModule(Module* mod)
{
- if(!qinprog)
+ SQLerror err(SQL_BAD_DBID);
+ for(ConnMap::iterator i = connections.begin(); i != connections.end(); i++)
{
- /* Parse the command string and dispatch it */
-
- /* 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 int paramlen;
-
- paramlen = 0;
-
- for(ParamL::iterator i = req.query.p.begin(); i != req.query.p.end(); i++)
+ SQLConn* conn = i->second;
+ if (conn->qinprog.c && conn->qinprog.c->creator == mod)
{
- paramlen += i->size();
+ conn->qinprog.c->OnError(err);
+ delete conn->qinprog.c;
+ conn->qinprog.c = NULL;
}
-
- /* 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 PQsendQuery()
- */
-
- query = new char[req.query.q.length() + (paramlen*2)];
- 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 int i = 0; i < req.query.q.length(); i++)
+ std::deque<QueueItem>::iterator j = conn->queue.begin();
+ while (j != conn->queue.end())
{
- if(req.query.q[i] == '?')
+ SQLQuery* q = j->c;
+ if (q->creator == mod)
{
- /* We found a place to substitute..what fun.
- * Use the PgSQL 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())
- {
- int error = 0;
- size_t len = 0;
-
-#ifdef PGSQL_HAS_ESCAPECONN
- len = PQescapeStringConn(sql, queryend, req.query.p.front().c_str(), req.query.p.front().length(), &error);
-#else
- len = PQescapeString (queryend, req.query.p.front().c_str(), req.query.p.front().length());
-#endif
- if(error)
- {
- Instance->Log(DEBUG, "Apparently PQescapeStringConn() failed somehow...don't know how or what to do...");
- }
-
- Instance->Log(DEBUG, "Appended %d bytes of escaped string onto the query", len);
-
- /* Incremenet queryend to the end of the newly escaped parameter */
- queryend += len;
-
- /* Remove the parameter we just substituted in */
- req.query.p.pop_front();
- }
- else
- {
- Instance->Log(DEBUG, "Found a substitution location but no parameter to substitute :|");
- break;
- }
+ q->OnError(err);
+ delete q;
+ j = conn->queue.erase(j);
}
else
- {
- *queryend = req.query.q[i];
- queryend++;
- }
- }
-
- /* Null-terminate the query */
- *queryend = 0;
-
- Instance->Log(DEBUG, "Attempting to dispatch query: %s", query);
-
- req.query.q = query;
-
- if(PQsendQuery(sql, query))
- {
- Instance->Log(DEBUG, "Dispatched query successfully");
- qinprog = true;
- delete[] query;
- return SQLerror();
- }
- else
- {
- Instance->Log(DEBUG, "Failed to dispatch query: %s", PQerrorMessage(sql));
- delete[] query;
- return SQLerror(QSEND_FAIL, PQerrorMessage(sql));
+ j++;
}
}
}
- Instance->Log(DEBUG, "Can't query until connection is complete");
- return SQLerror(BAD_CONN, "Can't query until connection is complete");
-}
-
-SQLerror SQLConn::Query(const SQLrequest &req)
-{
- queue.push(req);
-
- if(!qinprog && queue.totalsize())
- {
- /* There's no query currently in progress, and there's queries in the queue. */
- SQLrequest& query = queue.front();
- return DoQuery(query);
- }
- else
+ Version GetVersion()
{
- return SQLerror();
+ return Version("PostgreSQL Service Provider module for all other m_sql* modules, uses v2 of the SQL API", VF_VENDOR);
}
-}
-
-void SQLConn::OnUnloadModule(Module* mod)
-{
- queue.PurgeModule(mod);
-}
+};
-void SQLresolver::OnLookupComplete(const std::string &result)
+void ReconnectTimer::Tick(time_t time)
{
- host.host = result;
- mod->AddConn(host);
+ mod->retimer = NULL;
+ mod->ReadConf();
}
-class ModulePgSQLFactory : public ModuleFactory
+void SQLConn::DelayReconnect()
{
- public:
- ModulePgSQLFactory()
+ ModulePgSQL* mod = (ModulePgSQL*)(Module*)creator;
+ ConnMap::iterator it = mod->connections.find(conf->getString("id"));
+ if (it != mod->connections.end())
{
+ mod->connections.erase(it);
+ ServerInstance->GlobalCulls.AddItem((EventHandler*)this);
+ if (!mod->retimer)
+ {
+ mod->retimer = new ReconnectTimer(mod);
+ ServerInstance->Timers->AddTimer(mod->retimer);
+ }
}
-
- ~ModulePgSQLFactory()
- {
- }
-
- virtual Module * CreateModule(InspIRCd* Me)
- {
- return new ModulePgSQL(Me);
- }
-};
-
-
-extern "C" void * init_module( void )
-{
- return new ModulePgSQLFactory;
}
+
+MODULE_INIT(ModulePgSQL)
projects / user / henk / code / inspircd.git / blobdiff