src/modules/m_alias.cpp

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd: (C) 2002-2009 InspIRCd Development Team
   6  * See: http://www.inspircd.org/wiki/index.php/Credits
   7  *
   8  * This program is free but copyrighted software; see
   9  *            the file COPYING for details.
  10  *
  11  * ---------------------------------------------------
  12  */
  13
  14 #include "inspircd.h"
  15
  16 /* $ModDesc: Provides aliases of commands. */
  17
  18 /** An alias definition
  19  */
  20 class Alias : public classbase
  21 {
  22  public:
  23         /** The text of the alias command */
  24         irc::string AliasedCommand;
  25
  26         /** Text to replace with */
  27         std::string ReplaceFormat;
  28
  29         /** Nickname required to perform alias */
  30         std::string RequiredNick;
  31
  32         /** Alias requires ulined server */
  33         bool ULineOnly;
  34
  35         /** Requires oper? */
  36         bool OperOnly;
  37
  38         /* is case sensitive params */
  39         bool CaseSensitive;
  40
  41         /* whether or not it may be executed via fantasy (default OFF) */
  42         bool ChannelCommand;
  43
  44         /* whether or not it may be executed via /command (default ON) */
  45         bool UserCommand;
  46
  47         /** Format that must be matched for use */
  48         std::string format;
  49 };
  50
  51 class ModuleAlias : public Module
  52 {
  53  private:
  54
  55         char fprefix;
  56
  57         /* We cant use a map, there may be multiple aliases with the same name.
  58          * We can, however, use a fancy invention: the multimap. Maps a key to one or more values.
  59          *              -- w00t
  60    */
  61         std::multimap<std::string, Alias> Aliases;
  62
  63         /* whether or not +B users are allowed to use fantasy commands */
  64         bool AllowBots;
  65
  66         virtual void ReadAliases()
  67         {
  68                 ConfigReader MyConf(ServerInstance);
  69
  70                 AllowBots = MyConf.ReadFlag("fantasy", "allowbots", "no", 0);
  71
  72                 std::string fpre = MyConf.ReadValue("fantasy","prefix",0);
  73                 fprefix = fpre.empty() ? '!' : fpre[0];
  74
  75                 Aliases.clear();
  76                 for (int i = 0; i < MyConf.Enumerate("alias"); i++)
  77                 {
  78                         Alias a;
  79                         std::string txt;
  80                         txt = MyConf.ReadValue("alias", "text", i);
  81                         a.AliasedCommand = txt.c_str();
  82                         a.ReplaceFormat = MyConf.ReadValue("alias", "replace", i, true);
  83                         a.RequiredNick = MyConf.ReadValue("alias", "requires", i);
  84                         a.ULineOnly = MyConf.ReadFlag("alias", "uline", i);
  85                         a.ChannelCommand = MyConf.ReadFlag("alias", "channelcommand", "no", i);
  86                         a.UserCommand = MyConf.ReadFlag("alias", "usercommand", "yes", i);
  87                         a.OperOnly = MyConf.ReadFlag("alias", "operonly", i);
  88                         a.format = MyConf.ReadValue("alias", "format", i);
  89                         a.CaseSensitive = MyConf.ReadFlag("alias", "matchcase", i);
  90                         Aliases.insert(std::make_pair(txt, a));
  91                 }
  92         }
  93
  94  public:
  95
  96         ModuleAlias(InspIRCd* Me)
  97                 : Module(Me)
  98         {
  99                 ReadAliases();
 100                 Me->Modules->Attach(I_OnPreCommand, this);
 101                 Me->Modules->Attach(I_OnRehash, this);
 102                 Me->Modules->Attach(I_OnUserPreMessage, this);
 103
 104         }
 105
 106         virtual ~ModuleAlias()
 107         {
 108         }
 109
 110         virtual Version GetVersion()
 111         {
 112                 return Version("$Id$", VF_VENDOR,API_VERSION);
 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         virtual int OnPreCommand(std::string &command, std::vector<std::string> &parameters, User *user, bool validated, const std::string &original_line)
 141         {
 142                 std::multimap<std::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 0;
 149
 150                 /* We dont have any commands looking like this? Stop processing. */
 151                 i = Aliases.find(command);
 152                 if (i == Aliases.end())
 153                         return 0;
 154                 /* Avoid iterating on to different aliases if no patterns match. */
 155                 upperbound = Aliases.upper_bound(command);
 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 1;
 170                                 }
 171                         }
 172
 173                         i++;
 174                 }
 175
 176                 // If we made it here, no aliases actually matched.
 177                 return 0;
 178         }
 179
 180         virtual int OnUserPreMessage(User *user, void *dest, int target_type, std::string &text, char status, CUList &exempt_list)
 181         {
 182                 if (target_type != TYPE_CHANNEL)
 183                 {
 184                         ServerInstance->Logs->Log("FANTASY", DEBUG, "fantasy: not a channel msg");
 185                         return 0;
 186                 }
 187
 188                 // fcommands are only for local users. Spanningtree will send them back out as their original cmd.
 189                 if (!IS_LOCAL(user))
 190                 {
 191                         ServerInstance->Logs->Log("FANTASY", DEBUG, "fantasy: not local");
 192                         return 0;
 193                 }
 194
 195                 /* Stop here if the user is +B and allowbot is set to no. */
 196                 if (!AllowBots && user->IsModeSet('B'))
 197                 {
 198                         ServerInstance->Logs->Log("FANTASY", DEBUG, "fantasy: user is +B and allowbot is set to no");
 199                         return 0;
 200                 }
 201
 202                 Channel *c = (Channel *)dest;
 203                 std::string fcommand;
 204
 205                 // text is like "!moo cows bite me", we want "!moo" first
 206                 irc::spacesepstream ss(text);
 207                 ss.GetToken(fcommand);
 208
 209                 if (fcommand.empty())
 210                 {
 211                         ServerInstance->Logs->Log("FANTASY", DEBUG, "fantasy: empty (?)");
 212                         return 0; // wtfbbq
 213                 }
 214
 215                 ServerInstance->Logs->Log("FANTASY", DEBUG, "fantasy: looking at fcommand %s", fcommand.c_str());
 216
 217                 // we don't want to touch non-fantasy stuff
 218                 if (*fcommand.c_str() != fprefix)
 219                 {
 220                         ServerInstance->Logs->Log("FANTASY", DEBUG, "fantasy: not a fcommand");
 221                         return 0;
 222                 }
 223
 224                 // nor do we give a shit about the prefix
 225                 fcommand.erase(fcommand.begin());
 226                 std::transform(fcommand.begin(), fcommand.end(), fcommand.begin(), ::toupper);
 227                 ServerInstance->Logs->Log("FANTASY", DEBUG, "fantasy: now got %s", fcommand.c_str());
 228
 229
 230                 std::multimap<std::string, Alias>::iterator i = Aliases.find(fcommand);
 231
 232                 if (i == Aliases.end())
 233                         return 0;
 234
 235                 /* Avoid iterating on to other aliases if no patterns match */
 236                 std::multimap<std::string, Alias>::iterator upperbound = Aliases.upper_bound(fcommand);
 237
 238
 239                 /* The parameters for the command in their original form, with the command stripped off */
 240                 std::string compare = text.substr(fcommand.length() + 1);
 241                 while (*(compare.c_str()) == ' ')
 242                         compare.erase(compare.begin());
 243
 244                 std::string safe(compare);
 245
 246                 ServerInstance->Logs->Log("FANTASY", DEBUG, "fantasy: compare is %s and safe is %s", compare.c_str(), safe.c_str());
 247
 248                 while (i != upperbound)
 249                 {
 250                         if (i->second.ChannelCommand)
 251                         {
 252                                 if (DoAlias(user, c, &(i->second), compare, safe))
 253                                         return 0;
 254                         }
 255
 256                         i++;
 257                 }
 258
 259                 return 0;
 260         }
 261
 262
 263         int DoAlias(User *user, Channel *c, Alias *a, const std::string compare, const std::string safe)
 264         {
 265                 User *u = NULL;
 266
 267                 /* Does it match the pattern? */
 268                 if (!a->format.empty())
 269                 {
 270                         if (a->CaseSensitive)
 271                         {
 272                                 if (!InspIRCd::Match(compare, a->format, rfc_case_sensitive_map))
 273                                         return 0;
 274                         }
 275                         else
 276                         {
 277                                 if (!InspIRCd::Match(compare, a->format))
 278                                         return 0;
 279                         }
 280                 }
 281
 282                 if ((a->OperOnly) && (!IS_OPER(user)))
 283                         return 0;
 284
 285                 if (!a->RequiredNick.empty())
 286                 {
 287                         u = ServerInstance->FindNick(a->RequiredNick);
 288                         if (!u)
 289                         {
 290                                 user->WriteNumeric(401, ""+std::string(user->nick)+" "+a->RequiredNick+" :is currently unavailable. Please try again later.");
 291                                 return 1;
 292                         }
 293                 }
 294                 if ((u != NULL) && (!a->RequiredNick.empty()) && (a->ULineOnly))
 295                 {
 296                         if (!ServerInstance->ULine(u->server))
 297                         {
 298                                 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!");
 299                                 user->WriteNumeric(401, ""+std::string(user->nick)+" "+a->RequiredNick+" :is an imposter! Please inform an IRC operator as soon as possible.");
 300                                 return 1;
 301                         }
 302                 }
 303
 304                 /* Now, search and replace in a copy of the original_line, replacing $1 through $9 and $1- etc */
 305
 306                 std::string::size_type crlf = a->ReplaceFormat.find('\n');
 307
 308                 if (crlf == std::string::npos)
 309                 {
 310                         DoCommand(a->ReplaceFormat, user, c, safe);
 311                         return 1;
 312                 }
 313                 else
 314                 {
 315                         irc::sepstream commands(a->ReplaceFormat, '\n');
 316                         std::string scommand;
 317                         while (commands.GetToken(scommand))
 318                         {
 319                                 DoCommand(scommand, user, c, safe);
 320                         }
 321                         return 1;
 322                 }
 323         }
 324
 325         void DoCommand(std::string newline, User* user, Channel *c, const std::string &original_line)
 326         {
 327                 std::vector<std::string> pars;
 328
 329                 for (int v = 1; v < 10; v++)
 330                 {
 331                         std::string var = "$";
 332                         var.append(ConvToStr(v));
 333                         var.append("-");
 334                         std::string::size_type x = newline.find(var);
 335
 336                         while (x != std::string::npos)
 337                         {
 338                                 newline.erase(x, var.length());
 339                                 newline.insert(x, GetVar(var, original_line));
 340                                 x = newline.find(var);
 341                         }
 342
 343                         var = "$";
 344                         var.append(ConvToStr(v));
 345                         x = newline.find(var);
 346
 347                         while (x != std::string::npos)
 348                         {
 349                                 newline.erase(x, var.length());
 350                                 newline.insert(x, GetVar(var, original_line));
 351                                 x = newline.find(var);
 352                         }
 353                 }
 354
 355                 /* Special variables */
 356                 SearchAndReplace(newline, std::string("$nick"), user->nick);
 357                 SearchAndReplace(newline, std::string("$ident"), user->ident);
 358                 SearchAndReplace(newline, std::string("$host"), user->host);
 359                 SearchAndReplace(newline, std::string("$vhost"), user->dhost);
 360
 361                 if (c)
 362                 {
 363                         /* Channel specific variables */
 364                         SearchAndReplace(newline, std::string("$chan"), c->name);
 365                 }
 366
 367                 irc::tokenstream ss(newline);
 368                 pars.clear();
 369                 std::string command, token;
 370
 371                 ss.GetToken(command);
 372                 while (ss.GetToken(token) && (pars.size() <= MAXPARAMETERS))
 373                 {
 374                         pars.push_back(token);
 375                 }
 376                 ServerInstance->Parser->CallHandler(command, pars, user);
 377         }
 378
 379         virtual void OnRehash(User* user, const std::string &parameter)
 380         {
 381                 ReadAliases();
 382         }
 383 };
 384
 385 MODULE_INIT(ModuleAlias)