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 * ---------------------------------------------------
23 /* $ModDesc: Provides the SWHOIS command which allows setting of arbitary WHOIS lines */
27 class cmd_swhois : public command_t
31 cmd_swhois (InspIRCd* Instance) : command_t(Instance,"SWHOIS",'o',2)
33 this->source = "m_swhois.so";
34 syntax = "<nick> <swhois>";
37 CmdResult Handle(const char** parameters, int pcnt, userrec* user)
39 userrec* dest = ServerInstance->FindNick(parameters[0]);
43 for(int i = 1; i < pcnt; i++)
48 line.append(parameters[i]);
52 dest->GetExt("swhois", text);
56 // We already had it set...
58 if (!ServerInstance->ULine(user->server))
59 // Ulines set SWHOISes silently
60 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());
62 dest->Shrink("swhois");
65 else if(!ServerInstance->ULine(user->server))
67 // Ulines set SWHOISes silently
68 ServerInstance->WriteOpers("*** %s used SWHOIS to set %s's extra whois to '%s'", user->nick, dest->nick, line.c_str());
71 text = new std::string(line);
72 dest->Extend("swhois", text);
81 class ModuleSWhois : public Module
83 cmd_swhois* mycommand;
88 ModuleSWhois(InspIRCd* Me) : Module::Module(Me)
91 Conf = new ConfigReader(ServerInstance);
92 mycommand = new cmd_swhois(ServerInstance);
93 ServerInstance->AddCommand(mycommand);
96 void OnRehash(const std::string ¶meter)
99 Conf = new ConfigReader(ServerInstance);
102 void Implements(char* List)
104 List[I_OnWhois] = List[I_OnSyncUserMetaData] = List[I_OnUserQuit] = List[I_OnCleanup] = List[I_OnRehash] = List[I_OnOper] = 1;
107 // :kenny.chatspike.net 320 Brain Azhrarn :is getting paid to play games.
108 virtual void OnWhois(userrec* source, userrec* dest)
111 dest->GetExt("swhois", swhois);
114 source->WriteServ("320 %s %s :%s",source->nick,dest->nick,swhois->c_str());
118 // Whenever the linking module wants to send out data, but doesnt know what the data
119 // represents (e.g. it is metadata, added to a userrec or chanrec by a module) then
120 // this method is called. We should use the ProtoSendMetaData function after we've
121 // corrected decided how the data should look, to send the metadata on its way if
123 virtual void OnSyncUserMetaData(userrec* user, Module* proto, void* opaque, const std::string &extname)
125 // check if the linking module wants to know about OUR metadata
126 if (extname == "swhois")
128 // check if this user has an swhois field to send
130 user->GetExt("swhois", swhois);
133 // call this function in the linking module, let it format the data how it
134 // sees fit, and send it on its way. We dont need or want to know how.
135 proto->ProtoSendMetaData(opaque,TYPE_USER,user,extname,*swhois);
140 // when a user quits, tidy up their metadata
141 virtual void OnUserQuit(userrec* user, const std::string &message)
144 user->GetExt("swhois", swhois);
147 user->Shrink("swhois");
152 // if the module is unloaded, tidy up all our dangling metadata
153 virtual void OnCleanup(int target_type, void* item)
155 if (target_type == TYPE_USER)
157 userrec* user = (userrec*)item;
159 user->GetExt("swhois", swhois);
162 user->Shrink("swhois");
168 // Whenever the linking module receives metadata from another server and doesnt know what
169 // to do with it (of course, hence the 'meta') it calls this method, and it is up to each
170 // module in turn to figure out if this metadata key belongs to them, and what they want
172 // In our case we're only sending a single string around, so we just construct a std::string.
173 // Some modules will probably get much more complex and format more detailed structs and classes
174 // in a textual way for sending over the link.
175 virtual void OnDecodeMetaData(int target_type, void* target, const std::string &extname, const std::string &extdata)
177 // check if its our metadata key, and its associated with a user
178 if ((target_type == TYPE_USER) && (extname == "swhois"))
180 userrec* dest = (userrec*)target;
181 // if they dont already have an swhois field, accept the remote server's
183 if (!dest->GetExt("swhois", text))
185 std::string* text = new std::string(extdata);
186 dest->Extend("swhois",text);
191 virtual void OnOper(userrec* user, const std::string &opertype)
193 for(int i =0; i < Conf->Enumerate("type"); i++)
195 std::string type = Conf->ReadValue("type", "name", i);
197 if(strcmp(type.c_str(), user->oper) == 0)
199 std::string swhois = Conf->ReadValue("type", "swhois", i);
204 if(user->GetExt("swhois", old))
206 user->Shrink("swhois");
210 std::string* text = new std::string(swhois);
211 user->Extend("swhois", text);
219 virtual ~ModuleSWhois()
224 virtual Version GetVersion()
226 return Version(1,0,0,0,VF_VENDOR,API_VERSION);
231 class ModuleSWhoisFactory : public ModuleFactory
234 ModuleSWhoisFactory()
238 ~ModuleSWhoisFactory()
242 virtual Module * CreateModule(InspIRCd* Me)
244 return new ModuleSWhois(Me);
250 extern "C" void * init_module( void )
252 return new ModuleSWhoisFactory;