1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2009 InspIRCd Development Team
6 * See: http://wiki.inspircd.org/Credits
8 * This program is free but copyrighted software; see
9 * the file COPYING for details.
11 * ---------------------------------------------------
16 /* $ModDesc: Provides the SWHOIS command which allows setting of arbitary WHOIS lines */
20 class CommandSwhois : public Command
24 CommandSwhois (InspIRCd* Instance) : Command(Instance,"SWHOIS","o",2, 2)
26 this->source = "m_swhois.so";
27 syntax = "<nick> :<swhois>";
28 TRANSLATE3(TR_NICK, TR_TEXT, TR_END);
31 CmdResult Handle(const std::vector<std::string> ¶meters, User* user)
33 User* dest = ServerInstance->FindNick(parameters[0]);
37 user->WriteNumeric(ERR_NOSUCHNICK, "%s %s :No such nick/channel", user->nick.c_str(), parameters[0].c_str());
42 if (dest->GetExt("swhois", text))
44 // We already had it set...
45 if (!ServerInstance->ULine(user->server))
46 // Ulines set SWHOISes silently
47 ServerInstance->SNO->WriteGlobalSno('a', "%s used SWHOIS to set %s's extra whois from '%s' to '%s'", user->nick.c_str(), dest->nick.c_str(), text->c_str(), parameters[1].c_str());
49 dest->Shrink("swhois");
52 else if (!ServerInstance->ULine(user->server))
54 // Ulines set SWHOISes silently
55 ServerInstance->SNO->WriteGlobalSno('a', "%s used SWHOIS to set %s's extra whois to '%s'", user->nick.c_str(), dest->nick.c_str(), parameters[1].c_str());
58 text = new std::string(parameters[1]);
59 dest->Extend("swhois", text);
61 /* Bug #376 - feature request -
62 * To cut down on the amount of commands services etc have to recognise, this only sends METADATA across the network now
63 * not an actual SWHOIS command. Any SWHOIS command sent from services will be automatically translated to METADATA by this.
64 * Sorry w00t i know this was your fix, but i got bored and wanted to clear down the tracker :)
67 ServerInstance->PI->SendMetaData(dest, TYPE_USER, "swhois", *text);
69 // If it's an empty swhois, unset it (not ideal, but ok)
72 dest->Shrink("swhois");
81 class ModuleSWhois : public Module
88 ModuleSWhois(InspIRCd* Me) : Module(Me), cmd(Me)
91 Conf = new ConfigReader(ServerInstance);
92 ServerInstance->AddCommand(&cmd);
93 Implementation eventlist[] = { I_OnDecodeMetaData, I_OnWhoisLine, I_OnSyncUserMetaData, I_OnUserQuit, I_OnCleanup, I_OnRehash, I_OnPostCommand };
94 ServerInstance->Modules->Attach(eventlist, this, 7);
97 void OnRehash(User* user)
100 Conf = new ConfigReader(ServerInstance);
104 // :kenny.chatspike.net 320 Brain Azhrarn :is getting paid to play games.
105 int OnWhoisLine(User* user, User* dest, int &numeric, std::string &text)
107 /* We use this and not OnWhois because this triggers for remote, too */
110 /* Insert our numeric before 312 */
112 if (dest->GetExt("swhois", swhois))
114 ServerInstance->SendWhoisLine(user, dest, 320, "%s %s :%s",user->nick.c_str(), dest->nick.c_str(), swhois->c_str());
118 /* Dont block anything */
122 // Whenever the linking module wants to send out data, but doesnt know what the data
123 // represents (e.g. it is metadata, added to a User or Channel by a module) then
124 // this method is called. We should use the ProtoSendMetaData function after we've
125 // corrected decided how the data should look, to send the metadata on its way if
127 virtual void OnSyncUserMetaData(User* user, Module* proto, void* opaque, const std::string &extname, bool displayable)
129 // check if the linking module wants to know about OUR metadata
130 if (extname == "swhois")
132 // check if this user has an swhois field to send
134 if (user->GetExt("swhois", swhois))
136 // call this function in the linking module, let it format the data how it
137 // sees fit, and send it on its way. We dont need or want to know how.
138 proto->ProtoSendMetaData(opaque,TYPE_USER,user,extname,*swhois);
143 // when a user quits, tidy up their metadata
144 virtual void OnUserQuit(User* user, const std::string &message, const std::string &oper_message)
147 if (user->GetExt("swhois", swhois))
149 user->Shrink("swhois");
154 // if the module is unloaded, tidy up all our dangling metadata
155 virtual void OnCleanup(int target_type, void* item)
157 if (target_type == TYPE_USER)
159 User* user = (User*)item;
161 if (user->GetExt("swhois", swhois))
163 user->Shrink("swhois");
169 // Whenever the linking module receives metadata from another server and doesnt know what
170 // to do with it (of course, hence the 'meta') it calls this method, and it is up to each
171 // module in turn to figure out if this metadata key belongs to them, and what they want
173 // In our case we're only sending a single string around, so we just construct a std::string.
174 // Some modules will probably get much more complex and format more detailed structs and classes
175 // in a textual way for sending over the link.
176 virtual void OnDecodeMetaData(int target_type, void* target, const std::string &extname, const std::string &extdata)
178 // check if its our metadata key, and its associated with a user
179 if ((target_type == TYPE_USER) && (extname == "swhois"))
181 User* dest = (User*)target;
183 // if they already have an swhois field, trash it and replace it with the remote one.
185 if (dest->GetExt("swhois", text))
187 dest->Shrink("swhois");
192 return; // XXX does the command parser even allow sending blank mdata? it needs to here! -- w00t
194 text = new std::string(extdata);
195 dest->Extend("swhois", text);
199 virtual void OnPostCommand(const std::string &command, const std::vector<std::string> ¶ms, User *user, CmdResult result, const std::string &original_line)
201 if ((command != "OPER") || (result != CMD_SUCCESS))
206 for (int i = 0; i < Conf->Enumerate("oper"); i++)
208 std::string name = Conf->ReadValue("oper", "name", i);
210 if (name == params[0])
212 swhois = Conf->ReadValue("oper", "swhois", i);
217 if (!swhois.length())
219 for (int i = 0; i < Conf->Enumerate("type"); i++)
221 std::string type = Conf->ReadValue("type", "name", i);
223 if (type == user->oper)
225 swhois = Conf->ReadValue("type", "swhois", i);
232 if (user->GetExt("swhois", old))
234 user->Shrink("swhois");
238 if (!swhois.length())
241 std::string *text = new std::string(swhois);
242 user->Extend("swhois", text);
243 ServerInstance->PI->SendMetaData(user, TYPE_USER, "swhois", *text);
246 virtual ~ModuleSWhois()
251 virtual Version GetVersion()
253 return Version("$Id$", VF_COMMON | VF_VENDOR, API_VERSION);
257 MODULE_INIT(ModuleSWhois)