-/* +------------------------------------+
- * | Inspire Internet Relay Chat Daemon |
- * +------------------------------------+
+/* +------------------------------------+
+ * | Inspire Internet Relay Chat Daemon |
+ * +------------------------------------+
+ *
+ * InspIRCd: (C) 2002-2010 InspIRCd Development Team
+ * See: http://wiki.inspircd.org/Credits
*
- * InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
- * E-mail:
- * <brain@chatspike.net>
- * <Craig@chatspike.net>
- *
- * Written by Craig Edwards, Craig McLure, and others.
* This program is free but copyrighted software; see
- *the file COPYING for details.
+ * the file COPYING for details.
*
* ---------------------------------------------------
*/
-using namespace std;
-
-#include "users.h"
-#include "channels.h"
-#include "modules.h"
#include "inspircd.h"
-#include <vector>
/* $ModDesc: Provides aliases of commands. */
-class Alias : public classbase
+/** An alias definition
+ */
+class Alias
{
public:
- irc::string text;
- std::string replace_with;
- std::string requires;
- bool uline;
+ /** The text of the alias command */
+ irc::string AliasedCommand;
+
+ /** Text to replace with */
+ std::string ReplaceFormat;
+
+ /** Nickname required to perform alias */
+ std::string RequiredNick;
+
+ /** Alias requires ulined server */
+ bool ULineOnly;
+
+ /** Requires oper? */
+ bool OperOnly;
+
+ /* is case sensitive params */
+ 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:
- ConfigReader *MyConf;
- std::vector<Alias> Aliases;
+
+ 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<irc::string, Alias> Aliases;
+
+ /* whether or not +B users are allowed to use fantasy commands */
+ bool AllowBots;
virtual void ReadAliases()
{
+ ConfigReader MyConf;
+
+ AllowBots = MyConf.ReadFlag("fantasy", "allowbots", "no", 0);
+
+ std::string fpre = MyConf.ReadValue("fantasy","prefix",0);
+ fprefix = fpre.empty() ? '!' : fpre[0];
+
Aliases.clear();
-
- for (int i = 0; i < MyConf->Enumerate("alias"); i++)
+ ConfigTagList tags = ServerInstance->Config->ConfTags("alias");
+ for(ConfigIter i = tags.first; i != tags.second; ++i)
{
+ ConfigTag* tag = i->second;
Alias a;
- std::string txt;
- txt = MyConf->ReadValue("alias", "text", i);
- a.text = txt.c_str();
- a.replace_with = MyConf->ReadValue("alias", "replace", i);
- a.requires = MyConf->ReadValue("alias", "requires", i);
-
- a.uline = ((MyConf->ReadValue("alias", "uline", i) == "yes") ||
- (MyConf->ReadValue("alias", "uline", i) == "1") ||
- (MyConf->ReadValue("alias", "uline", i) == "true"));
-
- Aliases.push_back(a);
+ a.AliasedCommand = tag->getString("text").c_str();
+ tag->readString("replace", a.ReplaceFormat, true);
+ a.RequiredNick = tag->getString("requires");
+ a.ULineOnly = tag->getBool("uline");
+ a.ChannelCommand = tag->getBool("channelcommand", "no");
+ a.UserCommand = tag->getBool("usercommand", "yes");
+ a.OperOnly = tag->getBool("operonly");
+ a.format = tag->getString("format");
+ a.CaseSensitive = tag->getBool("matchcase");
+ Aliases.insert(std::make_pair(a.AliasedCommand, a));
}
-
}
public:
-
- ModuleAlias(InspIRCd* Me)
- : Module::Module(Me)
+
+ ModuleAlias()
{
-
- MyConf = new ConfigReader(ServerInstance);
ReadAliases();
+ ServerInstance->Modules->Attach(I_OnPreCommand, this);
+ ServerInstance->Modules->Attach(I_OnRehash, this);
+ ServerInstance->Modules->Attach(I_OnUserMessage, this);
}
- void Implements(char* List)
+ virtual ~ModuleAlias()
{
- List[I_OnPreCommand] = List[I_OnRehash] = 1;
}
- virtual ~ModuleAlias()
+ virtual Version GetVersion()
{
- DELETE(MyConf);
+ return Version("Provides aliases of commands.", VF_VENDOR);
}
- virtual Version GetVersion()
+ std::string GetVar(std::string varname, const std::string &original_line)
{
- return Version(1,0,0,1,VF_VENDOR);
+ irc::spacesepstream ss(original_line);
+ varname.erase(varname.begin());
+ int index = *(varname.begin()) - 48;
+ varname.erase(varname.begin());
+ bool everything_after = (varname == "-");
+ std::string word;
+
+ for (int j = 0; j < index; j++)
+ ss.GetToken(word);
+
+ if (everything_after)
+ {
+ std::string more;
+ while (ss.GetToken(more))
+ {
+ word.append(" ");
+ word.append(more);
+ }
+ }
+
+ return word;
}
- virtual int OnPreCommand(const std::string &command, const char** parameters, int pcnt, userrec *user, bool validated)
+ virtual ModResult OnPreCommand(std::string &command, std::vector<std::string> ¶meters, LocalUser *user, bool validated, const std::string &original_line)
{
- userrec *u = NULL;
- irc::string c = command.c_str();
- /* If the command is valid, we dont want to know,
- * and if theyre not registered yet, we dont want
- * to know either
+ std::multimap<irc::string, Alias>::iterator i, upperbound;
+
+ /* If theyre not registered yet, we dont want
+ * to know.
*/
- if ((validated) || (user->registered != REG_ALL))
+ if (user->registered != REG_ALL)
+ return MOD_RES_PASSTHRU;
+
+ /* We dont have any commands looking like this? Stop processing. */
+ i = Aliases.find(command.c_str());
+ if (i == Aliases.end())
+ return MOD_RES_PASSTHRU;
+ /* Avoid iterating on to different aliases if no patterns match. */
+ upperbound = Aliases.upper_bound(command.c_str());
+
+ irc::string c = command.c_str();
+ /* The parameters for the command in their original form, with the command stripped off */
+ std::string compare = original_line.substr(command.length());
+ while (*(compare.c_str()) == ' ')
+ compare.erase(compare.begin());
+
+ 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 scommand;
+
+ // text is like "!moo cows bite me", we want "!moo" first
+ irc::spacesepstream ss(text);
+ ss.GetToken(scommand);
+ irc::string fcommand = scommand.c_str();
+
+ 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::multimap<irc::string, Alias>::iterator i = Aliases.find(fcommand);
+
+ if (i == Aliases.end())
+ return;
+
+ /* Avoid iterating on to other aliases if no patterns match */
+ std::multimap<irc::string, Alias>::iterator upperbound = Aliases.upper_bound(fcommand);
+
+
+ /* 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 (i->second.ChannelCommand)
+ {
+ // 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;
+
+ /* 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 ((a->OperOnly) && (!IS_OPER(user)))
return 0;
-
- for (unsigned int i = 0; i < Aliases.size(); i++)
+
+ 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;
+ }
+ }
+
+ /* Now, search and replace in a copy of the original_line, replacing $1 through $9 and $1- etc */
+
+ std::string::size_type crlf = a->ReplaceFormat.find('\n');
+
+ if (crlf == std::string::npos)
+ {
+ DoCommand(a->ReplaceFormat, user, c, safe);
+ return 1;
+ }
+ else
{
- if (Aliases[i].text == c)
+ irc::sepstream commands(a->ReplaceFormat, '\n');
+ std::string scommand;
+ while (commands.GetToken(scommand))
{
- if (Aliases[i].requires != "")
+ DoCommand(scommand, user, c, safe);
+ }
+ return 1;
+ }
+ }
+
+ void DoCommand(const std::string& newline, User* user, Channel *chan, const std::string &original_line)
+ {
+ std::string result;
+ result.reserve(MAXBUF);
+ for (unsigned int i = 0; i < newline.length(); i++)
+ {
+ char c = newline[i];
+ if (c == '$')
+ {
+ if (isdigit(newline[i+1]))
{
- u = ServerInstance->FindNick(Aliases[i].requires);
- if (!u)
- {
- user->WriteServ("401 "+std::string(user->nick)+" "+Aliases[i].requires+" :is currently unavailable. Please try again later.");
- return 1;
- }
+ int len = (newline[i+2] == '-') ? 3 : 2;
+ std::string var = newline.substr(i, len);
+ result.append(GetVar(var, original_line));
+ i += len - 1;
}
- if ((u != NULL) && (Aliases[i].requires != "") && (Aliases[i].uline))
+ else if (newline.substr(i, 5) == "$nick")
{
- if (!ServerInstance->ULine(u->server))
- {
- ServerInstance->WriteOpers("*** 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->WriteServ("401 "+std::string(user->nick)+" "+Aliases[i].requires+" :is an imposter! Please inform an IRC operator as soon as possible.");
- return 1;
- }
+ result.append(user->nick);
+ i += 4;
}
- std::string n = "";
- for (int j = 0; j < pcnt; j++)
+ else if (newline.substr(i, 5) == "$host")
{
- if (j)
- n = n + " ";
- n = n + parameters[j];
+ result.append(user->host);
+ i += 4;
}
- /* Final param now in n as one string */
- std::stringstream stuff(Aliases[i].replace_with);
- std::string cmd = "";
- std::string target = "";
- stuff >> cmd;
- stuff >> target;
- const char* para[2];
- para[0] = target.c_str();
- para[1] = n.c_str();
- ServerInstance->CallCommandHandler(cmd,para,2,user);
- return 1;
+ else if (newline.substr(i, 5) == "$chan")
+ {
+ if (chan)
+ result.append(chan->name);
+ i += 4;
+ }
+ else if (newline.substr(i, 6) == "$ident")
+ {
+ result.append(user->ident);
+ i += 5;
+ }
+ else if (newline.substr(i, 6) == "$vhost")
+ {
+ result.append(user->dhost);
+ i += 5;
+ }
+ else
+ result.push_back(c);
}
+ else
+ result.push_back(c);
}
- return 0;
- }
-
- virtual void OnRehash(const std::string ¶meter)
- {
- DELETE(MyConf);
- MyConf = new ConfigReader(ServerInstance);
-
- ReadAliases();
- }
-};
+ irc::tokenstream ss(result);
+ std::vector<std::string> pars;
+ std::string command, token;
-class ModuleAliasFactory : public ModuleFactory
-{
- public:
- ModuleAliasFactory()
- {
+ ss.GetToken(command);
+ while (ss.GetToken(token) && (pars.size() <= MAXPARAMETERS))
+ {
+ pars.push_back(token);
+ }
+ ServerInstance->Parser->CallHandler(command, pars, user);
}
- ~ModuleAliasFactory()
+ virtual void OnRehash(User* user)
{
- }
+ ReadAliases();
+ }
- virtual Module * CreateModule(InspIRCd* Me)
+ virtual void Prioritize()
{
- return new ModuleAlias(Me);
+ // 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);
}
};
-
-extern "C" void * init_module( void )
-{
- return new ModuleAliasFactory;
-}
-
+MODULE_INIT(ModuleAlias)