X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=src%2Fmodules%2Fm_helpop.cpp;h=4bbe8785e4ef4f7b2f22d059b56f81682eb8d6fe;hb=91c34d4e971dcc9370d205ff6d8189cd92f1d556;hp=cc78c3257bd5d622e391c52b02a208576662fb67;hpb=b8fc8b8ea60300424e964f093122c46ac7905f7e;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/src/modules/m_helpop.cpp b/src/modules/m_helpop.cpp index cc78c3257..4bbe8785e 100644 --- a/src/modules/m_helpop.cpp +++ b/src/modules/m_helpop.cpp @@ -1,82 +1,74 @@ -/* +------------------------------------+ - * | 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) 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 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" + +/* $ModDesc: Provides the /HELPOP command for useful information */ + #include "inspircd.h" -/* $ModDesc: /helpop Command, Works like Unreal helpop */ static std::map 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 { 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) - { - irc::string parameter = parameters[0]; + CommandHelpop(Module* Creator) : Command(Creator, "HELPOP", 0) + { + syntax = ""; + } - user->WriteServ("NOTICE %s :*** HELPOP for %s", user->nick, parameters[0]); + CmdResult Handle (const std::vector ¶meters, User *user) + { + irc::string parameter("start"); + if (parameters.size() > 0) + parameter = parameters[0].c_str(); if (parameter == "index") { /* iterate over all helpop items */ + user->WriteServ("290 %s :HELPOP topic index", user->nick.c_str()); for (std::map::iterator iter = helpop_map.begin(); iter != helpop_map.end(); iter++) { - user->WriteServ("NOTICE %s :HELPOP KEY: %s", user->nick, iter->first.c_str()); + user->WriteServ("292 %s : %s", user->nick.c_str(), iter->first.c_str()); } + user->WriteServ("292 %s :*** End of HELPOP topic index", user->nick.c_str()); } else { + user->WriteServ("290 %s :*** HELPOP for %s", user->nick.c_str(), parameter.c_str()); + user->WriteServ("292 %s : -", user->nick.c_str()); + std::map::iterator iter = helpop_map.find(parameter); if (iter == helpop_map.end()) @@ -88,131 +80,94 @@ class cmd_helpop : public command_t irc::sepstream stream(value, '\n'); std::string token = "*"; - while ((token = stream.GetToken()) != "") + while (stream.GetToken(token)) { - user->WriteServ("NOTICE %s :%s", user->nick, token.c_str()); + // Writing a blank line will not work with some clients + if (token.empty()) + user->WriteServ("292 %s : ", user->nick.c_str()); + else + user->WriteServ("292 %s :%s", user->nick.c_str(), token.c_str()); } - } - user->WriteServ("NOTICE %s :*** HELPOP End", user->nick); + user->WriteServ("292 %s : -", user->nick.c_str()); + user->WriteServ("292 %s :*** End of HELPOP", user->nick.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 { private: - std::string h_file; - cmd_helpop* mycommand; - Helpop* ho; + CommandHelpop cmd; + Helpop ho; public: - ModuleHelpop(InspIRCd* Me) - : Module::Module(Me) + ModuleHelpop() + : 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 init() { - ConfigReader *MyConf = new ConfigReader(ServerInstance); + ReadConfig(); + ServerInstance->Modules->AddService(ho); + ServerInstance->Modules->AddService(cmd); + Implementation eventlist[] = { I_OnRehash, I_OnWhois }; + ServerInstance->Modules->Attach(eventlist, this, sizeof(eventlist)/sizeof(Implementation)); + } - helpop_map.clear(); + void ReadConfig() + { + std::map help; - for (int i = 0; i < MyConf->Enumerate("helpop"); i++) + ConfigTagList tags = ServerInstance->Config->ConfTags("helpop"); + 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); + ConfigTag* tag = i->second; + irc::string key = assign(tag->getString("key")); + std::string value; + tag->readString("value", value, true); /* Linefeeds allowed */ if (key == "index") { - HelpopException e("m_helpop: The key 'index' is reserved for internal purposes. Please remove it."); - throw(e); + throw ModuleException("m_helpop: The key 'index' is reserved for internal purposes. Please remove it."); } - helpop_map[key] = value; + help[key] = value; } - if (helpop_map.find("start") == helpop_map.end()) + if (help.find("start") == help.end()) { // error! - HelpopException e("m_helpop: Helpop file is missing important entries. Please check the example conf."); - throw(e); + throw ModuleException("m_helpop: Helpop file is missing important entry 'start'. Please check the example conf."); } - else if (helpop_map.find("nohelp") == helpop_map.end()) + else if (help.find("nohelp") == help.end()) { // error! - HelpopException e("m_helpop: Helpop file is missing important entries. Please check the example conf."); - throw(e); + throw ModuleException("m_helpop: Helpop file is missing important entry 'nohelp'. Please check the example conf."); } + helpop_map.swap(help); } - void Implements(char* List) - { - List[I_OnRehash] = List[I_OnWhois] = 1; - } - - virtual void OnRehash(const std::string ¶meter) + void OnRehash(User* user) { ReadConfig(); } - virtual void OnWhois(userrec* src, userrec* dst) + void OnWhois(User* src, User* dst) { if (dst->IsModeSet('h')) { - ServerInstance->SendWhoisLine(src, dst, 310, std::string(src->nick)+" "+std::string(dst->nick)+" :is available for help."); + ServerInstance->SendWhoisLine(src, dst, 310, src->nick+" "+dst->nick+" :is available for help."); } } - virtual ~ModuleHelpop() - { - ServerInstance->Modes->DelMode(ho); - DELETE(ho); - } - - virtual Version GetVersion() + Version GetVersion() { - return Version(1,1,0,1,VF_COMMON|VF_VENDOR,API_VERSION); + return Version("Provides the /HELPOP command for useful information", 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)