]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_helpop.cpp
Windows support. Tested and working to compile on freebsd and linux. Next step is...
[user/henk/code/inspircd.git] / src / modules / m_helpop.cpp
index 00ba05c243aa1be5d1c497a3d9b2b7840eadf918..5a02f2bf08291d84626de06fb67d1a2d84554e0a 100644 (file)
@@ -1,42 +1,31 @@
-/*   +------------------------------------+
- *   | Inspire Internet Relay Chat Daemon |
- *   +------------------------------------+
+/*       +------------------------------------+
+ *       | Inspire Internet Relay Chat Daemon |
+ *       +------------------------------------+
+ *
+ *  InspIRCd: (C) 2002-2007 InspIRCd Development Team
+ * See: http://www.inspircd.org/wiki/index.php/Credits
  *
- *  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.
+ *            the file COPYING for details.
  *
  * ---------------------------------------------------
  */
 
-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;
-
-bool do_helpop(const char**, int, userrec*);
-void sendtohelpop(userrec*, int, const char**);
-
 /* $ModDesc: /helpop Command, Works like Unreal helpop */
+static std::map<irc::string, std::string> helpop_map;
+
 
+/** Handles user mode +h
+ */
 class Helpop : public ModeHandler
 {
  public:
-       Helpop() : ModeHandler('h', 0, 0, false, MODETYPE_USER, true) { }
+       Helpop(InspIRCd* Instance) : ModeHandler(Instance, 'h', 0, 0, false, MODETYPE_USER, true) { }
 
        ModeAction OnModeChange(userrec* source, userrec* dest, chanrec* channel, std::string &parameter, bool adding)
        {
@@ -61,178 +50,112 @@ class Helpop : public ModeHandler
        }
 };
 
+/** Handles /HELPOP
+ */
 class cmd_helpop : public command_t
 {
  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)
+       cmd_helpop (InspIRCd* Instance) : command_t(Instance, "HELPOP", 0, 0)
        {
-               char a[MAXBUF];
-               std::string output = " ";
-
-               if (!helpop)
-                       return;
+               this->source = "m_helpop.so";
+               syntax = "<any-text>";
+       }
 
-               if (pcnt < 1)
-               {
-                       do_helpop(NULL,pcnt,user);
-                       return;
-               }
+       CmdResult Handle (const char** parameters, int pcnt, userrec *user)
+       {
+               irc::string parameter;
+               if (pcnt > 0)
+                       parameter = parameters[0];
 
-               if (*parameters[0] == '!')
-               {
-                       // Force send to all +h users
-                       sendtohelpop(user, pcnt, parameters);
-               }
-               else if (*parameters[0] == '?')
+               if (pcnt == 0 || 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("NOTICE %s :HELPOP topic index", user->nick);
+                       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("NOTICE %s :    %s", user->nick, iter->first.c_str());                          
                        }
+                       user->WriteServ("NOTICE %s :*** End of HELPOP topic index", user->nick);
                }
                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("NOTICE %s :*** HELPOP for %s", user->nick, parameters[0]);
 
+                       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 ((token = stream.GetToken()) != "")
+                       {
+                               user->WriteServ("NOTICE %s :%s", user->nick, 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("NOTICE %s :*** End of HELPOP", user->nick);
                }
-       }
-       return (nlines>0);
-}
-
 
-
-void sendtohelpop(userrec *src, int pcnt, const char **params)
-{
-       const char* first = params[0];
-       if (*first == '!')
-       {
-               first++;
+               /* 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;
        }
-
-       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;
 
        public:
-               ModuleHelpop(Server* Me)
-                       : Module::Module(Me)
+               ModuleHelpop(InspIRCd* Me)
+                       : Module(Me)
                {
-                       Srv  = Me;
-
                        ReadConfig();
-                       ho = new Helpop();
-                       Srv->AddMode(ho, 'h');
-                       mycommand = new cmd_helpop();
-                       Srv->AddCommand(mycommand);
+                       ho = new Helpop(ServerInstance);
+                       if (!ServerInstance->AddMode(ho, 'h'))
+                               throw ModuleException("Could not add new modes!");
+                       mycommand = new cmd_helpop(ServerInstance);
+                       ServerInstance->AddCommand(mycommand);
                }
 
                virtual void ReadConfig()
                {
-                       conf = new ConfigReader;
-                       h_file = conf->ReadValue("helpop", "file", 0);
+                       ConfigReader *MyConf = new ConfigReader(ServerInstance);
 
-                       if (h_file == "")
+                       helpop_map.clear();
+
+                       for (int i = 0; i < MyConf->Enumerate("helpop"); i++)
                        {
-                               helpop = NULL;
-                               HelpopException e("Missing helpop file");
-                               throw(e);
+                               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;
                        }
 
-                       helpop = new ConfigReader(h_file);
-                       if ((helpop->ReadValue("nohelp",  "line1", 0) == "") ||
-                               (helpop->ReadValue("nohelpo", "line1", 0) == "") ||
-                               (helpop->ReadValue("start",   "line1", 0) == ""))
+                       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())
                        {
-                               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 entries. Please check the example conf.");
                        }
+
                }
 
                void Implements(char* List)
@@ -240,12 +163,8 @@ class ModuleHelpop : public Module
                        List[I_OnRehash] = List[I_OnWhois] = 1;
                }
 
-               virtual void OnRehash(const std::string &parameter)
+               virtual void OnRehash(userrec* user, const std::string &parameter)
                {
-                       DELETE(conf);
-                       if (helpop)
-                               DELETE(helpop);
-
                        ReadConfig();
                }
 
@@ -253,20 +172,19 @@ class ModuleHelpop : public Module
                {
                        if (dst->IsModeSet('h'))
                        {
-                               src->WriteServ("310 "+std::string(src->nick)+" "+std::string(dst->nick)+" :is available for help.");
+                               ServerInstance->SendWhoisLine(src, dst, 310, std::string(src->nick)+" "+std::string(dst->nick)+" :is available for help.");
                        }
                }
 
                virtual ~ModuleHelpop()
                {
-                       DELETE(conf);
-                       DELETE(helpop);
+                       ServerInstance->Modes->DelMode(ho);
                        DELETE(ho);
                }
        
                virtual Version GetVersion()
                {
-                       return Version(1,0,0,1,VF_STATIC|VF_VENDOR);
+                       return Version(1,1,0,1,VF_COMMON|VF_VENDOR,API_VERSION);
                }
 };
 
@@ -281,14 +199,14 @@ class ModuleHelpopFactory : public ModuleFactory
        {
        }
        
-       virtual Module * CreateModule(Server* Me)
+       virtual Module * CreateModule(InspIRCd* Me)
        {
                return new ModuleHelpop(Me);
        }
        
 };
 
-extern "C" void * init_module( void )
+extern "C" DllExport void * init_module( void )
 {
        return new ModuleHelpopFactory;
 }