src/modules/m_alias.cpp

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
   5  *   Copyright (C) 2005, 2009 Robin Burchell <robin+git@viroteck.net>
   6  *   Copyright (C) 2004-2007, 2009 Craig Edwards <craigedwards@brainbox.cc>
   7  *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
   8  *
   9  * This file is part of InspIRCd.  InspIRCd is free software: you can
  10  * redistribute it and/or modify it under the terms of the GNU General Public
  11  * License as published by the Free Software Foundation, version 2.
  12  *
  13  * This program is distributed in the hope that it will be useful, but WITHOUT
  14  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  15  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  16  * details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20  */
  21
  22
  23 #include "inspircd.h"
  24
  25 /** An alias definition
  26  */
  27 class Alias
  28 {
  29  public:
  30         /** The text of the alias command */
  31         std::string AliasedCommand;
  32
  33         /** Text to replace with */
  34         std::string ReplaceFormat;
  35
  36         /** Nickname required to perform alias */
  37         std::string RequiredNick;
  38
  39         /** Alias requires ulined server */
  40         bool ULineOnly;
  41
  42         /** Requires oper? */
  43         bool OperOnly;
  44
  45         /* whether or not it may be executed via fantasy (default OFF) */
  46         bool ChannelCommand;
  47
  48         /* whether or not it may be executed via /command (default ON) */
  49         bool UserCommand;
  50
  51         /** Format that must be matched for use */
  52         std::string format;
  53 };
  54
  55 class ModuleAlias : public Module
  56 {
  57         std::string fprefix;
  58
  59         /* We cant use a map, there may be multiple aliases with the same name.
  60          * We can, however, use a fancy invention: the multimap. Maps a key to one or more values.
  61          *              -- w00t
  62          */
  63         typedef insp::flat_multimap<std::string, Alias, irc::insensitive_swo> AliasMap;
  64
  65         AliasMap Aliases;
  66
  67         /* whether or not +B users are allowed to use fantasy commands */
  68         bool AllowBots;
  69         UserModeReference botmode;
  70
  71  public:
  72         void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
  73         {
  74                 ConfigTag* fantasy = ServerInstance->Config->ConfValue("fantasy");
  75                 AllowBots = fantasy->getBool("allowbots", false);
  76                 fprefix = fantasy->getString("prefix", "!", 1, ServerInstance->Config->Limits.MaxLine);
  77
  78                 Aliases.clear();
  79                 ConfigTagList tags = ServerInstance->Config->ConfTags("alias");
  80                 for(ConfigIter i = tags.first; i != tags.second; ++i)
  81                 {
  82                         ConfigTag* tag = i->second;
  83                         Alias a;
  84                         a.AliasedCommand = tag->getString("text");
  85                         std::transform(a.AliasedCommand.begin(), a.AliasedCommand.end(), a.AliasedCommand.begin(), ::toupper);
  86                         tag->readString("replace", a.ReplaceFormat, true);
  87                         a.RequiredNick = tag->getString("requires");
  88                         a.ULineOnly = tag->getBool("uline");
  89                         a.ChannelCommand = tag->getBool("channelcommand", false);
  90                         a.UserCommand = tag->getBool("usercommand", true);
  91                         a.OperOnly = tag->getBool("operonly");
  92                         a.format = tag->getString("format");
  93                         Aliases.insert(std::make_pair(a.AliasedCommand, a));
  94                 }
  95         }
  96
  97         ModuleAlias()
  98                 : botmode(this, "bot")
  99         {
 100         }
 101
 102         Version GetVersion() CXX11_OVERRIDE
 103         {
 104                 return Version("Provides aliases of commands.", VF_VENDOR);
 105         }
 106
 107         std::string GetVar(std::string varname, const std::string &original_line)
 108         {
 109                 irc::spacesepstream ss(original_line);
 110                 varname.erase(varname.begin());
 111                 int index = *(varname.begin()) - 48;
 112                 varname.erase(varname.begin());
 113                 bool everything_after = (varname == "-");
 114                 std::string word;
 115
 116                 for (int j = 0; j < index; j++)
 117                         ss.GetToken(word);
 118
 119                 if (everything_after)
 120                 {
 121                         std::string more;
 122                         while (ss.GetToken(more))
 123                         {
 124                                 word.append(" ");
 125                                 word.append(more);
 126                         }
 127                 }
 128
 129                 return word;
 130         }
 131
 132         std::string CreateRFCMessage(const std::string& command, Command::Params& parameters)
 133         {
 134                 std::string message(command);
 135                 for (CommandBase::Params::const_iterator iter = parameters.begin(); iter != parameters.end();)
 136                 {
 137                         const std::string& parameter = *++iter;
 138                         message.push_back(' ');
 139                         if (iter == parameters.end())
 140                                 message.push_back(':');
 141                         message.append(parameter);
 142                 }
 143                 return message;
 144         }
 145
 146         ModResult OnPreCommand(std::string& command, CommandBase::Params& parameters, LocalUser* user, bool validated) CXX11_OVERRIDE
 147         {
 148                 /* If theyre not registered yet, we dont want
 149                  * to know.
 150                  */
 151                 if (user->registered != REG_ALL)
 152                         return MOD_RES_PASSTHRU;
 153
 154                 /* We dont have any commands looking like this? Stop processing. */
 155                 std::pair<AliasMap::iterator, AliasMap::iterator> iters = Aliases.equal_range(command);
 156                 if (iters.first == iters.second)
 157                         return MOD_RES_PASSTHRU;
 158
 159                 /* The parameters for the command in their original form, with the command stripped off */
 160                 std::string original_line = CreateRFCMessage(command, parameters);
 161                 std::string compare(original_line, command.length());
 162                 while (*(compare.c_str()) == ' ')
 163                         compare.erase(compare.begin());
 164
 165                 for (AliasMap::iterator i = iters.first; i != iters.second; ++i)
 166                 {
 167                         if (i->second.UserCommand)
 168                         {
 169                                 if (DoAlias(user, NULL, &(i->second), compare, original_line))
 170                                 {
 171                                         return MOD_RES_DENY;
 172                                 }
 173                         }
 174                 }
 175
 176                 // If we made it here, no aliases actually matched.
 177                 return MOD_RES_PASSTHRU;
 178         }
 179
 180         void OnUserPostMessage(User* user, const MessageTarget& target, const MessageDetails& details) CXX11_OVERRIDE
 181         {
 182                 if ((target.type != MessageTarget::TYPE_CHANNEL) || (details.type != MSG_PRIVMSG))
 183                 {
 184                         return;
 185                 }
 186
 187                 // fcommands are only for local users. Spanningtree will send them back out as their original cmd.
 188                 if (!IS_LOCAL(user))
 189                 {
 190                         return;
 191                 }
 192
 193                 /* Stop here if the user is +B and allowbot is set to no. */
 194                 if (!AllowBots && user->IsModeSet(botmode))
 195                 {
 196                         return;
 197                 }
 198
 199                 Channel *c = target.Get<Channel>();
 200                 std::string scommand;
 201
 202                 // text is like "!moo cows bite me", we want "!moo" first
 203                 irc::spacesepstream ss(details.text);
 204                 ss.GetToken(scommand);
 205
 206                 if (scommand.size() <= fprefix.size())
 207                 {
 208                         return; // wtfbbq
 209                 }
 210
 211                 // we don't want to touch non-fantasy stuff
 212                 if (scommand.compare(0, fprefix.size(), fprefix) != 0)
 213                 {
 214                         return;
 215                 }
 216
 217                 // nor do we give a shit about the prefix
 218                 scommand.erase(0, fprefix.size());
 219
 220                 std::pair<AliasMap::iterator, AliasMap::iterator> iters = Aliases.equal_range(scommand);
 221                 if (iters.first == iters.second)
 222                         return;
 223
 224                 /* The parameters for the command in their original form, with the command stripped off */
 225                 std::string compare(details.text, scommand.length() + fprefix.size());
 226                 while (*(compare.c_str()) == ' ')
 227                         compare.erase(compare.begin());
 228
 229                 for (AliasMap::iterator i = iters.first; i != iters.second; ++i)
 230                 {
 231                         if (i->second.ChannelCommand)
 232                         {
 233                                 // We use substr here to remove the fantasy prefix
 234                                 if (DoAlias(user, c, &(i->second), compare, details.text.substr(fprefix.size())))
 235                                         return;
 236                         }
 237                 }
 238         }
 239
 240
 241         int DoAlias(User *user, Channel *c, Alias *a, const std::string& compare, const std::string& safe)
 242         {
 243                 /* Does it match the pattern? */
 244                 if (!a->format.empty())
 245                 {
 246                         if (!InspIRCd::Match(compare, a->format))
 247                                 return 0;
 248                 }
 249
 250                 if ((a->OperOnly) && (!user->IsOper()))
 251                         return 0;
 252
 253                 if (!a->RequiredNick.empty())
 254                 {
 255                         User* u = ServerInstance->FindNick(a->RequiredNick);
 256                         if (!u)
 257                         {
 258                                 user->WriteNumeric(ERR_NOSUCHNICK, a->RequiredNick, "is currently unavailable. Please try again later.");
 259                                 return 1;
 260                         }
 261
 262                         if ((a->ULineOnly) && (!u->server->IsULine()))
 263                         {
 264                                 ServerInstance->SNO->WriteToSnoMask('a', "NOTICE -- Service "+a->RequiredNick+" required by alias "+a->AliasedCommand+" is not on a u-lined server, possibly underhanded antics detected!");
 265                                 user->WriteNumeric(ERR_NOSUCHNICK, a->RequiredNick, "is an imposter! Please inform an IRC operator as soon as possible.");
 266                                 return 1;
 267                         }
 268                 }
 269
 270                 /* Now, search and replace in a copy of the original_line, replacing $1 through $9 and $1- etc */
 271
 272                 std::string::size_type crlf = a->ReplaceFormat.find('\n');
 273
 274                 if (crlf == std::string::npos)
 275                 {
 276                         DoCommand(a->ReplaceFormat, user, c, safe, a);
 277                         return 1;
 278                 }
 279                 else
 280                 {
 281                         irc::sepstream commands(a->ReplaceFormat, '\n');
 282                         std::string scommand;
 283                         while (commands.GetToken(scommand))
 284                         {
 285                                 DoCommand(scommand, user, c, safe, a);
 286                         }
 287                         return 1;
 288                 }
 289         }
 290
 291         void DoCommand(const std::string& newline, User* user, Channel *chan, const std::string &original_line, Alias* a)
 292         {
 293                 std::string result;
 294                 result.reserve(newline.length());
 295                 for (unsigned int i = 0; i < newline.length(); i++)
 296                 {
 297                         char c = newline[i];
 298                         if ((c == '$') && (i + 1 < newline.length()))
 299                         {
 300                                 if (isdigit(newline[i+1]))
 301                                 {
 302                                         size_t len = ((i + 2 < newline.length()) && (newline[i+2] == '-')) ? 3 : 2;
 303                                         std::string var = newline.substr(i, len);
 304                                         result.append(GetVar(var, original_line));
 305                                         i += len - 1;
 306                                 }
 307                                 else if (!newline.compare(i, 5, "$nick", 5))
 308                                 {
 309                                         result.append(user->nick);
 310                                         i += 4;
 311                                 }
 312                                 else if (!newline.compare(i, 5, "$host", 5))
 313                                 {
 314                                         result.append(user->GetRealHost());
 315                                         i += 4;
 316                                 }
 317                                 else if (!newline.compare(i, 5, "$chan", 5))
 318                                 {
 319                                         if (chan)
 320                                                 result.append(chan->name);
 321                                         i += 4;
 322                                 }
 323                                 else if (!newline.compare(i, 6, "$ident", 6))
 324                                 {
 325                                         result.append(user->ident);
 326                                         i += 5;
 327                                 }
 328                                 else if (!newline.compare(i, 6, "$vhost", 6))
 329                                 {
 330                                         result.append(user->GetDisplayedHost());
 331                                         i += 5;
 332                                 }
 333                                 else if (!newline.compare(i, 12, "$requirement", 12))
 334                                 {
 335                                         result.append(a->RequiredNick);
 336                                         i += 11;
 337                                 }
 338                                 else
 339                                         result.push_back(c);
 340                         }
 341                         else
 342                                 result.push_back(c);
 343                 }
 344
 345                 irc::tokenstream ss(result);
 346                 CommandBase::Params pars;
 347                 std::string command, token;
 348
 349                 ss.GetMiddle(command);
 350                 while (ss.GetTrailing(token))
 351                 {
 352                         pars.push_back(token);
 353                 }
 354                 ServerInstance->Parser.CallHandler(command, pars, user);
 355         }
 356
 357         void Prioritize() CXX11_OVERRIDE
 358         {
 359                 // Prioritise after spanningtree so that channel aliases show the alias before the effects.
 360                 Module* linkmod = ServerInstance->Modules->Find("m_spanningtree.so");
 361                 ServerInstance->Modules->SetPriority(this, I_OnUserPostMessage, PRIORITY_AFTER, linkmod);
 362         }
 363 };
 364
 365 MODULE_INIT(ModuleAlias)