src/modules/m_sqlutils.cpp

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd: (C) 2002-2009 InspIRCd Development Team
   6  * See: http://wiki.inspircd.org/Credits
   7  *
   8  * This program is free but copyrighted software; see
   9  *            the file COPYING for details.
  10  *
  11  * ---------------------------------------------------
  12  */
  13
  14 #include "inspircd.h"
  15 #include <sstream>
  16 #include <list>
  17 #include "m_sqlutils.h"
  18
  19 /* $ModDesc: Provides some utilities to SQL client modules, such as mapping queries to users and channels */
  20 /* $ModDep: m_sqlutils.h */
  21
  22 typedef std::map<unsigned long, User*> IdUserMap;
  23 typedef std::map<unsigned long, Channel*> IdChanMap;
  24 typedef std::list<unsigned long> AssocIdList;
  25
  26 class ModuleSQLutils : public Module
  27 {
  28 private:
  29         IdUserMap iduser;
  30         IdChanMap idchan;
  31         SimpleExtItem<AssocIdList> idExt;
  32
  33 public:
  34         ModuleSQLutils() : idExt("sqlutils_list", this)
  35         {
  36                 ServerInstance->Modules->PublishInterface("SQLutils", this);
  37                 Implementation eventlist[] = { I_OnChannelDelete, I_OnUnloadModule, I_OnRequest, I_OnUserDisconnect };
  38                 ServerInstance->Modules->Attach(eventlist, this, 4);
  39         }
  40
  41         ~ModuleSQLutils()
  42         {
  43                 ServerInstance->Modules->UnpublishInterface("SQLutils", this);
  44         }
  45
  46
  47         const char* OnRequest(Request* request)
  48         {
  49                 if(strcmp(SQLUTILAU, request->GetId()) == 0)
  50                 {
  51                         AssociateUser* req = (AssociateUser*)request;
  52
  53                         iduser.insert(std::make_pair(req->id, req->user));
  54
  55                         AttachList(req->user, req->id);
  56                 }
  57                 else if(strcmp(SQLUTILAC, request->GetId()) == 0)
  58                 {
  59                         AssociateChan* req = (AssociateChan*)request;
  60
  61                         idchan.insert(std::make_pair(req->id, req->chan));
  62
  63                         AttachList(req->chan, req->id);
  64                 }
  65                 else if(strcmp(SQLUTILUA, request->GetId()) == 0)
  66                 {
  67                         UnAssociate* req = (UnAssociate*)request;
  68
  69                         /* Unassociate a given query ID with all users and channels
  70                          * it is associated with.
  71                          */
  72
  73                         DoUnAssociate(iduser, req->id);
  74                         DoUnAssociate(idchan, req->id);
  75                 }
  76                 else if(strcmp(SQLUTILGU, request->GetId()) == 0)
  77                 {
  78                         GetAssocUser* req = (GetAssocUser*)request;
  79
  80                         IdUserMap::iterator iter = iduser.find(req->id);
  81
  82                         if(iter != iduser.end())
  83                         {
  84                                 req->user = iter->second;
  85                         }
  86                 }
  87                 else if(strcmp(SQLUTILGC, request->GetId()) == 0)
  88                 {
  89                         GetAssocChan* req = (GetAssocChan*)request;
  90
  91                         IdChanMap::iterator iter = idchan.find(req->id);
  92
  93                         if(iter != idchan.end())
  94                         {
  95                                 req->chan = iter->second;
  96                         }
  97                 }
  98
  99                 return SQLUTILSUCCESS;
 100         }
 101
 102         void OnUserDisconnect(User* user)
 103         {
 104                 /* A user is disconnecting, first we need to check if they have a list of queries associated with them.
 105                  * Then, if they do, we need to erase each of them from our IdUserMap (iduser) so when the module that
 106                  * associated them asks to look them up then it gets a NULL result and knows to discard the query.
 107                  */
 108                 AssocIdList* il = idExt.get(user);
 109
 110                 if(il)
 111                 {
 112                         for(AssocIdList::iterator listiter = il->begin(); listiter != il->end(); listiter++)
 113                         {
 114                                 IdUserMap::iterator iter;
 115
 116                                 iter = iduser.find(*listiter);
 117
 118                                 if(iter != iduser.end())
 119                                 {
 120                                         if(iter->second != user)
 121                                         {
 122                                                 ServerInstance->Logs->Log("m_sqlutils",DEBUG, "BUG: ID associated with user %s doesn't have the same User* associated with it in the map (erasing anyway)", user->nick.c_str());
 123                                         }
 124
 125                                         iduser.erase(iter);
 126                                 }
 127                                 else
 128                                 {
 129                                         ServerInstance->Logs->Log("m_sqlutils",DEBUG, "BUG: user %s was extended with sqlutils_queryids but there was nothing matching in the map", user->nick.c_str());
 130                                 }
 131                         }
 132
 133                         idExt.unset(user);
 134                 }
 135         }
 136
 137         void AttachList(Extensible* obj, unsigned long id)
 138         {
 139                 AssocIdList* il = idExt.get(obj);
 140
 141                 if (!il)
 142                 {
 143                         /* Doesn't already exist, create a new list and attach it. */
 144                         il = new AssocIdList;
 145                         idExt.set(obj, il);
 146                 }
 147
 148                 /* Now either way we have a valid list in il, attached. */
 149                 il->push_back(id);
 150         }
 151
 152         void RemoveFromList(Extensible* obj, unsigned long id)
 153         {
 154                 AssocIdList* il = idExt.get(obj);
 155
 156                 if (il)
 157                 {
 158                         /* Only do anything if the list exists... (which it ought to) */
 159                         il->remove(id);
 160
 161                         if(il->empty())
 162                         {
 163                                 /* If we just emptied it.. */
 164                                 idExt.unset(obj);
 165                         }
 166                 }
 167         }
 168
 169         template <class T> void DoUnAssociate(T &map, unsigned long id)
 170         {
 171                 /* For each occurence of 'id' (well, only one..it's not a multimap) in 'map'
 172                  * remove it from the map, take an Extensible* value from the map and remove
 173                  * 'id' from the list of query IDs attached to it.
 174                  */
 175                 typename T::iterator iter = map.find(id);
 176
 177                 if(iter != map.end())
 178                 {
 179                         /* Found a value indexed by 'id', call RemoveFromList()
 180                          * on it with 'id' to remove 'id' from the list attached
 181                          * to the value.
 182                          */
 183                         RemoveFromList(iter->second, id);
 184                 }
 185         }
 186
 187         void OnChannelDelete(Channel* chan)
 188         {
 189                 /* A channel is being destroyed, first we need to check if it has a list of queries associated with it.
 190                  * Then, if it does, we need to erase each of them from our IdChanMap (idchan) so when the module that
 191                  * associated them asks to look them up then it gets a NULL result and knows to discard the query.
 192                  */
 193                 AssocIdList* il = idExt.get(chan);
 194
 195                 if (il)
 196                 {
 197                         for(AssocIdList::iterator listiter = il->begin(); listiter != il->end(); listiter++)
 198                         {
 199                                 IdChanMap::iterator iter;
 200
 201                                 iter = idchan.find(*listiter);
 202
 203                                 if(iter != idchan.end())
 204                                 {
 205                                         if(iter->second != chan)
 206                                         {
 207                                                 ServerInstance->Logs->Log("m_sqlutils",DEBUG, "BUG: ID associated with channel %s doesn't have the same Channel* associated with it in the map (erasing anyway)", chan->name.c_str());
 208                                         }
 209                                         idchan.erase(iter);
 210                                 }
 211                                 else
 212                                 {
 213                                         ServerInstance->Logs->Log("m_sqlutils",DEBUG, "BUG: channel %s was extended with sqlutils_queryids but there was nothing matching in the map", chan->name.c_str());
 214                                 }
 215                         }
 216
 217                         idExt.unset(chan);
 218                 }
 219         }
 220
 221         Version GetVersion()
 222         {
 223                 return Version("Provides some utilities to SQL client modules, such as mapping queries to users and channels", VF_VENDOR | VF_SERVICEPROVIDER, API_VERSION);
 224         }
 225
 226 };
 227
 228 MODULE_INIT(ModuleSQLutils)