]> git.netwichtig.de Git - user/henk/code/inspircd.git/blob - src/modules/extra/m_sqlutils.cpp
6cd09252b2a19e55e9b8d2dbaf375686208864b3
[user/henk/code/inspircd.git] / src / modules / extra / m_sqlutils.cpp
1 /*       +------------------------------------+\r *       | Inspire Internet Relay Chat Daemon |\r *       +------------------------------------+\r *\r *  InspIRCd: (C) 2002-2007 InspIRCd Development Team\r * See: http://www.inspircd.org/wiki/index.php/Credits\r *\r * This program is free but copyrighted software; see\r *            the file COPYING for details.\r *\r * ---------------------------------------------------\r */\r\r#include "inspircd.h"\r#include <sstream>\r#include <list>\r#include "users.h"\r#include "channels.h"\r#include "modules.h"\r#include "configreader.h"\r#include "m_sqlutils.h"\r\r/* $ModDesc: Provides some utilities to SQL client modules, such as mapping queries to users and channels */\r/* $ModDep: m_sqlutils.h */\r\rtypedef std::map<unsigned long, userrec*> IdUserMap;\rtypedef std::map<unsigned long, chanrec*> IdChanMap;\rtypedef std::list<unsigned long> AssocIdList;\r\rclass ModuleSQLutils : public Module\r{\rprivate:\r       IdUserMap iduser;\r      IdChanMap idchan;\r\rpublic:\r     ModuleSQLutils(InspIRCd* Me)\r   : Module::Module(Me)\r   {\r              ServerInstance->PublishInterface("SQLutils", this);\r    }\r\r     virtual ~ModuleSQLutils()\r      {\r              ServerInstance->UnpublishInterface("SQLutils", this);\r  }       \r\r      void Implements(char* List)\r    {\r              List[I_OnChannelDelete] = List[I_OnUnloadModule] = List[I_OnRequest] =  List[I_OnUserDisconnect] = 1;\r  }\r\r     virtual char* OnRequest(Request* request)\r      {\r              if(strcmp(SQLUTILAU, request->GetId()) == 0)\r           {\r                      AssociateUser* req = (AssociateUser*)request;\r                  \r                       iduser.insert(std::make_pair(req->id, req->user));\r                     \r                       AttachList(req->user, req->id);\r                }\r              else if(strcmp(SQLUTILAC, request->GetId()) == 0)\r              {\r                      AssociateChan* req = (AssociateChan*)request;\r                  \r                       idchan.insert(std::make_pair(req->id, req->chan));                      \r                       \r                       AttachList(req->chan, req->id);\r                }\r              else if(strcmp(SQLUTILUA, request->GetId()) == 0)\r              {\r                      UnAssociate* req = (UnAssociate*)request;\r                      \r                       /* Unassociate a given query ID with all users and channels\r                     * it is associated with.\r                       */\r                    \r                       DoUnAssociate(iduser, req->id);\r                        DoUnAssociate(idchan, req->id);\r                }\r              else if(strcmp(SQLUTILGU, request->GetId()) == 0)\r              {\r                      GetAssocUser* req = (GetAssocUser*)request;\r                    \r                       IdUserMap::iterator iter = iduser.find(req->id);\r                       \r                       if(iter != iduser.end())\r                       {\r                              req->user = iter->second;\r                      }\r              }\r              else if(strcmp(SQLUTILGC, request->GetId()) == 0)\r              {\r                      GetAssocChan* req = (GetAssocChan*)request;                     \r                       \r                       IdChanMap::iterator iter = idchan.find(req->id);\r                       \r                       if(iter != idchan.end())\r                       {\r                              req->chan = iter->second;\r                      }\r              }\r              \r               return SQLUTILSUCCESS;\r }\r      \r       virtual void OnUserDisconnect(userrec* user)\r   {\r              /* A user is disconnecting, first we need to check if they have a list of queries associated with them.\r                 * Then, if they do, we need to erase each of them from our IdUserMap (iduser) so when the module that\r          * associated them asks to look them up then it gets a NULL result and knows to discard the query.\r              */\r            AssocIdList* il;\r               \r               if(user->GetExt("sqlutils_queryids", il))\r              {\r                      for(AssocIdList::iterator listiter = il->begin(); listiter != il->end(); listiter++)\r                   {\r                              IdUserMap::iterator iter;\r                      \r                               iter = iduser.find(*listiter);\r                 \r                               if(iter != iduser.end())\r                               {\r                                      if(iter->second != user)\r                                       {\r                                              ServerInstance->Log(DEBUG, "BUG: ID associated with user %s doesn't have the same userrec* associated with it in the map (erasing anyway)", user->nick);\r                                       }\r\r                                     iduser.erase(iter);\r                            }\r                              else\r                           {\r                                      ServerInstance->Log(DEBUG, "BUG: user %s was extended with sqlutils_queryids but there was nothing matching in the map", user->nick);\r                          }\r                      }\r                      \r                       user->Shrink("sqlutils_queryids");\r                     delete il;\r             }\r      }\r      \r       void AttachList(Extensible* obj, unsigned long id)\r     {\r              AssocIdList* il;\r               \r               if(!obj->GetExt("sqlutils_queryids", il))\r              {\r                      /* Doesn't already exist, create a new list and attach it. */\r                  il = new AssocIdList;\r                  obj->Extend("sqlutils_queryids", il);\r          }\r              \r               /* Now either way we have a valid list in il, attached. */\r             il->push_back(id);\r     }\r      \r       void RemoveFromList(Extensible* obj, unsigned long id)\r {\r              AssocIdList* il;\r               \r               if(obj->GetExt("sqlutils_queryids", il))\r               {\r                      /* Only do anything if the list exists... (which it ought to) */\r                       il->remove(id);\r                        \r                       if(il->empty())\r                        {\r                              /* If we just emptied it.. */\r                          delete il;\r                             obj->Shrink("sqlutils_queryids");\r                      }\r              }\r      }\r      \r       template <class T> void DoUnAssociate(T &map, unsigned long id)\r        {\r              /* For each occurence of 'id' (well, only one..it's not a multimap) in 'map'\r            * remove it from the map, take an Extensible* value from the map and remove\r            * 'id' from the list of query IDs attached to it.\r              */\r            typename T::iterator iter = map.find(id);\r              \r               if(iter != map.end())\r          {\r                      /* Found a value indexed by 'id', call RemoveFromList()\r                         * on it with 'id' to remove 'id' from the list attached\r                        * to the value.\r                        */\r                    RemoveFromList(iter->second, id);\r              }\r      }\r      \r       virtual void OnChannelDelete(chanrec* chan)\r    {\r              /* A channel is being destroyed, first we need to check if it has a list of queries associated with it.\r                 * Then, if it does, we need to erase each of them from our IdChanMap (idchan) so when the module that\r          * associated them asks to look them up then it gets a NULL result and knows to discard the query.\r              */\r            AssocIdList* il;\r               \r               if(chan->GetExt("sqlutils_queryids", il))\r              {\r                      for(AssocIdList::iterator listiter = il->begin(); listiter != il->end(); listiter++)\r                   {\r                              IdChanMap::iterator iter;\r                      \r                               iter = idchan.find(*listiter);\r                 \r                               if(iter != idchan.end())\r                               {\r                                      if(iter->second != chan)\r                                       {\r                                              ServerInstance->Log(DEBUG, "BUG: ID associated with channel %s doesn't have the same chanrec* associated with it in the map (erasing anyway)", chan->name);\r                                    }\r                                      idchan.erase(iter);                                     \r                               }\r                              else\r                           {\r                                      ServerInstance->Log(DEBUG, "BUG: channel %s was extended with sqlutils_queryids but there was nothing matching in the map", chan->name);\r                               }\r                      }\r                      \r                       chan->Shrink("sqlutils_queryids");\r                     delete il;\r             }\r      }\r                      \r       virtual Version GetVersion()\r   {\r              return Version(1, 1, 0, 0, VF_VENDOR|VF_SERVICEPROVIDER, API_VERSION);\r }\r      \r};\r\rMODULE_INIT(ModuleSQLutils);\r\r