X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=src%2Fmodules%2Fm_helpop.cpp;h=f1f26a5eeb9c40d7b95594bdfeaaa02bfee08f0d;hb=80e81e3b81b779901fd9d67f8ae030ee30c0bcec;hp=95f69774bb0cad6cc543f7aa964b1688ac361342;hpb=d23c030c9a8fd58807438245a004e4aa5b7288ba;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/src/modules/m_helpop.cpp b/src/modules/m_helpop.cpp index 95f69774b..f1f26a5ee 100644 --- a/src/modules/m_helpop.cpp +++ b/src/modules/m_helpop.cpp @@ -1,11 +1,14 @@ /* * InspIRCd -- Internet Relay Chat Daemon * - * Copyright (C) 2009 Daniel De Graaf - * Copyright (C) 2005-2009 Robin Burchell - * Copyright (C) 2004-2006, 2008 Craig Edwards + * Copyright (C) 2013, 2017-2018, 2020 Sadie Powell + * Copyright (C) 2013, 2015 Attila Molnar + * Copyright (C) 2012 Robby + * Copyright (C) 2009-2010 Daniel De Graaf + * Copyright (C) 2009 Uli Schlachter + * Copyright (C) 2007 Robin Burchell * Copyright (C) 2007 Dennis Friis - * Copyright (C) 2004-2005 Craig McLure + * Copyright (C) 2006 Craig Edwards * * 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 @@ -22,27 +25,48 @@ #include "inspircd.h" +#include "modules/whois.h" -typedef std::map HelpopMap; -static HelpopMap helpop_map; +enum +{ + // From UnrealIRCd. + RPL_WHOISHELPOP = 310, + + // From ircd-ratbox. + ERR_HELPNOTFOUND = 524, + RPL_HELPSTART = 704, + RPL_HELPTXT = 705, + RPL_ENDOFHELP = 706 +}; -/** Handles user mode +h - */ -class Helpop : public SimpleUserModeHandler +typedef std::vector HelpMessage; + +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 HelpMap; + class CommandHelpop : public Command { + private: const std::string startkey; + public: + HelpMap help; + std::string nohelp; + CommandHelpop(Module* Creator) : Command(Creator, "HELPOP", 0) , startkey("start") @@ -50,108 +74,118 @@ class CommandHelpop : public Command syntax = ""; } - CmdResult Handle (const std::vector ¶meters, User *user) + CmdResult Handle(User* user, const Params& parameters) CXX11_OVERRIDE { - const std::string& parameter = (!parameters.empty() ? parameters[0] : startkey); - - 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->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"); + user->WriteNumeric(ERR_HELPNOTFOUND, topic, nohelp); + return CMD_FAILURE; } - else - { - user->WriteNumeric(290, InspIRCd::Format("*** 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, token); - } - - user->WriteNumeric(292, " -"); - user->WriteNumeric(292, "*** End of HELPOP"); - } + 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, public Whois::EventListener +class ModuleHelpop + : public Module + , public Whois::EventListener { + private: CommandHelpop cmd; - Helpop ho; + SimpleUserModeHandler ho; public: ModuleHelpop() : Whois::EventListener(this) , cmd(this) - , ho(this) + , ho(this, "helpop", 'h', true) { } void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE { - HelpopMap help; + 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; - std::string key = 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(" is empty at %s", tag->getTagLocation().c_str())); + else if (irc::equals(key, "index")) + throw ModuleException(InspIRCd::Format(" 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(" 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(" tag with duplicate key '%s' at %s", + key.c_str(), tag->getTagLocation().c_str())); } - - 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()) + // 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 '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); - helpop_map.swap(help); + 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(Whois::Context& whois) CXX11_OVERRIDE { if (whois.GetTarget()->IsModeSet(ho)) - { - whois.SendLine(310, "is available for help."); - } + 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); } };