]> git.netwichtig.de Git - user/henk/code/inspircd.git/blob - src/modules/extra/m_pgsql.cpp
b9eb309db65030ebb04e0f191d8d8b38d7b77689
[user/henk/code/inspircd.git] / src / modules / extra / m_pgsql.cpp
1 /*       +------------------------------------+
2  *       | Inspire Internet Relay Chat Daemon |
3  *       +------------------------------------+
4  *
5  *  InspIRCd is copyright (C) 2002-2004 ChatSpike-Dev.
6  *                       E-mail:
7  *                <brain@chatspike.net>
8  *                <Craig@chatspike.net>
9  *                <omster@gmail.com>
10  *     
11  * Written by Craig Edwards, Craig McLure, and others.
12  * This program is free but copyrighted software; see
13  *            the file COPYING for details.
14  *
15  * ---------------------------------------------------
16  */
17
18 #include <cstdlib>
19 #include <sstream>
20 #include <string>
21 #include <deque>
22 #include <map>
23 #include <libpq-fe.h>
24
25 #include "users.h"
26 #include "channels.h"
27 #include "modules.h"
28 #include "helperfuncs.h"
29 #include "inspircd.h"
30 #include "configreader.h"
31
32 #include "m_sqlv2.h"
33
34 /* $ModDesc: PostgreSQL Service Provider module for all other m_sql* modules, uses v2 of the SQL API */
35 /* $CompileFlags: -I`pg_config --includedir` `perl extra/pgsql_config.pl` */
36 /* $LinkerFlags: -L`pg_config --libdir` -lpq */
37
38 /* UGH, UGH, UGH, UGH, UGH, UGH
39  * I'm having trouble seeing how I
40  * can avoid this. The core-defined
41  * constructors for InspSocket just
42  * aren't suitable...and if I'm
43  * reimplementing them I need this so
44  * I can access the socket engine :\
45  */
46 extern InspIRCd* ServerInstance;
47 extern time_t TIME;
48
49 /* Forward declare, so we can have the typedef neatly at the top */
50 class SQLConn;
51 /* Also needs forward declaration, as it's used inside SQLconn */
52 class ModulePgSQL;
53
54 typedef std::map<std::string, SQLConn*> ConnMap;
55
56 /* CREAD,       Connecting and wants read event
57  * CWRITE,      Connecting and wants write event
58  * WREAD,       Connected/Working and wants read event
59  * WWRITE,      Connected/Working and wants write event
60  * RREAD,       Resetting and wants read event
61  * RWRITE,      Resetting and wants write event
62  */
63 enum SQLstatus { CREAD, CWRITE, WREAD, WWRITE, RREAD, RWRITE };
64
65 /** SQLhost, simple structure to store information about a SQL-connection-to-be
66  * We use this struct simply to make it neater passing around host information
67  * when we're creating connections and resolving hosts.
68  * Rather than giving SQLresolver a parameter for every field here so it can in
69  * turn call SQLConn's constructor with them all, both can simply use a SQLhost.
70  */
71 class SQLhost
72 {
73  public:
74         std::string             id;             /* Database handle id */
75         std::string     host;   /* Database server hostname */
76         unsigned int    port;   /* Database server port */
77         std::string     name;   /* Database name */
78         std::string     user;   /* Database username */
79         std::string     pass;   /* Database password */
80         bool                    ssl;    /* If we should require SSL */
81  
82         SQLhost()
83         {
84         }               
85
86         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)
87         : id(i), host(h), port(p), name(n), user(u), pass(pa), ssl(s)
88         {
89         }
90 };
91
92 class SQLresolver : public Resolver
93 {
94  private:
95         SQLhost host;
96         ModulePgSQL* mod;
97  public:
98         SQLresolver(ModulePgSQL* m, Server* srv, const SQLhost& hi)
99         : Resolver(hi.host, DNS_QUERY_FORWARD), host(hi), mod(m)
100         {
101         }
102
103         virtual void OnLookupComplete(const std::string &result);
104
105         virtual void OnError(ResolverError e, const std::string &errormessage)
106         {
107                 log(DEBUG, "DNS lookup failed (%s), dying horribly", errormessage.c_str());
108         }
109
110         virtual ~SQLresolver()
111         {
112         }
113 };
114
115 /** QueryQueue, a queue of queries waiting to be executed.
116  * This maintains two queues internally, one for 'priority'
117  * queries and one for less important ones. Each queue has
118  * new queries appended to it and ones to execute are popped
119  * off the front. This keeps them flowing round nicely and no
120  * query should ever get 'stuck' for too long. If there are
121  * queries in the priority queue they will be executed first,
122  * 'unimportant' queries will only be executed when the
123  * priority queue is empty.
124  *
125  * We store lists of SQLrequest's here, by value as we want to avoid storing
126  * any data allocated inside the client module (in case that module is unloaded
127  * while the query is in progress).
128  *
129  * Because we want to work on the current SQLrequest in-situ, we need a way
130  * of accessing the request we are currently processing, QueryQueue::front(),
131  * but that call needs to always return the same request until that request
132  * is removed from the queue, this is what the 'which' variable is. New queries are
133  * always added to the back of one of the two queues, but if when front()
134  * is first called then the priority queue is empty then front() will return
135  * a query from the normal queue, but if a query is then added to the priority
136  * queue then front() must continue to return the front of the *normal* queue
137  * until pop() is called.
138  */
139
140 class QueryQueue : public classbase
141 {
142 private:
143         typedef std::deque<SQLrequest> ReqDeque;        
144
145         ReqDeque priority;      /* The priority queue */
146         ReqDeque normal;        /* The 'normal' queue */
147         enum { PRI, NOR, NON } which;   /* Which queue the currently active element is at the front of */
148
149 public:
150         QueryQueue()
151         : which(NON)
152         {
153         }
154         
155         void push(const SQLrequest &q)
156         {
157                 log(DEBUG, "QueryQueue::push(): Adding %s query to queue: %s", ((q.pri) ? "priority" : "non-priority"), q.query.q.c_str());
158                 
159                 if(q.pri)
160                         priority.push_back(q);
161                 else
162                         normal.push_back(q);
163         }
164         
165         void pop()
166         {
167                 if((which == PRI) && priority.size())
168                 {
169                         priority.pop_front();
170                 }
171                 else if((which == NOR) && normal.size())
172                 {
173                         normal.pop_front();
174                 }
175                 
176                 /* Reset this */
177                 which = NON;
178                 
179                 /* Silently do nothing if there was no element to pop() */
180         }
181         
182         SQLrequest& front()
183         {
184                 switch(which)
185                 {
186                         case PRI:
187                                 return priority.front();
188                         case NOR:
189                                 return normal.front();
190                         default:
191                                 if(priority.size())
192                                 {
193                                         which = PRI;
194                                         return priority.front();
195                                 }
196                                 
197                                 if(normal.size())
198                                 {
199                                         which = NOR;
200                                         return normal.front();
201                                 }
202                                 
203                                 /* This will probably result in a segfault,
204                                  * but the caller should have checked totalsize()
205                                  * first so..meh - moron :p
206                                  */
207                                 
208                                 return priority.front();
209                 }
210         }
211         
212         std::pair<int, int> size()
213         {
214                 return std::make_pair(priority.size(), normal.size());
215         }
216         
217         int totalsize()
218         {
219                 return priority.size() + normal.size();
220         }
221         
222         void PurgeModule(Module* mod)
223         {
224                 DoPurgeModule(mod, priority);
225                 DoPurgeModule(mod, normal);
226         }
227         
228 private:
229         void DoPurgeModule(Module* mod, ReqDeque& q)
230         {
231                 for(ReqDeque::iterator iter = q.begin(); iter != q.end(); iter++)
232                 {
233                         if(iter->GetSource() == mod)
234                         {
235                                 if(iter->id == front().id)
236                                 {
237                                         /* It's the currently active query.. :x */
238                                         iter->SetSource(NULL);
239                                 }
240                                 else
241                                 {
242                                         /* It hasn't been executed yet..just remove it */
243                                         iter = q.erase(iter);
244                                 }
245                         }
246                 }
247         }
248 };
249
250 /** PgSQLresult is a subclass of the mostly-pure-virtual class SQLresult.
251  * All SQL providers must create their own subclass and define it's methods using that
252  * database library's data retriveal functions. The aim is to avoid a slow and inefficient process
253  * of converting all data to a common format before it reaches the result structure. This way
254  * data is passes to the module nearly as directly as if it was using the API directly itself.
255  */
256
257 class PgSQLresult : public SQLresult
258 {
259         PGresult* res;
260         int currentrow;
261         int rows;
262         int cols;
263         
264         SQLfieldList* fieldlist;
265         SQLfieldMap* fieldmap;
266 public:
267         PgSQLresult(Module* self, Module* to, unsigned long id, PGresult* result)
268         : SQLresult(self, to, id), res(result), currentrow(0), fieldlist(NULL), fieldmap(NULL)
269         {
270                 rows = PQntuples(res);
271                 cols = PQnfields(res);
272                 
273                 log(DEBUG, "Created new PgSQL result; %d rows, %d columns, %s affected", rows, cols, PQcmdTuples(res));
274         }
275         
276         ~PgSQLresult()
277         {
278                 /* If we allocated these, free them... */
279                 if(fieldlist)
280                         DELETE(fieldlist);
281                 
282                 if(fieldmap)
283                         DELETE(fieldmap);
284                 
285                 PQclear(res);
286         }
287         
288         virtual int Rows()
289         {
290                 if(!cols && !rows)
291                 {
292                         return atoi(PQcmdTuples(res));
293                 }
294                 else
295                 {
296                         return rows;
297                 }
298         }
299         
300         virtual int Cols()
301         {
302                 return PQnfields(res);
303         }
304         
305         virtual std::string ColName(int column)
306         {
307                 char* name = PQfname(res, column);
308                 
309                 return (name) ? name : "";
310         }
311         
312         virtual int ColNum(const std::string &column)
313         {
314                 int n = PQfnumber(res, column.c_str());
315                 
316                 if(n == -1)
317                 {
318                         throw SQLbadColName();
319                 }
320                 else
321                 {
322                         return n;
323                 }
324         }
325         
326         virtual SQLfield GetValue(int row, int column)
327         {
328                 char* v = PQgetvalue(res, row, column);
329                 
330                 if(v)
331                 {
332                         return SQLfield(std::string(v, PQgetlength(res, row, column)), PQgetisnull(res, row, column));
333                 }
334                 else
335                 {
336                         log(DEBUG, "PQgetvalue returned a null pointer..nobody wants to tell us what this means");
337                         throw SQLbadColName();
338                 }
339         }
340         
341         virtual SQLfieldList& GetRow()
342         {
343                 /* In an effort to reduce overhead we don't actually allocate the list
344                  * until the first time it's needed...so...
345                  */
346                 if(fieldlist)
347                 {
348                         fieldlist->clear();
349                 }
350                 else
351                 {
352                         fieldlist = new SQLfieldList;
353                 }
354                 
355                 if(currentrow < PQntuples(res))
356                 {
357                         int cols = PQnfields(res);
358                         
359                         for(int i = 0; i < cols; i++)
360                         {
361                                 fieldlist->push_back(GetValue(currentrow, i));
362                         }
363                         
364                         currentrow++;
365                 }
366                 
367                 return *fieldlist;
368         }
369         
370         virtual SQLfieldMap& GetRowMap()
371         {
372                 /* In an effort to reduce overhead we don't actually allocate the map
373                  * until the first time it's needed...so...
374                  */
375                 if(fieldmap)
376                 {
377                         fieldmap->clear();
378                 }
379                 else
380                 {
381                         fieldmap = new SQLfieldMap;
382                 }
383                 
384                 if(currentrow < PQntuples(res))
385                 {
386                         int cols = PQnfields(res);
387                         
388                         for(int i = 0; i < cols; i++)
389                         {
390                                 fieldmap->insert(std::make_pair(ColName(i), GetValue(currentrow, i)));
391                         }
392                         
393                         currentrow++;
394                 }
395                 
396                 return *fieldmap;
397         }
398         
399         virtual SQLfieldList* GetRowPtr()
400         {
401                 SQLfieldList* fl = new SQLfieldList;
402                 
403                 if(currentrow < PQntuples(res))
404                 {
405                         int cols = PQnfields(res);
406                         
407                         for(int i = 0; i < cols; i++)
408                         {
409                                 fl->push_back(GetValue(currentrow, i));
410                         }
411                         
412                         currentrow++;
413                 }
414                 
415                 return fl;
416         }
417         
418         virtual SQLfieldMap* GetRowMapPtr()
419         {
420                 SQLfieldMap* fm = new SQLfieldMap;
421                 
422                 if(currentrow < PQntuples(res))
423                 {
424                         int cols = PQnfields(res);
425                         
426                         for(int i = 0; i < cols; i++)
427                         {
428                                 fm->insert(std::make_pair(ColName(i), GetValue(currentrow, i)));
429                         }
430                         
431                         currentrow++;
432                 }
433                 
434                 return fm;
435         }
436         
437         virtual void Free(SQLfieldMap* fm)
438         {
439                 DELETE(fm);
440         }
441         
442         virtual void Free(SQLfieldList* fl)
443         {
444                 DELETE(fl);
445         }
446 };
447
448 /** SQLConn represents one SQL session.
449  * Each session has its own persistent connection to the database.
450  * This is a subclass of InspSocket so it can easily recieve read/write events from the core socket
451  * engine, unlike the original MySQL module this module does not block. Ever. It gets a mild stabbing
452  * if it dares to.
453  */
454
455 class SQLConn : public InspSocket
456 {
457 private:
458         ModulePgSQL* us;                /* Pointer to the SQL provider itself */
459         Server* Srv;                    /* Server* for..uhm..something, maybe */
460         std::string     dbhost; /* Database server hostname */
461         unsigned int    dbport; /* Database server port */
462         std::string     dbname; /* Database name */
463         std::string     dbuser; /* Database username */
464         std::string     dbpass; /* Database password */
465         bool                    ssl;    /* If we should require SSL */
466         PGconn*                 sql;    /* PgSQL database connection handle */
467         SQLstatus               status; /* PgSQL database connection status */
468         bool                    qinprog;/* If there is currently a query in progress */
469         QueryQueue              queue;  /* Queue of queries waiting to be executed on this connection */
470         time_t                  idle;   /* Time we last heard from the database */
471
472 public:
473
474         /* This class should only ever be created inside this module, using this constructor, so we don't have to worry about the default ones */
475
476         SQLConn(InspIRCd* SI, ModulePgSQL* self, Server* srv, const SQLhost& hostinfo);
477
478         ~SQLConn();
479
480         bool DoConnect();
481
482         virtual void Close();
483         
484         bool DoPoll();
485         
486         bool DoConnectedPoll();
487
488         bool DoResetPoll();
489         
490         void ShowStatus();      
491         
492         virtual bool OnDataReady();
493
494         virtual bool OnWriteReady();
495         
496         virtual bool OnConnected();
497         
498         bool DoEvent();
499         
500         bool Reconnect();
501         
502         std::string MkInfoStr();
503         
504         const char* StatusStr();
505         
506         SQLerror DoQuery(SQLrequest &req);
507         
508         SQLerror Query(const SQLrequest &req);
509         
510         void OnUnloadModule(Module* mod);
511 };
512
513 class ModulePgSQL : public Module
514 {
515 private:
516         Server* Srv;
517         ConnMap connections;
518         unsigned long currid;
519         char* sqlsuccess;
520
521 public:
522         ModulePgSQL(Server* Me)
523         : Module::Module(Me), Srv(Me), currid(0)
524         {
525                 log(DEBUG, "%s 'SQL' feature", Srv->PublishFeature("SQL", this) ? "Published" : "Couldn't publish");
526                 
527                 sqlsuccess = new char[strlen(SQLSUCCESS)+1];
528                 
529                 strcpy(sqlsuccess, SQLSUCCESS);
530
531                 OnRehash("");
532         }
533
534         void Implements(char* List)
535         {
536                 List[I_OnUnloadModule] = List[I_OnRequest] = List[I_OnRehash] = List[I_OnUserRegister] = List[I_OnCheckReady] = List[I_OnUserDisconnect] = 1;
537         }
538
539         virtual void OnRehash(const std::string &parameter)
540         {
541                 ConfigReader conf;
542                 
543                 /* Delete all the SQLConn objects in the connection lists,
544                  * this will call their destructors where they can handle
545                  * closing connections and such.
546                  */
547                 for(ConnMap::iterator iter = connections.begin(); iter != connections.end(); iter++)
548                 {
549                         DELETE(iter->second);
550                 }
551                 
552                 /* Empty out our list of connections */
553                 connections.clear();
554
555                 for(int i = 0; i < conf.Enumerate("database"); i++)
556                 {
557                         SQLhost host;                   
558                         int ipvalid;
559                         insp_inaddr blargle;
560                         
561                         host.id         = conf.ReadValue("database", "id", i);
562                         host.host       = conf.ReadValue("database", "hostname", i);
563                         host.port       = conf.ReadInteger("database", "port", i, true);
564                         host.name       = conf.ReadValue("database", "name", i);
565                         host.user       = conf.ReadValue("database", "username", i);
566                         host.pass       = conf.ReadValue("database", "password", i);
567                         host.ssl        = conf.ReadFlag("database", "ssl", i);
568                         
569                         ipvalid = insp_aton(host.host.c_str(), &blargle);
570                         
571                         if(ipvalid > 0)
572                         {
573                                 /* The conversion succeeded, we were given an IP and we can give it straight to SQLConn */
574                                 this->AddConn(host);
575                         }
576                         else if(ipvalid == 0)
577                         {
578                                 /* Conversion failed, assume it's a host */
579                                 SQLresolver* resolver;
580                                 
581                                 resolver = new SQLresolver(this, Srv, host);
582                                 
583                                 Srv->AddResolver(resolver);
584                         }
585                         else
586                         {
587                                 /* Invalid address family, die horribly. */
588                                 log(DEBUG, "insp_aton failed returning -1, oh noes.");
589                         }
590                 }       
591         }
592         
593         void AddConn(const SQLhost& hi)
594         {
595                 SQLConn* newconn;
596                                 
597                 /* The conversion succeeded, we were given an IP and we can give it straight to SQLConn */
598                 newconn = new SQLConn(this, Srv, hi);
599                                 
600                 connections.insert(std::make_pair(hi.id, newconn));
601         }
602         
603         virtual char* OnRequest(Request* request)
604         {
605                 if(strcmp(SQLREQID, request->GetId()) == 0)
606                 {
607                         SQLrequest* req = (SQLrequest*)request;
608                         ConnMap::iterator iter;
609                 
610                         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());
611
612                         if((iter = connections.find(req->dbid)) != connections.end())
613                         {
614                                 /* Execute query */
615                                 req->id = NewID();
616                                 req->error = iter->second->Query(*req);
617                                 
618                                 return (req->error.Id() == NO_ERROR) ? sqlsuccess : NULL;
619                         }
620                         else
621                         {
622                                 req->error.Id(BAD_DBID);
623                                 return NULL;
624                         }
625                 }
626
627                 log(DEBUG, "Got unsupported API version string: %s", request->GetId());
628                 
629                 return NULL;
630         }
631         
632         virtual void OnUnloadModule(Module* mod, const std::string&     name)
633         {
634                 /* When a module unloads we have to check all the pending queries for all our connections
635                  * and set the Module* specifying where the query came from to NULL. If the query has already
636                  * been dispatched then when it is processed it will be dropped if the pointer is NULL.
637                  *
638                  * If the queries we find are not already being executed then we can simply remove them immediately.
639                  */
640                 for(ConnMap::iterator iter = connections.begin(); iter != connections.end(); iter++)
641                 {
642                         iter->second->OnUnloadModule(mod);
643                 }
644         }
645
646         unsigned long NewID()
647         {
648                 if (currid+1 == 0)
649                         currid++;
650                 
651                 return ++currid;
652         }
653                 
654         virtual Version GetVersion()
655         {
656                 return Version(1, 0, 0, 0, VF_VENDOR|VF_SERVICEPROVIDER);
657         }
658         
659         virtual ~ModulePgSQL()
660         {
661                 DELETE(sqlsuccess);
662         }       
663 };
664
665 SQLConn::SQLConn(InspIRCd* SI, ModulePgSQL* self, Server* srv, const SQLhost& hi)
666 : InspSocket::InspSocket(SI), us(self), Srv(srv), dbhost(hi.host), dbport(hi.port), dbname(hi.name), dbuser(hi.user), dbpass(hi.pass), ssl(hi.ssl), sql(NULL), status(CWRITE), qinprog(false)
667 {
668         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());
669
670         /* Some of this could be reviewed, unsure if I need to fill 'host' etc...
671          * just copied this over from the InspSocket constructor.
672          */
673         strlcpy(this->host, dbhost.c_str(), MAXBUF);
674         strlcpy(this->IP, dbhost.c_str(), MAXBUF);
675         this->port = dbport;
676         idle = TIME;
677         
678         this->ClosePending = false;
679                         
680         log(DEBUG,"No need to resolve %s", this->host);
681         
682                 
683         if(!this->DoConnect())
684         {
685                 throw ModuleException("Connect failed");
686         }
687 }
688
689 SQLConn::~SQLConn()
690 {
691         Close();
692 }
693
694 bool SQLConn::DoConnect()
695 {
696         log(DEBUG, "SQLConn::DoConnect()");
697         
698         if(!(sql = PQconnectStart(MkInfoStr().c_str())))
699         {
700                 log(DEBUG, "Couldn't allocate PGconn structure, aborting: %s", PQerrorMessage(sql));
701                 Close();
702                 return false;
703         }
704         
705         if(PQstatus(sql) == CONNECTION_BAD)
706         {
707                 log(DEBUG, "PQconnectStart failed: %s", PQerrorMessage(sql));
708                 Close();
709                 return false;
710         }
711         
712         ShowStatus();
713         
714         if(PQsetnonblocking(sql, 1) == -1)
715         {
716                 log(DEBUG, "Couldn't set connection nonblocking: %s", PQerrorMessage(sql));
717                 Close();
718                 return false;
719         }
720         
721         /* OK, we've initalised the connection, now to get it hooked into the socket engine
722          * and then start polling it.
723          */
724         
725         log(DEBUG, "Old DNS socket: %d", this->fd);
726         this->fd = PQsocket(sql);
727         log(DEBUG, "New SQL socket: %d", this->fd);
728         
729         if(this->fd <= -1)
730         {
731                 log(DEBUG, "PQsocket says we have an invalid FD: %d", this->fd);
732                 Close();
733                 return false;
734         }
735         
736         this->state = I_CONNECTING;
737         if (!ServerInstance->SE->AddFd(this->fd,false,X_ESTAB_MODULE))
738         {
739                 log(DEBUG, "A PQsocket cant be added to the socket engine!");
740                 Close();
741                 return false;
742         }
743         Instance->socket_ref[this->fd] = this;
744         
745         /* Socket all hooked into the engine, now to tell PgSQL to start connecting */
746         
747         return DoPoll();
748 }
749
750 void SQLConn::Close()
751 {
752         log(DEBUG,"SQLConn::Close");
753         
754         if(this->fd > 01)
755                 Instance->socket_ref[this->fd] = NULL;
756         this->fd = -1;
757         this->state = I_ERROR;
758         this->OnError(I_ERR_SOCKET);
759         this->ClosePending = true;
760         
761         if(sql)
762         {
763                 PQfinish(sql);
764                 sql = NULL;
765         }
766         
767         return;
768 }
769
770 bool SQLConn::DoPoll()
771 {
772         switch(PQconnectPoll(sql))
773         {
774                 case PGRES_POLLING_WRITING:
775                         log(DEBUG, "PGconnectPoll: PGRES_POLLING_WRITING");
776                         WantWrite();
777                         status = CWRITE;
778                         return DoPoll();
779                 case PGRES_POLLING_READING:
780                         log(DEBUG, "PGconnectPoll: PGRES_POLLING_READING");
781                         status = CREAD;
782                         return true;
783                 case PGRES_POLLING_FAILED:
784                         log(DEBUG, "PGconnectPoll: PGRES_POLLING_FAILED: %s", PQerrorMessage(sql));
785                         return false;
786                 case PGRES_POLLING_OK:
787                         log(DEBUG, "PGconnectPoll: PGRES_POLLING_OK");
788                         status = WWRITE;
789                         return DoConnectedPoll();
790                 default:
791                         log(DEBUG, "PGconnectPoll: wtf?");
792                         return true;
793         }
794 }
795
796 bool SQLConn::DoConnectedPoll()
797 {
798         if(!qinprog && queue.totalsize())
799         {
800                 /* There's no query currently in progress, and there's queries in the queue. */
801                 SQLrequest& query = queue.front();
802                 DoQuery(query);
803         }
804         
805         if(PQconsumeInput(sql))
806         {
807                 log(DEBUG, "PQconsumeInput succeeded");
808                 
809                 /* We just read stuff from the server, that counts as it being alive
810                  * so update the idle-since time :p
811                  */
812                 idle = TIME;
813                         
814                 if(PQisBusy(sql))
815                 {
816                         log(DEBUG, "Still busy processing command though");
817                 }
818                 else if(qinprog)
819                 {
820                         log(DEBUG, "Looks like we have a result to process!");
821                         
822                         /* Grab the request we're processing */
823                         SQLrequest& query = queue.front();
824                         
825                         log(DEBUG, "ID is %lu", query.id);
826                         
827                         /* Get a pointer to the module we're about to return the result to */
828                         Module* to = query.GetSource();
829                         
830                         /* Fetch the result.. */
831                         PGresult* result = PQgetResult(sql);
832                         
833                         /* PgSQL would allow a query string to be sent which has multiple
834                          * queries in it, this isn't portable across database backends and
835                          * we don't want modules doing it. But just in case we make sure we
836                          * drain any results there are and just use the last one.
837                          * If the module devs are behaving there will only be one result.
838                          */
839                         while (PGresult* temp = PQgetResult(sql))
840                         {
841                                 PQclear(result);
842                                 result = temp;
843                         }
844                         
845                         if(to)
846                         {
847                                 /* ..and the result */
848                                 PgSQLresult reply(us, to, query.id, result);
849                                 
850                                 log(DEBUG, "Got result, status code: %s; error message: %s", PQresStatus(PQresultStatus(result)), PQresultErrorMessage(result));        
851                                 
852                                 switch(PQresultStatus(result))
853                                 {
854                                         case PGRES_EMPTY_QUERY:
855                                         case PGRES_BAD_RESPONSE:
856                                         case PGRES_FATAL_ERROR:
857                                                 reply.error.Id(QREPLY_FAIL);
858                                                 reply.error.Str(PQresultErrorMessage(result));
859                                         default:;
860                                                 /* No action, other values are not errors */
861                                 }
862                                 
863                                 reply.Send();
864                                 
865                                 /* PgSQLresult's destructor will free the PGresult */
866                         }
867                         else
868                         {
869                                 /* If the client module is unloaded partway through a query then the provider will set
870                                  * the pointer to NULL. We cannot just cancel the query as the result will still come
871                                  * through at some point...and it could get messy if we play with invalid pointers...
872                                  */
873                                 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);
874                                 PQclear(result);
875                         }
876                         
877                         qinprog = false;
878                         queue.pop();                            
879                         DoConnectedPoll();
880                 }
881                 else
882                 {
883                         log(DEBUG, "Eh!? We just got a read event, and connection isn't busy..but no result :(");
884                 }
885                 
886                 return true;
887         }
888         else
889         {
890                 /* I think we'll assume this means the server died...it might not,
891                  * but I think that any error serious enough we actually get here
892                  * deserves to reconnect [/excuse]
893                  * Returning true so the core doesn't try and close the connection.
894                  */
895                 log(DEBUG, "PQconsumeInput failed: %s", PQerrorMessage(sql));
896                 Reconnect();
897                 return true;
898         }
899 }
900
901 bool SQLConn::DoResetPoll()
902 {
903         switch(PQresetPoll(sql))
904         {
905                 case PGRES_POLLING_WRITING:
906                         log(DEBUG, "PGresetPoll: PGRES_POLLING_WRITING");
907                         WantWrite();
908                         status = CWRITE;
909                         return DoPoll();
910                 case PGRES_POLLING_READING:
911                         log(DEBUG, "PGresetPoll: PGRES_POLLING_READING");
912                         status = CREAD;
913                         return true;
914                 case PGRES_POLLING_FAILED:
915                         log(DEBUG, "PGresetPoll: PGRES_POLLING_FAILED: %s", PQerrorMessage(sql));
916                         return false;
917                 case PGRES_POLLING_OK:
918                         log(DEBUG, "PGresetPoll: PGRES_POLLING_OK");
919                         status = WWRITE;
920                         return DoConnectedPoll();
921                 default:
922                         log(DEBUG, "PGresetPoll: wtf?");
923                         return true;
924         }
925 }
926
927 void SQLConn::ShowStatus()
928 {
929         switch(PQstatus(sql))
930         {
931                 case CONNECTION_STARTED:
932                         log(DEBUG, "PQstatus: CONNECTION_STARTED: Waiting for connection to be made.");
933                         break;
934
935                 case CONNECTION_MADE:
936                         log(DEBUG, "PQstatus: CONNECTION_MADE: Connection OK; waiting to send.");
937                         break;
938                 
939                 case CONNECTION_AWAITING_RESPONSE:
940                         log(DEBUG, "PQstatus: CONNECTION_AWAITING_RESPONSE: Waiting for a response from the server.");
941                         break;
942                 
943                 case CONNECTION_AUTH_OK:
944                         log(DEBUG, "PQstatus: CONNECTION_AUTH_OK: Received authentication; waiting for backend start-up to finish.");
945                         break;
946                 
947                 case CONNECTION_SSL_STARTUP:
948                         log(DEBUG, "PQstatus: CONNECTION_SSL_STARTUP: Negotiating SSL encryption.");
949                         break;
950                 
951                 case CONNECTION_SETENV:
952                         log(DEBUG, "PQstatus: CONNECTION_SETENV: Negotiating environment-driven parameter settings.");
953                         break;
954                 
955                 default:
956                         log(DEBUG, "PQstatus: ???");
957         }
958 }
959
960 bool SQLConn::OnDataReady()
961 {
962         /* Always return true here, false would close the socket - we need to do that ourselves with the pgsql API */
963         log(DEBUG, "OnDataReady(): status = %s", StatusStr());
964         
965         return DoEvent();
966 }
967
968 bool SQLConn::OnWriteReady()
969 {
970         /* Always return true here, false would close the socket - we need to do that ourselves with the pgsql API */
971         log(DEBUG, "OnWriteReady(): status = %s", StatusStr());
972         
973         return DoEvent();
974 }
975
976 bool SQLConn::OnConnected()
977 {
978         log(DEBUG, "OnConnected(): status = %s", StatusStr());
979         
980         return DoEvent();
981 }
982
983 bool SQLConn::Reconnect()
984 {
985         log(DEBUG, "Initiating reconnect");
986         
987         if(PQresetStart(sql))
988         {
989                 /* Successfully initiatied database reconnect,
990                  * set flags so PQresetPoll() will be called appropriately
991                  */
992                 status = RWRITE;
993                 qinprog = false;
994                 return true;
995         }
996         else
997         {
998                 log(DEBUG, "Failed to initiate reconnect...fun");
999                 return false;
1000         }       
1001 }
1002
1003 bool SQLConn::DoEvent()
1004 {
1005         bool ret;
1006         
1007         if((status == CREAD) || (status == CWRITE))
1008         {
1009                 ret = DoPoll();
1010         }
1011         else if((status == RREAD) || (status == RWRITE))
1012         {
1013                 ret = DoResetPoll();
1014         }
1015         else
1016         {
1017                 ret = DoConnectedPoll();
1018         }
1019         
1020         switch(PQflush(sql))
1021         {
1022                 case -1:
1023                         log(DEBUG, "Error flushing write queue: %s", PQerrorMessage(sql));
1024                         break;
1025                 case 0:
1026                         log(DEBUG, "Successfully flushed write queue (or there was nothing to write)");
1027                         break;
1028                 case 1:
1029                         log(DEBUG, "Not all of the write queue written, triggering write event so we can have another go");
1030                         WantWrite();
1031                         break;
1032         }
1033
1034         return ret;
1035 }
1036
1037 std::string SQLConn::MkInfoStr()
1038 {                       
1039         std::ostringstream conninfo("connect_timeout = '2'");
1040         
1041         if(dbhost.length())
1042                 conninfo << " hostaddr = '" << dbhost << "'";
1043         
1044         if(dbport)
1045                 conninfo << " port = '" << dbport << "'";
1046         
1047         if(dbname.length())
1048                 conninfo << " dbname = '" << dbname << "'";
1049         
1050         if(dbuser.length())
1051                 conninfo << " user = '" << dbuser << "'";
1052         
1053         if(dbpass.length())
1054                 conninfo << " password = '" << dbpass << "'";
1055         
1056         if(ssl)
1057                 conninfo << " sslmode = 'require'";
1058         
1059         return conninfo.str();
1060 }
1061
1062 const char* SQLConn::StatusStr()
1063 {
1064         if(status == CREAD) return "CREAD";
1065         if(status == CWRITE) return "CWRITE";
1066         if(status == WREAD) return "WREAD";
1067         if(status == WWRITE) return "WWRITE";
1068         return "Err...what, erm..BUG!";
1069 }
1070
1071 SQLerror SQLConn::DoQuery(SQLrequest &req)
1072 {
1073         if((status == WREAD) || (status == WWRITE))
1074         {
1075                 if(!qinprog)
1076                 {
1077                         /* Parse the command string and dispatch it */
1078                         
1079                         /* Pointer to the buffer we screw around with substitution in */
1080                         char* query;
1081                         /* Pointer to the current end of query, where we append new stuff */
1082                         char* queryend;
1083                         /* Total length of the unescaped parameters */
1084                         unsigned int paramlen;
1085                         
1086                         paramlen = 0;
1087                         
1088                         for(ParamL::iterator i = req.query.p.begin(); i != req.query.p.end(); i++)
1089                         {
1090                                 paramlen += i->size();
1091                         }
1092                         
1093                         /* To avoid a lot of allocations, allocate enough memory for the biggest the escaped query could possibly be.
1094                          * sizeofquery + (totalparamlength*2) + 1
1095                          * 
1096                          * The +1 is for null-terminating the string for PQsendQuery()
1097                          */
1098                         
1099                         query = new char[req.query.q.length() + (paramlen*2)];
1100                         queryend = query;
1101                         
1102                         /* Okay, now we have a buffer large enough we need to start copying the query into it and escaping and substituting
1103                          * the parameters into it...
1104                          */
1105                         
1106                         for(unsigned int i = 0; i < req.query.q.length(); i++)
1107                         {
1108                                 if(req.query.q[i] == '?')
1109                                 {
1110                                         /* We found a place to substitute..what fun.
1111                                          * Use the PgSQL calls to escape and write the
1112                                          * escaped string onto the end of our query buffer,
1113                                          * then we "just" need to make sure queryend is
1114                                          * pointing at the right place.
1115                                          */
1116                                         
1117                                         if(req.query.p.size())
1118                                         {
1119                                                 int error = 0;
1120                                                 size_t len = 0;
1121
1122 #ifdef PGSQL_HAS_ESCAPECONN
1123                                                 len = PQescapeStringConn(sql, queryend, req.query.p.front().c_str(), req.query.p.front().length(), &error);
1124 #else
1125                                                 len = PQescapeStringConn(queryend, req.query.p.front().c_str(), req.query.p.front().length());
1126                                                 error = 0;
1127 #endif
1128                                                 
1129                                                 if(error)
1130                                                 {
1131                                                         log(DEBUG, "Apparently PQescapeStringConn() failed somehow...don't know how or what to do...");
1132                                                 }
1133                                                 
1134                                                 log(DEBUG, "Appended %d bytes of escaped string onto the query", len);
1135                                                 
1136                                                 /* Incremenet queryend to the end of the newly escaped parameter */
1137                                                 queryend += len;
1138                                                 
1139                                                 /* Remove the parameter we just substituted in */
1140                                                 req.query.p.pop_front();
1141                                         }
1142                                         else
1143                                         {
1144                                                 log(DEBUG, "Found a substitution location but no parameter to substitute :|");
1145                                                 break;
1146                                         }
1147                                 }
1148                                 else
1149                                 {
1150                                         *queryend = req.query.q[i];
1151                                         queryend++;
1152                                 }
1153                         }
1154                         
1155                         /* Null-terminate the query */
1156                         *queryend = 0;
1157         
1158                         log(DEBUG, "Attempting to dispatch query: %s", query);
1159                         
1160                         req.query.q = query;
1161
1162                         if(PQsendQuery(sql, query))
1163                         {
1164                                 log(DEBUG, "Dispatched query successfully");
1165                                 qinprog = true;
1166                                 DELETE(query);
1167                                 return SQLerror();
1168                         }
1169                         else
1170                         {
1171                                 log(DEBUG, "Failed to dispatch query: %s", PQerrorMessage(sql));
1172                                 DELETE(query);
1173                                 return SQLerror(QSEND_FAIL, PQerrorMessage(sql));
1174                         }
1175                 }
1176         }
1177
1178         log(DEBUG, "Can't query until connection is complete");
1179         return SQLerror(BAD_CONN, "Can't query until connection is complete");
1180 }
1181
1182 SQLerror SQLConn::Query(const SQLrequest &req)
1183 {
1184         queue.push(req);
1185         
1186         if(!qinprog && queue.totalsize())
1187         {
1188                 /* There's no query currently in progress, and there's queries in the queue. */
1189                 SQLrequest& query = queue.front();
1190                 return DoQuery(query);
1191         }
1192         else
1193         {
1194                 return SQLerror();
1195         }
1196 }
1197
1198 void SQLConn::OnUnloadModule(Module* mod)
1199 {
1200         queue.PurgeModule(mod);
1201 }
1202
1203 void SQLresolver::OnLookupComplete(const std::string &result)
1204 {
1205         host.host = result;
1206         mod->AddConn(host);
1207 }
1208
1209 class ModulePgSQLFactory : public ModuleFactory
1210 {
1211  public:
1212         ModulePgSQLFactory()
1213         {
1214         }
1215         
1216         ~ModulePgSQLFactory()
1217         {
1218         }
1219         
1220         virtual Module * CreateModule(Server* Me)
1221         {
1222                 return new ModulePgSQL(Me);
1223         }
1224 };
1225
1226
1227 extern "C" void * init_module( void )
1228 {
1229         return new ModulePgSQLFactory;
1230 }