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 (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         std::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         Commandtable::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)
 122 {
 123         Commandtable::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                                 return n->second->Handle(parameters,user);
 154                         }
 155                 }
 156         }
 157         return CMD_INVALID;
 158 }
 159
 160 void CommandParser::ProcessCommand(LocalUser *user, std::string &cmd)
 161 {
 162         std::vector<std::string> command_p;
 163         irc::tokenstream tokens(cmd);
 164         std::string command, token;
 165         tokens.GetToken(command);
 166
 167         /* A client sent a nick prefix on their command (ick)
 168          * rhapsody and some braindead bouncers do this --
 169          * the rfc says they shouldnt but also says the ircd should
 170          * discard it if they do.
 171          */
 172         if (command[0] == ':')
 173                 tokens.GetToken(command);
 174
 175         while (tokens.GetToken(token))
 176                 command_p.push_back(token);
 177
 178         std::transform(command.begin(), command.end(), command.begin(), ::toupper);
 179
 180         /* find the command, check it exists */
 181         Command* handler = GetHandler(command);
 182
 183         /* Modify the user's penalty regardless of whether or not the command exists */
 184         if (!user->HasPrivPermission("users/flood/no-throttle"))
 185         {
 186                 // If it *doesn't* exist, give it a slightly heftier penalty than normal to deter flooding us crap
 187                 user->CommandFloodPenalty += handler ? handler->Penalty * 1000 : 2000;
 188         }
 189
 190         if (!handler)
 191         {
 192                 ModResult MOD_RESULT;
 193                 FIRST_MOD_RESULT(OnPreCommand, MOD_RESULT, (command, command_p, user, false, cmd));
 194                 if (MOD_RESULT == MOD_RES_DENY)
 195                         return;
 196
 197                 /*
 198                  * This double lookup is in case a module (abbreviation) wishes to change a command.
 199                  * Sure, the double lookup is a bit painful, but bear in mind this only happens for unknowns anyway.
 200                  *
 201                  * Thanks dz for making me actually understand why this is necessary!
 202                  * -- w00t
 203                  */
 204                 handler = GetHandler(command);
 205                 if (!handler)
 206                 {
 207                         if (user->registered == REG_ALL)
 208                                 user->WriteNumeric(ERR_UNKNOWNCOMMAND, "%s :Unknown command",command.c_str());
 209                         ServerInstance->stats->statsUnknown++;
 210                         return;
 211                 }
 212         }
 213
 214         // If we were given more parameters than max_params then append the excess parameter(s)
 215         // to command_p[maxparams-1], i.e. to the last param that is still allowed
 216         if (handler->max_params && command_p.size() > handler->max_params)
 217         {
 218                 /*
 219                  * command_p input (assuming max_params 1):
 220                  *      this
 221                  *      is
 222                  *      a
 223                  *      test
 224                  */
 225
 226                 // Iterator to the last parameter that will be kept
 227                 const std::vector<std::string>::iterator lastkeep = command_p.begin() + (handler->max_params - 1);
 228                 // Iterator to the first excess parameter
 229                 const std::vector<std::string>::iterator firstexcess = lastkeep + 1;
 230
 231                 // Append all excess parameter(s) to the last parameter, seperated by spaces
 232                 for (std::vector<std::string>::const_iterator i = firstexcess; i != command_p.end(); ++i)
 233                 {
 234                         lastkeep->push_back(' ');
 235                         lastkeep->append(*i);
 236                 }
 237
 238                 // Erase the excess parameter(s)
 239                 command_p.erase(firstexcess, command_p.end());
 240         }
 241
 242         /*
 243          * We call OnPreCommand here seperately if the command exists, so the magic above can
 244          * truncate to max_params if necessary. -- w00t
 245          */
 246         ModResult MOD_RESULT;
 247         FIRST_MOD_RESULT(OnPreCommand, MOD_RESULT, (command, command_p, user, false, cmd));
 248         if (MOD_RESULT == MOD_RES_DENY)
 249                 return;
 250
 251         /* activity resets the ping pending timer */
 252         user->nping = ServerInstance->Time() + user->MyClass->GetPingTime();
 253
 254         if (handler->flags_needed)
 255         {
 256                 if (!user->IsModeSet(handler->flags_needed))
 257                 {
 258                         user->WriteNumeric(ERR_NOPRIVILEGES, ":Permission Denied - You do not have the required operator privileges");
 259                         return;
 260                 }
 261
 262                 if (!user->HasPermission(command))
 263                 {
 264                         user->WriteNumeric(ERR_NOPRIVILEGES, ":Permission Denied - Oper type %s does not have access to command %s",
 265                                 user->oper->name.c_str(), command.c_str());
 266                         return;
 267                 }
 268         }
 269
 270         if ((user->registered == REG_ALL) && (!user->IsOper()) && (handler->IsDisabled()))
 271         {
 272                 /* command is disabled! */
 273                 if (ServerInstance->Config->DisabledDontExist)
 274                 {
 275                         user->WriteNumeric(ERR_UNKNOWNCOMMAND, "%s :Unknown command", command.c_str());
 276                 }
 277                 else
 278                 {
 279                         user->WriteNumeric(ERR_UNKNOWNCOMMAND, "%s :This command has been disabled.", command.c_str());
 280                 }
 281
 282                 ServerInstance->SNO->WriteToSnoMask('t', "%s denied for %s (%s@%s)",
 283                                 command.c_str(), user->nick.c_str(), user->ident.c_str(), user->host.c_str());
 284                 return;
 285         }
 286
 287         if ((!command_p.empty()) && (command_p.back().empty()) && (!handler->allow_empty_last_param))
 288                 command_p.pop_back();
 289
 290         if (command_p.size() < handler->min_params)
 291         {
 292                 user->WriteNumeric(ERR_NEEDMOREPARAMS, "%s :Not enough parameters.", command.c_str());
 293                 if ((ServerInstance->Config->SyntaxHints) && (user->registered == REG_ALL) && (handler->syntax.length()))
 294                         user->WriteNumeric(RPL_SYNTAX, ":SYNTAX %s %s", handler->name.c_str(), handler->syntax.c_str());
 295                 return;
 296         }
 297
 298         if ((user->registered != REG_ALL) && (!handler->WorksBeforeReg()))
 299         {
 300                 user->WriteNumeric(ERR_NOTREGISTERED, "%s :You have not registered",command.c_str());
 301         }
 302         else
 303         {
 304                 /* passed all checks.. first, do the (ugly) stats counters. */
 305                 handler->use_count++;
 306
 307                 /* module calls too */
 308                 FIRST_MOD_RESULT(OnPreCommand, MOD_RESULT, (command, command_p, user, true, cmd));
 309                 if (MOD_RESULT == MOD_RES_DENY)
 310                         return;
 311
 312                 /*
 313                  * WARNING: be careful, the user may be deleted soon
 314                  */
 315                 CmdResult result = handler->Handle(command_p, user);
 316
 317                 FOREACH_MOD(OnPostCommand, (handler, command_p, user, result, cmd));
 318         }
 319 }
 320
 321 void CommandParser::RemoveCommand(Command* x)
 322 {
 323         Commandtable::iterator n = cmdlist.find(x->name);
 324         if (n != cmdlist.end() && n->second == x)
 325                 cmdlist.erase(n);
 326 }
 327
 328 CommandBase::~CommandBase()
 329 {
 330 }
 331
 332 Command::~Command()
 333 {
 334         ServerInstance->Parser->RemoveCommand(this);
 335 }
 336
 337 void CommandParser::ProcessBuffer(std::string &buffer,LocalUser *user)
 338 {
 339         if (buffer.empty())
 340                 return;
 341
 342         ServerInstance->Logs->Log("USERINPUT", LOG_RAWIO, "C[%s] I :%s %s",
 343                 user->uuid.c_str(), user->nick.c_str(), buffer.c_str());
 344         ProcessCommand(user,buffer);
 345 }
 346
 347 bool CommandParser::AddCommand(Command *f)
 348 {
 349         /* create the command and push it onto the table */
 350         if (cmdlist.find(f->name) == cmdlist.end())
 351         {
 352                 cmdlist[f->name] = f;
 353                 return true;
 354         }
 355         return false;
 356 }
 357
 358 CommandParser::CommandParser()
 359 {
 360 }
 361
 362 std::string CommandParser::TranslateUIDs(const std::vector<TranslateType>& to, const std::vector<std::string>& source, bool prefix_final, CommandBase* custom_translator)
 363 {
 364         std::vector<TranslateType>::const_iterator types = to.begin();
 365         std::string dest;
 366
 367         for (unsigned int i = 0; i < source.size(); i++)
 368         {
 369                 TranslateType t = TR_TEXT;
 370                 // They might supply less translation types than parameters,
 371                 // in that case pretend that all remaining types are TR_TEXT
 372                 if (types != to.end())
 373                 {
 374                         t = *types;
 375                         types++;
 376                 }
 377
 378                 bool last = (i == (source.size() - 1));
 379                 if (prefix_final && last)
 380                         dest.push_back(':');
 381
 382                 TranslateSingleParam(t, source[i], dest, custom_translator, i);
 383
 384                 if (!last)
 385                         dest.push_back(' ');
 386         }
 387
 388         return dest;
 389 }
 390
 391 void CommandParser::TranslateSingleParam(TranslateType to, const std::string& item, std::string& dest, CommandBase* custom_translator, unsigned int paramnumber)
 392 {
 393         switch (to)
 394         {
 395                 case TR_NICK:
 396                 {
 397                         /* Translate single nickname */
 398                         User* user = ServerInstance->FindNick(item);
 399                         if (user)
 400                                 dest.append(user->uuid);
 401                         else
 402                                 dest.append(item);
 403                         break;
 404                 }
 405                 case TR_CUSTOM:
 406                 {
 407                         if (custom_translator)
 408                         {
 409                                 std::string translated = item;
 410                                 custom_translator->EncodeParameter(translated, paramnumber);
 411                                 dest.append(translated);
 412                                 break;
 413                         }
 414                         // If no custom translator was given, fall through
 415                 }
 416                 case TR_TEXT:
 417                 default:
 418                         /* Do nothing */
 419                         dest.append(item);
 420                 break;
 421         }
 422 }