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;
74 ConfigTag* fantasy = ServerInstance->Config->ConfValue("fantasy");
75 AllowBots = fantasy->getBool("allowbots", false);
76 std::string fpre = fantasy->getString("prefix", "!");
77 fprefix = fpre.empty() ? '!' : fpre[0];
80 ConfigTagList tags = ServerInstance->Config->ConfTags("alias");
81 for(ConfigIter i = tags.first; i != tags.second; ++i)
83 ConfigTag* tag = i->second;
85 std::string aliastext = tag->getString("text");
86 a.AliasedCommand = aliastext.c_str();
87 tag->readString("replace", a.ReplaceFormat, true);
88 a.RequiredNick = tag->getString("requires");
89 a.ULineOnly = tag->getBool("uline");
90 a.ChannelCommand = tag->getBool("channelcommand", false);
91 a.UserCommand = tag->getBool("usercommand", true);
92 a.OperOnly = tag->getBool("operonly");
93 a.format = tag->getString("format");
94 a.CaseSensitive = tag->getBool("matchcase");
95 Aliases.insert(std::make_pair(a.AliasedCommand, a));
101 : botmode(this, "bot")
105 void init() CXX11_OVERRIDE
108 Implementation eventlist[] = { I_OnPreCommand, I_OnRehash, I_OnUserMessage };
109 ServerInstance->Modules->Attach(eventlist, this, sizeof(eventlist)/sizeof(Implementation));
112 Version GetVersion() CXX11_OVERRIDE
114 return Version("Provides aliases of commands.", VF_VENDOR);
117 std::string GetVar(std::string varname, const std::string &original_line)
119 irc::spacesepstream ss(original_line);
120 varname.erase(varname.begin());
121 int index = *(varname.begin()) - 48;
122 varname.erase(varname.begin());
123 bool everything_after = (varname == "-");
126 for (int j = 0; j < index; j++)
129 if (everything_after)
132 while (ss.GetToken(more))
142 ModResult OnPreCommand(std::string &command, std::vector<std::string> ¶meters, LocalUser *user, bool validated, const std::string &original_line) CXX11_OVERRIDE
144 std::multimap<irc::string, Alias>::iterator i, upperbound;
146 /* If theyre not registered yet, we dont want
149 if (user->registered != REG_ALL)
150 return MOD_RES_PASSTHRU;
152 /* We dont have any commands looking like this? Stop processing. */
153 i = Aliases.find(command.c_str());
154 if (i == Aliases.end())
155 return MOD_RES_PASSTHRU;
156 /* Avoid iterating on to different aliases if no patterns match. */
157 upperbound = Aliases.upper_bound(command.c_str());
159 irc::string c = command.c_str();
160 /* The parameters for the command in their original form, with the command stripped off */
161 std::string compare = original_line.substr(command.length());
162 while (*(compare.c_str()) == ' ')
163 compare.erase(compare.begin());
165 while (i != upperbound)
167 if (i->second.UserCommand)
169 if (DoAlias(user, NULL, &(i->second), compare, original_line))
178 // If we made it here, no aliases actually matched.
179 return MOD_RES_PASSTHRU;
182 void OnUserMessage(User *user, void *dest, int target_type, const std::string &text, char status, const CUList &exempt_list, MessageType msgtype) CXX11_OVERRIDE
184 if ((target_type != TYPE_CHANNEL) || (msgtype != MSG_PRIVMSG))
189 // fcommands are only for local users. Spanningtree will send them back out as their original cmd.
190 if (!user || !IS_LOCAL(user))
195 /* Stop here if the user is +B and allowbot is set to no. */
196 if (!AllowBots && user->IsModeSet(botmode))
201 Channel *c = (Channel *)dest;
202 std::string scommand;
204 // text is like "!moo cows bite me", we want "!moo" first
205 irc::spacesepstream ss(text);
206 ss.GetToken(scommand);
207 irc::string fcommand = scommand.c_str();
209 if (fcommand.empty())
214 // we don't want to touch non-fantasy stuff
215 if (*fcommand.c_str() != fprefix)
220 // nor do we give a shit about the prefix
221 fcommand.erase(fcommand.begin());
223 std::multimap<irc::string, Alias>::iterator i = Aliases.find(fcommand);
225 if (i == Aliases.end())
228 /* Avoid iterating on to other aliases if no patterns match */
229 std::multimap<irc::string, Alias>::iterator upperbound = Aliases.upper_bound(fcommand);
232 /* The parameters for the command in their original form, with the command stripped off */
233 std::string compare = text.substr(fcommand.length() + 1);
234 while (*(compare.c_str()) == ' ')
235 compare.erase(compare.begin());
237 while (i != upperbound)
239 if (i->second.ChannelCommand)
241 // We use substr(1) here to remove the fantasy prefix
242 if (DoAlias(user, c, &(i->second), compare, text.substr(1)))
251 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 (a->CaseSensitive)
260 if (!InspIRCd::Match(compare, a->format, rfc_case_sensitive_map))
265 if (!InspIRCd::Match(compare, a->format))
270 if ((a->OperOnly) && (!user->IsOper()))
273 if (!a->RequiredNick.empty())
275 u = ServerInstance->FindNick(a->RequiredNick);
278 user->WriteNumeric(401, ""+user->nick+" "+a->RequiredNick+" :is currently unavailable. Please try again later.");
282 if ((u != NULL) && (!a->RequiredNick.empty()) && (a->ULineOnly))
284 if (!ServerInstance->ULine(u->server))
286 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!");
287 user->WriteNumeric(401, ""+user->nick+" "+a->RequiredNick+" :is an imposter! Please inform an IRC operator as soon as possible.");
292 /* Now, search and replace in a copy of the original_line, replacing $1 through $9 and $1- etc */
294 std::string::size_type crlf = a->ReplaceFormat.find('\n');
296 if (crlf == std::string::npos)
298 DoCommand(a->ReplaceFormat, user, c, safe);
303 irc::sepstream commands(a->ReplaceFormat, '\n');
304 std::string scommand;
305 while (commands.GetToken(scommand))
307 DoCommand(scommand, user, c, safe);
313 void DoCommand(const std::string& newline, User* user, Channel *chan, const std::string &original_line)
316 result.reserve(newline.length());
317 for (unsigned int i = 0; i < newline.length(); i++)
322 if (isdigit(newline[i+1]))
324 int len = (newline[i+2] == '-') ? 3 : 2;
325 std::string var = newline.substr(i, len);
326 result.append(GetVar(var, original_line));
329 else if (newline.substr(i, 5) == "$nick")
331 result.append(user->nick);
334 else if (newline.substr(i, 5) == "$host")
336 result.append(user->host);
339 else if (newline.substr(i, 5) == "$chan")
342 result.append(chan->name);
345 else if (newline.substr(i, 6) == "$ident")
347 result.append(user->ident);
350 else if (newline.substr(i, 6) == "$vhost")
352 result.append(user->dhost);
362 irc::tokenstream ss(result);
363 std::vector<std::string> pars;
364 std::string command, token;
366 ss.GetToken(command);
367 while (ss.GetToken(token))
369 pars.push_back(token);
371 ServerInstance->Parser->CallHandler(command, pars, user);
374 void OnRehash(User* user) CXX11_OVERRIDE
381 // Prioritise after spanningtree so that channel aliases show the alias before the effects.
382 Module* linkmod = ServerInstance->Modules->Find("m_spanningtree.so");
383 ServerInstance->Modules->SetPriority(this, I_OnUserMessage, PRIORITY_AFTER, &linkmod);
387 MODULE_INIT(ModuleAlias)