1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
7 * <brain@chatspike.net>
8 * <Craig@chatspike.net>
10 * Written by Craig Edwards, Craig McLure, and others.
11 * This program is free but copyrighted software; see
12 * the file COPYING for details.
14 * ---------------------------------------------------
22 /* $ModDesc: Provides the SWHOIS command which allows setting of arbitary WHOIS lines */
26 class cmd_swhois : public command_t
30 cmd_swhois (InspIRCd* Instance) : command_t(Instance,"SWHOIS",'o',2)
32 this->source = "m_swhois.so";
33 syntax = "<nick> <swhois>";
36 CmdResult Handle(const char** parameters, int pcnt, userrec* user)
38 userrec* dest = ServerInstance->FindNick(parameters[0]);
42 for(int i = 1; i < pcnt; i++)
47 line.append(parameters[i]);
51 dest->GetExt("swhois", text);
55 // We already had it set...
57 if (!ServerInstance->ULine(user->server))
58 // Ulines set SWHOISes silently
59 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());
61 dest->Shrink("swhois");
64 else if(!ServerInstance->ULine(user->server))
66 // Ulines set SWHOISes silently
67 ServerInstance->WriteOpers("*** %s used SWHOIS to set %s's extra whois to '%s'", user->nick, dest->nick, line.c_str());
70 text = new std::string(line);
71 dest->Extend("swhois", text);
80 class ModuleSWhois : public Module
82 cmd_swhois* mycommand;
87 ModuleSWhois(InspIRCd* Me) : Module::Module(Me)
90 Conf = new ConfigReader(ServerInstance);
91 mycommand = new cmd_swhois(ServerInstance);
92 ServerInstance->AddCommand(mycommand);
95 void OnRehash(const std::string ¶meter)
98 Conf = new ConfigReader(ServerInstance);
101 void Implements(char* List)
103 List[I_OnWhois] = List[I_OnSyncUserMetaData] = List[I_OnUserQuit] = List[I_OnCleanup] = List[I_OnRehash] = List[I_OnPostCommand] = 1;
106 // :kenny.chatspike.net 320 Brain Azhrarn :is getting paid to play games.
107 virtual void OnWhois(userrec* source, userrec* dest)
110 dest->GetExt("swhois", swhois);
113 ServerInstance->SendWhoisLine(source, dest, 320, "%s %s :%s",source->nick,dest->nick,swhois->c_str());
117 // Whenever the linking module wants to send out data, but doesnt know what the data
118 // represents (e.g. it is metadata, added to a userrec or chanrec by a module) then
119 // this method is called. We should use the ProtoSendMetaData function after we've
120 // corrected decided how the data should look, to send the metadata on its way if
122 virtual void OnSyncUserMetaData(userrec* user, Module* proto, void* opaque, const std::string &extname)
124 // check if the linking module wants to know about OUR metadata
125 if (extname == "swhois")
127 // check if this user has an swhois field to send
129 user->GetExt("swhois", swhois);
132 // call this function in the linking module, let it format the data how it
133 // sees fit, and send it on its way. We dont need or want to know how.
134 proto->ProtoSendMetaData(opaque,TYPE_USER,user,extname,*swhois);
139 // when a user quits, tidy up their metadata
140 virtual void OnUserQuit(userrec* user, const std::string &message)
143 user->GetExt("swhois", swhois);
146 user->Shrink("swhois");
151 // if the module is unloaded, tidy up all our dangling metadata
152 virtual void OnCleanup(int target_type, void* item)
154 if (target_type == TYPE_USER)
156 userrec* user = (userrec*)item;
158 user->GetExt("swhois", swhois);
161 user->Shrink("swhois");
167 // Whenever the linking module receives metadata from another server and doesnt know what
168 // to do with it (of course, hence the 'meta') it calls this method, and it is up to each
169 // module in turn to figure out if this metadata key belongs to them, and what they want
171 // In our case we're only sending a single string around, so we just construct a std::string.
172 // Some modules will probably get much more complex and format more detailed structs and classes
173 // in a textual way for sending over the link.
174 virtual void OnDecodeMetaData(int target_type, void* target, const std::string &extname, const std::string &extdata)
176 // check if its our metadata key, and its associated with a user
177 if ((target_type == TYPE_USER) && (extname == "swhois"))
179 userrec* dest = (userrec*)target;
180 // if they dont already have an swhois field, accept the remote server's
182 if (!dest->GetExt("swhois", text))
184 std::string* text = new std::string(extdata);
185 dest->Extend("swhois",text);
190 virtual void OnPostCommand(const std::string &command, const char **params, int pcnt, userrec *user, CmdResult result, const std::string &original_line)
192 if ((command != "OPER") || (result != CMD_SUCCESS))
197 for (int i = 0; i < Conf->Enumerate("oper"); i++)
199 std::string name = Conf->ReadValue("oper", "name", i);
201 if (name == params[0])
203 swhois = Conf->ReadValue("oper", "swhois", i);
208 if (!swhois.length())
210 for (int i = 0; i < Conf->Enumerate("type"); i++)
212 std::string type = Conf->ReadValue("type", "name", i);
214 if (type == user->oper)
216 swhois = Conf->ReadValue("type", "swhois", i);
223 if (user->GetExt("swhois", old))
225 user->Shrink("swhois");
229 if (!swhois.length())
232 std::string *text = new std::string(swhois);
233 user->Extend("swhois", text);
236 virtual ~ModuleSWhois()
241 virtual Version GetVersion()
243 return Version(1,1,0,0,VF_VENDOR,API_VERSION);
248 class ModuleSWhoisFactory : public ModuleFactory
251 ModuleSWhoisFactory()
255 ~ModuleSWhoisFactory()
259 virtual Module * CreateModule(InspIRCd* Me)
261 return new ModuleSWhois(Me);
267 extern "C" void * init_module( void )
269 return new ModuleSWhoisFactory;