src/modules/m_swhois.cpp

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
   6  *                       E-mail:
   7  *                <brain@chatspike.net>
   8  *                <Craig@chatspike.net>
   9  *
  10  * Written by Craig Edwards, Craig McLure, and others.
  11  * This program is free but copyrighted software; see
  12  *            the file COPYING for details.
  13  *
  14  * ---------------------------------------------------
  15  */
  16
  17 #include "users.h"
  18 #include "channels.h"
  19 #include "modules.h"
  20 #include "helperfuncs.h"
  21
  22 /* $ModDesc: Provides the SWHOIS command which allows setting of arbitary WHOIS lines */
  23
  24 class cmd_swhois : public command_t
  25 {
  26         Server* Srv;
  27  public:
  28         cmd_swhois(Server* server) : command_t("SWHOIS",'o',2)
  29         {
  30                 this->Srv = server;
  31                 this->source = "m_swhois.so";
  32         }
  33
  34         void Handle(char** parameters, int pcnt, userrec* user)
  35         {
  36                 userrec* dest = Srv->FindNick(std::string(parameters[0]));
  37                 if(dest)
  38                 {
  39                         std::string line;
  40                         for(int i = 1; i < pcnt; i++)
  41                         {
  42                                 if (i != 1)
  43                                         line.append(" ");
  44
  45                                 line.append(parameters[i]);
  46                         }
  47
  48                         std::string* text = (std::string*)dest->GetExt("swhois");
  49
  50                         if(text)
  51                         {
  52                                 // We already had it set...
  53
  54                                 if (!Srv->IsUlined(user->server))
  55                                         // Ulines set SWHOISes silently
  56                                         WriteOpers("%s used SWHOIS to set %s's extra whois from '%s' to '%s'", user->nick, dest->nick, text->c_str(), line.c_str());
  57
  58                                 dest->Shrink("swhois");
  59                                 delete text;
  60                         }
  61                         else if(!Srv->IsUlined(user->server))
  62                         {
  63                                 // Ulines set SWHOISes silently
  64                                 WriteOpers("%s used SWHOIS to set %s's extra whois to '%s'", user->nick, dest->nick, line.c_str());
  65                         }
  66
  67                         text = new std::string(line);
  68                         dest->Extend("swhois", (char*)text);
  69                 }
  70         }
  71 };
  72
  73 class ModuleSWhois : public Module
  74 {
  75         cmd_swhois* mycommand;
  76         Server* Srv;
  77         ConfigReader* Conf;
  78
  79  public:
  80         ModuleSWhois(Server* Me) : Module::Module(Me)
  81         {
  82                 Srv = Me;
  83                 Conf = new ConfigReader();
  84                 mycommand = new cmd_swhois(Srv);
  85                 Srv->AddCommand(mycommand);
  86         }
  87
  88         void OnRehash(std::string parameter)
  89         {
  90                 delete Conf;
  91                 Conf = new ConfigReader();
  92         }
  93
  94         void Implements(char* List)
  95         {
  96                 List[I_OnWhois] = List[I_OnSyncUserMetaData] = List[I_OnUserQuit] = List[I_OnCleanup] = List[I_OnRehash] = List[I_OnOper] = 1;
  97         }
  98
  99         // :kenny.chatspike.net 320 Brain Azhrarn :is getting paid to play games.
 100         virtual void OnWhois(userrec* source, userrec* dest)
 101         {
 102                 char* desc = dest->GetExt("swhois");
 103                 if (desc)
 104                 {
 105                         std::string* swhois = (std::string*)desc;
 106                         WriteServ(source->fd,"320 %s %s :%s",source->nick,dest->nick,swhois->c_str());
 107                 }
 108         }
 109
 110         // Whenever the linking module wants to send out data, but doesnt know what the data
 111         // represents (e.g. it is metadata, added to a userrec or chanrec by a module) then
 112         // this method is called. We should use the ProtoSendMetaData function after we've
 113         // corrected decided how the data should look, to send the metadata on its way if
 114         // it is ours.
 115         virtual void OnSyncUserMetaData(userrec* user, Module* proto, void* opaque, std::string extname)
 116         {
 117                 // check if the linking module wants to know about OUR metadata
 118                 if (extname == "swhois")
 119                 {
 120                         // check if this user has an swhois field to send
 121                         char* field = user->GetExt("swhois");
 122                         if (field)
 123                         {
 124                                 // get our extdata out with a cast
 125                                 std::string* swhois = (std::string*)field;
 126                                 // call this function in the linking module, let it format the data how it
 127                                 // sees fit, and send it on its way. We dont need or want to know how.
 128                                 proto->ProtoSendMetaData(opaque,TYPE_USER,user,extname,*swhois);
 129                         }
 130                 }
 131         }
 132
 133         // when a user quits, tidy up their metadata
 134         virtual void OnUserQuit(userrec* user, std::string message)
 135         {
 136                 char* field = user->GetExt("swhois");
 137                 if (field)
 138                 {
 139                         std::string* swhois = (std::string*)field;
 140                         user->Shrink("swhois");
 141                         delete swhois;
 142                 }
 143         }
 144
 145         // if the module is unloaded, tidy up all our dangling metadata
 146         virtual void OnCleanup(int target_type, void* item)
 147         {
 148                 if (target_type == TYPE_USER)
 149                 {
 150                         userrec* user = (userrec*)item;
 151                         char* field = user->GetExt("swhois");
 152                         if (field)
 153                         {
 154                                 std::string* swhois = (std::string*)field;
 155                                 user->Shrink("swhois");
 156                                 delete swhois;
 157                         }
 158                 }
 159         }
 160
 161         // Whenever the linking module receives metadata from another server and doesnt know what
 162         // to do with it (of course, hence the 'meta') it calls this method, and it is up to each
 163         // module in turn to figure out if this metadata key belongs to them, and what they want
 164         // to do with it.
 165         // In our case we're only sending a single string around, so we just construct a std::string.
 166         // Some modules will probably get much more complex and format more detailed structs and classes
 167         // in a textual way for sending over the link.
 168         virtual void OnDecodeMetaData(int target_type, void* target, std::string extname, std::string extdata)
 169         {
 170                 // check if its our metadata key, and its associated with a user
 171                 if ((target_type == TYPE_USER) && (extname == "swhois"))
 172                 {
 173                         userrec* dest = (userrec*)target;
 174                         // if they dont already have an swhois field, accept the remote server's
 175                         if (!dest->GetExt("swhois"))
 176                         {
 177                                 std::string* text = new std::string(extdata);
 178                                 dest->Extend("swhois",(char*)text);
 179                         }
 180                 }
 181         }
 182
 183         virtual void OnOper(userrec* user, std::string opertype)
 184         {
 185                 for(int i =0; i < Conf->Enumerate("type"); i++)
 186                 {
 187                         std::string type = Conf->ReadValue("type", "name", i);
 188
 189                         if(strcmp(type.c_str(), user->oper) == 0)
 190                         {
 191                                 std::string swhois = Conf->ReadValue("type", "swhois", i);
 192
 193                                 if(swhois.length())
 194                                 {
 195                                         if(std::string* old = (std::string*)user->GetExt("swhois"))
 196                                         {
 197                                                 user->Shrink("swhois");
 198                                                 delete old;
 199                                         }
 200
 201                                         std::string* text = new std::string(swhois);
 202                                         user->Extend("swhois", (char*)text);
 203
 204                                         break;
 205                                 }
 206                         }
 207                 }
 208         }
 209
 210         virtual ~ModuleSWhois()
 211         {
 212                 delete Conf;
 213         }
 214
 215         virtual Version GetVersion()
 216         {
 217                 return Version(1,0,0,0,VF_VENDOR);
 218         }
 219 };
 220
 221
 222 class ModuleSWhoisFactory : public ModuleFactory
 223 {
 224  public:
 225         ModuleSWhoisFactory()
 226         {
 227         }
 228
 229         ~ModuleSWhoisFactory()
 230         {
 231         }
 232
 233         virtual Module * CreateModule(Server* Me)
 234         {
 235                 return new ModuleSWhois(Me);
 236         }
 237
 238 };
 239
 240
 241 extern "C" void * init_module( void )
 242 {
 243         return new ModuleSWhoisFactory;
 244 }
 245