1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2007 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 * ---------------------------------------------------
19 /* $ModDesc: Provides the SWHOIS command which allows setting of arbitary WHOIS lines */
23 class cmd_swhois : public command_t
27 cmd_swhois (InspIRCd* Instance) : command_t(Instance,"SWHOIS",'o',2)
29 this->source = "m_swhois.so";
30 syntax = "<nick> <swhois>";
33 CmdResult Handle(const char** parameters, int pcnt, userrec* user)
35 userrec* dest = ServerInstance->FindNick(parameters[0]);
39 for(int i = 1; i < pcnt; i++)
44 line.append(parameters[i]);
48 dest->GetExt("swhois", text);
52 // We already had it set...
54 if (!ServerInstance->ULine(user->server))
55 // Ulines set SWHOISes silently
56 ServerInstance->WriteOpers("*** %s used SWHOIS to set %s's extra whois from '%s' to '%s'", user->nick, dest->nick, text->c_str(), line.c_str());
58 dest->Shrink("swhois");
61 else if(!ServerInstance->ULine(user->server))
63 // Ulines set SWHOISes silently
64 ServerInstance->WriteOpers("*** %s used SWHOIS to set %s's extra whois to '%s'", user->nick, dest->nick, line.c_str());
67 text = new std::string(line);
68 dest->Extend("swhois", text);
77 class ModuleSWhois : public Module
79 cmd_swhois* mycommand;
84 ModuleSWhois(InspIRCd* Me) : Module::Module(Me)
87 Conf = new ConfigReader(ServerInstance);
88 mycommand = new cmd_swhois(ServerInstance);
89 ServerInstance->AddCommand(mycommand);
92 void OnRehash(userrec* user, const std::string ¶meter)
95 Conf = new ConfigReader(ServerInstance);
98 void Implements(char* List)
100 List[I_OnDecodeMetaData] = List[I_OnWhoisLine] = List[I_OnSyncUserMetaData] = List[I_OnUserQuit] = List[I_OnCleanup] = List[I_OnRehash] = List[I_OnPostCommand] = 1;
103 // :kenny.chatspike.net 320 Brain Azhrarn :is getting paid to play games.
104 int OnWhoisLine(userrec* user, userrec* dest, int &numeric, std::string &text)
106 /* We use this and not OnWhois because this triggers for remote, too */
109 /* Insert our numeric before 312 */
111 dest->GetExt("swhois", swhois);
114 ServerInstance->SendWhoisLine(user, dest, 320, "%s %s :%s",user->nick,dest->nick,swhois->c_str());
117 /* Dont block anything */
121 // Whenever the linking module wants to send out data, but doesnt know what the data
122 // represents (e.g. it is metadata, added to a userrec or chanrec by a module) then
123 // this method is called. We should use the ProtoSendMetaData function after we've
124 // corrected decided how the data should look, to send the metadata on its way if
126 virtual void OnSyncUserMetaData(userrec* user, Module* proto, void* opaque, const std::string &extname)
128 // check if the linking module wants to know about OUR metadata
129 if (extname == "swhois")
131 // check if this user has an swhois field to send
133 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(userrec* user, const std::string &message)
147 user->GetExt("swhois", swhois);
150 user->Shrink("swhois");
155 // if the module is unloaded, tidy up all our dangling metadata
156 virtual void OnCleanup(int target_type, void* item)
158 if (target_type == TYPE_USER)
160 userrec* user = (userrec*)item;
162 user->GetExt("swhois", swhois);
165 user->Shrink("swhois");
171 // Whenever the linking module receives metadata from another server and doesnt know what
172 // to do with it (of course, hence the 'meta') it calls this method, and it is up to each
173 // module in turn to figure out if this metadata key belongs to them, and what they want
175 // In our case we're only sending a single string around, so we just construct a std::string.
176 // Some modules will probably get much more complex and format more detailed structs and classes
177 // in a textual way for sending over the link.
178 virtual void OnDecodeMetaData(int target_type, void* target, const std::string &extname, const std::string &extdata)
180 // check if its our metadata key, and its associated with a user
181 if ((target_type == TYPE_USER) && (extname == "swhois"))
183 userrec* dest = (userrec*)target;
184 // if they dont already have an swhois field, accept the remote server's
186 if (!dest->GetExt("swhois", text))
188 std::string* text = new std::string(extdata);
189 dest->Extend("swhois",text);
194 virtual void OnPostCommand(const std::string &command, const char **params, int pcnt, userrec *user, CmdResult result, const std::string &original_line)
196 if ((command != "OPER") || (result != CMD_SUCCESS))
201 for (int i = 0; i < Conf->Enumerate("oper"); i++)
203 std::string name = Conf->ReadValue("oper", "name", i);
205 if (name == params[0])
207 swhois = Conf->ReadValue("oper", "swhois", i);
212 if (!swhois.length())
214 for (int i = 0; i < Conf->Enumerate("type"); i++)
216 std::string type = Conf->ReadValue("type", "name", i);
218 if (type == user->oper)
220 swhois = Conf->ReadValue("type", "swhois", i);
227 if (user->GetExt("swhois", old))
229 user->Shrink("swhois");
233 if (!swhois.length())
236 std::string *text = new std::string(swhois);
237 user->Extend("swhois", text);
238 std::deque<std::string>* metadata = new std::deque<std::string>;
239 metadata->push_back(user->nick);
240 metadata->push_back("swhois"); // The metadata id
241 metadata->push_back(*text); // The value to send
242 Event event((char*)metadata,(Module*)this,"send_metadata");
243 event.Send(ServerInstance);
247 virtual ~ModuleSWhois()
252 virtual Version GetVersion()
254 return Version(1,1,0,0,VF_VENDOR,API_VERSION);
259 class ModuleSWhoisFactory : public ModuleFactory
262 ModuleSWhoisFactory()
266 ~ModuleSWhoisFactory()
270 virtual Module * CreateModule(InspIRCd* Me)
272 return new ModuleSWhois(Me);
278 extern "C" void * init_module( void )
280 return new ModuleSWhoisFactory;