src/command_parse.cpp

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd: (C) 2002-2009 InspIRCd Development Team
   6  * See: http://wiki.inspircd.org/Credits
   7  *
   8  * This program is free but copyrighted software; see
   9  *          the file COPYING for details.
  10  *
  11  * ---------------------------------------------------
  12  */
  13
  14 /* $Core */
  15
  16 #include "inspircd.h"
  17 #include "xline.h"
  18 #include "socketengine.h"
  19 #include "socket.h"
  20 #include "command_parse.h"
  21 #include "exitcodes.h"
  22
  23 /* Directory Searching for Unix-Only */
  24 #ifndef WIN32
  25 #include <dirent.h>
  26 #include <dlfcn.h>
  27 #endif
  28
  29 int InspIRCd::PassCompare(Extensible* ex, const std::string &data, const std::string &input, const std::string &hashtype)
  30 {
  31         ModResult res;
  32         FIRST_MOD_RESULT(this, OnPassCompare, res, (ex, data, input, hashtype));
  33
  34         /* Module matched */
  35         if (res == MOD_RES_ALLOW)
  36                 return 0;
  37
  38         /* Module explicitly didnt match */
  39         if (res == MOD_RES_DENY)
  40                 return 1;
  41
  42         /* We dont handle any hash types except for plaintext - Thanks tra26 */
  43         if (hashtype != "" && hashtype != "plaintext")
  44                 /* See below. 1 because they dont match */
  45                 return 1;
  46
  47         return (data != input); // this seems back to front, but returns 0 if they *match*, 1 else
  48 }
  49
  50 /* LoopCall is used to call a command classes handler repeatedly based on the contents of a comma seperated list.
  51  * There are two overriden versions of this method, one of which takes two potential lists and the other takes one.
  52  * We need a version which takes two potential lists for JOIN, because a JOIN may contain two lists of items at once,
  53  * the channel names and their keys as follows:
  54  * JOIN #chan1,#chan2,#chan3 key1,,key3
  55  * Therefore, we need to deal with both lists concurrently. The first instance of this method does that by creating
  56  * two instances of irc::commasepstream and reading them both together until the first runs out of tokens.
  57  * The second version is much simpler and just has the one stream to read, and is used in NAMES, WHOIS, PRIVMSG etc.
  58  * Both will only parse until they reach ServerInstance->Config->MaxTargets number of targets, to stop abuse via spam.
  59  */
  60 int CommandParser::LoopCall(User* user, Command* CommandObj, const std::vector<std::string>& parameters, unsigned int splithere, unsigned int extra)
  61 {
  62         if (splithere >= parameters.size())
  63                 return 0;
  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(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) && (max++ < ServerInstance->Config->MaxTargets))
  90         {
  91                 if (dupes.find(item.c_str()) == dupes.end())
  92                 {
  93                         std::vector<std::string> new_parameters;
  94
  95                         for (unsigned int t = 0; (t < parameters.size()) && (t < MAXPARAMETERS); t++)
  96                                 new_parameters.push_back(parameters[t]);
  97
  98                         if (!items2.GetToken(extrastuff))
  99                                 extrastuff = "";
 100
 101                         new_parameters[splithere] = item.c_str();
 102                         new_parameters[extra] = extrastuff.c_str();
 103
 104                         CommandObj->Handle(new_parameters, user);
 105
 106                         dupes.insert(item.c_str());
 107                 }
 108         }
 109         return 1;
 110 }
 111
 112 int CommandParser::LoopCall(User* user, Command* CommandObj, const std::vector<std::string>& parameters, unsigned int splithere)
 113 {
 114         if (splithere >= parameters.size())
 115                 return 0;
 116
 117         /* First check if we have more than one item in the list, if we don't we return zero here and the handler
 118          * which called us just carries on as it was.
 119          */
 120         if (parameters[splithere].find(',') == std::string::npos)
 121                 return 0;
 122
 123         std::set<irc::string> dupes;
 124
 125         /* Only one commasepstream here */
 126         irc::commasepstream items1(parameters[splithere]);
 127         std::string item;
 128         unsigned int max = 0;
 129
 130         /* Parse the commasepstream until there are no tokens remaining.
 131          * Each token we parse out, call the command handler that called us
 132          * with it
 133          */
 134         while (items1.GetToken(item) && (max++ < ServerInstance->Config->MaxTargets))
 135         {
 136                 if (dupes.find(item.c_str()) == dupes.end())
 137                 {
 138                         std::vector<std::string> new_parameters;
 139
 140                         for (unsigned int t = 0; (t < parameters.size()) && (t < MAXPARAMETERS); t++)
 141                                 new_parameters.push_back(parameters[t]);
 142
 143                         new_parameters[splithere] = item.c_str();
 144
 145                         /* Execute the command handler. */
 146                         CommandObj->Handle(new_parameters, user);
 147
 148                         dupes.insert(item.c_str());
 149                 }
 150         }
 151         /* By returning 1 we tell our caller that nothing is to be done,
 152          * as all the previous calls handled the data. This makes the parent
 153          * return without doing any processing.
 154          */
 155         return 1;
 156 }
 157
 158 bool CommandParser::IsValidCommand(const std::string &commandname, unsigned int pcnt, User * user)
 159 {
 160         Commandtable::iterator n = cmdlist.find(commandname);
 161
 162         if (n != cmdlist.end())
 163         {
 164                 if ((pcnt >= n->second->min_params))
 165                 {
 166                         if (IS_LOCAL(user) && n->second->flags_needed)
 167                         {
 168                                 if (user->IsModeSet(n->second->flags_needed))
 169                                 {
 170                                         return (user->HasPermission(commandname));
 171                                 }
 172                         }
 173                         else
 174                         {
 175                                 return true;
 176                         }
 177                 }
 178         }
 179         return false;
 180 }
 181
 182 Command* CommandParser::GetHandler(const std::string &commandname)
 183 {
 184         Commandtable::iterator n = cmdlist.find(commandname);
 185         if (n != cmdlist.end())
 186                 return n->second;
 187
 188         return NULL;
 189 }
 190
 191 // calls a handler function for a command
 192
 193 CmdResult CommandParser::CallHandler(const std::string &commandname, const std::vector<std::string>& parameters, User *user)
 194 {
 195         Commandtable::iterator n = cmdlist.find(commandname);
 196
 197         if (n != cmdlist.end())
 198         {
 199                 if (parameters.size() >= n->second->min_params)
 200                 {
 201                         bool bOkay = false;
 202
 203                         if (IS_LOCAL(user) && n->second->flags_needed)
 204                         {
 205                                 /* if user is local, and flags are needed .. */
 206
 207                                 if (user->IsModeSet(n->second->flags_needed))
 208                                 {
 209                                         /* if user has the flags, and now has the permissions, go ahead */
 210                                         if (user->HasPermission(commandname))
 211                                                 bOkay = true;
 212                                 }
 213                         }
 214                         else
 215                         {
 216                                 /* remote or no flags required anyway */
 217                                 bOkay = true;
 218                         }
 219
 220                         if (bOkay)
 221                         {
 222                                 return n->second->Handle(parameters,user);
 223                         }
 224                 }
 225         }
 226         return CMD_INVALID;
 227 }
 228
 229 void CommandParser::DoLines(User* current, bool one_only)
 230 {
 231         while (current->BufferIsReady())
 232         {
 233                 // use GetBuffer to copy single lines into the sanitized string
 234                 std::string single_line = current->GetBuffer();
 235                 current->bytes_in += single_line.length();
 236                 current->cmds_in++;
 237                 if (single_line.length() > MAXBUF - 2)  // MAXBUF is 514 to allow for neccessary line terminators
 238                         single_line.resize(MAXBUF - 2); // So to trim to 512 here, we use MAXBUF - 2
 239
 240                 // ProcessBuffer returns false if the user has gone over penalty
 241                 if (!ServerInstance->Parser->ProcessBuffer(single_line, current) || one_only)
 242                         break;
 243         }
 244 }
 245
 246 bool CommandParser::ProcessCommand(User *user, std::string &cmd)
 247 {
 248         std::vector<std::string> command_p;
 249         irc::tokenstream tokens(cmd);
 250         std::string command, token;
 251         tokens.GetToken(command);
 252
 253         /* A client sent a nick prefix on their command (ick)
 254          * rhapsody and some braindead bouncers do this --
 255          * the rfc says they shouldnt but also says the ircd should
 256          * discard it if they do.
 257          */
 258         if (command[0] == ':')
 259                 tokens.GetToken(command);
 260
 261         while (tokens.GetToken(token) && (command_p.size() <= MAXPARAMETERS))
 262                 command_p.push_back(token);
 263
 264         std::transform(command.begin(), command.end(), command.begin(), ::toupper);
 265
 266         /* find the command, check it exists */
 267         Commandtable::iterator cm = cmdlist.find(command);
 268
 269         /* Modify the user's penalty regardless of whether or not the command exists */
 270         bool do_more = true;
 271         if (!user->HasPrivPermission("users/flood/no-throttle"))
 272         {
 273                 // If it *doesn't* exist, give it a slightly heftier penalty than normal to deter flooding us crap
 274                 user->IncreasePenalty(cm != cmdlist.end() ? cm->second->Penalty : 2);
 275                 do_more = (user->Penalty < 10);
 276         }
 277
 278
 279         if (cm == cmdlist.end())
 280         {
 281                 ModResult MOD_RESULT;
 282                 FIRST_MOD_RESULT(ServerInstance, OnPreCommand, MOD_RESULT, (command, command_p, user, false, cmd));
 283                 if (MOD_RESULT == MOD_RES_DENY)
 284                         return true;
 285
 286                 /*
 287                  * This double lookup is in case a module (abbreviation) wishes to change a command.
 288                  * Sure, the double lookup is a bit painful, but bear in mind this only happens for unknowns anyway.
 289                  *
 290                  * Thanks dz for making me actually understand why this is necessary!
 291                  * -- w00t
 292                  */
 293                 cm = cmdlist.find(command);
 294                 if (cm == cmdlist.end())
 295                 {
 296                         if (user->registered == REG_ALL)
 297                                 user->WriteNumeric(ERR_UNKNOWNCOMMAND, "%s %s :Unknown command",user->nick.c_str(),command.c_str());
 298                         ServerInstance->stats->statsUnknown++;
 299                         return true;
 300                 }
 301         }
 302
 303         if (cm->second->max_params && command_p.size() > cm->second->max_params)
 304         {
 305                 /*
 306                  * command_p input (assuming max_params 1):
 307                  *      this
 308                  *      is
 309                  *      a
 310                  *      test
 311                  */
 312                 std::string lparam = "";
 313
 314                 /*
 315                  * The '-1' here is a clever trick, we'll go backwards throwing everything into a temporary param
 316                  * and then just toss that into the array.
 317                  * -- w00t
 318                  */
 319                 while (command_p.size() > (cm->second->max_params - 1))
 320                 {
 321                         // BE CAREFUL: .end() returns past the end of the vector, hence decrement.
 322                         std::vector<std::string>::iterator it = --command_p.end();
 323
 324                         lparam.insert(0, " " + *(it));
 325                         command_p.erase(it); // remove last element
 326                 }
 327
 328                 /* we now have (each iteration):
 329                  *      ' test'
 330                  *      ' a test'
 331                  *      ' is a test' <-- final string
 332                  * ...now remove the ' ' at the start...
 333                  */
 334                 lparam.erase(lparam.begin());
 335
 336                 /* param is now 'is a test', which is exactly what we wanted! */
 337                 command_p.push_back(lparam);
 338         }
 339
 340         /*
 341          * We call OnPreCommand here seperately if the command exists, so the magic above can
 342          * truncate to max_params if necessary. -- w00t
 343          */
 344         ModResult MOD_RESULT;
 345         FIRST_MOD_RESULT(ServerInstance, OnPreCommand, MOD_RESULT, (command, command_p, user, false, cmd));
 346         if (MOD_RESULT == MOD_RES_DENY)
 347                 return true;
 348
 349         /* activity resets the ping pending timer */
 350         if (user->MyClass)
 351                 user->nping = ServerInstance->Time() + user->MyClass->GetPingTime();
 352
 353         if (cm->second->flags_needed)
 354         {
 355                 if (!user->IsModeSet(cm->second->flags_needed))
 356                 {
 357                         user->WriteNumeric(ERR_NOPRIVILEGES, "%s :Permission Denied - You do not have the required operator privileges",user->nick.c_str());
 358                         return do_more;
 359                 }
 360                 if (!user->HasPermission(command))
 361                 {
 362                         user->WriteNumeric(ERR_NOPRIVILEGES, "%s :Permission Denied - Oper type %s does not have access to command %s",user->nick.c_str(),user->oper.c_str(),command.c_str());
 363                         return do_more;
 364                 }
 365         }
 366         if ((user->registered == REG_ALL) && (!IS_OPER(user)) && (cm->second->IsDisabled()))
 367         {
 368                 /* command is disabled! */
 369                 if (ServerInstance->Config->DisabledDontExist)
 370                 {
 371                         user->WriteNumeric(ERR_UNKNOWNCOMMAND, "%s %s :Unknown command",user->nick.c_str(),command.c_str());
 372                 }
 373                 else
 374                 {
 375                         user->WriteNumeric(ERR_UNKNOWNCOMMAND, "%s %s :This command has been disabled.",
 376                                                                                 user->nick.c_str(), command.c_str());
 377                 }
 378
 379                 ServerInstance->SNO->WriteToSnoMask('t', "%s denied for %s (%s@%s)",
 380                                 command.c_str(), user->nick.c_str(), user->ident.c_str(), user->host.c_str());
 381                 return do_more;
 382         }
 383         if (command_p.size() < cm->second->min_params)
 384         {
 385                 user->WriteNumeric(ERR_NEEDMOREPARAMS, "%s %s :Not enough parameters.", user->nick.c_str(), command.c_str());
 386                 if ((ServerInstance->Config->SyntaxHints) && (user->registered == REG_ALL) && (cm->second->syntax.length()))
 387                         user->WriteNumeric(RPL_SYNTAX, "%s :SYNTAX %s %s", user->nick.c_str(), cm->second->command.c_str(), cm->second->syntax.c_str());
 388                 return do_more;
 389         }
 390         if ((user->registered != REG_ALL) && (!cm->second->WorksBeforeReg()))
 391         {
 392                 user->WriteNumeric(ERR_NOTREGISTERED, "%s :You have not registered",command.c_str());
 393                 return do_more;
 394         }
 395         else
 396         {
 397                 /* passed all checks.. first, do the (ugly) stats counters. */
 398                 cm->second->use_count++;
 399                 cm->second->total_bytes += cmd.length();
 400
 401                 /* module calls too */
 402                 FIRST_MOD_RESULT(ServerInstance, OnPreCommand, MOD_RESULT, (command, command_p, user, true, cmd));
 403                 if (MOD_RESULT == MOD_RES_DENY)
 404                         return do_more;
 405
 406                 /*
 407                  * WARNING: be careful, the user may be deleted soon
 408                  */
 409                 CmdResult result = cm->second->Handle(command_p, user);
 410
 411                 FOREACH_MOD(I_OnPostCommand,OnPostCommand(command, command_p, user, result,cmd));
 412                 return do_more;
 413         }
 414 }
 415
 416 void CommandParser::RemoveCommands(Module* source)
 417 {
 418         Commandtable::iterator i,safei;
 419         for (i = cmdlist.begin(); i != cmdlist.end();)
 420         {
 421                 safei = i;
 422                 i++;
 423                 RemoveCommand(safei, source);
 424         }
 425 }
 426
 427 void CommandParser::RemoveCommand(Commandtable::iterator safei, Module* source)
 428 {
 429         Command* x = safei->second;
 430         if (x->creator == source)
 431         {
 432                 cmdlist.erase(safei);
 433         }
 434 }
 435
 436 bool CommandParser::ProcessBuffer(std::string &buffer,User *user)
 437 {
 438         std::string::size_type a;
 439
 440         if (!user)
 441                 return true;
 442
 443         while ((a = buffer.rfind("\n")) != std::string::npos)
 444                 buffer.erase(a);
 445         while ((a = buffer.rfind("\r")) != std::string::npos)
 446                 buffer.erase(a);
 447
 448         if (buffer.length())
 449         {
 450                 ServerInstance->Logs->Log("USERINPUT", DEBUG,"C[%d] I :%s %s",user->GetFd(), user->nick.c_str(), buffer.c_str());
 451                 return this->ProcessCommand(user,buffer);
 452         }
 453
 454         return true;
 455 }
 456
 457 bool CommandParser::CreateCommand(Command *f)
 458 {
 459         /* create the command and push it onto the table */
 460         if (cmdlist.find(f->command) == cmdlist.end())
 461         {
 462                 cmdlist[f->command] = f;
 463                 return true;
 464         }
 465         return false;
 466 }
 467
 468 CommandParser::CommandParser(InspIRCd* Instance) : ServerInstance(Instance)
 469 {
 470         para.resize(128);
 471 }
 472
 473 int CommandParser::TranslateUIDs(const std::vector<TranslateType> to, const std::vector<std::string> &source, std::string &dest, bool prefix_final, Command* custom_translator)
 474 {
 475         std::vector<TranslateType>::const_iterator types = to.begin();
 476         User* user = NULL;
 477         unsigned int i;
 478         int translations = 0;
 479         dest.clear();
 480
 481         for(i=0; i < source.size(); i++)
 482         {
 483                 TranslateType t;
 484                 std::string item = source[i];
 485
 486                 if (types == to.end())
 487                         t = TR_TEXT;
 488                 else
 489                 {
 490                         t = *types;
 491                         types++;
 492                 }
 493
 494                 if (prefix_final && i == source.size() - 1)
 495                         dest.append(":");
 496
 497                 switch (t)
 498                 {
 499                         case TR_NICK:
 500                                 /* Translate single nickname */
 501                                 user = ServerInstance->FindNick(item);
 502                                 if (user)
 503                                 {
 504                                         dest.append(user->uuid);
 505                                         translations++;
 506                                 }
 507                                 else
 508                                         dest.append(item);
 509                         break;
 510                         case TR_CUSTOM:
 511                                 if (custom_translator)
 512                                         custom_translator->EncodeParameter(item, i);
 513                                 dest.append(item);
 514                         break;
 515                         case TR_END:
 516                         case TR_TEXT:
 517                         default:
 518                                 /* Do nothing */
 519                                 dest.append(item);
 520                         break;
 521                 }
 522                 if (i != source.size() - 1)
 523                         dest.append(" ");
 524         }
 525
 526         return translations;
 527 }
 528
 529 int CommandParser::TranslateUIDs(TranslateType to, const std::string &source, std::string &dest)
 530 {
 531         User* user = NULL;
 532         std::string item;
 533         int translations = 0;
 534         dest.clear();
 535
 536         switch (to)
 537         {
 538                 case TR_NICK:
 539                         /* Translate single nickname */
 540                         user = ServerInstance->FindNick(source);
 541                         if (user)
 542                         {
 543                                 dest = user->uuid;
 544                                 translations++;
 545                         }
 546                         else
 547                                 dest = source;
 548                 break;
 549                 case TR_END:
 550                 case TR_TEXT:
 551                 default:
 552                         /* Do nothing */
 553                         dest = source;
 554                 break;
 555         }
 556
 557         return translations;
 558 }