aboutsummaryrefslogtreecommitdiff
path: root/src/modules/extra/m_sqlutils.cpp
diff options
context:
space:
mode:
Diffstat (limited to 'src/modules/extra/m_sqlutils.cpp')
-rw-r--r--src/modules/extra/m_sqlutils.cpp298
1 files changed, 298 insertions, 0 deletions
diff --git a/src/modules/extra/m_sqlutils.cpp b/src/modules/extra/m_sqlutils.cpp
new file mode 100644
index 000000000..3bde05fd9
--- /dev/null
+++ b/src/modules/extra/m_sqlutils.cpp
@@ -0,0 +1,298 @@
+/* +------------------------------------+
+ * | Inspire Internet Relay Chat Daemon |
+ * +------------------------------------+
+ *
+ * InspIRCd is copyright (C) 2002-2004 ChatSpike-Dev.
+ * E-mail:
+ * <brain@chatspike.net>
+ * <Craig@chatspike.net>
+ * <omster@gmail.com>
+ *
+ * Written by Craig Edwards, Craig McLure, and others.
+ * This program is free but copyrighted software; see
+ * the file COPYING for details.
+ *
+ * ---------------------------------------------------
+ */
+
+#include <sstream>
+#include <string>
+#include <map>
+#include <list>
+
+#include "users.h"
+#include "channels.h"
+#include "modules.h"
+#include "helperfuncs.h"
+#include "inspircd.h"
+#include "configreader.h"
+
+#include "m_sqlutils.h"
+
+/* $ModDesc: Provides some utilities to SQL client modules, such as mapping queries to users and channels */
+
+typedef std::map<unsigned long, userrec*> IdUserMap;
+typedef std::map<unsigned long, chanrec*> IdChanMap;
+typedef std::list<unsigned long> AssocIdList;
+
+class ModuleSQLutils : public Module
+{
+private:
+ Server* Srv;
+
+ IdUserMap iduser;
+ IdChanMap idchan;
+
+public:
+ ModuleSQLutils(Server* Me)
+ : Module::Module(Me), Srv(Me)
+ {
+ log(DEBUG, "%s 'SQLutils' feature", Srv->PublishFeature("SQLutils", this) ? "Published" : "Couldn't publish");
+ }
+
+ void Implements(char* List)
+ {
+ List[I_OnChannelDelete] = List[I_OnUnloadModule] = List[I_OnRequest] = List[I_OnUserDisconnect] = 1;
+ }
+
+ virtual char* OnRequest(Request* request)
+ {
+ if(strcmp(SQLUTILAU, request->GetData()) == 0)
+ {
+ AssociateUser* req = (AssociateUser*)request;
+
+ log(DEBUG, "Associated ID %lu with user %s", req->id, req->user->nick);
+
+ iduser.insert(std::make_pair(req->id, req->user));
+
+ AttachList(req->user, req->id);
+ }
+ else if(strcmp(SQLUTILAC, request->GetData()) == 0)
+ {
+ AssociateChan* req = (AssociateChan*)request;
+
+ log(DEBUG, "Associated ID %lu with channel %s", req->id, req->chan->name);
+
+ idchan.insert(std::make_pair(req->id, req->chan));
+
+ AttachList(req->chan, req->id);
+ }
+ else if(strcmp(SQLUTILUA, request->GetData()) == 0)
+ {
+ UnAssociate* req = (UnAssociate*)request;
+
+ /* Unassociate a given query ID with all users and channels
+ * it is associated with.
+ */
+
+ log(DEBUG, "Unassociating ID %lu with all users and channels", req->id);
+
+ DoUnAssociate(iduser, req->id);
+ DoUnAssociate(idchan, req->id);
+ }
+ else if(strcmp(SQLUTILGU, request->GetData()) == 0)
+ {
+ GetAssocUser* req = (GetAssocUser*)request;
+
+ IdUserMap::iterator iter = iduser.find(req->id);
+
+ log(DEBUG, "Looking up user associated with ID %lu", req->id);
+
+ if(iter != iduser.end())
+ {
+ log(DEBUG, "Found user %s", iter->second->nick);
+ req->user = iter->second;
+ }
+ }
+ else if(strcmp(SQLUTILGC, request->GetData()) == 0)
+ {
+ GetAssocChan* req = (GetAssocChan*)request;
+
+ IdChanMap::iterator iter = idchan.find(req->id);
+
+ log(DEBUG, "Looking up channel associated with ID %lu", req->id);
+
+ if(iter != idchan.end())
+ {
+ log(DEBUG, "Found channel %s", iter->second->name);
+ req->chan = iter->second;
+ }
+ }
+ else
+ {
+ log(DEBUG, "Got unsupported API version string: %s", request->GetData());
+ return NULL;
+ }
+
+ return SQLUTILSUCCESS;
+ }
+
+ virtual void OnUserDisconnect(userrec* user)
+ {
+ /* A user is disconnecting, first we need to check if they have a list of queries associated with them.
+ * Then, if they do, we need to erase each of them from our IdUserMap (iduser) so when the module that
+ * associated them asks to look them up then it gets a NULL result and knows to discard the query.
+ */
+ AssocIdList* il;
+
+ if(user->GetExt("sqlutils_queryids", il))
+ {
+ for(AssocIdList::iterator listiter = il->begin(); listiter != il->end(); listiter++)
+ {
+ IdUserMap::iterator iter;
+
+ iter = iduser.find(*listiter);
+
+ if(iter != iduser.end())
+ {
+ if(iter->second == user)
+ {
+ log(DEBUG, "Erased query from map associated with quitting user %s", user->nick);
+ }
+ else
+ {
+ log(DEBUG, "BUG: ID associated with user %s doesn't have the same userrec* associated with it in the map (erasing anyway)", user->nick);
+ }
+
+ iduser.erase(iter);
+ }
+ else
+ {
+ log(DEBUG, "BUG: user %s was extended with sqlutils_queryids but there was nothing matching in the map", user->nick);
+ }
+ }
+
+ user->Shrink("sqlutils_queryids");
+ delete il;
+ }
+ }
+
+ void AttachList(Extensible* obj, unsigned long id)
+ {
+ AssocIdList* il;
+
+ if(!obj->GetExt("sqlutils_queryids", il))
+ {
+ /* Doesn't already exist, create a new list and attach it. */
+ il = new AssocIdList;
+ obj->Extend("sqlutils_queryids", il);
+ }
+
+ /* Now either way we have a valid list in il, attached. */
+ il->push_back(id);
+ }
+
+ void RemoveFromList(Extensible* obj, unsigned long id)
+ {
+ AssocIdList* il;
+
+ if(obj->GetExt("sqlutils_queryids", il))
+ {
+ /* Only do anything if the list exists... (which it ought to) */
+ il->remove(id);
+
+ if(il->empty())
+ {
+ /* If we just emptied it.. */
+ delete il;
+ obj->Shrink("sqlutils_queryids");
+ }
+ }
+ }
+
+ template <class T> void DoUnAssociate(T &map, unsigned long id)
+ {
+ /* For each occurence of 'id' (well, only one..it's not a multimap) in 'map'
+ * remove it from the map, take an Extensible* value from the map and remove
+ * 'id' from the list of query IDs attached to it.
+ */
+ typename T::iterator iter = map.find(id);
+
+ if(iter != map.end())
+ {
+ /* Found a value indexed by 'id', call RemoveFromList()
+ * on it with 'id' to remove 'id' from the list attached
+ * to the value.
+ */
+ RemoveFromList(iter->second, id);
+
+ log(DEBUG, "Removed query %lu from map and removed references to it on value", id);
+ }
+ else
+ {
+ log(DEBUG, "Nothing associated with query %lu", id);
+ }
+ }
+
+ virtual void OnChannelDelete(chanrec* chan)
+ {
+ /* A channel is being destroyed, first we need to check if it has a list of queries associated with it.
+ * Then, if it does, we need to erase each of them from our IdChanMap (idchan) so when the module that
+ * associated them asks to look them up then it gets a NULL result and knows to discard the query.
+ */
+ AssocIdList* il;
+
+ if(chan->GetExt("sqlutils_queryids", il))
+ {
+ for(AssocIdList::iterator listiter = il->begin(); listiter != il->end(); listiter++)
+ {
+ IdChanMap::iterator iter;
+
+ iter = idchan.find(*listiter);
+
+ if(iter != idchan.end())
+ {
+ if(iter->second == chan)
+ {
+ log(DEBUG, "Erased query from map associated with dying channnel %s", chan->name);
+ }
+ else
+ {
+ log(DEBUG, "BUG: ID associated with channel %s doesn't have the same chanrec* associated with it in the map (erasing anyway)", chan->name);
+ }
+
+ idchan.erase(iter);
+ }
+ else
+ {
+ log(DEBUG, "BUG: channel %s was extended with sqlutils_queryids but there was nothing matching in the map", chan->name);
+ }
+ }
+
+ chan->Shrink("sqlutils_queryids");
+ delete il;
+ }
+ }
+
+ virtual Version GetVersion()
+ {
+ return Version(1, 0, 0, 0, VF_STATIC|VF_VENDOR|VF_SERVICEPROVIDER);
+ }
+
+ virtual ~ModuleSQLutils()
+ {
+ }
+};
+
+class ModuleSQLutilsFactory : public ModuleFactory
+{
+ public:
+ ModuleSQLutilsFactory()
+ {
+ }
+
+ ~ModuleSQLutilsFactory()
+ {
+ }
+
+ virtual Module * CreateModule(Server* Me)
+ {
+ return new ModuleSQLutils(Me);
+ }
+};
+
+
+extern "C" void * init_module( void )
+{
+ return new ModuleSQLutilsFactory;
+}
generated by cgit v1.3.1-10-gc9f91 (git 2.54.0) at 2026-07-07 16:16:56 +0000