src/modules/m_helpop.cpp

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd: (C) 2002-2007 InspIRCd Development Team
   6  * See: http://www.inspircd.org/wiki/index.php/Credits
   7  *
   8  * This program is free but copyrighted software; see
   9  *            the file COPYING for details.
  10  *
  11  * ---------------------------------------------------
  12  */
  13
  14 #include "users.h"
  15 #include "channels.h"
  16 #include "modules.h"
  17 #include "inspircd.h"
  18
  19 /* $ModDesc: /helpop Command, Works like Unreal helpop */
  20 static std::map<irc::string, std::string> helpop_map;
  21
  22
  23 /** Handles user mode +h
  24  */
  25 class Helpop : public ModeHandler
  26 {
  27  public:
  28         Helpop(InspIRCd* Instance) : ModeHandler(Instance, 'h', 0, 0, false, MODETYPE_USER, true) { }
  29
  30         ModeAction OnModeChange(userrec* source, userrec* dest, chanrec* channel, std::string &parameter, bool adding)
  31         {
  32                 if (adding)
  33                 {
  34                         if (!dest->IsModeSet('h'))
  35                         {
  36                                 dest->SetMode('h',true);
  37                                 return MODEACTION_ALLOW;
  38                         }
  39                 }
  40                 else
  41                 {
  42                         if (dest->IsModeSet('h'))
  43                         {
  44                                 dest->SetMode('h',false);
  45                                 return MODEACTION_ALLOW;
  46                         }
  47                 }
  48
  49                 return MODEACTION_DENY;
  50         }
  51 };
  52
  53 /** Handles /HELPOP
  54  */
  55 class cmd_helpop : public command_t
  56 {
  57  public:
  58         cmd_helpop (InspIRCd* Instance) : command_t(Instance, "HELPOP", 0, 0)
  59         {
  60                 this->source = "m_helpop.so";
  61                 syntax = "<any-text>";
  62         }
  63
  64         CmdResult Handle (const char** parameters, int pcnt, userrec *user)
  65         {
  66                 if (pcnt > 0)
  67                         irc::string parameter = parameters[0];
  68
  69                 if (pcnt == 0 || parameter == "index")
  70                 {
  71                         /* iterate over all helpop items */
  72                         user->WriteServ("NOTICE %s :HELPOP topic index", user->nick);
  73                         for (std::map<irc::string, std::string>::iterator iter = helpop_map.begin(); iter != helpop_map.end(); iter++)
  74                         {
  75                                 user->WriteServ("NOTICE %s :    %s", user->nick, iter->first.c_str());
  76                         }
  77                         user->WriteServ("NOTICE %s :*** End of HELPOP topic index", user->nick);
  78                 }
  79                 else
  80                 {
  81                         user->WriteServ("NOTICE %s :*** HELPOP for %s", user->nick, parameters[0]);
  82
  83                         std::map<irc::string, std::string>::iterator iter = helpop_map.find(parameter);
  84
  85                         if (iter == helpop_map.end())
  86                         {
  87                                 iter = helpop_map.find("nohelp");
  88                         }
  89
  90                         std::string value = iter->second;
  91                         irc::sepstream stream(value, '\n');
  92                         std::string token = "*";
  93
  94                         while ((token = stream.GetToken()) != "")
  95                         {
  96                                 user->WriteServ("NOTICE %s :%s", user->nick, token.c_str());
  97                         }
  98
  99                         user->WriteServ("NOTICE %s :*** End of HELPOP", user->nick);
 100                 }
 101
 102                 /* We dont want these going out over the network, return CMD_FAILURE
 103                  * to make sure the protocol module thinks theyre not worth sending.
 104                  */
 105                 return CMD_FAILURE;
 106         }
 107 };
 108
 109 class ModuleHelpop : public Module
 110 {
 111         private:
 112                 std::string  h_file;
 113                 cmd_helpop* mycommand;
 114                 Helpop* ho;
 115
 116         public:
 117                 ModuleHelpop(InspIRCd* Me)
 118                         : Module::Module(Me)
 119                 {
 120                         ReadConfig();
 121                         ho = new Helpop(ServerInstance);
 122                         if (!ServerInstance->AddMode(ho, 'h'))
 123                                 throw ModuleException("Could not add new modes!");
 124                         mycommand = new cmd_helpop(ServerInstance);
 125                         ServerInstance->AddCommand(mycommand);
 126                 }
 127
 128                 virtual void ReadConfig()
 129                 {
 130                         ConfigReader *MyConf = new ConfigReader(ServerInstance);
 131
 132                         helpop_map.clear();
 133
 134                         for (int i = 0; i < MyConf->Enumerate("helpop"); i++)
 135                         {
 136                                 irc::string key = assign(MyConf->ReadValue("helpop", "key", i));
 137                                 std::string value = MyConf->ReadValue("helpop", "value", i, true); /* Linefeeds allowed! */
 138
 139                                 if (key == "index")
 140                                 {
 141                                         throw ModuleException("m_helpop: The key 'index' is reserved for internal purposes. Please remove it.");
 142                                 }
 143
 144                                 helpop_map[key] = value;
 145                         }
 146
 147                         if (helpop_map.find("start") == helpop_map.end())
 148                         {
 149                                 // error!
 150                                 throw ModuleException("m_helpop: Helpop file is missing important entries. Please check the example conf.");
 151                         }
 152                         else if (helpop_map.find("nohelp") == helpop_map.end())
 153                         {
 154                                 // error!
 155                                 throw ModuleException("m_helpop: Helpop file is missing important entries. Please check the example conf.");
 156                         }
 157
 158                 }
 159
 160                 void Implements(char* List)
 161                 {
 162                         List[I_OnRehash] = List[I_OnWhois] = 1;
 163                 }
 164
 165                 virtual void OnRehash(userrec* user, const std::string &parameter)
 166                 {
 167                         ReadConfig();
 168                 }
 169
 170                 virtual void OnWhois(userrec* src, userrec* dst)
 171                 {
 172                         if (dst->IsModeSet('h'))
 173                         {
 174                                 ServerInstance->SendWhoisLine(src, dst, 310, std::string(src->nick)+" "+std::string(dst->nick)+" :is available for help.");
 175                         }
 176                 }
 177
 178                 virtual ~ModuleHelpop()
 179                 {
 180                         ServerInstance->Modes->DelMode(ho);
 181                         DELETE(ho);
 182                 }
 183
 184                 virtual Version GetVersion()
 185                 {
 186                         return Version(1,1,0,1,VF_COMMON|VF_VENDOR,API_VERSION);
 187                 }
 188 };
 189
 190 class ModuleHelpopFactory : public ModuleFactory
 191 {
 192  public:
 193         ModuleHelpopFactory()
 194         {
 195         }
 196
 197         ~ModuleHelpopFactory()
 198         {
 199         }
 200
 201         virtual Module * CreateModule(InspIRCd* Me)
 202         {
 203                 return new ModuleHelpop(Me);
 204         }
 205
 206 };
 207
 208 extern "C" void * init_module( void )
 209 {
 210         return new ModuleHelpopFactory;
 211 }