/*
* 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) 2013, 2017-2018, 2020 Sadie Powell <sadie@witchery.services>
+ * Copyright (C) 2013, 2015 Attila Molnar <attilamolnar@hush.com>
+ * Copyright (C) 2012 Robby <robby@chatbelgie.be>
+ * Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
+ * Copyright (C) 2009 Uli Schlachter <psychon@inspircd.org>
+ * Copyright (C) 2007 Robin Burchell <robin+git@viroteck.net>
* Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
- * Copyright (C) 2004-2005 Craig McLure <craig@chatspike.net>
+ * Copyright (C) 2006 Craig Edwards <brain@inspircd.org>
*
* 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
*/
-/* $ModDesc: Provides the /HELPOP command for useful information */
-
#include "inspircd.h"
+#include "modules/whois.h"
+
+enum
+{
+ // From UnrealIRCd.
+ RPL_WHOISHELPOP = 310,
+
+ // From ircd-ratbox.
+ ERR_HELPNOTFOUND = 524,
+ RPL_HELPSTART = 704,
+ RPL_HELPTXT = 705,
+ RPL_ENDOFHELP = 706
+};
-static std::map<irc::string, std::string> helpop_map;
+typedef std::vector<std::string> HelpMessage;
-/** Handles user mode +h
- */
-class Helpop : public SimpleUserModeHandler
+struct HelpTopic
{
- public:
- Helpop(Module* Creator) : SimpleUserModeHandler(Creator, "helpop", 'h')
+ // The body of the help topic.
+ const HelpMessage body;
+
+ // The title of the help topic.
+ const std::string title;
+
+ HelpTopic(const HelpMessage& Body, const std::string& Title)
+ : body(Body)
+ , title(Title)
{
- oper = true;
}
};
-/** Handles /HELPOP
- */
+typedef std::map<std::string, HelpTopic, irc::insensitive_swo> HelpMap;
+
class CommandHelpop : public Command
{
+ private:
+ const std::string startkey;
+
public:
- CommandHelpop(Module* Creator) : Command(Creator, "HELPOP", 0)
+ HelpMap help;
+ std::string nohelp;
+
+ CommandHelpop(Module* Creator)
+ : Command(Creator, "HELPOP", 0)
+ , startkey("start")
{
syntax = "<any-text>";
}
- CmdResult Handle (const std::vector<std::string> ¶meters, User *user)
+ CmdResult Handle(User* user, const Params& parameters) CXX11_OVERRIDE
{
- irc::string parameter("start");
- if (parameters.size() > 0)
- parameter = parameters[0].c_str();
-
- if (parameter == "index")
+ const std::string& topic = parameters.empty() ? startkey : parameters[0];
+ HelpMap::const_iterator titer = help.find(topic);
+ if (titer == help.end())
{
- /* 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(ERR_HELPNOTFOUND, topic, nohelp);
+ return CMD_FAILURE;
}
- 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())
- {
- iter = helpop_map.find("nohelp");
- }
-
- 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->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());
- }
+ const HelpTopic& entry = titer->second;
+ user->WriteNumeric(RPL_HELPSTART, topic, entry.title);
+ for (HelpMessage::const_iterator liter = entry.body.begin(); liter != entry.body.end(); ++liter)
+ user->WriteNumeric(RPL_HELPTXT, topic, *liter);
+ user->WriteNumeric(RPL_ENDOFHELP, topic, "End of /HELPOP.");
return CMD_SUCCESS;
}
};
-class ModuleHelpop : public Module
+class ModuleHelpop
+ : public Module
+ , public Whois::EventListener
{
- std::string h_file;
+ private:
CommandHelpop cmd;
- Helpop ho;
+ SimpleUserModeHandler ho;
public:
ModuleHelpop()
- : cmd(this), ho(this)
- {
- }
-
- void init() CXX11_OVERRIDE
+ : Whois::EventListener(this)
+ , cmd(this)
+ , ho(this, "helpop", 'h', true)
{
- 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()
+ void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
{
- helpop_map.clear();
+ size_t longestkey = 0;
+ HelpMap newhelp;
ConfigTagList tags = ServerInstance->Config->ConfTags("helpop");
- for(ConfigIter i = tags.first; i != tags.second; ++i)
+ if (tags.first == tags.second)
+ throw ModuleException("You have loaded the helpop module but not configured any help topics!");
+
+ for (ConfigIter i = tags.first; i != tags.second; ++i)
{
ConfigTag* tag = i->second;
- irc::string key = assign(tag->getString("key"));
- std::string value;
- tag->readString("value", value, true); /* Linefeeds allowed */
- if (key == "index")
+ // Attempt to read the help key.
+ const std::string key = tag->getString("key");
+ if (key.empty())
+ throw ModuleException(InspIRCd::Format("<helpop:key> is empty at %s", tag->getTagLocation().c_str()));
+ else if (irc::equals(key, "index"))
+ throw ModuleException(InspIRCd::Format("<helpop:key> is set to \"index\" which is reserved at %s", tag->getTagLocation().c_str()));
+ else if (key.length() > longestkey)
+ longestkey = key.length();
+
+ // Attempt to read the help value.
+ std::string value;
+ if (!tag->readString("value", value, true) || value.empty())
+ throw ModuleException(InspIRCd::Format("<helpop:value> is empty at %s", tag->getTagLocation().c_str()));
+
+ // Parse the help body. Empty lines are replaced with a single
+ // space because some clients are unable to show blank lines.
+ HelpMessage helpmsg;
+ irc::sepstream linestream(value, '\n', true);
+ for (std::string line; linestream.GetToken(line); )
+ helpmsg.push_back(line.empty() ? " " : line);
+
+ // Read the help title and store the topic.
+ const std::string title = tag->getString("title", InspIRCd::Format("*** Help for %s", key.c_str()), 1);
+ if (!newhelp.insert(std::make_pair(key, HelpTopic(helpmsg, title))).second)
{
- throw ModuleException("m_helpop: The key 'index' is reserved for internal purposes. Please remove it.");
+ throw ModuleException(InspIRCd::Format("<helpop> tag with duplicate key '%s' at %s",
+ key.c_str(), tag->getTagLocation().c_str()));
}
-
- helpop_map[key] = value;
}
- if (helpop_map.find("start") == helpop_map.end())
+ // The number of items we can fit on a page.
+ HelpMessage indexmsg;
+ size_t maxcolumns = 80 / (longestkey + 2);
+ for (HelpMap::iterator iter = newhelp.begin(); iter != newhelp.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())
- {
- // error!
- throw ModuleException("m_helpop: Helpop file is missing important entry 'nohelp'. Please check the example conf.");
- }
+ std::string indexline;
+ for (size_t column = 0; column != maxcolumns; )
+ {
+ if (iter == newhelp.end())
+ break;
- }
+ indexline.append(iter->first);
+ if (++column != maxcolumns)
+ indexline.append(longestkey - iter->first.length() + 2, ' ');
+ iter++;
+ }
+ indexmsg.push_back(indexline);
+ }
+ newhelp.insert(std::make_pair("index", HelpTopic(indexmsg, "List of help topics")));
+ cmd.help.swap(newhelp);
- void OnRehash(User* user) CXX11_OVERRIDE
- {
- 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) CXX11_OVERRIDE
+ void OnWhois(Whois::Context& whois) CXX11_OVERRIDE
{
- if (dst->IsModeSet('h'))
- {
- ServerInstance->SendWhoisLine(src, dst, 310, src->nick+" "+dst->nick+" :is available for help.");
- }
+ if (whois.GetTarget()->IsModeSet(ho))
+ whois.SendLine(RPL_WHOISHELPOP, "is available for help.");
}
Version GetVersion() CXX11_OVERRIDE
{
- return Version("Provides the /HELPOP command for useful information", VF_VENDOR);
+ return Version("Adds the /HELPOP command which allows users to view help on various topics and user mode h (helpop) which marks a server operator as being available for help.", VF_VENDOR);
}
};
projects / user / henk / code / inspircd.git / blobdiff