]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_helpop.cpp
Convert WriteNumeric() calls to pass the parameters of the numeric as method parameters
[user/henk/code/inspircd.git] / src / modules / m_helpop.cpp
index 8f19bd72b739bfbae57e3363b91de7d83e942d2c..f567aa0767d7440ea065fd064036a0ee8dfe70e0 100644 (file)
@@ -1,94 +1,80 @@
-/*       +------------------------------------+
- *       | Inspire Internet Relay Chat Daemon |
- *       +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
  *
- *  InspIRCd: (C) 2002-2009 InspIRCd Development Team
- * See: http://wiki.inspircd.org/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/>.
  */
 
-#include "inspircd.h"
 
-/* $ModDesc: /helpop Command, Works like Unreal helpop */
-static std::map<irc::string, std::string> helpop_map;
+#include "inspircd.h"
 
+typedef std::map<std::string, std::string, irc::insensitive_swo> HelpopMap;
+static HelpopMap helpop_map;
 
 /** Handles user mode +h
  */
-class Helpop : public ModeHandler
+class Helpop : public SimpleUserModeHandler
 {
  public:
-       Helpop(Module* Creator) : ModeHandler(Creator, "helpop", 'h', PARAM_NONE, MODETYPE_USER)
+       Helpop(Module* Creator) : SimpleUserModeHandler(Creator, "helpop", 'h')
        {
                oper = true;
        }
-
-       ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string &parameter, bool adding)
-       {
-               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;
-       }
 };
 
 /** Handles /HELPOP
  */
 class CommandHelpop : public Command
 {
+       const std::string startkey;
  public:
-       CommandHelpop(Module* Creator) : Command(Creator, "HELPOP", 0)
+       CommandHelpop(Module* Creator)
+               : Command(Creator, "HELPOP", 0)
+               , startkey("start")
        {
                syntax = "<any-text>";
        }
 
        CmdResult Handle (const std::vector<std::string> &parameters, User *user)
        {
-               irc::string parameter("start");
-               if (parameters.size() > 0)
-                       parameter = parameters[0].c_str();
+               const std::string& parameter = (!parameters.empty() ? parameters[0] : startkey);
 
                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("292 %s :  %s", user->nick.c_str(), iter->first.c_str());
-                       }
-                       user->WriteServ("292 %s :*** End of HELPOP topic index", user->nick.c_str());
+                       user->WriteNumeric(290, "HELPOP topic index");
+                       for (HelpopMap::const_iterator iter = helpop_map.begin(); iter != helpop_map.end(); iter++)
+                               user->WriteNumeric(292, InspIRCd::Format("  %s", iter->first.c_str()));
+                       user->WriteNumeric(292, "*** End of HELPOP topic index");
                }
                else
                {
-                       user->WriteServ("290 %s :*** HELPOP for %s", user->nick.c_str(), parameter.c_str());
-                       user->WriteServ("292 %s : -", user->nick.c_str());
+                       user->WriteNumeric(290, InspIRCd::Format("*** HELPOP for %s", parameter.c_str()));
+                       user->WriteNumeric(292, " -");
 
-                       std::map<irc::string, std::string>::iterator iter = helpop_map.find(parameter);
+                       HelpopMap::const_iterator iter = helpop_map.find(parameter);
 
                        if (iter == helpop_map.end())
                        {
                                iter = helpop_map.find("nohelp");
                        }
 
-                       std::string value = iter->second;
+                       const std::string& value = iter->second;
                        irc::sepstream stream(value, '\n');
                        std::string token = "*";
 
@@ -96,49 +82,40 @@ class CommandHelpop : public Command
                        {
                                // Writing a blank line will not work with some clients
                                if (token.empty())
-                                       user->WriteServ("292 %s : ", user->nick.c_str());
+                                       user->WriteNumeric(292, ' ');
                                else
-                                       user->WriteServ("292 %s :%s", user->nick.c_str(), token.c_str());
+                                       user->WriteNumeric(292, token);
                        }
 
-                       user->WriteServ("292 %s : -", user->nick.c_str());
-                       user->WriteServ("292 %s :*** End of HELPOP", user->nick.c_str());
+                       user->WriteNumeric(292, " -");
+                       user->WriteNumeric(292, "*** End of HELPOP");
                }
                return CMD_SUCCESS;
        }
 };
 
-class ModuleHelpop : public Module
+class ModuleHelpop : public Module, public Whois::EventListener
 {
-       private:
-               std::string  h_file;
                CommandHelpop cmd;
                Helpop ho;
 
        public:
                ModuleHelpop()
-                       : cmd(this), ho(this)
+                       : Whois::EventListener(this)
+                       , cmd(this)
+                       , ho(this)
                {
-                       ReadConfig();
-                       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()
+               void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
                {
-                       ConfigReader MyConf;
-
-                       helpop_map.clear();
+                       HelpopMap help;
 
-                       for (int i = 0;; i++)
+                       ConfigTagList tags = ServerInstance->Config->ConfTags("helpop");
+                       for(ConfigIter i = tags.first; i != tags.second; ++i)
                        {
-                               ConfigTag* tag = ServerInstance->Config->ConfValue("helpop", i);
-                               if (!tag)
-                                       break;
-                               irc::string key = assign(tag->getString("key"));
+                               ConfigTag* tag = i->second;
+                               std::string key = tag->getString("key");
                                std::string value;
                                tag->readString("value", value, true); /* Linefeeds allowed */
 
@@ -147,43 +124,34 @@ class ModuleHelpop : public Module
                                        throw ModuleException("m_helpop: The key 'index' is reserved for internal purposes. Please remove it.");
                                }
 
-                               helpop_map[key] = value;
+                               help[key] = value;
                        }
 
-                       if (helpop_map.find("start") == helpop_map.end())
+                       if (help.find("start") == help.end())
                        {
                                // error!
                                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())
+                       else if (help.find("nohelp") == help.end())
                        {
                                // error!
                                throw ModuleException("m_helpop: Helpop file is missing important entry 'nohelp'. Please check the example conf.");
                        }
 
+                       helpop_map.swap(help);
                }
 
-
-               virtual void OnRehash(User* user)
+               void OnWhois(Whois::Context& whois) CXX11_OVERRIDE
                {
-                       ReadConfig();
-               }
-
-               virtual void OnWhois(User* src, User* dst)
-               {
-                       if (dst->IsModeSet('h'))
+                       if (whois.GetTarget()->IsModeSet(ho))
                        {
-                               ServerInstance->SendWhoisLine(src, dst, 310, std::string(src->nick)+" "+std::string(dst->nick)+" :is available for help.");
+                               whois.SendLine(310, ":is available for help.");
                        }
                }
 
-               virtual ~ModuleHelpop()
-               {
-               }
-
-               virtual Version GetVersion()
+               Version GetVersion() CXX11_OVERRIDE
                {
-                       return Version("/helpop Command, Works like Unreal helpop", VF_VENDOR | VF_COMMON);
+                       return Version("Provides the /HELPOP command for useful information", VF_VENDOR);
                }
 };