-/* +------------------------------------+
- * | Inspire Internet Relay Chat Daemon |
- * +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
*
- * 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.
+ * Copyright (C) 2018-2019 linuxdaemon <linuxdaemon.irc@gmail.com>
+ * Copyright (C) 2013, 2015-2019, 2021 Sadie Powell <sadie@witchery.services>
+ * Copyright (C) 2012-2015, 2018 Attila Molnar <attilamolnar@hush.com>
+ * Copyright (C) 2012, 2019 Robby <robby@chatbelgie.be>
+ * Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
+ * Copyright (C) 2009 Matt Smith <dz@inspircd.org>
+ * Copyright (C) 2008-2009 Robin Burchell <robin+git@viroteck.net>
+ * Copyright (C) 2007-2008 Dennis Friis <peavey@inspircd.org>
+ * Copyright (C) 2004, 2006-2009 Craig Edwards <brain@inspircd.org>
*
- * ---------------------------------------------------
+ * This file is part of InspIRCd. InspIRCd is free software: you can
+ * redistribute it and/or modify it under the terms of the GNU General Public
+ * License as published by the Free Software Foundation, version 2.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-using namespace std;
-#include "users.h"
-#include "channels.h"
-#include "modules.h"
#include "inspircd.h"
-#include <vector>
-
-/* $ModDesc: Provides aliases of commands. */
/** An alias definition
*/
-class Alias : public classbase
+class Alias
{
public:
/** The text of the alias command */
- irc::string text;
+ std::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;
+
+ /* 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;
+
+ /** Strip color codes before match? */
+ bool StripColor;
};
class ModuleAlias : public Module
{
- private:
- std::vector<Alias> Aliases;
- std::vector<std::string> pars;
+ std::string fprefix;
- virtual void ReadAliases()
- {
- ConfigReader MyConf(ServerInstance);
+ /* 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
+ */
+ typedef insp::flat_multimap<std::string, Alias, irc::insensitive_swo> AliasMap;
- Aliases.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);
- a.requires = MyConf.ReadValue("alias", "requires", i);
- a.uline = MyConf.ReadFlag("alias", "uline", i);
-
- Aliases.push_back(a);
- }
+ AliasMap Aliases;
- }
+ /* whether or not +B users are allowed to use fantasy commands */
+ bool AllowBots;
+ UserModeReference botmode;
+
+ // Whether we are actively executing an alias.
+ bool active;
public:
-
- ModuleAlias(InspIRCd* Me)
- : Module::Module(Me)
+ void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
{
- ReadAliases();
- pars.resize(127);
- }
+ AliasMap newAliases;
+ ConfigTagList tags = ServerInstance->Config->ConfTags("alias");
+ for(ConfigIter i = tags.first; i != tags.second; ++i)
+ {
+ ConfigTag* tag = i->second;
+ Alias a;
+ a.AliasedCommand = tag->getString("text");
+ if (a.AliasedCommand.empty())
+ throw ModuleException("<alias:text> is empty! at " + tag->getTagLocation());
+
+ tag->readString("replace", a.ReplaceFormat, true);
+ if (a.ReplaceFormat.empty())
+ throw ModuleException("<alias:replace> is empty! at " + tag->getTagLocation());
+
+ a.RequiredNick = tag->getString("requires");
+ a.ULineOnly = tag->getBool("uline");
+ a.ChannelCommand = tag->getBool("channelcommand", false);
+ a.UserCommand = tag->getBool("usercommand", true);
+ a.OperOnly = tag->getBool("operonly");
+ a.format = tag->getString("format");
+ a.StripColor = tag->getBool("stripcolor");
+
+ std::transform(a.AliasedCommand.begin(), a.AliasedCommand.end(), a.AliasedCommand.begin(), ::toupper);
+ newAliases.insert(std::make_pair(a.AliasedCommand, a));
+ }
- void Implements(char* List)
- {
- List[I_OnPreCommand] = List[I_OnRehash] = 1;
+ ConfigTag* fantasy = ServerInstance->Config->ConfValue("fantasy");
+ AllowBots = fantasy->getBool("allowbots", false);
+ fprefix = fantasy->getString("prefix", "!", 1, ServerInstance->Config->Limits.MaxLine);
+ Aliases.swap(newAliases);
}
- virtual ~ModuleAlias()
+ ModuleAlias()
+ : botmode(this, "bot")
+ , active(false)
{
}
- virtual Version GetVersion()
+ Version GetVersion() CXX11_OVERRIDE
{
- return Version(1,0,0,1,VF_VENDOR);
+ return Version("Allows the server administrator to define custom channel commands (e.g. !kick) and server commands (e.g. /OPERSERV).", VF_VENDOR);
}
std::string GetVar(std::string varname, const std::string &original_line)
int index = *(varname.begin()) - 48;
varname.erase(varname.begin());
bool everything_after = (varname == "-");
- std::string word = "";
-
- ServerInstance->Log(DEBUG,"Get var %d%s", index , everything_after ? " and all after it" : "");
+ std::string word;
for (int j = 0; j < index; j++)
- word = ss.GetToken();
+ ss.GetToken(word);
if (everything_after)
{
- std::string more = "*";
- while ((more = ss.GetToken()) != "")
+ std::string more;
+ while (ss.GetToken(more))
{
word.append(" ");
word.append(more);
}
}
- ServerInstance->Log(DEBUG,"Var is '%s'", word.c_str());
-
return word;
}
- void SearchAndReplace(std::string& newline, const std::string &find, const std::string &replace)
+ std::string CreateRFCMessage(const std::string& command, CommandBase::Params& parameters)
{
- std::string::size_type x = newline.find(find);
- while (x != std::string::npos)
+ std::string message(command);
+ for (CommandBase::Params::const_iterator iter = parameters.begin(); iter != parameters.end();)
{
- newline.erase(x, find.length());
- newline.insert(x, replace);
- x = newline.find(find);
+ const std::string& parameter = *iter++;
+ message.push_back(' ');
+ if (iter == parameters.end() && (parameter.empty() || parameter.find(' ') != std::string::npos))
+ message.push_back(':');
+ message.append(parameter);
}
+ return message;
}
- virtual int OnPreCommand(const std::string &command, const char** parameters, int pcnt, userrec *user, bool validated, const std::string &original_line)
+ ModResult OnPreCommand(std::string& command, CommandBase::Params& parameters, LocalUser* user, bool validated) CXX11_OVERRIDE
{
- 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
+ /* If they're not registered yet, we dont want
+ * to know.
*/
- if ((validated) || (user->registered != REG_ALL))
- return 0;
-
- for (unsigned int i = 0; i < Aliases.size(); i++)
+ if (user->registered != REG_ALL)
+ return MOD_RES_PASSTHRU;
+
+ /* We dont have any commands looking like this? Stop processing. */
+ std::pair<AliasMap::iterator, AliasMap::iterator> iters = Aliases.equal_range(command);
+ if (iters.first == iters.second)
+ return MOD_RES_PASSTHRU;
+
+ /* The parameters for the command in their original form, with the command stripped off */
+ std::string original_line = CreateRFCMessage(command, parameters);
+ std::string compare(original_line, command.length());
+ while (*(compare.c_str()) == ' ')
+ compare.erase(compare.begin());
+
+ for (AliasMap::iterator i = iters.first; i != iters.second; ++i)
{
- if (Aliases[i].text == c)
+ if (i->second.UserCommand)
{
- if (Aliases[i].requires != "")
- {
- 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;
- }
- }
- if ((u != NULL) && (Aliases[i].requires != "") && (Aliases[i].uline))
+ if (DoAlias(user, NULL, &(i->second), compare, original_line))
{
- 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;
- }
+ return MOD_RES_DENY;
}
+ }
+ }
- /* Now, search and replace in a copy of the original_line, replacing $1 through $9 and $1- etc */
+ // If we made it here, no aliases actually matched.
+ return MOD_RES_PASSTHRU;
+ }
- std::string newline = Aliases[i].replace_with;
+ ModResult OnUserPreMessage(User* user, const MessageTarget& target, MessageDetails& details) CXX11_OVERRIDE
+ {
+ // Don't echo anything which is caused by an alias.
+ if (active)
+ details.echo = false;
- for (int v = 1; v < 10; v++)
- {
- std::string var = "$";
- var.append(ConvToStr(v));
- var.append("-");
- std::string::size_type x = newline.find(var);
-
- while (x != std::string::npos)
- {
- newline.erase(x, var.length());
- newline.insert(x, GetVar(var, original_line));
- x = newline.find(var);
- }
-
- var = "$";
- var.append(ConvToStr(v));
- x = newline.find(var);
-
- while (x != std::string::npos)
- {
- newline.erase(x, var.length());
- newline.insert(x, GetVar(var, original_line));
- x = newline.find(var);
- }
- }
+ return MOD_RES_PASSTHRU;
+ }
- /* Special variables */
- SearchAndReplace(newline, "$nick", user->nick);
- SearchAndReplace(newline, "$ident", user->ident);
- SearchAndReplace(newline, "$host", user->host);
- SearchAndReplace(newline, "$vhost", user->dhost);
+ void OnUserPostMessage(User* user, const MessageTarget& target, const MessageDetails& details) CXX11_OVERRIDE
+ {
+ if ((target.type != MessageTarget::TYPE_CHANNEL) || (details.type != MSG_PRIVMSG))
+ {
+ return;
+ }
- irc::tokenstream ss(newline);
- const char* parv[127];
- int x = 0;
+ // fcommands are only for local users. Spanningtree will send them back out as their original cmd.
+ if (!IS_LOCAL(user))
+ {
+ return;
+ }
- while ((pars[x] = ss.GetToken()) != "")
- {
- parv[x] = pars[x].c_str();
- ServerInstance->Log(DEBUG,"Parameter %d: %s", x, parv[x]);
- x++;
- }
+ /* Stop here if the user is +B and allowbot is set to no. */
+ if (!AllowBots && user->IsModeSet(botmode))
+ {
+ return;
+ }
- ServerInstance->CallCommandHandler(parv[0], &parv[1], x-1, user);
- return 1;
+ Channel *c = target.Get<Channel>();
+ std::string scommand;
+
+ // text is like "!moo cows bite me", we want "!moo" first
+ irc::spacesepstream ss(details.text);
+ ss.GetToken(scommand);
+
+ if (scommand.size() <= fprefix.size())
+ {
+ return; // wtfbbq
+ }
+
+ // we don't want to touch non-fantasy stuff
+ if (scommand.compare(0, fprefix.size(), fprefix) != 0)
+ {
+ return;
+ }
+
+ // nor do we give a shit about the prefix
+ scommand.erase(0, fprefix.size());
+
+ std::pair<AliasMap::iterator, AliasMap::iterator> iters = Aliases.equal_range(scommand);
+ if (iters.first == iters.second)
+ return;
+
+ /* The parameters for the command in their original form, with the command stripped off */
+ std::string compare(details.text, scommand.length() + fprefix.size());
+ while (*(compare.c_str()) == ' ')
+ compare.erase(compare.begin());
+
+ for (AliasMap::iterator i = iters.first; i != iters.second; ++i)
+ {
+ if (i->second.ChannelCommand)
+ {
+ // We use substr here to remove the fantasy prefix
+ if (DoAlias(user, c, &(i->second), compare, details.text.substr(fprefix.size())))
+ return;
}
}
- return 0;
- }
-
- virtual void OnRehash(const std::string ¶meter)
- {
- ReadAliases();
- }
-};
+ }
-class ModuleAliasFactory : public ModuleFactory
-{
- public:
- ModuleAliasFactory()
+ int DoAlias(User *user, Channel *c, Alias *a, const std::string& compare, const std::string& safe)
{
+ std::string stripped(compare);
+ if (a->StripColor)
+ InspIRCd::StripColor(stripped);
+
+ /* Does it match the pattern? */
+ if (!a->format.empty())
+ {
+ if (!InspIRCd::Match(stripped, a->format))
+ return 0;
+ }
+
+ if ((a->OperOnly) && (!user->IsOper()))
+ return 0;
+
+ if (!a->RequiredNick.empty())
+ {
+ int numeric = a->ULineOnly ? ERR_NOSUCHSERVICE : ERR_NOSUCHNICK;
+ User* u = ServerInstance->FindNickOnly(a->RequiredNick);
+ if (!u)
+ {
+ user->WriteNumeric(numeric, a->RequiredNick, "is currently unavailable. Please try again later.");
+ return 1;
+ }
+
+ if ((a->ULineOnly) && (!u->server->IsULine()))
+ {
+ ServerInstance->SNO->WriteToSnoMask('a', "NOTICE -- Service "+a->RequiredNick+" required by alias "+a->AliasedCommand+" is not on a U-lined server, possibly underhanded antics detected!");
+ user->WriteNumeric(numeric, a->RequiredNick, "is not a network service! Please inform a server 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, a);
+ return 1;
+ }
+ else
+ {
+ irc::sepstream commands(a->ReplaceFormat, '\n');
+ std::string scommand;
+ while (commands.GetToken(scommand))
+ {
+ DoCommand(scommand, user, c, safe, a);
+ }
+ return 1;
+ }
}
- ~ModuleAliasFactory()
+ void DoCommand(const std::string& newline, User* user, Channel *chan, const std::string &original_line, Alias* a)
{
+ std::string result;
+ result.reserve(newline.length());
+ for (unsigned int i = 0; i < newline.length(); i++)
+ {
+ char c = newline[i];
+ if ((c == '$') && (i + 1 < newline.length()))
+ {
+ if (isdigit(newline[i+1]))
+ {
+ size_t len = ((i + 2 < newline.length()) && (newline[i+2] == '-')) ? 3 : 2;
+ std::string var = newline.substr(i, len);
+ result.append(GetVar(var, original_line));
+ i += len - 1;
+ }
+ else if (!newline.compare(i, 5, "$nick", 5))
+ {
+ result.append(user->nick);
+ i += 4;
+ }
+ else if (!newline.compare(i, 5, "$host", 5))
+ {
+ result.append(user->GetRealHost());
+ i += 4;
+ }
+ else if (!newline.compare(i, 5, "$chan", 5))
+ {
+ if (chan)
+ result.append(chan->name);
+ i += 4;
+ }
+ else if (!newline.compare(i, 6, "$ident", 6))
+ {
+ result.append(user->ident);
+ i += 5;
+ }
+ else if (!newline.compare(i, 6, "$vhost", 6))
+ {
+ result.append(user->GetDisplayedHost());
+ i += 5;
+ }
+ else if (!newline.compare(i, 12, "$requirement", 12))
+ {
+ result.append(a->RequiredNick);
+ i += 11;
+ }
+ else
+ result.push_back(c);
+ }
+ else
+ result.push_back(c);
+ }
+
+ irc::tokenstream ss(result);
+ CommandBase::Params pars;
+ std::string command, token;
+
+ ss.GetMiddle(command);
+ while (ss.GetTrailing(token))
+ {
+ pars.push_back(token);
+ }
+
+ active = true;
+ ServerInstance->Parser.CallHandler(command, pars, user);
+ active = false;
}
- virtual Module * CreateModule(InspIRCd* Me)
+ void Prioritize() CXX11_OVERRIDE
{
- 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_OnUserPostMessage, PRIORITY_AFTER, linkmod);
}
};
-
-extern "C" void * init_module( void )
-{
- return new ModuleAliasFactory;
-}
-
+MODULE_INIT(ModuleAlias)
projects / user / henk / code / inspircd.git / blobdiff