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                                 if (!vhost.empty())
  83                                         user->ChangeDisplayedHost(vhost.c_str());
  84
  85                                 if (!ServerInstance->ULine(user->server))
  86                                         // Ulines set TITLEs silently
  87                                         ServerInstance->WriteOpers("*** %s used TITLE to set custom title '%s'",user->nick,title.c_str());
  88
  89                                 user->WriteServ("NOTICE %s :Custom title set to '%s'",user->nick, title.c_str());
  90
  91                                 return CMD_SUCCESS;
  92                         }
  93                 }
  94
  95                 if (!ServerInstance->ULine(user->server))
  96                         // Ulines also fail TITLEs silently
  97                         ServerInstance->WriteOpers("*** Failed TITLE attempt by %s!%s@%s using login '%s'",user->nick,user->ident,user->host,parameters[0]);
  98
  99                 user->WriteServ("NOTICE %s :Invalid title credentials",user->nick);
 100                 return CMD_SUCCESS;
 101         }
 102
 103 };
 104
 105 class ModuleCustomTitle : public Module
 106 {
 107         cmd_title* mycommand;
 108
 109  public:
 110         ModuleCustomTitle(InspIRCd* Me) : Module(Me)
 111         {
 112
 113                 mycommand = new cmd_title(ServerInstance);
 114                 ServerInstance->AddCommand(mycommand);
 115         }
 116
 117         void Implements(char* List)
 118         {
 119                 List[I_OnDecodeMetaData] = List[I_OnWhoisLine] = List[I_OnSyncUserMetaData] = List[I_OnUserQuit] = List[I_OnCleanup] = 1;
 120         }
 121
 122         // :kenny.chatspike.net 320 Brain Azhrarn :is getting paid to play games.
 123         int OnWhoisLine(userrec* user, userrec* dest, int &numeric, std::string &text)
 124         {
 125                 /* We use this and not OnWhois because this triggers for remote, too */
 126                 if (numeric == 312)
 127                 {
 128                         /* Insert our numeric before 312 */
 129                         std::string* ctitle;
 130                         dest->GetExt("ctitle", ctitle);
 131                         if (ctitle)
 132                         {
 133                                 ServerInstance->SendWhoisLine(user, dest, 320, "%s %s :%s",user->nick,dest->nick,ctitle->c_str());
 134                         }
 135                 }
 136                 /* Dont block anything */
 137                 return 0;
 138         }
 139
 140         // Whenever the linking module wants to send out data, but doesnt know what the data
 141         // represents (e.g. it is metadata, added to a userrec or chanrec by a module) then
 142         // this method is called. We should use the ProtoSendMetaData function after we've
 143         // corrected decided how the data should look, to send the metadata on its way if
 144         // it is ours.
 145         virtual void OnSyncUserMetaData(userrec* user, Module* proto, void* opaque, const std::string &extname, bool displayable)
 146         {
 147                 // check if the linking module wants to know about OUR metadata
 148                 if (extname == "ctitle")
 149                 {
 150                         // check if this user has an ctitle field to send
 151                         std::string* ctitle;
 152                         user->GetExt("ctitle", ctitle);
 153                         if (ctitle)
 154                         {
 155                                 // call this function in the linking module, let it format the data how it
 156                                 // sees fit, and send it on its way. We dont need or want to know how.
 157                                 proto->ProtoSendMetaData(opaque,TYPE_USER,user,extname,*ctitle);
 158                         }
 159                 }
 160         }
 161
 162         // when a user quits, tidy up their metadata
 163         virtual void OnUserQuit(userrec* user, const std::string &message, const std::string &oper_message)
 164         {
 165                 std::string* ctitle;
 166                 user->GetExt("ctitle", ctitle);
 167                 if (ctitle)
 168                 {
 169                         user->Shrink("ctitle");
 170                         DELETE(ctitle);
 171                 }
 172         }
 173
 174         // if the module is unloaded, tidy up all our dangling metadata
 175         virtual void OnCleanup(int target_type, void* item)
 176         {
 177                 if (target_type == TYPE_USER)
 178                 {
 179                         userrec* user = (userrec*)item;
 180                         std::string* ctitle;
 181                         user->GetExt("ctitle", ctitle);
 182                         if (ctitle)
 183                         {
 184                                 user->Shrink("ctitle");
 185                                 DELETE(ctitle);
 186                         }
 187                 }
 188         }
 189
 190         // Whenever the linking module receives metadata from another server and doesnt know what
 191         // to do with it (of course, hence the 'meta') it calls this method, and it is up to each
 192         // module in turn to figure out if this metadata key belongs to them, and what they want
 193         // to do with it.
 194         // In our case we're only sending a single string around, so we just construct a std::string.
 195         // Some modules will probably get much more complex and format more detailed structs and classes
 196         // in a textual way for sending over the link.
 197         virtual void OnDecodeMetaData(int target_type, void* target, const std::string &extname, const std::string &extdata)
 198         {
 199                 // check if its our metadata key, and its associated with a user
 200                 if ((target_type == TYPE_USER) && (extname == "ctitle"))
 201                 {
 202                         userrec* dest = (userrec*)target;
 203                         // if they dont already have an ctitle field, accept the remote server's
 204                         std::string* text;
 205                         if (!dest->GetExt("ctitle", text))
 206                         {
 207                                 std::string* text = new std::string(extdata);
 208                                 dest->Extend("ctitle",text);
 209                         }
 210                 }
 211         }
 212
 213         virtual ~ModuleCustomTitle()
 214         {
 215         }
 216
 217         virtual Version GetVersion()
 218         {
 219                 return Version(1,1,0,0,VF_VENDOR,API_VERSION);
 220         }
 221 };
 222
 223 MODULE_INIT(ModuleCustomTitle)