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