-/* +------------------------------------+
- * | 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"
-#include "inspircd.h"
-
-// Global Vars
-static ConfigReader *helpop;
-static Server *Srv;
-extern InspIRCd* ServerInstance;
+/* $ModDesc: Provides the /HELPOP command for useful information */
-bool do_helpop(const char**, int, userrec*);
-void sendtohelpop(userrec*, int, const char**);
+#include "inspircd.h"
-/* $ModDesc: /helpop Command, Works like Unreal helpop */
+static std::map<irc::string, std::string> helpop_map;
-class Helpop : public ModeHandler
+/** Handles user mode +h
+ */
+class Helpop : public SimpleUserModeHandler
{
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)
+ Helpop(Module* Creator) : SimpleUserModeHandler(Creator, "helpop", 'h')
{
- 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;
+ oper = true;
}
};
-class cmd_helpop : public command_t
+/** Handles /HELPOP
+ */
+class CommandHelpop : public Command
{
public:
- cmd_helpop () : command_t("HELPOP",0,1)
- {
- this->source = "m_helpop.so";
- syntax = "[?|!]<any-text>";
- }
-
- void Handle (const char** parameters, int pcnt, userrec *user)
+ CommandHelpop(Module* Creator) : Command(Creator, "HELPOP", 0)
{
- char a[MAXBUF];
- std::string output = " ";
-
- if (!helpop)
- return;
+ syntax = "<any-text>";
+ }
- if (pcnt < 1)
- {
- do_helpop(NULL,pcnt,user);
- return;
- }
+ CmdResult Handle (const std::vector<std::string> ¶meters, User *user)
+ {
+ irc::string parameter("start");
+ if (parameters.size() > 0)
+ parameter = parameters[0].c_str();
- if (*parameters[0] == '!')
- {
- // Force send to all +h users
- sendtohelpop(user, pcnt, parameters);
- }
- else if (*parameters[0] == '?')
+ if (parameter == "index")
{
- // Force to the helpop system with no forward if not found.
- if (do_helpop(parameters, pcnt, user) == false)
+ /* iterate over all helpop items */
+ user->WriteServ("290 %s :HELPOP topic index", user->nick.c_str());
+ for (std::map<irc::string, std::string>::iterator iter = helpop_map.begin(); iter != helpop_map.end(); iter++)
{
- // 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);
- }
- }
+ user->WriteServ("292 %s : %s", user->nick.c_str(), iter->first.c_str());
}
+ user->WriteServ("292 %s :*** End of HELPOP topic index", user->nick.c_str());
}
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);
- }
- }
- }
-};
+ user->WriteServ("290 %s :*** HELPOP for %s", user->nick.c_str(), parameter.c_str());
+ user->WriteServ("292 %s : -", user->nick.c_str());
+ std::map<irc::string, std::string>::iterator iter = helpop_map.find(parameter);
-bool do_helpop(const char** parameters, int pcnt, userrec *src)
-{
- char search[MAXBUF];
- std::string output = " "; // a fix bought to you by brain :p
- char a[MAXBUF];
- int nlines = 0;
+ if (iter == helpop_map.end())
+ {
+ iter = helpop_map.find("nohelp");
+ }
- if (!pcnt)
- {
- strcpy(search,"start");
- }
- else
- {
- if (*parameters[0] == '?')
- parameters[0]++;
- strlcpy(search,parameters[0],MAXBUF);
- }
+ std::string value = iter->second;
+ irc::sepstream stream(value, '\n');
+ std::string token = "*";
- for (char* n = search; *n; n++)
- *n = tolower(*n);
+ while (stream.GetToken(token))
+ {
+ // Writing a blank line will not work with some clients
+ if (token.empty())
+ user->WriteServ("292 %s : ", user->nick.c_str());
+ else
+ user->WriteServ("292 %s :%s", user->nick.c_str(), token.c_str());
+ }
- 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++;
+ user->WriteServ("292 %s : -", user->nick.c_str());
+ user->WriteServ("292 %s :*** End of HELPOP", user->nick.c_str());
}
+ return CMD_SUCCESS;
}
- return (nlines>0);
-}
-
-
-
-void sendtohelpop(userrec *src, int pcnt, const char **params)
-{
- const char* first = params[0];
- if (*first == '!')
- {
- 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]) + " ";
- }
- ServerInstance->WriteMode("oh",WM_AND,line.c_str());
-}
-
-class HelpopException : public ModuleException
-{
- 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;
+ Helpop ho;
public:
- ModuleHelpop(InspIRCd* Me)
- : Module::Module(Me)
+ ModuleHelpop()
+ : cmd(this), ho(this)
+ {
+ }
+
+ void init()
{
ReadConfig();
- ho = new Helpop(ServerInstance);
- Srv->AddMode(ho, 'h');
- mycommand = new cmd_helpop();
- Srv->AddCommand(mycommand);
+ ServerInstance->Modules->AddService(ho);
+ ServerInstance->Modules->AddService(cmd);
+ Implementation eventlist[] = { I_OnRehash, I_OnWhois };
+ ServerInstance->Modules->Attach(eventlist, this, sizeof(eventlist)/sizeof(Implementation));
}
- virtual void ReadConfig()
+ void ReadConfig()
{
- conf = new ConfigReader;
- h_file = conf->ReadValue("helpop", "file", 0);
+ std::map<irc::string, std::string> 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;
+ irc::string key = assign(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.");
+ }
+ else if (help.find("nohelp") == help.end())
+ {
+ // error!
+ throw ModuleException("m_helpop: Helpop file is missing important entry 'nohelp'. Please check the example conf.");
}
- }
- void Implements(char* List)
- {
- List[I_OnRehash] = List[I_OnWhois] = 1;
+ helpop_map.swap(help);
}
- virtual void OnRehash(const std::string ¶meter)
+ void OnRehash(User* user)
{
- DELETE(conf);
- if (helpop)
- DELETE(helpop);
-
ReadConfig();
}
- virtual void OnWhois(userrec* src, userrec* dst)
+ void OnWhois(User* src, User* dst)
{
if (dst->IsModeSet('h'))
{
- src->WriteServ("310 "+std::string(src->nick)+" "+std::string(dst->nick)+" :is available for help.");
+ ServerInstance->SendWhoisLine(src, dst, 310, src->nick+" "+dst->nick+" :is available for help.");
}
}
- virtual ~ModuleHelpop()
- {
- DELETE(conf);
- DELETE(helpop);
- DELETE(ho);
- }
-
- virtual Version GetVersion()
+ Version GetVersion()
{
- return Version(1,0,0,1,VF_STATIC|VF_VENDOR);
+ return Version("Provides the /HELPOP command for useful information", 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