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                 irc::string parameter;
  67                 if (pcnt > 0)
  68                         parameter = parameters[0];
  69
  70                 if (pcnt == 0 || parameter == "index")
  71                 {
  72                         /* iterate over all helpop items */
  73                         user->WriteServ("NOTICE %s :HELPOP topic index", user->nick);
  74                         for (std::map<irc::string, std::string>::iterator iter = helpop_map.begin(); iter != helpop_map.end(); iter++)
  75                         {
  76                                 user->WriteServ("NOTICE %s :    %s", user->nick, iter->first.c_str());
  77                         }
  78                         user->WriteServ("NOTICE %s :*** End of HELPOP topic index", user->nick);
  79                 }
  80                 else
  81                 {
  82                         user->WriteServ("NOTICE %s :*** HELPOP for %s", user->nick, parameters[0]);
  83
  84                         std::map<irc::string, std::string>::iterator iter = helpop_map.find(parameter);
  85
  86                         if (iter == helpop_map.end())
  87                         {
  88                                 iter = helpop_map.find("nohelp");
  89                         }
  90
  91                         std::string value = iter->second;
  92                         irc::sepstream stream(value, '\n');
  93                         std::string token = "*";
  94
  95                         while ((token = stream.GetToken()) != "")
  96                         {
  97                                 user->WriteServ("NOTICE %s :%s", user->nick, token.c_str());
  98                         }
  99
 100                         user->WriteServ("NOTICE %s :*** End of HELPOP", user->nick);
 101                 }
 102
 103                 /* We dont want these going out over the network, return CMD_FAILURE
 104                  * to make sure the protocol module thinks theyre not worth sending.
 105                  */
 106                 return CMD_FAILURE;
 107         }
 108 };
 109
 110 class ModuleHelpop : public Module
 111 {
 112         private:
 113                 std::string  h_file;
 114                 cmd_helpop* mycommand;
 115                 Helpop* ho;
 116
 117         public:
 118                 ModuleHelpop(InspIRCd* Me)
 119                         : Module::Module(Me)
 120                 {
 121                         ReadConfig();
 122                         ho = new Helpop(ServerInstance);
 123                         if (!ServerInstance->AddMode(ho, 'h'))
 124                                 throw ModuleException("Could not add new modes!");
 125                         mycommand = new cmd_helpop(ServerInstance);
 126                         ServerInstance->AddCommand(mycommand);
 127                 }
 128
 129                 virtual void ReadConfig()
 130                 {
 131                         ConfigReader *MyConf = new ConfigReader(ServerInstance);
 132
 133                         helpop_map.clear();
 134
 135                         for (int i = 0; i < MyConf->Enumerate("helpop"); i++)
 136                         {
 137                                 irc::string key = assign(MyConf->ReadValue("helpop", "key", i));
 138                                 std::string value = MyConf->ReadValue("helpop", "value", i, true); /* Linefeeds allowed! */
 139
 140                                 if (key == "index")
 141                                 {
 142                                         throw ModuleException("m_helpop: The key 'index' is reserved for internal purposes. Please remove it.");
 143                                 }
 144
 145                                 helpop_map[key] = value;
 146                         }
 147
 148                         if (helpop_map.find("start") == helpop_map.end())
 149                         {
 150                                 // error!
 151                                 throw ModuleException("m_helpop: Helpop file is missing important entries. Please check the example conf.");
 152                         }
 153                         else if (helpop_map.find("nohelp") == helpop_map.end())
 154                         {
 155                                 // error!
 156                                 throw ModuleException("m_helpop: Helpop file is missing important entries. Please check the example conf.");
 157                         }
 158
 159                 }
 160
 161                 void Implements(char* List)
 162                 {
 163                         List[I_OnRehash] = List[I_OnWhois] = 1;
 164                 }
 165
 166                 virtual void OnRehash(userrec* user, const std::string &parameter)
 167                 {
 168                         ReadConfig();
 169                 }
 170
 171                 virtual void OnWhois(userrec* src, userrec* dst)
 172                 {
 173                         if (dst->IsModeSet('h'))
 174                         {
 175                                 ServerInstance->SendWhoisLine(src, dst, 310, std::string(src->nick)+" "+std::string(dst->nick)+" :is available for help.");
 176                         }
 177                 }
 178
 179                 virtual ~ModuleHelpop()
 180                 {
 181                         ServerInstance->Modes->DelMode(ho);
 182                         DELETE(ho);
 183                 }
 184
 185                 virtual Version GetVersion()
 186                 {
 187                         return Version(1,1,0,1,VF_COMMON|VF_VENDOR,API_VERSION);
 188                 }
 189 };
 190
 191 class ModuleHelpopFactory : public ModuleFactory
 192 {
 193  public:
 194         ModuleHelpopFactory()
 195         {
 196         }
 197
 198         ~ModuleHelpopFactory()
 199         {
 200         }
 201
 202         virtual Module * CreateModule(InspIRCd* Me)
 203         {
 204                 return new ModuleHelpop(Me);
 205         }
 206
 207 };
 208
 209 extern "C" void * init_module( void )
 210 {
 211         return new ModuleHelpopFactory;
 212 }