-/* +------------------------------------+\r * | Inspire Internet Relay Chat Daemon |\r * +------------------------------------+\r *\r * InspIRCd: (C) 2002-2007 InspIRCd Development Team\r * See: http://www.inspircd.org/wiki/index.php/Credits\r *\r * This program is free but copyrighted software; see\r * the file COPYING for details.\r *\r * ---------------------------------------------------\r */\r\r#include "inspircd.h"\r#include <cstdlib>\r#include <sstream>\r#include <libpq-fe.h>\r#include "users.h"\r#include "channels.h"\r#include "modules.h"\r#include "configreader.h"\r#include "m_sqlv2.h"\r\r/* $ModDesc: PostgreSQL Service Provider module for all other m_sql* modules, uses v2 of the SQL API */\r/* $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));") */\r/* $LinkerFlags: -Lexec("pg_config --libdir") -lpq */\r/* $ModDep: m_sqlv2.h */\r\r\r/* SQLConn rewritten by peavey to\r * use EventHandler instead of\r * InspSocket. This is much neater\r * and gives total control of destroy\r * and delete of resources.\r */\r\r/* Forward declare, so we can have the typedef neatly at the top */\rclass SQLConn;\r\rtypedef std::map<std::string, SQLConn*> ConnMap;\r\r/* CREAD, Connecting and wants read event\r * CWRITE, Connecting and wants write event\r * WREAD, Connected/Working and wants read event\r * WWRITE, Connected/Working and wants write event\r * RREAD, Resetting and wants read event\r * RWRITE, Resetting and wants write event\r */\renum SQLstatus { CREAD, CWRITE, WREAD, WWRITE, RREAD, RWRITE };\r\r/** SQLhost::GetDSN() - Overload to return correct DSN for PostgreSQL\r */\rstd::string SQLhost::GetDSN()\r{\r std::ostringstream conninfo("connect_timeout = '2'");\r\r if (ip.length())\r conninfo << " hostaddr = '" << ip << "'";\r\r if (port)\r conninfo << " port = '" << port << "'";\r\r if (name.length())\r conninfo << " dbname = '" << name << "'";\r\r if (user.length())\r conninfo << " user = '" << user << "'";\r\r if (pass.length())\r conninfo << " password = '" << pass << "'";\r\r if (ssl)\r {\r conninfo << " sslmode = 'require'";\r }\r else\r {\r conninfo << " sslmode = 'disable'";\r }\r\r return conninfo.str();\r}\r\rclass ReconnectTimer : public InspTimer\r{\r private:\r Module* mod;\r public:\r ReconnectTimer(InspIRCd* SI, Module* m)\r : InspTimer(5, SI->Time(), false), mod(m)\r {\r }\r virtual void Tick(time_t TIME);\r};\r\r\r/** Used to resolve sql server hostnames\r */\rclass SQLresolver : public Resolver\r{\r private:\r SQLhost host;\r Module* mod;\r public:\r SQLresolver(Module* m, InspIRCd* Instance, const SQLhost& hi, bool &cached)\r : Resolver(Instance, hi.host, DNS_QUERY_FORWARD, cached, (Module*)m), host(hi), mod(m)\r {\r }\r\r virtual void OnLookupComplete(const std::string &result, unsigned int ttl, bool cached);\r\r virtual void OnError(ResolverError e, const std::string &errormessage)\r {\r ServerInstance->Log(DEBUG, "PgSQL: DNS lookup failed (%s), dying horribly", errormessage.c_str());\r }\r};\r\r/** PgSQLresult is a subclass of the mostly-pure-virtual class SQLresult.\r * All SQL providers must create their own subclass and define it's methods using that\r * database library's data retriveal functions. The aim is to avoid a slow and inefficient process\r * of converting all data to a common format before it reaches the result structure. This way\r * data is passes to the module nearly as directly as if it was using the API directly itself.\r */\r\rclass PgSQLresult : public SQLresult\r{\r PGresult* res;\r int currentrow;\r int rows;\r int cols;\r\r SQLfieldList* fieldlist;\r SQLfieldMap* fieldmap;\rpublic:\r PgSQLresult(Module* self, Module* to, unsigned long id, PGresult* result)\r : SQLresult(self, to, id), res(result), currentrow(0), fieldlist(NULL), fieldmap(NULL)\r {\r rows = PQntuples(res);\r cols = PQnfields(res);\r }\r\r ~PgSQLresult()\r {\r /* If we allocated these, free them... */\r if(fieldlist)\r DELETE(fieldlist);\r\r if(fieldmap)\r DELETE(fieldmap);\r\r PQclear(res);\r }\r\r virtual int Rows()\r {\r if(!cols && !rows)\r {\r return atoi(PQcmdTuples(res));\r }\r else\r {\r return rows;\r }\r }\r\r virtual int Cols()\r {\r return PQnfields(res);\r }\r\r virtual std::string ColName(int column)\r {\r char* name = PQfname(res, column);\r\r return (name) ? name : "";\r }\r\r virtual int ColNum(const std::string &column)\r {\r int n = PQfnumber(res, column.c_str());\r\r if(n == -1)\r {\r throw SQLbadColName();\r }\r else\r {\r return n;\r }\r }\r\r virtual SQLfield GetValue(int row, int column)\r {\r char* v = PQgetvalue(res, row, column);\r\r if(v)\r {\r return SQLfield(std::string(v, PQgetlength(res, row, column)), PQgetisnull(res, row, column));\r }\r else\r {\r throw SQLbadColName();\r }\r }\r\r virtual SQLfieldList& GetRow()\r {\r /* In an effort to reduce overhead we don't actually allocate the list\r * until the first time it's needed...so...\r */\r if(fieldlist)\r {\r fieldlist->clear();\r }\r else\r {\r fieldlist = new SQLfieldList;\r }\r\r if(currentrow < PQntuples(res))\r {\r int cols = PQnfields(res);\r\r for(int i = 0; i < cols; i++)\r {\r fieldlist->push_back(GetValue(currentrow, i));\r }\r\r currentrow++;\r }\r\r return *fieldlist;\r }\r\r virtual SQLfieldMap& GetRowMap()\r {\r /* In an effort to reduce overhead we don't actually allocate the map\r * until the first time it's needed...so...\r */\r if(fieldmap)\r {\r fieldmap->clear();\r }\r else\r {\r fieldmap = new SQLfieldMap;\r }\r\r if(currentrow < PQntuples(res))\r {\r int cols = PQnfields(res);\r\r for(int i = 0; i < cols; i++)\r {\r fieldmap->insert(std::make_pair(ColName(i), GetValue(currentrow, i)));\r }\r\r currentrow++;\r }\r\r return *fieldmap;\r }\r\r virtual SQLfieldList* GetRowPtr()\r {\r SQLfieldList* fl = new SQLfieldList;\r\r if(currentrow < PQntuples(res))\r {\r int cols = PQnfields(res);\r\r for(int i = 0; i < cols; i++)\r {\r fl->push_back(GetValue(currentrow, i));\r }\r\r currentrow++;\r }\r\r return fl;\r }\r\r virtual SQLfieldMap* GetRowMapPtr()\r {\r SQLfieldMap* fm = new SQLfieldMap;\r\r if(currentrow < PQntuples(res))\r {\r int cols = PQnfields(res);\r\r for(int i = 0; i < cols; i++)\r {\r fm->insert(std::make_pair(ColName(i), GetValue(currentrow, i)));\r }\r\r currentrow++;\r }\r\r return fm;\r }\r\r virtual void Free(SQLfieldMap* fm)\r {\r DELETE(fm);\r }\r\r virtual void Free(SQLfieldList* fl)\r {\r DELETE(fl);\r }\r};\r\r/** SQLConn represents one SQL session.\r */\rclass SQLConn : public EventHandler\r{\r private:\r InspIRCd* Instance;\r SQLhost confhost; /* The <database> entry */\r Module* us; /* Pointer to the SQL provider itself */\r PGconn* sql; /* PgSQL database connection handle */\r SQLstatus status; /* PgSQL database connection status */\r bool qinprog; /* If there is currently a query in progress */\r QueryQueue queue; /* Queue of queries waiting to be executed on this connection */\r time_t idle; /* Time we last heard from the database */\r\r public:\r SQLConn(InspIRCd* SI, Module* self, const SQLhost& hi)\r : EventHandler(), Instance(SI), confhost(hi), us(self), sql(NULL), status(CWRITE), qinprog(false)\r {\r idle = this->Instance->Time();\r if(!DoConnect())\r {\r Instance->Log(DEFAULT, "WARNING: Could not connect to database with id: " + ConvToStr(hi.id));\r DelayReconnect();\r }\r }\r\r ~SQLConn()\r {\r Close();\r }\r\r virtual void HandleEvent(EventType et, int errornum)\r {\r switch (et)\r {\r case EVENT_READ:\r OnDataReady();\r break;\r\r case EVENT_WRITE:\r OnWriteReady();\r break;\r\r case EVENT_ERROR:\r DelayReconnect();\r break;\r\r default:\r break;\r }\r }\r\r bool DoConnect()\r {\r if(!(sql = PQconnectStart(confhost.GetDSN().c_str())))\r return false;\r\r if(PQstatus(sql) == CONNECTION_BAD)\r return false;\r\r if(PQsetnonblocking(sql, 1) == -1)\r return false;\r\r /* OK, we've initalised the connection, now to get it hooked into the socket engine\r * and then start polling it.\r */\r this->fd = PQsocket(sql);\r\r if(this->fd <= -1)\r return false;\r\r if (!this->Instance->SE->AddFd(this))\r {\r Instance->Log(DEBUG, "BUG: Couldn't add pgsql socket to socket engine");\r return false;\r }\r\r /* Socket all hooked into the engine, now to tell PgSQL to start connecting */\r return DoPoll();\r }\r\r bool DoPoll()\r {\r switch(PQconnectPoll(sql))\r {\r case PGRES_POLLING_WRITING:\r Instance->SE->WantWrite(this);\r status = CWRITE;\r return true;\r case PGRES_POLLING_READING:\r status = CREAD;\r return true;\r case PGRES_POLLING_FAILED:\r return false;\r case PGRES_POLLING_OK:\r status = WWRITE;\r return DoConnectedPoll();\r default:\r return true;\r }\r }\r\r bool DoConnectedPoll()\r {\r if(!qinprog && queue.totalsize())\r {\r /* There's no query currently in progress, and there's queries in the queue. */\r SQLrequest& query = queue.front();\r DoQuery(query);\r }\r\r if(PQconsumeInput(sql))\r {\r /* We just read stuff from the server, that counts as it being alive\r * so update the idle-since time :p\r */\r idle = this->Instance->Time();\r\r if (PQisBusy(sql))\r {\r /* Nothing happens here */\r }\r else if (qinprog)\r {\r /* Grab the request we're processing */\r SQLrequest& query = queue.front();\r\r /* Get a pointer to the module we're about to return the result to */\r Module* to = query.GetSource();\r\r /* Fetch the result.. */\r PGresult* result = PQgetResult(sql);\r\r /* PgSQL would allow a query string to be sent which has multiple\r * queries in it, this isn't portable across database backends and\r * we don't want modules doing it. But just in case we make sure we\r * drain any results there are and just use the last one.\r * If the module devs are behaving there will only be one result.\r */\r while (PGresult* temp = PQgetResult(sql))\r {\r PQclear(result);\r result = temp;\r }\r\r if(to)\r {\r /* ..and the result */\r PgSQLresult reply(us, to, query.id, result);\r\r /* Fix by brain, make sure the original query gets sent back in the reply */\r reply.query = query.query.q;\r\r switch(PQresultStatus(result))\r {\r case PGRES_EMPTY_QUERY:\r case PGRES_BAD_RESPONSE:\r case PGRES_FATAL_ERROR:\r reply.error.Id(QREPLY_FAIL);\r reply.error.Str(PQresultErrorMessage(result));\r default:;\r /* No action, other values are not errors */\r }\r\r reply.Send();\r\r /* PgSQLresult's destructor will free the PGresult */\r }\r else\r {\r /* If the client module is unloaded partway through a query then the provider will set\r * the pointer to NULL. We cannot just cancel the query as the result will still come\r * through at some point...and it could get messy if we play with invalid pointers...\r */\r PQclear(result);\r }\r qinprog = false;\r queue.pop();\r DoConnectedPoll();\r }\r return true;\r }\r else\r {\r /* I think we'll assume this means the server died...it might not,\r * but I think that any error serious enough we actually get here\r * deserves to reconnect [/excuse]\r * Returning true so the core doesn't try and close the connection.\r */\r DelayReconnect();\r return true;\r }\r }\r\r bool DoResetPoll()\r {\r switch(PQresetPoll(sql))\r {\r case PGRES_POLLING_WRITING:\r Instance->SE->WantWrite(this);\r status = CWRITE;\r return DoPoll();\r case PGRES_POLLING_READING:\r status = CREAD;\r return true;\r case PGRES_POLLING_FAILED:\r return false;\r case PGRES_POLLING_OK:\r status = WWRITE;\r return DoConnectedPoll();\r default:\r return true;\r }\r }\r\r bool OnDataReady()\r {\r /* Always return true here, false would close the socket - we need to do that ourselves with the pgsql API */\r return DoEvent();\r }\r\r bool OnWriteReady()\r {\r /* Always return true here, false would close the socket - we need to do that ourselves with the pgsql API */\r return DoEvent();\r }\r\r bool OnConnected()\r {\r return DoEvent();\r }\r\r void DelayReconnect();\r\r bool DoEvent()\r {\r bool ret;\r\r if((status == CREAD) || (status == CWRITE))\r {\r ret = DoPoll();\r }\r else if((status == RREAD) || (status == RWRITE))\r {\r ret = DoResetPoll();\r }\r else\r {\r ret = DoConnectedPoll();\r }\r return ret;\r }\r\r SQLerror DoQuery(SQLrequest &req)\r {\r if((status == WREAD) || (status == WWRITE))\r {\r if(!qinprog)\r {\r /* Parse the command string and dispatch it */\r\r /* Pointer to the buffer we screw around with substitution in */\r char* query;\r /* Pointer to the current end of query, where we append new stuff */\r char* queryend;\r /* Total length of the unescaped parameters */\r unsigned int paramlen;\r\r paramlen = 0;\r\r for(ParamL::iterator i = req.query.p.begin(); i != req.query.p.end(); i++)\r {\r paramlen += i->size();\r }\r\r /* To avoid a lot of allocations, allocate enough memory for the biggest the escaped query could possibly be.\r * sizeofquery + (totalparamlength*2) + 1\r *\r * The +1 is for null-terminating the string for PQsendQuery()\r */\r\r query = new char[req.query.q.length() + (paramlen*2) + 1];\r queryend = query;\r\r /* Okay, now we have a buffer large enough we need to start copying the query into it and escaping and substituting\r * the parameters into it...\r */\r\r for(unsigned int i = 0; i < req.query.q.length(); i++)\r {\r if(req.query.q[i] == '?')\r {\r /* We found a place to substitute..what fun.\r * Use the PgSQL calls to escape and write the\r * escaped string onto the end of our query buffer,\r * then we "just" need to make sure queryend is\r * pointing at the right place.\r */\r\r if(req.query.p.size())\r {\r int error = 0;\r size_t len = 0;\r\r#ifdef PGSQL_HAS_ESCAPECONN\r len = PQescapeStringConn(sql, queryend, req.query.p.front().c_str(), req.query.p.front().length(), &error);\r#else\r len = PQescapeString (queryend, req.query.p.front().c_str(), req.query.p.front().length());\r#endif\r if(error)\r {\r Instance->Log(DEBUG, "BUG: Apparently PQescapeStringConn() failed somehow...don't know how or what to do...");\r }\r\r /* Incremenet queryend to the end of the newly escaped parameter */\r queryend += len;\r\r /* Remove the parameter we just substituted in */\r req.query.p.pop_front();\r }\r else\r {\r Instance->Log(DEBUG, "BUG: Found a substitution location but no parameter to substitute :|");\r break;\r }\r }\r else\r {\r *queryend = req.query.q[i];\r queryend++;\r }\r }\r\r /* Null-terminate the query */\r *queryend = 0;\r req.query.q = query;\r\r if(PQsendQuery(sql, query))\r {\r qinprog = true;\r delete[] query;\r return SQLerror();\r }\r else\r {\r delete[] query;\r return SQLerror(QSEND_FAIL, PQerrorMessage(sql));\r }\r }\r }\r return SQLerror(BAD_CONN, "Can't query until connection is complete");\r }\r\r SQLerror Query(const SQLrequest &req)\r {\r queue.push(req);\r\r if(!qinprog && queue.totalsize())\r {\r /* There's no query currently in progress, and there's queries in the queue. */\r SQLrequest& query = queue.front();\r return DoQuery(query);\r }\r else\r {\r return SQLerror();\r }\r }\r\r void OnUnloadModule(Module* mod)\r {\r queue.PurgeModule(mod);\r }\r\r const SQLhost GetConfHost()\r {\r return confhost;\r }\r\r void Close() {\r if (!this->Instance->SE->DelFd(this))\r {\r if (sql && PQstatus(sql) == CONNECTION_BAD)\r {\r this->Instance->SE->DelFd(this, true);\r }\r else\r {\r Instance->Log(DEBUG, "BUG: PQsocket cant be removed from socket engine!");\r }\r }\r\r if(sql)\r {\r PQfinish(sql);\r sql = NULL;\r }\r }\r\r};\r\rclass ModulePgSQL : public Module\r{\r private:\r ConnMap connections;\r unsigned long currid;\r char* sqlsuccess;\r ReconnectTimer* retimer;\r\r public:\r ModulePgSQL(InspIRCd* Me)\r : Module::Module(Me), currid(0)\r {\r ServerInstance->UseInterface("SQLutils");\r\r sqlsuccess = new char[strlen(SQLSUCCESS)+1];\r\r strlcpy(sqlsuccess, SQLSUCCESS, strlen(SQLSUCCESS));\r\r if (!ServerInstance->PublishFeature("SQL", this))\r {\r throw ModuleException("BUG: PgSQL Unable to publish feature 'SQL'");\r }\r\r ReadConf();\r\r ServerInstance->PublishInterface("SQL", this);\r }\r\r virtual ~ModulePgSQL()\r {\r if (retimer)\r ServerInstance->Timers->DelTimer(retimer);\r ClearAllConnections();\r delete[] sqlsuccess;\r ServerInstance->UnpublishInterface("SQL", this);\r ServerInstance->UnpublishFeature("SQL");\r ServerInstance->DoneWithInterface("SQLutils");\r }\r\r void Implements(char* List)\r {\r List[I_OnUnloadModule] = List[I_OnRequest] = List[I_OnRehash] = List[I_OnUserRegister] = List[I_OnCheckReady] = List[I_OnUserDisconnect] = 1;\r }\r\r virtual void OnRehash(userrec* user, const std::string ¶meter)\r {\r ReadConf();\r }\r\r bool HasHost(const SQLhost &host)\r {\r for (ConnMap::iterator iter = connections.begin(); iter != connections.end(); iter++)\r {\r if (host == iter->second->GetConfHost())\r return true;\r }\r return false;\r }\r\r bool HostInConf(const SQLhost &h)\r {\r ConfigReader conf(ServerInstance);\r for(int i = 0; i < conf.Enumerate("database"); i++)\r {\r SQLhost host;\r host.id = conf.ReadValue("database", "id", i);\r host.host = conf.ReadValue("database", "hostname", i);\r host.port = conf.ReadInteger("database", "port", i, true);\r host.name = conf.ReadValue("database", "name", i);\r host.user = conf.ReadValue("database", "username", i);\r host.pass = conf.ReadValue("database", "password", i);\r host.ssl = conf.ReadFlag("database", "ssl", "0", i);\r if (h == host)\r return true;\r }\r return false;\r }\r\r void ReadConf()\r {\r ClearOldConnections();\r\r ConfigReader conf(ServerInstance);\r for(int i = 0; i < conf.Enumerate("database"); i++)\r {\r SQLhost host;\r int ipvalid;\r\r host.id = conf.ReadValue("database", "id", i);\r host.host = conf.ReadValue("database", "hostname", i);\r host.port = conf.ReadInteger("database", "port", i, true);\r host.name = conf.ReadValue("database", "name", i);\r host.user = conf.ReadValue("database", "username", i);\r host.pass = conf.ReadValue("database", "password", i);\r host.ssl = conf.ReadFlag("database", "ssl", "0", i);\r\r if (HasHost(host))\r continue;\r\r#ifdef IPV6\r if (strchr(host.host.c_str(),':'))\r {\r in6_addr blargle;\r ipvalid = inet_pton(AF_INET6, host.host.c_str(), &blargle);\r }\r else\r#endif\r {\r in_addr blargle;\r ipvalid = inet_aton(host.host.c_str(), &blargle);\r }\r\r if(ipvalid > 0)\r {\r /* The conversion succeeded, we were given an IP and we can give it straight to SQLConn */\r host.ip = host.host;\r this->AddConn(host);\r }\r else if(ipvalid == 0)\r {\r /* Conversion failed, assume it's a host */\r SQLresolver* resolver;\r\r try\r {\r bool cached;\r resolver = new SQLresolver(this, ServerInstance, host, cached);\r ServerInstance->AddResolver(resolver, cached);\r }\r catch(...)\r {\r /* THE WORLD IS COMING TO AN END! */\r }\r }\r else\r {\r /* Invalid address family, die horribly. */\r ServerInstance->Log(DEBUG, "BUG: insp_aton failed returning -1, oh noes.");\r }\r }\r }\r\r void ClearOldConnections()\r {\r ConnMap::iterator iter,safei;\r for (iter = connections.begin(); iter != connections.end(); iter++)\r {\r if (!HostInConf(iter->second->GetConfHost()))\r {\r DELETE(iter->second);\r safei = iter;\r --iter;\r connections.erase(safei);\r }\r }\r }\r\r void ClearAllConnections()\r {\r ConnMap::iterator i;\r while ((i = connections.begin()) != connections.end())\r {\r connections.erase(i);\r DELETE(i->second);\r }\r }\r\r void AddConn(const SQLhost& hi)\r {\r if (HasHost(hi))\r {\r ServerInstance->Log(DEFAULT, "WARNING: A pgsql connection with id: %s already exists, possibly due to DNS delay. Aborting connection attempt.", hi.id.c_str());\r return;\r }\r\r SQLConn* newconn;\r\r /* The conversion succeeded, we were given an IP and we can give it straight to SQLConn */\r newconn = new SQLConn(ServerInstance, this, hi);\r\r connections.insert(std::make_pair(hi.id, newconn));\r }\r\r void ReconnectConn(SQLConn* conn)\r {\r for (ConnMap::iterator iter = connections.begin(); iter != connections.end(); iter++)\r {\r if (conn == iter->second)\r {\r DELETE(iter->second);\r connections.erase(iter);\r break;\r }\r }\r retimer = new ReconnectTimer(ServerInstance, this);\r ServerInstance->Timers->AddTimer(retimer);\r }\r\r virtual char* OnRequest(Request* request)\r {\r if(strcmp(SQLREQID, request->GetId()) == 0)\r {\r SQLrequest* req = (SQLrequest*)request;\r ConnMap::iterator iter;\r if((iter = connections.find(req->dbid)) != connections.end())\r {\r /* Execute query */\r req->id = NewID();\r req->error = iter->second->Query(*req);\r\r return (req->error.Id() == NO_ERROR) ? sqlsuccess : NULL;\r }\r else\r {\r req->error.Id(BAD_DBID);\r return NULL;\r }\r }\r return NULL;\r }\r\r virtual void OnUnloadModule(Module* mod, const std::string& name)\r {\r /* When a module unloads we have to check all the pending queries for all our connections\r * and set the Module* specifying where the query came from to NULL. If the query has already\r * been dispatched then when it is processed it will be dropped if the pointer is NULL.\r *\r * If the queries we find are not already being executed then we can simply remove them immediately.\r */\r for(ConnMap::iterator iter = connections.begin(); iter != connections.end(); iter++)\r {\r iter->second->OnUnloadModule(mod);\r }\r }\r\r unsigned long NewID()\r {\r if (currid+1 == 0)\r currid++;\r\r return ++currid;\r }\r\r virtual Version GetVersion()\r {\r return Version(1, 1, 0, 0, VF_VENDOR|VF_SERVICEPROVIDER, API_VERSION);\r }\r};\r\r/* move this here to use AddConn, rather that than having the whole\r * module above SQLConn, since this is buggin me right now :/\r */\rvoid SQLresolver::OnLookupComplete(const std::string &result, unsigned int ttl, bool cached)\r{\r host.ip = result;\r ((ModulePgSQL*)mod)->AddConn(host);\r ((ModulePgSQL*)mod)->ClearOldConnections();\r}\r\rvoid ReconnectTimer::Tick(time_t time)\r{\r ((ModulePgSQL*)mod)->ReadConf();\r}\r\rvoid SQLConn::DelayReconnect()\r{\r ((ModulePgSQL*)us)->ReconnectConn(this);\r}\r\rMODULE_INIT(ModulePgSQL);\r\r
\ No newline at end of file
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
+ *
+ * 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 <libpq-fe.h>
+#include "modules/sql.h"
+
+/* $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;
+class ModulePgSQL;
+
+typedef std::map<std::string, SQLConn*> ConnMap;
+
+/* CREAD, Connecting and wants read event
+ * CWRITE, Connecting and wants write event
+ * WREAD, Connected/Working and wants read event
+ * WWRITE, Connected/Working and wants write event
+ * RREAD, Resetting and wants read event
+ * RWRITE, Resetting and wants write event
+ */
+enum SQLstatus { CREAD, CWRITE, WREAD, WWRITE, RREAD, RWRITE };
+
+class ReconnectTimer : public Timer
+{
+ private:
+ ModulePgSQL* mod;
+ public:
+ ReconnectTimer(ModulePgSQL* m) : Timer(5, ServerInstance->Time(), false), mod(m)
+ {
+ }
+ bool Tick(time_t TIME);
+};
+
+struct QueueItem
+{
+ 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.
+ * All SQL providers must create their own subclass and define it's methods using that
+ * database library's data retriveal functions. The aim is to avoid a slow and inefficient process
+ * of converting all data to a common format before it reaches the result structure. This way
+ * data is passes to the module nearly as directly as if it was using the API directly itself.
+ */
+
+class PgSQLresult : public SQLResult
+{
+ PGresult* res;
+ int currentrow;
+ int rows;
+ public:
+ PgSQLresult(PGresult* result) : res(result), currentrow(0)
+ {
+ rows = PQntuples(res);
+ if (!rows)
+ rows = atoi(PQcmdTuples(res));
+ }
+
+ ~PgSQLresult()
+ {
+ PQclear(res);
+ }
+
+ int Rows()
+ {
+ return rows;
+ }
+
+ void GetCols(std::vector<std::string>& result)
+ {
+ result.resize(PQnfields(res));
+ for(unsigned int i=0; i < result.size(); i++)
+ {
+ result[i] = PQfname(res, i);
+ }
+ }
+
+ SQLEntry GetValue(int row, int column)
+ {
+ char* v = PQgetvalue(res, row, column);
+ if (!v || PQgetisnull(res, row, column))
+ return SQLEntry();
+
+ return SQLEntry(std::string(v, PQgetlength(res, row, column)));
+ }
+
+ bool GetRow(SQLEntries& result)
+ {
+ if (currentrow >= PQntuples(res))
+ return false;
+ int ncols = PQnfields(res);
+
+ for(int i = 0; i < ncols; i++)
+ {
+ result.push_back(GetValue(currentrow, i));
+ }
+ currentrow++;
+
+ return true;
+ }
+};
+
+/** 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, "")
+ {
+ if (!DoConnect())
+ {
+ ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "WARNING: Could not connect to database " + tag->getString("id"));
+ DelayReconnect();
+ }
+ }
+
+ CullResult cull()
+ {
+ this->SQLProvider::cull();
+ ServerInstance->Modules->DelService(*this);
+ return this->EventHandler::cull();
+ }
+
+ ~SQLConn()
+ {
+ SQLerror err(SQL_BAD_DBID);
+ if (qinprog.c)
+ {
+ qinprog.c->OnError(err);
+ delete qinprog.c;
+ }
+ for(std::deque<QueueItem>::iterator i = queue.begin(); i != queue.end(); i++)
+ {
+ SQLQuery* q = i->c;
+ q->OnError(err);
+ delete q;
+ }
+ }
+
+ void HandleEvent(EventType et, int errornum)
+ {
+ switch (et)
+ {
+ case EVENT_READ:
+ case EVENT_WRITE:
+ DoEvent();
+ break;
+
+ case EVENT_ERROR:
+ DelayReconnect();
+ }
+ }
+
+ std::string GetDSN()
+ {
+ 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();
+ }
+
+ bool DoConnect()
+ {
+ sql = PQconnectStart(GetDSN().c_str());
+ if (!sql)
+ return false;
+
+ if(PQstatus(sql) == CONNECTION_BAD)
+ return false;
+
+ if(PQsetnonblocking(sql, 1) == -1)
+ return false;
+
+ /* OK, we've initalised the connection, now to get it hooked into the socket engine
+ * and then start polling it.
+ */
+ this->fd = PQsocket(sql);
+
+ if(this->fd <= -1)
+ return false;
+
+ if (!ServerInstance->SE->AddFd(this, FD_WANT_NO_WRITE | FD_WANT_NO_READ))
+ {
+ ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "BUG: Couldn't add pgsql socket to socket engine");
+ return false;
+ }
+
+ /* Socket all hooked into the engine, now to tell PgSQL to start connecting */
+ return DoPoll();
+ }
+
+ bool DoPoll()
+ {
+ 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;
+ }
+ }
+
+ void DoConnectedPoll()
+ {
+restart:
+ while (qinprog.q.empty() && !queue.empty())
+ {
+ /* There's no query currently in progress, and there's queries in the queue. */
+ DoQuery(queue.front());
+ queue.pop_front();
+ }
+
+ if (PQconsumeInput(sql))
+ {
+ if (PQisBusy(sql))
+ {
+ /* Nothing happens here */
+ }
+ else if (qinprog.c)
+ {
+ /* 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;
+ }
+
+ /* ..and the result */
+ PgSQLresult reply(result);
+ switch(PQresultStatus(result))
+ {
+ 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);
+ }
+
+ delete qinprog.c;
+ qinprog = QueueItem(NULL, "");
+ goto restart;
+ }
+ else
+ {
+ qinprog.q.clear();
+ }
+ }
+ else
+ {
+ /* 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();
+ }
+ }
+
+ bool DoResetPoll()
+ {
+ 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;
+ }
+ }
+
+ void DelayReconnect();
+
+ void DoEvent()
+ {
+ if((status == CREAD) || (status == CWRITE))
+ {
+ DoPoll();
+ }
+ else if((status == RREAD) || (status == RWRITE))
+ {
+ DoResetPoll();
+ }
+ else
+ {
+ DoConnectedPoll();
+ }
+ }
+
+ void submit(SQLQuery *req, const std::string& q)
+ {
+ if (qinprog.q.empty())
+ {
+ DoQuery(QueueItem(req,q));
+ }
+ else
+ {
+ // wait your turn.
+ queue.push_back(QueueItem(req,q));
+ }
+ }
+
+ void submit(SQLQuery *req, const std::string& q, const ParamL& p)
+ {
+ std::string res;
+ unsigned int param = 0;
+ for(std::string::size_type i = 0; i < q.length(); i++)
+ {
+ if (q[i] != '?')
+ res.push_back(q[i]);
+ else
+ {
+ if (param < p.size())
+ {
+ std::string parm = p[param++];
+ std::vector<char> buffer(parm.length() * 2 + 1);
+#ifdef PGSQL_HAS_ESCAPECONN
+ int error;
+ size_t escapedsize = PQescapeStringConn(sql, &buffer[0], parm.data(), parm.length(), &error);
+ if (error)
+ ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "BUG: Apparently PQescapeStringConn() failed");
+#else
+ size_t escapedsize = PQescapeString(&buffer[0], parm.data(), parm.length());
+#endif
+ res.append(&buffer[0], escapedsize);
+ }
+ }
+ }
+ 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
+ {
+ 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;
+ std::vector<char> buffer(parm.length() * 2 + 1);
+#ifdef PGSQL_HAS_ESCAPECONN
+ int error;
+ size_t escapedsize = PQescapeStringConn(sql, &buffer[0], parm.data(), parm.length(), &error);
+ if (error)
+ ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "BUG: Apparently PQescapeStringConn() failed");
+#else
+ size_t escapedsize = PQescapeString(&buffer[0], parm.data(), parm.length());
+#endif
+ res.append(&buffer[0], escapedsize);
+ }
+ }
+ }
+ 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
+ {
+ SQLerror err(SQL_QSEND_FAIL, PQerrorMessage(sql));
+ req.c->OnError(err);
+ delete req.c;
+ }
+ }
+
+ void Close()
+ {
+ ServerInstance->SE->DelFd(this);
+
+ if(sql)
+ {
+ PQfinish(sql);
+ sql = NULL;
+ }
+ }
+};
+
+class ModulePgSQL : public Module
+{
+ public:
+ ConnMap connections;
+ ReconnectTimer* retimer;
+
+ ModulePgSQL()
+ : retimer(NULL)
+ {
+ }
+
+ void init() CXX11_OVERRIDE
+ {
+ ReadConf();
+
+ Implementation eventlist[] = { I_OnUnloadModule, I_OnRehash };
+ ServerInstance->Modules->Attach(eventlist, this, sizeof(eventlist)/sizeof(Implementation));
+ }
+
+ ~ModulePgSQL()
+ {
+ delete retimer;
+ ClearAllConnections();
+ }
+
+ void OnRehash(User* user) CXX11_OVERRIDE
+ {
+ ReadConf();
+ }
+
+ void ReadConf()
+ {
+ 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);
+ }
+
+ void ClearAllConnections()
+ {
+ for(ConnMap::iterator i = connections.begin(); i != connections.end(); i++)
+ {
+ i->second->cull();
+ delete i->second;
+ }
+ connections.clear();
+ }
+
+ void OnUnloadModule(Module* mod) CXX11_OVERRIDE
+ {
+ SQLerror err(SQL_BAD_DBID);
+ for(ConnMap::iterator i = connections.begin(); i != connections.end(); i++)
+ {
+ SQLConn* conn = i->second;
+ if (conn->qinprog.c && conn->qinprog.c->creator == mod)
+ {
+ conn->qinprog.c->OnError(err);
+ delete conn->qinprog.c;
+ conn->qinprog.c = NULL;
+ }
+ std::deque<QueueItem>::iterator j = conn->queue.begin();
+ while (j != conn->queue.end())
+ {
+ SQLQuery* q = j->c;
+ if (q->creator == mod)
+ {
+ q->OnError(err);
+ delete q;
+ j = conn->queue.erase(j);
+ }
+ else
+ j++;
+ }
+ }
+ }
+
+ Version GetVersion() CXX11_OVERRIDE
+ {
+ return Version("PostgreSQL Service Provider module for all other m_sql* modules, uses v2 of the SQL API", VF_VENDOR);
+ }
+};
+
+bool ReconnectTimer::Tick(time_t time)
+{
+ mod->retimer = NULL;
+ mod->ReadConf();
+ return false;
+}
+
+void SQLConn::DelayReconnect()
+{
+ 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);
+ }
+ }
+}
+
+MODULE_INIT(ModulePgSQL)
projects / user / henk / code / inspircd.git / blobdiff