summaryrefslogtreecommitdiff
path: root/src/modules/m_helpop.cpp
diff options
context:
space:
mode:
Diffstat (limited to 'src/modules/m_helpop.cpp')
-rw-r--r--src/modules/m_helpop.cpp108
1 files changed, 52 insertions, 56 deletions
diff --git a/src/modules/m_helpop.cpp b/src/modules/m_helpop.cpp
index 4bbe8785e..5aa719c2f 100644
--- a/src/modules/m_helpop.cpp
+++ b/src/modules/m_helpop.cpp
@@ -21,11 +21,23 @@
*/
-/* $ModDesc: Provides the /HELPOP command for useful information */
-
#include "inspircd.h"
+#include "modules/whois.h"
-static std::map<irc::string, std::string> helpop_map;
+enum
+{
+ // From UnrealIRCd.
+ RPL_WHOISHELPOP = 310,
+
+ // From ircd-ratbox.
+ ERR_HELPNOTFOUND = 524,
+ RPL_HELPSTART = 704,
+ RPL_HELPTXT = 705,
+ RPL_ENDOFHELP = 706
+};
+
+typedef std::map<std::string, std::string, irc::insensitive_swo> HelpopMap;
+static HelpopMap helpop_map;
/** Handles user mode +h
*/
@@ -42,90 +54,81 @@ class Helpop : public SimpleUserModeHandler
*/
class CommandHelpop : public Command
{
+ private:
+ const std::string startkey;
+
public:
- CommandHelpop(Module* Creator) : Command(Creator, "HELPOP", 0)
+ std::string nohelp;
+
+ CommandHelpop(Module* Creator)
+ : Command(Creator, "HELPOP", 0)
+ , startkey("start")
{
syntax = "<any-text>";
}
- CmdResult Handle (const std::vector<std::string> &parameters, User *user)
+ CmdResult Handle(User* user, const Params& parameters) CXX11_OVERRIDE
{
- 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(RPL_HELPSTART, parameter, "HELPOP topic index");
+ for (HelpopMap::const_iterator iter = helpop_map.begin(); iter != helpop_map.end(); iter++)
+ user->WriteNumeric(RPL_HELPTXT, parameter, InspIRCd::Format(" %s", iter->first.c_str()));
+ user->WriteNumeric(RPL_ENDOFHELP, parameter, "*** 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());
-
- 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");
+ user->WriteNumeric(ERR_HELPNOTFOUND, parameter, nohelp);
+ return CMD_FAILURE;
}
- std::string value = iter->second;
- irc::sepstream stream(value, '\n');
+ const std::string& value = iter->second;
+ irc::sepstream stream(value, '\n', true);
std::string token = "*";
+ user->WriteNumeric(RPL_HELPSTART, parameter, InspIRCd::Format("*** HELPOP for %s", parameter.c_str()));
while (stream.GetToken(token))
{
// Writing a blank line will not work with some clients
if (token.empty())
- user->WriteServ("292 %s : ", user->nick.c_str());
+ user->WriteNumeric(RPL_HELPTXT, parameter, ' ');
else
- user->WriteServ("292 %s :%s", user->nick.c_str(), token.c_str());
+ user->WriteNumeric(RPL_HELPTXT, parameter, token);
}
-
- user->WriteServ("292 %s : -", user->nick.c_str());
- user->WriteServ("292 %s :*** End of HELPOP", user->nick.c_str());
+ user->WriteNumeric(RPL_ENDOFHELP, parameter, "*** End of HELPOP");
}
return CMD_SUCCESS;
}
};
-class ModuleHelpop : public Module
+class ModuleHelpop : public Module, public Whois::EventListener
{
- private:
CommandHelpop cmd;
Helpop ho;
public:
ModuleHelpop()
- : cmd(this), ho(this)
+ : Whois::EventListener(this)
+ , cmd(this)
+ , ho(this)
{
}
- void init()
+ void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
{
- ReadConfig();
- ServerInstance->Modules->AddService(ho);
- ServerInstance->Modules->AddService(cmd);
- Implementation eventlist[] = { I_OnRehash, I_OnWhois };
- ServerInstance->Modules->Attach(eventlist, this, sizeof(eventlist)/sizeof(Implementation));
- }
-
- void ReadConfig()
- {
- std::map<irc::string, std::string> help;
+ HelpopMap help;
ConfigTagList tags = ServerInstance->Config->ConfTags("helpop");
for(ConfigIter i = tags.first; i != tags.second; ++i)
{
ConfigTag* tag = i->second;
- irc::string key = assign(tag->getString("key"));
+ std::string key = tag->getString("key");
std::string value;
tag->readString("value", value, true); /* Linefeeds allowed */
@@ -142,31 +145,24 @@ class ModuleHelpop : public Module
// 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 OnRehash(User* user)
- {
- ReadConfig();
+ ConfigTag* tag = ServerInstance->Config->ConfValue("helpmsg");
+ cmd.nohelp = tag->getString("nohelp", "There is no help for the topic you searched for. Please try again.", 1);
}
- void OnWhois(User* src, User* dst)
+ void OnWhois(Whois::Context& whois) CXX11_OVERRIDE
{
- if (dst->IsModeSet('h'))
+ if (whois.GetTarget()->IsModeSet(ho))
{
- ServerInstance->SendWhoisLine(src, dst, 310, src->nick+" "+dst->nick+" :is available for help.");
+ whois.SendLine(RPL_WHOISHELPOP, "is available for help.");
}
}
- Version GetVersion()
+ Version GetVersion() CXX11_OVERRIDE
{
- return Version("Provides the /HELPOP command for useful information", VF_VENDOR);
+ return Version("Provides the HELPOP command for useful information", VF_VENDOR);
}
};