src/modules/m_helpop.cpp

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
   5  *   Copyright (C) 2005-2009 Robin Burchell <robin+git@viroteck.net>
   6  *   Copyright (C) 2004-2006, 2008 Craig Edwards <craigedwards@brainbox.cc>
   7  *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
   8  *   Copyright (C) 2004-2005 Craig McLure <craig@chatspike.net>
   9  *
  10  * This file is part of InspIRCd.  InspIRCd is free software: you can
  11  * redistribute it and/or modify it under the terms of the GNU General Public
  12  * License as published by the Free Software Foundation, version 2.
  13  *
  14  * This program is distributed in the hope that it will be useful, but WITHOUT
  15  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  16  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  17  * details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21  */
  22
  23
  24 #include "inspircd.h"
  25
  26 static std::map<irc::string, std::string> helpop_map;
  27
  28 /** Handles user mode +h
  29  */
  30 class Helpop : public SimpleUserModeHandler
  31 {
  32  public:
  33         Helpop(Module* Creator) : SimpleUserModeHandler(Creator, "helpop", 'h')
  34         {
  35                 oper = true;
  36         }
  37 };
  38
  39 /** Handles /HELPOP
  40  */
  41 class CommandHelpop : public Command
  42 {
  43  public:
  44         CommandHelpop(Module* Creator) : Command(Creator, "HELPOP", 0)
  45         {
  46                 syntax = "<any-text>";
  47         }
  48
  49         CmdResult Handle (const std::vector<std::string> &parameters, User *user)
  50         {
  51                 irc::string parameter("start");
  52                 if (parameters.size() > 0)
  53                         parameter = parameters[0].c_str();
  54
  55                 if (parameter == "index")
  56                 {
  57                         /* iterate over all helpop items */
  58                         user->WriteNumeric(290, ":HELPOP topic index");
  59                         for (std::map<irc::string, std::string>::iterator iter = helpop_map.begin(); iter != helpop_map.end(); iter++)
  60                                 user->WriteNumeric(292, ":  %s", iter->first.c_str());
  61                         user->WriteNumeric(292, ":*** End of HELPOP topic index");
  62                 }
  63                 else
  64                 {
  65                         user->WriteNumeric(290, ":*** HELPOP for %s", parameter.c_str());
  66                         user->WriteNumeric(292, ": -");
  67
  68                         std::map<irc::string, std::string>::iterator iter = helpop_map.find(parameter);
  69
  70                         if (iter == helpop_map.end())
  71                         {
  72                                 iter = helpop_map.find("nohelp");
  73                         }
  74
  75                         std::string value = iter->second;
  76                         irc::sepstream stream(value, '\n');
  77                         std::string token = "*";
  78
  79                         while (stream.GetToken(token))
  80                         {
  81                                 // Writing a blank line will not work with some clients
  82                                 if (token.empty())
  83                                         user->WriteNumeric(292, ": ");
  84                                 else
  85                                         user->WriteNumeric(292, ":%s", token.c_str());
  86                         }
  87
  88                         user->WriteNumeric(292, ": -");
  89                         user->WriteNumeric(292, ":*** End of HELPOP");
  90                 }
  91                 return CMD_SUCCESS;
  92         }
  93 };
  94
  95 class ModuleHelpop : public Module
  96 {
  97                 std::string  h_file;
  98                 CommandHelpop cmd;
  99                 Helpop ho;
 100
 101         public:
 102                 ModuleHelpop()
 103                         : cmd(this), ho(this)
 104                 {
 105                 }
 106
 107                 void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
 108                 {
 109                         helpop_map.clear();
 110
 111                         ConfigTagList tags = ServerInstance->Config->ConfTags("helpop");
 112                         for(ConfigIter i = tags.first; i != tags.second; ++i)
 113                         {
 114                                 ConfigTag* tag = i->second;
 115                                 irc::string key = assign(tag->getString("key"));
 116                                 std::string value;
 117                                 tag->readString("value", value, true); /* Linefeeds allowed */
 118
 119                                 if (key == "index")
 120                                 {
 121                                         throw ModuleException("m_helpop: The key 'index' is reserved for internal purposes. Please remove it.");
 122                                 }
 123
 124                                 helpop_map[key] = value;
 125                         }
 126
 127                         if (helpop_map.find("start") == helpop_map.end())
 128                         {
 129                                 // error!
 130                                 throw ModuleException("m_helpop: Helpop file is missing important entry 'start'. Please check the example conf.");
 131                         }
 132                         else if (helpop_map.find("nohelp") == helpop_map.end())
 133                         {
 134                                 // error!
 135                                 throw ModuleException("m_helpop: Helpop file is missing important entry 'nohelp'. Please check the example conf.");
 136                         }
 137
 138                 }
 139
 140                 void OnWhois(User* src, User* dst) CXX11_OVERRIDE
 141                 {
 142                         if (dst->IsModeSet(ho))
 143                         {
 144                                 ServerInstance->SendWhoisLine(src, dst, 310, dst->nick+" :is available for help.");
 145                         }
 146                 }
 147
 148                 Version GetVersion() CXX11_OVERRIDE
 149                 {
 150                         return Version("Provides the /HELPOP command for useful information", VF_VENDOR);
 151                 }
 152 };
 153
 154 MODULE_INIT(ModuleHelpop)