]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_alias.cpp
Update wiki links to use HTTPS and point to the correct pages.
[user/henk/code/inspircd.git] / src / modules / m_alias.cpp
index 039aeed92c5a0fb3a6979ff727c9e064c4476904..32fc80b64d5427638a4a7919b2d437fa34afdec3 100644 (file)
@@ -1 +1,390 @@
-/*       +------------------------------------+\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) 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>
+ *
+ * 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"
+
+/* $ModDesc: Provides aliases of commands. */
+
+/** An alias definition
+ */
+class Alias
+{
+ public:
+       /** 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:
+
+       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()
+       {
+               ConfigTag* fantasy = ServerInstance->Config->ConfValue("fantasy");
+               AllowBots = fantasy->getBool("allowbots", false);
+               std::string fpre = fantasy->getString("prefix", "!");
+               fprefix = fpre.empty() ? '!' : fpre[0];
+
+               Aliases.clear();
+               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();
+                       tag->readString("replace", a.ReplaceFormat, true);
+                       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));
+               }
+       }
+
+ public:
+
+       void init()
+       {
+               ReadAliases();
+               Implementation eventlist[] = { I_OnPreCommand, I_OnRehash, I_OnUserMessage };
+               ServerInstance->Modules->Attach(eventlist, this, sizeof(eventlist)/sizeof(Implementation));
+       }
+
+       virtual ~ModuleAlias()
+       {
+       }
+
+       virtual Version GetVersion()
+       {
+               return Version("Provides aliases of commands.", 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;
+       }
+
+       virtual ModResult OnPreCommand(std::string &command, std::vector<std::string> &parameters, LocalUser *user, bool validated, const std::string &original_line)
+       {
+               std::multimap<irc::string, Alias>::iterator i, upperbound;
+
+               /* If theyre 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())
+                       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;
+
+               if (!a->RequiredNick.empty())
+               {
+                       u = ServerInstance->FindNick(a->RequiredNick);
+                       if (!u)
+                       {
+                               user->WriteNumeric(401, ""+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, ""+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
+               {
+                       irc::sepstream commands(a->ReplaceFormat, '\n');
+                       std::string scommand;
+                       while (commands.GetToken(scommand))
+                       {
+                               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 == '$') && (i + 1 < newline.length()))
+                       {
+                               if (isdigit(newline[i+1]))
+                               {
+                                       int 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")
+                               {
+                                       result.append(user->nick);
+                                       i += 4;
+                               }
+                               else if (newline.substr(i, 5) == "$host")
+                               {
+                                       result.append(user->host);
+                                       i += 4;
+                               }
+                               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);
+               }
+
+               irc::tokenstream ss(result);
+               std::vector<std::string> pars;
+               std::string command, token;
+
+               ss.GetToken(command);
+               while (ss.GetToken(token) && (pars.size() <= MAXPARAMETERS))
+               {
+                       pars.push_back(token);
+               }
+               ServerInstance->Parser->CallHandler(command, pars, user);
+       }
+
+       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)