X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=src%2Fmodules%2Fm_helpop.cpp;h=f1f26a5eeb9c40d7b95594bdfeaaa02bfee08f0d;hb=3151d60c1ecc9462e4c335282ee6c31672f45111;hp=5ef4f10a34cc610eee56d184f8f550fa5bc132fd;hpb=9f64dd045bee9b624828d2038b466b92824c9524;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/src/modules/m_helpop.cpp b/src/modules/m_helpop.cpp index 5ef4f10a3..f1f26a5ee 100644 --- a/src/modules/m_helpop.cpp +++ b/src/modules/m_helpop.cpp @@ -1,224 +1,192 @@ -#include "users.h" -#include "channels.h" -#include "modules.h" - -// Global Vars -ConfigReader *helpop; -Server *Srv; - -void handle_helpop(char**, int, userrec*); -bool do_helpop(char**, int, userrec*); -void sendtohelpop(userrec*, int, char**); - +/* + * InspIRCd -- Internet Relay Chat Daemon + * + * 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 . + */ + + +#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 +}; -/* $ModDesc: /helpop Command, Works like Unreal helpop */ +typedef std::vector HelpMessage; -void handle_helpop(char **parameters, int pcnt, userrec *user) +struct HelpTopic { - char a[MAXBUF]; - std::string output = " "; - - if (pcnt < 1) { - do_helpop(NULL,pcnt,user); - return; - } + // The body of the help topic. + const HelpMessage body; - // FIX by brain: make the string lowercase, ConfigReader is - // case sensitive - char* lower = parameters[0]; - for (int t = 0; t < strlen(lower); t++) - lower[t] = tolower(lower[t]); + // The title of the help topic. + const std::string title; - if (parameters[0][0] == '!') + HelpTopic(const HelpMessage& Body, const std::string& Title) + : body(Body) + , title(Title) { - // 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 forward. - for (int i = 1; output != ""; i++) - { - snprintf(a,MAXBUF,"line%d",i); - output = helpop->ReadValue("nohelp", std::string(a), 0); - if(output != "") { - Srv->SendTo(NULL,user,"290 "+std::string(user->nick)+" :"+output); - } - } - } - } else if (strchr(user->modes,'o')) { - // Its an oper whos not using ?, send to all +h - sendtohelpop(user, pcnt, parameters); - } 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); - 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); - } } -} +}; -bool do_helpop(char **parameters, int pcnt, userrec *src) -{ - char *search; - std::string output = " "; // a fix bought to you by brain :p - char a[MAXBUF]; +typedef std::map HelpMap; - if (!parameters) { strcpy(search, "start"); } - else { search = parameters[0]; } +class CommandHelpop : public Command +{ + private: + const std::string startkey; - if (search[0] == '?') { search++; } + public: + HelpMap help; + std::string nohelp; - // Make sure it exists. - if (helpop->ReadValue(std::string(search), "line1", 0) == "") + CommandHelpop(Module* Creator) + : Command(Creator, "HELPOP", 0) + , startkey("start") { - // Tell caller.. - return false; + syntax = ""; } - // Somethings there.. tell the person who wants to know :p - - for (int i = 1; output != ""; i++) + CmdResult Handle(User* user, const Params& parameters) CXX11_OVERRIDE { - snprintf(a,MAXBUF,"line%d",i); - output = helpop->ReadValue(std::string(search), std::string(a), 0); - if (output != "") { - Srv->SendTo(NULL,src,"290 "+std::string(src->nick)+" :"+output); + 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; } - } - return true; -} - - -void sendtohelpop(userrec *src, int pcnt, char **params) -{ - char* first = params[0]; - if (first[0] == '!') { 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]) + " "; + 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; } - Srv->SendToModeMask("oh",WM_AND,line); -} +}; -class ModuleHelpop : public Module +class ModuleHelpop + : public Module + , public Whois::EventListener { private: - ConfigReader *conf; - std::string h_file; - - public: - ModuleHelpop() - { - Srv = new Server; - conf = new ConfigReader; - - h_file = conf->ReadValue("helpop", "file", 0); - - if (h_file == "") { - printf("m_helpop: Helpop file not Specified."); - exit(0); - } - - helpop = new ConfigReader(h_file); - if (!helpop->Verify()) + CommandHelpop cmd; + SimpleUserModeHandler ho; + + public: + ModuleHelpop() + : Whois::EventListener(this) + , cmd(this) + , ho(this, "helpop", 'h', true) { - printf("m_helpop: Invalid Helpop File. Please Ensure it exists and is error free."); - exit(0); } - if ((helpop->ReadValue("nohelp", "line1", 0) == "") || - (helpop->ReadValue("nohelpo", "line1", 0) == "") || - (helpop->ReadValue("start", "line1", 0) == "")) + void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE { - printf("m_helpop: Helpop file is missing important entries. Please check the example conf."); - exit(0); - } + size_t longestkey = 0; + + 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 (ConfigIter i = tags.first; i != tags.second; ++i) + { + 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())); + } + } + + // 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; + + 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); - if (!Srv->AddExtendedMode('h',MT_CLIENT,true,0,0)) - { - Srv->Log(DEFAULT,"Unable to clame the +h usermode."); - printf("m_helpop: Unable to claim the +h usermode!"); - exit(0); + 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); } - // Loads of comments, untill supported properly. - /*if (!*/Srv->AddCommand("HELPOP",handle_helpop,0,0);/*) + void OnWhois(Whois::Context& whois) CXX11_OVERRIDE { - Srv->Log(DEFAULT,"Unable to claim the HELPOP command."); - printf("m_helpop: Unable to claim the HELPOP command."); - exit(0); - }*/ - - } - - virtual bool OnExtendedMode(userrec* user, void* target, char modechar, int type, bool mode_on, string_list ¶ms) - { - if ((modechar == 'h') && (type == MT_CLIENT)) - { - return 1; + if (whois.GetTarget()->IsModeSet(ho)) + whois.SendLine(RPL_WHOISHELPOP, "is available for help."); } - return 0; - } - virtual void OnWhois(userrec* src, userrec* dst) { - if (strchr(src->modes,'h')) + Version GetVersion() CXX11_OVERRIDE { - Srv->SendTo(NULL,src,"310 "+std::string(src->nick)+" "+std::string(dst->nick)+" :is available for help."); + 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); } - } - - virtual void OnOper(userrec* user) - { - char* modes[2]; // only two parameters - modes[0] = user->nick; // first parameter is the nick - modes[1] = "+h"; // second parameter is the mode - Srv->SendMode(modes,2,user); // send these, forming the command "MODE +h" - } - - virtual ~ModuleHelpop() - { - delete Srv; - delete conf; - delete helpop; - } - - virtual Version GetVersion() - { - return Version(0,0,0,1); - } -}; - -class ModuleHelpopFactory : public ModuleFactory -{ - public: - ModuleHelpopFactory() - { - } - - ~ModuleHelpopFactory() - { - } - - virtual Module * CreateModule() - { - return new ModuleHelpop; - } - }; -extern "C" void * init_module( void ) -{ - return new ModuleHelpopFactory; -} +MODULE_INIT(ModuleHelpop)