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 * ---------------------------------------------------
17 /* $ModDesc: Provides the TITLE command which allows setting of CUSTOM WHOIS TITLE line */
21 class CommandTitle : public Command
24 CommandTitle (InspIRCd* Instance) : Command(Instance,"TITLE",0,2)
26 this->source = "m_customtitle.so";
27 syntax = "<user> <password>";
28 TRANSLATE3(TR_NICK, TR_TEXT, TR_END);
31 bool OneOfMatches(const char* host, const char* ip, const char* hostlist)
33 std::stringstream hl(hostlist);
37 if (match(host, xhost) || match(ip,xhost, true))
45 CmdResult Handle(const std::vector<std::string> ¶meters, User* user)
53 snprintf(TheHost,MAXBUF,"%s@%s",user->ident.c_str(), user->host.c_str());
54 snprintf(TheIP, MAXBUF,"%s@%s",user->ident.c_str(), user->GetIPString());
56 ConfigReader Conf(ServerInstance);
57 for (int i=0; i<Conf.Enumerate("title"); i++)
59 std::string name = Conf.ReadValue("title", "name", "", i);
60 std::string pass = Conf.ReadValue("title", "password", "", i);
61 std::string hash = Conf.ReadValue("title", "hash", "", i);
62 std::string host = Conf.ReadValue("title", "host", "*@*", i);
63 std::string title = Conf.ReadValue("title", "title", "", i);
64 std::string vhost = Conf.ReadValue("title", "vhost", "", i);
66 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())
69 user->GetExt("ctitle", text);
73 user->Shrink("ctitle");
77 text = new std::string(title);
78 user->Extend("ctitle", text);
80 ServerInstance->PI->SendMetaData(user, TYPE_USER, "ctitle", *text);
83 user->ChangeDisplayedHost(vhost.c_str());
85 if (!ServerInstance->ULine(user->server))
86 // Ulines set TITLEs silently
87 ServerInstance->SNO->WriteToSnoMask('A', "%s used TITLE to set custom title '%s'",user->nick.c_str(),title.c_str());
89 user->WriteServ("NOTICE %s :Custom title set to '%s'",user->nick.c_str(), title.c_str());
95 if (!ServerInstance->ULine(user->server))
96 // Ulines also fail TITLEs silently
97 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());
99 user->WriteServ("NOTICE %s :Invalid title credentials",user->nick.c_str());
105 class ModuleCustomTitle : public Module
107 CommandTitle* mycommand;
110 ModuleCustomTitle(InspIRCd* Me) : Module(Me)
113 mycommand = new CommandTitle(ServerInstance);
114 ServerInstance->AddCommand(mycommand);
115 Implementation eventlist[] = { I_OnDecodeMetaData, I_OnWhoisLine, I_OnSyncUserMetaData, I_OnUserQuit, I_OnCleanup };
116 ServerInstance->Modules->Attach(eventlist, this, 5);
120 // :kenny.chatspike.net 320 Brain Azhrarn :is getting paid to play games.
121 int OnWhoisLine(User* user, User* dest, int &numeric, std::string &text)
123 /* We use this and not OnWhois because this triggers for remote, too */
126 /* Insert our numeric before 312 */
128 dest->GetExt("ctitle", ctitle);
131 ServerInstance->SendWhoisLine(user, dest, 320, "%s %s :%s",user->nick.c_str(), dest->nick.c_str(), ctitle->c_str());
134 /* Dont block anything */
138 // Whenever the linking module wants to send out data, but doesnt know what the data
139 // represents (e.g. it is metadata, added to a User or Channel by a module) then
140 // this method is called. We should use the ProtoSendMetaData function after we've
141 // corrected decided how the data should look, to send the metadata on its way if
143 virtual void OnSyncUserMetaData(User* user, Module* proto, void* opaque, const std::string &extname, bool displayable)
145 // check if the linking module wants to know about OUR metadata
146 if (extname == "ctitle")
148 // check if this user has an ctitle field to send
150 user->GetExt("ctitle", ctitle);
153 // call this function in the linking module, let it format the data how it
154 // sees fit, and send it on its way. We dont need or want to know how.
155 proto->ProtoSendMetaData(opaque,TYPE_USER,user,extname,*ctitle);
160 // when a user quits, tidy up their metadata
161 virtual void OnUserQuit(User* user, const std::string &message, const std::string &oper_message)
164 user->GetExt("ctitle", ctitle);
167 user->Shrink("ctitle");
172 // if the module is unloaded, tidy up all our dangling metadata
173 virtual void OnCleanup(int target_type, void* item)
175 if (target_type == TYPE_USER)
177 User* user = (User*)item;
179 user->GetExt("ctitle", ctitle);
182 user->Shrink("ctitle");
188 // Whenever the linking module receives metadata from another server and doesnt know what
189 // to do with it (of course, hence the 'meta') it calls this method, and it is up to each
190 // module in turn to figure out if this metadata key belongs to them, and what they want
192 // In our case we're only sending a single string around, so we just construct a std::string.
193 // Some modules will probably get much more complex and format more detailed structs and classes
194 // in a textual way for sending over the link.
195 virtual void OnDecodeMetaData(int target_type, void* target, const std::string &extname, const std::string &extdata)
197 // check if its our metadata key, and its associated with a user
198 if ((target_type == TYPE_USER) && (extname == "ctitle"))
200 User* dest = (User*)target;
201 // if they dont already have an ctitle field, accept the remote server's
203 if (!dest->GetExt("ctitle", text))
205 std::string* ntext = new std::string(extdata);
206 dest->Extend("ctitle",ntext);
211 virtual ~ModuleCustomTitle()
215 virtual Version GetVersion()
217 return Version(1, 2, 0, 0, VF_COMMON | VF_VENDOR, API_VERSION);
221 MODULE_INIT(ModuleCustomTitle)