src/command_parse.cpp

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
   5  *   Copyright (C) 2006-2008 Robin Burchell <robin+git@viroteck.net>
   6  *   Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
   7  *   Copyright (C) 2005-2008 Craig Edwards <craigedwards@brainbox.cc>
   8  *   Copyright (C) 2006-2007 Dennis Friis <peavey@inspircd.org>
   9  *
  10  * This file is part of InspIRCd.  InspIRCd is free software: you can
  11  * redistribute it and/or modify it under the terms of the GNU General Public
  12  * License as published by the Free Software Foundation, version 2.
  13  *
  14  * This program is distributed in the hope that it will be useful, but WITHOUT
  15  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  16  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  17  * details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21  */
  22
  23
  24 #include "inspircd.h"
  25
  26 bool InspIRCd::PassCompare(Extensible* ex, const std::string& data, const std::string& input, const std::string& hashtype)
  27 {
  28         ModResult res;
  29         FIRST_MOD_RESULT(OnPassCompare, res, (ex, data, input, hashtype));
  30
  31         /* Module matched */
  32         if (res == MOD_RES_ALLOW)
  33                 return true;
  34
  35         /* Module explicitly didnt match */
  36         if (res == MOD_RES_DENY)
  37                 return false;
  38
  39         /* We dont handle any hash types except for plaintext - Thanks tra26 */
  40         if (!hashtype.empty() && hashtype != "plaintext")
  41                 return false;
  42
  43         return TimingSafeCompare(data, input);
  44 }
  45
  46 bool CommandParser::LoopCall(User* user, Command* handler, const std::vector<std::string>& parameters, unsigned int splithere, int extra, bool usemax)
  47 {
  48         if (splithere >= parameters.size())
  49                 return false;
  50
  51         /* First check if we have more than one item in the list, if we don't we return false here and the handler
  52          * which called us just carries on as it was.
  53          */
  54         if (parameters[splithere].find(',') == std::string::npos)
  55                 return false;
  56
  57         /** Some lame ircds will weed out dupes using some shitty O(n^2) algorithm.
  58          * By using std::set (thanks for the idea w00t) we can cut this down a ton.
  59          * ...VOOODOOOO!
  60          *
  61          * Only check for duplicates if there is one list (allow them in JOIN).
  62          */
  63         insp::flat_set<irc::string> dupes;
  64         bool check_dupes = (extra < 0);
  65
  66         /* Create two sepstreams, if we have only one list, then initialize the second sepstream with
  67          * an empty string. The second parameter of the constructor of the sepstream tells whether
  68          * or not to allow empty tokens.
  69          * We allow empty keys, so "JOIN #a,#b ,bkey" will be interpreted as "JOIN #a", "JOIN #b bkey"
  70          */
  71         irc::commasepstream items1(parameters[splithere]);
  72         irc::commasepstream items2(extra >= 0 ? parameters[extra] : "", true);
  73         std::string item;
  74         unsigned int max = 0;
  75         LocalUser* localuser = IS_LOCAL(user);
  76
  77         /* Attempt to iterate these lists and call the command handler
  78          * for every parameter or parameter pair until there are no more
  79          * left to parse.
  80          */
  81         while (items1.GetToken(item) && (!usemax || max++ < ServerInstance->Config->MaxTargets))
  82         {
  83                 if ((!check_dupes) || (dupes.insert(item.c_str()).second))
  84                 {
  85                         std::vector<std::string> new_parameters(parameters);
  86                         new_parameters[splithere] = item;
  87
  88                         if (extra >= 0)
  89                         {
  90                                 // If we have two lists then get the next item from the second list.
  91                                 // In case it runs out of elements then 'item' will be an empty string.
  92                                 items2.GetToken(item);
  93                                 new_parameters[extra] = item;
  94                         }
  95
  96                         CmdResult result = handler->Handle(new_parameters, user);
  97                         if (localuser)
  98                         {
  99                                 // Run the OnPostCommand hook with the last parameter (original line) being empty
 100                                 // to indicate that the command had more targets in its original form.
 101                                 item.clear();
 102                                 FOREACH_MOD(OnPostCommand, (handler, new_parameters, localuser, result, item));
 103                         }
 104                 }
 105         }
 106
 107         return true;
 108 }
 109
 110 Command* CommandParser::GetHandler(const std::string &commandname)
 111 {
 112         CommandMap::iterator n = cmdlist.find(commandname);
 113         if (n != cmdlist.end())
 114                 return n->second;
 115
 116         return NULL;
 117 }
 118
 119 // calls a handler function for a command
 120
 121 CmdResult CommandParser::CallHandler(const std::string& commandname, const std::vector<std::string>& parameters, User* user, Command** cmd)
 122 {
 123         CommandMap::iterator n = cmdlist.find(commandname);
 124
 125         if (n != cmdlist.end())
 126         {
 127                 if ((!parameters.empty()) && (parameters.back().empty()) && (!n->second->allow_empty_last_param))
 128                         return CMD_INVALID;
 129
 130                 if (parameters.size() >= n->second->min_params)
 131                 {
 132                         bool bOkay = false;
 133
 134                         if (IS_LOCAL(user) && n->second->flags_needed)
 135                         {
 136                                 /* if user is local, and flags are needed .. */
 137
 138                                 if (user->IsModeSet(n->second->flags_needed))
 139                                 {
 140                                         /* if user has the flags, and now has the permissions, go ahead */
 141                                         if (user->HasPermission(commandname))
 142                                                 bOkay = true;
 143                                 }
 144                         }
 145                         else
 146                         {
 147                                 /* remote or no flags required anyway */
 148                                 bOkay = true;
 149                         }
 150
 151                         if (bOkay)
 152                         {
 153                                 if (cmd)
 154                                         *cmd = n->second;
 155                                 return n->second->Handle(parameters,user);
 156                         }
 157                 }
 158         }
 159         return CMD_INVALID;
 160 }
 161
 162 void CommandParser::ProcessCommand(LocalUser *user, std::string &cmd)
 163 {
 164         std::vector<std::string> command_p;
 165         irc::tokenstream tokens(cmd);
 166         std::string command, token;
 167         tokens.GetToken(command);
 168
 169         /* A client sent a nick prefix on their command (ick)
 170          * rhapsody and some braindead bouncers do this --
 171          * the rfc says they shouldnt but also says the ircd should
 172          * discard it if they do.
 173          */
 174         if (command[0] == ':')
 175                 tokens.GetToken(command);
 176
 177         while (tokens.GetToken(token))
 178                 command_p.push_back(token);
 179
 180         std::transform(command.begin(), command.end(), command.begin(), ::toupper);
 181
 182         /* find the command, check it exists */
 183         Command* handler = GetHandler(command);
 184
 185         // Penalty to give if the command fails before the handler is executed
 186         unsigned int failpenalty = 0;
 187
 188         /* Modify the user's penalty regardless of whether or not the command exists */
 189         if (!user->HasPrivPermission("users/flood/no-throttle"))
 190         {
 191                 // If it *doesn't* exist, give it a slightly heftier penalty than normal to deter flooding us crap
 192                 unsigned int penalty = (handler ? handler->Penalty * 1000 : 2000);
 193                 user->CommandFloodPenalty += penalty;
 194
 195                 // Increase their penalty later if we fail and the command has 0 penalty by default (i.e. in Command::Penalty) to
 196                 // throttle sending ERR_* from the command parser. If the command does have a non-zero penalty then this is not
 197                 // needed because we've increased their penalty above.
 198                 if (penalty == 0)
 199                         failpenalty = 1000;
 200         }
 201
 202         if (!handler)
 203         {
 204                 ModResult MOD_RESULT;
 205                 FIRST_MOD_RESULT(OnPreCommand, MOD_RESULT, (command, command_p, user, false, cmd));
 206                 if (MOD_RESULT == MOD_RES_DENY)
 207                         return;
 208
 209                 /*
 210                  * This double lookup is in case a module (abbreviation) wishes to change a command.
 211                  * Sure, the double lookup is a bit painful, but bear in mind this only happens for unknowns anyway.
 212                  *
 213                  * Thanks dz for making me actually understand why this is necessary!
 214                  * -- w00t
 215                  */
 216                 handler = GetHandler(command);
 217                 if (!handler)
 218                 {
 219                         if (user->registered == REG_ALL)
 220                                 user->WriteNumeric(ERR_UNKNOWNCOMMAND, "%s :Unknown command",command.c_str());
 221                         ServerInstance->stats.Unknown++;
 222                         return;
 223                 }
 224         }
 225
 226         // If we were given more parameters than max_params then append the excess parameter(s)
 227         // to command_p[maxparams-1], i.e. to the last param that is still allowed
 228         if (handler->max_params && command_p.size() > handler->max_params)
 229         {
 230                 /*
 231                  * command_p input (assuming max_params 1):
 232                  *      this
 233                  *      is
 234                  *      a
 235                  *      test
 236                  */
 237
 238                 // Iterator to the last parameter that will be kept
 239                 const std::vector<std::string>::iterator lastkeep = command_p.begin() + (handler->max_params - 1);
 240                 // Iterator to the first excess parameter
 241                 const std::vector<std::string>::iterator firstexcess = lastkeep + 1;
 242
 243                 // Append all excess parameter(s) to the last parameter, seperated by spaces
 244                 for (std::vector<std::string>::const_iterator i = firstexcess; i != command_p.end(); ++i)
 245                 {
 246                         lastkeep->push_back(' ');
 247                         lastkeep->append(*i);
 248                 }
 249
 250                 // Erase the excess parameter(s)
 251                 command_p.erase(firstexcess, command_p.end());
 252         }
 253
 254         /*
 255          * We call OnPreCommand here seperately if the command exists, so the magic above can
 256          * truncate to max_params if necessary. -- w00t
 257          */
 258         ModResult MOD_RESULT;
 259         FIRST_MOD_RESULT(OnPreCommand, MOD_RESULT, (command, command_p, user, false, cmd));
 260         if (MOD_RESULT == MOD_RES_DENY)
 261                 return;
 262
 263         /* activity resets the ping pending timer */
 264         user->nping = ServerInstance->Time() + user->MyClass->GetPingTime();
 265
 266         if (handler->flags_needed)
 267         {
 268                 if (!user->IsModeSet(handler->flags_needed))
 269                 {
 270                         user->CommandFloodPenalty += failpenalty;
 271                         user->WriteNumeric(ERR_NOPRIVILEGES, ":Permission Denied - You do not have the required operator privileges");
 272                         return;
 273                 }
 274
 275                 if (!user->HasPermission(command))
 276                 {
 277                         user->CommandFloodPenalty += failpenalty;
 278                         user->WriteNumeric(ERR_NOPRIVILEGES, ":Permission Denied - Oper type %s does not have access to command %s",
 279                                 user->oper->name.c_str(), command.c_str());
 280                         return;
 281                 }
 282         }
 283
 284         if ((user->registered == REG_ALL) && (!user->IsOper()) && (handler->IsDisabled()))
 285         {
 286                 /* command is disabled! */
 287                 user->CommandFloodPenalty += failpenalty;
 288                 if (ServerInstance->Config->DisabledDontExist)
 289                 {
 290                         user->WriteNumeric(ERR_UNKNOWNCOMMAND, "%s :Unknown command", command.c_str());
 291                 }
 292                 else
 293                 {
 294                         user->WriteNumeric(ERR_UNKNOWNCOMMAND, "%s :This command has been disabled.", command.c_str());
 295                 }
 296
 297                 ServerInstance->SNO->WriteToSnoMask('a', "%s denied for %s (%s@%s)",
 298                                 command.c_str(), user->nick.c_str(), user->ident.c_str(), user->host.c_str());
 299                 return;
 300         }
 301
 302         if ((!command_p.empty()) && (command_p.back().empty()) && (!handler->allow_empty_last_param))
 303                 command_p.pop_back();
 304
 305         if (command_p.size() < handler->min_params)
 306         {
 307                 user->CommandFloodPenalty += failpenalty;
 308                 user->WriteNumeric(ERR_NEEDMOREPARAMS, "%s :Not enough parameters.", command.c_str());
 309                 if ((ServerInstance->Config->SyntaxHints) && (user->registered == REG_ALL) && (handler->syntax.length()))
 310                         user->WriteNumeric(RPL_SYNTAX, ":SYNTAX %s %s", handler->name.c_str(), handler->syntax.c_str());
 311                 return;
 312         }
 313
 314         if ((user->registered != REG_ALL) && (!handler->WorksBeforeReg()))
 315         {
 316                 user->CommandFloodPenalty += failpenalty;
 317                 user->WriteNumeric(ERR_NOTREGISTERED, "%s :You have not registered",command.c_str());
 318         }
 319         else
 320         {
 321                 /* passed all checks.. first, do the (ugly) stats counters. */
 322                 handler->use_count++;
 323
 324                 /* module calls too */
 325                 FIRST_MOD_RESULT(OnPreCommand, MOD_RESULT, (command, command_p, user, true, cmd));
 326                 if (MOD_RESULT == MOD_RES_DENY)
 327                         return;
 328
 329                 /*
 330                  * WARNING: be careful, the user may be deleted soon
 331                  */
 332                 CmdResult result = handler->Handle(command_p, user);
 333
 334                 FOREACH_MOD(OnPostCommand, (handler, command_p, user, result, cmd));
 335         }
 336 }
 337
 338 void CommandParser::RemoveCommand(Command* x)
 339 {
 340         CommandMap::iterator n = cmdlist.find(x->name);
 341         if (n != cmdlist.end() && n->second == x)
 342                 cmdlist.erase(n);
 343 }
 344
 345 CommandBase::CommandBase(Module* mod, const std::string& cmd, unsigned int minpara, unsigned int maxpara)
 346         : ServiceProvider(mod, cmd, SERVICE_COMMAND)
 347         , flags_needed(0)
 348         , min_params(minpara)
 349         , max_params(maxpara)
 350         , use_count(0)
 351         , disabled(false)
 352         , works_before_reg(false)
 353         , allow_empty_last_param(true)
 354         , Penalty(1)
 355 {
 356 }
 357
 358 CommandBase::~CommandBase()
 359 {
 360 }
 361
 362 void CommandBase::EncodeParameter(std::string& parameter, int index)
 363 {
 364 }
 365
 366 RouteDescriptor CommandBase::GetRouting(User* user, const std::vector<std::string>& parameters)
 367 {
 368         return ROUTE_LOCALONLY;
 369 }
 370
 371 Command::Command(Module* mod, const std::string& cmd, unsigned int minpara, unsigned int maxpara)
 372         : CommandBase(mod, cmd, minpara, maxpara)
 373         , force_manual_route(false)
 374 {
 375 }
 376
 377 Command::~Command()
 378 {
 379         ServerInstance->Parser.RemoveCommand(this);
 380 }
 381
 382 void Command::RegisterService()
 383 {
 384         if (!ServerInstance->Parser.AddCommand(this))
 385                 throw ModuleException("Command already exists: " + name);
 386 }
 387
 388 void CommandParser::ProcessBuffer(std::string &buffer,LocalUser *user)
 389 {
 390         if (buffer.empty())
 391                 return;
 392
 393         ServerInstance->Logs->Log("USERINPUT", LOG_RAWIO, "C[%s] I :%s %s",
 394                 user->uuid.c_str(), user->nick.c_str(), buffer.c_str());
 395         ProcessCommand(user,buffer);
 396 }
 397
 398 bool CommandParser::AddCommand(Command *f)
 399 {
 400         /* create the command and push it onto the table */
 401         if (cmdlist.find(f->name) == cmdlist.end())
 402         {
 403                 cmdlist[f->name] = f;
 404                 return true;
 405         }
 406         return false;
 407 }
 408
 409 CommandParser::CommandParser()
 410 {
 411 }
 412
 413 std::string CommandParser::TranslateUIDs(const std::vector<TranslateType>& to, const std::vector<std::string>& source, bool prefix_final, CommandBase* custom_translator)
 414 {
 415         std::vector<TranslateType>::const_iterator types = to.begin();
 416         std::string dest;
 417
 418         for (unsigned int i = 0; i < source.size(); i++)
 419         {
 420                 TranslateType t = TR_TEXT;
 421                 // They might supply less translation types than parameters,
 422                 // in that case pretend that all remaining types are TR_TEXT
 423                 if (types != to.end())
 424                 {
 425                         t = *types;
 426                         types++;
 427                 }
 428
 429                 bool last = (i == (source.size() - 1));
 430                 if (prefix_final && last)
 431                         dest.push_back(':');
 432
 433                 TranslateSingleParam(t, source[i], dest, custom_translator, i);
 434
 435                 if (!last)
 436                         dest.push_back(' ');
 437         }
 438
 439         return dest;
 440 }
 441
 442 void CommandParser::TranslateSingleParam(TranslateType to, const std::string& item, std::string& dest, CommandBase* custom_translator, unsigned int paramnumber)
 443 {
 444         switch (to)
 445         {
 446                 case TR_NICK:
 447                 {
 448                         /* Translate single nickname */
 449                         User* user = ServerInstance->FindNick(item);
 450                         if (user)
 451                                 dest.append(user->uuid);
 452                         else
 453                                 dest.append(item);
 454                         break;
 455                 }
 456                 case TR_CUSTOM:
 457                 {
 458                         if (custom_translator)
 459                         {
 460                                 std::string translated = item;
 461                                 custom_translator->EncodeParameter(translated, paramnumber);
 462                                 dest.append(translated);
 463                                 break;
 464                         }
 465                         // If no custom translator was given, fall through
 466                 }
 467                 case TR_TEXT:
 468                 default:
 469                         /* Do nothing */
 470                         dest.append(item);
 471                 break;
 472         }
 473 }