X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=src%2Fmodules%2Fm_helpop.cpp;h=f8829857681b37b9a775ab2f35c6f9cac6e952ab;hb=c6e40d36b42a7ebf832c3a57d2816a47ee9c9a76;hp=22bd3619b6c89a9a1b578a9308a298302fa5279b;hpb=9f35df1ad1599f62f040261fec821b703a3643af;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/src/modules/m_helpop.cpp b/src/modules/m_helpop.cpp index 22bd3619b..f88298576 100644 --- a/src/modules/m_helpop.cpp +++ b/src/modules/m_helpop.cpp @@ -1,283 +1,165 @@ -/* +------------------------------------+ - * | 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) 2009 Daniel De Graaf + * Copyright (C) 2005-2009 Robin Burchell + * Copyright (C) 2004-2006, 2008 Craig Edwards + * Copyright (C) 2007 Dennis Friis + * Copyright (C) 2004-2005 Craig McLure * - * --------------------------------------------------- + * 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 "inspircd.h" +#include "modules/whois.h" -// Global Vars -static ConfigReader *helpop; - -/*bool do_helpop(const char**, int, userrec*); -void sendtohelpop(userrec*, int, const char**);*/ +enum +{ + // From UnrealIRCd. + RPL_WHOISHELPOP = 310 +}; -/* $ModDesc: /helpop Command, Works like Unreal helpop */ +typedef std::map HelpopMap; +static HelpopMap helpop_map; /** Handles user mode +h */ -class Helpop : public ModeHandler +class Helpop : public SimpleUserModeHandler { 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) + Helpop(Module* Creator) : SimpleUserModeHandler(Creator, "helpop", 'h') { - 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; + oper = true; } }; /** Handles /HELPOP */ -class cmd_helpop : public command_t +class CommandHelpop : public Command { + const std::string startkey; public: - cmd_helpop (InspIRCd* Instance) : command_t(Instance, "HELPOP", 0, 1) - { - this->source = "m_helpop.so"; - syntax = "[?|!]"; - } - - CmdResult Handle (const char** parameters, int pcnt, userrec *user) + CommandHelpop(Module* Creator) + : Command(Creator, "HELPOP", 0) + , startkey("start") { - char a[MAXBUF]; - std::string output = " "; - - if (!helpop) - return CMD_FAILURE; - - if (pcnt < 1) - { - do_helpop(NULL,pcnt,user); - return CMD_SUCCESS; - } - - 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("helpop_nohelp", 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("helpop_nohelpo", a, 0); - if (output != "") - { - user->WriteServ("290 "+std::string(user->nick)+" :"+output); - } - } - // Forward. - sendtohelpop(user, pcnt, parameters); - } - } - - return CMD_SUCCESS; + syntax = ""; } - - bool do_helpop(const char** parameters, int pcnt, userrec *src) + CmdResult Handle(User* user, const Params& parameters) CXX11_OVERRIDE { - char search[MAXBUF]; - std::string output = " "; // a fix bought to you by brain :p - char a[MAXBUF]; - int nlines = 0; + const std::string& parameter = (!parameters.empty() ? parameters[0] : startkey); - if (!pcnt) + if (parameter == "index") { - strcpy(search,"helpop_start"); - } + /* iterate over all helpop items */ + user->WriteNumeric(290, "HELPOP topic index"); + for (HelpopMap::const_iterator iter = helpop_map.begin(); iter != helpop_map.end(); iter++) + user->WriteNumeric(292, InspIRCd::Format(" %s", iter->first.c_str())); + user->WriteNumeric(292, "*** End of HELPOP topic index"); + } else { - if (*parameters[0] == '?') - parameters[0]++; - strlcpy(search, "helpop_", MAXBUF); - strlcat(search, parameters[0], MAXBUF); - } + user->WriteNumeric(290, InspIRCd::Format("*** HELPOP for %s", parameter.c_str())); + user->WriteNumeric(292, " -"); - for (char* n = search; *n; n++) - *n = tolower(*n); + HelpopMap::const_iterator iter = helpop_map.find(parameter); - for (int i = 1; output != ""; i++) - { - snprintf(a,MAXBUF,"line%d",i); - output = helpop->ReadValue(search, a, 0); - if (output != "") + if (iter == helpop_map.end()) { - src->WriteServ("290 "+std::string(src->nick)+" :"+output); - nlines++; + iter = helpop_map.find("nohelp"); } - } - return (nlines>0); - } - void sendtohelpop(userrec *src, int pcnt, const char **params) - { - const char* first = params[0]; - if (*first == '!') - { - first++; - } + const std::string& value = iter->second; + irc::sepstream stream(value, '\n'); + std::string token = "*"; - 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]) + " "; + while (stream.GetToken(token)) + { + // Writing a blank line will not work with some clients + if (token.empty()) + user->WriteNumeric(292, ' '); + else + user->WriteNumeric(292, token); + } + + user->WriteNumeric(292, " -"); + user->WriteNumeric(292, "*** End of HELPOP"); } - ServerInstance->WriteMode("oh",WM_AND,line.c_str()); + return CMD_SUCCESS; } }; -/** Thrown by m_helpop - */ -class HelpopException : public ModuleException -{ - private: - std::string err; - public: - HelpopException(std::string message) : err(message) { } - ~HelpopException() throw() { }; - virtual const char* GetReason() { return err.c_str(); } -}; - -class ModuleHelpop : public Module +class ModuleHelpop : public Module, public Whois::EventListener { - private: - std::string h_file; - cmd_helpop* mycommand; - Helpop* ho; + CommandHelpop cmd; + Helpop ho; public: - ModuleHelpop(InspIRCd* Me) - : Module::Module(Me) + ModuleHelpop() + : Whois::EventListener(this) + , cmd(this) + , ho(this) { - 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 { - helpop = new ConfigReader(ServerInstance); - if ((helpop->ReadValue("helpop_nohelp", "line1", 0) == "") || - (helpop->ReadValue("helpop_nohelpo", "line1", 0) == "") || - (helpop->ReadValue("helpop_start", "line1", 0) == "")) + HelpopMap help; + + ConfigTagList tags = ServerInstance->Config->ConfTags("helpop"); + 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; + std::string key = tag->getString("key"); + std::string value; + tag->readString("value", value, true); /* Linefeeds allowed */ + + if (key == "index") + { + throw ModuleException("m_helpop: The key 'index' is reserved for internal purposes. Please remove it."); + } + + help[key] = value; } - } - void Implements(char* List) - { - List[I_OnRehash] = List[I_OnWhois] = 1; - } + if (help.find("start") == help.end()) + { + // error! + throw ModuleException("m_helpop: Helpop file is missing important entry 'start'. Please check the example conf."); + } + else if (help.find("nohelp") == help.end()) + { + // error! + throw ModuleException("m_helpop: Helpop file is missing important entry 'nohelp'. Please check the example conf."); + } - virtual void OnRehash(const std::string ¶meter) - { - if (helpop) - DELETE(helpop); - ReadConfig(); + helpop_map.swap(help); } - virtual void OnWhois(userrec* src, userrec* dst) + void OnWhois(Whois::Context& whois) CXX11_OVERRIDE { - if (dst->IsModeSet('h')) + if (whois.GetTarget()->IsModeSet(ho)) { - ServerInstance->SendWhoisLine(src, dst, 310, std::string(src->nick)+" "+std::string(dst->nick)+" :is available for help."); + whois.SendLine(RPL_WHOISHELPOP, "is available for help."); } } - virtual ~ModuleHelpop() + Version GetVersion() CXX11_OVERRIDE { - ServerInstance->Modes->DelMode(ho); - DELETE(helpop); - DELETE(ho); + return Version("Provides the /HELPOP command for useful information", VF_VENDOR); } - - virtual Version GetVersion() - { - return Version(1,1,0,1,VF_COMMON|VF_VENDOR,API_VERSION); - } -}; - -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)