src/modules/m_customtitle.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 #include "wildcard.h"
  19
  20 /* $ModDesc: Provides the TITLE command which allows setting of CUSTOM WHOIS TITLE line */
  21
  22 /** Handle /TITLE
  23  */
  24 class cmd_title : public command_t
  25 {
  26
  27  public:
  28         cmd_title (InspIRCd* Instance) : command_t(Instance,"TITLE",0,2)
  29         {
  30                 this->source = "m_customtitle.so";
  31                 syntax = "<user> <password>";
  32         }
  33
  34 bool OneOfMatches(const char* host, const char* ip, const char* hostlist)
  35 {
  36     std::stringstream hl(hostlist);
  37     std::string xhost;
  38     while (hl >> xhost)
  39     {
  40         if (match(host,xhost.c_str()) || match(ip,xhost.c_str(),true))
  41         {
  42             return true;
  43         }
  44     }
  45     return false;
  46 }
  47
  48         CmdResult Handle(const char** parameters, int pcnt, userrec* user)
  49         {
  50                 if (!IS_LOCAL(user))
  51                         return CMD_LOCALONLY;
  52
  53                 char TheHost[MAXBUF];
  54                 char TheIP[MAXBUF];
  55
  56                 snprintf(TheHost,MAXBUF,"%s@%s",user->ident,user->host);
  57                 snprintf(TheIP, MAXBUF,"%s@%s",user->ident,user->GetIPString());
  58
  59                 ConfigReader Conf(ServerInstance);
  60                 for (int i=0; i<Conf.Enumerate("title"); i++)
  61                 {
  62                         std::string name = Conf.ReadValue("title", "name", "", i);
  63                         std::string pass = Conf.ReadValue("title", "password", "", i);
  64                         std::string host = Conf.ReadValue("title", "host", "*@*", i);
  65                         std::string title = Conf.ReadValue("title", "title", "", i);
  66                         std::string vhost = Conf.ReadValue("title", "vhost", "", i);
  67
  68                         if (!strcmp(name.c_str(),parameters[0]) && !strcmp(pass.c_str(),parameters[1]) && OneOfMatches(TheHost,TheIP,host.c_str()) && !title.empty())
  69                         {
  70                                 std::string* text;
  71                                 user->GetExt("ctitle", text);
  72
  73                                 if (text)
  74                                 {
  75                                         user->Shrink("ctitle");
  76                                         DELETE(text);
  77                                 }
  78
  79                                 text = new std::string(title);
  80                                 user->Extend("ctitle", text);
  81
  82 //                              METADATA peavey ctitle :Official Chat Helper
  83
  84                                 std::deque<std::string>* metadata = new std::deque<std::string>;
  85                                 metadata->push_back(user->nick);
  86                                 metadata->push_back("ctitle");      // The metadata id
  87                                 metadata->push_back(*text);     // The value to send
  88                                 Event event((char*)metadata,(Module*)this,"send_metadata");
  89                                 event.Send(ServerInstance);
  90                                 delete metadata;
  91
  92                                 if (!vhost.empty())
  93                                         user->ChangeDisplayedHost(vhost.c_str());
  94
  95                                 if (!ServerInstance->ULine(user->server))
  96                                         // Ulines set TITLEs silently
  97                                         ServerInstance->WriteOpers("*** %s used TITLE to set custom title '%s'",user->nick,title.c_str());
  98
  99                                 user->WriteServ("NOTICE %s :Custom title set to '%s'",user->nick, title.c_str());
 100
 101                                 return CMD_SUCCESS;
 102                         }
 103                 }
 104
 105                 if (!ServerInstance->ULine(user->server))
 106                         // Ulines also fail TITLEs silently
 107                         ServerInstance->WriteOpers("*** Failed TITLE attempt by %s!%s@%s using login '%s'",user->nick,user->ident,user->host,parameters[0]);
 108
 109                 user->WriteServ("NOTICE %s :Invalid title credentials",user->nick);
 110                 return CMD_SUCCESS;
 111         }
 112
 113 };
 114
 115 class ModuleCustomTitle : public Module
 116 {
 117         cmd_title* mycommand;
 118
 119  public:
 120         ModuleCustomTitle(InspIRCd* Me) : Module(Me)
 121         {
 122
 123                 mycommand = new cmd_title(ServerInstance);
 124                 ServerInstance->AddCommand(mycommand);
 125         }
 126
 127         void Implements(char* List)
 128         {
 129                 List[I_OnDecodeMetaData] = List[I_OnWhoisLine] = List[I_OnSyncUserMetaData] = List[I_OnUserQuit] = List[I_OnCleanup] = 1;
 130         }
 131
 132         // :kenny.chatspike.net 320 Brain Azhrarn :is getting paid to play games.
 133         int OnWhoisLine(userrec* user, userrec* dest, int &numeric, std::string &text)
 134         {
 135                 /* We use this and not OnWhois because this triggers for remote, too */
 136                 if (numeric == 312)
 137                 {
 138                         /* Insert our numeric before 312 */
 139                         std::string* ctitle;
 140                         dest->GetExt("ctitle", ctitle);
 141                         if (ctitle)
 142                         {
 143                                 ServerInstance->SendWhoisLine(user, dest, 320, "%s %s :%s",user->nick,dest->nick,ctitle->c_str());
 144                         }
 145                 }
 146                 /* Dont block anything */
 147                 return 0;
 148         }
 149
 150         // Whenever the linking module wants to send out data, but doesnt know what the data
 151         // represents (e.g. it is metadata, added to a userrec or chanrec by a module) then
 152         // this method is called. We should use the ProtoSendMetaData function after we've
 153         // corrected decided how the data should look, to send the metadata on its way if
 154         // it is ours.
 155         virtual void OnSyncUserMetaData(userrec* user, Module* proto, void* opaque, const std::string &extname, bool displayable)
 156         {
 157                 // check if the linking module wants to know about OUR metadata
 158                 if (extname == "ctitle")
 159                 {
 160                         // check if this user has an ctitle field to send
 161                         std::string* ctitle;
 162                         user->GetExt("ctitle", ctitle);
 163                         if (ctitle)
 164                         {
 165                                 // call this function in the linking module, let it format the data how it
 166                                 // sees fit, and send it on its way. We dont need or want to know how.
 167                                 proto->ProtoSendMetaData(opaque,TYPE_USER,user,extname,*ctitle);
 168                         }
 169                 }
 170         }
 171
 172         // when a user quits, tidy up their metadata
 173         virtual void OnUserQuit(userrec* user, const std::string &message, const std::string &oper_message)
 174         {
 175                 std::string* ctitle;
 176                 user->GetExt("ctitle", ctitle);
 177                 if (ctitle)
 178                 {
 179                         user->Shrink("ctitle");
 180                         DELETE(ctitle);
 181                 }
 182         }
 183
 184         // if the module is unloaded, tidy up all our dangling metadata
 185         virtual void OnCleanup(int target_type, void* item)
 186         {
 187                 if (target_type == TYPE_USER)
 188                 {
 189                         userrec* user = (userrec*)item;
 190                         std::string* ctitle;
 191                         user->GetExt("ctitle", ctitle);
 192                         if (ctitle)
 193                         {
 194                                 user->Shrink("ctitle");
 195                                 DELETE(ctitle);
 196                         }
 197                 }
 198         }
 199
 200         // Whenever the linking module receives metadata from another server and doesnt know what
 201         // to do with it (of course, hence the 'meta') it calls this method, and it is up to each
 202         // module in turn to figure out if this metadata key belongs to them, and what they want
 203         // to do with it.
 204         // In our case we're only sending a single string around, so we just construct a std::string.
 205         // Some modules will probably get much more complex and format more detailed structs and classes
 206         // in a textual way for sending over the link.
 207         virtual void OnDecodeMetaData(int target_type, void* target, const std::string &extname, const std::string &extdata)
 208         {
 209                 // check if its our metadata key, and its associated with a user
 210                 if ((target_type == TYPE_USER) && (extname == "ctitle"))
 211                 {
 212                         userrec* dest = (userrec*)target;
 213                         // if they dont already have an ctitle field, accept the remote server's
 214                         std::string* text;
 215                         if (!dest->GetExt("ctitle", text))
 216                         {
 217                                 std::string* text = new std::string(extdata);
 218                                 dest->Extend("ctitle",text);
 219                         }
 220                 }
 221         }
 222
 223         virtual ~ModuleCustomTitle()
 224         {
 225         }
 226
 227         virtual Version GetVersion()
 228         {
 229                 return Version(1,1,0,0,VF_VENDOR,API_VERSION);
 230         }
 231 };
 232
 233 MODULE_INIT(ModuleCustomTitle)