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