* | Inspire 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.
+ * InspIRCd: (C) 2002-2008 InspIRCd Development Team
+ * See: http://www.inspircd.org/wiki/index.php/Credits
+ *
* This program is free but copyrighted software; see
* the file COPYING for details.
*
* ---------------------------------------------------
*/
-#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**);
-
+#include "inspircd.h"
/* $ModDesc: /helpop Command, Works like Unreal helpop */
+static std::map<irc::string, std::string> helpop_map;
-void handle_helpop(char **parameters, int pcnt, userrec *user)
-{
- char a[MAXBUF];
- std::string output = " ";
- if (pcnt < 1) {
- do_helpop(NULL,pcnt,user);
- return;
- }
+/** Handles user mode +h
+ */
+class Helpop : public ModeHandler
+{
+ public:
+ Helpop(InspIRCd* Instance) : ModeHandler(Instance, 'h', 0, 0, false, MODETYPE_USER, true) { }
- if (parameters[0][0] == '!')
+ ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string ¶meter, bool adding, bool)
{
- // 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);
+ 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;
}
-}
+};
-bool do_helpop(char **parameters, int pcnt, userrec *src)
+/** Handles /HELPOP
+ */
+class CommandHelpop : public Command
{
- 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++)
+ public:
+ CommandHelpop (InspIRCd* Instance) : Command(Instance, "HELPOP", 0, 0)
{
- 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++;
- }
+ this->source = "m_helpop.so";
+ syntax = "<any-text>";
}
- return (nlines>0);
-}
+ CmdResult Handle (const char* const* parameters, int pcnt, User *user)
+ {
+ irc::string parameter("start");
+ if (pcnt > 0)
+ parameter = parameters[0];
+ if (parameter == "index")
+ {
+ /* iterate over all helpop items */
+ user->WriteServ("NOTICE %s :HELPOP topic index", user->nick);
+ for (std::map<irc::string, std::string>::iterator iter = helpop_map.begin(); iter != helpop_map.end(); iter++)
+ {
+ user->WriteServ("NOTICE %s : %s", user->nick, iter->first.c_str());
+ }
+ user->WriteServ("NOTICE %s :*** End of HELPOP topic index", user->nick);
+ }
+ else
+ {
+ user->WriteServ("NOTICE %s :*** HELPOP for %s", user->nick, parameter.c_str());
-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]) + " ";
- }
- Srv->SendToModeMask("oh",WM_AND,line);
-}
+ std::map<irc::string, std::string>::iterator iter = helpop_map.find(parameter);
-class ModuleHelpop : public Module
-{
- private:
- ConfigReader *conf;
- std::string h_file;
+ if (iter == helpop_map.end())
+ {
+ iter = helpop_map.find("nohelp");
+ }
- public:
- ModuleHelpop()
- {
- Srv = new Server;
- conf = new ConfigReader;
+ std::string value = iter->second;
+ irc::sepstream stream(value, '\n');
+ std::string token = "*";
- h_file = conf->ReadValue("helpop", "file", 0);
+ while (stream.GetToken(token))
+ user->WriteServ("NOTICE %s :%s", user->nick, token.c_str());
- if (h_file == "") {
- printf("m_helpop: Helpop file not Specified.");
- exit(0);
+ user->WriteServ("NOTICE %s :*** End of HELPOP", user->nick);
}
- helpop = new ConfigReader(h_file);
+ /* We dont want these going out over the network, return CMD_FAILURE
+ * to make sure the protocol module thinks theyre not worth sending.
+ */
+ return CMD_FAILURE;
+ }
+};
- if ((helpop->ReadValue("nohelp", "line1", 0) == "") ||
- (helpop->ReadValue("nohelpo", "line1", 0) == "") ||
- (helpop->ReadValue("start", "line1", 0) == ""))
+class ModuleHelpop : public Module
+{
+ private:
+ std::string h_file;
+ CommandHelpop* mycommand;
+ Helpop* ho;
+
+ public:
+ ModuleHelpop(InspIRCd* Me)
+ : Module(Me)
{
- printf("m_helpop: Helpop file is missing important entries. Please check the example conf.");
- exit(0);
+ ReadConfig();
+ ho = new Helpop(ServerInstance);
+ if (!ServerInstance->Modes->AddMode(ho))
+ throw ModuleException("Could not add new modes!");
+ mycommand = new CommandHelpop(ServerInstance);
+ ServerInstance->AddCommand(mycommand);
+ Implementation eventlist[] = { I_OnRehash, I_OnWhois };
+ ServerInstance->Modules->Attach(eventlist, this, 2);
}
- if (!Srv->AddExtendedMode('h',MT_CLIENT,true,0,0))
+ virtual void ReadConfig()
{
- Srv->Log(DEFAULT,"Unable to claim the +h usermode.");
- printf("m_helpop: Unable to claim the +h usermode!");
- exit(0);
- }
+ ConfigReader *MyConf = new ConfigReader(ServerInstance);
- // Loads of comments, untill supported properly.
- Srv->AddCommand("HELPOP",handle_helpop,0,0);
+ helpop_map.clear();
- }
+ for (int i = 0; i < MyConf->Enumerate("helpop"); i++)
+ {
+ irc::string key = assign(MyConf->ReadValue("helpop", "key", i));
+ std::string value = MyConf->ReadValue("helpop", "value", i, true); /* Linefeeds allowed! */
+
+ if (key == "index")
+ {
+ throw ModuleException("m_helpop: The key 'index' is reserved for internal purposes. Please remove it.");
+ }
+
+ helpop_map[key] = value;
+ }
+
+ if (helpop_map.find("start") == helpop_map.end())
+ {
+ // error!
+ throw ModuleException("m_helpop: Helpop file is missing important entries. Please check the example conf.");
+ }
+ else if (helpop_map.find("nohelp") == helpop_map.end())
+ {
+ // error!
+ throw ModuleException("m_helpop: Helpop file is missing important entries. Please check the example conf.");
+ }
- 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;
}
- return 0;
- }
- virtual void OnWhois(userrec* src, userrec* dst)
- {
- if (strchr(dst->modes,'h'))
+
+ virtual void OnRehash(User* user, const std::string ¶meter)
{
- Srv->SendTo(NULL,src,"310 "+std::string(src->nick)+" "+std::string(dst->nick)+" :is available for help.");
+ ReadConfig();
}
- }
- 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);
- }
-};
+ virtual void OnWhois(User* src, User* dst)
+ {
+ if (dst->IsModeSet('h'))
+ {
+ ServerInstance->SendWhoisLine(src, dst, 310, std::string(src->nick)+" "+std::string(dst->nick)+" :is available for help.");
+ }
+ }
-class ModuleHelpopFactory : public ModuleFactory
-{
- public:
- ModuleHelpopFactory()
- {
- }
-
- ~ModuleHelpopFactory()
- {
- }
-
- virtual Module * CreateModule()
- {
- return new ModuleHelpop;
- }
+ virtual ~ModuleHelpop()
+ {
+ ServerInstance->Modes->DelMode(ho);
+ delete ho;
+ }
+ virtual Version GetVersion()
+ {
+ return Version(1,1,0,1,VF_COMMON|VF_VENDOR,API_VERSION);
+ }
};
-extern "C" void * init_module( void )
-{
- return new ModuleHelpopFactory;
-}
+MODULE_INIT(ModuleHelpop)