]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_alias.cpp
Fix the cloaking module on C++98 compilers.
[user/henk/code/inspircd.git] / src / modules / m_alias.cpp
index c9fa9bd0ab9325c79210b4b2775fa92212bc090e..7fc0f3bb038f360e3e0f69782abeee5f516c4c2d 100644 (file)
@@ -1,10 +1,15 @@
 /*
  * InspIRCd -- Internet Relay Chat Daemon
  *
- *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
- *   Copyright (C) 2005, 2009 Robin Burchell <robin+git@viroteck.net>
- *   Copyright (C) 2004-2007, 2009 Craig Edwards <craigedwards@brainbox.cc>
- *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
+ *   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
 
 #include "inspircd.h"
 
-/* $ModDesc: Provides aliases of commands. */
-
 /** An alias definition
  */
 class Alias
 {
  public:
        /** The text of the alias command */
-       irc::string AliasedCommand;
+       std::string AliasedCommand;
 
        /** Text to replace with */
        std::string ReplaceFormat;
@@ -44,9 +47,6 @@ class Alias
        /** Requires oper? */
        bool OperOnly;
 
-       /* is case sensitive params */
-       bool CaseSensitive;
-
        /* whether or not it may be executed via fantasy (default OFF) */
        bool ChannelCommand;
 
@@ -55,59 +55,74 @@ class Alias
 
        /** Format that must be matched for use */
        std::string format;
+
+       /** Strip color codes before match? */
+       bool StripColor;
 };
 
 class ModuleAlias : public Module
 {
-       char fprefix;
+       std::string 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;
+        */
+       typedef insp::flat_multimap<std::string, Alias, irc::insensitive_swo> AliasMap;
+
+       AliasMap Aliases;
 
        /* whether or not +B users are allowed to use fantasy commands */
        bool AllowBots;
+       UserModeReference botmode;
 
-       void ReadAliases()
-       {
-               ConfigTag* fantasy = ServerInstance->Config->ConfValue("fantasy");
-               AllowBots = fantasy->getBool("allowbots", false);
-               std::string fpre = fantasy->getString("prefix", "!");
-               fprefix = fpre.empty() ? '!' : fpre[0];
+       // Whether we are actively executing an alias.
+       bool active;
 
-               Aliases.clear();
+ public:
+       void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
+       {
+               AliasMap newAliases;
                ConfigTagList tags = ServerInstance->Config->ConfTags("alias");
                for(ConfigIter i = tags.first; i != tags.second; ++i)
                {
                        ConfigTag* tag = i->second;
                        Alias a;
-                       std::string aliastext = tag->getString("text");
-                       a.AliasedCommand = aliastext.c_str();
+                       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.CaseSensitive = tag->getBool("matchcase");
-                       Aliases.insert(std::make_pair(a.AliasedCommand, a));
+                       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));
                }
+
+               ConfigTag* fantasy = ServerInstance->Config->ConfValue("fantasy");
+               AllowBots = fantasy->getBool("allowbots", false);
+               fprefix = fantasy->getString("prefix", "!", 1, ServerInstance->Config->Limits.MaxLine);
+               Aliases.swap(newAliases);
        }
 
- public:
-       void init() CXX11_OVERRIDE
+       ModuleAlias()
+               : botmode(this, "bot")
+               , active(false)
        {
-               ReadAliases();
-               Implementation eventlist[] = { I_OnPreCommand, I_OnRehash, I_OnUserMessage };
-               ServerInstance->Modules->Attach(eventlist, this, sizeof(eventlist)/sizeof(Implementation));
        }
 
        Version GetVersion() CXX11_OVERRIDE
        {
-               return Version("Provides aliases of commands.", 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)
@@ -135,30 +150,40 @@ class ModuleAlias : public Module
                return word;
        }
 
-       ModResult OnPreCommand(std::string &command, std::vector<std::string> &parameters, LocalUser *user, bool validated, const std::string &original_line) CXX11_OVERRIDE
+       std::string CreateRFCMessage(const std::string& command, CommandBase::Params& parameters)
        {
-               std::multimap<irc::string, Alias>::iterator i, upperbound;
+               std::string message(command);
+               for (CommandBase::Params::const_iterator iter = parameters.begin(); iter != parameters.end();)
+               {
+                       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;
+       }
 
-               /* If theyre not registered yet, we dont want
+       ModResult OnPreCommand(std::string& command, CommandBase::Params& parameters, LocalUser* user, bool validated) CXX11_OVERRIDE
+       {
+               /* If they're not registered yet, we dont want
                 * to know.
                 */
                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())
+               std::pair<AliasMap::iterator, AliasMap::iterator> iters = Aliases.equal_range(command);
+               if (iters.first == iters.second)
                        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());
+               std::string original_line = CreateRFCMessage(command, parameters);
+               std::string compare(original_line, command.length());
                while (*(compare.c_str()) == ' ')
                        compare.erase(compare.begin());
 
-               while (i != upperbound)
+               for (AliasMap::iterator i = iters.first; i != iters.second; ++i)
                {
                        if (i->second.UserCommand)
                        {
@@ -167,100 +192,93 @@ class ModuleAlias : public Module
                                        return MOD_RES_DENY;
                                }
                        }
-
-                       i++;
                }
 
                // If we made it here, no aliases actually matched.
                return MOD_RES_PASSTHRU;
        }
 
-       void OnUserMessage(User *user, void *dest, int target_type, const std::string &text, char status, const CUList &exempt_list, MessageType msgtype) CXX11_OVERRIDE
+       ModResult OnUserPreMessage(User* user, const MessageTarget& target, MessageDetails& details) CXX11_OVERRIDE
        {
-               if ((target_type != TYPE_CHANNEL) || (msgtype != MSG_PRIVMSG))
+               // Don't echo anything which is caused by an alias.
+               if (active)
+                       details.echo = false;
+
+               return MOD_RES_PASSTHRU;
+       }
+
+       void OnUserPostMessage(User* user, const MessageTarget& target, const MessageDetails& details) CXX11_OVERRIDE
+       {
+               if ((target.type != MessageTarget::TYPE_CHANNEL) || (details.type != MSG_PRIVMSG))
                {
                        return;
                }
 
                // fcommands are only for local users. Spanningtree will send them back out as their original cmd.
-               if (!user || !IS_LOCAL(user))
+               if (!IS_LOCAL(user))
                {
                        return;
                }
 
                /* Stop here if the user is +B and allowbot is set to no. */
-               if (!AllowBots && user->IsModeSet('B'))
+               if (!AllowBots && user->IsModeSet(botmode))
                {
                        return;
                }
 
-               Channel *c = (Channel *)dest;
+               Channel *c = target.Get<Channel>();
                std::string scommand;
 
                // text is like "!moo cows bite me", we want "!moo" first
-               irc::spacesepstream ss(text);
+               irc::spacesepstream ss(details.text);
                ss.GetToken(scommand);
-               irc::string fcommand = scommand.c_str();
 
-               if (fcommand.empty())
+               if (scommand.size() <= fprefix.size())
                {
                        return; // wtfbbq
                }
 
                // we don't want to touch non-fantasy stuff
-               if (*fcommand.c_str() != fprefix)
+               if (scommand.compare(0, fprefix.size(), fprefix) != 0)
                {
                        return;
                }
 
                // nor do we give a shit about the prefix
-               fcommand.erase(fcommand.begin());
-
-               std::multimap<irc::string, Alias>::iterator i = Aliases.find(fcommand);
+               scommand.erase(0, fprefix.size());
 
-               if (i == Aliases.end())
+               std::pair<AliasMap::iterator, AliasMap::iterator> iters = Aliases.equal_range(scommand);
+               if (iters.first == iters.second)
                        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);
+               std::string compare(details.text, scommand.length() + fprefix.size());
                while (*(compare.c_str()) == ' ')
                        compare.erase(compare.begin());
 
-               while (i != upperbound)
+               for (AliasMap::iterator i = iters.first; i != iters.second; ++i)
                {
                        if (i->second.ChannelCommand)
                        {
-                               // We use substr(1) here to remove the fantasy prefix
-                               if (DoAlias(user, c, &(i->second), compare, text.substr(1)))
+                               // We use substr here to remove the fantasy prefix
+                               if (DoAlias(user, c, &(i->second), compare, details.text.substr(fprefix.size())))
                                        return;
                        }
-
-                       i++;
                }
        }
 
 
-       int DoAlias(User *user, Channel *c, Alias *a, const std::string compare, const std::string safe)
+       int DoAlias(User *user, Channel *c, Alias *a, const std::string& compare, const std::string& safe)
        {
-               User *u = NULL;
+               std::string stripped(compare);
+               if (a->StripColor)
+                       InspIRCd::StripColor(stripped);
 
                /* 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 (!InspIRCd::Match(stripped, a->format))
+                               return 0;
                }
 
                if ((a->OperOnly) && (!user->IsOper()))
@@ -268,19 +286,18 @@ class ModuleAlias : public Module
 
                if (!a->RequiredNick.empty())
                {
-                       u = ServerInstance->FindNick(a->RequiredNick);
+                       int numeric = a->ULineOnly ? ERR_NOSUCHSERVICE : ERR_NOSUCHNICK;
+                       User* u = ServerInstance->FindNickOnly(a->RequiredNick);
                        if (!u)
                        {
-                               user->WriteNumeric(401, ""+user->nick+" "+a->RequiredNick+" :is currently unavailable. Please try again later.");
+                               user->WriteNumeric(numeric, a->RequiredNick, "is currently unavailable. Please try again later.");
                                return 1;
                        }
-               }
-               if ((u != NULL) && (!a->RequiredNick.empty()) && (a->ULineOnly))
-               {
-                       if (!ServerInstance->ULine(u->server))
+
+                       if ((a->ULineOnly) && (!u->server->IsULine()))
                        {
-                               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, ""+user->nick+" "+a->RequiredNick+" :is an imposter! Please inform an IRC operator as soon as possible.");
+                               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;
                        }
                }
@@ -291,7 +308,7 @@ class ModuleAlias : public Module
 
                if (crlf == std::string::npos)
                {
-                       DoCommand(a->ReplaceFormat, user, c, safe);
+                       DoCommand(a->ReplaceFormat, user, c, safe, a);
                        return 1;
                }
                else
@@ -300,54 +317,59 @@ class ModuleAlias : public Module
                        std::string scommand;
                        while (commands.GetToken(scommand))
                        {
-                               DoCommand(scommand, user, c, safe);
+                               DoCommand(scommand, user, c, safe, a);
                        }
                        return 1;
                }
        }
 
-       void DoCommand(const std::string& newline, User* user, Channel *chan, const std::string &original_line)
+       void DoCommand(const std::string& newline, User* user, Channel *chan, const std::string &original_line, Alias* a)
        {
                std::string result;
-               result.reserve(MAXBUF);
+               result.reserve(newline.length());
                for (unsigned int i = 0; i < newline.length(); i++)
                {
                        char c = newline[i];
-                       if (c == '$')
+                       if ((c == '$') && (i + 1 < newline.length()))
                        {
                                if (isdigit(newline[i+1]))
                                {
-                                       int len = (newline[i+2] == '-') ? 3 : 2;
+                                       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.substr(i, 5) == "$nick")
+                               else if (!newline.compare(i, 5, "$nick", 5))
                                {
                                        result.append(user->nick);
                                        i += 4;
                                }
-                               else if (newline.substr(i, 5) == "$host")
+                               else if (!newline.compare(i, 5, "$host", 5))
                                {
-                                       result.append(user->host);
+                                       result.append(user->GetRealHost());
                                        i += 4;
                                }
-                               else if (newline.substr(i, 5) == "$chan")
+                               else if (!newline.compare(i, 5, "$chan", 5))
                                {
                                        if (chan)
                                                result.append(chan->name);
                                        i += 4;
                                }
-                               else if (newline.substr(i, 6) == "$ident")
+                               else if (!newline.compare(i, 6, "$ident", 6))
                                {
                                        result.append(user->ident);
                                        i += 5;
                                }
-                               else if (newline.substr(i, 6) == "$vhost")
+                               else if (!newline.compare(i, 6, "$vhost", 6))
                                {
-                                       result.append(user->dhost);
+                                       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);
                        }
@@ -356,27 +378,25 @@ class ModuleAlias : public Module
                }
 
                irc::tokenstream ss(result);
-               std::vector<std::string> pars;
+               CommandBase::Params pars;
                std::string command, token;
 
-               ss.GetToken(command);
-               while (ss.GetToken(token) && (pars.size() <= MAXPARAMETERS))
+               ss.GetMiddle(command);
+               while (ss.GetTrailing(token))
                {
                        pars.push_back(token);
                }
-               ServerInstance->Parser->CallHandler(command, pars, user);
-       }
 
-       void OnRehash(User* user) CXX11_OVERRIDE
-       {
-               ReadAliases();
-       }
+               active = true;
+               ServerInstance->Parser.CallHandler(command, pars, user);
+               active = false;
+       }
 
-       void Prioritize()
+       void Prioritize() CXX11_OVERRIDE
        {
                // 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);
+               ServerInstance->Modules->SetPriority(this, I_OnUserPostMessage, PRIORITY_AFTER, linkmod);
        }
 };