src/modules/m_showfile.cpp

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2013 Attila Molnar <attilamolnar@hush.com>
   5  *
   6  * This file is part of InspIRCd.  InspIRCd is free software: you can
   7  * redistribute it and/or modify it under the terms of the GNU General Public
   8  * License as published by the Free Software Foundation, version 2.
   9  *
  10  * This program is distributed in the hope that it will be useful, but WITHOUT
  11  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  12  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  13  * details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17  */
  18
  19
  20 #include "inspircd.h"
  21
  22 enum
  23 {
  24         // From UnrealIRCd.
  25         RPL_RULES = 232,
  26         RPL_RULESTART = 308,
  27         RPL_RULESEND = 309,
  28         ERR_NORULES = 434
  29 };
  30
  31 class CommandShowFile : public Command
  32 {
  33         enum Method
  34         {
  35                 SF_MSG,
  36                 SF_NOTICE,
  37                 SF_NUMERIC
  38         };
  39
  40         std::string introtext;
  41         std::string endtext;
  42         unsigned int intronumeric;
  43         unsigned int textnumeric;
  44         unsigned int endnumeric;
  45         file_cache contents;
  46         Method method;
  47
  48  public:
  49         CommandShowFile(Module* parent, const std::string& cmdname)
  50                 : Command(parent, cmdname)
  51         {
  52         }
  53
  54         CmdResult Handle(User* user, const Params& parameters) CXX11_OVERRIDE
  55         {
  56                 if (method == SF_NUMERIC)
  57                 {
  58                         if (!introtext.empty())
  59                                 user->WriteRemoteNumeric(intronumeric, introtext);
  60
  61                         for (file_cache::const_iterator i = contents.begin(); i != contents.end(); ++i)
  62                                 user->WriteRemoteNumeric(textnumeric, InspIRCd::Format("- %s", i->c_str()));
  63
  64                         user->WriteRemoteNumeric(endnumeric, endtext.c_str());
  65                 }
  66                 else
  67                 {
  68                         const char* msgcmd = (method == SF_MSG ? "PRIVMSG" : "NOTICE");
  69                         for (file_cache::const_iterator i = contents.begin(); i != contents.end(); ++i)
  70                         {
  71                                 const std::string& line = *i;
  72                                 user->WriteCommand(msgcmd, ":" + line);
  73                         }
  74                 }
  75                 return CMD_SUCCESS;
  76         }
  77
  78         void UpdateSettings(ConfigTag* tag, const std::vector<std::string>& filecontents)
  79         {
  80                 introtext = tag->getString("introtext", "Showing " + name);
  81                 endtext = tag->getString("endtext", "End of " + name);
  82                 intronumeric = tag->getUInt("intronumeric", RPL_RULESTART, 0, 999);
  83                 textnumeric = tag->getUInt("numeric", RPL_RULES, 0, 999);
  84                 endnumeric = tag->getUInt("endnumeric", RPL_RULESEND, 0, 999);
  85                 std::string smethod = tag->getString("method");
  86
  87                 method = SF_NUMERIC;
  88                 if (smethod == "msg")
  89                         method = SF_MSG;
  90                 else if (smethod == "notice")
  91                         method = SF_NOTICE;
  92
  93                 contents = filecontents;
  94                 InspIRCd::ProcessColors(contents);
  95         }
  96 };
  97
  98 class ModuleShowFile : public Module
  99 {
 100         std::vector<CommandShowFile*> cmds;
 101
 102         void ReadTag(ConfigTag* tag, std::vector<CommandShowFile*>& newcmds)
 103         {
 104                 std::string cmdname = tag->getString("name");
 105                 if (cmdname.empty())
 106                         throw ModuleException("Empty value for 'name'");
 107
 108                 std::transform(cmdname.begin(), cmdname.end(), cmdname.begin(), ::toupper);
 109
 110                 const std::string file = tag->getString("file", cmdname);
 111                 if (file.empty())
 112                         throw ModuleException("Empty value for 'file'");
 113                 FileReader reader(file);
 114
 115                 CommandShowFile* sfcmd;
 116                 Command* handler = ServerInstance->Parser.GetHandler(cmdname);
 117                 if (handler)
 118                 {
 119                         // Command exists, check if it is ours
 120                         if (handler->creator != this)
 121                                 throw ModuleException("Command " + cmdname + " already exists");
 122
 123                         // This is our command, make sure we don't have the same entry twice
 124                         sfcmd = static_cast<CommandShowFile*>(handler);
 125                         if (stdalgo::isin(newcmds, sfcmd))
 126                                 throw ModuleException("Command " + cmdname + " is already used in a <showfile> tag");
 127                 }
 128                 else
 129                 {
 130                         // Command doesn't exist, create it
 131                         sfcmd = new CommandShowFile(this, cmdname);
 132                         ServerInstance->Modules->AddService(*sfcmd);
 133                 }
 134
 135                 sfcmd->UpdateSettings(tag, reader.GetVector());
 136                 newcmds.push_back(sfcmd);
 137         }
 138
 139  public:
 140         void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
 141         {
 142                 std::vector<CommandShowFile*> newcmds;
 143
 144                 ConfigTagList tags = ServerInstance->Config->ConfTags("showfile");
 145                 for (ConfigIter i = tags.first; i != tags.second; ++i)
 146                 {
 147                         ConfigTag* tag = i->second;
 148                         try
 149                         {
 150                                 ReadTag(tag, newcmds);
 151                         }
 152                         catch (CoreException& ex)
 153                         {
 154                                 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Error: " + ex.GetReason() + " at " + tag->getTagLocation());
 155                         }
 156                 }
 157
 158                 // Remove all commands that were removed from the config
 159                 std::vector<CommandShowFile*> removed(cmds.size());
 160                 std::sort(newcmds.begin(), newcmds.end());
 161                 std::set_difference(cmds.begin(), cmds.end(), newcmds.begin(), newcmds.end(), removed.begin());
 162
 163                 stdalgo::delete_all(removed);
 164                 cmds.swap(newcmds);
 165         }
 166
 167         ~ModuleShowFile()
 168         {
 169                 stdalgo::delete_all(cmds);
 170         }
 171
 172         Version GetVersion() CXX11_OVERRIDE
 173         {
 174                 return Version("Provides support for showing text files to users", VF_VENDOR);
 175         }
 176 };
 177
 178 MODULE_INIT(ModuleShowFile)