src/command_parse.cpp

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
   5  *   Copyright (C) 2006-2008 Robin Burchell <robin+git@viroteck.net>
   6  *   Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
   7  *   Copyright (C) 2005-2008 Craig Edwards <craigedwards@brainbox.cc>
   8  *   Copyright (C) 2006-2007 Dennis Friis <peavey@inspircd.org>
   9  *
  10  * This file is part of InspIRCd.  InspIRCd is free software: you can
  11  * redistribute it and/or modify it under the terms of the GNU General Public
  12  * License as published by the Free Software Foundation, version 2.
  13  *
  14  * This program is distributed in the hope that it will be useful, but WITHOUT
  15  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  16  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  17  * details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21  */
  22
  23
  24 #include "inspircd.h"
  25
  26 int InspIRCd::PassCompare(Extensible* ex, const std::string &data, const std::string &input, const std::string &hashtype)
  27 {
  28         ModResult res;
  29         FIRST_MOD_RESULT(OnPassCompare, res, (ex, data, input, hashtype));
  30
  31         /* Module matched */
  32         if (res == MOD_RES_ALLOW)
  33                 return 0;
  34
  35         /* Module explicitly didnt match */
  36         if (res == MOD_RES_DENY)
  37                 return 1;
  38
  39         /* We dont handle any hash types except for plaintext - Thanks tra26 */
  40         if (!hashtype.empty() && hashtype != "plaintext")
  41                 /* See below. 1 because they dont match */
  42                 return 1;
  43
  44         return (data != input); // this seems back to front, but returns 0 if they *match*, 1 else
  45 }
  46
  47 bool CommandParser::LoopCall(User* user, Command* handler, const std::vector<std::string>& parameters, unsigned int splithere, int extra, bool usemax)
  48 {
  49         if (splithere >= parameters.size())
  50                 return false;
  51
  52         /* First check if we have more than one item in the list, if we don't we return false here and the handler
  53          * which called us just carries on as it was.
  54          */
  55         if (parameters[splithere].find(',') == std::string::npos)
  56                 return false;
  57
  58         /** Some lame ircds will weed out dupes using some shitty O(n^2) algorithm.
  59          * By using std::set (thanks for the idea w00t) we can cut this down a ton.
  60          * ...VOOODOOOO!
  61          *
  62          * Only check for duplicates if there is one list (allow them in JOIN).
  63          */
  64         std::set<irc::string> dupes;
  65         bool check_dupes = (extra < 0);
  66
  67         /* Create two sepstreams, if we have only one list, then initialize the second sepstream with
  68          * an empty string. The second parameter of the constructor of the sepstream tells whether
  69          * or not to allow empty tokens.
  70          * We allow empty keys, so "JOIN #a,#b ,bkey" will be interpreted as "JOIN #a", "JOIN #b bkey"
  71          */
  72         irc::commasepstream items1(parameters[splithere]);
  73         irc::commasepstream items2(extra >= 0 ? parameters[extra] : "", true);
  74         std::string item;
  75         unsigned int max = 0;
  76         LocalUser* localuser = IS_LOCAL(user);
  77
  78         /* Attempt to iterate these lists and call the command handler
  79          * for every parameter or parameter pair until there are no more
  80          * left to parse.
  81          */
  82         while (items1.GetToken(item) && (!usemax || max++ < ServerInstance->Config->MaxTargets))
  83         {
  84                 if ((!check_dupes) || (dupes.insert(item.c_str()).second))
  85                 {
  86                         std::vector<std::string> new_parameters(parameters);
  87                         new_parameters[splithere] = item;
  88
  89                         if (extra >= 0)
  90                         {
  91                                 // If we have two lists then get the next item from the second list.
  92                                 // In case it runs out of elements then 'item' will be an empty string.
  93                                 items2.GetToken(item);
  94                                 new_parameters[extra] = item;
  95                         }
  96
  97                         CmdResult result = handler->Handle(new_parameters, user);
  98                         if (localuser)
  99                         {
 100                                 // Run the OnPostCommand hook with the last parameter (original line) being empty
 101                                 // to indicate that the command had more targets in its original form.
 102                                 item.clear();
 103                                 FOREACH_MOD(OnPostCommand, (handler, new_parameters, localuser, result, item));
 104                         }
 105                 }
 106         }
 107
 108         return true;
 109 }
 110
 111 Command* CommandParser::GetHandler(const std::string &commandname)
 112 {
 113         Commandtable::iterator n = cmdlist.find(commandname);
 114         if (n != cmdlist.end())
 115                 return n->second;
 116
 117         return NULL;
 118 }
 119
 120 // calls a handler function for a command
 121
 122 CmdResult CommandParser::CallHandler(const std::string &commandname, const std::vector<std::string>& parameters, User *user)
 123 {
 124         Commandtable::iterator n = cmdlist.find(commandname);
 125
 126         if (n != cmdlist.end())
 127         {
 128                 if ((!parameters.empty()) && (parameters.back().empty()) && (!n->second->allow_empty_last_param))
 129                         return CMD_INVALID;
 130
 131                 if (parameters.size() >= n->second->min_params)
 132                 {
 133                         bool bOkay = false;
 134
 135                         if (IS_LOCAL(user) && n->second->flags_needed)
 136                         {
 137                                 /* if user is local, and flags are needed .. */
 138
 139                                 if (user->IsModeSet(n->second->flags_needed))
 140                                 {
 141                                         /* if user has the flags, and now has the permissions, go ahead */
 142                                         if (user->HasPermission(commandname))
 143                                                 bOkay = true;
 144                                 }
 145                         }
 146                         else
 147                         {
 148                                 /* remote or no flags required anyway */
 149                                 bOkay = true;
 150                         }
 151
 152                         if (bOkay)
 153                         {
 154                                 return n->second->Handle(parameters,user);
 155                         }
 156                 }
 157         }
 158         return CMD_INVALID;
 159 }
 160
 161 void CommandParser::ProcessCommand(LocalUser *user, std::string &cmd)
 162 {
 163         std::vector<std::string> command_p;
 164         irc::tokenstream tokens(cmd);
 165         std::string command, token;
 166         tokens.GetToken(command);
 167
 168         /* A client sent a nick prefix on their command (ick)
 169          * rhapsody and some braindead bouncers do this --
 170          * the rfc says they shouldnt but also says the ircd should
 171          * discard it if they do.
 172          */
 173         if (command[0] == ':')
 174                 tokens.GetToken(command);
 175
 176         while (tokens.GetToken(token))
 177                 command_p.push_back(token);
 178
 179         std::transform(command.begin(), command.end(), command.begin(), ::toupper);
 180
 181         /* find the command, check it exists */
 182         Command* handler = GetHandler(command);
 183
 184         /* Modify the user's penalty regardless of whether or not the command exists */
 185         if (!user->HasPrivPermission("users/flood/no-throttle"))
 186         {
 187                 // If it *doesn't* exist, give it a slightly heftier penalty than normal to deter flooding us crap
 188                 user->CommandFloodPenalty += handler ? handler->Penalty * 1000 : 2000;
 189         }
 190
 191         if (!handler)
 192         {
 193                 ModResult MOD_RESULT;
 194                 FIRST_MOD_RESULT(OnPreCommand, MOD_RESULT, (command, command_p, user, false, cmd));
 195                 if (MOD_RESULT == MOD_RES_DENY)
 196                         return;
 197
 198                 /*
 199                  * This double lookup is in case a module (abbreviation) wishes to change a command.
 200                  * Sure, the double lookup is a bit painful, but bear in mind this only happens for unknowns anyway.
 201                  *
 202                  * Thanks dz for making me actually understand why this is necessary!
 203                  * -- w00t
 204                  */
 205                 handler = GetHandler(command);
 206                 if (!handler)
 207                 {
 208                         if (user->registered == REG_ALL)
 209                                 user->WriteNumeric(ERR_UNKNOWNCOMMAND, "%s :Unknown command",command.c_str());
 210                         ServerInstance->stats->statsUnknown++;
 211                         return;
 212                 }
 213         }
 214
 215         // If we were given more parameters than max_params then append the excess parameter(s)
 216         // to command_p[maxparams-1], i.e. to the last param that is still allowed
 217         if (handler->max_params && command_p.size() > handler->max_params)
 218         {
 219                 /*
 220                  * command_p input (assuming max_params 1):
 221                  *      this
 222                  *      is
 223                  *      a
 224                  *      test
 225                  */
 226
 227                 // Iterator to the last parameter that will be kept
 228                 const std::vector<std::string>::iterator lastkeep = command_p.begin() + (handler->max_params - 1);
 229                 // Iterator to the first excess parameter
 230                 const std::vector<std::string>::iterator firstexcess = lastkeep + 1;
 231
 232                 // Append all excess parameter(s) to the last parameter, seperated by spaces
 233                 for (std::vector<std::string>::const_iterator i = firstexcess; i != command_p.end(); ++i)
 234                 {
 235                         lastkeep->push_back(' ');
 236                         lastkeep->append(*i);
 237                 }
 238
 239                 // Erase the excess parameter(s)
 240                 command_p.erase(firstexcess, command_p.end());
 241         }
 242
 243         /*
 244          * We call OnPreCommand here seperately if the command exists, so the magic above can
 245          * truncate to max_params if necessary. -- w00t
 246          */
 247         ModResult MOD_RESULT;
 248         FIRST_MOD_RESULT(OnPreCommand, MOD_RESULT, (command, command_p, user, false, cmd));
 249         if (MOD_RESULT == MOD_RES_DENY)
 250                 return;
 251
 252         /* activity resets the ping pending timer */
 253         user->nping = ServerInstance->Time() + user->MyClass->GetPingTime();
 254
 255         if (handler->flags_needed)
 256         {
 257                 if (!user->IsModeSet(handler->flags_needed))
 258                 {
 259                         user->WriteNumeric(ERR_NOPRIVILEGES, ":Permission Denied - You do not have the required operator privileges");
 260                         return;
 261                 }
 262
 263                 if (!user->HasPermission(command))
 264                 {
 265                         user->WriteNumeric(ERR_NOPRIVILEGES, ":Permission Denied - Oper type %s does not have access to command %s",
 266                                 user->oper->name.c_str(), command.c_str());
 267                         return;
 268                 }
 269         }
 270
 271         if ((user->registered == REG_ALL) && (!user->IsOper()) && (handler->IsDisabled()))
 272         {
 273                 /* command is disabled! */
 274                 if (ServerInstance->Config->DisabledDontExist)
 275                 {
 276                         user->WriteNumeric(ERR_UNKNOWNCOMMAND, "%s :Unknown command", command.c_str());
 277                 }
 278                 else
 279                 {
 280                         user->WriteNumeric(ERR_UNKNOWNCOMMAND, "%s :This command has been disabled.", command.c_str());
 281                 }
 282
 283                 ServerInstance->SNO->WriteToSnoMask('t', "%s denied for %s (%s@%s)",
 284                                 command.c_str(), user->nick.c_str(), user->ident.c_str(), user->host.c_str());
 285                 return;
 286         }
 287
 288         if ((!command_p.empty()) && (command_p.back().empty()) && (!handler->allow_empty_last_param))
 289                 command_p.pop_back();
 290
 291         if (command_p.size() < handler->min_params)
 292         {
 293                 user->WriteNumeric(ERR_NEEDMOREPARAMS, "%s :Not enough parameters.", command.c_str());
 294                 if ((ServerInstance->Config->SyntaxHints) && (user->registered == REG_ALL) && (handler->syntax.length()))
 295                         user->WriteNumeric(RPL_SYNTAX, ":SYNTAX %s %s", handler->name.c_str(), handler->syntax.c_str());
 296                 return;
 297         }
 298
 299         if ((user->registered != REG_ALL) && (!handler->WorksBeforeReg()))
 300         {
 301                 user->WriteNumeric(ERR_NOTREGISTERED, "%s :You have not registered",command.c_str());
 302         }
 303         else
 304         {
 305                 /* passed all checks.. first, do the (ugly) stats counters. */
 306                 handler->use_count++;
 307
 308                 /* module calls too */
 309                 FIRST_MOD_RESULT(OnPreCommand, MOD_RESULT, (command, command_p, user, true, cmd));
 310                 if (MOD_RESULT == MOD_RES_DENY)
 311                         return;
 312
 313                 /*
 314                  * WARNING: be careful, the user may be deleted soon
 315                  */
 316                 CmdResult result = handler->Handle(command_p, user);
 317
 318                 FOREACH_MOD(OnPostCommand, (handler, command_p, user, result, cmd));
 319         }
 320 }
 321
 322 void CommandParser::RemoveCommand(Command* x)
 323 {
 324         Commandtable::iterator n = cmdlist.find(x->name);
 325         if (n != cmdlist.end() && n->second == x)
 326                 cmdlist.erase(n);
 327 }
 328
 329 CommandBase::~CommandBase()
 330 {
 331 }
 332
 333 Command::~Command()
 334 {
 335         ServerInstance->Parser->RemoveCommand(this);
 336 }
 337
 338 void CommandParser::ProcessBuffer(std::string &buffer,LocalUser *user)
 339 {
 340         if (!user || buffer.empty())
 341                 return;
 342
 343         ServerInstance->Logs->Log("USERINPUT", LOG_RAWIO, "C[%s] I :%s %s",
 344                 user->uuid.c_str(), user->nick.c_str(), buffer.c_str());
 345         ProcessCommand(user,buffer);
 346 }
 347
 348 bool CommandParser::AddCommand(Command *f)
 349 {
 350         /* create the command and push it onto the table */
 351         if (cmdlist.find(f->name) == cmdlist.end())
 352         {
 353                 cmdlist[f->name] = f;
 354                 return true;
 355         }
 356         return false;
 357 }
 358
 359 CommandParser::CommandParser()
 360 {
 361 }
 362
 363 std::string CommandParser::TranslateUIDs(const std::vector<TranslateType>& to, const std::vector<std::string>& source, bool prefix_final, CommandBase* custom_translator)
 364 {
 365         std::vector<TranslateType>::const_iterator types = to.begin();
 366         std::string dest;
 367
 368         for (unsigned int i = 0; i < source.size(); i++)
 369         {
 370                 TranslateType t = TR_TEXT;
 371                 // They might supply less translation types than parameters,
 372                 // in that case pretend that all remaining types are TR_TEXT
 373                 if (types != to.end())
 374                 {
 375                         t = *types;
 376                         types++;
 377                 }
 378
 379                 bool last = (i == (source.size() - 1));
 380                 if (prefix_final && last)
 381                         dest.push_back(':');
 382
 383                 TranslateSingleParam(t, source[i], dest, custom_translator, i);
 384
 385                 if (!last)
 386                         dest.push_back(' ');
 387         }
 388
 389         return dest;
 390 }
 391
 392 void CommandParser::TranslateSingleParam(TranslateType to, const std::string& item, std::string& dest, CommandBase* custom_translator, unsigned int paramnumber)
 393 {
 394         switch (to)
 395         {
 396                 case TR_NICK:
 397                 {
 398                         /* Translate single nickname */
 399                         User* user = ServerInstance->FindNick(item);
 400                         if (user)
 401                                 dest.append(user->uuid);
 402                         else
 403                                 dest.append(item);
 404                         break;
 405                 }
 406                 case TR_CUSTOM:
 407                 {
 408                         if (custom_translator)
 409                         {
 410                                 std::string translated = item;
 411                                 custom_translator->EncodeParameter(translated, paramnumber);
 412                                 dest.append(translated);
 413                                 break;
 414                         }
 415                         // If no custom translator was given, fall through
 416                 }
 417                 case TR_TEXT:
 418                 default:
 419                         /* Do nothing */
 420                         dest.append(item);
 421                 break;
 422         }
 423 }