2 * InspIRCd -- Internet Relay Chat Daemon
4 * Copyright (C) 2013 Attila Molnar <attilamolnar@hush.com>
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.
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
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/>.
31 class CommandShowFile : public Command
40 std::string introtext;
42 unsigned int intronumeric;
43 unsigned int textnumeric;
44 unsigned int endnumeric;
49 CommandShowFile(Module* parent, const std::string& cmdname)
50 : Command(parent, cmdname)
54 CmdResult Handle(User* user, const Params& parameters) CXX11_OVERRIDE
56 if (method == SF_NUMERIC)
58 if (!introtext.empty() && intronumeric)
59 user->WriteRemoteNumeric(intronumeric, introtext);
61 for (file_cache::const_iterator i = contents.begin(); i != contents.end(); ++i)
62 user->WriteRemoteNumeric(textnumeric, InspIRCd::Format("- %s", i->c_str()));
64 if (!endtext.empty() && endnumeric)
65 user->WriteRemoteNumeric(endnumeric, endtext.c_str());
67 else if (IS_LOCAL(user))
69 LocalUser* const localuser = IS_LOCAL(user);
70 for (file_cache::const_iterator i = contents.begin(); i != contents.end(); ++i)
72 const std::string& line = *i;
73 ClientProtocol::Messages::Privmsg msg(ClientProtocol::Messages::Privmsg::nocopy, ServerInstance->FakeClient, localuser, line, ((method == SF_MSG) ? MSG_PRIVMSG : MSG_NOTICE));
74 localuser->Send(ServerInstance->GetRFCEvents().privmsg, msg);
80 void UpdateSettings(ConfigTag* tag, const std::vector<std::string>& filecontents)
82 introtext = tag->getString("introtext", "Showing " + name);
83 endtext = tag->getString("endtext", "End of " + name);
84 intronumeric = tag->getUInt("intronumeric", RPL_RULESTART, 0, 999);
85 textnumeric = tag->getUInt("numeric", RPL_RULES, 0, 999);
86 endnumeric = tag->getUInt("endnumeric", RPL_RULESEND, 0, 999);
87 std::string smethod = tag->getString("method");
92 else if (smethod == "notice")
95 contents = filecontents;
96 InspIRCd::ProcessColors(contents);
100 class ModuleShowFile : public Module
102 std::vector<CommandShowFile*> cmds;
104 void ReadTag(ConfigTag* tag, std::vector<CommandShowFile*>& newcmds)
106 std::string cmdname = tag->getString("name");
108 throw ModuleException("Empty value for 'name'");
110 std::transform(cmdname.begin(), cmdname.end(), cmdname.begin(), ::toupper);
112 const std::string file = tag->getString("file", cmdname);
114 throw ModuleException("Empty value for 'file'");
115 FileReader reader(file);
117 CommandShowFile* sfcmd;
118 Command* handler = ServerInstance->Parser.GetHandler(cmdname);
121 // Command exists, check if it is ours
122 if (handler->creator != this)
123 throw ModuleException("Command " + cmdname + " already exists");
125 // This is our command, make sure we don't have the same entry twice
126 sfcmd = static_cast<CommandShowFile*>(handler);
127 if (stdalgo::isin(newcmds, sfcmd))
128 throw ModuleException("Command " + cmdname + " is already used in a <showfile> tag");
132 // Command doesn't exist, create it
133 sfcmd = new CommandShowFile(this, cmdname);
134 ServerInstance->Modules->AddService(*sfcmd);
137 sfcmd->UpdateSettings(tag, reader.GetVector());
138 newcmds.push_back(sfcmd);
142 void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
144 std::vector<CommandShowFile*> newcmds;
146 ConfigTagList tags = ServerInstance->Config->ConfTags("showfile");
147 for (ConfigIter i = tags.first; i != tags.second; ++i)
149 ConfigTag* tag = i->second;
152 ReadTag(tag, newcmds);
154 catch (CoreException& ex)
156 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Error: " + ex.GetReason() + " at " + tag->getTagLocation());
160 // Remove all commands that were removed from the config
161 std::vector<CommandShowFile*> removed(cmds.size());
162 std::sort(newcmds.begin(), newcmds.end());
163 std::set_difference(cmds.begin(), cmds.end(), newcmds.begin(), newcmds.end(), removed.begin());
165 stdalgo::delete_all(removed);
171 stdalgo::delete_all(cmds);
174 Version GetVersion() CXX11_OVERRIDE
176 return Version("Provides support for showing text files to users", VF_VENDOR);
180 MODULE_INIT(ModuleShowFile)