src/command_parse.cpp

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd: (C) 2002-2008 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 /* $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         int MOD_RESULT = 0;
  32         FOREACH_RESULT_I(this,I_OnPassCompare,OnPassCompare(ex, data, input, hashtype))
  33         if (MOD_RESULT == 1)
  34                 return 0;
  35         if (MOD_RESULT == -1)
  36                 return 1;
  37         return data != input; // this seems back to front, but returns 0 if they *match*, 1 else
  38 }
  39
  40 /* LoopCall is used to call a command classes handler repeatedly based on the contents of a comma seperated list.
  41  * There are two overriden versions of this method, one of which takes two potential lists and the other takes one.
  42  * We need a version which takes two potential lists for JOIN, because a JOIN may contain two lists of items at once,
  43  * the channel names and their keys as follows:
  44  * JOIN #chan1,#chan2,#chan3 key1,,key3
  45  * Therefore, we need to deal with both lists concurrently. The first instance of this method does that by creating
  46  * two instances of irc::commasepstream and reading them both together until the first runs out of tokens.
  47  * The second version is much simpler and just has the one stream to read, and is used in NAMES, WHOIS, PRIVMSG etc.
  48  * Both will only parse until they reach ServerInstance->Config->MaxTargets number of targets, to stop abuse via spam.
  49  */
  50 int CommandParser::LoopCall(User* user, Command* CommandObj, const std::vector<std::string>& parameters, unsigned int splithere, unsigned int extra)
  51 {
  52         if (splithere >= parameters.size())
  53                 return 0;
  54
  55         /* First check if we have more than one item in the list, if we don't we return zero here and the handler
  56          * which called us just carries on as it was.
  57          */
  58         if (parameters[splithere].find(',') == std::string::npos)
  59                 return 0;
  60
  61         /** Some lame ircds will weed out dupes using some shitty O(n^2) algorithm.
  62          * By using std::map (thanks for the idea w00t) we can cut this down a ton.
  63          * ...VOOODOOOO!
  64          */
  65         std::map<irc::string, bool> dupes;
  66
  67         /* Create two lists, one for channel names, one for keys
  68          */
  69         irc::commasepstream items1(parameters[splithere]);
  70         irc::commasepstream items2(parameters[extra]);
  71         std::string extrastuff;
  72         std::string item;
  73         unsigned int max = 0;
  74
  75         /* Attempt to iterate these lists and call the command objech
  76          * which called us, for every parameter pair until there are
  77          * no more left to parse.
  78          */
  79         while (items1.GetToken(item) && (max++ < ServerInstance->Config->MaxTargets))
  80         {
  81                 if (dupes.find(item.c_str()) == dupes.end())
  82                 {
  83                         std::vector<std::string> new_parameters;
  84
  85                         for (unsigned int t = 0; (t < parameters.size()) && (t < MAXPARAMETERS); t++)
  86                                 new_parameters.push_back(parameters[t]);
  87
  88                         if (!items2.GetToken(extrastuff))
  89                                 extrastuff = "";
  90
  91                         new_parameters[splithere] = item.c_str();
  92                         new_parameters[extra] = extrastuff.c_str();
  93
  94                         CommandObj->Handle(new_parameters, user);
  95
  96                         dupes[item.c_str()] = true;
  97                 }
  98         }
  99         return 1;
 100 }
 101
 102 int CommandParser::LoopCall(User* user, Command* CommandObj, const std::vector<std::string>& parameters, unsigned int splithere)
 103 {
 104         if (splithere >= parameters.size())
 105                 return 0;
 106
 107         /* First check if we have more than one item in the list, if we don't we return zero here and the handler
 108          * which called us just carries on as it was.
 109          */
 110         if (parameters[splithere].find(',') == std::string::npos)
 111                 return 0;
 112
 113         std::map<irc::string, bool> dupes;
 114
 115         /* Only one commasepstream here */
 116         irc::commasepstream items1(parameters[splithere]);
 117         std::string item;
 118         unsigned int max = 0;
 119
 120         /* Parse the commasepstream until there are no tokens remaining.
 121          * Each token we parse out, call the command handler that called us
 122          * with it
 123          */
 124         while (items1.GetToken(item) && (max++ < ServerInstance->Config->MaxTargets))
 125         {
 126                 if (dupes.find(item.c_str()) == dupes.end())
 127                 {
 128                         std::vector<std::string> new_parameters;
 129
 130                         for (unsigned int t = 0; (t < parameters.size()) && (t < MAXPARAMETERS); t++)
 131                                 new_parameters.push_back(parameters[t]);
 132
 133                         new_parameters[splithere] = item.c_str();
 134
 135                         /* Execute the command handler. */
 136                         CommandObj->Handle(new_parameters, user);
 137
 138                         dupes[item.c_str()] = true;
 139                 }
 140         }
 141         /* By returning 1 we tell our caller that nothing is to be done,
 142          * as all the previous calls handled the data. This makes the parent
 143          * return without doing any processing.
 144          */
 145         return 1;
 146 }
 147
 148 bool CommandParser::IsValidCommand(const std::string &commandname, unsigned int pcnt, User * user)
 149 {
 150         Commandtable::iterator n = cmdlist.find(commandname);
 151
 152         if (n != cmdlist.end())
 153         {
 154                 if ((pcnt >= n->second->min_params) && (n->second->source != "<core>"))
 155                 {
 156                         if (IS_LOCAL(user) && n->second->flags_needed)
 157                         {
 158                                 if (user->IsModeSet(n->second->flags_needed))
 159                                 {
 160                                         return (user->HasPermission(commandname));
 161                                 }
 162                         }
 163                         else
 164                         {
 165                                 return true;
 166                         }
 167                 }
 168         }
 169         return false;
 170 }
 171
 172 Command* CommandParser::GetHandler(const std::string &commandname)
 173 {
 174         Commandtable::iterator n = cmdlist.find(commandname);
 175         if (n != cmdlist.end())
 176                 return n->second;
 177
 178         return NULL;
 179 }
 180
 181 // calls a handler function for a command
 182
 183 CmdResult CommandParser::CallHandler(const std::string &commandname, const std::vector<std::string>& parameters, User *user)
 184 {
 185         Commandtable::iterator n = cmdlist.find(commandname);
 186
 187         if (n != cmdlist.end())
 188         {
 189                 if (parameters.size() >= n->second->min_params)
 190                 {
 191                         bool bOkay = false;
 192
 193                         if (IS_LOCAL(user) && n->second->flags_needed)
 194                         {
 195                                 /* if user is local, and flags are needed .. */
 196
 197                                 if (user->IsModeSet(n->second->flags_needed))
 198                                 {
 199                                         /* if user has the flags, and now has the permissions, go ahead */
 200                                         if (user->HasPermission(commandname))
 201                                                 bOkay = true;
 202                                 }
 203                         }
 204                         else
 205                         {
 206                                 /* remote or no flags required anyway */
 207                                 bOkay = true;
 208                         }
 209
 210                         if (bOkay)
 211                         {
 212                                 return n->second->Handle(parameters,user);
 213                         }
 214                 }
 215         }
 216         return CMD_INVALID;
 217 }
 218
 219 void CommandParser::DoLines(User* current, bool one_only)
 220 {
 221         while (current->BufferIsReady())
 222         {
 223                 // use GetBuffer to copy single lines into the sanitized string
 224                 std::string single_line = current->GetBuffer();
 225                 current->bytes_in += single_line.length();
 226                 current->cmds_in++;
 227                 if (single_line.length() > MAXBUF - 2)  // MAXBUF is 514 to allow for neccessary line terminators
 228                         single_line.resize(MAXBUF - 2); // So to trim to 512 here, we use MAXBUF - 2
 229
 230                 // ProcessBuffer returns false if the user has gone over penalty
 231                 if (!ServerInstance->Parser->ProcessBuffer(single_line, current) || one_only)
 232                         break;
 233         }
 234 }
 235
 236 bool CommandParser::ProcessCommand(User *user, std::string &cmd)
 237 {
 238         std::vector<std::string> command_p;
 239         irc::tokenstream tokens(cmd);
 240         std::string command, token;
 241         tokens.GetToken(command);
 242
 243         /* A client sent a nick prefix on their command (ick)
 244          * rhapsody and some braindead bouncers do this --
 245          * the rfc says they shouldnt but also says the ircd should
 246          * discard it if they do.
 247          */
 248         if (command[0] == ':')
 249                 tokens.GetToken(command);
 250
 251         while (tokens.GetToken(token) && (command_p.size() <= MAXPARAMETERS))
 252                 command_p.push_back(token);
 253
 254         std::transform(command.begin(), command.end(), command.begin(), ::toupper);
 255
 256         /* find the command, check it exists */
 257         Commandtable::iterator cm = cmdlist.find(command);
 258
 259         if (cm == cmdlist.end())
 260         {
 261                 int MOD_RESULT = 0;
 262                 FOREACH_RESULT(I_OnPreCommand,OnPreCommand(command, command_p, user, false, cmd));
 263                 if (MOD_RESULT == 1)
 264                         return true;
 265
 266                 /*
 267                  * This double lookup is in case a module (abbreviation) wishes to change a command.
 268                  * Sure, the double lookup is a bit painful, but bear in mind this only happens for unknowns anyway.
 269                  *
 270                  * Thanks dz for making me actually understand why this is necessary!
 271                  * -- w00t
 272                  */
 273                 cm = cmdlist.find(command);
 274                 if (cm == cmdlist.end())
 275                 {
 276                         if (user->registered == REG_ALL)
 277                                 user->WriteNumeric(ERR_UNKNOWNCOMMAND, "%s %s :Unknown command",user->nick.c_str(),command.c_str());
 278                         ServerInstance->stats->statsUnknown++;
 279                         return true;
 280                 }
 281         }
 282
 283         if (cm->second->max_params && command_p.size() > cm->second->max_params)
 284         {
 285                 /*
 286                  * command_p input (assuming max_params 1):
 287                  *      this
 288                  *      is
 289                  *      a
 290                  *      test
 291                  */
 292                 std::string lparam = "";
 293
 294                 /*
 295                  * The '-1' here is a clever trick, we'll go backwards throwing everything into a temporary param
 296                  * and then just toss that into the array.
 297                  * -- w00t
 298                  */
 299                 while (command_p.size() > (cm->second->max_params - 1))
 300                 {
 301                         // BE CAREFUL: .end() returns past the end of the vector, hence decrement.
 302                         std::vector<std::string>::iterator it = --command_p.end();
 303
 304                         lparam.insert(0, " " + *(it));
 305                         command_p.erase(it); // remove last element
 306                 }
 307
 308                 /* we now have (each iteration):
 309                  *      ' test'
 310                  *      ' a test'
 311                  *      ' is a test' <-- final string
 312                  * ...now remove the ' ' at the start...
 313                  */
 314                 lparam.erase(lparam.begin());
 315
 316                 /* param is now 'is a test', which is exactly what we wanted! */
 317                 command_p.push_back(lparam);
 318         }
 319
 320         /*
 321          * We call OnPreCommand here seperately if the command exists, so the magic above can
 322          * truncate to max_params if necessary. -- w00t
 323          */
 324         int MOD_RESULT = 0;
 325         FOREACH_RESULT(I_OnPreCommand,OnPreCommand(command, command_p, user, false, cmd));
 326         if (MOD_RESULT == 1)
 327                 return true;
 328
 329         /* Modify the user's penalty */
 330         bool do_more = true;
 331         if (!user->HasPrivPermission("users/flood/no-throttle"))
 332         {
 333                 user->IncreasePenalty(cm->second->Penalty);
 334                 do_more = (user->Penalty < 10);
 335         }
 336
 337         /* activity resets the ping pending timer */
 338         if (user->MyClass)
 339                 user->nping = ServerInstance->Time() + user->MyClass->GetPingTime();
 340
 341         if (cm->second->flags_needed)
 342         {
 343                 if (!user->IsModeSet(cm->second->flags_needed))
 344                 {
 345                         user->WriteNumeric(ERR_NOPRIVILEGES, "%s :Permission Denied - You do not have the required operator privileges",user->nick.c_str());
 346                         return do_more;
 347                 }
 348                 if (!user->HasPermission(command))
 349                 {
 350                         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());
 351                         return do_more;
 352                 }
 353         }
 354         if ((user->registered == REG_ALL) && (!IS_OPER(user)) && (cm->second->IsDisabled()))
 355         {
 356                 /* command is disabled! */
 357                 if (ServerInstance->Config->DisabledDontExist)
 358                 {
 359                         user->WriteNumeric(ERR_UNKNOWNCOMMAND, "%s %s :Unknown command",user->nick.c_str(),command.c_str());
 360                 }
 361                 else
 362                 {
 363                         user->WriteNumeric(ERR_UNKNOWNCOMMAND, "%s %s :This command has been disabled.",
 364                                                                                 user->nick.c_str(), command.c_str());
 365                 }
 366
 367                 ServerInstance->SNO->WriteToSnoMask('d', "%s denied for %s (%s@%s)",
 368                                 command.c_str(), user->nick.c_str(), user->ident.c_str(), user->host.c_str());
 369                 return do_more;
 370         }
 371         if (command_p.size() < cm->second->min_params)
 372         {
 373                 user->WriteNumeric(ERR_NEEDMOREPARAMS, "%s %s :Not enough parameters.", user->nick.c_str(), command.c_str());
 374                 if ((ServerInstance->Config->SyntaxHints) && (user->registered == REG_ALL) && (cm->second->syntax.length()))
 375                         user->WriteNumeric(RPL_SYNTAX, "%s :SYNTAX %s %s", user->nick.c_str(), cm->second->command.c_str(), cm->second->syntax.c_str());
 376                 return do_more;
 377         }
 378         if ((user->registered != REG_ALL) && (!cm->second->WorksBeforeReg()))
 379         {
 380                 user->WriteNumeric(ERR_NOTREGISTERED, "%s :You have not registered",command.c_str());
 381                 return do_more;
 382         }
 383         else
 384         {
 385                 /* passed all checks.. first, do the (ugly) stats counters. */
 386                 cm->second->use_count++;
 387                 cm->second->total_bytes += cmd.length();
 388
 389                 /* module calls too */
 390                 MOD_RESULT = 0;
 391                 FOREACH_RESULT(I_OnPreCommand,OnPreCommand(command, command_p, user, true, cmd));
 392                 if (MOD_RESULT == 1)
 393                         return do_more;
 394
 395                 /*
 396                  * WARNING: be careful, the user may be deleted soon
 397                  */
 398                 CmdResult result = cm->second->Handle(command_p, user);
 399
 400                 FOREACH_MOD(I_OnPostCommand,OnPostCommand(command, command_p, user, result,cmd));
 401                 return do_more;
 402         }
 403 }
 404
 405 void CommandParser::RemoveCommands(const char* source)
 406 {
 407         Commandtable::iterator i,safei;
 408         for (i = cmdlist.begin(); i != cmdlist.end();)
 409         {
 410                 safei = i;
 411                 i++;
 412                 RemoveCommand(safei, source);
 413         }
 414 }
 415
 416 void CommandParser::RemoveCommand(Commandtable::iterator safei, const char* source)
 417 {
 418         Command* x = safei->second;
 419         if (x->source == std::string(source))
 420         {
 421                 cmdlist.erase(safei);
 422                 delete x;
 423         }
 424 }
 425
 426 bool CommandParser::ProcessBuffer(std::string &buffer,User *user)
 427 {
 428         std::string::size_type a;
 429
 430         if (!user)
 431                 return true;
 432
 433         while ((a = buffer.rfind("\n")) != std::string::npos)
 434                 buffer.erase(a);
 435         while ((a = buffer.rfind("\r")) != std::string::npos)
 436                 buffer.erase(a);
 437
 438         if (buffer.length())
 439         {
 440                 ServerInstance->Logs->Log("USERINPUT", DEBUG,"C[%d] I :%s %s",user->GetFd(), user->nick.c_str(), buffer.c_str());
 441                 return this->ProcessCommand(user,buffer);
 442         }
 443
 444         return true;
 445 }
 446
 447 bool CommandParser::CreateCommand(Command *f, void* so_handle)
 448 {
 449         if (so_handle)
 450         {
 451                 if (RFCCommands.find(f->command) == RFCCommands.end())
 452                         RFCCommands[f->command] = so_handle;
 453                 else
 454                 {
 455                         ServerInstance->Logs->Log("COMMAND",DEFAULT,"ERK! Somehow, we loaded a cmd_*.so file twice! Only the first instance is being recorded.");
 456                         return false;
 457                 }
 458         }
 459
 460         /* create the command and push it onto the table */
 461         if (cmdlist.find(f->command) == cmdlist.end())
 462         {
 463                 cmdlist[f->command] = f;
 464                 return true;
 465         }
 466         else return false;
 467 }
 468
 469 CommandParser::CommandParser(InspIRCd* Instance) : ServerInstance(Instance)
 470 {
 471         para.resize(128);
 472 }
 473
 474 bool CommandParser::FindSym(void** v, void* h, const std::string &name)
 475 {
 476         *v = dlsym(h, "init_command");
 477         const char* err = dlerror();
 478         if (err && !(*v))
 479         {
 480                 ServerInstance->Logs->Log("COMMAND",SPARSE, "Error loading core command %s: %s\n", name.c_str(), err);
 481                 return false;
 482         }
 483         return true;
 484 }
 485
 486 bool CommandParser::ReloadCommand(std::string cmd, User* user)
 487 {
 488         char filename[MAXBUF];
 489         std::transform(cmd.begin(), cmd.end(), cmd.begin(), ::toupper);
 490
 491         SharedObjectList::iterator command = RFCCommands.find(cmd);
 492
 493         if (command != RFCCommands.end())
 494         {
 495                 Command* cmdptr = cmdlist.find(cmd)->second;
 496                 cmdlist.erase(cmdlist.find(cmd));
 497
 498                 RFCCommands.erase(cmd);
 499                 std::transform(cmd.begin(), cmd.end(), cmd.begin(), ::tolower);
 500                 delete cmdptr;
 501                 dlclose(command->second);
 502
 503                 snprintf(filename, MAXBUF, "cmd_%s.so", cmd.c_str());
 504                 const char* err = this->LoadCommand(filename);
 505                 if (err)
 506                 {
 507                         if (user)
 508                                 user->WriteServ("NOTICE %s :*** Error loading 'cmd_%s.so': %s", user->nick.c_str(), cmd.c_str(), err);
 509                         return false;
 510                 }
 511
 512                 return true;
 513         }
 514
 515         return false;
 516 }
 517
 518 CmdResult cmd_reload::Handle(const std::vector<std::string>& parameters, User *user)
 519 {
 520         if (parameters.size() < 1)
 521                 return CMD_FAILURE;
 522
 523         user->WriteServ("NOTICE %s :*** Reloading command '%s'",user->nick.c_str(), parameters[0].c_str());
 524         if (ServerInstance->Parser->ReloadCommand(parameters[0], user))
 525         {
 526                 user->WriteServ("NOTICE %s :*** Successfully reloaded command '%s'", user->nick.c_str(), parameters[0].c_str());
 527                 ServerInstance->SNO->WriteToSnoMask('A', "RELOAD: %s reloaded the '%s' command.", user->nick.c_str(), parameters[0].c_str());
 528                 return CMD_SUCCESS;
 529         }
 530         else
 531         {
 532                 user->WriteServ("NOTICE %s :*** Could not reload command '%s' -- fix this problem, then /REHASH as soon as possible!", user->nick.c_str(), parameters[0].c_str());
 533                 return CMD_FAILURE;
 534         }
 535 }
 536
 537 const char* CommandParser::LoadCommand(const char* name)
 538 {
 539         char filename[MAXBUF];
 540         void* h;
 541         Command* (*cmd_factory_func)(InspIRCd*);
 542
 543         /* Command already exists? Succeed silently - this is needed for REHASH */
 544         if (RFCCommands.find(name) != RFCCommands.end())
 545         {
 546                 ServerInstance->Logs->Log("COMMAND",DEBUG,"Not reloading command %s/%s, it already exists", LIBRARYDIR, name);
 547                 return NULL;
 548         }
 549
 550         snprintf(filename, MAXBUF, "%s/%s", LIBRARYDIR, name);
 551         h = dlopen(filename, RTLD_NOW | RTLD_GLOBAL);
 552
 553         if (!h)
 554         {
 555                 const char* n = dlerror();
 556                 ServerInstance->Logs->Log("COMMAND",SPARSE, "Error loading core command %s: %s", name, n);
 557                 return n;
 558         }
 559
 560         if (this->FindSym((void **)&cmd_factory_func, h, name))
 561         {
 562                 Command* newcommand = cmd_factory_func(ServerInstance);
 563                 this->CreateCommand(newcommand, h);
 564         }
 565         return NULL;
 566 }
 567
 568 /** This is only invoked on startup
 569  */
 570 void CommandParser::SetupCommandTable()
 571 {
 572         printf("\nLoading core commands");
 573         fflush(stdout);
 574
 575         DIR* library = opendir(LIBRARYDIR);
 576         if (library)
 577         {
 578                 dirent* entry = NULL;
 579                 while (0 != (entry = readdir(library)))
 580                 {
 581                         if (InspIRCd::Match(entry->d_name, "cmd_*.so"))
 582                         {
 583                                 printf(".");
 584                                 fflush(stdout);
 585
 586                                 const char* err = this->LoadCommand(entry->d_name);
 587                                 if (err)
 588                                 {
 589                                         printf("Error loading %s: %s", entry->d_name, err);
 590                                         exit(EXIT_STATUS_BADHANDLER);
 591                                 }
 592                         }
 593                 }
 594                 closedir(library);
 595                 printf("\n");
 596         }
 597
 598         if (cmdlist.find("RELOAD") == cmdlist.end())
 599                 this->CreateCommand(new cmd_reload(ServerInstance));
 600 }
 601
 602 int CommandParser::TranslateUIDs(TranslateType to, const std::string &source, std::string &dest)
 603 {
 604         User* user = NULL;
 605         std::string item;
 606         int translations = 0;
 607         dest.clear();
 608
 609         switch (to)
 610         {
 611                 case TR_NICK:
 612                         /* Translate single nickname */
 613                         user = ServerInstance->FindNick(source);
 614                         if (user)
 615                         {
 616                                 dest = user->uuid;
 617                                 translations++;
 618                         }
 619                         else
 620                                 dest = source;
 621                 break;
 622                 case TR_NICKLIST:
 623                 {
 624                         /* Translate comma seperated list of nicknames */
 625                         irc::commasepstream items(source);
 626                         while (items.GetToken(item))
 627                         {
 628                                 user = ServerInstance->FindNick(item);
 629                                 if (user)
 630                                 {
 631                                         dest.append(user->uuid);
 632                                         translations++;
 633                                 }
 634                                 else
 635                                         dest.append(item);
 636                                 dest.append(",");
 637                         }
 638                         if (!dest.empty())
 639                                 dest.erase(dest.end() - 1);
 640                 }
 641                 break;
 642                 case TR_SPACENICKLIST:
 643                 {
 644                         /* Translate space seperated list of nicknames */
 645                         irc::spacesepstream items(source);
 646                         while (items.GetToken(item))
 647                         {
 648                                 user = ServerInstance->FindNick(item);
 649                                 if (user)
 650                                 {
 651                                         dest.append(user->uuid);
 652                                         translations++;
 653                                 }
 654                                 else
 655                                         dest.append(item);
 656                                 dest.append(" ");
 657                         }
 658                         if (!dest.empty())
 659                                 dest.erase(dest.end() - 1);
 660                 }
 661                 break;
 662                 case TR_END:
 663                 case TR_TEXT:
 664                 default:
 665                         /* Do nothing */
 666                         dest = source;
 667                 break;
 668         }
 669
 670         return translations;
 671 }
 672
 673