]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_helpop.cpp
Move OnWhois* events to core_whois, add Whois::Context
[user/henk/code/inspircd.git] / src / modules / m_helpop.cpp
index 965194a0892e0a16336b0fac2c0cac987a57e92f..ef9ae5e22e8e7d8ffcccaa8396f9c04bd6723e54 100644 (file)
@@ -1 +1,158 @@
-/*       +------------------------------------+\r *       | Inspire Internet Relay Chat Daemon |\r *       +------------------------------------+\r *\r *  InspIRCd: (C) 2002-2007 InspIRCd Development Team\r * See: http://www.inspircd.org/wiki/index.php/Credits\r *\r * This program is free but copyrighted software; see\r *            the file COPYING for details.\r *\r * ---------------------------------------------------\r */\r\r#include "inspircd.h"\r#include "users.h"\r#include "channels.h"\r#include "modules.h"\r\r/* $ModDesc: /helpop Command, Works like Unreal helpop */\rstatic std::map<irc::string, std::string> helpop_map;\r\r\r/** Handles user mode +h\r */\rclass Helpop : public ModeHandler\r{\r public:\r  Helpop(InspIRCd* Instance) : ModeHandler(Instance, 'h', 0, 0, false, MODETYPE_USER, true) { }\r\r ModeAction OnModeChange(userrec* source, userrec* dest, chanrec* channel, std::string &parameter, bool adding)\r {\r              if (adding)\r            {\r                      if (!dest->IsModeSet('h'))\r                     {\r                              dest->SetMode('h',true);\r                               return MODEACTION_ALLOW;\r                       }\r              }\r              else\r           {\r                      if (dest->IsModeSet('h'))\r                      {\r                              dest->SetMode('h',false);\r                              return MODEACTION_ALLOW;\r                       }\r              }\r\r             return MODEACTION_DENY;\r        }\r};\r\r/** Handles /HELPOP\r */\rclass cmd_helpop : public command_t\r{\r public:\r   cmd_helpop (InspIRCd* Instance) : command_t(Instance, "HELPOP", 0, 0)\r  {\r              this->source = "m_helpop.so";\r          syntax = "<any-text>";\r }\r\r     CmdResult Handle (const char** parameters, int pcnt, userrec *user)\r    {\r              irc::string parameter;\r         if (pcnt > 0)\r                  parameter = parameters[0];\r\r            if (pcnt == 0 || parameter == "index")\r         {\r                      /* iterate over all helpop items */\r                    user->WriteServ("NOTICE %s :HELPOP topic index", user->nick);\r                  for (std::map<irc::string, std::string>::iterator iter = helpop_map.begin(); iter != helpop_map.end(); iter++)\r                 {\r                              user->WriteServ("NOTICE %s :    %s", user->nick, iter->first.c_str());                          \r                       }\r                      user->WriteServ("NOTICE %s :*** End of HELPOP topic index", user->nick);\r               }\r              else\r           {\r                      user->WriteServ("NOTICE %s :*** HELPOP for %s", user->nick, parameters[0]);\r\r                   std::map<irc::string, std::string>::iterator iter = helpop_map.find(parameter);\r\r                       if (iter == helpop_map.end())\r                  {\r                              iter = helpop_map.find("nohelp");\r                      }\r\r                     std::string value = iter->second;\r                      irc::sepstream stream(value, '\n');\r                    std::string token = "*";\r\r                      while ((token = stream.GetToken()) != "")\r                      {\r                              user->WriteServ("NOTICE %s :%s", user->nick, token.c_str());\r                   }\r\r                     user->WriteServ("NOTICE %s :*** End of HELPOP", user->nick);\r           }\r\r             /* We dont want these going out over the network, return CMD_FAILURE\r            * to make sure the protocol module thinks theyre not worth sending.\r            */\r            return CMD_FAILURE;\r    }\r};\r\rclass ModuleHelpop : public Module\r{\r     private:\r               std::string  h_file;\r           cmd_helpop* mycommand;\r         Helpop* ho;\r\r   public:\r                ModuleHelpop(InspIRCd* Me)\r                     : Module(Me)\r           {\r                      ReadConfig();\r                  ho = new Helpop(ServerInstance);\r                       if (!ServerInstance->AddMode(ho, 'h'))\r                         throw ModuleException("Could not add new modes!");\r                     mycommand = new cmd_helpop(ServerInstance);\r                    ServerInstance->AddCommand(mycommand);\r         }\r\r             virtual void ReadConfig()\r              {\r                      ConfigReader *MyConf = new ConfigReader(ServerInstance);\r\r                      helpop_map.clear();\r\r                   for (int i = 0; i < MyConf->Enumerate("helpop"); i++)\r                  {\r                              irc::string key = assign(MyConf->ReadValue("helpop", "key", i));\r                               std::string value = MyConf->ReadValue("helpop", "value", i, true); /* Linefeeds allowed! */\r\r                           if (key == "index")\r                            {\r                                      throw ModuleException("m_helpop: The key 'index' is reserved for internal purposes. Please remove it.");\r                               }\r\r                             helpop_map[key] = value;\r                       }\r\r                     if (helpop_map.find("start") == helpop_map.end())\r                      {\r                              // error!\r                              throw ModuleException("m_helpop: Helpop file is missing important entries. Please check the example conf.");\r                   }\r                      else if (helpop_map.find("nohelp") == helpop_map.end())\r                        {\r                              // error!\r                              throw ModuleException("m_helpop: Helpop file is missing important entries. Please check the example conf.");\r                   }\r\r             }\r\r             void Implements(char* List)\r            {\r                      List[I_OnRehash] = List[I_OnWhois] = 1;\r                }\r\r             virtual void OnRehash(userrec* user, const std::string &parameter)\r             {\r                      ReadConfig();\r          }\r\r             virtual void OnWhois(userrec* src, userrec* dst)\r               {\r                      if (dst->IsModeSet('h'))\r                       {\r                              ServerInstance->SendWhoisLine(src, dst, 310, std::string(src->nick)+" "+std::string(dst->nick)+" :is available for help.");\r                    }\r              }\r\r             virtual ~ModuleHelpop()\r                {\r                      ServerInstance->Modes->DelMode(ho);\r                    DELETE(ho);\r            }\r      \r               virtual Version GetVersion()\r           {\r                      return Version(1,1,0,1,VF_COMMON|VF_VENDOR,API_VERSION);\r               }\r};\r\rMODULE_INIT(ModuleHelpop)\r
\ No newline at end of file
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
+ *
+ *   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 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"
+
+typedef std::map<std::string, std::string, irc::insensitive_swo> HelpopMap;
+static HelpopMap helpop_map;
+
+/** Handles user mode +h
+ */
+class Helpop : public SimpleUserModeHandler
+{
+ public:
+       Helpop(Module* Creator) : SimpleUserModeHandler(Creator, "helpop", 'h')
+       {
+               oper = true;
+       }
+};
+
+/** Handles /HELPOP
+ */
+class CommandHelpop : public Command
+{
+       const std::string startkey;
+ public:
+       CommandHelpop(Module* Creator)
+               : Command(Creator, "HELPOP", 0)
+               , startkey("start")
+       {
+               syntax = "<any-text>";
+       }
+
+       CmdResult Handle (const std::vector<std::string> &parameters, User *user)
+       {
+               const std::string& parameter = (!parameters.empty() ? parameters[0] : startkey);
+
+               if (parameter == "index")
+               {
+                       /* iterate over all helpop items */
+                       user->WriteNumeric(290, ":HELPOP topic index");
+                       for (HelpopMap::const_iterator iter = helpop_map.begin(); iter != helpop_map.end(); iter++)
+                               user->WriteNumeric(292, ":  %s", iter->first.c_str());
+                       user->WriteNumeric(292, ":*** End of HELPOP topic index");
+               }
+               else
+               {
+                       user->WriteNumeric(290, ":*** HELPOP for %s", parameter.c_str());
+                       user->WriteNumeric(292, ": -");
+
+                       HelpopMap::const_iterator iter = helpop_map.find(parameter);
+
+                       if (iter == helpop_map.end())
+                       {
+                               iter = helpop_map.find("nohelp");
+                       }
+
+                       const std::string& value = iter->second;
+                       irc::sepstream stream(value, '\n');
+                       std::string token = "*";
+
+                       while (stream.GetToken(token))
+                       {
+                               // Writing a blank line will not work with some clients
+                               if (token.empty())
+                                       user->WriteNumeric(292, ": ");
+                               else
+                                       user->WriteNumeric(292, ":%s", token.c_str());
+                       }
+
+                       user->WriteNumeric(292, ": -");
+                       user->WriteNumeric(292, ":*** End of HELPOP");
+               }
+               return CMD_SUCCESS;
+       }
+};
+
+class ModuleHelpop : public Module, public Whois::EventListener
+{
+               CommandHelpop cmd;
+               Helpop ho;
+
+       public:
+               ModuleHelpop()
+                       : Whois::EventListener(this)
+                       , cmd(this)
+                       , ho(this)
+               {
+               }
+
+               void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
+               {
+                       HelpopMap help;
+
+                       ConfigTagList tags = ServerInstance->Config->ConfTags("helpop");
+                       for(ConfigIter i = tags.first; i != tags.second; ++i)
+                       {
+                               ConfigTag* tag = i->second;
+                               std::string key = tag->getString("key");
+                               std::string value;
+                               tag->readString("value", value, true); /* Linefeeds allowed */
+
+                               if (key == "index")
+                               {
+                                       throw ModuleException("m_helpop: The key 'index' is reserved for internal purposes. Please remove it.");
+                               }
+
+                               help[key] = value;
+                       }
+
+                       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 (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);
+               }
+
+               void OnWhois(Whois::Context& whois) CXX11_OVERRIDE
+               {
+                       if (whois.GetTarget()->IsModeSet(ho))
+                       {
+                               whois.SendLine(310, ":is available for help.");
+                       }
+               }
+
+               Version GetVersion() CXX11_OVERRIDE
+               {
+                       return Version("Provides the /HELPOP command for useful information", VF_VENDOR);
+               }
+};
+
+MODULE_INIT(ModuleHelpop)