X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=src%2Fmodules%2Fm_helpop.cpp;h=f1f26a5eeb9c40d7b95594bdfeaaa02bfee08f0d;hb=HEAD;hp=1733d0455d6ce56ea1fb0b436e05c511958ef039;hpb=d9d99cd02dadf34bfcc220734ba0c422f0acb3e6;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/src/modules/m_helpop.cpp b/src/modules/m_helpop.cpp index 1733d0455..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 @@ -21,151 +24,168 @@ */ -/* $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 helpop_map; +typedef std::vector 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 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 = ""; } - CmdResult Handle (const std::vector ¶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::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::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(" 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())); } - - 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); } };