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 irc::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 /* is case sensitive params */
48 /* whether or not it may be executed via fantasy (default OFF) */
51 /* whether or not it may be executed via /command (default ON) */
54 /** Format that must be matched for use */
58 class ModuleAlias : public Module
62 /* We cant use a map, there may be multiple aliases with the same name.
63 * We can, however, use a fancy invention: the multimap. Maps a key to one or more values.
66 std::multimap<irc::string, Alias> Aliases;
68 /* whether or not +B users are allowed to use fantasy commands */
70 UserModeReference botmode;
73 void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
75 ConfigTag* fantasy = ServerInstance->Config->ConfValue("fantasy");
76 AllowBots = fantasy->getBool("allowbots", false);
77 std::string fpre = fantasy->getString("prefix", "!");
78 fprefix = fpre.empty() ? '!' : fpre[0];
81 ConfigTagList tags = ServerInstance->Config->ConfTags("alias");
82 for(ConfigIter i = tags.first; i != tags.second; ++i)
84 ConfigTag* tag = i->second;
86 std::string aliastext = tag->getString("text");
87 a.AliasedCommand = aliastext.c_str();
88 tag->readString("replace", a.ReplaceFormat, true);
89 a.RequiredNick = tag->getString("requires");
90 a.ULineOnly = tag->getBool("uline");
91 a.ChannelCommand = tag->getBool("channelcommand", false);
92 a.UserCommand = tag->getBool("usercommand", true);
93 a.OperOnly = tag->getBool("operonly");
94 a.format = tag->getString("format");
95 a.CaseSensitive = tag->getBool("matchcase");
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 ModResult OnPreCommand(std::string &command, std::vector<std::string> ¶meters, LocalUser *user, bool validated, const std::string &original_line) CXX11_OVERRIDE
137 std::multimap<irc::string, Alias>::iterator i, upperbound;
139 /* If theyre not registered yet, we dont want
142 if (user->registered != REG_ALL)
143 return MOD_RES_PASSTHRU;
145 /* We dont have any commands looking like this? Stop processing. */
146 i = Aliases.find(command.c_str());
147 if (i == Aliases.end())
148 return MOD_RES_PASSTHRU;
149 /* Avoid iterating on to different aliases if no patterns match. */
150 upperbound = Aliases.upper_bound(command.c_str());
152 irc::string c = command.c_str();
153 /* The parameters for the command in their original form, with the command stripped off */
154 std::string compare = original_line.substr(command.length());
155 while (*(compare.c_str()) == ' ')
156 compare.erase(compare.begin());
158 while (i != upperbound)
160 if (i->second.UserCommand)
162 if (DoAlias(user, NULL, &(i->second), compare, original_line))
171 // If we made it here, no aliases actually matched.
172 return MOD_RES_PASSTHRU;
175 void OnUserMessage(User *user, void *dest, int target_type, const std::string &text, char status, const CUList &exempt_list, MessageType msgtype) CXX11_OVERRIDE
177 if ((target_type != TYPE_CHANNEL) || (msgtype != MSG_PRIVMSG))
182 // fcommands are only for local users. Spanningtree will send them back out as their original cmd.
183 if (!user || !IS_LOCAL(user))
188 /* Stop here if the user is +B and allowbot is set to no. */
189 if (!AllowBots && user->IsModeSet(botmode))
194 Channel *c = (Channel *)dest;
195 std::string scommand;
197 // text is like "!moo cows bite me", we want "!moo" first
198 irc::spacesepstream ss(text);
199 ss.GetToken(scommand);
200 irc::string fcommand = scommand.c_str();
202 if (fcommand.empty())
207 // we don't want to touch non-fantasy stuff
208 if (*fcommand.c_str() != fprefix)
213 // nor do we give a shit about the prefix
214 fcommand.erase(fcommand.begin());
216 std::multimap<irc::string, Alias>::iterator i = Aliases.find(fcommand);
218 if (i == Aliases.end())
221 /* Avoid iterating on to other aliases if no patterns match */
222 std::multimap<irc::string, Alias>::iterator upperbound = Aliases.upper_bound(fcommand);
225 /* The parameters for the command in their original form, with the command stripped off */
226 std::string compare = text.substr(fcommand.length() + 1);
227 while (*(compare.c_str()) == ' ')
228 compare.erase(compare.begin());
230 while (i != upperbound)
232 if (i->second.ChannelCommand)
234 // We use substr(1) here to remove the fantasy prefix
235 if (DoAlias(user, c, &(i->second), compare, text.substr(1)))
244 int DoAlias(User *user, Channel *c, Alias *a, const std::string& compare, const std::string& safe)
248 /* Does it match the pattern? */
249 if (!a->format.empty())
251 if (a->CaseSensitive)
253 if (!InspIRCd::Match(compare, a->format, rfc_case_sensitive_map))
258 if (!InspIRCd::Match(compare, a->format))
263 if ((a->OperOnly) && (!user->IsOper()))
266 if (!a->RequiredNick.empty())
268 u = ServerInstance->FindNick(a->RequiredNick);
271 user->WriteNumeric(401, ""+user->nick+" "+a->RequiredNick+" :is currently unavailable. Please try again later.");
275 if ((u != NULL) && (!a->RequiredNick.empty()) && (a->ULineOnly))
277 if (!ServerInstance->ULine(u->server))
279 ServerInstance->SNO->WriteToSnoMask('a', "NOTICE -- Service "+a->RequiredNick+" required by alias "+std::string(a->AliasedCommand.c_str())+" is not on a u-lined server, possibly underhanded antics detected!");
280 user->WriteNumeric(401, ""+user->nick+" "+a->RequiredNick+" :is an imposter! Please inform an IRC operator as soon as possible.");
285 /* Now, search and replace in a copy of the original_line, replacing $1 through $9 and $1- etc */
287 std::string::size_type crlf = a->ReplaceFormat.find('\n');
289 if (crlf == std::string::npos)
291 DoCommand(a->ReplaceFormat, user, c, safe);
296 irc::sepstream commands(a->ReplaceFormat, '\n');
297 std::string scommand;
298 while (commands.GetToken(scommand))
300 DoCommand(scommand, user, c, safe);
306 void DoCommand(const std::string& newline, User* user, Channel *chan, const std::string &original_line)
309 result.reserve(newline.length());
310 for (unsigned int i = 0; i < newline.length(); i++)
315 if (isdigit(newline[i+1]))
317 int len = (newline[i+2] == '-') ? 3 : 2;
318 std::string var = newline.substr(i, len);
319 result.append(GetVar(var, original_line));
322 else if (newline.substr(i, 5) == "$nick")
324 result.append(user->nick);
327 else if (newline.substr(i, 5) == "$host")
329 result.append(user->host);
332 else if (newline.substr(i, 5) == "$chan")
335 result.append(chan->name);
338 else if (newline.substr(i, 6) == "$ident")
340 result.append(user->ident);
343 else if (newline.substr(i, 6) == "$vhost")
345 result.append(user->dhost);
355 irc::tokenstream ss(result);
356 std::vector<std::string> pars;
357 std::string command, token;
359 ss.GetToken(command);
360 while (ss.GetToken(token))
362 pars.push_back(token);
364 ServerInstance->Parser->CallHandler(command, pars, user);
369 // Prioritise after spanningtree so that channel aliases show the alias before the effects.
370 Module* linkmod = ServerInstance->Modules->Find("m_spanningtree.so");
371 ServerInstance->Modules->SetPriority(this, I_OnUserMessage, PRIORITY_AFTER, &linkmod);
375 MODULE_INIT(ModuleAlias)