]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_alias.cpp
Add a shun option to only apply when users are fully connected.
[user/henk/code/inspircd.git] / src / modules / m_alias.cpp
index 039aeed92c5a0fb3a6979ff727c9e064c4476904..df7add05cc93112da3c05f014b6a8c9095e3359c 100644 (file)
@@ -1 +1,402 @@
-/*       +------------------------------------+\r *       | Inspire Internet Relay Chat Daemon |\r *       +------------------------------------+\r *\r *  InspIRCd: (C) 2002-2007 InspIRCd Development Team\r * See: http://www.inspircd.org/wiki/index.php/Credits\r *\r * This program is free but copyrighted software; see\r *            the file COPYING for details.\r *\r * ---------------------------------------------------\r */\r\r#include "inspircd.h"\r#include "users.h"\r#include "channels.h"\r#include "modules.h"\r#include "wildcard.h"\r\r/* $ModDesc: Provides aliases of commands. */\r\r/** An alias definition\r */\rclass Alias : public classbase\r{\r public:\r   /** The text of the alias command */\r   irc::string text;\r      /** Text to replace with */\r    std::string replace_with;\r      /** Nickname required to perform alias */\r      std::string requires;\r  /** Alias requires ulined server */\r    bool uline;\r    /** Requires oper? */\r  bool operonly;\r /* is case sensitive params */\r bool case_sensitive;\r   /** Format that must be matched for use */\r     std::string format;\r};\r\rclass ModuleAlias : public Module\r{\r private:\r  /** We cant use a map, there may be multiple aliases with the same name */\r     std::vector<Alias> Aliases;\r    std::map<std::string, int> AliasMap;\r   std::vector<std::string> pars;\r\r        virtual void ReadAliases()\r     {\r              ConfigReader MyConf(ServerInstance);\r\r          Aliases.clear();\r               AliasMap.clear();\r              for (int i = 0; i < MyConf.Enumerate("alias"); i++)\r            {\r                      Alias a;\r                       std::string txt;\r                       txt = MyConf.ReadValue("alias", "text", i);\r                    a.text = txt.c_str();\r                  a.replace_with = MyConf.ReadValue("alias", "replace", i, true);\r                        a.requires = MyConf.ReadValue("alias", "requires", i);\r                 a.uline = MyConf.ReadFlag("alias", "uline", i);\r                        a.operonly = MyConf.ReadFlag("alias", "operonly", i);\r                  a.format = MyConf.ReadValue("alias", "format", i);\r                     a.case_sensitive = MyConf.ReadFlag("alias", "matchcase", i);\r                   Aliases.push_back(a);\r                  AliasMap[txt] = 1;\r             }\r      }\r\r public:\r    \r       ModuleAlias(InspIRCd* Me)\r              : Module(Me)\r   {\r              ReadAliases();\r         pars.resize(127);\r      }\r\r     void Implements(char* List)\r    {\r              List[I_OnPreCommand] = List[I_OnRehash] = 1;\r   }\r\r     virtual ~ModuleAlias()\r {\r      }\r\r     virtual Version GetVersion()\r   {\r              return Version(1,1,0,1,VF_VENDOR,API_VERSION);\r }\r\r     std::string GetVar(std::string varname, const std::string &original_line)\r      {\r              irc::spacesepstream ss(original_line);\r         varname.erase(varname.begin());\r                int index = *(varname.begin()) - 48;\r           varname.erase(varname.begin());\r                bool everything_after = (varname == "-");\r              std::string word;\r\r             for (int j = 0; j < index; j++)\r                        word = ss.GetToken();\r\r         if (everything_after)\r          {\r                      std::string more = "*";\r                        while ((more = ss.GetToken()) != "")\r                   {\r                              word.append(" ");\r                              word.append(more);\r                     }\r              }\r\r             return word;\r   }\r\r     void SearchAndReplace(std::string& newline, const std::string &find, const std::string &replace)\r       {\r              std::string::size_type x = newline.find(find);\r         while (x != std::string::npos)\r         {\r                      newline.erase(x, find.length());\r                       newline.insert(x, replace);\r                    x = newline.find(find);\r                }\r      }\r\r     virtual int OnPreCommand(const std::string &command, const char** parameters, int pcnt, userrec *user, bool validated, const std::string &original_line)\r       {\r              userrec *u = NULL;\r\r            /* If theyre not registered yet, we dont want\r           * to know.\r             */\r            if (user->registered != REG_ALL)\r                       return 0;\r\r             /* We dont have any commands looking like this, dont bother with the loop */\r           if (AliasMap.find(command) == AliasMap.end())\r                  return 0;\r\r             irc::string c = command.c_str();\r               /* The parameters for the command in their original form, with the command stripped off */\r             std::string compare = original_line.substr(command.length());\r          while (*(compare.c_str()) == ' ')\r                      compare.erase(compare.begin());\r\r               std::string safe(original_line);\r\r              /* Escape out any $ symbols in the user provided text */\r\r              SearchAndReplace(safe, "$", "\r");\r\r            for (unsigned int i = 0; i < Aliases.size(); i++)\r              {\r                      if (Aliases[i].text == c)\r                      {\r                              /* Does it match the pattern? */\r                               if (!Aliases[i].format.empty())\r                                {\r                                      if (!match(Aliases[i].case_sensitive, compare.c_str(), Aliases[i].format.c_str()))\r                                             continue;\r                              }\r\r                             if ((Aliases[i].operonly) && (!IS_OPER(user)))\r                                 return 0;\r\r                             if (!Aliases[i].requires.empty())\r                              {\r                                      u = ServerInstance->FindNick(Aliases[i].requires);\r                                     if (!u)\r                                        {\r                                              user->WriteServ("401 "+std::string(user->nick)+" "+Aliases[i].requires+" :is currently unavailable. Please try again later.");\r                                         return 1;\r                                      }\r                              }\r                              if ((u != NULL) && (!Aliases[i].requires.empty()) && (Aliases[i].uline))\r                               {\r                                      if (!ServerInstance->ULine(u->server))\r                                 {\r                                              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!"); \r                                             user->WriteServ("401 "+std::string(user->nick)+" "+Aliases[i].requires+" :is an imposter! Please inform an IRC operator as soon as possible.");\r                                                return 1;\r                                      }\r                              }\r\r                             /* Now, search and replace in a copy of the original_line, replacing $1 through $9 and $1- etc */\r\r                             std::string::size_type crlf = Aliases[i].replace_with.find('\n');\r\r                             if (crlf == std::string::npos)\r                         {\r                                      DoCommand(Aliases[i].replace_with, user, safe);\r                                        return 1;\r                              }\r                              else\r                           {\r                                      irc::sepstream commands(Aliases[i].replace_with, '\n');\r                                        std::string command = "*";\r                                     while ((command = commands.GetToken()) != "")\r                                  {\r                                              DoCommand(command, user, safe);\r                                        }\r                                      return 1;\r                              }\r                      }\r              }\r              return 0;\r      }\r\r     void DoCommand(std::string newline, userrec* user, const std::string &original_line)\r   {\r              for (int v = 1; v < 10; v++)\r           {\r                      std::string var = "$";\r                 var.append(ConvToStr(v));\r                      var.append("-");\r                       std::string::size_type x = newline.find(var);\r\r                 while (x != std::string::npos)\r                 {\r                              newline.erase(x, var.length());\r                                newline.insert(x, GetVar(var, original_line));\r                         x = newline.find(var);\r                 }\r\r                     var = "$";\r                     var.append(ConvToStr(v));\r                      x = newline.find(var);\r\r                        while (x != std::string::npos)\r                 {\r                              newline.erase(x, var.length());\r                                newline.insert(x, GetVar(var, original_line));\r                         x = newline.find(var);\r                 }\r              }\r\r             /* Special variables */\r                SearchAndReplace(newline, "$nick", user->nick);\r                SearchAndReplace(newline, "$ident", user->ident);\r              SearchAndReplace(newline, "$host", user->host);\r                SearchAndReplace(newline, "$vhost", user->dhost);\r\r             /* Unescape any variable names in the user text before sending */\r              SearchAndReplace(newline, "\r", "$");\r\r         irc::tokenstream ss(newline);\r          const char* parv[127];\r         int x = 0;\r\r            while (ss.GetToken(pars[x]))\r           {\r                      parv[x] = pars[x].c_str();\r                     x++;\r           }\r\r             ServerInstance->Parser->CallHandler(parv[0], &parv[1], x-1, user);\r     }\r \r    virtual void OnRehash(userrec* user, const std::string &parameter)\r     {\r              ReadAliases();\r         }\r};\r\rMODULE_INIT(ModuleAlias)\r
\ No newline at end of file
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
+ *
+ *   Copyright (C) 2018-2019 linuxdaemon <linuxdaemon.irc@gmail.com>
+ *   Copyright (C) 2013-2016, 2018 Attila Molnar <attilamolnar@hush.com>
+ *   Copyright (C) 2013, 2015-2019 Sadie Powell <sadie@witchery.services>
+ *   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) 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/>.
+ */
+
+
+#include "inspircd.h"
+
+/** An alias definition
+ */
+class Alias
+{
+ public:
+       /** The text of the alias command */
+       std::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;
+
+       /* 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
+{
+       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
+        */
+       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;
+
+       // Whether we are actively executing an alias.
+       bool active;
+
+ 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;
+                       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));
+               }
+
+               ConfigTag* fantasy = ServerInstance->Config->ConfValue("fantasy");
+               AllowBots = fantasy->getBool("allowbots", false);
+               fprefix = fantasy->getString("prefix", "!", 1, ServerInstance->Config->Limits.MaxLine);
+               Aliases.swap(newAliases);
+       }
+
+       ModuleAlias()
+               : botmode(this, "bot")
+               , active(false)
+       {
+       }
+
+       Version GetVersion() CXX11_OVERRIDE
+       {
+               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)
+       {
+               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;
+       }
+
+       std::string CreateRFCMessage(const std::string& command, CommandBase::Params& parameters)
+       {
+               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;
+       }
+
+       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. */
+               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 (i->second.UserCommand)
+                       {
+                               if (DoAlias(user, NULL, &(i->second), compare, original_line))
+                               {
+                                       return MOD_RES_DENY;
+                               }
+                       }
+               }
+
+               // If we made it here, no aliases actually matched.
+               return MOD_RES_PASSTHRU;
+       }
+
+       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;
+
+               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 (!IS_LOCAL(user))
+               {
+                       return;
+               }
+
+               /* Stop here if the user is +B and allowbot is set to no. */
+               if (!AllowBots && user->IsModeSet(botmode))
+               {
+                       return;
+               }
+
+               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;
+                       }
+               }
+       }
+
+
+       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())
+               {
+                       User* u = ServerInstance->FindNickOnly(a->RequiredNick);
+                       if (!u)
+                       {
+                               user->WriteNumeric(ERR_NOSUCHNICK, 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(ERR_NOSUCHNICK, 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;
+               }
+       }
+
+       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;
+       }
+
+       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_OnUserPostMessage, PRIORITY_AFTER, linkmod);
+       }
+};
+
+MODULE_INIT(ModuleAlias)