]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/extra/m_sqlv2.h
Allow freeform queries. Allow $nick, $host, $ip, $pass, $md5pass and $sha256pass...
[user/henk/code/inspircd.git] / src / modules / extra / m_sqlv2.h
index 50047148888ea63dd65c01ec0e47e81e6139518b..2e0ab2a1931eaa60777a6026f184667da382a26a 100644 (file)
@@ -2,11 +2,11 @@
  *       | Inspire Internet Relay Chat Daemon |
  *       +------------------------------------+
  *
- *  InspIRCd: (C) 2002-2007 InspIRCd Development Team
+ *  InspIRCd: (C) 2002-2008 InspIRCd Development Team
  * See: http://www.inspircd.org/wiki/index.php/Credits
  *
  * This program is free but copyrighted software; see
- *            the file COPYING for details.
+ *          the file COPYING for details.
  *
  * ---------------------------------------------------
  */
 #include <map>
 #include "modules.h"
 
-/** SQLreq define.
- * This is the voodoo magic which lets us pass multiple
- * parameters to the SQLrequest constructor... voodoo...
- */
-#define SQLreq(a, b, c, d, e...) SQLrequest(a, b, c, (SQLquery(d), ##e))
-
 /** Identifiers used to identify Request types
  */
 #define SQLREQID "SQLv2 Request"
@@ -140,11 +134,11 @@ public:
  * the workaround for this isn't easy to describe simply, but in a nutshell what's really
  * happening when - from the above example - you do this:
  *
- * SQLrequest foo = SQLreq(this, target, "databaseid", "SELECT (foo, bar) FROM rawr WHERE foo = '?' AND bar = ?", "Hello", "42");
+ * SQLrequest foo = SQLrequest(this, target, "databaseid", SQLquery("SELECT (foo, bar) FROM rawr WHERE foo = '?' AND bar = ?", "Hello", "42"));
  *
  * what's actually happening is functionally this:
  *
- * SQLrequest foo = SQLreq(this, target, "databaseid", query("SELECT (foo, bar) FROM rawr WHERE foo = '?' AND bar = ?").addparam("Hello").addparam("42"));
+ * SQLrequest foo = SQLrequest(this, target, "databaseid", query("SELECT (foo, bar) FROM rawr WHERE foo = '?' AND bar = ?").addparam("Hello").addparam("42"));
  *
  * with 'query()' returning a reference to an object with a 'addparam()' member function which
  * in turn returns a reference to that object. There are actually four ways you can create a
@@ -233,7 +227,7 @@ public:
        /** Initialize an SQLrequest.
         * For example:
         *
-        * SQLrequest req = SQLreq(MyMod, SQLModule, dbid, "INSERT INTO ircd_log_actors VALUES('','?')", nick);
+        * SQLrequest req = SQLrequest(MyMod, SQLModule, dbid, SQLquery("INSERT INTO ircd_log_actors VALUES('','?')" % nick));
         *
         * @param s A pointer to the sending module, where the result should be routed
         * @param d A pointer to the receiving module, identified as implementing the 'SQL' feature
@@ -467,4 +461,139 @@ bool operator== (const SQLhost& l, const SQLhost& r)
        return (l.id == r.id && l.host == r.host && l.port == r.port && l.name == r.name && l.user == l.user && l.pass == r.pass && l.ssl == r.ssl);
 }
 
+
+/** QueryQueue, a queue of queries waiting to be executed.
+ * This maintains two queues internally, one for 'priority'
+ * queries and one for less important ones. Each queue has
+ * new queries appended to it and ones to execute are popped
+ * off the front. This keeps them flowing round nicely and no
+ * query should ever get 'stuck' for too long. If there are
+ * queries in the priority queue they will be executed first,
+ * 'unimportant' queries will only be executed when the
+ * priority queue is empty.
+ *
+ * We store lists of SQLrequest's here, by value as we want to avoid storing
+ * any data allocated inside the client module (in case that module is unloaded
+ * while the query is in progress).
+ *
+ * Because we want to work on the current SQLrequest in-situ, we need a way
+ * of accessing the request we are currently processing, QueryQueue::front(),
+ * but that call needs to always return the same request until that request
+ * is removed from the queue, this is what the 'which' variable is. New queries are
+ * always added to the back of one of the two queues, but if when front()
+ * is first called then the priority queue is empty then front() will return
+ * a query from the normal queue, but if a query is then added to the priority
+ * queue then front() must continue to return the front of the *normal* queue
+ * until pop() is called.
+ */
+
+class QueryQueue : public classbase
+{
+private:
+       typedef std::deque<SQLrequest> ReqDeque;
+
+       ReqDeque priority;      /* The priority queue */
+       ReqDeque normal;        /* The 'normal' queue */
+       enum { PRI, NOR, NON } which;   /* Which queue the currently active element is at the front of */
+
+public:
+       QueryQueue()
+       : which(NON)
+       {
+       }
+
+       void push(const SQLrequest &q)
+       {
+               if(q.pri)
+                       priority.push_back(q);
+               else
+                       normal.push_back(q);
+       }
+
+       void pop()
+       {
+               if((which == PRI) && priority.size())
+               {
+                       priority.pop_front();
+               }
+               else if((which == NOR) && normal.size())
+               {
+                       normal.pop_front();
+               }
+
+               /* Reset this */
+               which = NON;
+
+               /* Silently do nothing if there was no element to pop() */
+       }
+
+       SQLrequest& front()
+       {
+               switch(which)
+               {
+                       case PRI:
+                               return priority.front();
+                       case NOR:
+                               return normal.front();
+                       default:
+                               if(priority.size())
+                               {
+                                       which = PRI;
+                                       return priority.front();
+                               }
+
+                               if(normal.size())
+                               {
+                                       which = NOR;
+                                       return normal.front();
+                               }
+
+                               /* This will probably result in a segfault,
+                                * but the caller should have checked totalsize()
+                                * first so..meh - moron :p
+                                */
+
+                               return priority.front();
+               }
+       }
+
+       std::pair<int, int> size()
+       {
+               return std::make_pair(priority.size(), normal.size());
+       }
+
+       int totalsize()
+       {
+               return priority.size() + normal.size();
+       }
+
+       void PurgeModule(Module* mod)
+       {
+               DoPurgeModule(mod, priority);
+               DoPurgeModule(mod, normal);
+       }
+
+private:
+       void DoPurgeModule(Module* mod, ReqDeque& q)
+       {
+               for(ReqDeque::iterator iter = q.begin(); iter != q.end(); iter++)
+               {
+                       if(iter->GetSource() == mod)
+                       {
+                               if(iter->id == front().id)
+                               {
+                                       /* It's the currently active query.. :x */
+                                       iter->SetSource(NULL);
+                               }
+                               else
+                               {
+                                       /* It hasn't been executed yet..just remove it */
+                                       iter = q.erase(iter);
+                               }
+                       }
+               }
+       }
+};
+
+
 #endif