]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_alias.cpp
Nuke trailing spaces
[user/henk/code/inspircd.git] / src / modules / m_alias.cpp
index 59492c828083b27c9aaf191e81ddbef47ed29f47..39d19b2bc6d58ace3f613e238c598feb9158d6c6 100644 (file)
-/*   +------------------------------------+
- *   | Inspire Internet Relay Chat Daemon |
- *   +------------------------------------+
+/*       +------------------------------------+
+ *       | Inspire Internet Relay Chat Daemon |
+ *       +------------------------------------+
+ *
+ *  InspIRCd: (C) 2002-2009 InspIRCd Development Team
+ * See: http://www.inspircd.org/wiki/index.php/Credits
  *
- *  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.
+ *            the file COPYING for details.
  *
  * ---------------------------------------------------
  */
 
-using namespace std;
-
-#include "users.h"
-#include "channels.h"
-#include "modules.h"
-#include "helperfuncs.h"
-#include <vector>
+#include "inspircd.h"
 
 /* $ModDesc: Provides aliases of commands. */
 
-class Alias
+/** An alias definition
+ */
+class Alias : public classbase
 {
-       public:
-               irc::string text;
-               std::string replace_with;
-               std::string requires;
-               bool uline;
+ 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:
-               Server *Srv;
-               ConfigReader *MyConf;
-               std::vector<Alias> Aliases;
-
-               /* XXX - small issue, why is this marked public when it's not (really) intended for external use
-                * Fixed 30/11/05 by Brain as suggestion by w00t */
-               virtual void ReadAliases()
-               {
-                       Aliases.clear();
-               
-                       for (int i = 0; i < MyConf->Enumerate("alias"); i++)
+ 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<std::string, Alias> Aliases;
+
+       /* whether or not +B users are allowed to use fantasy commands */
+       bool AllowBots;
+
+       virtual void ReadAliases()
+       {
+               ConfigReader MyConf(ServerInstance);
+
+               AllowBots = MyConf.ReadFlag("fantasy", "allowbots", "no", 0);
+
+               std::string fpre = MyConf.ReadValue("fantasy","prefix",0);
+               fprefix = fpre.empty() ? '!' : fpre[0];
+
+               Aliases.clear();
+               for (int i = 0; i < MyConf.Enumerate("alias"); i++)
+               {
+                       Alias a;
+                       std::string txt;
+                       txt = MyConf.ReadValue("alias", "text", i);
+                       a.AliasedCommand = txt.c_str();
+                       a.ReplaceFormat = MyConf.ReadValue("alias", "replace", i, true);
+                       a.RequiredNick = MyConf.ReadValue("alias", "requires", i);
+                       a.ULineOnly = MyConf.ReadFlag("alias", "uline", i);
+                       a.ChannelCommand = MyConf.ReadFlag("alias", "channelcommand", "no", i);
+                       a.UserCommand = MyConf.ReadFlag("alias", "usercommand", "yes", i);
+                       a.OperOnly = MyConf.ReadFlag("alias", "operonly", i);
+                       a.format = MyConf.ReadValue("alias", "format", i);
+                       a.CaseSensitive = MyConf.ReadFlag("alias", "matchcase", i);
+                       Aliases.insert(std::make_pair(txt, a));
+               }
+       }
+
+ public:
+
+       ModuleAlias(InspIRCd* Me)
+               : Module(Me)
+       {
+               ReadAliases();
+               Me->Modules->Attach(I_OnPreCommand, this);
+               Me->Modules->Attach(I_OnRehash, this);
+               Me->Modules->Attach(I_OnUserPreMessage, this);
+
+       }
+
+       virtual ~ModuleAlias()
+       {
+       }
+
+       virtual Version GetVersion()
+       {
+               return Version("$Id$", VF_VENDOR,API_VERSION);
+       }
+
+       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 int OnPreCommand(std::string &command, std::vector<std::string> &parameters, User *user, bool validated, const std::string &original_line)
+       {
+               std::multimap<std::string, Alias>::iterator i, upperbound;
+
+               /* If theyre not registered yet, we dont want
+                * to know.
+                */
+               if (user->registered != REG_ALL)
+                       return 0;
+
+               /* We dont have any commands looking like this? Stop processing. */
+               i = Aliases.find(command);
+               if (i == Aliases.end())
+                       return 0;
+               /* Avoid iterating on to different aliases if no patterns match. */
+               upperbound = Aliases.upper_bound(command);
+
+               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)
                        {
-                               Alias a;
-                               std::string txt;
-                               txt = MyConf->ReadValue("alias", "text", i);
-                               a.text = txt.c_str();
-                               a.replace_with = MyConf->ReadValue("alias", "replace", i);
-                               a.requires = MyConf->ReadValue("alias", "requires", i);
-                       
-                               a.uline =       ((MyConf->ReadValue("alias", "uline", i) == "yes") ||
-                                               (MyConf->ReadValue("alias", "uline", i) == "1") ||
-                                               (MyConf->ReadValue("alias", "uline", i) == "true"));
-                                       
-                               Aliases.push_back(a);
+                               if (DoAlias(user, NULL, &(i->second), compare, original_line))
+                               {
+                                       return 1;
+                               }
                        }
-       
+
+                       i++;
                }
 
-       public:
-       
-               ModuleAlias(Server* Me)
-                       : Module::Module(Me)
+               // If we made it here, no aliases actually matched.
+               return 0;
+       }
+
+       virtual int OnUserPreMessage(User *user, void *dest, int target_type, std::string &text, char status, CUList &exempt_list)
+       {
+               if (target_type != TYPE_CHANNEL)
                {
-                       Srv = Me;
-                       MyConf = new ConfigReader;
-                       ReadAliases();
+                       ServerInstance->Logs->Log("FANTASY", DEBUG, "fantasy: not a channel msg");
+                       return 0;
                }
-       
-               virtual ~ModuleAlias()
+
+               // fcommands are only for local users. Spanningtree will send them back out as their original cmd.
+               if (!IS_LOCAL(user))
                {
-                       delete MyConf;
+                       ServerInstance->Logs->Log("FANTASY", DEBUG, "fantasy: not local");
+                       return 0;
                }
-       
-               virtual Version GetVersion()
+
+               /* Stop here if the user is +B and allowbot is set to no. */
+               if (!AllowBots && user->IsModeSet('B'))
                {
-                       return Version(1,0,0,1,VF_VENDOR);
+                       ServerInstance->Logs->Log("FANTASY", DEBUG, "fantasy: user is +B and allowbot is set to no");
+                       return 0;
                }
 
-               virtual int OnPreCommand(std::string command, char **parameters, int pcnt, userrec *user, bool validated)
+               Channel *c = (Channel *)dest;
+               std::string fcommand;
+
+               // text is like "!moo cows bite me", we want "!moo" first
+               irc::spacesepstream ss(text);
+               ss.GetToken(fcommand);
+
+               if (fcommand.empty())
                {
-                       userrec *u = NULL;
-                       irc::string c = command.c_str();
+                       ServerInstance->Logs->Log("FANTASY", DEBUG, "fantasy: empty (?)");
+                       return 0; // wtfbbq
+               }
+
+               ServerInstance->Logs->Log("FANTASY", DEBUG, "fantasy: looking at fcommand %s", fcommand.c_str());
+
+               // we don't want to touch non-fantasy stuff
+               if (*fcommand.c_str() != fprefix)
+               {
+                       ServerInstance->Logs->Log("FANTASY", DEBUG, "fantasy: not a fcommand");
+                       return 0;
+               }
+
+               // nor do we give a shit about the prefix
+               fcommand.erase(fcommand.begin());
+               std::transform(fcommand.begin(), fcommand.end(), fcommand.begin(), ::toupper);
+               ServerInstance->Logs->Log("FANTASY", DEBUG, "fantasy: now got %s", fcommand.c_str());
 
-                       /* If the command is valid, we dont want to know */
-                       if (validated)
-                               return 0;
-                       
-                       for (unsigned int i = 0; i < Aliases.size(); i++)
+
+               std::multimap<std::string, Alias>::iterator i = Aliases.find(fcommand);
+
+               if (i == Aliases.end())
+                       return 0;
+
+               /* Avoid iterating on to other aliases if no patterns match */
+               std::multimap<std::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());
+
+               std::string safe(compare);
+
+               ServerInstance->Logs->Log("FANTASY", DEBUG, "fantasy: compare is %s and safe is %s", compare.c_str(), safe.c_str());
+
+               while (i != upperbound)
+               {
+                       if (i->second.ChannelCommand)
                        {
-                               if (Aliases[i].text == c)
-                               {
-                                       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.");
-                                               return 1;
-                                       }
-                                       if (Aliases[i].uline)
-                                       {
-                                               if (!Srv->IsUlined(u->server))
-                                               {
-                                                       Srv->SendOpers("*** 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!"); 
-                                                       Srv->SendServ(user->fd,"401 "+std::string(user->nick)+" "+Aliases[i].requires+" :is an imposter! Please inform an IRC operator as soon as possible.");
-                                                       return 1;
-                                               }
-                                       }
-
-                                       std::string n = "";
-                                       for (int j = 0; j < pcnt; j++)
-                                       {
-                                               if (j)
-                                                       n = n + " ";
-                                               n = n + parameters[j];
-                                       }
-                                       /* Final param now in n as one string */
-                                       std::stringstream stuff(Aliases[i].replace_with);
-
-                                       std::string cmd = "";
-                                       std::string target = "";
-                                       stuff >> cmd;
-                                       stuff >> target;
-
-                                       char* para[2];
-                                       para[0] = (char*)target.c_str();
-                                       para[1] = (char*)n.c_str();
-
-                                       Srv->CallCommandHandler(cmd,para,2,user);
-                                       return 1;
-                               }
+                               if (DoAlias(user, c, &(i->second), compare, safe))
+                                       return 0;
+                       }
+
+                       i++;
+               }
+
+               return 0;
+       }
+
+
+       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;
-               }
-  
-               virtual void OnRehash(std::string parameter)
-               {
-                       delete MyConf;
-                       MyConf = new ConfigReader;
-               
-                       ReadAliases();
-               }
-};
 
+               if (!a->RequiredNick.empty())
+               {
+                       u = ServerInstance->FindNick(a->RequiredNick);
+                       if (!u)
+                       {
+                               user->WriteNumeric(401, ""+std::string(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, ""+std::string(user->nick)+" "+a->RequiredNick+" :is an imposter! Please inform an IRC operator as soon as possible.");
+                               return 1;
+                       }
+               }
 
-class ModuleAliasFactory : public ModuleFactory
-{
-       public:
-               ModuleAliasFactory()
+               /* 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;
                }
-       
-               ~ModuleAliasFactory()
+               else
                {
+                       irc::sepstream commands(a->ReplaceFormat, '\n');
+                       std::string scommand;
+                       while (commands.GetToken(scommand))
+                       {
+                               DoCommand(scommand, user, c, safe);
+                       }
+                       return 1;
                }
-       
-               virtual Module * CreateModule(Server* Me)
+       }
+
+       void DoCommand(std::string newline, User* user, Channel *c, const std::string &original_line)
+       {
+               std::vector<std::string> pars;
+
+               for (int v = 1; v < 10; v++)
                {
-                       return new ModuleAlias(Me);
+                       std::string var = "$";
+                       var.append(ConvToStr(v));
+                       var.append("-");
+                       std::string::size_type x = newline.find(var);
+
+                       while (x != std::string::npos)
+                       {
+                               newline.erase(x, var.length());
+                               newline.insert(x, GetVar(var, original_line));
+                               x = newline.find(var);
+                       }
+
+                       var = "$";
+                       var.append(ConvToStr(v));
+                       x = newline.find(var);
+
+                       while (x != std::string::npos)
+                       {
+                               newline.erase(x, var.length());
+                               newline.insert(x, GetVar(var, original_line));
+                               x = newline.find(var);
+                       }
                }
-};
 
+               /* Special variables */
+               SearchAndReplace(newline, std::string("$nick"), user->nick);
+               SearchAndReplace(newline, std::string("$ident"), user->ident);
+               SearchAndReplace(newline, std::string("$host"), user->host);
+               SearchAndReplace(newline, std::string("$vhost"), user->dhost);
 
-extern "C" void * init_module( void )
-{
-       return new ModuleAliasFactory;
-}
+               if (c)
+               {
+                       /* Channel specific variables */
+                       SearchAndReplace(newline, std::string("$chan"), c->name);
+               }
+
+               irc::tokenstream ss(newline);
+               pars.clear();
+               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, const std::string &parameter)
+       {
+               ReadAliases();
+       }
+};
 
+MODULE_INIT(ModuleAlias)