src/modules/extra/m_pgsql.cpp

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