-/* +------------------------------------+
- * | 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, 2017-2018, 2020 Sadie Powell <sadie@witchery.services>
+ * Copyright (C) 2013, 2015 Attila Molnar <attilamolnar@hush.com>
+ * Copyright (C) 2012 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 Robin Burchell <robin+git@viroteck.net>
+ * Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
+ * Copyright (C) 2006 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 "helperfuncs.h"
-
-// Global Vars
-/* XXX - should all this be marked static? clear the global namespace, etc. */
-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 */
+#include "inspircd.h"
+#include "modules/whois.h"
-class cmd_helpop : public command_t
+enum
{
- public:
- cmd_helpop () : command_t("HELPOP",0,0)
- {
- this->source = "m_helpop.so";
- }
+ // From UnrealIRCd.
+ RPL_WHOISHELPOP = 310,
+
+ // From ircd-ratbox.
+ ERR_HELPNOTFOUND = 524,
+ RPL_HELPSTART = 704,
+ RPL_HELPTXT = 705,
+ RPL_ENDOFHELP = 706
+};
- void Handle (char **parameters, int pcnt, userrec *user)
- {
- char a[MAXBUF];
- std::string output = " ";
+typedef std::vector<std::string> HelpMessage;
- if (!helpop)
- return;
+struct HelpTopic
+{
+ // The body of the help topic.
+ const HelpMessage body;
- if (pcnt < 1)
- {
- do_helpop(NULL,pcnt,user);
- return;
- }
+ // The title of the help topic.
+ const std::string title;
- 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);
- }
- }
+ HelpTopic(const HelpMessage& Body, const std::string& Title)
+ : body(Body)
+ , title(Title)
+ {
}
};
+typedef std::map<std::string, HelpTopic, irc::insensitive_swo> HelpMap;
-bool do_helpop(char **parameters, int pcnt, userrec *src)
+class CommandHelpop : public Command
{
- char *search;
- std::string output = " "; // a fix bought to you by brain :p
- char a[MAXBUF];
- char lower[MAXBUF];
- int nlines = 0;
+ private:
+ const std::string startkey;
- if (!parameters)
- {
- search = "start";
- }
- else
- {
- search = parameters[0];
- }
+ public:
+ HelpMap help;
+ std::string nohelp;
- if (search[0] == '?')
+ CommandHelpop(Module* Creator)
+ : Command(Creator, "HELPOP", 0)
+ , startkey("start")
{
- search++;
- }
-
- /* XXX - don't we have an strtolower()? if not, might pay to add one.. that works on char *, preferably.. */
- strlcpy(lower, search, MAXBUF);
- for (unsigned int t = 0; t < strlen(lower); t++)
- lower[t] = tolower(lower[t]);
-
+ syntax = "<any-text>";
+ }
- 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 != "")
+ const std::string& topic = parameters.empty() ? startkey : parameters[0];
+ HelpMap::const_iterator titer = help.find(topic);
+ if (titer == help.end())
{
- Srv->SendTo(NULL,src,"290 "+std::string(src->nick)+" :"+output);
- nlines++;
+ 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 == '!')
- {
- first++;
+ const HelpTopic& entry = titer->second;
+ user->WriteNumeric(RPL_HELPSTART, topic, entry.title);
+ for (HelpMessage::const_iterator liter = entry.body.begin(); liter != entry.body.end(); ++liter)
+ user->WriteNumeric(RPL_HELPTXT, topic, *liter);
+ user->WriteNumeric(RPL_ENDOFHELP, topic, "End of /HELPOP.");
+ return CMD_SUCCESS;
}
-
- 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);
-}
-
-class HelpopException
-{
- private:
- std::string err;
- public:
- HelpopException(std::string message) : err(message) { }
- virtual char* GetReason() { return (char*)err.c_str(); }
};
-class ModuleHelpop : public Module
+class ModuleHelpop
+ : public Module
+ , public Whois::EventListener
{
- private:
- ConfigReader *conf;
- std::string h_file;
- cmd_helpop* mycommand;
+ private:
+ CommandHelpop cmd;
+ SimpleUserModeHandler ho;
public:
- ModuleHelpop(Server* Me)
- : Module::Module(Me)
+ ModuleHelpop()
+ : Whois::EventListener(this)
+ , cmd(this)
+ , ho(this, "helpop", 'h', true)
{
- 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);
+ 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(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);
+
+ // Read the help title and store the topic.
+ const std::string title = tag->getString("title", InspIRCd::Format("*** Help for %s", key.c_str()), 1);
+ if (!newhelp.insert(std::make_pair(key, HelpTopic(helpmsg, title))).second)
+ {
+ throw ModuleException(InspIRCd::Format("<helpop> tag with duplicate key '%s' at %s",
+ key.c_str(), tag->getTagLocation().c_str()));
+ }
}
- }
-
- 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();
- }
+ // The number of items we can fit on a page.
+ HelpMessage indexmsg;
+ 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 int OnExtendedMode(userrec* user, void* target, char modechar, int type, bool mode_on, string_list ¶ms)
- {
- if ((modechar == 'h') && (type == MT_CLIENT))
- {
- return 1;
+ indexline.append(iter->first);
+ if (++column != maxcolumns)
+ indexline.append(longestkey - iter->first.length() + 2, ' ');
+ iter++;
+ }
+ indexmsg.push_back(indexline);
}
- return 0;
- }
+ newhelp.insert(std::make_pair("index", HelpTopic(indexmsg, "List of help topics")));
+ cmd.help.swap(newhelp);
- virtual void OnWhois(userrec* src, userrec* dst)
- {
- if (strchr(dst->modes,'h'))
- {
- Srv->SendTo(NULL,src,"310 "+std::string(src->nick)+" "+std::string(dst->nick)+" :is available for help.");
- }
+ 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 ~ModuleHelpop()
+ void OnWhois(Whois::Context& whois) CXX11_OVERRIDE
{
- delete conf;
- delete helpop;
+ if (whois.GetTarget()->IsModeSet(ho))
+ whois.SendLine(RPL_WHOISHELPOP, "is available for help.");
}
-
- virtual Version GetVersion()
+
+ Version GetVersion() CXX11_OVERRIDE
{
- return Version(1,0,0,1,VF_STATIC|VF_VENDOR);
+ return Version("Adds the /HELPOP command which allows users to view help on various topics and user mode h (helpop) which marks a server operator as being available for help.", 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