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;
72 void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
74 ConfigTag* fantasy = ServerInstance->Config->ConfValue("fantasy");
75 AllowBots = fantasy->getBool("allowbots", false);
76 fprefix = fantasy->getString("prefix", "!", 1, ServerInstance->Config->Limits.MaxLine);
79 ConfigTagList tags = ServerInstance->Config->ConfTags("alias");
80 for(ConfigIter i = tags.first; i != tags.second; ++i)
82 ConfigTag* tag = i->second;
84 a.AliasedCommand = tag->getString("text");
85 std::transform(a.AliasedCommand.begin(), a.AliasedCommand.end(), a.AliasedCommand.begin(), ::toupper);
86 tag->readString("replace", a.ReplaceFormat, true);
87 a.RequiredNick = tag->getString("requires");
88 a.ULineOnly = tag->getBool("uline");
89 a.ChannelCommand = tag->getBool("channelcommand", false);
90 a.UserCommand = tag->getBool("usercommand", true);
91 a.OperOnly = tag->getBool("operonly");
92 a.format = tag->getString("format");
93 Aliases.insert(std::make_pair(a.AliasedCommand, a));
98 : botmode(this, "bot")
102 Version GetVersion() CXX11_OVERRIDE
104 return Version("Provides aliases of commands.", VF_VENDOR);
107 std::string GetVar(std::string varname, const std::string &original_line)
109 irc::spacesepstream ss(original_line);
110 varname.erase(varname.begin());
111 int index = *(varname.begin()) - 48;
112 varname.erase(varname.begin());
113 bool everything_after = (varname == "-");
116 for (int j = 0; j < index; j++)
119 if (everything_after)
122 while (ss.GetToken(more))
132 ModResult OnPreCommand(std::string &command, std::vector<std::string> ¶meters, LocalUser *user, bool validated, const std::string &original_line) CXX11_OVERRIDE
134 /* If theyre not registered yet, we dont want
137 if (user->registered != REG_ALL)
138 return MOD_RES_PASSTHRU;
140 /* We dont have any commands looking like this? Stop processing. */
141 std::pair<AliasMap::iterator, AliasMap::iterator> iters = Aliases.equal_range(command);
142 if (iters.first == iters.second)
143 return MOD_RES_PASSTHRU;
145 /* The parameters for the command in their original form, with the command stripped off */
146 std::string compare(original_line, command.length());
147 while (*(compare.c_str()) == ' ')
148 compare.erase(compare.begin());
150 for (AliasMap::iterator i = iters.first; i != iters.second; ++i)
152 if (i->second.UserCommand)
154 if (DoAlias(user, NULL, &(i->second), compare, original_line))
161 // If we made it here, no aliases actually matched.
162 return MOD_RES_PASSTHRU;
165 void OnUserPostMessage(User* user, const MessageTarget& target, const MessageDetails& details) CXX11_OVERRIDE
167 if ((target.type != MessageTarget::TYPE_CHANNEL) || (details.type != MSG_PRIVMSG))
172 // fcommands are only for local users. Spanningtree will send them back out as their original cmd.
178 /* Stop here if the user is +B and allowbot is set to no. */
179 if (!AllowBots && user->IsModeSet(botmode))
184 Channel *c = target.Get<Channel>();
185 std::string scommand;
187 // text is like "!moo cows bite me", we want "!moo" first
188 irc::spacesepstream ss(details.text);
189 ss.GetToken(scommand);
191 if (scommand.size() <= fprefix.size())
196 // we don't want to touch non-fantasy stuff
197 if (scommand.compare(0, fprefix.size(), fprefix) != 0)
202 // nor do we give a shit about the prefix
203 scommand.erase(0, fprefix.size());
205 std::pair<AliasMap::iterator, AliasMap::iterator> iters = Aliases.equal_range(scommand);
206 if (iters.first == iters.second)
209 /* The parameters for the command in their original form, with the command stripped off */
210 std::string compare(details.text, scommand.length() + fprefix.size());
211 while (*(compare.c_str()) == ' ')
212 compare.erase(compare.begin());
214 for (AliasMap::iterator i = iters.first; i != iters.second; ++i)
216 if (i->second.ChannelCommand)
218 // We use substr here to remove the fantasy prefix
219 if (DoAlias(user, c, &(i->second), compare, details.text.substr(fprefix.size())))
226 int DoAlias(User *user, Channel *c, Alias *a, const std::string& compare, const std::string& safe)
228 /* Does it match the pattern? */
229 if (!a->format.empty())
231 if (!InspIRCd::Match(compare, a->format))
235 if ((a->OperOnly) && (!user->IsOper()))
238 if (!a->RequiredNick.empty())
240 User* u = ServerInstance->FindNick(a->RequiredNick);
243 user->WriteNumeric(ERR_NOSUCHNICK, a->RequiredNick, "is currently unavailable. Please try again later.");
247 if ((a->ULineOnly) && (!u->server->IsULine()))
249 ServerInstance->SNO->WriteToSnoMask('a', "NOTICE -- Service "+a->RequiredNick+" required by alias "+a->AliasedCommand+" is not on a u-lined server, possibly underhanded antics detected!");
250 user->WriteNumeric(ERR_NOSUCHNICK, a->RequiredNick, "is an imposter! Please inform an IRC operator as soon as possible.");
255 /* Now, search and replace in a copy of the original_line, replacing $1 through $9 and $1- etc */
257 std::string::size_type crlf = a->ReplaceFormat.find('\n');
259 if (crlf == std::string::npos)
261 DoCommand(a->ReplaceFormat, user, c, safe, a);
266 irc::sepstream commands(a->ReplaceFormat, '\n');
267 std::string scommand;
268 while (commands.GetToken(scommand))
270 DoCommand(scommand, user, c, safe, a);
276 void DoCommand(const std::string& newline, User* user, Channel *chan, const std::string &original_line, Alias* a)
279 result.reserve(newline.length());
280 for (unsigned int i = 0; i < newline.length(); i++)
283 if ((c == '$') && (i + 1 < newline.length()))
285 if (isdigit(newline[i+1]))
287 size_t len = ((i + 2 < newline.length()) && (newline[i+2] == '-')) ? 3 : 2;
288 std::string var = newline.substr(i, len);
289 result.append(GetVar(var, original_line));
292 else if (!newline.compare(i, 5, "$nick", 5))
294 result.append(user->nick);
297 else if (!newline.compare(i, 5, "$host", 5))
299 result.append(user->GetRealHost());
302 else if (!newline.compare(i, 5, "$chan", 5))
305 result.append(chan->name);
308 else if (!newline.compare(i, 6, "$ident", 6))
310 result.append(user->ident);
313 else if (!newline.compare(i, 6, "$vhost", 6))
315 result.append(user->GetDisplayedHost());
318 else if (!newline.compare(i, 12, "$requirement", 12))
320 result.append(a->RequiredNick);
330 irc::tokenstream ss(result);
331 std::vector<std::string> pars;
332 std::string command, token;
334 ss.GetToken(command);
335 while (ss.GetToken(token))
337 pars.push_back(token);
339 ServerInstance->Parser.CallHandler(command, pars, user);
342 void Prioritize() CXX11_OVERRIDE
344 // Prioritise after spanningtree so that channel aliases show the alias before the effects.
345 Module* linkmod = ServerInstance->Modules->Find("m_spanningtree.so");
346 ServerInstance->Modules->SetPriority(this, I_OnUserPostMessage, PRIORITY_AFTER, linkmod);
350 MODULE_INIT(ModuleAlias)