X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=src%2Fmodules%2Fm_helpop.cpp;h=f1f26a5eeb9c40d7b95594bdfeaaa02bfee08f0d;hb=3151d60c1ecc9462e4c335282ee6c31672f45111;hp=4d4263d280142e0a2646f747d2c3cbdd17b4062a;hpb=66098d307c036997e51eaea21724615e27fdc3e9;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/src/modules/m_helpop.cpp b/src/modules/m_helpop.cpp index 4d4263d28..f1f26a5ee 100644 --- a/src/modules/m_helpop.cpp +++ b/src/modules/m_helpop.cpp @@ -1,291 +1,192 @@ -/* +------------------------------------+ - * | Inspire Internet Relay Chat Daemon | - * +------------------------------------+ +/* + * InspIRCd -- Internet Relay Chat Daemon * - * InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev. - * E-mail: - * - * - * - * Written by Craig Edwards, Craig McLure, and others. - * This program is free but copyrighted software; see - *the file COPYING for details. + * 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 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 . */ -using namespace std; -#include "users.h" -#include "channels.h" -#include "modules.h" -#include "helperfuncs.h" #include "inspircd.h" +#include "modules/whois.h" -// Global Vars -static ConfigReader *helpop; - -extern InspIRCd* ServerInstance; - -bool do_helpop(const char**, int, userrec*); -void sendtohelpop(userrec*, int, const char**); - -/* $ModDesc: /helpop Command, Works like Unreal helpop */ - -class Helpop : public ModeHandler +enum { - public: - Helpop(InspIRCd* Instance) : ModeHandler(Instance, 'h', 0, 0, false, MODETYPE_USER, true) { } - - 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; - } - } - - return MODEACTION_DENY; - } + // From UnrealIRCd. + RPL_WHOISHELPOP = 310, + + // From ircd-ratbox. + ERR_HELPNOTFOUND = 524, + RPL_HELPSTART = 704, + RPL_HELPTXT = 705, + RPL_ENDOFHELP = 706 }; -class cmd_helpop : public command_t -{ - public: - cmd_helpop (InspIRCd* Instance) : command_t(Instance, "HELPOP", 0, 1) - { - this->source = "m_helpop.so"; - syntax = "[?|!]"; - } - - void Handle (const char** parameters, int pcnt, userrec *user) - { - char a[MAXBUF]; - std::string output = " "; +typedef std::vector HelpMessage; - if (!helpop) - return; +struct HelpTopic +{ + // The body of the help topic. + const HelpMessage body; - if (pcnt < 1) - { - do_helpop(NULL,pcnt,user); - return; - } + // The title of the help topic. + const std::string title; - if (*parameters[0] == '!') - { - // Force send to all +h users - sendtohelpop(user, pcnt, parameters); - } - else if (*parameters[0] == '?') - { - // Force to the helpop system with no forward if not found. - if (do_helpop(parameters, pcnt, user) == false) - { - // Not handled by the Database, Tell the user, and bail. - for (int i = 1; output != ""; i++) - { - snprintf(a,MAXBUF,"line%d",i); - output = helpop->ReadValue("nohelp", std::string(a), 0); - - if(output != "") - { - user->WriteServ("290 "+std::string(user->nick)+" :"+output); - } - } - } - } - else - { - // Check with the helpop database, if not found send to +h - if (do_helpop(parameters, pcnt, user) == false) - { - // Not handled by the Database, Tell the user, and forward. - for (int i = 1; output != ""; i++) - { - snprintf(a,MAXBUF,"line%d",i); - /* "nohelpo" for opers "nohelp" for users */ - output = helpop->ReadValue("nohelpo", std::string(a), 0); - if (output != "") - { - user->WriteServ("290 "+std::string(user->nick)+" :"+output); - } - } - // Forward. - sendtohelpop(user, pcnt, parameters); - } - } + HelpTopic(const HelpMessage& Body, const std::string& Title) + : body(Body) + , title(Title) + { } }; +typedef std::map HelpMap; -bool do_helpop(const char** parameters, int pcnt, userrec *src) +class CommandHelpop : public Command { - char search[MAXBUF]; - std::string output = " "; // a fix bought to you by brain :p - char a[MAXBUF]; - int nlines = 0; - - if (!pcnt) - { - strcpy(search,"start"); - } - else - { - if (*parameters[0] == '?') - parameters[0]++; - strlcpy(search,parameters[0],MAXBUF); - } + private: + const std::string startkey; - for (char* n = search; *n; n++) - *n = tolower(*n); + public: + HelpMap help; + std::string nohelp; - for (int i = 1; output != ""; i++) + CommandHelpop(Module* Creator) + : Command(Creator, "HELPOP", 0) + , startkey("start") { - snprintf(a,MAXBUF,"line%d",i); - output = helpop->ReadValue(search, a, 0); - if (output != "") - { - src->WriteServ("290 "+std::string(src->nick)+" :"+output); - nlines++; - } + syntax = ""; } - return (nlines>0); -} - - -void sendtohelpop(userrec *src, int pcnt, const char **params) -{ - const char* first = params[0]; - if (*first == '!') + CmdResult Handle(User* user, const Params& parameters) CXX11_OVERRIDE { - first++; - } + const std::string& topic = parameters.empty() ? startkey : parameters[0]; + HelpMap::const_iterator titer = help.find(topic); + if (titer == help.end()) + { + user->WriteNumeric(ERR_HELPNOTFOUND, topic, nohelp); + return CMD_FAILURE; + } - std::string line = "*** HELPOPS - From "+std::string(src->nick)+": "+std::string(first)+" "; - for (int i = 1; i < pcnt; i++) - { - line = line + std::string(params[i]) + " "; + 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; } - ServerInstance->WriteMode("oh",WM_AND,line.c_str()); -} - -class HelpopException : public ModuleException -{ - private: - std::string err; - public: - HelpopException(std::string message) : err(message) { } - virtual const char* GetReason() { return err.c_str(); } }; -class ModuleHelpop : public Module +class ModuleHelpop + : public Module + , public Whois::EventListener { - private: - ConfigReader *conf; - 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 { - conf = new ConfigReader; - h_file = conf->ReadValue("helpop", "file", 0); + size_t longestkey = 0; - if (h_file == "") - { - helpop = NULL; - HelpopException e("Missing helpop file"); - throw(e); - } + 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!"); - helpop = new ConfigReader(h_file); - if ((helpop->ReadValue("nohelp", "line1", 0) == "") || - (helpop->ReadValue("nohelpo", "line1", 0) == "") || - (helpop->ReadValue("start", "line1", 0) == "")) + for (ConfigIter i = tags.first; i != tags.second; ++i) { - HelpopException e("m_helpop: Helpop file is missing important entries. Please check the example conf."); - throw(e); + 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(InspIRCd::Format(" tag with duplicate key '%s' at %s", + key.c_str(), tag->getTagLocation().c_str())); + } } - } - void Implements(char* List) - { - List[I_OnRehash] = List[I_OnWhois] = 1; - } + // 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(); ) + { + std::string indexline; + for (size_t column = 0; column != maxcolumns; ) + { + if (iter == newhelp.end()) + break; - virtual void OnRehash(const std::string ¶meter) - { - DELETE(conf); - if (helpop) - DELETE(helpop); + 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); - 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); } - virtual void OnWhois(userrec* src, userrec* dst) + void OnWhois(Whois::Context& whois) CXX11_OVERRIDE { - if (dst->IsModeSet('h')) - { - src->WriteServ("310 "+std::string(src->nick)+" "+std::string(dst->nick)+" :is available for help."); - } + if (whois.GetTarget()->IsModeSet(ho)) + whois.SendLine(RPL_WHOISHELPOP, "is available for help."); } - virtual ~ModuleHelpop() + Version GetVersion() CXX11_OVERRIDE { - DELETE(conf); - DELETE(helpop); - DELETE(ho); - } - - virtual Version GetVersion() - { - return Version(1,0,0,1,VF_STATIC|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); } }; -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)