X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=src%2Fmodules%2Fm_helpop.cpp;h=f1f26a5eeb9c40d7b95594bdfeaaa02bfee08f0d;hb=3151d60c1ecc9462e4c335282ee6c31672f45111;hp=f501676c3070a55dc2c70d17446dc06334bb0c95;hpb=c44487d3b4e67fbbd5f736bc29da0eac3a83f4a3;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/src/modules/m_helpop.cpp b/src/modules/m_helpop.cpp index f501676c3..f1f26a5ee 100644 --- a/src/modules/m_helpop.cpp +++ b/src/modules/m_helpop.cpp @@ -1,209 +1,192 @@ -/* +------------------------------------+ - * | Inspire Internet Relay Chat Daemon | - * +------------------------------------+ +/* + * InspIRCd -- Internet Relay Chat Daemon * - * InspIRCd: (C) 2002-2007 InspIRCd Development Team - * See: http://www.inspircd.org/wiki/index.php/Credits + * 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) 2006 Craig Edwards * - * This program is free but copyrighted software; see - * the file COPYING for details. + * 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 . */ -#include "users.h" -#include "channels.h" -#include "modules.h" + #include "inspircd.h" +#include "modules/whois.h" -/* $ModDesc: /helpop Command, Works like Unreal helpop */ -static std::map 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::vector HelpMessage; -/** Handles user mode +h - */ -class Helpop : public ModeHandler +struct HelpTopic { - public: - Helpop(InspIRCd* Instance) : ModeHandler(Instance, 'h', 0, 0, false, MODETYPE_USER, true) { } + // The body of the help topic. + const HelpMessage body; - ModeAction OnModeChange(userrec* source, userrec* dest, chanrec* channel, std::string ¶meter, bool adding) - { - if (adding) - { - if (!dest->IsModeSet('h')) - { - dest->SetMode('h',true); - return MODEACTION_ALLOW; - } - } - else - { - if (dest->IsModeSet('h')) - { - dest->SetMode('h',false); - return MODEACTION_ALLOW; - } - } + // The title of the help topic. + const std::string title; - return MODEACTION_DENY; + HelpTopic(const HelpMessage& Body, const std::string& Title) + : body(Body) + , title(Title) + { } }; -/** Handles /HELPOP - */ -class cmd_helpop : public command_t +typedef std::map HelpMap; + +class CommandHelpop : public Command { + private: + const std::string startkey; + public: - cmd_helpop (InspIRCd* Instance) : command_t(Instance, "HELPOP", 0, 1) - { - this->source = "m_helpop.so"; - syntax = ""; - } + HelpMap help; + std::string nohelp; - CmdResult Handle (const char** parameters, int pcnt, userrec *user) - { - irc::string parameter = parameters[0]; + CommandHelpop(Module* Creator) + : Command(Creator, "HELPOP", 0) + , startkey("start") + { + syntax = ""; + } - if (parameter == "index") + CmdResult Handle(User* user, const Params& parameters) CXX11_OVERRIDE + { + 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("NOTICE %s :HELPOP topic index", user->nick); - for (std::map::iterator iter = helpop_map.begin(); iter != helpop_map.end(); iter++) - { - user->WriteServ("NOTICE %s : %s", user->nick, iter->first.c_str()); - } - user->WriteServ("NOTICE %s :*** End of HELPOP topic index", user->nick); + user->WriteNumeric(ERR_HELPNOTFOUND, topic, nohelp); + return CMD_FAILURE; } - else - { - user->WriteServ("NOTICE %s :*** HELPOP for %s", user->nick, parameters[0]); - - 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 ((token = stream.GetToken()) != "") - { - user->WriteServ("NOTICE %s :%s", user->nick, token.c_str()); - } - - user->WriteServ("NOTICE %s :*** End of HELPOP", user->nick); - } - - /* We dont want these going out over the network, return CMD_FAILURE - * to make sure the protocol module thinks theyre not worth sending. - */ - return CMD_FAILURE; + 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 { - private: - std::string h_file; - cmd_helpop* mycommand; - Helpop* ho; + private: + CommandHelpop cmd; + SimpleUserModeHandler ho; public: - ModuleHelpop(InspIRCd* Me) - : Module::Module(Me) + ModuleHelpop() + : Whois::EventListener(this) + , cmd(this) + , ho(this, "helpop", 'h', true) { - ReadConfig(); - ho = new Helpop(ServerInstance); - ServerInstance->AddMode(ho, 'h'); - mycommand = new cmd_helpop(ServerInstance); - ServerInstance->AddCommand(mycommand); } - virtual void ReadConfig() + void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE { - ConfigReader *MyConf = new ConfigReader(ServerInstance); + size_t longestkey = 0; - helpop_map.clear(); + HelpMap newhelp; + ConfigTagList tags = ServerInstance->Config->ConfTags("helpop"); + if (tags.first == tags.second) + throw ModuleException("You have loaded the helpop module but not configured any help topics!"); - for (int i = 0; i < MyConf->Enumerate("helpop"); i++) + for (ConfigIter i = tags.first; i != tags.second; ++i) { - irc::string key = assign(MyConf->ReadValue("helpop", "key", i)); - std::string value = MyConf->ReadValue("helpop", "value", i, true); /* Linefeeds allowed! */ - - if (key == "index") + ConfigTag* tag = i->second; + + // 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()) - { - // error! - throw ModuleException("m_helpop: Helpop file is missing important entries. Please check the example conf."); - } - else if (helpop_map.find("nohelp") == 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 entries. 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 Implements(char* List) - { - List[I_OnRehash] = List[I_OnWhois] = 1; + 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); } - virtual void OnRehash(const std::string ¶meter) + void OnWhois(Whois::Context& whois) CXX11_OVERRIDE { - ReadConfig(); + if (whois.GetTarget()->IsModeSet(ho)) + whois.SendLine(RPL_WHOISHELPOP, "is available for help."); } - virtual void OnWhois(userrec* src, userrec* dst) + Version GetVersion() CXX11_OVERRIDE { - if (dst->IsModeSet('h')) - { - ServerInstance->SendWhoisLine(src, dst, 310, std::string(src->nick)+" "+std::string(dst->nick)+" :is available for help."); - } - } - - virtual ~ModuleHelpop() - { - ServerInstance->Modes->DelMode(ho); - DELETE(ho); - } - - virtual Version GetVersion() - { - return Version(1,1,0,1,VF_COMMON|VF_VENDOR,API_VERSION); + 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); } }; -class ModuleHelpopFactory : public ModuleFactory -{ - public: - ModuleHelpopFactory() - { - } - - ~ModuleHelpopFactory() - { - } - - virtual Module * CreateModule(InspIRCd* Me) - { - return new ModuleHelpop(Me); - } - -}; - -extern "C" void * init_module( void ) -{ - return new ModuleHelpopFactory; -} +MODULE_INIT(ModuleHelpop)