]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_helpop.cpp
Include explicit routing information in Command, will replace CMD_LOCALONLY return...
[user/henk/code/inspircd.git] / src / modules / m_helpop.cpp
index cc78c3257bd5d622e391c52b02a208576662fb67..4800ebac8328bc327e349bcf673f8a408114471e 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.
@@ -11,9 +11,6 @@
  * ---------------------------------------------------
  */
 
-#include "users.h"
-#include "channels.h"
-#include "modules.h"
 #include "inspircd.h"
 
 /* $ModDesc: /helpop Command, Works like Unreal helpop */
@@ -27,7 +24,7 @@ class Helpop : public ModeHandler
  public:
        Helpop(InspIRCd* Instance) : ModeHandler(Instance, 'h', 0, 0, false, MODETYPE_USER, true) { }
 
-       ModeAction OnModeChange(userrec* source, userrec* dest, chanrec* channel, std::string &parameter, bool adding)
+       ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string &parameter, bool adding, bool)
        {
                if (adding)
                {
@@ -52,31 +49,36 @@ class Helpop : public ModeHandler
 
 /** Handles /HELPOP
  */
-class cmd_helpop : public command_t
+class CommandHelpop : public Command
 {
  public:
-        cmd_helpop (InspIRCd* Instance) : command_t(Instance, "HELPOP", 0, 1)
-        {
-                this->source = "m_helpop.so";
-                syntax = "<any-text>";
-        }
-
-       CmdResult Handle (const char** parameters, int pcnt, userrec *user)
-       {               
-               irc::string parameter = parameters[0];
+       CommandHelpop (InspIRCd* Instance) : Command(Instance, "HELPOP", 0, 0)
+       {
+               this->source = "m_helpop.so";
+               syntax = "<any-text>";
+       }
 
-               user->WriteServ("NOTICE %s :*** HELPOP for %s", user->nick, parameters[0]);
+       CmdResult Handle (const std::vector<std::string> &parameters, User *user)
+       {
+               irc::string parameter("start");
+               if (parameters.size() > 0)
+                       parameter = parameters[0].c_str();
 
                if (parameter == "index")
                {
                        /* iterate over all helpop items */
+                       user->WriteServ("290 %s :HELPOP topic index", user->nick.c_str());
                        for (std::map<irc::string, std::string>::iterator iter = helpop_map.begin(); iter != helpop_map.end(); iter++)
                        {
-                               user->WriteServ("NOTICE %s :HELPOP KEY: %s", user->nick, iter->first.c_str());                          
+                               user->WriteServ("292 %s :  %s", user->nick.c_str(), iter->first.c_str());
                        }
+                       user->WriteServ("292 %s :*** End of HELPOP topic index", user->nick.c_str());
                }
                else
                {
+                       user->WriteServ("290 %s :*** HELPOP for %s", user->nick.c_str(), parameter.c_str());
+                       user->WriteServ("292 %s : -", user->nick.c_str());
+
                        std::map<irc::string, std::string>::iterator iter = helpop_map.find(parameter);
 
                        if (iter == helpop_map.end())
@@ -88,62 +90,59 @@ class cmd_helpop : public command_t
                        irc::sepstream stream(value, '\n');
                        std::string token = "*";
 
-                       while ((token = stream.GetToken()) != "")
+                       while (stream.GetToken(token))
                        {
-                               user->WriteServ("NOTICE %s :%s", user->nick, token.c_str());
+                               // Writing a blank line will not work with some clients
+                               if (token.empty())
+                                       user->WriteServ("292 %s : ", user->nick.c_str());
+                               else
+                                       user->WriteServ("292 %s :%s", user->nick.c_str(), token.c_str());
                        }
+
+                       user->WriteServ("292 %s : -", user->nick.c_str());
+                       user->WriteServ("292 %s :*** End of HELPOP", user->nick.c_str());
                }
 
-               user->WriteServ("NOTICE %s :*** HELPOP End", user->nick);
-               return CMD_SUCCESS;
+               /* We dont want these going out over the network, return CMD_FAILURE
+                * to make sure the protocol module thinks theyre not worth sending.
+                */
+               return CMD_FAILURE;
        }
 };
 
-/** Thrown by m_helpop
- */
-class HelpopException : public ModuleException
-{
- private:
-       std::string err;
- public:
-       HelpopException(std::string message) : err(message) { }
-       ~HelpopException() throw() { };
-       virtual const char* GetReason() { return err.c_str(); }
-};
-
 class ModuleHelpop : public Module
 {
        private:
                std::string  h_file;
-               cmd_helpop* mycommand;
-               Helpop* ho;
+               CommandHelpop cmd;
+               Helpop ho;
 
        public:
                ModuleHelpop(InspIRCd* Me)
-                       : Module::Module(Me)
+                       : Module(Me), cmd(Me), ho(Me)
                {
                        ReadConfig();
-                       ho = new Helpop(ServerInstance);
-                       ServerInstance->AddMode(ho, 'h');
-                       mycommand = new cmd_helpop(ServerInstance);
-                       ServerInstance->AddCommand(mycommand);
+                       if (!ServerInstance->Modes->AddMode(&ho))
+                               throw ModuleException("Could not add new modes!");
+                       ServerInstance->AddCommand(&cmd);
+                       Implementation eventlist[] = { I_OnRehash, I_OnWhois };
+                       ServerInstance->Modules->Attach(eventlist, this, 2);
                }
 
                virtual void ReadConfig()
                {
-                       ConfigReader *MyConf = new ConfigReader(ServerInstance);
+                       ConfigReader MyConf(ServerInstance);
 
                        helpop_map.clear();
 
-                       for (int i = 0; i < MyConf->Enumerate("helpop"); i++)
+                       for (int i = 0; i < MyConf.Enumerate("helpop"); i++)
                        {
-                               irc::string key = assign(MyConf->ReadValue("helpop", "key", i));
-                               std::string value = MyConf->ReadValue("helpop", "value", i);
+                               irc::string key = assign(MyConf.ReadValue("helpop", "key", i));
+                               std::string value = MyConf.ReadValue("helpop", "value", i, true); /* Linefeeds allowed! */
 
                                if (key == "index")
                                {
-                                       HelpopException e("m_helpop: The key 'index' is reserved for internal purposes. Please remove it.");
-                                       throw(e);
+                                       throw ModuleException("m_helpop: The key 'index' is reserved for internal purposes. Please remove it.");
                                }
 
                                helpop_map[key] = value;
@@ -152,29 +151,23 @@ class ModuleHelpop : public Module
                        if (helpop_map.find("start") == helpop_map.end())
                        {
                                // error!
-                               HelpopException e("m_helpop: Helpop file is missing important entries. Please check the example conf.");
-                               throw(e);
+                               throw ModuleException("m_helpop: Helpop file is missing important entries. Please check the example conf.");
                        }
                        else if (helpop_map.find("nohelp") == helpop_map.end())
                        {
                                // error!
-                               HelpopException e("m_helpop: Helpop file is missing important entries. Please check the example conf.");
-                               throw(e);
+                               throw ModuleException("m_helpop: Helpop file is missing important entries. Please check the example conf.");
                        }
 
                }
 
-               void Implements(char* List)
-               {
-                       List[I_OnRehash] = List[I_OnWhois] = 1;
-               }
 
-               virtual void OnRehash(const std::string &parameter)
+               virtual void OnRehash(User* user)
                {
                        ReadConfig();
                }
 
-               virtual void OnWhois(userrec* src, userrec* dst)
+               virtual void OnWhois(User* src, User* dst)
                {
                        if (dst->IsModeSet('h'))
                        {
@@ -184,35 +177,13 @@ class ModuleHelpop : public Module
 
                virtual ~ModuleHelpop()
                {
-                       ServerInstance->Modes->DelMode(ho);
-                       DELETE(ho);
+                       ServerInstance->Modes->DelMode(&ho);
                }
-       
+
                virtual Version GetVersion()
                {
-                       return Version(1,1,0,1,VF_COMMON|VF_VENDOR,API_VERSION);
+                       return Version("$Id$", VF_COMMON | VF_VENDOR, API_VERSION);
                }
 };
 
-class ModuleHelpopFactory : public ModuleFactory
-{
- public:
-       ModuleHelpopFactory()
-       {
-       }
-       
-       ~ModuleHelpopFactory()
-       {
-       }
-       
-       virtual Module * CreateModule(InspIRCd* Me)
-       {
-               return new ModuleHelpop(Me);
-       }
-       
-};
-
-extern "C" void * init_module( void )
-{
-       return new ModuleHelpopFactory;
-}
+MODULE_INIT(ModuleHelpop)