src/command_parse.cpp

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd: (C) 2002-2007 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: libIRCDcommand_parse */
  15
  16 #include "inspircd.h"
  17 #include "wildcard.h"
  18 #include "xline.h"
  19 #include "socketengine.h"
  20 #include "socket.h"
  21 #include "command_parse.h"
  22 #include "exitcodes.h"
  23
  24 /* Directory Searching for Unix-Only */
  25 #ifndef WIN32
  26 #include <dirent.h>
  27 #include <dlfcn.h>
  28 #endif
  29
  30 int InspIRCd::OperPassCompare(const char* data,const char* input, int tagnumber)
  31 {
  32         int MOD_RESULT = 0;
  33         FOREACH_RESULT_I(this,I_OnOperCompare,OnOperCompare(data, input, tagnumber))
  34         if (MOD_RESULT == 1)
  35                 return 0;
  36         if (MOD_RESULT == -1)
  37                 return 1;
  38         return strcmp(data,input);
  39 }
  40
  41 /* LoopCall is used to call a command classes handler repeatedly based on the contents of a comma seperated list.
  42  * There are two overriden versions of this method, one of which takes two potential lists and the other takes one.
  43  * We need a version which takes two potential lists for JOIN, because a JOIN may contain two lists of items at once,
  44  * the channel names and their keys as follows:
  45  * JOIN #chan1,#chan2,#chan3 key1,,key3
  46  * Therefore, we need to deal with both lists concurrently. The first instance of this method does that by creating
  47  * two instances of irc::commasepstream and reading them both together until the first runs out of tokens.
  48  * The second version is much simpler and just has the one stream to read, and is used in NAMES, WHOIS, PRIVMSG etc.
  49  * Both will only parse until they reach ServerInstance->Config->MaxTargets number of targets, to stop abuse via spam.
  50  */
  51 int CommandParser::LoopCall(User* user, Command* CommandObj, const char** parameters, int pcnt, unsigned int splithere, unsigned int extra)
  52 {
  53         /* First check if we have more than one item in the list, if we don't we return zero here and the handler
  54          * which called us just carries on as it was.
  55          */
  56         if (!strchr(parameters[splithere],','))
  57                 return 0;
  58
  59         /** Some lame ircds will weed out dupes using some shitty O(n^2) algorithm.
  60          * By using std::map (thanks for the idea w00t) we can cut this down a ton.
  61          * ...VOOODOOOO!
  62          */
  63         std::map<irc::string, bool> dupes;
  64
  65         /* Create two lists, one for channel names, one for keys
  66          */
  67         irc::commasepstream items1(parameters[splithere]);
  68         irc::commasepstream items2(parameters[extra]);
  69         std::string extrastuff;
  70         std::string item;
  71         unsigned int max = 0;
  72
  73         /* Attempt to iterate these lists and call the command objech
  74          * which called us, for every parameter pair until there are
  75          * no more left to parse.
  76          */
  77         while (items1.GetToken(item) && (max++ < ServerInstance->Config->MaxTargets))
  78         {
  79                 if (dupes.find(item.c_str()) == dupes.end())
  80                 {
  81                         const char* new_parameters[MAXPARAMETERS];
  82
  83                         for (int t = 0; (t < pcnt) && (t < MAXPARAMETERS); t++)
  84                                 new_parameters[t] = parameters[t];
  85
  86                         if (!items2.GetToken(extrastuff))
  87                                 extrastuff = "";
  88
  89                         new_parameters[splithere] = item.c_str();
  90                         new_parameters[extra] = extrastuff.c_str();
  91
  92                         CommandObj->Handle(new_parameters,pcnt,user);
  93
  94                         dupes[item.c_str()] = true;
  95                 }
  96         }
  97         return 1;
  98 }
  99
 100 int CommandParser::LoopCall(User* user, Command* CommandObj, const char** parameters, int pcnt, unsigned int splithere)
 101 {
 102         /* First check if we have more than one item in the list, if we don't we return zero here and the handler
 103          * which called us just carries on as it was.
 104          */
 105         if (!strchr(parameters[splithere],','))
 106                 return 0;
 107
 108         std::map<irc::string, bool> dupes;
 109
 110         /* Only one commasepstream here */
 111         irc::commasepstream items1(parameters[splithere]);
 112         std::string item;
 113         unsigned int max = 0;
 114
 115         /* Parse the commasepstream until there are no tokens remaining.
 116          * Each token we parse out, call the command handler that called us
 117          * with it
 118          */
 119         while (items1.GetToken(item) && (max++ < ServerInstance->Config->MaxTargets))
 120         {
 121                 if (dupes.find(item.c_str()) == dupes.end())
 122                 {
 123                         const char* new_parameters[MAXPARAMETERS];
 124
 125                         for (int t = 0; (t < pcnt) && (t < MAXPARAMETERS); t++)
 126                                 new_parameters[t] = parameters[t];
 127
 128                         new_parameters[splithere] = item.c_str();
 129
 130                         parameters[splithere] = item.c_str();
 131
 132                         /* Execute the command handler over and over. If someone pulls our user
 133                          * record out from under us (e.g. if we /kill a comma sep list, and we're
 134                          * in that list ourselves) abort if we're gone.
 135                          */
 136                         CommandObj->Handle(new_parameters,pcnt,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, int pcnt, User * user)
 149 {
 150         Commandable::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         Commandable::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 char** parameters, int pcnt, User *user)
 184 {
 185         Commandable::iterator n = cmdlist.find(commandname);
 186
 187         if (n != cmdlist.end())
 188         {
 189                 if (pcnt >= 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,pcnt,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         const char *command_p[MAXPARAMETERS];
 263         int items = 0;
 264         irc::tokenstream tokens(cmd);
 265         std::string command;
 266         tokens.GetToken(command);
 267
 268         /* A client sent a nick prefix on their command (ick)
 269          * rhapsody and some braindead bouncers do this --
 270          * the rfc says they shouldnt but also says the ircd should
 271          * discard it if they do.
 272          */
 273         if (*command.c_str() == ':')
 274                 tokens.GetToken(command);
 275
 276         while (tokens.GetToken(para[items]) && (items < MAXPARAMETERS))
 277         {
 278                 command_p[items] = para[items].c_str();
 279                 items++;
 280         }
 281
 282         std::transform(command.begin(), command.end(), command.begin(), ::toupper);
 283
 284         int MOD_RESULT = 0;
 285         FOREACH_RESULT(I_OnPreCommand,OnPreCommand(command,command_p,items,user,false,cmd));
 286         if (MOD_RESULT == 1) {
 287                 return true;
 288         }
 289
 290         /* find the command, check it exists */
 291         Commandable::iterator cm = cmdlist.find(command);
 292
 293         if (cm == cmdlist.end())
 294         {
 295                 ServerInstance->stats->statsUnknown++;
 296                 user->WriteServ("421 %s %s :Unknown command",user->nick,command.c_str());
 297                 return true;
 298         }
 299
 300         /* Modify the user's penalty */
 301         bool do_more = true;
 302         if (!user->ExemptFromPenalty)
 303         {
 304                 user->IncreasePenalty(cm->second->Penalty);
 305                 do_more = (user->Penalty < 10);
 306                 if (!do_more)
 307                         user->OverPenalty = true;
 308         }
 309
 310         /* activity resets the ping pending timer */
 311         if (user->MyClass)
 312                 user->nping = ServerInstance->Time() + user->MyClass->GetPingTime();
 313
 314         if (cm->second->flags_needed)
 315         {
 316                 if (!user->IsModeSet(cm->second->flags_needed))
 317                 {
 318                         user->WriteServ("481 %s :Permission Denied - You do not have the required operator privileges",user->nick);
 319                         return do_more;
 320                 }
 321                 if (!user->HasPermission(command))
 322                 {
 323                         user->WriteServ("481 %s :Permission Denied - Oper type %s does not have access to command %s",user->nick,user->oper,command.c_str());
 324                         return do_more;
 325                 }
 326         }
 327         if ((user->registered == REG_ALL) && (!IS_OPER(user)) && (cm->second->IsDisabled()))
 328         {
 329                 /* command is disabled! */
 330                 user->WriteServ("421 %s %s :This command has been disabled.",user->nick,command.c_str());
 331                 ServerInstance->SNO->WriteToSnoMask('d', "%s denied for %s (%s@%s)",
 332                                 command.c_str(), user->nick, user->ident, user->host);
 333                 return do_more;
 334         }
 335         if (items < cm->second->min_params)
 336         {
 337                 user->WriteServ("461 %s %s :Not enough parameters.", user->nick, command.c_str());
 338                 if ((ServerInstance->Config->SyntaxHints) && (user->registered == REG_ALL) && (cm->second->syntax.length()))
 339                         user->WriteServ("304 %s :SYNTAX %s %s", user->nick, cm->second->command.c_str(), cm->second->syntax.c_str());
 340                 return do_more;
 341         }
 342         if ((user->registered != REG_ALL) && (!cm->second->WorksBeforeReg()))
 343         {
 344                 user->WriteServ("451 %s :You have not registered",command.c_str());
 345                 return do_more;
 346         }
 347         else
 348         {
 349                 /* passed all checks.. first, do the (ugly) stats counters. */
 350                 cm->second->use_count++;
 351                 cm->second->total_bytes += cmd.length();
 352
 353                 /* module calls too */
 354                 int MOD_RESULT = 0;
 355                 FOREACH_RESULT(I_OnPreCommand,OnPreCommand(command,command_p,items,user,true,cmd));
 356                 if (MOD_RESULT == 1)
 357                         return do_more;
 358
 359                 /*
 360                  * WARNING: be careful, the user may be deleted soon
 361                  */
 362                 CmdResult result = cm->second->Handle(command_p,items,user);
 363
 364                 FOREACH_MOD(I_OnPostCommand,OnPostCommand(command, command_p, items, user, result,cmd));
 365                 return do_more;
 366         }
 367 }
 368
 369 bool CommandParser::RemoveCommands(const char* source)
 370 {
 371         Commandable::iterator i,safei;
 372         for (i = cmdlist.begin(); i != cmdlist.end(); i++)
 373         {
 374                 safei = i;
 375                 safei++;
 376                 if (safei != cmdlist.end())
 377                 {
 378                         RemoveCommand(safei, source);
 379                 }
 380         }
 381         safei = cmdlist.begin();
 382         if (safei != cmdlist.end())
 383         {
 384                 RemoveCommand(safei, source);
 385         }
 386         return true;
 387 }
 388
 389 void CommandParser::RemoveCommand(Commandable::iterator safei, const char* source)
 390 {
 391         Command* x = safei->second;
 392         if (x->source == std::string(source))
 393         {
 394                 cmdlist.erase(safei);
 395                 delete x;
 396         }
 397 }
 398
 399 bool CommandParser::ProcessBuffer(std::string &buffer,User *user)
 400 {
 401         std::string::size_type a;
 402
 403         if (!user)
 404                 return true;
 405
 406         while ((a = buffer.rfind("\n")) != std::string::npos)
 407                 buffer.erase(a);
 408         while ((a = buffer.rfind("\r")) != std::string::npos)
 409                 buffer.erase(a);
 410
 411         if (buffer.length())
 412         {
 413                 if (!user->muted)
 414                 {
 415                         ServerInstance->Log(DEBUG,"C[%d] I :%s %s",user->GetFd(), user->nick, buffer.c_str());
 416                         return this->ProcessCommand(user,buffer);
 417                 }
 418         }
 419         return true;
 420 }
 421
 422 bool CommandParser::CreateCommand(Command *f, void* so_handle)
 423 {
 424         if (so_handle)
 425         {
 426                 if (RFCCommands.find(f->command) == RFCCommands.end())
 427                         RFCCommands[f->command] = so_handle;
 428                 else
 429                 {
 430                         ServerInstance->Log(DEFAULT,"ERK! Somehow, we loaded a cmd_*.so file twice! Only the first instance is being recorded.");
 431                         return false;
 432                 }
 433         }
 434
 435         /* create the command and push it onto the table */
 436         if (cmdlist.find(f->command) == cmdlist.end())
 437         {
 438                 cmdlist[f->command] = f;
 439                 return true;
 440         }
 441         else return false;
 442 }
 443
 444 CommandParser::CommandParser(InspIRCd* Instance) : ServerInstance(Instance)
 445 {
 446         para.resize(128);
 447 }
 448
 449 bool CommandParser::FindSym(void** v, void* h, const std::string &name)
 450 {
 451         *v = dlsym(h, "init_command");
 452         const char* err = dlerror();
 453         if (err && !(*v))
 454         {
 455                 ServerInstance->Log(SPARSE, "Error loading core command %s: %s\n", name.c_str(), err);
 456                 return false;
 457         }
 458         return true;
 459 }
 460
 461 bool CommandParser::ReloadCommand(const char* cmd, User* user)
 462 {
 463         char filename[MAXBUF];
 464         char commandname[MAXBUF];
 465         int y = 0;
 466
 467         for (const char* x = cmd; *x; x++, y++)
 468                 commandname[y] = toupper(*x);
 469
 470         commandname[y] = 0;
 471
 472         SharedObjectList::iterator command = RFCCommands.find(commandname);
 473
 474         if (command != RFCCommands.end())
 475         {
 476                 Command* cmdptr = cmdlist.find(commandname)->second;
 477                 cmdlist.erase(cmdlist.find(commandname));
 478
 479                 for (char* x = commandname; *x; x++)
 480                         *x = tolower(*x);
 481
 482
 483                 delete cmdptr;
 484                 dlclose(command->second);
 485                 RFCCommands.erase(command);
 486
 487                 snprintf(filename, MAXBUF, "cmd_%s.so", commandname);
 488                 const char* err = this->LoadCommand(filename);
 489                 if (err)
 490                 {
 491                         if (user)
 492                                 user->WriteServ("NOTICE %s :*** Error loading 'cmd_%s.so': %s", user->nick, cmd, err);
 493                         return false;
 494                 }
 495
 496                 return true;
 497         }
 498
 499         return false;
 500 }
 501
 502 CmdResult cmd_reload::Handle(const char** parameters, int /* pcnt */, User *user)
 503 {
 504         user->WriteServ("NOTICE %s :*** Reloading command '%s'",user->nick, parameters[0]);
 505         if (ServerInstance->Parser->ReloadCommand(parameters[0], user))
 506         {
 507                 user->WriteServ("NOTICE %s :*** Successfully reloaded command '%s'", user->nick, parameters[0]);
 508                 ServerInstance->WriteOpers("*** RELOAD: %s reloaded the '%s' command.", user->nick, parameters[0]);
 509                 return CMD_SUCCESS;
 510         }
 511         else
 512         {
 513                 user->WriteServ("NOTICE %s :*** Could not reload command '%s' -- fix this problem, then /REHASH as soon as possible!", user->nick, parameters[0]);
 514                 return CMD_FAILURE;
 515         }
 516 }
 517
 518 const char* CommandParser::LoadCommand(const char* name)
 519 {
 520         char filename[MAXBUF];
 521         void* h;
 522         Command* (*cmd_factory_func)(InspIRCd*);
 523
 524         /* Command already exists? Succeed silently - this is needed for REHASH */
 525         if (RFCCommands.find(name) != RFCCommands.end())
 526         {
 527                 ServerInstance->Log(DEBUG,"Not reloading command %s/%s, it already exists", LIBRARYDIR, name);
 528                 return NULL;
 529         }
 530
 531         snprintf(filename, MAXBUF, "%s/%s", LIBRARYDIR, name);
 532         h = dlopen(filename, RTLD_NOW | RTLD_GLOBAL);
 533
 534         if (!h)
 535         {
 536                 const char* n = dlerror();
 537                 ServerInstance->Log(SPARSE, "Error loading core command %s: %s", name, n);
 538                 return n;
 539         }
 540
 541         if (this->FindSym((void **)&cmd_factory_func, h, name))
 542         {
 543                 Command* newcommand = cmd_factory_func(ServerInstance);
 544                 this->CreateCommand(newcommand, h);
 545         }
 546         return NULL;
 547 }
 548
 549 void CommandParser::SetupCommandTable(User* user)
 550 {
 551         RFCCommands.clear();
 552
 553         if (!user)
 554         {
 555                 printf("\nLoading core commands");
 556                 fflush(stdout);
 557         }
 558
 559         DIR* library = opendir(LIBRARYDIR);
 560         if (library)
 561         {
 562                 dirent* entry = NULL;
 563                 while ((entry = readdir(library)))
 564                 {
 565                         if (match(entry->d_name, "cmd_*.so"))
 566                         {
 567                                 if (!user)
 568                                 {
 569                                         printf(".");
 570                                         fflush(stdout);
 571                                 }
 572                                 const char* err = this->LoadCommand(entry->d_name);
 573                                 if (err)
 574                                 {
 575                                         if (user)
 576                                         {
 577                                                 user->WriteServ("NOTICE %s :*** Failed to load core command %s: %s", user->nick, entry->d_name, err);
 578                                         }
 579                                         else
 580                                         {
 581                                                 printf("Error loading %s: %s", entry->d_name, err);
 582                                                 exit(EXIT_STATUS_BADHANDLER);
 583                                         }
 584                                 }
 585                         }
 586                 }
 587                 closedir(library);
 588                 if (!user)
 589                         printf("\n");
 590         }
 591
 592         if (cmdlist.find("RELOAD") == cmdlist.end())
 593                 this->CreateCommand(new cmd_reload(ServerInstance));
 594 }
 595
 596 int CommandParser::TranslateUIDs(TranslateType to, const std::string &source, std::string &dest)
 597 {
 598         User* user = NULL;
 599         std::string item;
 600         int translations = 0;
 601         dest.clear();
 602
 603         switch (to)
 604         {
 605                 case TR_NICK:
 606                         /* Translate single nickname */
 607                         user = ServerInstance->FindNick(source);
 608                         if (user)
 609                         {
 610                                 dest = user->uuid;
 611                                 translations++;
 612                         }
 613                         else
 614                                 dest = source;
 615                 break;
 616                 case TR_NICKLIST:
 617                 {
 618                         /* Translate comma seperated list of nicknames */
 619                         irc::commasepstream items(source);
 620                         while (items.GetToken(item))
 621                         {
 622                                 user = ServerInstance->FindNick(item);
 623                                 if (user)
 624                                 {
 625                                         dest.append(user->uuid);
 626                                         translations++;
 627                                 }
 628                                 else
 629                                         dest.append(item);
 630                                 dest.append(",");
 631                         }
 632                         if (!dest.empty())
 633                                 dest.erase(dest.end() - 1);
 634                 }
 635                 break;
 636                 case TR_SPACENICKLIST:
 637                 {
 638                         /* Translate space seperated list of nicknames */
 639                         irc::spacesepstream items(source);
 640                         while (items.GetToken(item))
 641                         {
 642                                 user = ServerInstance->FindNick(item);
 643                                 if (user)
 644                                 {
 645                                         dest.append(user->uuid);
 646                                         translations++;
 647                                 }
 648                                 else
 649                                         dest.append(item);
 650                                 dest.append(" ");
 651                         }
 652                         if (!dest.empty())
 653                                 dest.erase(dest.end() - 1);
 654                 }
 655                 break;
 656                 case TR_END:
 657                 case TR_TEXT:
 658                 default:
 659                         /* Do nothing */
 660                         dest = source;
 661                 break;
 662         }
 663
 664         return translations;
 665 }
 666