* | Inspire Internet Relay Chat Daemon |
* +------------------------------------+
*
- * InspIRCd: (C) 2002-2007 InspIRCd Development Team
- * See: http://www.inspircd.org/wiki/index.php/Credits
+ * InspIRCd: (C) 2002-2010 InspIRCd Development Team
+ * See: http://wiki.inspircd.org/Credits
*
* This program is free but copyrighted software; see
* the file COPYING for details.
*/
#include "inspircd.h"
-#include "users.h"
-#include "channels.h"
-#include "modules.h"
/* $ModDesc: Provides the SWHOIS command which allows setting of arbitary WHOIS lines */
/** Handle /SWHOIS
*/
-class cmd_swhois : public command_t
+class CommandSwhois : public Command
{
-
public:
- cmd_swhois (InspIRCd* Instance) : command_t(Instance,"SWHOIS",'o',2)
+ StringExtItem swhois;
+ CommandSwhois(Module* Creator) : Command(Creator,"SWHOIS", 2,2), swhois("swhois", Creator)
{
- this->source = "m_swhois.so";
- syntax = "<nick> <swhois>";
+ flags_needed = 'o'; syntax = "<nick> :<swhois>";
+ ServerInstance->Extensions.Register(&swhois);
+ TRANSLATE3(TR_NICK, TR_TEXT, TR_END);
}
- CmdResult Handle(const char** parameters, int pcnt, userrec* user)
+ CmdResult Handle(const std::vector<std::string> ¶meters, User* user)
{
- userrec* dest = ServerInstance->FindNick(parameters[0]);
-
- if (!dest)
- {
- user->WriteServ("401 %s %s :No such nick/channel", user->nick, parameters[0]);
- return CMD_FAILURE;
- }
+ User* dest = ServerInstance->FindNick(parameters[0]);
- if (!*parameters[1])
+ if (!dest)
{
- user->WriteServ("NOTICE %s :*** SWHOIS: Whois line must be specified", user->nick);
+ user->WriteNumeric(ERR_NOSUCHNICK, "%s %s :No such nick/channel", user->nick.c_str(), parameters[0].c_str());
return CMD_FAILURE;
}
-
- std::string line;
- for (int i = 1; i < pcnt; i++)
- {
- if (i != 1)
- line.append(" ");
-
- line.append(parameters[i]);
- }
-
- std::string* text;
- dest->GetExt("swhois", text);
+ std::string* text = swhois.get(dest);
if (text)
{
// We already had it set...
-
if (!ServerInstance->ULine(user->server))
// Ulines set SWHOISes silently
- 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());
-
- dest->Shrink("swhois");
- DELETE(text);
+ 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());
}
else if (!ServerInstance->ULine(user->server))
{
// Ulines set SWHOISes silently
- ServerInstance->WriteOpers("*** %s used SWHOIS to set %s's extra whois to '%s'", user->nick, dest->nick, line.c_str());
+ 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());
}
-
- text = new std::string(line);
- dest->Extend("swhois", text);
+
+ if (parameters[1].empty())
+ swhois.unset(dest);
+ else
+ swhois.set(dest, parameters[1]);
+
+ /* Bug #376 - feature request -
+ * To cut down on the amount of commands services etc have to recognise, this only sends METADATA across the network now
+ * not an actual SWHOIS command. Any SWHOIS command sent from services will be automatically translated to METADATA by this.
+ * Sorry w00t i know this was your fix, but i got bored and wanted to clear down the tracker :)
+ * -- Brain
+ */
+ ServerInstance->PI->SendMetaData(dest, "swhois", parameters[1]);
return CMD_SUCCESS;
}
class ModuleSWhois : public Module
{
- cmd_swhois* mycommand;
-
- ConfigReader* Conf;
-
- public:
- ModuleSWhois(InspIRCd* Me) : Module(Me)
- {
-
- Conf = new ConfigReader(ServerInstance);
- mycommand = new cmd_swhois(ServerInstance);
- ServerInstance->AddCommand(mycommand);
- }
-
- void OnRehash(userrec* user, const std::string ¶meter)
- {
- DELETE(Conf);
- Conf = new ConfigReader(ServerInstance);
- }
+ CommandSwhois cmd;
- void Implements(char* List)
+ public:
+ ModuleSWhois() : cmd(this)
{
- List[I_OnDecodeMetaData] = List[I_OnWhoisLine] = List[I_OnSyncUserMetaData] = List[I_OnUserQuit] = List[I_OnCleanup] = List[I_OnRehash] = List[I_OnPostCommand] = 1;
+ ServerInstance->AddCommand(&cmd);
+ Implementation eventlist[] = { I_OnWhoisLine, I_OnPostCommand };
+ ServerInstance->Modules->Attach(eventlist, this, 2);
}
// :kenny.chatspike.net 320 Brain Azhrarn :is getting paid to play games.
- int OnWhoisLine(userrec* user, userrec* dest, int &numeric, std::string &text)
+ ModResult OnWhoisLine(User* user, User* dest, int &numeric, std::string &text)
{
/* We use this and not OnWhois because this triggers for remote, too */
if (numeric == 312)
{
/* Insert our numeric before 312 */
- std::string* swhois;
- dest->GetExt("swhois", swhois);
- if (swhois)
- {
- ServerInstance->SendWhoisLine(user, dest, 320, "%s %s :%s",user->nick,dest->nick,swhois->c_str());
- }
- }
- /* Dont block anything */
- return 0;
- }
-
- // Whenever the linking module wants to send out data, but doesnt know what the data
- // represents (e.g. it is metadata, added to a userrec or chanrec by a module) then
- // this method is called. We should use the ProtoSendMetaData function after we've
- // corrected decided how the data should look, to send the metadata on its way if
- // it is ours.
- virtual void OnSyncUserMetaData(userrec* user, Module* proto, void* opaque, const std::string &extname, bool displayable)
- {
- // check if the linking module wants to know about OUR metadata
- if (extname == "swhois")
- {
- // check if this user has an swhois field to send
- std::string* swhois;
- user->GetExt("swhois", swhois);
+ std::string* swhois = cmd.swhois.get(dest);
if (swhois)
{
- // call this function in the linking module, let it format the data how it
- // sees fit, and send it on its way. We dont need or want to know how.
- proto->ProtoSendMetaData(opaque,TYPE_USER,user,extname,*swhois);
+ ServerInstance->SendWhoisLine(user, dest, 320, "%s %s :%s",user->nick.c_str(), dest->nick.c_str(), swhois->c_str());
}
}
- }
-
- // when a user quits, tidy up their metadata
- virtual void OnUserQuit(userrec* user, const std::string &message, const std::string &oper_message)
- {
- std::string* swhois;
- user->GetExt("swhois", swhois);
- if (swhois)
- {
- user->Shrink("swhois");
- DELETE(swhois);
- }
- }
- // if the module is unloaded, tidy up all our dangling metadata
- virtual void OnCleanup(int target_type, void* item)
- {
- if (target_type == TYPE_USER)
- {
- userrec* user = (userrec*)item;
- std::string* swhois;
- user->GetExt("swhois", swhois);
- if (swhois)
- {
- user->Shrink("swhois");
- DELETE(swhois);
- }
- }
+ /* Dont block anything */
+ return MOD_RES_PASSTHRU;
}
- // Whenever the linking module receives metadata from another server and doesnt know what
- // to do with it (of course, hence the 'meta') it calls this method, and it is up to each
- // module in turn to figure out if this metadata key belongs to them, and what they want
- // to do with it.
- // In our case we're only sending a single string around, so we just construct a std::string.
- // Some modules will probably get much more complex and format more detailed structs and classes
- // in a textual way for sending over the link.
- virtual void OnDecodeMetaData(int target_type, void* target, const std::string &extname, const std::string &extdata)
- {
- // check if its our metadata key, and its associated with a user
- if ((target_type == TYPE_USER) && (extname == "swhois"))
- {
- userrec* dest = (userrec*)target;
- // if they dont already have an swhois field, accept the remote server's
- std::string* text;
- if (!dest->GetExt("swhois", text))
- {
- std::string* text = new std::string(extdata);
- dest->Extend("swhois",text);
- }
- }
- }
-
- virtual void OnPostCommand(const std::string &command, const char **params, int pcnt, userrec *user, CmdResult result, const std::string &original_line)
+ void OnPostCommand(const std::string &command, const std::vector<std::string> ¶ms, LocalUser *user, CmdResult result, const std::string &original_line)
{
if ((command != "OPER") || (result != CMD_SUCCESS))
return;
-
- std::string swhois;
-
- for (int i = 0; i < Conf->Enumerate("oper"); i++)
- {
- std::string name = Conf->ReadValue("oper", "name", i);
-
- if (name == params[0])
- {
- swhois = Conf->ReadValue("oper", "swhois", i);
- break;
- }
- }
-
- if (!swhois.length())
- {
- for (int i = 0; i < Conf->Enumerate("type"); i++)
- {
- std::string type = Conf->ReadValue("type", "name", i);
-
- if (type == user->oper)
- {
- swhois = Conf->ReadValue("type", "swhois", i);
- break;
- }
- }
- }
+ ConfigReader Conf;
+
+ std::string swhois = user->oper->getConfig("swhois");
- std::string *old;
- if (user->GetExt("swhois", old))
- {
- user->Shrink("swhois");
- DELETE(old);
- }
-
if (!swhois.length())
return;
-
- std::string *text = new std::string(swhois);
- user->Extend("swhois", text);
- std::deque<std::string>* metadata = new std::deque<std::string>;
- metadata->push_back(user->nick);
- metadata->push_back("swhois"); // The metadata id
- metadata->push_back(*text); // The value to send
- Event event((char*)metadata,(Module*)this,"send_metadata");
- event.Send(ServerInstance);
- delete metadata;
+
+ cmd.swhois.set(user, swhois);
+ ServerInstance->PI->SendMetaData(user, "swhois", swhois);
}
- virtual ~ModuleSWhois()
+ ~ModuleSWhois()
{
- DELETE(Conf);
}
-
- virtual Version GetVersion()
+
+ Version GetVersion()
{
- return Version(1,1,0,0,VF_VENDOR,API_VERSION);
+ return Version("Provides the SWHOIS command which allows setting of arbitary WHOIS lines", VF_OPTCOMMON | VF_VENDOR);
}
};