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 "inspircd.h"
  15 #include "users.h"
  16 #include "channels.h"
  17 #include "modules.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
  37                 if (!dest)
  38                 {
  39                         user->WriteServ("401 %s %s :No such nick/channel", user->nick, parameters[0]);
  40                         return CMD_FAILURE;
  41                 }
  42
  43                 if (!*parameters[1])
  44                 {
  45                         user->WriteServ("NOTICE %s :*** SWHOIS: Whois line must be specified", user->nick);
  46                         return CMD_FAILURE;
  47                 }
  48
  49                 std::string line;
  50                 for (int i = 1; i < pcnt; i++)
  51                 {
  52                         if (i != 1)
  53                                 line.append(" ");
  54
  55                         line.append(parameters[i]);
  56                 }
  57
  58                 std::string* text;
  59                 dest->GetExt("swhois", text);
  60
  61                 if (text)
  62                 {
  63                         // We already had it set...
  64
  65                         if (!ServerInstance->ULine(user->server))
  66                                 // Ulines set SWHOISes silently
  67                                 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());
  68
  69                         dest->Shrink("swhois");
  70                         DELETE(text);
  71                 }
  72                 else if (!ServerInstance->ULine(user->server))
  73                 {
  74                         // Ulines set SWHOISes silently
  75                         ServerInstance->WriteOpers("*** %s used SWHOIS to set %s's extra whois to '%s'", user->nick, dest->nick, line.c_str());
  76                 }
  77
  78                 text = new std::string(line);
  79                 dest->Extend("swhois", text);
  80
  81                 return CMD_SUCCESS;
  82         }
  83
  84 };
  85
  86 class ModuleSWhois : public Module
  87 {
  88         cmd_swhois* mycommand;
  89
  90         ConfigReader* Conf;
  91
  92  public:
  93         ModuleSWhois(InspIRCd* Me) : Module(Me)
  94         {
  95
  96                 Conf = new ConfigReader(ServerInstance);
  97                 mycommand = new cmd_swhois(ServerInstance);
  98                 ServerInstance->AddCommand(mycommand);
  99         }
 100
 101         void OnRehash(userrec* user, const std::string &parameter)
 102         {
 103                 DELETE(Conf);
 104                 Conf = new ConfigReader(ServerInstance);
 105         }
 106
 107         void Implements(char* List)
 108         {
 109                 List[I_OnDecodeMetaData] = List[I_OnWhoisLine] = List[I_OnSyncUserMetaData] = List[I_OnUserQuit] = List[I_OnCleanup] = List[I_OnRehash] = List[I_OnPostCommand] = 1;
 110         }
 111
 112         // :kenny.chatspike.net 320 Brain Azhrarn :is getting paid to play games.
 113         int OnWhoisLine(userrec* user, userrec* dest, int &numeric, std::string &text)
 114         {
 115                 /* We use this and not OnWhois because this triggers for remote, too */
 116                 if (numeric == 312)
 117                 {
 118                         /* Insert our numeric before 312 */
 119                         std::string* swhois;
 120                         dest->GetExt("swhois", swhois);
 121                         if (swhois)
 122                         {
 123                                 ServerInstance->SendWhoisLine(user, dest, 320, "%s %s :%s",user->nick,dest->nick,swhois->c_str());
 124                         }
 125                 }
 126                 /* Dont block anything */
 127                 return 0;
 128         }
 129
 130         // Whenever the linking module wants to send out data, but doesnt know what the data
 131         // represents (e.g. it is metadata, added to a userrec or chanrec by a module) then
 132         // this method is called. We should use the ProtoSendMetaData function after we've
 133         // corrected decided how the data should look, to send the metadata on its way if
 134         // it is ours.
 135         virtual void OnSyncUserMetaData(userrec* user, Module* proto, void* opaque, const std::string &extname, bool displayable)
 136         {
 137                 // check if the linking module wants to know about OUR metadata
 138                 if (extname == "swhois")
 139                 {
 140                         // check if this user has an swhois field to send
 141                         std::string* swhois;
 142                         user->GetExt("swhois", swhois);
 143                         if (swhois)
 144                         {
 145                                 // call this function in the linking module, let it format the data how it
 146                                 // sees fit, and send it on its way. We dont need or want to know how.
 147                                 proto->ProtoSendMetaData(opaque,TYPE_USER,user,extname,*swhois);
 148                         }
 149                 }
 150         }
 151
 152         // when a user quits, tidy up their metadata
 153         virtual void OnUserQuit(userrec* user, const std::string &message, const std::string &oper_message)
 154         {
 155                 std::string* swhois;
 156                 user->GetExt("swhois", swhois);
 157                 if (swhois)
 158                 {
 159                         user->Shrink("swhois");
 160                         DELETE(swhois);
 161                 }
 162         }
 163
 164         // if the module is unloaded, tidy up all our dangling metadata
 165         virtual void OnCleanup(int target_type, void* item)
 166         {
 167                 if (target_type == TYPE_USER)
 168                 {
 169                         userrec* user = (userrec*)item;
 170                         std::string* swhois;
 171                         user->GetExt("swhois", swhois);
 172                         if (swhois)
 173                         {
 174                                 user->Shrink("swhois");
 175                                 DELETE(swhois);
 176                         }
 177                 }
 178         }
 179
 180         // Whenever the linking module receives metadata from another server and doesnt know what
 181         // to do with it (of course, hence the 'meta') it calls this method, and it is up to each
 182         // module in turn to figure out if this metadata key belongs to them, and what they want
 183         // to do with it.
 184         // In our case we're only sending a single string around, so we just construct a std::string.
 185         // Some modules will probably get much more complex and format more detailed structs and classes
 186         // in a textual way for sending over the link.
 187         virtual void OnDecodeMetaData(int target_type, void* target, const std::string &extname, const std::string &extdata)
 188         {
 189                 // check if its our metadata key, and its associated with a user
 190                 if ((target_type == TYPE_USER) && (extname == "swhois"))
 191                 {
 192                         userrec* dest = (userrec*)target;
 193                         // if they dont already have an swhois field, accept the remote server's
 194                         std::string* text;
 195                         if (!dest->GetExt("swhois", text))
 196                         {
 197                                 std::string* text = new std::string(extdata);
 198                                 dest->Extend("swhois",text);
 199                         }
 200                 }
 201         }
 202
 203         virtual void OnPostCommand(const std::string &command, const char **params, int pcnt, userrec *user, CmdResult result, const std::string &original_line)
 204         {
 205                 if ((command != "OPER") || (result != CMD_SUCCESS))
 206                         return;
 207
 208                 std::string swhois;
 209
 210                 for (int i = 0; i < Conf->Enumerate("oper"); i++)
 211                 {
 212                         std::string name = Conf->ReadValue("oper", "name", i);
 213
 214                         if (name == params[0])
 215                         {
 216                                 swhois = Conf->ReadValue("oper", "swhois", i);
 217                                 break;
 218                         }
 219                 }
 220
 221                 if (!swhois.length())
 222                 {
 223                         for (int i = 0; i < Conf->Enumerate("type"); i++)
 224                         {
 225                                 std::string type = Conf->ReadValue("type", "name", i);
 226
 227                                 if (type == user->oper)
 228                                 {
 229                                         swhois = Conf->ReadValue("type", "swhois", i);
 230                                         break;
 231                                 }
 232                         }
 233                 }
 234
 235                 std::string *old;
 236                 if (user->GetExt("swhois", old))
 237                 {
 238                         user->Shrink("swhois");
 239                         DELETE(old);
 240                 }
 241
 242                 if (!swhois.length())
 243                         return;
 244
 245                 std::string *text = new std::string(swhois);
 246                 user->Extend("swhois", text);
 247                 std::deque<std::string>* metadata = new std::deque<std::string>;
 248                 metadata->push_back(user->nick);
 249                 metadata->push_back("swhois");          // The metadata id
 250                 metadata->push_back(*text);             // The value to send
 251                 Event event((char*)metadata,(Module*)this,"send_metadata");
 252                 event.Send(ServerInstance);
 253                 delete metadata;
 254         }
 255
 256         virtual ~ModuleSWhois()
 257         {
 258                 DELETE(Conf);
 259         }
 260
 261         virtual Version GetVersion()
 262         {
 263                 return Version(1, 1, 0, 0, VF_COMMON | VF_VENDOR, API_VERSION);
 264         }
 265 };
 266
 267 MODULE_INIT(ModuleSWhois)