* | Inspire Internet Relay Chat Daemon |
* +------------------------------------+
*
- * InspIRCd: (C) 2002-2008 InspIRCd Development Team
- * See: http://www.inspircd.org/wiki/index.php/Credits
+ * InspIRCd: (C) 2002-2009 InspIRCd Development Team
+ * See: http://wiki.inspircd.org/Credits
*
* This program is free but copyrighted software; see
* the file COPYING for details.
*/
#include "inspircd.h"
-#include "wildcard.h"
/* $ModDesc: Provides aliases of commands. */
{
public:
/** The text of the alias command */
- irc::string text;
+ irc::string AliasedCommand;
+
/** Text to replace with */
- std::string replace_with;
+ std::string ReplaceFormat;
+
/** Nickname required to perform alias */
- std::string requires;
+ std::string RequiredNick;
+
/** Alias requires ulined server */
- bool uline;
+ bool ULineOnly;
+
/** Requires oper? */
- bool operonly;
+ bool OperOnly;
+
/* is case sensitive params */
- bool case_sensitive;
+ bool CaseSensitive;
+
+ /* whether or not it may be executed via fantasy (default OFF) */
+ bool ChannelCommand;
+
+ /* whether or not it may be executed via /command (default ON) */
+ bool UserCommand;
+
/** Format that must be matched for use */
std::string format;
};
class ModuleAlias : public Module
{
private:
- /** We cant use a map, there may be multiple aliases with the same name */
- std::vector<Alias> Aliases;
- std::map<std::string, int> AliasMap;
- std::vector<std::string> pars;
+
+ char fprefix;
+
+ /* We cant use a map, there may be multiple aliases with the same name.
+ * We can, however, use a fancy invention: the multimap. Maps a key to one or more values.
+ * -- w00t
+ */
+ std::multimap<std::string, Alias> Aliases;
+
+ /* whether or not +B users are allowed to use fantasy commands */
+ bool AllowBots;
virtual void ReadAliases()
{
- ConfigReader MyConf(ServerInstance);
+ ConfigReader MyConf;
+
+ AllowBots = MyConf.ReadFlag("fantasy", "allowbots", "no", 0);
+
+ std::string fpre = MyConf.ReadValue("fantasy","prefix",0);
+ fprefix = fpre.empty() ? '!' : fpre[0];
Aliases.clear();
- AliasMap.clear();
for (int i = 0; i < MyConf.Enumerate("alias"); i++)
{
Alias a;
std::string txt;
txt = MyConf.ReadValue("alias", "text", i);
- a.text = txt.c_str();
- a.replace_with = MyConf.ReadValue("alias", "replace", i, true);
- a.requires = MyConf.ReadValue("alias", "requires", i);
- a.uline = MyConf.ReadFlag("alias", "uline", i);
- a.operonly = MyConf.ReadFlag("alias", "operonly", i);
+ a.AliasedCommand = txt.c_str();
+ a.ReplaceFormat = MyConf.ReadValue("alias", "replace", i, true);
+ a.RequiredNick = MyConf.ReadValue("alias", "requires", i);
+ a.ULineOnly = MyConf.ReadFlag("alias", "uline", i);
+ a.ChannelCommand = MyConf.ReadFlag("alias", "channelcommand", "no", i);
+ a.UserCommand = MyConf.ReadFlag("alias", "usercommand", "yes", i);
+ a.OperOnly = MyConf.ReadFlag("alias", "operonly", i);
a.format = MyConf.ReadValue("alias", "format", i);
- a.case_sensitive = MyConf.ReadFlag("alias", "matchcase", i);
- Aliases.push_back(a);
- AliasMap[txt] = 1;
+ a.CaseSensitive = MyConf.ReadFlag("alias", "matchcase", i);
+ Aliases.insert(std::make_pair(txt, a));
}
}
public:
- ModuleAlias(InspIRCd* Me)
- : Module(Me)
- {
+ ModuleAlias()
+ {
ReadAliases();
- Me->Modules->Attach(I_OnPreCommand, this);
- Me->Modules->Attach(I_OnRehash, this);
+ ServerInstance->Modules->Attach(I_OnPreCommand, this);
+ ServerInstance->Modules->Attach(I_OnRehash, this);
+ ServerInstance->Modules->Attach(I_OnUserMessage, this);
}
virtual Version GetVersion()
{
- return Version(1,2,0,1,VF_VENDOR,API_VERSION);
+ return Version("Provides aliases of commands.", VF_VENDOR,API_VERSION);
}
std::string GetVar(std::string varname, const std::string &original_line)
return word;
}
- void SearchAndReplace(std::string& newline, const std::string &find, const std::string &replace)
+ virtual ModResult OnPreCommand(std::string &command, std::vector<std::string> ¶meters, User *user, bool validated, const std::string &original_line)
{
- std::string::size_type x = newline.find(find);
- while (x != std::string::npos)
- {
- newline.erase(x, find.length());
- newline.insert(x, replace);
- x = newline.find(find);
- }
- }
-
- virtual int OnPreCommand(std::string &command, std::vector<std::string> ¶meters, User *user, bool validated, const std::string &original_line)
- {
- User *u = NULL;
+ std::multimap<std::string, Alias>::iterator i, upperbound;
/* If theyre not registered yet, we dont want
* to know.
*/
if (user->registered != REG_ALL)
- return 0;
+ return MOD_RES_PASSTHRU;
- /* We dont have any commands looking like this, dont bother with the loop */
- if (AliasMap.find(command) == AliasMap.end())
- return 0;
+ /* We dont have any commands looking like this? Stop processing. */
+ i = Aliases.find(command);
+ if (i == Aliases.end())
+ return MOD_RES_PASSTHRU;
+ /* Avoid iterating on to different aliases if no patterns match. */
+ upperbound = Aliases.upper_bound(command);
irc::string c = command.c_str();
/* The parameters for the command in their original form, with the command stripped off */
while (*(compare.c_str()) == ' ')
compare.erase(compare.begin());
- std::string safe(original_line);
+ while (i != upperbound)
+ {
+ if (i->second.UserCommand)
+ {
+ if (DoAlias(user, NULL, &(i->second), compare, original_line))
+ {
+ return MOD_RES_DENY;
+ }
+ }
+
+ i++;
+ }
+
+ // If we made it here, no aliases actually matched.
+ return MOD_RES_PASSTHRU;
+ }
+
+ virtual void OnUserMessage(User *user, void *dest, int target_type, const std::string &text, char status, const CUList &exempt_list)
+ {
+ if (target_type != TYPE_CHANNEL)
+ {
+ return;
+ }
+
+ // fcommands are only for local users. Spanningtree will send them back out as their original cmd.
+ if (!user || !IS_LOCAL(user))
+ {
+ return;
+ }
+
+ /* Stop here if the user is +B and allowbot is set to no. */
+ if (!AllowBots && user->IsModeSet('B'))
+ {
+ return;
+ }
+
+ Channel *c = (Channel *)dest;
+ std::string fcommand;
+
+ // text is like "!moo cows bite me", we want "!moo" first
+ irc::spacesepstream ss(text);
+ ss.GetToken(fcommand);
+
+ if (fcommand.empty())
+ {
+ return; // wtfbbq
+ }
+
+ // we don't want to touch non-fantasy stuff
+ if (*fcommand.c_str() != fprefix)
+ {
+ return;
+ }
+
+ // nor do we give a shit about the prefix
+ fcommand.erase(fcommand.begin());
+ std::transform(fcommand.begin(), fcommand.end(), fcommand.begin(), ::toupper);
+
+ std::multimap<std::string, Alias>::iterator i = Aliases.find(fcommand);
- /* Escape out any $ symbols in the user provided text */
+ if (i == Aliases.end())
+ return;
- SearchAndReplace(safe, "$", "\r");
+ /* Avoid iterating on to other aliases if no patterns match */
+ std::multimap<std::string, Alias>::iterator upperbound = Aliases.upper_bound(fcommand);
- for (unsigned int i = 0; i < Aliases.size(); i++)
+
+ /* The parameters for the command in their original form, with the command stripped off */
+ std::string compare = text.substr(fcommand.length() + 1);
+ while (*(compare.c_str()) == ' ')
+ compare.erase(compare.begin());
+
+ while (i != upperbound)
{
- if (Aliases[i].text == c)
+ if (i->second.ChannelCommand)
{
- /* Does it match the pattern? */
- if (!Aliases[i].format.empty())
- {
- if (!match(Aliases[i].case_sensitive, compare, Aliases[i].format))
- continue;
- }
+ // We use substr(1) here to remove the fantasy prefix
+ if (DoAlias(user, c, &(i->second), compare, text.substr(1)))
+ return;
+ }
+
+ i++;
+ }
+ }
+
+
+ int DoAlias(User *user, Channel *c, Alias *a, const std::string compare, const std::string safe)
+ {
+ User *u = NULL;
- if ((Aliases[i].operonly) && (!IS_OPER(user)))
+ /* Does it match the pattern? */
+ if (!a->format.empty())
+ {
+ if (a->CaseSensitive)
+ {
+ if (!InspIRCd::Match(compare, a->format, rfc_case_sensitive_map))
+ return 0;
+ }
+ else
+ {
+ if (!InspIRCd::Match(compare, a->format))
return 0;
+ }
+ }
- if (!Aliases[i].requires.empty())
- {
- u = ServerInstance->FindNick(Aliases[i].requires);
- if (!u)
- {
- user->WriteNumeric(401, ""+std::string(user->nick)+" "+Aliases[i].requires+" :is currently unavailable. Please try again later.");
- return 1;
- }
- }
- if ((u != NULL) && (!Aliases[i].requires.empty()) && (Aliases[i].uline))
- {
- if (!ServerInstance->ULine(u->server))
- {
- ServerInstance->SNO->WriteToSnoMask('A', "NOTICE -- Service "+Aliases[i].requires+" required by alias "+std::string(Aliases[i].text.c_str())+" is not on a u-lined server, possibly underhanded antics detected!");
- user->WriteNumeric(401, ""+std::string(user->nick)+" "+Aliases[i].requires+" :is an imposter! Please inform an IRC operator as soon as possible.");
- return 1;
- }
- }
+ if ((a->OperOnly) && (!IS_OPER(user)))
+ return 0;
- /* Now, search and replace in a copy of the original_line, replacing $1 through $9 and $1- etc */
+ if (!a->RequiredNick.empty())
+ {
+ u = ServerInstance->FindNick(a->RequiredNick);
+ if (!u)
+ {
+ user->WriteNumeric(401, ""+std::string(user->nick)+" "+a->RequiredNick+" :is currently unavailable. Please try again later.");
+ return 1;
+ }
+ }
+ if ((u != NULL) && (!a->RequiredNick.empty()) && (a->ULineOnly))
+ {
+ if (!ServerInstance->ULine(u->server))
+ {
+ 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!");
+ user->WriteNumeric(401, ""+std::string(user->nick)+" "+a->RequiredNick+" :is an imposter! Please inform an IRC operator as soon as possible.");
+ return 1;
+ }
+ }
- std::string::size_type crlf = Aliases[i].replace_with.find('\n');
+ /* Now, search and replace in a copy of the original_line, replacing $1 through $9 and $1- etc */
- if (crlf == std::string::npos)
- {
- DoCommand(Aliases[i].replace_with, user, safe);
- return 1;
- }
- else
- {
- irc::sepstream commands(Aliases[i].replace_with, '\n');
- std::string scommand;
- while (commands.GetToken(scommand))
- {
- DoCommand(scommand, user, safe);
- }
- return 1;
- }
+ std::string::size_type crlf = a->ReplaceFormat.find('\n');
+
+ if (crlf == std::string::npos)
+ {
+ DoCommand(a->ReplaceFormat, user, c, safe);
+ return 1;
+ }
+ else
+ {
+ irc::sepstream commands(a->ReplaceFormat, '\n');
+ std::string scommand;
+ while (commands.GetToken(scommand))
+ {
+ DoCommand(scommand, user, c, safe);
}
+ return 1;
}
- return 0;
}
- void DoCommand(std::string newline, User* user, const std::string &original_line)
+ void DoCommand(std::string newline, User* user, Channel *c, const std::string &original_line)
{
+ std::vector<std::string> pars;
+
for (int v = 1; v < 10; v++)
{
std::string var = "$";
}
/* Special variables */
- SearchAndReplace(newline, "$nick", user->nick);
- SearchAndReplace(newline, "$ident", user->ident);
- SearchAndReplace(newline, "$host", user->host);
- SearchAndReplace(newline, "$vhost", user->dhost);
+ SearchAndReplace(newline, std::string("$nick"), user->nick);
+ SearchAndReplace(newline, std::string("$ident"), user->ident);
+ SearchAndReplace(newline, std::string("$host"), user->host);
+ SearchAndReplace(newline, std::string("$vhost"), user->dhost);
- /* Unescape any variable names in the user text before sending */
- SearchAndReplace(newline, "\r", "$");
+ if (c)
+ {
+ /* Channel specific variables */
+ SearchAndReplace(newline, std::string("$chan"), c->name);
+ }
+ else
+ {
+ /* We don't want these in a user alias */
+ SearchAndReplace(newline, std::string("$chan"), std::string(""));
+ }
irc::tokenstream ss(newline);
pars.clear();
ServerInstance->Parser->CallHandler(command, pars, user);
}
- virtual void OnRehash(User* user, const std::string ¶meter)
+ virtual void OnRehash(User* user)
{
ReadAliases();
}
+
+ virtual void Prioritize()
+ {
+ // Prioritise after spanningtree so that channel aliases show the alias before the effects.
+ Module* linkmod = ServerInstance->Modules->Find("m_spanningtree.so");
+ ServerInstance->Modules->SetPriority(this, I_OnUserMessage, PRIORITY_AFTER, &linkmod);
+ }
};
MODULE_INIT(ModuleAlias)
projects / user / henk / code / inspircd.git / blobdiff