src/modules/m_swhois.cpp

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd: (C) 2002-2007 InspIRCd Development Team
   6  * See: http://www.inspircd.org/wiki/index.php/Credits
   7  *
   8  * This program is free but copyrighted software; see
   9  *            the file COPYING for details.
  10  *
  11  * ---------------------------------------------------
  12  */
  13
  14 #include "users.h"
  15 #include "channels.h"
  16 #include "modules.h"
  17 #include "inspircd.h"
  18
  19 /* $ModDesc: Provides the SWHOIS command which allows setting of arbitary WHOIS lines */
  20
  21 /** Handle /SWHOIS
  22  */
  23 class cmd_swhois : public command_t
  24 {
  25
  26  public:
  27         cmd_swhois (InspIRCd* Instance) : command_t(Instance,"SWHOIS",'o',2)
  28         {
  29                 this->source = "m_swhois.so";
  30                 syntax = "<nick> <swhois>";
  31         }
  32
  33         CmdResult Handle(const char** parameters, int pcnt, userrec* user)
  34         {
  35                 userrec* dest = ServerInstance->FindNick(parameters[0]);
  36                 if(dest)
  37                 {
  38                         std::string line;
  39                         for(int i = 1; i < pcnt; i++)
  40                         {
  41                                 if (i != 1)
  42                                         line.append(" ");
  43
  44                                 line.append(parameters[i]);
  45                         }
  46
  47                         std::string* text;
  48                         dest->GetExt("swhois", text);
  49
  50                         if(text)
  51                         {
  52                                 // We already had it set...
  53
  54                                 if (!ServerInstance->ULine(user->server))
  55                                         // Ulines set SWHOISes silently
  56                                         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());
  57
  58                                 dest->Shrink("swhois");
  59                                 DELETE(text);
  60                         }
  61                         else if(!ServerInstance->ULine(user->server))
  62                         {
  63                                 // Ulines set SWHOISes silently
  64                                 ServerInstance->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", text);
  69
  70                         return CMD_SUCCESS;
  71                 }
  72
  73                 return CMD_FAILURE;
  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_OnPostCommand] = 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                         ServerInstance->SendWhoisLine(source, dest, 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                 ServerInstance->Log(DEBUG,"Sync user metadata type '%s'", extname.c_str());
 122                 // check if the linking module wants to know about OUR metadata
 123                 if (extname == "swhois")
 124                 {
 125                         // check if this user has an swhois field to send
 126                         std::string* swhois;
 127                         user->GetExt("swhois", swhois);
 128                         if (swhois)
 129                         {
 130                                 // call this function in the linking module, let it format the data how it
 131                                 // sees fit, and send it on its way. We dont need or want to know how.
 132                                 proto->ProtoSendMetaData(opaque,TYPE_USER,user,extname,*swhois);
 133                         }
 134                         else
 135                         {
 136                                 ServerInstance->Log(DEBUG,"User has a null swhois string!");
 137                         }
 138                 }
 139         }
 140
 141         // when a user quits, tidy up their metadata
 142         virtual void OnUserQuit(userrec* user, const std::string &message)
 143         {
 144                 std::string* swhois;
 145                 user->GetExt("swhois", swhois);
 146                 if (swhois)
 147                 {
 148                         user->Shrink("swhois");
 149                         DELETE(swhois);
 150                 }
 151         }
 152
 153         // if the module is unloaded, tidy up all our dangling metadata
 154         virtual void OnCleanup(int target_type, void* item)
 155         {
 156                 if (target_type == TYPE_USER)
 157                 {
 158                         userrec* user = (userrec*)item;
 159                         std::string* swhois;
 160                         user->GetExt("swhois", swhois);
 161                         if (swhois)
 162                         {
 163                                 user->Shrink("swhois");
 164                                 DELETE(swhois);
 165                         }
 166                 }
 167         }
 168
 169         // Whenever the linking module receives metadata from another server and doesnt know what
 170         // to do with it (of course, hence the 'meta') it calls this method, and it is up to each
 171         // module in turn to figure out if this metadata key belongs to them, and what they want
 172         // to do with it.
 173         // In our case we're only sending a single string around, so we just construct a std::string.
 174         // Some modules will probably get much more complex and format more detailed structs and classes
 175         // in a textual way for sending over the link.
 176         virtual void OnDecodeMetaData(int target_type, void* target, const std::string &extname, const std::string &extdata)
 177         {
 178                 // check if its our metadata key, and its associated with a user
 179                 if ((target_type == TYPE_USER) && (extname == "swhois"))
 180                 {
 181                         ServerInstance->Log(DEBUG,"Extend with swhois");
 182                         userrec* dest = (userrec*)target;
 183                         // if they dont already have an swhois field, accept the remote server's
 184                         std::string* text;
 185                         if (!dest->GetExt("swhois", text))
 186                         {
 187                                 std::string* text = new std::string(extdata);
 188                                 dest->Extend("swhois",text);
 189                                 ServerInstance->Log(DEBUG,"extended: %s %s", dest->nick, text->c_str());
 190                         }
 191                 }
 192         }
 193
 194         virtual void OnPostCommand(const std::string &command, const char **params, int pcnt, userrec *user, CmdResult result, const std::string &original_line)
 195         {
 196                 if ((command != "OPER") || (result != CMD_SUCCESS))
 197                         return;
 198
 199                 std::string swhois;
 200
 201                 for (int i = 0; i < Conf->Enumerate("oper"); i++)
 202                 {
 203                         std::string name = Conf->ReadValue("oper", "name", i);
 204
 205                         if (name == params[0])
 206                         {
 207                                 swhois = Conf->ReadValue("oper", "swhois", i);
 208                                 break;
 209                         }
 210                 }
 211
 212                 if (!swhois.length())
 213                 {
 214                         for (int i = 0; i < Conf->Enumerate("type"); i++)
 215                         {
 216                                 std::string type = Conf->ReadValue("type", "name", i);
 217
 218                                 if (type == user->oper)
 219                                 {
 220                                         swhois = Conf->ReadValue("type", "swhois", i);
 221                                         break;
 222                                 }
 223                         }
 224                 }
 225
 226                 std::string *old;
 227                 if (user->GetExt("swhois", old))
 228                 {
 229                         user->Shrink("swhois");
 230                         DELETE(old);
 231                 }
 232
 233                 if (!swhois.length())
 234                         return;
 235
 236                 std::string *text = new std::string(swhois);
 237                 user->Extend("swhois", text);
 238         }
 239
 240         virtual ~ModuleSWhois()
 241         {
 242                 DELETE(Conf);
 243         }
 244
 245         virtual Version GetVersion()
 246         {
 247                 return Version(1,1,0,0,VF_VENDOR,API_VERSION);
 248         }
 249 };
 250
 251
 252 class ModuleSWhoisFactory : public ModuleFactory
 253 {
 254  public:
 255         ModuleSWhoisFactory()
 256         {
 257         }
 258
 259         ~ModuleSWhoisFactory()
 260         {
 261         }
 262
 263         virtual Module * CreateModule(InspIRCd* Me)
 264         {
 265                 return new ModuleSWhois(Me);
 266         }
 267
 268 };
 269
 270
 271 extern "C" void * init_module( void )
 272 {
 273         return new ModuleSWhoisFactory;
 274 }
 275