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 there are complete lines to process...
 222         unsigned int floodlines = 0;
 223
 224         while (current->BufferIsReady())
 225         {
 226                 if (current->MyClass)
 227                 {
 228                         if (ServerInstance->Time() > current->reset_due)
 229                         {
 230                                 current->reset_due = ServerInstance->Time() + current->MyClass->GetThreshold();
 231                                 current->lines_in = 0;
 232                         }
 233
 234                         if (++current->lines_in > current->MyClass->GetFlood() && current->MyClass->GetFlood())
 235                         {
 236                                 ServerInstance->FloodQuitUser(current);
 237                                 return;
 238                         }
 239
 240                         if ((++floodlines > current->MyClass->GetFlood()) && (current->MyClass->GetFlood() != 0))
 241                         {
 242                                 ServerInstance->FloodQuitUser(current);
 243                                 return;
 244                         }
 245                 }
 246
 247                 // use GetBuffer to copy single lines into the sanitized string
 248                 std::string single_line = current->GetBuffer();
 249                 current->bytes_in += single_line.length();
 250                 current->cmds_in++;
 251                 if (single_line.length() > MAXBUF - 2)  // MAXBUF is 514 to allow for neccessary line terminators
 252                         single_line.resize(MAXBUF - 2); // So to trim to 512 here, we use MAXBUF - 2
 253
 254                 // ProcessBuffer returns false if the user has gone over penalty
 255                 if (!ServerInstance->Parser->ProcessBuffer(single_line, current) || one_only)
 256                         break;
 257         }
 258 }
 259
 260 bool CommandParser::ProcessCommand(User *user, std::string &cmd)
 261 {
 262         std::vector<std::string> command_p;
 263         irc::tokenstream tokens(cmd);
 264         std::string command, token;
 265         tokens.GetToken(command);
 266
 267         /* A client sent a nick prefix on their command (ick)
 268          * rhapsody and some braindead bouncers do this --
 269          * the rfc says they shouldnt but also says the ircd should
 270          * discard it if they do.
 271          */
 272         if (command[0] == ':')
 273                 tokens.GetToken(command);
 274
 275         while (tokens.GetToken(token) && (command_p.size() <= MAXPARAMETERS))
 276                 command_p.push_back(token);
 277
 278         std::transform(command.begin(), command.end(), command.begin(), ::toupper);
 279
 280         int MOD_RESULT = 0;
 281         FOREACH_RESULT(I_OnPreCommand,OnPreCommand(command, command_p, user, false, cmd));
 282         if (MOD_RESULT == 1) {
 283                 return true;
 284         }
 285
 286         /* find the command, check it exists */
 287         Commandtable::iterator cm = cmdlist.find(command);
 288
 289         if (cm == cmdlist.end())
 290         {
 291                 if (user->registered == REG_ALL)
 292                 {
 293                         user->WriteNumeric(ERR_UNKNOWNCOMMAND, "%s %s :Unknown command",user->nick.c_str(),command.c_str());
 294                 }
 295                 ServerInstance->stats->statsUnknown++;
 296                 return true;
 297         }
 298
 299         /* Modify the user's penalty */
 300         bool do_more = true;
 301         if (!user->ExemptFromPenalty)
 302         {
 303                 user->IncreasePenalty(cm->second->Penalty);
 304                 do_more = (user->Penalty < 10);
 305                 if (!do_more)
 306                         user->OverPenalty = true;
 307         }
 308
 309         /* activity resets the ping pending timer */
 310         if (user->MyClass)
 311                 user->nping = ServerInstance->Time() + user->MyClass->GetPingTime();
 312
 313         if (cm->second->flags_needed)
 314         {
 315                 if (!user->IsModeSet(cm->second->flags_needed))
 316                 {
 317                         user->WriteNumeric(ERR_NOPRIVILEGES, "%s :Permission Denied - You do not have the required operator privileges",user->nick.c_str());
 318                         return do_more;
 319                 }
 320                 if (!user->HasPermission(command))
 321                 {
 322                         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());
 323                         return do_more;
 324                 }
 325         }
 326         if ((user->registered == REG_ALL) && (!IS_OPER(user)) && (cm->second->IsDisabled()))
 327         {
 328                 /* command is disabled! */
 329                 user->WriteNumeric(ERR_UNKNOWNCOMMAND, "%s %s :This command has been disabled.",user->nick.c_str(),command.c_str());
 330                 ServerInstance->SNO->WriteToSnoMask('d', "%s denied for %s (%s@%s)",
 331                                 command.c_str(), user->nick.c_str(), user->ident.c_str(), user->host.c_str());
 332                 return do_more;
 333         }
 334         if (command_p.size() < cm->second->min_params)
 335         {
 336                 user->WriteNumeric(ERR_NEEDMOREPARAMS, "%s %s :Not enough parameters.", user->nick.c_str(), command.c_str());
 337                 if ((ServerInstance->Config->SyntaxHints) && (user->registered == REG_ALL) && (cm->second->syntax.length()))
 338                         user->WriteNumeric(RPL_SYNTAX, "%s :SYNTAX %s %s", user->nick.c_str(), cm->second->command.c_str(), cm->second->syntax.c_str());
 339                 return do_more;
 340         }
 341         if ((user->registered != REG_ALL) && (!cm->second->WorksBeforeReg()))
 342         {
 343                 user->WriteNumeric(ERR_NOTREGISTERED, "%s :You have not registered",command.c_str());
 344                 return do_more;
 345         }
 346         else
 347         {
 348                 /* passed all checks.. first, do the (ugly) stats counters. */
 349                 cm->second->use_count++;
 350                 cm->second->total_bytes += cmd.length();
 351
 352                 /* module calls too */
 353                 MOD_RESULT = 0;
 354                 FOREACH_RESULT(I_OnPreCommand,OnPreCommand(command, command_p, user, true, cmd));
 355                 if (MOD_RESULT == 1)
 356                         return do_more;
 357
 358                 /*
 359                  * WARNING: be careful, the user may be deleted soon
 360                  */
 361                 CmdResult result = cm->second->Handle(command_p, user);
 362
 363                 FOREACH_MOD(I_OnPostCommand,OnPostCommand(command, command_p, user, result,cmd));
 364                 return do_more;
 365         }
 366 }
 367
 368 void CommandParser::RemoveCommands(const char* source)
 369 {
 370         Commandtable::iterator i,safei;
 371         for (i = cmdlist.begin(); i != cmdlist.end();)
 372         {
 373                 safei = i;
 374                 i++;
 375                 RemoveCommand(safei, source);
 376         }
 377 }
 378
 379 void CommandParser::RemoveCommand(Commandtable::iterator safei, const char* source)
 380 {
 381         Command* x = safei->second;
 382         if (x->source == std::string(source))
 383         {
 384                 cmdlist.erase(safei);
 385                 delete x;
 386         }
 387 }
 388
 389 bool CommandParser::ProcessBuffer(std::string &buffer,User *user)
 390 {
 391         std::string::size_type a;
 392
 393         if (!user)
 394                 return true;
 395
 396         while ((a = buffer.rfind("\n")) != std::string::npos)
 397                 buffer.erase(a);
 398         while ((a = buffer.rfind("\r")) != std::string::npos)
 399                 buffer.erase(a);
 400
 401         if (buffer.length())
 402         {
 403                 ServerInstance->Logs->Log("USERINPUT", DEBUG,"C[%d] I :%s %s",user->GetFd(), user->nick.c_str(), buffer.c_str());
 404                 return this->ProcessCommand(user,buffer);
 405         }
 406
 407         return true;
 408 }
 409
 410 bool CommandParser::CreateCommand(Command *f, void* so_handle)
 411 {
 412         if (so_handle)
 413         {
 414                 if (RFCCommands.find(f->command) == RFCCommands.end())
 415                         RFCCommands[f->command] = so_handle;
 416                 else
 417                 {
 418                         ServerInstance->Logs->Log("COMMAND",DEFAULT,"ERK! Somehow, we loaded a cmd_*.so file twice! Only the first instance is being recorded.");
 419                         return false;
 420                 }
 421         }
 422
 423         /* create the command and push it onto the table */
 424         if (cmdlist.find(f->command) == cmdlist.end())
 425         {
 426                 cmdlist[f->command] = f;
 427                 return true;
 428         }
 429         else return false;
 430 }
 431
 432 CommandParser::CommandParser(InspIRCd* Instance) : ServerInstance(Instance)
 433 {
 434         para.resize(128);
 435 }
 436
 437 bool CommandParser::FindSym(void** v, void* h, const std::string &name)
 438 {
 439         *v = dlsym(h, "init_command");
 440         const char* err = dlerror();
 441         if (err && !(*v))
 442         {
 443                 ServerInstance->Logs->Log("COMMAND",SPARSE, "Error loading core command %s: %s\n", name.c_str(), err);
 444                 return false;
 445         }
 446         return true;
 447 }
 448
 449 bool CommandParser::ReloadCommand(std::string cmd, User* user)
 450 {
 451         char filename[MAXBUF];
 452         std::transform(cmd.begin(), cmd.end(), cmd.begin(), ::toupper);
 453
 454         SharedObjectList::iterator command = RFCCommands.find(cmd);
 455
 456         if (command != RFCCommands.end())
 457         {
 458                 Command* cmdptr = cmdlist.find(cmd)->second;
 459                 cmdlist.erase(cmdlist.find(cmd));
 460
 461                 RFCCommands.erase(cmd);
 462                 std::transform(cmd.begin(), cmd.end(), cmd.begin(), ::tolower);
 463                 delete cmdptr;
 464                 dlclose(command->second);
 465
 466                 snprintf(filename, MAXBUF, "cmd_%s.so", cmd.c_str());
 467                 const char* err = this->LoadCommand(filename);
 468                 if (err)
 469                 {
 470                         if (user)
 471                                 user->WriteServ("NOTICE %s :*** Error loading 'cmd_%s.so': %s", user->nick.c_str(), cmd.c_str(), err);
 472                         return false;
 473                 }
 474
 475                 return true;
 476         }
 477
 478         return false;
 479 }
 480
 481 CmdResult cmd_reload::Handle(const std::vector<std::string>& parameters, User *user)
 482 {
 483         if (parameters.size() < 1)
 484                 return CMD_FAILURE;
 485
 486         user->WriteServ("NOTICE %s :*** Reloading command '%s'",user->nick.c_str(), parameters[0].c_str());
 487         if (ServerInstance->Parser->ReloadCommand(parameters[0], user))
 488         {
 489                 user->WriteServ("NOTICE %s :*** Successfully reloaded command '%s'", user->nick.c_str(), parameters[0].c_str());
 490                 ServerInstance->SNO->WriteToSnoMask('A', "RELOAD: %s reloaded the '%s' command.", user->nick.c_str(), parameters[0].c_str());
 491                 return CMD_SUCCESS;
 492         }
 493         else
 494         {
 495                 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());
 496                 return CMD_FAILURE;
 497         }
 498 }
 499
 500 const char* CommandParser::LoadCommand(const char* name)
 501 {
 502         char filename[MAXBUF];
 503         void* h;
 504         Command* (*cmd_factory_func)(InspIRCd*);
 505
 506         /* Command already exists? Succeed silently - this is needed for REHASH */
 507         if (RFCCommands.find(name) != RFCCommands.end())
 508         {
 509                 ServerInstance->Logs->Log("COMMAND",DEBUG,"Not reloading command %s/%s, it already exists", LIBRARYDIR, name);
 510                 return NULL;
 511         }
 512
 513         snprintf(filename, MAXBUF, "%s/%s", LIBRARYDIR, name);
 514         h = dlopen(filename, RTLD_NOW | RTLD_GLOBAL);
 515
 516         if (!h)
 517         {
 518                 const char* n = dlerror();
 519                 ServerInstance->Logs->Log("COMMAND",SPARSE, "Error loading core command %s: %s", name, n);
 520                 return n;
 521         }
 522
 523         if (this->FindSym((void **)&cmd_factory_func, h, name))
 524         {
 525                 Command* newcommand = cmd_factory_func(ServerInstance);
 526                 this->CreateCommand(newcommand, h);
 527         }
 528         return NULL;
 529 }
 530
 531 void CommandParser::SetupCommandTable(User* user)
 532 {
 533         RFCCommands.clear();
 534
 535         if (!user)
 536         {
 537                 printf("\nLoading core commands");
 538                 fflush(stdout);
 539         }
 540
 541         DIR* library = opendir(LIBRARYDIR);
 542         if (library)
 543         {
 544                 dirent* entry = NULL;
 545                 while (0 != (entry = readdir(library)))
 546                 {
 547                         if (InspIRCd::Match(entry->d_name, "cmd_*.so", NULL))
 548                         {
 549                                 if (!user)
 550                                 {
 551                                         printf(".");
 552                                         fflush(stdout);
 553                                 }
 554                                 const char* err = this->LoadCommand(entry->d_name);
 555                                 if (err)
 556                                 {
 557                                         if (user)
 558                                         {
 559                                                 user->WriteServ("NOTICE %s :*** Failed to load core command %s: %s", user->nick.c_str(), entry->d_name, err);
 560                                         }
 561                                         else
 562                                         {
 563                                                 printf("Error loading %s: %s", entry->d_name, err);
 564                                                 exit(EXIT_STATUS_BADHANDLER);
 565                                         }
 566                                 }
 567                         }
 568                 }
 569                 closedir(library);
 570                 if (!user)
 571                         printf("\n");
 572         }
 573
 574         if (cmdlist.find("RELOAD") == cmdlist.end())
 575                 this->CreateCommand(new cmd_reload(ServerInstance));
 576 }
 577
 578 int CommandParser::TranslateUIDs(TranslateType to, const std::string &source, std::string &dest)
 579 {
 580         User* user = NULL;
 581         std::string item;
 582         int translations = 0;
 583         dest.clear();
 584
 585         switch (to)
 586         {
 587                 case TR_NICK:
 588                         /* Translate single nickname */
 589                         user = ServerInstance->FindNick(source);
 590                         if (user)
 591                         {
 592                                 dest = user->uuid;
 593                                 translations++;
 594                         }
 595                         else
 596                                 dest = source;
 597                 break;
 598                 case TR_NICKLIST:
 599                 {
 600                         /* Translate comma seperated list of nicknames */
 601                         irc::commasepstream items(source);
 602                         while (items.GetToken(item))
 603                         {
 604                                 user = ServerInstance->FindNick(item);
 605                                 if (user)
 606                                 {
 607                                         dest.append(user->uuid);
 608                                         translations++;
 609                                 }
 610                                 else
 611                                         dest.append(item);
 612                                 dest.append(",");
 613                         }
 614                         if (!dest.empty())
 615                                 dest.erase(dest.end() - 1);
 616                 }
 617                 break;
 618                 case TR_SPACENICKLIST:
 619                 {
 620                         /* Translate space seperated list of nicknames */
 621                         irc::spacesepstream items(source);
 622                         while (items.GetToken(item))
 623                         {
 624                                 user = ServerInstance->FindNick(item);
 625                                 if (user)
 626                                 {
 627                                         dest.append(user->uuid);
 628                                         translations++;
 629                                 }
 630                                 else
 631                                         dest.append(item);
 632                                 dest.append(" ");
 633                         }
 634                         if (!dest.empty())
 635                                 dest.erase(dest.end() - 1);
 636                 }
 637                 break;
 638                 case TR_END:
 639                 case TR_TEXT:
 640                 default:
 641                         /* Do nothing */
 642                         dest = source;
 643                 break;
 644         }
 645
 646         return translations;
 647 }
 648
 649