1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2009 InspIRCd Development Team
6 * See: http://wiki.inspircd.org/Credits
8 * This program is free but copyrighted software; see
9 * the file COPYING for details.
11 * ---------------------------------------------------
16 /* $ModDesc: Provides aliases of commands. */
18 /** An alias definition
20 class Alias : public classbase
23 /** The text of the alias command */
24 irc::string AliasedCommand;
26 /** Text to replace with */
27 std::string ReplaceFormat;
29 /** Nickname required to perform alias */
30 std::string RequiredNick;
32 /** Alias requires ulined server */
38 /* is case sensitive params */
41 /* whether or not it may be executed via fantasy (default OFF) */
44 /* whether or not it may be executed via /command (default ON) */
47 /** Format that must be matched for use */
51 class ModuleAlias : public Module
57 /* We cant use a map, there may be multiple aliases with the same name.
58 * We can, however, use a fancy invention: the multimap. Maps a key to one or more values.
61 std::multimap<std::string, Alias> Aliases;
63 /* whether or not +B users are allowed to use fantasy commands */
66 virtual void ReadAliases()
70 AllowBots = MyConf.ReadFlag("fantasy", "allowbots", "no", 0);
72 std::string fpre = MyConf.ReadValue("fantasy","prefix",0);
73 fprefix = fpre.empty() ? '!' : fpre[0];
76 for (int i = 0; i < MyConf.Enumerate("alias"); i++)
80 txt = MyConf.ReadValue("alias", "text", i);
81 a.AliasedCommand = txt.c_str();
82 a.ReplaceFormat = MyConf.ReadValue("alias", "replace", i, true);
83 a.RequiredNick = MyConf.ReadValue("alias", "requires", i);
84 a.ULineOnly = MyConf.ReadFlag("alias", "uline", i);
85 a.ChannelCommand = MyConf.ReadFlag("alias", "channelcommand", "no", i);
86 a.UserCommand = MyConf.ReadFlag("alias", "usercommand", "yes", i);
87 a.OperOnly = MyConf.ReadFlag("alias", "operonly", i);
88 a.format = MyConf.ReadValue("alias", "format", i);
89 a.CaseSensitive = MyConf.ReadFlag("alias", "matchcase", i);
90 Aliases.insert(std::make_pair(txt, a));
99 ServerInstance->Modules->Attach(I_OnPreCommand, this);
100 ServerInstance->Modules->Attach(I_OnRehash, this);
101 ServerInstance->Modules->Attach(I_OnUserMessage, this);
105 virtual ~ModuleAlias()
109 virtual Version GetVersion()
111 return Version("Provides aliases of commands.", VF_VENDOR,API_VERSION);
114 std::string GetVar(std::string varname, const std::string &original_line)
116 irc::spacesepstream ss(original_line);
117 varname.erase(varname.begin());
118 int index = *(varname.begin()) - 48;
119 varname.erase(varname.begin());
120 bool everything_after = (varname == "-");
123 for (int j = 0; j < index; j++)
126 if (everything_after)
129 while (ss.GetToken(more))
139 virtual ModResult OnPreCommand(std::string &command, std::vector<std::string> ¶meters, User *user, bool validated, const std::string &original_line)
141 std::multimap<std::string, Alias>::iterator i, upperbound;
143 /* If theyre not registered yet, we dont want
146 if (user->registered != REG_ALL)
147 return MOD_RES_PASSTHRU;
149 /* We dont have any commands looking like this? Stop processing. */
150 i = Aliases.find(command);
151 if (i == Aliases.end())
152 return MOD_RES_PASSTHRU;
153 /* Avoid iterating on to different aliases if no patterns match. */
154 upperbound = Aliases.upper_bound(command);
156 irc::string c = command.c_str();
157 /* The parameters for the command in their original form, with the command stripped off */
158 std::string compare = original_line.substr(command.length());
159 while (*(compare.c_str()) == ' ')
160 compare.erase(compare.begin());
162 while (i != upperbound)
164 if (i->second.UserCommand)
166 if (DoAlias(user, NULL, &(i->second), compare, original_line))
175 // If we made it here, no aliases actually matched.
176 return MOD_RES_PASSTHRU;
179 virtual void OnUserMessage(User *user, void *dest, int target_type, const std::string &text, char status, const CUList &exempt_list)
181 if (target_type != TYPE_CHANNEL)
186 // fcommands are only for local users. Spanningtree will send them back out as their original cmd.
187 if (!user || !IS_LOCAL(user))
192 /* Stop here if the user is +B and allowbot is set to no. */
193 if (!AllowBots && user->IsModeSet('B'))
198 Channel *c = (Channel *)dest;
199 std::string fcommand;
201 // text is like "!moo cows bite me", we want "!moo" first
202 irc::spacesepstream ss(text);
203 ss.GetToken(fcommand);
205 if (fcommand.empty())
210 // we don't want to touch non-fantasy stuff
211 if (*fcommand.c_str() != fprefix)
216 // nor do we give a shit about the prefix
217 fcommand.erase(fcommand.begin());
218 std::transform(fcommand.begin(), fcommand.end(), fcommand.begin(), ::toupper);
220 std::multimap<std::string, Alias>::iterator i = Aliases.find(fcommand);
222 if (i == Aliases.end())
225 /* Avoid iterating on to other aliases if no patterns match */
226 std::multimap<std::string, Alias>::iterator upperbound = Aliases.upper_bound(fcommand);
229 /* The parameters for the command in their original form, with the command stripped off */
230 std::string compare = text.substr(fcommand.length() + 1);
231 while (*(compare.c_str()) == ' ')
232 compare.erase(compare.begin());
234 while (i != upperbound)
236 if (i->second.ChannelCommand)
238 // We use substr(1) here to remove the fantasy prefix
239 if (DoAlias(user, c, &(i->second), compare, text.substr(1)))
248 int DoAlias(User *user, Channel *c, Alias *a, const std::string compare, const std::string safe)
252 /* Does it match the pattern? */
253 if (!a->format.empty())
255 if (a->CaseSensitive)
257 if (!InspIRCd::Match(compare, a->format, rfc_case_sensitive_map))
262 if (!InspIRCd::Match(compare, a->format))
267 if ((a->OperOnly) && (!IS_OPER(user)))
270 if (!a->RequiredNick.empty())
272 u = ServerInstance->FindNick(a->RequiredNick);
275 user->WriteNumeric(401, ""+std::string(user->nick)+" "+a->RequiredNick+" :is currently unavailable. Please try again later.");
279 if ((u != NULL) && (!a->RequiredNick.empty()) && (a->ULineOnly))
281 if (!ServerInstance->ULine(u->server))
283 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!");
284 user->WriteNumeric(401, ""+std::string(user->nick)+" "+a->RequiredNick+" :is an imposter! Please inform an IRC operator as soon as possible.");
289 /* Now, search and replace in a copy of the original_line, replacing $1 through $9 and $1- etc */
291 std::string::size_type crlf = a->ReplaceFormat.find('\n');
293 if (crlf == std::string::npos)
295 DoCommand(a->ReplaceFormat, user, c, safe);
300 irc::sepstream commands(a->ReplaceFormat, '\n');
301 std::string scommand;
302 while (commands.GetToken(scommand))
304 DoCommand(scommand, user, c, safe);
310 void DoCommand(std::string newline, User* user, Channel *c, const std::string &original_line)
312 std::vector<std::string> pars;
314 for (int v = 1; v < 10; v++)
316 std::string var = "$";
317 var.append(ConvToStr(v));
319 std::string::size_type x = newline.find(var);
321 while (x != std::string::npos)
323 newline.erase(x, var.length());
324 newline.insert(x, GetVar(var, original_line));
325 x = newline.find(var);
329 var.append(ConvToStr(v));
330 x = newline.find(var);
332 while (x != std::string::npos)
334 newline.erase(x, var.length());
335 newline.insert(x, GetVar(var, original_line));
336 x = newline.find(var);
340 /* Special variables */
341 SearchAndReplace(newline, std::string("$nick"), user->nick);
342 SearchAndReplace(newline, std::string("$ident"), user->ident);
343 SearchAndReplace(newline, std::string("$host"), user->host);
344 SearchAndReplace(newline, std::string("$vhost"), user->dhost);
348 /* Channel specific variables */
349 SearchAndReplace(newline, std::string("$chan"), c->name);
353 /* We don't want these in a user alias */
354 SearchAndReplace(newline, std::string("$chan"), std::string(""));
357 irc::tokenstream ss(newline);
359 std::string command, token;
361 ss.GetToken(command);
362 while (ss.GetToken(token) && (pars.size() <= MAXPARAMETERS))
364 pars.push_back(token);
366 ServerInstance->Parser->CallHandler(command, pars, user);
369 virtual void OnRehash(User* user)
374 virtual void Prioritize()
376 // Prioritise after spanningtree so that channel aliases show the alias before the effects.
377 Module* linkmod = ServerInstance->Modules->Find("m_spanningtree.so");
378 ServerInstance->Modules->SetPriority(this, I_OnUserMessage, PRIORITY_AFTER, &linkmod);
382 MODULE_INIT(ModuleAlias)