2 * InspIRCd -- Internet Relay Chat Daemon
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-2007, 2009 Craig Edwards <craigedwards@brainbox.cc>
7 * Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
9 * This file is part of InspIRCd. InspIRCd is free software: you can
10 * redistribute it and/or modify it under the terms of the GNU General Public
11 * License as published by the Free Software Foundation, version 2.
13 * This program is distributed in the hope that it will be useful, but WITHOUT
14 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
15 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
18 * You should have received a copy of the GNU General Public License
19 * along with this program. If not, see <http://www.gnu.org/licenses/>.
25 /** An alias definition
30 /** The text of the alias command */
31 std::string AliasedCommand;
33 /** Text to replace with */
34 std::string ReplaceFormat;
36 /** Nickname required to perform alias */
37 std::string RequiredNick;
39 /** Alias requires ulined server */
45 /* whether or not it may be executed via fantasy (default OFF) */
48 /* whether or not it may be executed via /command (default ON) */
51 /** Format that must be matched for use */
55 class ModuleAlias : public Module
59 /* We cant use a map, there may be multiple aliases with the same name.
60 * We can, however, use a fancy invention: the multimap. Maps a key to one or more values.
63 typedef insp::flat_multimap<std::string, Alias, irc::insensitive_swo> AliasMap;
67 /* whether or not +B users are allowed to use fantasy commands */
69 UserModeReference botmode;
71 // Whether we are actively executing an alias.
75 void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
77 ConfigTag* fantasy = ServerInstance->Config->ConfValue("fantasy");
78 AllowBots = fantasy->getBool("allowbots", false);
79 fprefix = fantasy->getString("prefix", "!", 1, ServerInstance->Config->Limits.MaxLine);
82 ConfigTagList tags = ServerInstance->Config->ConfTags("alias");
83 for(ConfigIter i = tags.first; i != tags.second; ++i)
85 ConfigTag* tag = i->second;
87 a.AliasedCommand = tag->getString("text");
88 std::transform(a.AliasedCommand.begin(), a.AliasedCommand.end(), a.AliasedCommand.begin(), ::toupper);
89 tag->readString("replace", a.ReplaceFormat, true);
90 a.RequiredNick = tag->getString("requires");
91 a.ULineOnly = tag->getBool("uline");
92 a.ChannelCommand = tag->getBool("channelcommand", false);
93 a.UserCommand = tag->getBool("usercommand", true);
94 a.OperOnly = tag->getBool("operonly");
95 a.format = tag->getString("format");
96 Aliases.insert(std::make_pair(a.AliasedCommand, a));
101 : botmode(this, "bot")
105 Version GetVersion() CXX11_OVERRIDE
107 return Version("Provides aliases of commands.", VF_VENDOR);
110 std::string GetVar(std::string varname, const std::string &original_line)
112 irc::spacesepstream ss(original_line);
113 varname.erase(varname.begin());
114 int index = *(varname.begin()) - 48;
115 varname.erase(varname.begin());
116 bool everything_after = (varname == "-");
119 for (int j = 0; j < index; j++)
122 if (everything_after)
125 while (ss.GetToken(more))
135 std::string CreateRFCMessage(const std::string& command, CommandBase::Params& parameters)
137 std::string message(command);
138 for (CommandBase::Params::const_iterator iter = parameters.begin(); iter != parameters.end();)
140 const std::string& parameter = *iter++;
141 message.push_back(' ');
142 if (iter == parameters.end() && (parameter.empty() || parameter.find(' ') != std::string::npos))
143 message.push_back(':');
144 message.append(parameter);
149 ModResult OnPreCommand(std::string& command, CommandBase::Params& parameters, LocalUser* user, bool validated) CXX11_OVERRIDE
151 /* If theyre not registered yet, we dont want
154 if (user->registered != REG_ALL)
155 return MOD_RES_PASSTHRU;
157 /* We dont have any commands looking like this? Stop processing. */
158 std::pair<AliasMap::iterator, AliasMap::iterator> iters = Aliases.equal_range(command);
159 if (iters.first == iters.second)
160 return MOD_RES_PASSTHRU;
162 /* The parameters for the command in their original form, with the command stripped off */
163 std::string original_line = CreateRFCMessage(command, parameters);
164 std::string compare(original_line, command.length());
165 while (*(compare.c_str()) == ' ')
166 compare.erase(compare.begin());
168 for (AliasMap::iterator i = iters.first; i != iters.second; ++i)
170 if (i->second.UserCommand)
172 if (DoAlias(user, NULL, &(i->second), compare, original_line))
179 // If we made it here, no aliases actually matched.
180 return MOD_RES_PASSTHRU;
183 ModResult OnUserPreMessage(User* user, const MessageTarget& target, MessageDetails& details) CXX11_OVERRIDE
185 // Don't echo anything which is caused by an alias.
187 details.echo = false;
189 return MOD_RES_PASSTHRU;
192 void OnUserPostMessage(User* user, const MessageTarget& target, const MessageDetails& details) CXX11_OVERRIDE
194 if ((target.type != MessageTarget::TYPE_CHANNEL) || (details.type != MSG_PRIVMSG))
199 // fcommands are only for local users. Spanningtree will send them back out as their original cmd.
205 /* Stop here if the user is +B and allowbot is set to no. */
206 if (!AllowBots && user->IsModeSet(botmode))
211 Channel *c = target.Get<Channel>();
212 std::string scommand;
214 // text is like "!moo cows bite me", we want "!moo" first
215 irc::spacesepstream ss(details.text);
216 ss.GetToken(scommand);
218 if (scommand.size() <= fprefix.size())
223 // we don't want to touch non-fantasy stuff
224 if (scommand.compare(0, fprefix.size(), fprefix) != 0)
229 // nor do we give a shit about the prefix
230 scommand.erase(0, fprefix.size());
232 std::pair<AliasMap::iterator, AliasMap::iterator> iters = Aliases.equal_range(scommand);
233 if (iters.first == iters.second)
236 /* The parameters for the command in their original form, with the command stripped off */
237 std::string compare(details.text, scommand.length() + fprefix.size());
238 while (*(compare.c_str()) == ' ')
239 compare.erase(compare.begin());
241 for (AliasMap::iterator i = iters.first; i != iters.second; ++i)
243 if (i->second.ChannelCommand)
245 // We use substr here to remove the fantasy prefix
246 if (DoAlias(user, c, &(i->second), compare, details.text.substr(fprefix.size())))
253 int DoAlias(User *user, Channel *c, Alias *a, const std::string& compare, const std::string& safe)
255 /* Does it match the pattern? */
256 if (!a->format.empty())
258 if (!InspIRCd::Match(compare, a->format))
262 if ((a->OperOnly) && (!user->IsOper()))
265 if (!a->RequiredNick.empty())
267 User* u = ServerInstance->FindNick(a->RequiredNick);
270 user->WriteNumeric(ERR_NOSUCHNICK, a->RequiredNick, "is currently unavailable. Please try again later.");
274 if ((a->ULineOnly) && (!u->server->IsULine()))
276 ServerInstance->SNO->WriteToSnoMask('a', "NOTICE -- Service "+a->RequiredNick+" required by alias "+a->AliasedCommand+" is not on a u-lined server, possibly underhanded antics detected!");
277 user->WriteNumeric(ERR_NOSUCHNICK, a->RequiredNick, "is an imposter! Please inform an IRC operator as soon as possible.");
282 /* Now, search and replace in a copy of the original_line, replacing $1 through $9 and $1- etc */
284 std::string::size_type crlf = a->ReplaceFormat.find('\n');
286 if (crlf == std::string::npos)
288 DoCommand(a->ReplaceFormat, user, c, safe, a);
293 irc::sepstream commands(a->ReplaceFormat, '\n');
294 std::string scommand;
295 while (commands.GetToken(scommand))
297 DoCommand(scommand, user, c, safe, a);
303 void DoCommand(const std::string& newline, User* user, Channel *chan, const std::string &original_line, Alias* a)
306 result.reserve(newline.length());
307 for (unsigned int i = 0; i < newline.length(); i++)
310 if ((c == '$') && (i + 1 < newline.length()))
312 if (isdigit(newline[i+1]))
314 size_t len = ((i + 2 < newline.length()) && (newline[i+2] == '-')) ? 3 : 2;
315 std::string var = newline.substr(i, len);
316 result.append(GetVar(var, original_line));
319 else if (!newline.compare(i, 5, "$nick", 5))
321 result.append(user->nick);
324 else if (!newline.compare(i, 5, "$host", 5))
326 result.append(user->GetRealHost());
329 else if (!newline.compare(i, 5, "$chan", 5))
332 result.append(chan->name);
335 else if (!newline.compare(i, 6, "$ident", 6))
337 result.append(user->ident);
340 else if (!newline.compare(i, 6, "$vhost", 6))
342 result.append(user->GetDisplayedHost());
345 else if (!newline.compare(i, 12, "$requirement", 12))
347 result.append(a->RequiredNick);
357 irc::tokenstream ss(result);
358 CommandBase::Params pars;
359 std::string command, token;
361 ss.GetMiddle(command);
362 while (ss.GetTrailing(token))
364 pars.push_back(token);
368 ServerInstance->Parser.CallHandler(command, pars, user);
372 void Prioritize() CXX11_OVERRIDE
374 // Prioritise after spanningtree so that channel aliases show the alias before the effects.
375 Module* linkmod = ServerInstance->Modules->Find("m_spanningtree.so");
376 ServerInstance->Modules->SetPriority(this, I_OnUserPostMessage, PRIORITY_AFTER, linkmod);
380 MODULE_INIT(ModuleAlias)