-/* +------------------------------------+
- * | Inspire Internet Relay Chat Daemon |
- * +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
*
- * Inspire is copyright (C) 2002-2004 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/>.
*/
-#include "users.h"
-#include "channels.h"
-#include "modules.h"
-#include "helperfuncs.h"
-// Global Vars
-ConfigReader *helpop;
-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,
+
+ // From ircd-ratbox.
+ ERR_HELPNOTFOUND = 524,
+ RPL_HELPSTART = 704,
+ RPL_HELPTXT = 705,
+ RPL_ENDOFHELP = 706
+};
+typedef std::vector<std::string> HelpMessage;
-/* $ModDesc: /helpop Command, Works like Unreal helpop */
+typedef std::map<std::string, HelpMessage, irc::insensitive_swo> HelpMap;
-void handle_helpop(char **parameters, int pcnt, userrec *user)
+class CommandHelpop : public Command
{
- char a[MAXBUF];
- std::string output = " ";
+ private:
+ const std::string startkey;
- if (pcnt < 1) {
- do_helpop(NULL,pcnt,user);
- return;
- }
+ public:
+ HelpMap help;
+ std::string nohelp;
- if (parameters[0][0] == '!')
+ CommandHelpop(Module* Creator)
+ : Command(Creator, "HELPOP", 0)
+ , startkey("start")
{
- // 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 {
- // 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);
- }
+ syntax = "<any-text>";
}
-}
-bool do_helpop(char **parameters, int pcnt, userrec *src)
-{
- char *search;
- std::string output = " "; // a fix bought to you by brain :p
- char a[MAXBUF];
-
- if (!parameters) {
- search = "start";
- }
- else {
- search = parameters[0];
- }
-
- if (search[0] == '?') {
- search++;
- }
-
- // FIX by brain: make the string lowercase, ConfigReader is
- // case sensitive
- char lower[MAXBUF];
- strlcpy(lower,search,MAXBUF);
- for (int t = 0; t < strlen(lower); t++)
- lower[t] = tolower(lower[t]);
-
-
- int nlines = 0;
- for (int i = 1; output != ""; i++)
+ CmdResult Handle(User* user, const Params& parameters) CXX11_OVERRIDE
{
- snprintf(a,MAXBUF,"line%d",i);
- output = helpop->ReadValue(lower, a, 0);
- if (output != "") {
- Srv->SendTo(NULL,src,"290 "+std::string(src->nick)+" :"+output);
- nlines++;
+ const std::string& topic = parameters.empty() ? startkey : parameters[0];
+ HelpMap::const_iterator titer = help.find(topic);
+ if (titer == help.end())
+ {
+ user->WriteNumeric(ERR_HELPNOTFOUND, topic, nohelp);
+ return CMD_FAILURE;
}
- }
- return (nlines>0);
-}
-
-
-void sendtohelpop(userrec *src, int pcnt, char **params)
-{
- 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++)
- {
- line = line + std::string(params[i]) + " ";
+ 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;
}
- Srv->SendToModeMask("oh",WM_AND,line);
-}
+};
-class ModuleHelpop : public Module
+class ModuleHelpop
+ : public Module
+ , public Whois::EventListener
{
private:
- ConfigReader *conf;
- std::string h_file;
-
- public:
- ModuleHelpop()
- {
- Srv = new Server;
- conf = new ConfigReader;
-
- h_file = conf->ReadValue("helpop", "file", 0);
-
- if (h_file == "") {
- log(DEFAULT,"m_helpop: Helpop file not Specified.");
- return;
- }
-
- helpop = new ConfigReader(h_file);
-
- if ((helpop->ReadValue("nohelp", "line1", 0) == "") ||
- (helpop->ReadValue("nohelpo", "line1", 0) == "") ||
- (helpop->ReadValue("start", "line1", 0) == ""))
+ CommandHelpop cmd;
+ SimpleUserModeHandler ho;
+
+ public:
+ ModuleHelpop()
+ : Whois::EventListener(this)
+ , cmd(this)
+ , ho(this, "helpop", 'h', true)
{
- log(DEFAULT,"m_helpop: Helpop file is missing important entries. Please check the example conf.");
- return;
}
- if (!Srv->AddExtendedMode('h',MT_CLIENT,true,0,0))
+ void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
{
- Srv->Log(DEFAULT,"Unable to claim the +h usermode.");
- return;
- }
-
- // Loads of comments, untill supported properly.
- Srv->AddCommand("HELPOP",handle_helpop,0,0,"m_helpop.so");
-
- }
+ size_t longestkey = 0;
+
+ 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!");
+
+ for (ConfigIter i = tags.first; i != tags.second; ++i)
+ {
+ 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;
+ }
+
+ // 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;
+
+ indexline.append(iter->first);
+ if (++column != maxcolumns)
+ indexline.append(longestkey - iter->first.length() + 2, ' ');
+ iter++;
+ }
+ indexmsg.push_back(indexline);
+ }
+ cmd.help.swap(newhelp);
- 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;
+ 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);
}
- return 0;
- }
- virtual void OnWhois(userrec* src, userrec* dst)
- {
- if (strchr(dst->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(1,0,0,1,VF_STATIC|VF_VENDOR);
- }
-};
-class ModuleHelpopFactory : public ModuleFactory
-{
- public:
- ModuleHelpopFactory()
- {
- }
-
- ~ModuleHelpopFactory()
- {
- }
-
- virtual Module * CreateModule()
- {
- return new ModuleHelpop;
- }
-
+ Version GetVersion() CXX11_OVERRIDE
+ {
+ return Version("Provides help to users via the HELPOP command", VF_VENDOR);
+ }
};
-extern "C" void * init_module( void )
-{
- return new ModuleHelpopFactory;
-}
+MODULE_INIT(ModuleHelpop)
projects / user / henk / code / inspircd.git / blobdiff