-#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**);
-
-
-/* $ModDesc: /helpop Command, Works like Unreal helpop */
-
-void handle_helpop(char **parameters, int pcnt, userrec *user)
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
+ *
+ * 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/>.
+ */
+
+
+#include "inspircd.h"
+#include "modules/whois.h"
+
+enum
{
- char a[MAXBUF];
- std::string output = " ";
-
- if (pcnt < 1) {
- do_helpop(NULL,pcnt,user);
- return;
- }
-
- // 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]);
+ // From UnrealIRCd.
+ RPL_WHOISHELPOP = 310
+};
- 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 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);
- }
- }
-}
+typedef std::map<std::string, std::string, irc::insensitive_swo> HelpopMap;
+static HelpopMap helpop_map;
-bool do_helpop(char **parameters, int pcnt, userrec *src)
+/** Handles user mode +h
+ */
+class Helpop : public SimpleUserModeHandler
{
- char *search;
- std::string output = " "; // a fix bought to you by brain :p
- char a[MAXBUF];
-
- if (!parameters) { strcpy(search, "start"); }
- else { search = parameters[0]; }
-
- if (search[0] == '?') { search++; }
-
- // Make sure it exists.
- if (helpop->ReadValue(std::string(search), "line1", 0) == "")
- {
- // Tell caller..
- return false;
- }
-
- // Somethings there.. tell the person who wants to know :p
-
- for (int i = 1; output != ""; i++)
+ public:
+ Helpop(Module* Creator) : SimpleUserModeHandler(Creator, "helpop", 'h')
{
- 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);
- }
+ oper = true;
}
- return true;
-}
-
-
+};
-void sendtohelpop(userrec *src, int pcnt, char **params)
+/** Handles /HELPOP
+ */
+class CommandHelpop : public Command
{
- 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++)
+ const std::string startkey;
+ public:
+ CommandHelpop(Module* Creator)
+ : Command(Creator, "HELPOP", 0)
+ , startkey("start")
{
- line = line + std::string(params[i]) + " ";
+ syntax = "<any-text>";
}
- Srv->SendToModeMask("oh",WM_AND,line);
-}
-
-class ModuleHelpop : public Module
-{
- private:
- ConfigReader *conf;
- std::string h_file;
- public:
- ModuleHelpop()
+ CmdResult Handle(User* user, const Params& parameters) CXX11_OVERRIDE
{
- 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);
- }
+ const std::string& parameter = (!parameters.empty() ? parameters[0] : startkey);
- helpop = new ConfigReader(h_file);
- if (!helpop->Verify())
+ if (parameter == "index")
{
- printf("m_helpop: Invalid Helpop File. Please Ensure it exists and is error free.");
- exit(0);
+ /* 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");
}
-
- /*if ((helpop->ReadValue("nohelp", "line1", 0) == "") ||
- (helpop->ReadValue("nohelpo", "line1", 0) == "") ||
- (helpop->ReadValue("start", "line1", 0) == ""))
+ else
{
- printf("m_helpop: Helpop file is missing important entries. Please check the example conf.");
- exit(0);
- }*/
+ 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");
+ }
+
+ const std::string& value = iter->second;
+ irc::sepstream stream(value, '\n');
+ std::string token = "*";
+
+ 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");
+ }
+ return CMD_SUCCESS;
+ }
+};
- if (!Srv->AddExtendedMode('h',MT_CLIENT,true,0,0))
+class ModuleHelpop : public Module, public Whois::EventListener
+{
+ CommandHelpop cmd;
+ Helpop ho;
+
+ public:
+ ModuleHelpop()
+ : Whois::EventListener(this)
+ , cmd(this)
+ , ho(this)
{
- Srv->Log(DEFAULT,"Unable to clame the +h usermode.");
- printf("m_helpop: Unable to claim the +h usermode!");
- exit(0);
}
- // Loads of comments, untill supported properly.
- /*if (!*/Srv->AddCommand("HELPOP",handle_helpop,0,0);/*)
+ void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
{
- Srv->Log(DEFAULT,"Unable to claim the HELPOP command.");
- printf("m_helpop: Unable to claim the HELPOP command.");
- exit(0);
- }*/
-
- }
+ HelpopMap help;
+
+ ConfigTagList tags = ServerInstance->Config->ConfTags("helpop");
+ for(ConfigIter i = tags.first; i != tags.second; ++i)
+ {
+ 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.");
+ }
- 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;
+ help[key] = value;
+ }
+
+ 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.");
+ }
+
+ helpop_map.swap(help);
}
- return 0;
- }
- virtual void OnWhois(userrec* src, userrec* dst) {
- if (strchr(src->modes,'h'))
+ void OnWhois(Whois::Context& whois) CXX11_OVERRIDE
{
- Srv->SendTo(NULL,src,"310 "+std::string(src->nick)+" "+std::string(dst->nick)+" :is available for help.");
+ if (whois.GetTarget()->IsModeSet(ho))
+ {
+ whois.SendLine(RPL_WHOISHELPOP, "is available for help.");
+ }
}
- }
- 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 <nick> +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;
- }
-
+ Version GetVersion() CXX11_OVERRIDE
+ {
+ return Version("Provides the /HELPOP command for useful information", VF_VENDOR);
+ }
};
-extern "C" void * init_module( void )
-{
- return new ModuleHelpopFactory;
-}
+MODULE_INIT(ModuleHelpop)
projects / user / henk / code / inspircd.git / blobdiff