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         irc::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         /* is case sensitive params */
  46         bool CaseSensitive;
  47
  48         /* whether or not it may be executed via fantasy (default OFF) */
  49         bool ChannelCommand;
  50
  51         /* whether or not it may be executed via /command (default ON) */
  52         bool UserCommand;
  53
  54         /** Format that must be matched for use */
  55         std::string format;
  56 };
  57
  58 class ModuleAlias : public Module
  59 {
  60         char fprefix;
  61
  62         /* We cant use a map, there may be multiple aliases with the same name.
  63          * We can, however, use a fancy invention: the multimap. Maps a key to one or more values.
  64          *              -- w00t
  65      */
  66         std::multimap<irc::string, Alias> Aliases;
  67
  68         /* whether or not +B users are allowed to use fantasy commands */
  69         bool AllowBots;
  70         UserModeReference botmode;
  71
  72         void ReadAliases()
  73         {
  74                 ConfigTag* fantasy = ServerInstance->Config->ConfValue("fantasy");
  75                 AllowBots = fantasy->getBool("allowbots", false);
  76                 std::string fpre = fantasy->getString("prefix", "!");
  77                 fprefix = fpre.empty() ? '!' : fpre[0];
  78
  79                 Aliases.clear();
  80                 ConfigTagList tags = ServerInstance->Config->ConfTags("alias");
  81                 for(ConfigIter i = tags.first; i != tags.second; ++i)
  82                 {
  83                         ConfigTag* tag = i->second;
  84                         Alias a;
  85                         std::string aliastext = tag->getString("text");
  86                         a.AliasedCommand = aliastext.c_str();
  87                         tag->readString("replace", a.ReplaceFormat, true);
  88                         a.RequiredNick = tag->getString("requires");
  89                         a.ULineOnly = tag->getBool("uline");
  90                         a.ChannelCommand = tag->getBool("channelcommand", false);
  91                         a.UserCommand = tag->getBool("usercommand", true);
  92                         a.OperOnly = tag->getBool("operonly");
  93                         a.format = tag->getString("format");
  94                         a.CaseSensitive = tag->getBool("matchcase");
  95                         Aliases.insert(std::make_pair(a.AliasedCommand, a));
  96                 }
  97         }
  98
  99  public:
 100         ModuleAlias()
 101                 : botmode(this, "bot")
 102         {
 103         }
 104
 105         void init() CXX11_OVERRIDE
 106         {
 107                 ReadAliases();
 108         }
 109
 110         Version GetVersion() CXX11_OVERRIDE
 111         {
 112                 return Version("Provides aliases of commands.", VF_VENDOR);
 113         }
 114
 115         std::string GetVar(std::string varname, const std::string &original_line)
 116         {
 117                 irc::spacesepstream ss(original_line);
 118                 varname.erase(varname.begin());
 119                 int index = *(varname.begin()) - 48;
 120                 varname.erase(varname.begin());
 121                 bool everything_after = (varname == "-");
 122                 std::string word;
 123
 124                 for (int j = 0; j < index; j++)
 125                         ss.GetToken(word);
 126
 127                 if (everything_after)
 128                 {
 129                         std::string more;
 130                         while (ss.GetToken(more))
 131                         {
 132                                 word.append(" ");
 133                                 word.append(more);
 134                         }
 135                 }
 136
 137                 return word;
 138         }
 139
 140         ModResult OnPreCommand(std::string &command, std::vector<std::string> &parameters, LocalUser *user, bool validated, const std::string &original_line) CXX11_OVERRIDE
 141         {
 142                 std::multimap<irc::string, Alias>::iterator i, upperbound;
 143
 144                 /* If theyre not registered yet, we dont want
 145                  * to know.
 146                  */
 147                 if (user->registered != REG_ALL)
 148                         return MOD_RES_PASSTHRU;
 149
 150                 /* We dont have any commands looking like this? Stop processing. */
 151                 i = Aliases.find(command.c_str());
 152                 if (i == Aliases.end())
 153                         return MOD_RES_PASSTHRU;
 154                 /* Avoid iterating on to different aliases if no patterns match. */
 155                 upperbound = Aliases.upper_bound(command.c_str());
 156
 157                 irc::string c = command.c_str();
 158                 /* The parameters for the command in their original form, with the command stripped off */
 159                 std::string compare = original_line.substr(command.length());
 160                 while (*(compare.c_str()) == ' ')
 161                         compare.erase(compare.begin());
 162
 163                 while (i != upperbound)
 164                 {
 165                         if (i->second.UserCommand)
 166                         {
 167                                 if (DoAlias(user, NULL, &(i->second), compare, original_line))
 168                                 {
 169                                         return MOD_RES_DENY;
 170                                 }
 171                         }
 172
 173                         i++;
 174                 }
 175
 176                 // If we made it here, no aliases actually matched.
 177                 return MOD_RES_PASSTHRU;
 178         }
 179
 180         void OnUserMessage(User *user, void *dest, int target_type, const std::string &text, char status, const CUList &exempt_list, MessageType msgtype) CXX11_OVERRIDE
 181         {
 182                 if ((target_type != TYPE_CHANNEL) || (msgtype != 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 (!user || !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 = (Channel *)dest;
 200                 std::string scommand;
 201
 202                 // text is like "!moo cows bite me", we want "!moo" first
 203                 irc::spacesepstream ss(text);
 204                 ss.GetToken(scommand);
 205                 irc::string fcommand = scommand.c_str();
 206
 207                 if (fcommand.empty())
 208                 {
 209                         return; // wtfbbq
 210                 }
 211
 212                 // we don't want to touch non-fantasy stuff
 213                 if (*fcommand.c_str() != fprefix)
 214                 {
 215                         return;
 216                 }
 217
 218                 // nor do we give a shit about the prefix
 219                 fcommand.erase(fcommand.begin());
 220
 221                 std::multimap<irc::string, Alias>::iterator i = Aliases.find(fcommand);
 222
 223                 if (i == Aliases.end())
 224                         return;
 225
 226                 /* Avoid iterating on to other aliases if no patterns match */
 227                 std::multimap<irc::string, Alias>::iterator upperbound = Aliases.upper_bound(fcommand);
 228
 229
 230                 /* The parameters for the command in their original form, with the command stripped off */
 231                 std::string compare = text.substr(fcommand.length() + 1);
 232                 while (*(compare.c_str()) == ' ')
 233                         compare.erase(compare.begin());
 234
 235                 while (i != upperbound)
 236                 {
 237                         if (i->second.ChannelCommand)
 238                         {
 239                                 // We use substr(1) here to remove the fantasy prefix
 240                                 if (DoAlias(user, c, &(i->second), compare, text.substr(1)))
 241                                         return;
 242                         }
 243
 244                         i++;
 245                 }
 246         }
 247
 248
 249         int DoAlias(User *user, Channel *c, Alias *a, const std::string& compare, const std::string& safe)
 250         {
 251                 User *u = NULL;
 252
 253                 /* Does it match the pattern? */
 254                 if (!a->format.empty())
 255                 {
 256                         if (a->CaseSensitive)
 257                         {
 258                                 if (!InspIRCd::Match(compare, a->format, rfc_case_sensitive_map))
 259                                         return 0;
 260                         }
 261                         else
 262                         {
 263                                 if (!InspIRCd::Match(compare, a->format))
 264                                         return 0;
 265                         }
 266                 }
 267
 268                 if ((a->OperOnly) && (!user->IsOper()))
 269                         return 0;
 270
 271                 if (!a->RequiredNick.empty())
 272                 {
 273                         u = ServerInstance->FindNick(a->RequiredNick);
 274                         if (!u)
 275                         {
 276                                 user->WriteNumeric(401, ""+user->nick+" "+a->RequiredNick+" :is currently unavailable. Please try again later.");
 277                                 return 1;
 278                         }
 279                 }
 280                 if ((u != NULL) && (!a->RequiredNick.empty()) && (a->ULineOnly))
 281                 {
 282                         if (!ServerInstance->ULine(u->server))
 283                         {
 284                                 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!");
 285                                 user->WriteNumeric(401, ""+user->nick+" "+a->RequiredNick+" :is an imposter! Please inform an IRC operator as soon as possible.");
 286                                 return 1;
 287                         }
 288                 }
 289
 290                 /* Now, search and replace in a copy of the original_line, replacing $1 through $9 and $1- etc */
 291
 292                 std::string::size_type crlf = a->ReplaceFormat.find('\n');
 293
 294                 if (crlf == std::string::npos)
 295                 {
 296                         DoCommand(a->ReplaceFormat, user, c, safe);
 297                         return 1;
 298                 }
 299                 else
 300                 {
 301                         irc::sepstream commands(a->ReplaceFormat, '\n');
 302                         std::string scommand;
 303                         while (commands.GetToken(scommand))
 304                         {
 305                                 DoCommand(scommand, user, c, safe);
 306                         }
 307                         return 1;
 308                 }
 309         }
 310
 311         void DoCommand(const std::string& newline, User* user, Channel *chan, const std::string &original_line)
 312         {
 313                 std::string result;
 314                 result.reserve(newline.length());
 315                 for (unsigned int i = 0; i < newline.length(); i++)
 316                 {
 317                         char c = newline[i];
 318                         if (c == '$')
 319                         {
 320                                 if (isdigit(newline[i+1]))
 321                                 {
 322                                         int len = (newline[i+2] == '-') ? 3 : 2;
 323                                         std::string var = newline.substr(i, len);
 324                                         result.append(GetVar(var, original_line));
 325                                         i += len - 1;
 326                                 }
 327                                 else if (newline.substr(i, 5) == "$nick")
 328                                 {
 329                                         result.append(user->nick);
 330                                         i += 4;
 331                                 }
 332                                 else if (newline.substr(i, 5) == "$host")
 333                                 {
 334                                         result.append(user->host);
 335                                         i += 4;
 336                                 }
 337                                 else if (newline.substr(i, 5) == "$chan")
 338                                 {
 339                                         if (chan)
 340                                                 result.append(chan->name);
 341                                         i += 4;
 342                                 }
 343                                 else if (newline.substr(i, 6) == "$ident")
 344                                 {
 345                                         result.append(user->ident);
 346                                         i += 5;
 347                                 }
 348                                 else if (newline.substr(i, 6) == "$vhost")
 349                                 {
 350                                         result.append(user->dhost);
 351                                         i += 5;
 352                                 }
 353                                 else
 354                                         result.push_back(c);
 355                         }
 356                         else
 357                                 result.push_back(c);
 358                 }
 359
 360                 irc::tokenstream ss(result);
 361                 std::vector<std::string> pars;
 362                 std::string command, token;
 363
 364                 ss.GetToken(command);
 365                 while (ss.GetToken(token))
 366                 {
 367                         pars.push_back(token);
 368                 }
 369                 ServerInstance->Parser->CallHandler(command, pars, user);
 370         }
 371
 372         void OnRehash(User* user) CXX11_OVERRIDE
 373         {
 374                 ReadAliases();
 375         }
 376
 377         void Prioritize()
 378         {
 379                 // Prioritise after spanningtree so that channel aliases show the alias before the effects.
 380                 Module* linkmod = ServerInstance->Modules->Find("m_spanningtree.so");
 381                 ServerInstance->Modules->SetPriority(this, I_OnUserMessage, PRIORITY_AFTER, &linkmod);
 382         }
 383 };
 384
 385 MODULE_INIT(ModuleAlias)