]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_swhois.cpp
Remove CMD_LOCALONLY, enforce use of GetRouting for routed commands
[user/henk/code/inspircd.git] / src / modules / m_swhois.cpp
index bdacb1f2e604bcc751b495ff34a6dfaf22332b28..ebff25cb838ace4ad742134d54e06c07d7b269da 100644 (file)
@@ -2,8 +2,8 @@
  *       | Inspire Internet Relay Chat Daemon |
  *       +------------------------------------+
  *
- *  InspIRCd: (C) 2002-2007 InspIRCd Development Team
- * See: http://www.inspircd.org/wiki/index.php/Credits
+ *  InspIRCd: (C) 2002-2009 InspIRCd Development Team
+ * See: http://wiki.inspircd.org/Credits
  *
  * This program is free but copyrighted software; see
  *            the file COPYING for details.
  * ---------------------------------------------------
  */
 
-#include "users.h"
-#include "channels.h"
-#include "modules.h"
 #include "inspircd.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)
+       CommandSwhois (InspIRCd* Instance, Module* Creator) : Command(Instance, Creator,"SWHOIS","o",2, 2)
        {
-               this->source = "m_swhois.so";
-               syntax = "<nick> <swhois>";
+               syntax = "<nick> :<swhois>";
+               TRANSLATE3(TR_NICK, TR_TEXT, TR_END);
        }
 
-       CmdResult Handle(const char** parameters, int pcnt, userrec* user)
+       CmdResult Handle(const std::vector<std::string> &parameters, User* user)
        {
-               userrec* dest = ServerInstance->FindNick(parameters[0]);
-               if(dest)
+               User* dest = ServerInstance->FindNick(parameters[0]);
+
+               if (!dest)
                {
-                       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);
-       
-                       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);
-                       }
-                       else if(!ServerInstance->ULine(user->server))
-                       {
+                       user->WriteNumeric(ERR_NOSUCHNICK, "%s %s :No such nick/channel", user->nick.c_str(), parameters[0].c_str());
+                       return CMD_FAILURE;
+               }
+
+               std::string* text;
+               if (dest->GetExt("swhois", 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 to '%s'", user->nick, dest->nick, line.c_str());
-                       }
-                       
-                       text = new std::string(line);
-                       dest->Extend("swhois", 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());
 
-                       return CMD_SUCCESS;
+                       dest->Shrink("swhois");
+                       delete text;
+               }
+               else if (!ServerInstance->ULine(user->server))
+               {
+                       // Ulines set SWHOISes silently
+                       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());
                }
 
-               return CMD_FAILURE;
+               text = new std::string(parameters[1]);
+               dest->Extend("swhois", text);
+
+               /* 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", *text);
+
+               // If it's an empty swhois, unset it (not ideal, but ok)
+               if (text->empty())
+               {
+                       dest->Shrink("swhois");
+                       delete text;
+               }
+
+               return CMD_SUCCESS;
        }
+
 };
 
 class ModuleSWhois : public Module
 {
-       cmd_swhois* mycommand;
-       
+       CommandSwhois cmd;
+
        ConfigReader* Conf;
-       
+
  public:
-       ModuleSWhois(InspIRCd* Me) : Module::Module(Me)
+       ModuleSWhois(InspIRCd* Me) : Module(Me), cmd(Me, this)
        {
-               
+
                Conf = new ConfigReader(ServerInstance);
-               mycommand = new cmd_swhois(ServerInstance);
-               ServerInstance->AddCommand(mycommand);
+               ServerInstance->AddCommand(&cmd);
+               Implementation eventlist[] = { I_OnDecodeMetaData, I_OnWhoisLine, I_OnSyncUser, I_OnUserQuit, I_OnCleanup, I_OnRehash, I_OnPostCommand };
+               ServerInstance->Modules->Attach(eventlist, this, 7);
        }
 
-       void OnRehash(const std::string &parameter)
+       void OnRehash(User* user)
        {
-               DELETE(Conf);
+               delete Conf;
                Conf = new ConfigReader(ServerInstance);
        }
 
-       void Implements(char* List)
-       {
-               List[I_OnWhois] = List[I_OnSyncUserMetaData] = List[I_OnUserQuit] = List[I_OnCleanup] = List[I_OnRehash] = List[I_OnPostCommand] = 1;
-       }
 
        // :kenny.chatspike.net 320 Brain Azhrarn :is getting paid to play games.
-       virtual void OnWhois(userrec* source, userrec* dest)
+       ModResult OnWhoisLine(User* user, User* dest, int &numeric, std::string &text)
        {
-               std::string* swhois;
-               dest->GetExt("swhois", swhois);
-               if (swhois)
+               /* We use this and not OnWhois because this triggers for remote, too */
+               if (numeric == 312)
                {
-                       ServerInstance->SendWhoisLine(source, dest, 320, "%s %s :%s",source->nick,dest->nick,swhois->c_str());
+                       /* Insert our numeric before 312 */
+                       std::string* swhois;
+                       if (dest->GetExt("swhois", swhois))
+                       {
+                               ServerInstance->SendWhoisLine(user, dest, 320, "%s %s :%s",user->nick.c_str(), dest->nick.c_str(), swhois->c_str());
+                       }
                }
+
+               /* Dont block anything */
+               return MOD_RES_PASSTHRU;
        }
 
        // 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
+       // represents (e.g. it is metadata, added to a User or Channel 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)
+       virtual void OnSyncUser(User* user, Module* proto, void* opaque)
        {
-               ServerInstance->Log(DEBUG,"Sync user metadata type '%s'", extname.c_str());
-               // 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);
-                       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);
-                       }
-                       else
-                       {
-                               ServerInstance->Log(DEBUG,"User has a null swhois string!");
-                       }
-               }
+               // check if this user has an swhois field to send
+               std::string* swhois;
+               if (user->GetExt("swhois", swhois))
+                       proto->ProtoSendMetaData(opaque,user,"swhois",*swhois);
        }
 
        // when a user quits, tidy up their metadata
-       virtual void OnUserQuit(userrec* user, const std::string &message)
+       virtual void OnUserQuit(User* user, const std::string &message, const std::string &oper_message)
        {
                std::string* swhois;
-               user->GetExt("swhois", swhois);
-               if (swhois)
+               if (user->GetExt("swhois", swhois))
                {
                        user->Shrink("swhois");
-                       DELETE(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)
+               if (target_type != TYPE_USER) return;
+               User* user = static_cast<User*>(item);
+               std::string* swhois;
+               if (user && user->GetExt("swhois", swhois))
                {
-                       userrec* user = (userrec*)item;
-                       std::string* swhois;
-                       user->GetExt("swhois", swhois);
-                       if (swhois)
-                       {
-                               user->Shrink("swhois");
-                               DELETE(swhois);
-                       }
+                       user->Shrink("swhois");
+                       delete swhois;
                }
        }
 
@@ -173,48 +162,52 @@ class ModuleSWhois : public Module
        // 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)
+       virtual void OnDecodeMetaData(Extensible* target, const std::string &extname, const std::string &extdata)
        {
+               User* dest = dynamic_cast<User*>(target);
                // check if its our metadata key, and its associated with a user
-               if ((target_type == TYPE_USER) && (extname == "swhois"))
+               if (extname != "swhois" || !dest)
+                       return;
+
+               // if they already have an swhois field, trash it and replace it with the remote one.
+               std::string* text;
+               if (dest->GetExt("swhois", text))
                {
-                       ServerInstance->Log(DEBUG,"Extend with 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);
-                               ServerInstance->Log(DEBUG,"extended: %s %s", dest->nick, dest->text.c_str());
-                       }
+                       dest->Shrink("swhois");
+                       delete text;
                }
+
+               if (extdata.empty())
+                       return;
+
+               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)
+
+       virtual void OnPostCommand(const std::string &command, const std::vector<std::string> &params, User *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);
@@ -227,49 +220,26 @@ class ModuleSWhois : public Module
                if (user->GetExt("swhois", old))
                {
                        user->Shrink("swhois");
-                       DELETE(old);
+                       delete old;
                }
-               
+
                if (!swhois.length())
                        return;
-               
+
                std::string *text = new std::string(swhois);
                user->Extend("swhois", text);
+               ServerInstance->PI->SendMetaData(user, "swhois", *text);
        }
-       
+
        virtual ~ModuleSWhois()
        {
-               DELETE(Conf);
+               delete Conf;
        }
-       
-       virtual Version GetVersion()
-       {
-               return Version(1,1,0,0,VF_VENDOR,API_VERSION);
-       }
-};
 
-
-class ModuleSWhoisFactory : public ModuleFactory
-{
- public:
-       ModuleSWhoisFactory()
-       {
-       }
-       
-       ~ModuleSWhoisFactory()
-       {
-       }
-       
-       virtual Module * CreateModule(InspIRCd* Me)
+       virtual Version GetVersion()
        {
-               return new ModuleSWhois(Me);
+               return Version("$Id$", VF_COMMON | VF_VENDOR, API_VERSION);
        }
-       
 };
 
-
-extern "C" void * init_module( void )
-{
-       return new ModuleSWhoisFactory;
-}
-
+MODULE_INIT(ModuleSWhois)