1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2008 InspIRCd Development Team
6 * See: http://www.inspircd.org/wiki/index.php/Credits
8 * This program is free but copyrighted software; see
9 * the file COPYING for details.
11 * ---------------------------------------------------
16 /* $ModDesc: Provides the TITLE command which allows setting of CUSTOM WHOIS TITLE line */
20 class CommandTitle : public Command
23 CommandTitle (InspIRCd* Instance) : Command(Instance,"TITLE",0,2)
25 this->source = "m_customtitle.so";
26 syntax = "<user> <password>";
27 TRANSLATE3(TR_NICK, TR_TEXT, TR_END);
30 bool OneOfMatches(const char* host, const char* ip, const char* hostlist)
32 std::stringstream hl(hostlist);
36 if (InspIRCd::Match(host, xhost, ascii_case_insensitive_map) || InspIRCd::MatchCIDR(ip, xhost, ascii_case_insensitive_map))
44 CmdResult Handle(const std::vector<std::string> ¶meters, User* user)
52 snprintf(TheHost,MAXBUF,"%s@%s",user->ident.c_str(), user->host.c_str());
53 snprintf(TheIP, MAXBUF,"%s@%s",user->ident.c_str(), user->GetIPString());
55 ConfigReader Conf(ServerInstance);
56 for (int i=0; i<Conf.Enumerate("title"); i++)
58 std::string name = Conf.ReadValue("title", "name", "", i);
59 std::string pass = Conf.ReadValue("title", "password", "", i);
60 std::string hash = Conf.ReadValue("title", "hash", "", i);
61 std::string host = Conf.ReadValue("title", "host", "*@*", i);
62 std::string title = Conf.ReadValue("title", "title", "", i);
63 std::string vhost = Conf.ReadValue("title", "vhost", "", i);
65 if (!strcmp(name.c_str(),parameters[0].c_str()) && !ServerInstance->PassCompare(user, pass.c_str(), parameters[1].c_str(), hash.c_str()) && OneOfMatches(TheHost,TheIP,host.c_str()) && !title.empty())
68 if (user->GetExt("ctitle", text))
70 user->Shrink("ctitle");
74 text = new std::string(title);
75 user->Extend("ctitle", text);
77 ServerInstance->PI->SendMetaData(user, TYPE_USER, "ctitle", *text);
80 user->ChangeDisplayedHost(vhost.c_str());
82 if (!ServerInstance->ULine(user->server))
83 // Ulines set TITLEs silently
84 ServerInstance->SNO->WriteToSnoMask('A', "%s used TITLE to set custom title '%s'",user->nick.c_str(),title.c_str());
86 user->WriteServ("NOTICE %s :Custom title set to '%s'",user->nick.c_str(), title.c_str());
92 if (!ServerInstance->ULine(user->server))
93 // Ulines also fail TITLEs silently
94 ServerInstance->SNO->WriteToSnoMask('A', "Failed TITLE attempt by %s!%s@%s using login '%s'", user->nick.c_str(), user->ident.c_str(), user->host.c_str(), parameters[0].c_str());
96 user->WriteServ("NOTICE %s :Invalid title credentials",user->nick.c_str());
102 class ModuleCustomTitle : public Module
104 CommandTitle* mycommand;
107 ModuleCustomTitle(InspIRCd* Me) : Module(Me)
110 mycommand = new CommandTitle(ServerInstance);
111 ServerInstance->AddCommand(mycommand);
112 Implementation eventlist[] = { I_OnDecodeMetaData, I_OnWhoisLine, I_OnSyncUserMetaData, I_OnUserQuit, I_OnCleanup };
113 ServerInstance->Modules->Attach(eventlist, this, 5);
117 // :kenny.chatspike.net 320 Brain Azhrarn :is getting paid to play games.
118 int OnWhoisLine(User* user, User* dest, int &numeric, std::string &text)
120 /* We use this and not OnWhois because this triggers for remote, too */
123 /* Insert our numeric before 312 */
125 if (dest->GetExt("ctitle", ctitle))
127 ServerInstance->SendWhoisLine(user, dest, 320, "%s %s :%s",user->nick.c_str(), dest->nick.c_str(), ctitle->c_str());
130 /* Dont block anything */
134 // Whenever the linking module wants to send out data, but doesnt know what the data
135 // represents (e.g. it is metadata, added to a User or Channel by a module) then
136 // this method is called. We should use the ProtoSendMetaData function after we've
137 // corrected decided how the data should look, to send the metadata on its way if
139 virtual void OnSyncUserMetaData(User* user, Module* proto, void* opaque, const std::string &extname, bool displayable)
141 // check if the linking module wants to know about OUR metadata
142 if (extname == "ctitle")
144 // check if this user has an ctitle field to send
146 if (user->GetExt("ctitle", ctitle))
148 // call this function in the linking module, let it format the data how it
149 // sees fit, and send it on its way. We dont need or want to know how.
150 proto->ProtoSendMetaData(opaque,TYPE_USER,user,extname,*ctitle);
155 // when a user quits, tidy up their metadata
156 virtual void OnUserQuit(User* user, const std::string &message, const std::string &oper_message)
159 if (user->GetExt("ctitle", ctitle))
161 user->Shrink("ctitle");
166 // if the module is unloaded, tidy up all our dangling metadata
167 virtual void OnCleanup(int target_type, void* item)
169 if (target_type == TYPE_USER)
171 User* user = (User*)item;
173 if (user->GetExt("ctitle", ctitle))
175 user->Shrink("ctitle");
181 // Whenever the linking module receives metadata from another server and doesnt know what
182 // to do with it (of course, hence the 'meta') it calls this method, and it is up to each
183 // module in turn to figure out if this metadata key belongs to them, and what they want
185 // In our case we're only sending a single string around, so we just construct a std::string.
186 // Some modules will probably get much more complex and format more detailed structs and classes
187 // in a textual way for sending over the link.
188 virtual void OnDecodeMetaData(int target_type, void* target, const std::string &extname, const std::string &extdata)
190 // check if its our metadata key, and its associated with a user
191 if ((target_type == TYPE_USER) && (extname == "ctitle"))
193 User* dest = (User*)target;
194 // if they dont already have an ctitle field, accept the remote server's
196 if (!dest->GetExt("ctitle", text))
198 std::string* ntext = new std::string(extdata);
199 dest->Extend("ctitle",ntext);
204 virtual ~ModuleCustomTitle()
208 virtual Version GetVersion()
210 return Version("$Id$", VF_COMMON | VF_VENDOR, API_VERSION);
214 MODULE_INIT(ModuleCustomTitle)