]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_helpop.cpp
Merge pull request #249 from Shawn-Smith/insp20+simplemode
[user/henk/code/inspircd.git] / src / modules / m_helpop.cpp
index a5430d7da77cbd064aa5e02f6bf031d29fb8dab5..60c23f45bd44820c39b5e01496a804551c535a1c 100644 (file)
@@ -1,49 +1,40 @@
-/*       +------------------------------------+
- *       | Inspire Internet Relay Chat Daemon |
- *       +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
  *
- *  InspIRCd: (C) 2002-2007 InspIRCd Development Team
- * See: http://www.inspircd.org/wiki/index.php/Credits
+ *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
+ *   Copyright (C) 2005-2009 Robin Burchell <robin+git@viroteck.net>
+ *   Copyright (C) 2004-2006, 2008 Craig Edwards <craigedwards@brainbox.cc>
+ *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
+ *   Copyright (C) 2004-2005 Craig McLure <craig@chatspike.net>
  *
- * This program is free but copyrighted software; see
- *            the file COPYING for details.
+ * This file is part of InspIRCd.  InspIRCd is free software: you can
+ * redistribute it and/or modify it under the terms of the GNU General Public
+ * License as published by the Free Software Foundation, version 2.
  *
- * ---------------------------------------------------
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+
+/* $ModDesc: Provides the /HELPOP command for useful information */
+
 #include "inspircd.h"
 
-/* $ModDesc: /helpop Command, Works like Unreal helpop */
 static std::map<irc::string, std::string> helpop_map;
 
-
 /** Handles user mode +h
  */
-class Helpop : public ModeHandler
+class Helpop : public SimpleUserModeHandler
 {
  public:
-       Helpop(InspIRCd* Instance) : ModeHandler(Instance, 'h', 0, 0, false, MODETYPE_USER, true) { }
-
-       ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string &parameter, bool adding)
+       Helpop(Module* Creator) : SimpleUserModeHandler(Creator, "helpop", 'h')
        {
-               if (adding)
-               {
-                       if (!dest->IsModeSet('h'))
-                       {
-                               dest->SetMode('h',true);
-                               return MODEACTION_ALLOW;
-                       }
-               }
-               else
-               {
-                       if (dest->IsModeSet('h'))
-                       {
-                               dest->SetMode('h',false);
-                               return MODEACTION_ALLOW;
-                       }
-               }
-
-               return MODEACTION_DENY;
+               oper = true;
        }
 };
 
@@ -52,31 +43,31 @@ class Helpop : public ModeHandler
 class CommandHelpop : public Command
 {
  public:
-       CommandHelpop (InspIRCd* Instance) : Command(Instance, "HELPOP", 0, 0)
+       CommandHelpop(Module* Creator) : Command(Creator, "HELPOP", 0)
        {
-               this->source = "m_helpop.so";
                syntax = "<any-text>";
        }
 
-       CmdResult Handle (const char** parameters, int pcnt, User *user)
+       CmdResult Handle (const std::vector<std::string> &parameters, User *user)
        {
                irc::string parameter("start");
-               if (pcnt > 0)
-                       parameter = parameters[0];
+               if (parameters.size() > 0)
+                       parameter = parameters[0].c_str();
 
                if (parameter == "index")
                {
                        /* iterate over all helpop items */
-                       user->WriteServ("NOTICE %s :HELPOP topic index", user->nick);
+                       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 :    %s", user->nick, iter->first.c_str());                          
+                               user->WriteServ("292 %s :  %s", user->nick.c_str(), iter->first.c_str());
                        }
-                       user->WriteServ("NOTICE %s :*** End of HELPOP topic index", user->nick);
+                       user->WriteServ("292 %s :*** End of HELPOP topic index", user->nick.c_str());
                }
                else
                {
-                       user->WriteServ("NOTICE %s :*** HELPOP for %s", user->nick, parameter.c_str());
+                       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);
 
@@ -90,15 +81,18 @@ class CommandHelpop : public Command
                        std::string token = "*";
 
                        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("NOTICE %s :*** End of HELPOP", user->nick);
+                       user->WriteServ("292 %s : -", user->nick.c_str());
+                       user->WriteServ("292 %s :*** End of HELPOP", user->nick.c_str());
                }
-
-               /* 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;
+               return CMD_SUCCESS;
        }
 };
 
@@ -106,31 +100,35 @@ class ModuleHelpop : public Module
 {
        private:
                std::string  h_file;
-               CommandHelpop* mycommand;
-               Helpop* ho;
+               CommandHelpop cmd;
+               Helpop ho;
 
        public:
-               ModuleHelpop(InspIRCd* Me)
-                       : Module(Me)
+               ModuleHelpop()
+                       : cmd(this), ho(this)
                {
-                       ReadConfig();
-                       ho = new Helpop(ServerInstance);
-                       if (!ServerInstance->AddMode(ho))
-                               throw ModuleException("Could not add new modes!");
-                       mycommand = new CommandHelpop(ServerInstance);
-                       ServerInstance->AddCommand(mycommand);
                }
 
-               virtual void ReadConfig()
+               void init()
                {
-                       ConfigReader *MyConf = new ConfigReader(ServerInstance);
+                       ReadConfig();
+                       ServerInstance->Modules->AddService(ho);
+                       ServerInstance->Modules->AddService(cmd);
+                       Implementation eventlist[] = { I_OnRehash, I_OnWhois };
+                       ServerInstance->Modules->Attach(eventlist, this, 2);
+               }
 
+               void ReadConfig()
+               {
                        helpop_map.clear();
 
-                       for (int i = 0; i < MyConf->Enumerate("helpop"); i++)
+                       ConfigTagList tags = ServerInstance->Config->ConfTags("helpop");
+                       for(ConfigIter i = tags.first; i != tags.second; ++i)
                        {
-                               irc::string key = assign(MyConf->ReadValue("helpop", "key", i));
-                               std::string value = MyConf->ReadValue("helpop", "value", i, true); /* Linefeeds allowed! */
+                               ConfigTag* tag = i->second;
+                               irc::string key = assign(tag->getString("key"));
+                               std::string value;
+                               tag->readString("value", value, true); /* Linefeeds allowed */
 
                                if (key == "index")
                                {
@@ -143,27 +141,22 @@ class ModuleHelpop : public Module
                        if (helpop_map.find("start") == helpop_map.end())
                        {
                                // error!
-                               throw ModuleException("m_helpop: Helpop file is missing important entries. Please check the example conf.");
+                               throw ModuleException("m_helpop: Helpop file is missing important entry 'start'. Please check the example conf.");
                        }
                        else if (helpop_map.find("nohelp") == helpop_map.end())
                        {
                                // error!
-                               throw ModuleException("m_helpop: Helpop file is missing important entries. Please check the example conf.");
+                               throw ModuleException("m_helpop: Helpop file is missing important entry 'nohelp'. Please check the example conf.");
                        }
 
                }
 
-               void Implements(char* List)
-               {
-                       List[I_OnRehash] = List[I_OnWhois] = 1;
-               }
-
-               virtual void OnRehash(User* user, const std::string &parameter)
+               void OnRehash(User* user)
                {
                        ReadConfig();
                }
 
-               virtual void OnWhois(User* src, User* dst)
+               void OnWhois(User* src, User* dst)
                {
                        if (dst->IsModeSet('h'))
                        {
@@ -171,15 +164,9 @@ class ModuleHelpop : public Module
                        }
                }
 
-               virtual ~ModuleHelpop()
-               {
-                       ServerInstance->Modes->DelMode(ho);
-                       DELETE(ho);
-               }
-       
-               virtual Version GetVersion()
+               Version GetVersion()
                {
-                       return Version(1,1,0,1,VF_COMMON|VF_VENDOR,API_VERSION);
+                       return Version("Provides the /HELPOP command for useful information", VF_VENDOR);
                }
 };