]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/command_parse.cpp
Add support for blocking tag messages with the deaf mode.
[user/henk/code/inspircd.git] / src / command_parse.cpp
index 721bc2c61a0e9ce162321b675552204716e7bd18..f4d8f377c57827729814e8739d8636900db427d2 100644 (file)
@@ -1,11 +1,13 @@
 /*
  * InspIRCd -- Internet Relay Chat Daemon
  *
+ *   Copyright (C) 2014, 2018-2020 Sadie Powell <sadie@witchery.services>
+ *   Copyright (C) 2012-2016, 2018 Attila Molnar <attilamolnar@hush.com>
+ *   Copyright (C) 2012 Robby <robby@chatbelgie.be>
  *   Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
- *   Copyright (C) 2006-2008 Robin Burchell <robin+git@viroteck.net>
- *   Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
- *   Copyright (C) 2005-2008 Craig Edwards <craigedwards@brainbox.cc>
- *   Copyright (C) 2006-2007 Dennis Friis <peavey@inspircd.org>
+ *   Copyright (C) 2007-2009 Robin Burchell <robin+git@viroteck.net>
+ *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
+ *   Copyright (C) 2005-2008, 2010 Craig Edwards <brain@inspircd.org>
  *
  * This file is part of InspIRCd.  InspIRCd is free software: you can
  * redistribute it and/or modify it under the terms of the GNU General Public
 
 #include "inspircd.h"
 
-int InspIRCd::PassCompare(Extensible* ex, const std::string &data, const std::string &input, const std::string &hashtype)
+bool InspIRCd::PassCompare(Extensible* ex, const std::string& data, const std::string& input, const std::string& hashtype)
 {
        ModResult res;
        FIRST_MOD_RESULT(OnPassCompare, res, (ex, data, input, hashtype));
 
        /* Module matched */
        if (res == MOD_RES_ALLOW)
-               return 0;
+               return true;
 
        /* Module explicitly didnt match */
        if (res == MOD_RES_DENY)
-               return 1;
+               return false;
 
        /* We dont handle any hash types except for plaintext - Thanks tra26 */
-       if (!hashtype.empty() && hashtype != "plaintext")
-               /* See below. 1 because they dont match */
-               return 1;
+       if (!hashtype.empty() && !stdalgo::string::equalsci(hashtype, "plaintext"))
+               return false;
 
-       return (data != input); // this seems back to front, but returns 0 if they *match*, 1 else
+       return TimingSafeCompare(data, input);
 }
 
-/* LoopCall is used to call a command classes handler repeatedly based on the contents of a comma seperated list.
- * There are two overriden versions of this method, one of which takes two potential lists and the other takes one.
- * We need a version which takes two potential lists for JOIN, because a JOIN may contain two lists of items at once,
- * the channel names and their keys as follows:
- * JOIN #chan1,#chan2,#chan3 key1,,key3
- * Therefore, we need to deal with both lists concurrently. The first instance of this method does that by creating
- * two instances of irc::commasepstream and reading them both together until the first runs out of tokens.
- * The second version is much simpler and just has the one stream to read, and is used in NAMES, WHOIS, PRIVMSG etc.
- * Both will only parse until they reach ServerInstance->Config->MaxTargets number of targets, to stop abuse via spam.
- */
-int CommandParser::LoopCall(User* user, Command* CommandObj, const std::vector<std::string>& parameters, unsigned int splithere, int extra, bool usemax)
+bool CommandParser::LoopCall(User* user, Command* handler, const CommandBase::Params& parameters, unsigned int splithere, int extra, bool usemax)
 {
        if (splithere >= parameters.size())
-               return 0;
-
-       if (extra >= (signed)parameters.size())
-               extra = -1;
+               return false;
 
-       /* First check if we have more than one item in the list, if we don't we return zero here and the handler
+       /* First check if we have more than one item in the list, if we don't we return false here and the handler
         * which called us just carries on as it was.
         */
        if (parameters[splithere].find(',') == std::string::npos)
-               return 0;
+               return false;
 
        /** Some lame ircds will weed out dupes using some shitty O(n^2) algorithm.
         * By using std::set (thanks for the idea w00t) we can cut this down a ton.
         * ...VOOODOOOO!
+        *
+        * Only check for duplicates if there is one list (allow them in JOIN).
         */
-       std::set<irc::string> dupes;
+       insp::flat_set<std::string, irc::insensitive_swo> dupes;
+       bool check_dupes = (extra < 0);
 
-       /* Create two lists, one for channel names, one for keys
+       /* Create two sepstreams, if we have only one list, then initialize the second sepstream with
+        * an empty string. The second parameter of the constructor of the sepstream tells whether
+        * or not to allow empty tokens.
+        * We allow empty keys, so "JOIN #a,#b ,bkey" will be interpreted as "JOIN #a", "JOIN #b bkey"
         */
        irc::commasepstream items1(parameters[splithere]);
-       irc::commasepstream items2(extra >= 0 ? parameters[extra] : "");
-       std::string extrastuff;
+       irc::commasepstream items2(extra >= 0 ? parameters[extra] : "", true);
        std::string item;
        unsigned int max = 0;
+       LocalUser* localuser = IS_LOCAL(user);
 
-       /* Attempt to iterate these lists and call the command objech
-        * which called us, for every parameter pair until there are
-        * no more left to parse.
+       /* Attempt to iterate these lists and call the command handler
+        * for every parameter or parameter pair until there are no more
+        * left to parse.
         */
+       CommandBase::Params splitparams(parameters);
        while (items1.GetToken(item) && (!usemax || max++ < ServerInstance->Config->MaxTargets))
        {
-               if (dupes.find(item.c_str()) == dupes.end())
+               if ((!check_dupes) || (dupes.insert(item).second))
                {
-                       std::vector<std::string> new_parameters(parameters);
+                       splitparams[splithere] = item;
 
-                       if (!items2.GetToken(extrastuff))
-                               extrastuff.clear();
-
-                       new_parameters[splithere] = item;
                        if (extra >= 0)
-                               new_parameters[extra] = extrastuff;
-
-                       CommandObj->Handle(new_parameters, user);
-
-                       dupes.insert(item.c_str());
-               }
-       }
-       return 1;
-}
-
-bool CommandParser::IsValidCommand(const std::string &commandname, unsigned int pcnt, User * user)
-{
-       Commandtable::iterator n = cmdlist.find(commandname);
-
-       if (n != cmdlist.end())
-       {
-               if ((pcnt >= n->second->min_params))
-               {
-                       if (IS_LOCAL(user) && n->second->flags_needed)
                        {
-                               if (user->IsModeSet(n->second->flags_needed))
-                               {
-                                       return (user->HasPermission(commandname));
-                               }
+                               // If we have two lists then get the next item from the second list.
+                               // In case it runs out of elements then 'item' will be an empty string.
+                               items2.GetToken(item);
+                               splitparams[extra] = item;
                        }
-                       else
+
+                       CmdResult result = handler->Handle(user, splitparams);
+                       if (localuser)
                        {
-                               return true;
+                               // Run the OnPostCommand hook with the last parameter being true to indicate
+                               // that the event is being called in a loop.
+                               item.clear();
+                               FOREACH_MOD(OnPostCommand, (handler, splitparams, localuser, result, true));
                        }
                }
        }
-       return false;
+
+       return true;
 }
 
 Command* CommandParser::GetHandler(const std::string &commandname)
 {
-       Commandtable::iterator n = cmdlist.find(commandname);
+       CommandMap::iterator n = cmdlist.find(commandname);
        if (n != cmdlist.end())
                return n->second;
 
@@ -142,9 +120,9 @@ Command* CommandParser::GetHandler(const std::string &commandname)
 
 // calls a handler function for a command
 
-CmdResult CommandParser::CallHandler(const std::string &commandname, const std::vector<std::string>& parameters, User *user)
+CmdResult CommandParser::CallHandler(const std::string& commandname, const CommandBase::Params& parameters, User* user, Command** cmd)
 {
-       Commandtable::iterator n = cmdlist.find(commandname);
+       CommandMap::iterator n = cmdlist.find(commandname);
 
        if (n != cmdlist.end())
        {
@@ -162,7 +140,7 @@ CmdResult CommandParser::CallHandler(const std::string &commandname, const std::
                                if (user->IsModeSet(n->second->flags_needed))
                                {
                                        /* if user has the flags, and now has the permissions, go ahead */
-                                       if (user->HasPermission(commandname))
+                                       if (user->HasCommandPermission(commandname))
                                                bOkay = true;
                                }
                        }
@@ -174,51 +152,48 @@ CmdResult CommandParser::CallHandler(const std::string &commandname, const std::
 
                        if (bOkay)
                        {
-                               return n->second->Handle(parameters,user);
+                               if (cmd)
+                                       *cmd = n->second;
+
+                               ClientProtocol::TagMap tags;
+                               return n->second->Handle(user, CommandBase::Params(parameters, tags));
                        }
                }
        }
        return CMD_INVALID;
 }
 
-bool CommandParser::ProcessCommand(LocalUser *user, std::string &cmd)
+void CommandParser::ProcessCommand(LocalUser* user, std::string& command, CommandBase::Params& command_p)
 {
-       std::vector<std::string> command_p;
-       irc::tokenstream tokens(cmd);
-       std::string command, token;
-       tokens.GetToken(command);
-
-       /* A client sent a nick prefix on their command (ick)
-        * rhapsody and some braindead bouncers do this --
-        * the rfc says they shouldnt but also says the ircd should
-        * discard it if they do.
-        */
-       if (command[0] == ':')
-               tokens.GetToken(command);
-
-       while (tokens.GetToken(token) && (command_p.size() <= MAXPARAMETERS))
-               command_p.push_back(token);
-
-       std::transform(command.begin(), command.end(), command.begin(), ::toupper);
-
        /* find the command, check it exists */
-       Commandtable::iterator cm = cmdlist.find(command);
+       Command* handler = GetHandler(command);
+
+       // Penalty to give if the command fails before the handler is executed
+       unsigned int failpenalty = 0;
 
        /* Modify the user's penalty regardless of whether or not the command exists */
-       bool do_more = true;
        if (!user->HasPrivPermission("users/flood/no-throttle"))
        {
                // If it *doesn't* exist, give it a slightly heftier penalty than normal to deter flooding us crap
-               user->CommandFloodPenalty += cm != cmdlist.end() ? cm->second->Penalty * 1000 : 2000;
+               unsigned int penalty = (handler ? handler->Penalty * 1000 : 2000);
+               user->CommandFloodPenalty += penalty;
+
+               // Increase their penalty later if we fail and the command has 0 penalty by default (i.e. in Command::Penalty) to
+               // throttle sending ERR_* from the command parser. If the command does have a non-zero penalty then this is not
+               // needed because we've increased their penalty above.
+               if (penalty == 0)
+                       failpenalty = 1000;
        }
 
-
-       if (cm == cmdlist.end())
+       if (!handler)
        {
                ModResult MOD_RESULT;
-               FIRST_MOD_RESULT(OnPreCommand, MOD_RESULT, (command, command_p, user, false, cmd));
+               FIRST_MOD_RESULT(OnPreCommand, MOD_RESULT, (command, command_p, user, false));
                if (MOD_RESULT == MOD_RES_DENY)
-                       return true;
+               {
+                       FOREACH_MOD(OnCommandBlocked, (command, command_p, user));
+                       return;
+               }
 
                /*
                 * This double lookup is in case a module (abbreviation) wishes to change a command.
@@ -227,19 +202,21 @@ bool CommandParser::ProcessCommand(LocalUser *user, std::string &cmd)
                 * Thanks dz for making me actually understand why this is necessary!
                 * -- w00t
                 */
-               cm = cmdlist.find(command);
-               if (cm == cmdlist.end())
+               handler = GetHandler(command);
+               if (!handler)
                {
                        if (user->registered == REG_ALL)
-                               user->WriteNumeric(ERR_UNKNOWNCOMMAND, "%s %s :Unknown command",user->nick.c_str(),command.c_str());
-                       ServerInstance->stats->statsUnknown++;
-                       return true;
+                               user->WriteNumeric(ERR_UNKNOWNCOMMAND, command, "Unknown command");
+
+                       ServerInstance->stats.Unknown++;
+                       FOREACH_MOD(OnCommandBlocked, (command, command_p, user));
+                       return;
                }
        }
 
        // If we were given more parameters than max_params then append the excess parameter(s)
        // to command_p[maxparams-1], i.e. to the last param that is still allowed
-       if (cm->second->max_params && command_p.size() > cm->second->max_params)
+       if (handler->max_params && command_p.size() > handler->max_params)
        {
                /*
                 * command_p input (assuming max_params 1):
@@ -250,12 +227,12 @@ bool CommandParser::ProcessCommand(LocalUser *user, std::string &cmd)
                 */
 
                // Iterator to the last parameter that will be kept
-               const std::vector<std::string>::iterator lastkeep = command_p.begin() + (cm->second->max_params - 1);
+               const CommandBase::Params::iterator lastkeep = command_p.begin() + (handler->max_params - 1);
                // Iterator to the first excess parameter
-               const std::vector<std::string>::iterator firstexcess = lastkeep + 1;
+               const CommandBase::Params::iterator firstexcess = lastkeep + 1;
 
-               // Append all excess parameter(s) to the last parameter, seperated by spaces
-               for (std::vector<std::string>::const_iterator i = firstexcess; i != command_p.end(); ++i)
+               // Append all excess parameter(s) to the last parameter, separated by spaces
+               for (CommandBase::Params::const_iterator i = firstexcess; i != command_p.end(); ++i)
                {
                        lastkeep->push_back(' ');
                        lastkeep->append(*i);
@@ -266,104 +243,97 @@ bool CommandParser::ProcessCommand(LocalUser *user, std::string &cmd)
        }
 
        /*
-        * We call OnPreCommand here seperately if the command exists, so the magic above can
+        * We call OnPreCommand here separately if the command exists, so the magic above can
         * truncate to max_params if necessary. -- w00t
         */
        ModResult MOD_RESULT;
-       FIRST_MOD_RESULT(OnPreCommand, MOD_RESULT, (command, command_p, user, false, cmd));
+       FIRST_MOD_RESULT(OnPreCommand, MOD_RESULT, (command, command_p, user, false));
        if (MOD_RESULT == MOD_RES_DENY)
-               return true;
+       {
+               FOREACH_MOD(OnCommandBlocked, (command, command_p, user));
+               return;
+       }
 
        /* activity resets the ping pending timer */
-       user->nping = ServerInstance->Time() + user->MyClass->GetPingTime();
+       user->nextping = ServerInstance->Time() + user->MyClass->GetPingTime();
 
-       if (cm->second->flags_needed)
+       if (handler->flags_needed)
        {
-               if (!user->IsModeSet(cm->second->flags_needed))
+               if (!user->IsModeSet(handler->flags_needed))
                {
-                       user->WriteNumeric(ERR_NOPRIVILEGES, "%s :Permission Denied - You do not have the required operator privileges",user->nick.c_str());
-                       return do_more;
+                       user->CommandFloodPenalty += failpenalty;
+                       user->WriteNumeric(ERR_NOPRIVILEGES, "Permission Denied - You do not have the required operator privileges");
+                       FOREACH_MOD(OnCommandBlocked, (command, command_p, user));
+                       return;
                }
-               if (!user->HasPermission(command))
-               {
-                       user->WriteNumeric(ERR_NOPRIVILEGES, "%s :Permission Denied - Oper type %s does not have access to command %s",
-                               user->nick.c_str(), user->oper->name.c_str(), command.c_str());
-                       return do_more;
-               }
-       }
-       if ((user->registered == REG_ALL) && (!user->IsOper()) && (cm->second->IsDisabled()))
-       {
-               /* command is disabled! */
-               if (ServerInstance->Config->DisabledDontExist)
-               {
-                       user->WriteNumeric(ERR_UNKNOWNCOMMAND, "%s %s :Unknown command",user->nick.c_str(),command.c_str());
-               }
-               else
+
+               if (!user->HasCommandPermission(command))
                {
-                       user->WriteNumeric(ERR_UNKNOWNCOMMAND, "%s %s :This command has been disabled.",
-                                                                               user->nick.c_str(), command.c_str());
+                       user->CommandFloodPenalty += failpenalty;
+                       user->WriteNumeric(ERR_NOPRIVILEGES, InspIRCd::Format("Permission Denied - Oper type %s does not have access to command %s",
+                               user->oper->name.c_str(), command.c_str()));
+                       FOREACH_MOD(OnCommandBlocked, (command, command_p, user));
+                       return;
                }
-
-               ServerInstance->SNO->WriteToSnoMask('t', "%s denied for %s (%s@%s)",
-                               command.c_str(), user->nick.c_str(), user->ident.c_str(), user->host.c_str());
-               return do_more;
        }
 
-       if ((!command_p.empty()) && (command_p.back().empty()) && (!cm->second->allow_empty_last_param))
+       if ((!command_p.empty()) && (command_p.back().empty()) && (!handler->allow_empty_last_param))
                command_p.pop_back();
 
-       if (command_p.size() < cm->second->min_params)
+       if (command_p.size() < handler->min_params)
        {
-               user->WriteNumeric(ERR_NEEDMOREPARAMS, "%s %s :Not enough parameters.", user->nick.c_str(), command.c_str());
-               if ((ServerInstance->Config->SyntaxHints) && (user->registered == REG_ALL) && (cm->second->syntax.length()))
-                       user->WriteNumeric(RPL_SYNTAX, "%s :SYNTAX %s %s", user->nick.c_str(), cm->second->name.c_str(), cm->second->syntax.c_str());
-               return do_more;
+               user->CommandFloodPenalty += failpenalty;
+               handler->TellNotEnoughParameters(user, command_p);
+               FOREACH_MOD(OnCommandBlocked, (command, command_p, user));
+               return;
        }
-       if ((user->registered != REG_ALL) && (!cm->second->WorksBeforeReg()))
+
+       if ((user->registered != REG_ALL) && (!handler->works_before_reg))
        {
-               user->WriteNumeric(ERR_NOTREGISTERED, "%s :You have not registered",command.c_str());
-               return do_more;
+               user->CommandFloodPenalty += failpenalty;
+               handler->TellNotRegistered(user, command_p);
+               FOREACH_MOD(OnCommandBlocked, (command, command_p, user));
        }
        else
        {
                /* passed all checks.. first, do the (ugly) stats counters. */
-               cm->second->use_count++;
+               handler->use_count++;
 
                /* module calls too */
-               FIRST_MOD_RESULT(OnPreCommand, MOD_RESULT, (command, command_p, user, true, cmd));
+               FIRST_MOD_RESULT(OnPreCommand, MOD_RESULT, (command, command_p, user, true));
                if (MOD_RESULT == MOD_RES_DENY)
-                       return do_more;
+               {
+                       FOREACH_MOD(OnCommandBlocked, (command, command_p, user));
+                       return;
+               }
 
                /*
                 * WARNING: be careful, the user may be deleted soon
                 */
-               CmdResult result = cm->second->Handle(command_p, user);
+               CmdResult result = handler->Handle(user, command_p);
 
-               FOREACH_MOD(I_OnPostCommand,OnPostCommand(command, command_p, user, result,cmd));
-               return do_more;
+               FOREACH_MOD(OnPostCommand, (handler, command_p, user, result, false));
        }
 }
 
 void CommandParser::RemoveCommand(Command* x)
 {
-       Commandtable::iterator n = cmdlist.find(x->name);
+       CommandMap::iterator n = cmdlist.find(x->name);
        if (n != cmdlist.end() && n->second == x)
                cmdlist.erase(n);
 }
 
-Command::~Command()
+void CommandParser::ProcessBuffer(LocalUser* user, const std::string& buffer)
 {
-       ServerInstance->Parser->RemoveCommand(this);
-}
+       ClientProtocol::ParseOutput parseoutput;
+       if (!user->serializer->Parse(user, buffer, parseoutput))
+               return;
 
-bool CommandParser::ProcessBuffer(std::string &buffer,LocalUser *user)
-{
-       if (!user || buffer.empty())
-               return true;
+       std::string& command = parseoutput.cmd;
+       std::transform(command.begin(), command.end(), command.begin(), ::toupper);
 
-       ServerInstance->Logs->Log("USERINPUT", LOG_RAWIO, "C[%s] I :%s %s",
-               user->uuid.c_str(), user->nick.c_str(), buffer.c_str());
-       return ProcessCommand(user,buffer);
+       CommandBase::Params parameters(parseoutput.params, parseoutput.tags);
+       ProcessCommand(user, command, parameters);
 }
 
 bool CommandParser::AddCommand(Command *f)
@@ -379,92 +349,66 @@ bool CommandParser::AddCommand(Command *f)
 
 CommandParser::CommandParser()
 {
-       para.resize(128);
 }
 
-int CommandParser::TranslateUIDs(const std::vector<TranslateType> to, const std::vector<std::string> &source, std::string &dest, bool prefix_final, Command* custom_translator)
+std::string CommandParser::TranslateUIDs(const std::vector<TranslateType>& to, const CommandBase::Params& source, bool prefix_final, CommandBase* custom_translator)
 {
        std::vector<TranslateType>::const_iterator types = to.begin();
-       User* user = NULL;
-       unsigned int i;
-       int translations = 0;
-       dest.clear();
+       std::string dest;
 
-       for(i=0; i < source.size(); i++)
+       for (unsigned int i = 0; i < source.size(); i++)
        {
-               TranslateType t;
-               std::string item = source[i];
-
-               if (types == to.end())
-                       t = TR_TEXT;
-               else
+               TranslateType t = TR_TEXT;
+               // They might supply less translation types than parameters,
+               // in that case pretend that all remaining types are TR_TEXT
+               if (types != to.end())
                {
                        t = *types;
                        types++;
                }
 
-               if (prefix_final && i == source.size() - 1)
-                       dest.append(":");
+               bool last = (i == (source.size() - 1));
+               if (prefix_final && last)
+                       dest.push_back(':');
 
-               switch (t)
-               {
-                       case TR_NICK:
-                               /* Translate single nickname */
-                               user = ServerInstance->FindNick(item);
-                               if (user)
-                               {
-                                       dest.append(user->uuid);
-                                       translations++;
-                               }
-                               else
-                                       dest.append(item);
-                       break;
-                       case TR_CUSTOM:
-                               if (custom_translator)
-                                       custom_translator->EncodeParameter(item, i);
-                               dest.append(item);
-                       break;
-                       case TR_END:
-                       case TR_TEXT:
-                       default:
-                               /* Do nothing */
-                               dest.append(item);
-                       break;
-               }
-               if (i != source.size() - 1)
-                       dest.append(" ");
+               TranslateSingleParam(t, source[i], dest, custom_translator, i);
+
+               if (!last)
+                       dest.push_back(' ');
        }
 
-       return translations;
+       return dest;
 }
 
-int CommandParser::TranslateUIDs(TranslateType to, const std::string &source, std::string &dest)
+void CommandParser::TranslateSingleParam(TranslateType to, const std::string& item, std::string& dest, CommandBase* custom_translator, unsigned int paramnumber)
 {
-       User* user = NULL;
-       std::string item;
-       int translations = 0;
-       dest.clear();
-
        switch (to)
        {
                case TR_NICK:
+               {
                        /* Translate single nickname */
-                       user = ServerInstance->FindNick(source);
+                       User* user = ServerInstance->FindNick(item);
                        if (user)
+                               dest.append(user->uuid);
+                       else
+                               dest.append(item);
+                       break;
+               }
+               case TR_CUSTOM:
+               {
+                       if (custom_translator)
                        {
-                               dest = user->uuid;
-                               translations++;
+                               std::string translated = item;
+                               custom_translator->EncodeParameter(translated, paramnumber);
+                               dest.append(translated);
+                               break;
                        }
-                       else
-                               dest = source;
-               break;
-               case TR_END:
-               case TR_TEXT:
+                       // If no custom translator was given, fall through
+               }
+               /*@fallthrough@*/
                default:
                        /* Do nothing */
-                       dest = source;
+                       dest.append(item);
                break;
        }
-
-       return translations;
 }