-/* +------------------------------------+
- * | 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) 2013-2015 Attila Molnar <attilamolnar@hush.com>
+ * Copyright (C) 2013, 2017-2018, 2020 Sadie Powell <sadie@witchery.services>
+ * Copyright (C) 2012, 2019 Robby <robby@chatbelgie.be>
+ * Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
+ * Copyright (C) 2009 Uli Schlachter <psychon@inspircd.org>
+ * Copyright (C) 2007-2008 Robin Burchell <robin+git@viroteck.net>
+ * Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
+ * Copyright (C) 2006-2007 Craig Edwards <brain@inspircd.org>
*
- * ---------------------------------------------------
+ * 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 "inspircd.h"
+#include "modules/whois.h"
-// Global Vars
-static ConfigReader *helpop;
-
-bool do_helpop(const char**, int, userrec*);
-void sendtohelpop(userrec*, int, const char**);
-
-/* $ModDesc: /helpop Command, Works like Unreal helpop */
-
-/** Handles user mode +h
- */
-class Helpop : public ModeHandler
+enum
{
- 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)
- {
- 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;
- }
+ // From UnrealIRCd.
+ RPL_WHOISHELPOP = 310,
+
+ // From ircd-ratbox.
+ ERR_HELPNOTFOUND = 524,
+ RPL_HELPSTART = 704,
+ RPL_HELPTXT = 705,
+ RPL_ENDOFHELP = 706
};
-/** Handles /HELPOP
- */
-class cmd_helpop : public command_t
-{
- public:
- cmd_helpop (InspIRCd* Instance) : command_t(Instance, "HELPOP", 0, 1)
- {
- this->source = "m_helpop.so";
- syntax = "[?|!]<any-text>";
- }
-
- CmdResult Handle (const char** parameters, int pcnt, userrec *user)
- {
- char a[MAXBUF];
- std::string output = " ";
-
- if (!helpop)
- return CMD_FAILURE;
-
- if (pcnt < 1)
- {
- do_helpop(NULL,pcnt,user);
- return CMD_SUCCESS;
- }
+typedef std::vector<std::string> HelpMessage;
- 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("nohelp", std::string(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("nohelpo", std::string(a), 0);
- if (output != "")
- {
- user->WriteServ("290 "+std::string(user->nick)+" :"+output);
- }
- }
- // Forward.
- sendtohelpop(user, pcnt, parameters);
- }
- }
+typedef std::map<std::string, HelpMessage, irc::insensitive_swo> HelpMap;
- return CMD_SUCCESS;
- }
+class CommandHelpop : public Command
+{
+ private:
+ const std::string startkey;
+ public:
+ HelpMap help;
+ std::string nohelp;
- bool do_helpop(const char** parameters, int pcnt, userrec *src)
+ CommandHelpop(Module* Creator)
+ : Command(Creator, "HELPOP", 0)
+ , startkey("start")
{
- char search[MAXBUF];
- std::string output = " "; // a fix bought to you by brain :p
- char a[MAXBUF];
- int nlines = 0;
-
- if (!pcnt)
- {
- strcpy(search,"start");
- }
- else
- {
- if (*parameters[0] == '?')
- parameters[0]++;
- strlcpy(search,parameters[0],MAXBUF);
- }
-
- for (char* n = search; *n; n++)
- *n = tolower(*n);
-
- for (int i = 1; output != ""; i++)
- {
- snprintf(a,MAXBUF,"line%d",i);
- output = helpop->ReadValue(search, a, 0);
- if (output != "")
- {
- src->WriteServ("290 "+std::string(src->nick)+" :"+output);
- nlines++;
- }
- }
- return (nlines>0);
+ syntax = "<any-text>";
}
- void sendtohelpop(userrec *src, int pcnt, const char **params)
+ CmdResult Handle(User* user, const Params& parameters) CXX11_OVERRIDE
{
- const char* first = params[0];
- if (*first == '!')
+ const std::string& topic = parameters.empty() ? startkey : parameters[0];
+ HelpMap::const_iterator titer = help.find(topic);
+ if (titer == help.end())
{
- first++;
+ user->WriteNumeric(ERR_HELPNOTFOUND, topic, nohelp);
+ return CMD_FAILURE;
}
- 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]) + " ";
- }
- ServerInstance->WriteMode("oh",WM_AND,line.c_str());
+ user->WriteNumeric(RPL_HELPSTART, topic, InspIRCd::Format("*** Help for %s", topic.c_str()));
+ for (HelpMessage::const_iterator liter = titer->second.begin(); liter != titer->second.end(); ++liter)
+ user->WriteNumeric(RPL_HELPTXT, topic, *liter);
+ user->WriteNumeric(RPL_ENDOFHELP, topic, "*** End of help");
+ return CMD_SUCCESS;
}
};
-/** Thrown by m_helpop
- */
-class HelpopException : public ModuleException
+class ModuleHelpop
+ : public Module
+ , public Whois::EventListener
{
private:
- std::string err;
- public:
- HelpopException(std::string message) : err(message) { }
- virtual const char* GetReason() { return err.c_str(); }
-};
-
-class ModuleHelpop : public Module
-{
- private:
- ConfigReader *conf;
- std::string h_file;
- cmd_helpop* mycommand;
- Helpop* ho;
+ CommandHelpop cmd;
+ SimpleUserModeHandler ho;
public:
- ModuleHelpop(InspIRCd* Me)
- : Module::Module(Me)
+ ModuleHelpop()
+ : Whois::EventListener(this)
+ , cmd(this)
+ , ho(this, "helpop", 'h', true)
{
- 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
{
- conf = new ConfigReader(ServerInstance);
- h_file = conf->ReadValue("helpop", "file", 0);
+ size_t longestkey = 0;
- if (h_file == "")
- {
- helpop = NULL;
- HelpopException e("Missing helpop file");
- throw(e);
- }
+ 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!");
- helpop = new ConfigReader(ServerInstance, h_file);
- if ((helpop->ReadValue("nohelp", "line1", 0) == "") ||
- (helpop->ReadValue("nohelpo", "line1", 0) == "") ||
- (helpop->ReadValue("start", "line1", 0) == ""))
+ 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;
+
+ // Attempt to read the help key.
+ const std::string key = tag->getString("key");
+ if (key.empty())
+ throw ModuleException(InspIRCd::Format("<helpop:key> is empty at %s", tag->getTagLocation().c_str()));
+ else if (irc::equals(key, "index"))
+ throw ModuleException(InspIRCd::Format("<helpop:key> 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("<helpop:value> 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);
+ newhelp[key] = helpmsg;
}
- }
- void Implements(char* List)
- {
- List[I_OnRehash] = List[I_OnWhois] = 1;
- }
+ // The number of items we can fit on a page.
+ HelpMessage& indexmsg = newhelp["index"];
+ 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;
- virtual void OnRehash(const std::string ¶meter)
- {
- DELETE(conf);
- if (helpop)
- DELETE(helpop);
+ indexline.append(iter->first);
+ if (++column != maxcolumns)
+ indexline.append(longestkey - iter->first.length() + 2, ' ');
+ iter++;
+ }
+ indexmsg.push_back(indexline);
+ }
+ cmd.help.swap(newhelp);
- ReadConfig();
+ 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);
}
- virtual void OnWhois(userrec* src, userrec* dst)
+ void OnWhois(Whois::Context& whois) CXX11_OVERRIDE
{
- if (dst->IsModeSet('h'))
- {
- src->WriteServ("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 ~ModuleHelpop()
- {
- ServerInstance->Modes->DelMode(ho);
- DELETE(conf);
- DELETE(helpop);
- DELETE(ho);
- }
-
- virtual Version GetVersion()
+ Version GetVersion() CXX11_OVERRIDE
{
- return Version(1,0,0,1,VF_COMMON|VF_VENDOR,API_VERSION);
+ return Version("Provides help to users via the HELPOP command", 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)
projects / user / henk / code / inspircd.git / blobdiff