-/* +------------------------------------+
- * | Inspire Internet Relay Chat Daemon |
- * +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
*
- * InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
- * E-mail:
- *<brain@chatspike.net>
- * <Craig@chatspike.net>
- *
- * 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 <danieldg@inspircd.org>
+ * Copyright (C) 2005-2009 Robin Burchell <robin+git@viroteck.net>
+ * Copyright (C) 2004-2006, 2008 Craig Edwards <craigedwards@brainbox.cc>
+ * Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
+ * Copyright (C) 2004-2005 Craig McLure <craig@chatspike.net>
*
- * ---------------------------------------------------
+ * 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 <http://www.gnu.org/licenses/>.
*/
-using namespace std;
-
-#include "users.h"
-#include "channels.h"
-#include "modules.h"
-#include "helperfuncs.h"
-// Global Vars
-static ConfigReader *helpop;
-static Server *Srv;
+#include "inspircd.h"
+#include "modules/whois.h"
-void handle_helpop(char**, int, userrec*);
-bool do_helpop(char**, int, userrec*);
-void sendtohelpop(userrec*, int, char**);
+enum
+{
+ // From UnrealIRCd.
+ RPL_WHOISHELPOP = 310
+};
-/* $ModDesc: /helpop Command, Works like Unreal helpop */
+typedef std::map<std::string, std::string, irc::insensitive_swo> HelpopMap;
+static HelpopMap helpop_map;
-class cmd_helpop : public command_t
+/** Handles user mode +h
+ */
+class Helpop : public SimpleUserModeHandler
{
public:
- cmd_helpop () : command_t("HELPOP",0,0)
- {
- this->source = "m_helpop.so";
- }
-
- void Handle (char **parameters, int pcnt, userrec *user)
+ Helpop(Module* Creator) : SimpleUserModeHandler(Creator, "helpop", 'h')
{
- char a[MAXBUF];
- std::string output = " ";
-
- if (!helpop)
- return;
-
- if (pcnt < 1)
- {
- do_helpop(NULL,pcnt,user);
- return;
- }
-
- 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);
-
- 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);
- }
- }
+ oper = true;
}
};
-
-bool do_helpop(char **parameters, int pcnt, userrec *src)
+/** Handles /HELPOP
+ */
+class CommandHelpop : public Command
{
- char *search;
- std::string output = " "; // a fix bought to you by brain :p
- char a[MAXBUF];
- int nlines = 0;
-
- if (!parameters)
- {
- search = "start";
- }
- else
+ const std::string startkey;
+ public:
+ CommandHelpop(Module* Creator)
+ : Command(Creator, "HELPOP", 0)
+ , startkey("start")
{
- search = parameters[0];
- }
+ syntax = "<any-text>";
+ }
- if (search[0] == '?')
+ CmdResult Handle(User* user, const Params& parameters) CXX11_OVERRIDE
{
- search++;
- }
-
- strlower(search);
+ const std::string& parameter = (!parameters.empty() ? parameters[0] : startkey);
- for (int i = 1; output != ""; i++)
- {
- snprintf(a,MAXBUF,"line%d",i);
- output = helpop->ReadValue(search, a, 0);
- if (output != "")
+ if (parameter == "index")
{
- Srv->SendTo(NULL,src,"290 "+std::string(src->nick)+" :"+output);
- nlines++;
+ /* 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");
}
- }
- return (nlines>0);
-}
+ else
+ {
+ user->WriteNumeric(290, InspIRCd::Format("*** HELPOP for %s", parameter.c_str()));
+ user->WriteNumeric(292, " -");
+ HelpopMap::const_iterator iter = helpop_map.find(parameter);
+ if (iter == helpop_map.end())
+ {
+ iter = helpop_map.find("nohelp");
+ }
-void sendtohelpop(userrec *src, int pcnt, char **params)
-{
- 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]) + " ";
- }
- Srv->SendToModeMask("oh",WM_AND,line);
-}
+ 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);
+ }
-class HelpopException : public ModuleException
-{
- private:
- std::string err;
- public:
- HelpopException(std::string message) : err(message) { }
- virtual char* GetReason() { return (char*)err.c_str(); }
+ user->WriteNumeric(292, " -");
+ user->WriteNumeric(292, "*** End of HELPOP");
+ }
+ return CMD_SUCCESS;
+ }
};
-class ModuleHelpop : public Module
+class ModuleHelpop : public Module, public Whois::EventListener
{
- private:
- ConfigReader *conf;
- std::string h_file;
- cmd_helpop* mycommand;
+ CommandHelpop cmd;
+ Helpop ho;
public:
- ModuleHelpop(Server* Me)
- : Module::Module(Me)
+ ModuleHelpop()
+ : Whois::EventListener(this)
+ , cmd(this)
+ , ho(this)
{
- Srv = Me;
-
- ReadConfig();
- if (!Srv->AddExtendedMode('h',MT_CLIENT,true,0,0))
- {
- Srv->Log(DEFAULT,"Unable to claim the +h usermode.");
- return;
- }
-
- mycommand = new cmd_helpop();
- Srv->AddCommand(mycommand);
}
- virtual void ReadConfig()
+ void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
{
- conf = new ConfigReader;
- h_file = conf->ReadValue("helpop", "file", 0);
+ HelpopMap help;
- if (h_file == "")
+ ConfigTagList tags = ServerInstance->Config->ConfTags("helpop");
+ for(ConfigIter i = tags.first; i != tags.second; ++i)
{
- helpop = NULL;
- HelpopException e("Missing helpop file");
- 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;
}
- helpop = new ConfigReader(h_file);
- if ((helpop->ReadValue("nohelp", "line1", 0) == "") ||
- (helpop->ReadValue("nohelpo", "line1", 0) == "") ||
- (helpop->ReadValue("start", "line1", 0) == ""))
+ if (help.find("start") == help.end())
{
- HelpopException e("m_helpop: Helpop file is missing important entries. Please check the example conf.");
- throw(e);
+ // error!
+ throw ModuleException("m_helpop: Helpop file is missing important entry 'start'. Please check the example conf.");
}
- }
-
- void Implements(char* List)
- {
- List[I_OnRehash] = List[I_OnExtendedMode] = List[I_OnWhois] = 1;
- }
-
- 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;
+ else if (help.find("nohelp") == help.end())
+ {
+ // error!
+ throw ModuleException("m_helpop: Helpop file is missing important entry 'nohelp'. Please check the example conf.");
}
- return 0;
+
+ helpop_map.swap(help);
}
- virtual void OnWhois(userrec* src, userrec* dst)
+ void OnWhois(Whois::Context& whois) CXX11_OVERRIDE
{
- if (strchr(dst->modes,'h'))
+ if (whois.GetTarget()->IsModeSet(ho))
{
- Srv->SendTo(NULL,src,"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
{
- delete conf;
- delete helpop;
+ return Version("Provides the /HELPOP command for useful information", VF_VENDOR);
}
-
- virtual Version GetVersion()
- {
- return Version(1,0,0,1,VF_STATIC|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)
projects / user / henk / code / inspircd.git / blobdiff