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 /* LoopCall is used to call a command classes handler repeatedly based on the contents of a comma seperated list.
  48  * There are two overriden versions of this method, one of which takes two potential lists and the other takes one.
  49  * We need a version which takes two potential lists for JOIN, because a JOIN may contain two lists of items at once,
  50  * the channel names and their keys as follows:
  51  * JOIN #chan1,#chan2,#chan3 key1,,key3
  52  * Therefore, we need to deal with both lists concurrently. The first instance of this method does that by creating
  53  * two instances of irc::commasepstream and reading them both together until the first runs out of tokens.
  54  * The second version is much simpler and just has the one stream to read, and is used in NAMES, WHOIS, PRIVMSG etc.
  55  * Both will only parse until they reach ServerInstance->Config->MaxTargets number of targets, to stop abuse via spam.
  56  */
  57 int CommandParser::LoopCall(User* user, Command* CommandObj, const std::vector<std::string>& parameters, unsigned int splithere, int extra, bool usemax)
  58 {
  59         if (splithere >= parameters.size())
  60                 return 0;
  61
  62         if (extra >= (signed)parameters.size())
  63                 extra = -1;
  64
  65         /* First check if we have more than one item in the list, if we don't we return zero here and the handler
  66          * which called us just carries on as it was.
  67          */
  68         if (parameters[splithere].find(',') == std::string::npos)
  69                 return 0;
  70
  71         /** Some lame ircds will weed out dupes using some shitty O(n^2) algorithm.
  72          * By using std::set (thanks for the idea w00t) we can cut this down a ton.
  73          * ...VOOODOOOO!
  74          */
  75         std::set<irc::string> dupes;
  76
  77         /* Create two lists, one for channel names, one for keys
  78          */
  79         irc::commasepstream items1(parameters[splithere]);
  80         irc::commasepstream items2(extra >= 0 ? parameters[extra] : "");
  81         std::string extrastuff;
  82         std::string item;
  83         unsigned int max = 0;
  84
  85         /* Attempt to iterate these lists and call the command objech
  86          * which called us, for every parameter pair until there are
  87          * no more left to parse.
  88          */
  89         while (items1.GetToken(item) && (!usemax || max++ < ServerInstance->Config->MaxTargets))
  90         {
  91                 if (dupes.find(item.c_str()) == dupes.end())
  92                 {
  93                         std::vector<std::string> new_parameters(parameters);
  94
  95                         if (!items2.GetToken(extrastuff))
  96                                 extrastuff.clear();
  97
  98                         new_parameters[splithere] = item;
  99                         if (extra >= 0)
 100                                 new_parameters[extra] = extrastuff;
 101
 102                         CommandObj->Handle(new_parameters, user);
 103
 104                         dupes.insert(item.c_str());
 105                 }
 106         }
 107         return 1;
 108 }
 109
 110 bool CommandParser::IsValidCommand(const std::string &commandname, unsigned int pcnt, User * user)
 111 {
 112         Commandtable::iterator n = cmdlist.find(commandname);
 113
 114         if (n != cmdlist.end())
 115         {
 116                 if ((pcnt >= n->second->min_params))
 117                 {
 118                         if (IS_LOCAL(user) && n->second->flags_needed)
 119                         {
 120                                 if (user->IsModeSet(n->second->flags_needed))
 121                                 {
 122                                         return (user->HasPermission(commandname));
 123                                 }
 124                         }
 125                         else
 126                         {
 127                                 return true;
 128                         }
 129                 }
 130         }
 131         return false;
 132 }
 133
 134 Command* CommandParser::GetHandler(const std::string &commandname)
 135 {
 136         Commandtable::iterator n = cmdlist.find(commandname);
 137         if (n != cmdlist.end())
 138                 return n->second;
 139
 140         return NULL;
 141 }
 142
 143 // calls a handler function for a command
 144
 145 CmdResult CommandParser::CallHandler(const std::string &commandname, const std::vector<std::string>& parameters, User *user)
 146 {
 147         Commandtable::iterator n = cmdlist.find(commandname);
 148
 149         if (n != cmdlist.end())
 150         {
 151                 if ((!parameters.empty()) && (parameters.back().empty()) && (!n->second->allow_empty_last_param))
 152                         return CMD_INVALID;
 153
 154                 if (parameters.size() >= n->second->min_params)
 155                 {
 156                         bool bOkay = false;
 157
 158                         if (IS_LOCAL(user) && n->second->flags_needed)
 159                         {
 160                                 /* if user is local, and flags are needed .. */
 161
 162                                 if (user->IsModeSet(n->second->flags_needed))
 163                                 {
 164                                         /* if user has the flags, and now has the permissions, go ahead */
 165                                         if (user->HasPermission(commandname))
 166                                                 bOkay = true;
 167                                 }
 168                         }
 169                         else
 170                         {
 171                                 /* remote or no flags required anyway */
 172                                 bOkay = true;
 173                         }
 174
 175                         if (bOkay)
 176                         {
 177                                 return n->second->Handle(parameters,user);
 178                         }
 179                 }
 180         }
 181         return CMD_INVALID;
 182 }
 183
 184 bool CommandParser::ProcessCommand(LocalUser *user, std::string &cmd)
 185 {
 186         std::vector<std::string> command_p;
 187         irc::tokenstream tokens(cmd);
 188         std::string command, token;
 189         tokens.GetToken(command);
 190
 191         /* A client sent a nick prefix on their command (ick)
 192          * rhapsody and some braindead bouncers do this --
 193          * the rfc says they shouldnt but also says the ircd should
 194          * discard it if they do.
 195          */
 196         if (command[0] == ':')
 197                 tokens.GetToken(command);
 198
 199         while (tokens.GetToken(token) && (command_p.size() <= MAXPARAMETERS))
 200                 command_p.push_back(token);
 201
 202         std::transform(command.begin(), command.end(), command.begin(), ::toupper);
 203
 204         /* find the command, check it exists */
 205         Commandtable::iterator cm = cmdlist.find(command);
 206
 207         // Penalty to give if the command fails before the handler is executed
 208         unsigned int failpenalty = 0;
 209
 210         /* Modify the user's penalty regardless of whether or not the command exists */
 211         bool do_more = true;
 212         if (!user->HasPrivPermission("users/flood/no-throttle"))
 213         {
 214                 // If it *doesn't* exist, give it a slightly heftier penalty than normal to deter flooding us crap
 215                 unsigned int penalty = (cm != cmdlist.end() ? cm->second->Penalty * 1000 : 2000);
 216                 user->CommandFloodPenalty += penalty;
 217
 218                 // Increase their penalty later if we fail and the command has 0 penalty by default (i.e. in Command::Penalty) to
 219                 // throttle sending ERR_* from the command parser. If the command does have a non-zero penalty then this is not
 220                 // needed because we've increased their penalty above.
 221                 if (penalty == 0)
 222                         failpenalty = 1000;
 223         }
 224
 225
 226         if (cm == cmdlist.end())
 227         {
 228                 ModResult MOD_RESULT;
 229                 FIRST_MOD_RESULT(OnPreCommand, MOD_RESULT, (command, command_p, user, false, cmd));
 230                 if (MOD_RESULT == MOD_RES_DENY)
 231                         return true;
 232
 233                 /*
 234                  * This double lookup is in case a module (abbreviation) wishes to change a command.
 235                  * Sure, the double lookup is a bit painful, but bear in mind this only happens for unknowns anyway.
 236                  *
 237                  * Thanks dz for making me actually understand why this is necessary!
 238                  * -- w00t
 239                  */
 240                 cm = cmdlist.find(command);
 241                 if (cm == cmdlist.end())
 242                 {
 243                         if (user->registered == REG_ALL)
 244                                 user->WriteNumeric(ERR_UNKNOWNCOMMAND, "%s %s :Unknown command",user->nick.c_str(),command.c_str());
 245                         ServerInstance->stats->statsUnknown++;
 246                         return true;
 247                 }
 248         }
 249
 250         if (cm->second->max_params && command_p.size() > cm->second->max_params)
 251         {
 252                 /*
 253                  * command_p input (assuming max_params 1):
 254                  *      this
 255                  *      is
 256                  *      a
 257                  *      test
 258                  */
 259                 std::string lparam;
 260
 261                 /*
 262                  * The '-1' here is a clever trick, we'll go backwards throwing everything into a temporary param
 263                  * and then just toss that into the array.
 264                  * -- w00t
 265                  */
 266                 while (command_p.size() > (cm->second->max_params - 1))
 267                 {
 268                         // BE CAREFUL: .end() returns past the end of the vector, hence decrement.
 269                         std::vector<std::string>::iterator it = command_p.end() - 1;
 270
 271                         lparam.insert(0, " " + *(it));
 272                         command_p.erase(it); // remove last element
 273                 }
 274
 275                 /* we now have (each iteration):
 276                  *      ' test'
 277                  *      ' a test'
 278                  *      ' is a test' <-- final string
 279                  * ...now remove the ' ' at the start...
 280                  */
 281                 lparam.erase(lparam.begin());
 282
 283                 /* param is now 'is a test', which is exactly what we wanted! */
 284                 command_p.push_back(lparam);
 285         }
 286
 287         /*
 288          * We call OnPreCommand here seperately if the command exists, so the magic above can
 289          * truncate to max_params if necessary. -- w00t
 290          */
 291         ModResult MOD_RESULT;
 292         FIRST_MOD_RESULT(OnPreCommand, MOD_RESULT, (command, command_p, user, false, cmd));
 293         if (MOD_RESULT == MOD_RES_DENY)
 294                 return true;
 295
 296         /* activity resets the ping pending timer */
 297         user->nping = ServerInstance->Time() + user->MyClass->GetPingTime();
 298
 299         if (cm->second->flags_needed)
 300         {
 301                 if (!user->IsModeSet(cm->second->flags_needed))
 302                 {
 303                         user->CommandFloodPenalty += failpenalty;
 304                         user->WriteNumeric(ERR_NOPRIVILEGES, "%s :Permission Denied - You do not have the required operator privileges",user->nick.c_str());
 305                         return do_more;
 306                 }
 307                 if (!user->HasPermission(command))
 308                 {
 309                         user->CommandFloodPenalty += failpenalty;
 310                         user->WriteNumeric(ERR_NOPRIVILEGES, "%s :Permission Denied - Oper type %s does not have access to command %s",
 311                                 user->nick.c_str(), user->oper->NameStr(), command.c_str());
 312                         return do_more;
 313                 }
 314         }
 315         if ((user->registered == REG_ALL) && (!IS_OPER(user)) && (cm->second->IsDisabled()))
 316         {
 317                 /* command is disabled! */
 318                 user->CommandFloodPenalty += failpenalty;
 319                 if (ServerInstance->Config->DisabledDontExist)
 320                 {
 321                         user->WriteNumeric(ERR_UNKNOWNCOMMAND, "%s %s :Unknown command",user->nick.c_str(),command.c_str());
 322                 }
 323                 else
 324                 {
 325                         user->WriteNumeric(ERR_UNKNOWNCOMMAND, "%s %s :This command has been disabled.",
 326                                                                                 user->nick.c_str(), command.c_str());
 327                 }
 328
 329                 ServerInstance->SNO->WriteToSnoMask('a', "%s denied for %s (%s@%s)",
 330                                 command.c_str(), user->nick.c_str(), user->ident.c_str(), user->host.c_str());
 331                 return do_more;
 332         }
 333
 334         if ((!command_p.empty()) && (command_p.back().empty()) && (!cm->second->allow_empty_last_param))
 335                 command_p.pop_back();
 336
 337         if (command_p.size() < cm->second->min_params)
 338         {
 339                 user->CommandFloodPenalty += failpenalty;
 340                 user->WriteNumeric(ERR_NEEDMOREPARAMS, "%s %s :Not enough parameters.", user->nick.c_str(), command.c_str());
 341                 if ((ServerInstance->Config->SyntaxHints) && (user->registered == REG_ALL) && (cm->second->syntax.length()))
 342                         user->WriteNumeric(RPL_SYNTAX, "%s :SYNTAX %s %s", user->nick.c_str(), cm->second->name.c_str(), cm->second->syntax.c_str());
 343                 return do_more;
 344         }
 345         if ((user->registered != REG_ALL) && (!cm->second->WorksBeforeReg()))
 346         {
 347                 user->CommandFloodPenalty += failpenalty;
 348                 user->WriteNumeric(ERR_NOTREGISTERED, "%s %s :You have not registered", user->nick.c_str(), command.c_str());
 349                 return do_more;
 350         }
 351         else
 352         {
 353                 /* passed all checks.. first, do the (ugly) stats counters. */
 354                 cm->second->use_count++;
 355                 cm->second->total_bytes += cmd.length();
 356
 357                 /* module calls too */
 358                 FIRST_MOD_RESULT(OnPreCommand, MOD_RESULT, (command, command_p, user, true, cmd));
 359                 if (MOD_RESULT == MOD_RES_DENY)
 360                         return do_more;
 361
 362                 /*
 363                  * WARNING: be careful, the user may be deleted soon
 364                  */
 365                 CmdResult result = cm->second->Handle(command_p, user);
 366
 367                 FOREACH_MOD(I_OnPostCommand,OnPostCommand(command, command_p, user, result,cmd));
 368                 return do_more;
 369         }
 370 }
 371
 372 void CommandParser::RemoveCommand(Command* x)
 373 {
 374         Commandtable::iterator n = cmdlist.find(x->name);
 375         if (n != cmdlist.end() && n->second == x)
 376                 cmdlist.erase(n);
 377 }
 378
 379 Command::~Command()
 380 {
 381         ServerInstance->Parser->RemoveCommand(this);
 382 }
 383
 384 bool CommandParser::ProcessBuffer(std::string &buffer,LocalUser *user)
 385 {
 386         if (!user || buffer.empty())
 387                 return true;
 388
 389         ServerInstance->Logs->Log("USERINPUT", RAWIO, "C[%s] I :%s %s",
 390                 user->uuid.c_str(), user->nick.c_str(), buffer.c_str());
 391         return ProcessCommand(user,buffer);
 392 }
 393
 394 bool CommandParser::AddCommand(Command *f)
 395 {
 396         /* create the command and push it onto the table */
 397         if (cmdlist.find(f->name) == cmdlist.end())
 398         {
 399                 cmdlist[f->name] = f;
 400                 return true;
 401         }
 402         return false;
 403 }
 404
 405 CommandParser::CommandParser()
 406 {
 407 }
 408
 409 int CommandParser::TranslateUIDs(const std::vector<TranslateType> to, const std::vector<std::string> &source, std::string &dest, bool prefix_final, Command* custom_translator)
 410 {
 411         std::vector<TranslateType>::const_iterator types = to.begin();
 412         User* user = NULL;
 413         unsigned int i;
 414         int translations = 0;
 415         dest.clear();
 416
 417         for(i=0; i < source.size(); i++)
 418         {
 419                 TranslateType t;
 420                 std::string item = source[i];
 421
 422                 if (types == to.end())
 423                         t = TR_TEXT;
 424                 else
 425                 {
 426                         t = *types;
 427                         types++;
 428                 }
 429
 430                 if (prefix_final && i == source.size() - 1)
 431                         dest.append(":");
 432
 433                 switch (t)
 434                 {
 435                         case TR_NICK:
 436                                 /* Translate single nickname */
 437                                 user = ServerInstance->FindNick(item);
 438                                 if (user)
 439                                 {
 440                                         dest.append(user->uuid);
 441                                         translations++;
 442                                 }
 443                                 else
 444                                         dest.append(item);
 445                         break;
 446                         case TR_CUSTOM:
 447                                 if (custom_translator)
 448                                         custom_translator->EncodeParameter(item, i);
 449                                 dest.append(item);
 450                         break;
 451                         case TR_END:
 452                         case TR_TEXT:
 453                         default:
 454                                 /* Do nothing */
 455                                 dest.append(item);
 456                         break;
 457                 }
 458                 if (i != source.size() - 1)
 459                         dest.append(" ");
 460         }
 461
 462         return translations;
 463 }
 464
 465 int CommandParser::TranslateUIDs(TranslateType to, const std::string &source, std::string &dest)
 466 {
 467         User* user = NULL;
 468         int translations = 0;
 469         dest.clear();
 470
 471         switch (to)
 472         {
 473                 case TR_NICK:
 474                         /* Translate single nickname */
 475                         user = ServerInstance->FindNick(source);
 476                         if (user)
 477                         {
 478                                 dest = user->uuid;
 479                                 translations++;
 480                         }
 481                         else
 482                                 dest = source;
 483                 break;
 484                 case TR_END:
 485                 case TR_TEXT:
 486                 default:
 487                         /* Do nothing */
 488                         dest = source;
 489                 break;
 490         }
 491
 492         return translations;
 493 }