]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_helpop.cpp
fixed some indentation and spacing in modules
[user/henk/code/inspircd.git] / src / modules / m_helpop.cpp
index 2a0a0e62b76bd6a1254e141fff14f789b70fcb81..1a1867e073d9e6db61479eebf59469ead4d7e0d3 100644 (file)
-/*   +------------------------------------+
- *   | Inspire Internet Relay Chat Daemon |
- *   +------------------------------------+
+/*       +------------------------------------+
+ *       | Inspire Internet Relay Chat Daemon |
+ *       +------------------------------------+
+ *
+ *  InspIRCd: (C) 2002-2008 InspIRCd Development Team
+ * See: http://www.inspircd.org/wiki/index.php/Credits
  *
- *  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.
+ *            the file COPYING for details.
  *
  * ---------------------------------------------------
  */
 
-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**);
-
+#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 (!helpop)
-               return;
 
-       if (pcnt < 1)
-       {
-               do_helpop(NULL,pcnt,user);
-               return;
-       }
+/** Handles user mode +h
+ */
+class Helpop : public SimpleUserModeHandler
+{
+ public:
+       Helpop(InspIRCd* Instance) : SimpleUserModeHandler(Instance, 'h') { }
+};
 
-       if (parameters[0][0] == '!')
+/** Handles /HELPOP
+ */
+class CommandHelpop : public Command
+{
+ public:
+       CommandHelpop (InspIRCd* Instance) : Command(Instance, "HELPOP", 0, 0)
        {
-               // Force send to all +h users
-               sendtohelpop(user, pcnt, parameters);
+               this->source = "m_helpop.so";
+               syntax = "<any-text>";
        }
-       else if (parameters[0][0] == '?')
+
+       CmdResult Handle (const std::vector<std::string> &parameters, User *user)
        {
-               // Force to the helpop system with no forward if not found.
-               if (do_helpop(parameters, pcnt, user) == false)
+               irc::string parameter("start");
+               if (parameters.size() > 0)
+                       parameter = parameters[0].c_str();
+
+               if (parameter == "index")
                {
-                       // Not handled by the Database, Tell the user, and bail.
-                       for (int i = 1; output != ""; i++)
+                       /* iterate over all helpop items */
+                       user->WriteServ("NOTICE %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++)
                        {
-                               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);
-                               }
+                               user->WriteServ("NOTICE %s :    %s", user->nick.c_str(), iter->first.c_str());
                        }
+                       user->WriteServ("NOTICE %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)
+               else
                {
-                       // 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);
-               }
-       }
-}
-
-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];
-       char lower[MAXBUF];
-       int nlines = 0;
+                       user->WriteServ("NOTICE %s :*** HELPOP for %s", user->nick.c_str(), parameter.c_str());
 
-       if (!parameters)
-       {
-               search = "start";
-       }
-       else
-       {
-               search = parameters[0];
-       }
+                       std::map<irc::string, std::string>::iterator iter = helpop_map.find(parameter);
 
-       if (search[0] == '?')
-       {
-               search++;
-       }
+                       if (iter == helpop_map.end())
+                       {
+                               iter = helpop_map.find("nohelp");
+                       }
 
-       /* 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]);
+                       std::string value = iter->second;
+                       irc::sepstream stream(value, '\n');
+                       std::string token = "*";
 
+                       while (stream.GetToken(token))
+                               user->WriteServ("NOTICE %s :%s", user->nick.c_str(), token.c_str());
 
-       for (int i = 1; output != ""; i++)
-       {
-               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++;
+                       user->WriteServ("NOTICE %s :*** End of HELPOP", user->nick.c_str());
                }
-       }
-       return (nlines>0);
-}
-
 
-
-void sendtohelpop(userrec *src, int pcnt, char **params)
-{
-       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]) + " ";
-       }
-       Srv->SendToModeMask("oh",WM_AND,line);
-}
+};
 
 class ModuleHelpop : public Module
 {
        private:
-               ConfigReader *conf;
                std::string  h_file;
+               CommandHelpop* mycommand;
+               Helpop* ho;
 
        public:
-               ModuleHelpop(Server* Me)
-                       : Module::Module(Me)
+               ModuleHelpop(InspIRCd* Me)
+                       : Module(Me)
                {
-                       Srv  = Me;
-
                        ReadConfig();
-                       if (!Srv->AddExtendedMode('h',MT_CLIENT,true,0,0))
-                       {
-                               Srv->Log(DEFAULT,"Unable to claim the +h usermode.");
-                               return;
-                       }
-
-                       Srv->AddCommand("HELPOP",handle_helpop,0,0,"m_helpop.so");
+                       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);
                }
 
                virtual void ReadConfig()
                {
-                       conf = new ConfigReader;
-                       h_file = conf->ReadValue("helpop", "file", 0);
+                       ConfigReader *MyConf = new ConfigReader(ServerInstance);
+
+                       helpop_map.clear();
 
-                       if (h_file == "")
+                       for (int i = 0; i < MyConf->Enumerate("helpop"); i++)
                        {
-                               helpop = NULL;
-                               log(DEFAULT,"m_helpop: Helpop file not Specified.");
-                               return;
+                               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())
                        {
-                               log(DEFAULT,"m_helpop: Helpop file is missing important entries. Please check the example conf.");
-                               return;
+                               // error!
+                               throw ModuleException("m_helpop: Helpop file is missing important entries. Please check the example conf.");
                        }
+
                }
 
 
-               virtual void OnRehash(std::string parameter)
+               virtual void OnRehash(User* user, const std::string &parameter)
                {
-                       delete conf;
-                       if (helpop)
-                               delete helpop;
-
                        ReadConfig();
                }
 
-               virtual int OnExtendedMode(userrec* user, void* target, char modechar, int type, bool mode_on, string_list &params)
+               virtual void OnWhois(User* src, User* dst)
                {
-                       if ((modechar == 'h') && (type == MT_CLIENT))
-                       {
-                               return 1;
-                       }
-                       return 0;
-               }
-
-               virtual void OnWhois(userrec* src, userrec* dst)
-               {
-                       if (strchr(dst->modes,'h'))
+                       if (dst->IsModeSet('h'))
                        {
-                               Srv->SendTo(NULL,src,"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,2,0,1,VF_COMMON|VF_VENDOR,API_VERSION);
                }
 };
 
-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)