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