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         /* We cant use a map, there may be multiple aliases with the same name.
  55          * We can, however, use a fancy invention: the multimap. Maps a key to one or more values.
  56          *              -- w00t
  57    */
  58         std::multimap<std::string, Alias> Aliases;
  59
  60         virtual void ReadAliases()
  61         {
  62                 ConfigReader MyConf(ServerInstance);
  63
  64                 Aliases.clear();
  65                 for (int i = 0; i < MyConf.Enumerate("alias"); i++)
  66                 {
  67                         Alias a;
  68                         std::string txt;
  69                         txt = MyConf.ReadValue("alias", "text", i);
  70                         a.AliasedCommand = txt.c_str();
  71                         a.ReplaceFormat = MyConf.ReadValue("alias", "replace", i, true);
  72                         a.RequiredNick = MyConf.ReadValue("alias", "requires", i);
  73                         a.ULineOnly = MyConf.ReadFlag("alias", "uline", i);
  74                         a.ChannelCommand = MyConf.ReadFlag("alias", "channelcommand", "no", i);
  75                         a.UserCommand = MyConf.ReadFlag("alias", "usercommand", "yes", i);
  76                         a.OperOnly = MyConf.ReadFlag("alias", "operonly", i);
  77                         a.format = MyConf.ReadValue("alias", "format", i);
  78                         a.CaseSensitive = MyConf.ReadFlag("alias", "matchcase", i);
  79                         Aliases.insert(std::make_pair(txt, a));
  80                 }
  81         }
  82
  83  public:
  84
  85         ModuleAlias(InspIRCd* Me)
  86                 : Module(Me)
  87         {
  88                 ReadAliases();
  89                 Me->Modules->Attach(I_OnPreCommand, this);
  90                 Me->Modules->Attach(I_OnRehash, this);
  91                 Me->Modules->Attach(I_OnUserPreMessage, this);
  92
  93         }
  94
  95         virtual ~ModuleAlias()
  96         {
  97         }
  98
  99         virtual Version GetVersion()
 100         {
 101                 return Version("$Id$", VF_VENDOR,API_VERSION);
 102         }
 103
 104         std::string GetVar(std::string varname, const std::string &original_line)
 105         {
 106                 irc::spacesepstream ss(original_line);
 107                 varname.erase(varname.begin());
 108                 int index = *(varname.begin()) - 48;
 109                 varname.erase(varname.begin());
 110                 bool everything_after = (varname == "-");
 111                 std::string word;
 112
 113                 for (int j = 0; j < index; j++)
 114                         ss.GetToken(word);
 115
 116                 if (everything_after)
 117                 {
 118                         std::string more;
 119                         while (ss.GetToken(more))
 120                         {
 121                                 word.append(" ");
 122                                 word.append(more);
 123                         }
 124                 }
 125
 126                 return word;
 127         }
 128
 129         void SearchAndReplace(std::string& newline, const std::string &find, const std::string &replace)
 130         {
 131                 std::string::size_type x = newline.find(find);
 132                 while (x != std::string::npos)
 133                 {
 134                         newline.erase(x, find.length());
 135                         newline.insert(x, replace);
 136                         x = newline.find(find);
 137                 }
 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                 std::string safe(original_line);
 164
 165                 /* Escape out any $ symbols in the user provided text */
 166
 167                 SearchAndReplace(safe, "$", "\r");
 168
 169                 while (i != upperbound)
 170                 {
 171                         if (i->second.UserCommand)
 172                         {
 173                                 if (DoAlias(user, NULL, &(i->second), compare, safe))
 174                                 {
 175                                         return 1;
 176                                 }
 177                         }
 178
 179                         i++;
 180                 }
 181
 182                 // If aliases have been processed, aliases took it.
 183                 return 1;
 184         }
 185
 186         virtual int OnUserPreMessage(User *user, void *dest, int target_type, std::string &text, char status, CUList &exempt_list)
 187         {
 188                 if (target_type != TYPE_CHANNEL)
 189                 {
 190                         ServerInstance->Logs->Log("FANTASY", DEBUG, "fantasy: not a channel msg");
 191                         return 0;
 192                 }
 193
 194                 // fcommands are only for local users. Spanningtree will send them back out as their original cmd.
 195                 if (!IS_LOCAL(user))
 196                 {
 197                         ServerInstance->Logs->Log("FANTASY", DEBUG, "fantasy: not local");
 198                         return 0;
 199                 }
 200
 201                 Channel *c = (Channel *)dest;
 202                 std::string fcommand;
 203
 204                 // text is like "!moo cows bite me", we want "!moo" first
 205                 irc::spacesepstream ss(text);
 206                 ss.GetToken(fcommand);
 207
 208                 if (fcommand.empty())
 209                 {
 210                         ServerInstance->Logs->Log("FANTASY", DEBUG, "fantasy: empty (?)");
 211                         return 0; // wtfbbq
 212                 }
 213
 214                 ServerInstance->Logs->Log("FANTASY", DEBUG, "fantasy: looking at fcommand %s", fcommand.c_str());
 215
 216                 // we don't want to touch non-fantasy stuff
 217                 if (*fcommand.c_str() != '!')
 218                 {
 219                         ServerInstance->Logs->Log("FANTASY", DEBUG, "fantasy: not a fcommand");
 220                         return 0;
 221                 }
 222
 223                 // nor do we give a shit about the !
 224                 fcommand.erase(fcommand.begin());
 225                 std::transform(fcommand.begin(), fcommand.end(), fcommand.begin(), ::toupper);
 226                 ServerInstance->Logs->Log("FANTASY", DEBUG, "fantasy: now got %s", fcommand.c_str());
 227
 228
 229                 std::multimap<std::string, Alias>::iterator i = Aliases.find(fcommand);
 230
 231                 if (i == Aliases.end())
 232                         return 0;
 233
 234                 /* Avoid iterating on to other aliases if no patterns match */
 235                 std::multimap<std::string, Alias>::iterator upperbound = Aliases.upper_bound(fcommand);
 236
 237
 238                 /* The parameters for the command in their original form, with the command stripped off */
 239                 std::string compare = text.substr(fcommand.length() + 1);
 240                 while (*(compare.c_str()) == ' ')
 241                         compare.erase(compare.begin());
 242
 243                 std::string safe(compare);
 244
 245                 /* Escape out any $ symbols in the user provided text (ugly, but better than crashy) */
 246                 SearchAndReplace(safe, "$", "\r");
 247
 248                 ServerInstance->Logs->Log("FANTASY", DEBUG, "fantasy: compare is %s and safe is %s", compare.c_str(), safe.c_str());
 249
 250                 while (i != upperbound)
 251                 {
 252                         if (i->second.ChannelCommand)
 253                         {
 254                                 if (DoAlias(user, c, &(i->second), compare, safe))
 255                                         return 0;
 256                         }
 257
 258                         i++;
 259                 }
 260
 261                 return 0;
 262         }
 263
 264
 265         int DoAlias(User *user, Channel *c, Alias *a, const std::string compare, const std::string safe)
 266         {
 267                 User *u = NULL;
 268
 269                 /* Does it match the pattern? */
 270                 if (!a->format.empty())
 271                 {
 272                         if (a->CaseSensitive)
 273                         {
 274                                 if (!InspIRCd::Match(compare, a->format, rfc_case_sensitive_map))
 275                                         return 0;
 276                         }
 277                         else
 278                         {
 279                                 if (!InspIRCd::Match(compare, a->format))
 280                                         return 0;
 281                         }
 282                 }
 283
 284                 if ((a->OperOnly) && (!IS_OPER(user)))
 285                         return 0;
 286
 287                 if (!a->RequiredNick.empty())
 288                 {
 289                         u = ServerInstance->FindNick(a->RequiredNick);
 290                         if (!u)
 291                         {
 292                                 user->WriteNumeric(401, ""+std::string(user->nick)+" "+a->RequiredNick+" :is currently unavailable. Please try again later.");
 293                                 return 1;
 294                         }
 295                 }
 296                 if ((u != NULL) && (!a->RequiredNick.empty()) && (a->ULineOnly))
 297                 {
 298                         if (!ServerInstance->ULine(u->server))
 299                         {
 300                                 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!");
 301                                 user->WriteNumeric(401, ""+std::string(user->nick)+" "+a->RequiredNick+" :is an imposter! Please inform an IRC operator as soon as possible.");
 302                                 return 1;
 303                         }
 304                 }
 305
 306                 /* Now, search and replace in a copy of the original_line, replacing $1 through $9 and $1- etc */
 307
 308                 std::string::size_type crlf = a->ReplaceFormat.find('\n');
 309
 310                 if (crlf == std::string::npos)
 311                 {
 312                         DoCommand(a->ReplaceFormat, user, c, safe);
 313                         return 1;
 314                 }
 315                 else
 316                 {
 317                         irc::sepstream commands(a->ReplaceFormat, '\n');
 318                         std::string scommand;
 319                         while (commands.GetToken(scommand))
 320                         {
 321                                 DoCommand(scommand, user, c, safe);
 322                         }
 323                         return 1;
 324                 }
 325         }
 326
 327         void DoCommand(std::string newline, User* user, Channel *c, const std::string &original_line)
 328         {
 329                 std::vector<std::string> pars;
 330
 331                 for (int v = 1; v < 10; v++)
 332                 {
 333                         std::string var = "$";
 334                         var.append(ConvToStr(v));
 335                         var.append("-");
 336                         std::string::size_type x = newline.find(var);
 337
 338                         while (x != std::string::npos)
 339                         {
 340                                 newline.erase(x, var.length());
 341                                 newline.insert(x, GetVar(var, original_line));
 342                                 x = newline.find(var);
 343                         }
 344
 345                         var = "$";
 346                         var.append(ConvToStr(v));
 347                         x = newline.find(var);
 348
 349                         while (x != std::string::npos)
 350                         {
 351                                 newline.erase(x, var.length());
 352                                 newline.insert(x, GetVar(var, original_line));
 353                                 x = newline.find(var);
 354                         }
 355                 }
 356
 357                 /* Special variables */
 358                 SearchAndReplace(newline, "$nick", user->nick);
 359                 SearchAndReplace(newline, "$ident", user->ident);
 360                 SearchAndReplace(newline, "$host", user->host);
 361                 SearchAndReplace(newline, "$vhost", user->dhost);
 362
 363                 if (c)
 364                 {
 365                         /* Channel specific variables */
 366                         SearchAndReplace(newline, "$chan", c->name);
 367                 }
 368
 369                 /* Unescape any variable names in the user text before sending */
 370                 SearchAndReplace(newline, "\r", "$");
 371
 372                 irc::tokenstream ss(newline);
 373                 pars.clear();
 374                 std::string command, token;
 375
 376                 ss.GetToken(command);
 377                 while (ss.GetToken(token) && (pars.size() <= MAXPARAMETERS))
 378                 {
 379                         pars.push_back(token);
 380                 }
 381                 ServerInstance->Parser->CallHandler(command, pars, user);
 382         }
 383
 384         virtual void OnRehash(User* user, const std::string &parameter)
 385         {
 386                 ReadAliases();
 387         }
 388 };
 389
 390 MODULE_INIT(ModuleAlias)