X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;ds=sidebyside;f=src%2Fmodules%2Fm_helpop.cpp;h=eb64d4f481609201e025f1b4c58224ea47870831;hb=88d1811905675c84b5ef96ff157d304e0e5f4e9a;hp=2a0a0e62b76bd6a1254e141fff14f789b70fcb81;hpb=2d821f2980825be73e3f90b47ffff365b0ec5ecb;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/src/modules/m_helpop.cpp b/src/modules/m_helpop.cpp index 2a0a0e62b..a34e3ff94 100644 --- a/src/modules/m_helpop.cpp +++ b/src/modules/m_helpop.cpp @@ -1,258 +1,168 @@ -/* +------------------------------------+ - * | Inspire Internet Relay Chat Daemon | - * +------------------------------------+ +/* + * InspIRCd -- Internet Relay Chat Daemon * - * Inspire is copyright (C) 2002-2004 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-2015 Attila Molnar + * Copyright (C) 2013, 2017-2018, 2020 Sadie Powell + * Copyright (C) 2012, 2019 Robby + * Copyright (C) 2009-2010 Daniel De Graaf + * Copyright (C) 2009 Uli Schlachter + * Copyright (C) 2007-2008 Robin Burchell + * Copyright (C) 2007 Dennis Friis + * Copyright (C) 2006-2007 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" - -// Global Vars -/* XXX - should all this be marked static? clear the global namespace, etc. */ -ConfigReader *helpop; -Server *Srv; - -void handle_helpop(char**, int, userrec*); -bool do_helpop(char**, int, userrec*); -void sendtohelpop(userrec*, int, char**); +#include "inspircd.h" +#include "modules/whois.h" -/* $ModDesc: /helpop Command, Works like Unreal helpop */ - -void handle_helpop(char **parameters, int pcnt, userrec *user) +enum { - char a[MAXBUF]; - std::string output = " "; - - if (!helpop) - return; - - if (pcnt < 1) - { - do_helpop(NULL,pcnt,user); - return; - } + // From UnrealIRCd. + RPL_WHOISHELPOP = 310, + + // From ircd-ratbox. + ERR_HELPNOTFOUND = 524, + RPL_HELPSTART = 704, + RPL_HELPTXT = 705, + RPL_ENDOFHELP = 706 +}; - if (parameters[0][0] == '!') - { - // Force send to all +h users - sendtohelpop(user, pcnt, parameters); - } - else if (parameters[0][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); +typedef std::vector HelpMessage; - if(output != "") - { - Srv->SendTo(NULL,user,"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 != "") - { - Srv->SendTo(NULL,user,"290 "+std::string(user->nick)+" :"+output); - } - } - // Forward. - sendtohelpop(user, pcnt, parameters); - } - } -} +typedef std::map HelpMap; -bool do_helpop(char **parameters, int pcnt, userrec *src) +class CommandHelpop : public Command { - char *search; - std::string output = " "; // a fix bought to you by brain :p - char a[MAXBUF]; - char lower[MAXBUF]; - int nlines = 0; + private: + const std::string startkey; - if (!parameters) - { - search = "start"; - } - else - { - search = parameters[0]; - } + public: + HelpMap help; + std::string nohelp; - if (search[0] == '?') + CommandHelpop(Module* Creator) + : Command(Creator, "HELPOP", 0) + , startkey("start") { - search++; - } - - /* XXX - don't we have an strtolower()? if not, might pay to add one.. that works on char *, preferably.. */ - strlcpy(lower, search, MAXBUF); - for (unsigned int t = 0; t < strlen(lower); t++) - lower[t] = tolower(lower[t]); - + syntax = ""; + } - for (int i = 1; output != ""; i++) + CmdResult Handle(User* user, const Params& parameters) CXX11_OVERRIDE { - snprintf(a,MAXBUF,"line%d",i); - output = helpop->ReadValue(lower, a, 0); - if (output != "") + const std::string& topic = parameters.empty() ? startkey : parameters[0]; + HelpMap::const_iterator titer = help.find(topic); + if (titer == help.end()) { - Srv->SendTo(NULL,src,"290 "+std::string(src->nick)+" :"+output); - nlines++; + user->WriteNumeric(ERR_HELPNOTFOUND, topic, nohelp); + return CMD_FAILURE; } - } - return (nlines>0); -} - - - -void sendtohelpop(userrec *src, int pcnt, char **params) -{ - char* first = params[0]; - if (*first == '!') - { - first++; - } - 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]) + " "; + user->WriteNumeric(RPL_HELPSTART, topic, InspIRCd::Format("*** Help for %s", topic.c_str())); + for (HelpMessage::const_iterator liter = titer->second.begin(); liter != titer->second.end(); ++liter) + user->WriteNumeric(RPL_HELPTXT, topic, *liter); + user->WriteNumeric(RPL_ENDOFHELP, topic, "*** End of help"); + return CMD_SUCCESS; } - Srv->SendToModeMask("oh",WM_AND,line); -} +}; -class ModuleHelpop : public Module +class ModuleHelpop + : public Module + , public Whois::EventListener { - private: - ConfigReader *conf; - std::string h_file; + private: + CommandHelpop cmd; + SimpleUserModeHandler ho; public: - ModuleHelpop(Server* Me) - : Module::Module(Me) + ModuleHelpop() + : Whois::EventListener(this) + , cmd(this) + , ho(this, "helpop", 'h', true) { - Srv = Me; - - ReadConfig(); - if (!Srv->AddExtendedMode('h',MT_CLIENT,true,0,0)) - { - Srv->Log(DEFAULT,"Unable to claim the +h usermode."); - return; - } - - Srv->AddCommand("HELPOP",handle_helpop,0,0,"m_helpop.so"); } - 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; - log(DEFAULT,"m_helpop: Helpop file not Specified."); - return; - } + 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) { - log(DEFAULT,"m_helpop: Helpop file is missing important entries. Please check the example conf."); - return; + 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); + newhelp[key] = helpmsg; } - } + // The number of items we can fit on a page. + HelpMessage& indexmsg = newhelp["index"]; + 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(std::string parameter) - { - delete conf; - if (helpop) - delete helpop; - - ReadConfig(); - } - - virtual int OnExtendedMode(userrec* user, void* target, char modechar, int type, bool mode_on, string_list ¶ms) - { - if ((modechar == 'h') && (type == MT_CLIENT)) - { - return 1; + indexline.append(iter->first); + if (++column != maxcolumns) + indexline.append(longestkey - iter->first.length() + 2, ' '); + iter++; + } + indexmsg.push_back(indexline); } - return 0; - } + cmd.help.swap(newhelp); - virtual void OnWhois(userrec* src, userrec* dst) - { - if (strchr(dst->modes,'h')) - { - Srv->SendTo(NULL,src,"310 "+std::string(src->nick)+" "+std::string(dst->nick)+" :is available for 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); } - virtual ~ModuleHelpop() + void OnWhois(Whois::Context& whois) CXX11_OVERRIDE { - delete conf; - delete helpop; + if (whois.GetTarget()->IsModeSet(ho)) + whois.SendLine(RPL_WHOISHELPOP, "is available for help."); } - - virtual Version GetVersion() + + Version GetVersion() CXX11_OVERRIDE { - return Version(1,0,0,1,VF_STATIC|VF_VENDOR); + return Version("Provides help to users via the HELPOP command", VF_VENDOR); } }; -class ModuleHelpopFactory : public ModuleFactory -{ - public: - ModuleHelpopFactory() - { - } - - ~ModuleHelpopFactory() - { - } - - virtual Module * CreateModule(Server* Me) - { - return new ModuleHelpop(Me); - } - -}; - -extern "C" void * init_module( void ) -{ - return new ModuleHelpopFactory; -} +MODULE_INIT(ModuleHelpop)