]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_alias.cpp
Merge tag 'v2.0.25' into master.
[user/henk/code/inspircd.git] / src / modules / m_alias.cpp
index 9bb2a9df2247288a9683e183301804e3c4640fa9..bdb242938de2d62f1c6b7ab33b04d9570ac40324 100644 (file)
-/*       +------------------------------------+
- *       | Inspire Internet Relay Chat Daemon |
- *       +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
  *
- *  Inspire is copyright (C) 2002-2004 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) 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/>.
  */
 
-using namespace std;
 
-#include "users.h"
-#include "channels.h"
-#include "modules.h"
-#include <vector>
-
-/* $ModDesc: Changes the ident of connecting bottler clients to 'bottler' */
+#include "inspircd.h"
 
+/** An alias definition
+ */
 class Alias
 {
  public:
-       std::string text;
-       std::string replace_with;
-       std::string requires;
-       bool uline;
+       /** 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;
 };
 
 class ModuleAlias : public Module
 {
- private:
-        
-        Server *Srv;
-        ConfigReader *MyConf;
-        std::vector<Alias> Aliases;
+       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;
+
  public:
-       virtual void ReadAliases()
+       void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
        {
+               ConfigTag* fantasy = ServerInstance->Config->ConfValue("fantasy");
+               AllowBots = fantasy->getBool("allowbots", false);
+               fprefix = fantasy->getString("prefix", "!", 1, ServerInstance->Config->Limits.MaxLine);
+
                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;
-                       a.text = MyConf->ReadValue("alias", "text", i);
-                       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");
+                       std::transform(a.AliasedCommand.begin(), a.AliasedCommand.end(), a.AliasedCommand.begin(), ::toupper);
+                       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");
+                       Aliases.insert(std::make_pair(a.AliasedCommand, a));
                }
-       
        }
-       
+
        ModuleAlias()
+               : botmode(this, "bot")
        {
-               Srv = new Server;
-               MyConf = new ConfigReader;
-
-               ReadAliases();
        }
-       
-       virtual ~ModuleAlias()
+
+       Version GetVersion() CXX11_OVERRIDE
        {
-               delete Srv;
-               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 void OnServerRaw(std::string &raw, bool inbound, userrec* user)
+       ModResult OnPreCommand(std::string &command, std::vector<std::string> &parameters, LocalUser *user, bool validated, const std::string &original_line) CXX11_OVERRIDE
        {
-               if (inbound)
+               /* 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. */
+               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 compare(original_line, command.length());
+               while (*(compare.c_str()) == ' ')
+                       compare.erase(compare.begin());
+
+               for (AliasMap::iterator i = iters.first; i != iters.second; ++i)
                {
-                       char data[MAXBUF];
-                       strncpy(data,raw.c_str(),MAXBUF);
-                       char* dptr = data;
-                       
-                       for (unsigned int i = 0; i < Aliases.size(); i++)
+                       if (i->second.UserCommand)
                        {
-                               if (!strncasecmp(Aliases[i].text.c_str(),data,Aliases[i].text.length()))
+                               if (DoAlias(user, NULL, &(i->second), compare, original_line))
                                {
-                                       userrec* u = NULL;
-                                       
-                                       if (Aliases[i].requires != "")
-                                       {
-                                               u = Srv->FindNick(Aliases[i].requires);
-                                       }
-                                       
-                                       if ((Aliases[i].requires != "") && (!u))
-                                       {
-                                               Srv->SendServ(user->fd,"401 "+std::string(user->nick)+" "+Aliases[i].requires+" :is currently unavailable. Please try again later.");
-                                               raw = "PONG :"+Srv->GetServerName();
-                                               return;
-                                       }
-                                       if (Aliases[i].uline)
-                                       {
-                                               if (!Srv->IsUlined(u->server))
-                                               {
-                                                       Srv->SendOpers("*** NOTICE -- Service "+Aliases[i].requires+" required by alias "+Aliases[i].text+" is not on a u-lined server, possibly underhanded antics detected!"); 
-                                                       Srv->SendServ(user->fd,"401 "+std::string(user->nick)+" "+Aliases[i].requires+" :is an imposter! Please inform an IRC operator as soon as possible.");
-                                                       raw = "PONG :"+Srv->GetServerName();
-                                                       return;
-                                               }
-                                       }
-                                       
-                                       dptr += Aliases[i].text.length();
-                                       if (strlen(dptr))
-                                       {
-                                               raw = Aliases[i].replace_with + std::string(dptr);
-                                       }
-                                       else
-                                       {
-                                               raw = Aliases[i].replace_with;
-                                       }
-                                       return;
+                                       return MOD_RES_DENY;
                                }
                        }
                }
-       }
-  
-       virtual void OnRehash()
+
+               // 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
        {
-               delete MyConf;
-               MyConf = new ConfigReader;
-               
-               ReadAliases();
-       }
-};
+               if ((target_type != TYPE_CHANNEL) || (msgtype != MSG_PRIVMSG))
+               {
+                       return;
+               }
 
+               // fcommands are only for local users. Spanningtree will send them back out as their original cmd.
+               if (!IS_LOCAL(user))
+               {
+                       return;
+               }
 
-class ModuleAliasFactory : public ModuleFactory
-{
- public:
-       ModuleAliasFactory()
+               /* Stop here if the user is +B and allowbot is set to no. */
+               if (!AllowBots && user->IsModeSet(botmode))
+               {
+                       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);
+
+               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(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, text.substr(fprefix.size())))
+                                       return;
+                       }
+               }
+       }
+
+
+       int DoAlias(User *user, Channel *c, Alias *a, const std::string& compare, const std::string& safe)
        {
+               /* Does it match the pattern? */
+               if (!a->format.empty())
+               {
+                       if (!InspIRCd::Match(compare, a->format))
+                               return 0;
+               }
+
+               if ((a->OperOnly) && (!user->IsOper()))
+                       return 0;
+
+               if (!a->RequiredNick.empty())
+               {
+                       User* u = ServerInstance->FindNick(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 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, 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]))
+                               {
+                                       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.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);
+               std::vector<std::string> pars;
+               std::string command, token;
+
+               ss.GetToken(command);
+               while (ss.GetToken(token))
+               {
+                       pars.push_back(token);
+               }
+               ServerInstance->Parser.CallHandler(command, pars, user);
        }
-       
-       virtual Module * CreateModule()
+
+       void Prioritize() CXX11_OVERRIDE
        {
-               return new ModuleAlias;
+               // 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)