src/modules/m_helpop.cpp

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd: (C) 2002-2010 InspIRCd Development Team
   6  * See: http://wiki.inspircd.org/Credits
   7  *
   8  * This program is free but copyrighted software; see
   9  *            the file COPYING for details.
  10  *
  11  * ---------------------------------------------------
  12  */
  13
  14 #include "inspircd.h"
  15
  16 /* $ModDesc: /helpop Command, Works like Unreal helpop */
  17 static std::map<irc::string, std::string> helpop_map;
  18
  19
  20 /** Handles user mode +h
  21  */
  22 class Helpop : public ModeHandler
  23 {
  24  public:
  25         Helpop(Module* Creator) : ModeHandler(Creator, "helpop", 'h', PARAM_NONE, MODETYPE_USER)
  26         {
  27                 oper = true;
  28         }
  29
  30         ModeAction OnModeChange(User* source, User* dest, Channel* 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 CommandHelpop : public Command
  56 {
  57  public:
  58         CommandHelpop(Module* Creator) : Command(Creator, "HELP", 0)
  59         {
  60                 syntax = "<any-text>";
  61         }
  62
  63         CmdResult Handle (const std::vector<std::string> &parameters, User *user)
  64         {
  65                 irc::string parameter("start");
  66                 if (parameters.size() > 0)
  67                         parameter = parameters[0].c_str();
  68
  69                 if (parameter == "index")
  70                 {
  71                         /* iterate over all helpop items */
  72                         user->WriteServ("290 %s :HELPOP topic index", user->nick.c_str());
  73                         for (std::map<irc::string, std::string>::iterator iter = helpop_map.begin(); iter != helpop_map.end(); iter++)
  74                         {
  75                                 user->WriteServ("292 %s :  %s", user->nick.c_str(), iter->first.c_str());
  76                         }
  77                         user->WriteServ("292 %s :*** End of HELPOP topic index", user->nick.c_str());
  78                 }
  79                 else
  80                 {
  81                         user->WriteServ("290 %s :*** HELPOP for %s", user->nick.c_str(), parameter.c_str());
  82                         user->WriteServ("292 %s : -", user->nick.c_str());
  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 (stream.GetToken(token))
  96                         {
  97                                 // Writing a blank line will not work with some clients
  98                                 if (token.empty())
  99                                         user->WriteServ("292 %s : ", user->nick.c_str());
 100                                 else
 101                                         user->WriteServ("292 %s :%s", user->nick.c_str(), token.c_str());
 102                         }
 103
 104                         user->WriteServ("292 %s : -", user->nick.c_str());
 105                         user->WriteServ("292 %s :*** End of HELPOP", user->nick.c_str());
 106                 }
 107                 return CMD_SUCCESS;
 108         }
 109 };
 110
 111 class ModuleHelpop : public Module
 112 {
 113         private:
 114                 std::string  h_file;
 115                 CommandHelpop cmd;
 116                 Helpop ho;
 117
 118         public:
 119                 ModuleHelpop()
 120                         : cmd(this), ho(this)
 121                 {
 122                 }
 123
 124                 void init()
 125                 {
 126                         ReadConfig();
 127                         ServerInstance->Modules->AddService(ho);
 128                         ServerInstance->Modules->AddService(cmd);
 129                         Implementation eventlist[] = { I_OnRehash, I_OnWhois };
 130                         ServerInstance->Modules->Attach(eventlist, this, 2);
 131                 }
 132
 133                 void ReadConfig()
 134                 {
 135                         ConfigReader MyConf;
 136
 137                         helpop_map.clear();
 138
 139                         ConfigTagList tags = ServerInstance->Config->ConfTags("helpop");
 140                         for(ConfigIter i = tags.first; i != tags.second; ++i)
 141                         {
 142                                 ConfigTag* tag = i->second;
 143                                 irc::string key = assign(tag->getString("key"));
 144                                 std::string value;
 145                                 tag->readString("value", value, true); /* Linefeeds allowed */
 146
 147                                 if (key == "index")
 148                                 {
 149                                         throw ModuleException("m_helpop: The key 'index' is reserved for internal purposes. Please remove it.");
 150                                 }
 151
 152                                 helpop_map[key] = value;
 153                         }
 154
 155                         if (helpop_map.find("start") == helpop_map.end())
 156                         {
 157                                 // error!
 158                                 throw ModuleException("m_helpop: Helpop file is missing important entry 'start'. Please check the example conf.");
 159                         }
 160                         else if (helpop_map.find("nohelp") == helpop_map.end())
 161                         {
 162                                 // error!
 163                                 throw ModuleException("m_helpop: Helpop file is missing important entry 'nohelp'. Please check the example conf.");
 164                         }
 165
 166                 }
 167
 168
 169                 virtual void OnRehash(User* user)
 170                 {
 171                         ReadConfig();
 172                 }
 173
 174                 virtual void OnWhois(User* src, User* dst)
 175                 {
 176                         if (dst->IsModeSet('h'))
 177                         {
 178                                 ServerInstance->SendWhoisLine(src, dst, 310, std::string(src->nick)+" "+std::string(dst->nick)+" :is available for help.");
 179                         }
 180                 }
 181
 182                 virtual ~ModuleHelpop()
 183                 {
 184                 }
 185
 186                 virtual Version GetVersion()
 187                 {
 188                         return Version("/helpop Command, Works like Unreal helpop", VF_VENDOR);
 189                 }
 190 };
 191
 192 MODULE_INIT(ModuleHelpop)