2 * InspIRCd -- Internet Relay Chat Daemon
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>
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.
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
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/>.
26 bool InspIRCd::PassCompare(Extensible* ex, const std::string& data, const std::string& input, const std::string& hashtype)
29 FIRST_MOD_RESULT(OnPassCompare, res, (ex, data, input, hashtype));
32 if (res == MOD_RES_ALLOW)
35 /* Module explicitly didnt match */
36 if (res == MOD_RES_DENY)
39 /* We dont handle any hash types except for plaintext - Thanks tra26 */
40 if (!hashtype.empty() && hashtype != "plaintext")
43 return TimingSafeCompare(data, input);
46 bool CommandParser::LoopCall(User* user, Command* handler, const std::vector<std::string>& parameters, unsigned int splithere, int extra, bool usemax)
48 if (splithere >= parameters.size())
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.
54 if (parameters[splithere].find(',') == std::string::npos)
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.
61 * Only check for duplicates if there is one list (allow them in JOIN).
63 insp::flat_set<std::string, irc::insensitive_swo> dupes;
64 bool check_dupes = (extra < 0);
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"
71 irc::commasepstream items1(parameters[splithere]);
72 irc::commasepstream items2(extra >= 0 ? parameters[extra] : "", true);
75 LocalUser* localuser = IS_LOCAL(user);
77 /* Attempt to iterate these lists and call the command handler
78 * for every parameter or parameter pair until there are no more
81 while (items1.GetToken(item) && (!usemax || max++ < ServerInstance->Config->MaxTargets))
83 if ((!check_dupes) || (dupes.insert(item).second))
85 std::vector<std::string> new_parameters(parameters);
86 new_parameters[splithere] = item;
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;
96 CmdResult result = handler->Handle(new_parameters, user);
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.
102 FOREACH_MOD(OnPostCommand, (handler, new_parameters, localuser, result, item));
110 Command* CommandParser::GetHandler(const std::string &commandname)
112 CommandMap::iterator n = cmdlist.find(commandname);
113 if (n != cmdlist.end())
119 // calls a handler function for a command
121 CmdResult CommandParser::CallHandler(const std::string& commandname, const std::vector<std::string>& parameters, User* user, Command** cmd)
123 CommandMap::iterator n = cmdlist.find(commandname);
125 if (n != cmdlist.end())
127 if ((!parameters.empty()) && (parameters.back().empty()) && (!n->second->allow_empty_last_param))
130 if (parameters.size() >= n->second->min_params)
134 if (IS_LOCAL(user) && n->second->flags_needed)
136 /* if user is local, and flags are needed .. */
138 if (user->IsModeSet(n->second->flags_needed))
140 /* if user has the flags, and now has the permissions, go ahead */
141 if (user->HasPermission(commandname))
147 /* remote or no flags required anyway */
155 return n->second->Handle(parameters,user);
162 void CommandParser::ProcessCommand(LocalUser *user, std::string &cmd)
164 std::vector<std::string> command_p;
165 irc::tokenstream tokens(cmd);
166 std::string command, token;
167 tokens.GetToken(command);
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.
174 if (command[0] == ':')
175 tokens.GetToken(command);
177 while (tokens.GetToken(token))
178 command_p.push_back(token);
180 std::transform(command.begin(), command.end(), command.begin(), ::toupper);
182 /* find the command, check it exists */
183 Command* handler = GetHandler(command);
185 // Penalty to give if the command fails before the handler is executed
186 unsigned int failpenalty = 0;
188 /* Modify the user's penalty regardless of whether or not the command exists */
189 if (!user->HasPrivPermission("users/flood/no-throttle"))
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;
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.
204 ModResult MOD_RESULT;
205 FIRST_MOD_RESULT(OnPreCommand, MOD_RESULT, (command, command_p, user, false, cmd));
206 if (MOD_RESULT == MOD_RES_DENY)
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.
213 * Thanks dz for making me actually understand why this is necessary!
216 handler = GetHandler(command);
219 if (user->registered == REG_ALL)
220 user->WriteNumeric(ERR_UNKNOWNCOMMAND, command, "Unknown command");
221 ServerInstance->stats.Unknown++;
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)
231 * command_p input (assuming max_params 1):
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;
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)
246 lastkeep->push_back(' ');
247 lastkeep->append(*i);
250 // Erase the excess parameter(s)
251 command_p.erase(firstexcess, command_p.end());
255 * We call OnPreCommand here seperately if the command exists, so the magic above can
256 * truncate to max_params if necessary. -- w00t
258 ModResult MOD_RESULT;
259 FIRST_MOD_RESULT(OnPreCommand, MOD_RESULT, (command, command_p, user, false, cmd));
260 if (MOD_RESULT == MOD_RES_DENY)
263 /* activity resets the ping pending timer */
264 user->nping = ServerInstance->Time() + user->MyClass->GetPingTime();
266 if (handler->flags_needed)
268 if (!user->IsModeSet(handler->flags_needed))
270 user->CommandFloodPenalty += failpenalty;
271 user->WriteNumeric(ERR_NOPRIVILEGES, "Permission Denied - You do not have the required operator privileges");
275 if (!user->HasPermission(command))
277 user->CommandFloodPenalty += failpenalty;
278 user->WriteNumeric(ERR_NOPRIVILEGES, InspIRCd::Format("Permission Denied - Oper type %s does not have access to command %s",
279 user->oper->name.c_str(), command.c_str()));
284 if ((user->registered == REG_ALL) && (!user->IsOper()) && (handler->IsDisabled()))
286 /* command is disabled! */
287 user->CommandFloodPenalty += failpenalty;
288 if (ServerInstance->Config->DisabledDontExist)
290 user->WriteNumeric(ERR_UNKNOWNCOMMAND, command, "Unknown command");
294 user->WriteNumeric(ERR_UNKNOWNCOMMAND, command, "This command has been disabled.");
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());
302 if ((!command_p.empty()) && (command_p.back().empty()) && (!handler->allow_empty_last_param))
303 command_p.pop_back();
305 if (command_p.size() < handler->min_params)
307 user->CommandFloodPenalty += failpenalty;
308 user->WriteNumeric(ERR_NEEDMOREPARAMS, command, "Not enough parameters.");
309 if ((ServerInstance->Config->SyntaxHints) && (user->registered == REG_ALL) && (handler->syntax.length()))
310 user->WriteNumeric(RPL_SYNTAX, InspIRCd::Format("SYNTAX %s %s", handler->name.c_str(), handler->syntax.c_str()));
314 if ((user->registered != REG_ALL) && (!handler->WorksBeforeReg()))
316 user->CommandFloodPenalty += failpenalty;
317 user->WriteNumeric(ERR_NOTREGISTERED, command, "You have not registered");
321 /* passed all checks.. first, do the (ugly) stats counters. */
322 handler->use_count++;
324 /* module calls too */
325 FIRST_MOD_RESULT(OnPreCommand, MOD_RESULT, (command, command_p, user, true, cmd));
326 if (MOD_RESULT == MOD_RES_DENY)
330 * WARNING: be careful, the user may be deleted soon
332 CmdResult result = handler->Handle(command_p, user);
334 FOREACH_MOD(OnPostCommand, (handler, command_p, user, result, cmd));
338 void CommandParser::RemoveCommand(Command* x)
340 CommandMap::iterator n = cmdlist.find(x->name);
341 if (n != cmdlist.end() && n->second == x)
345 CommandBase::CommandBase(Module* mod, const std::string& cmd, unsigned int minpara, unsigned int maxpara)
346 : ServiceProvider(mod, cmd, SERVICE_COMMAND)
348 , min_params(minpara)
349 , max_params(maxpara)
352 , works_before_reg(false)
353 , allow_empty_last_param(true)
358 CommandBase::~CommandBase()
362 void CommandBase::EncodeParameter(std::string& parameter, int index)
366 RouteDescriptor CommandBase::GetRouting(User* user, const std::vector<std::string>& parameters)
368 return ROUTE_LOCALONLY;
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)
379 ServerInstance->Parser.RemoveCommand(this);
382 void Command::RegisterService()
384 if (!ServerInstance->Parser.AddCommand(this))
385 throw ModuleException("Command already exists: " + name);
388 void CommandParser::ProcessBuffer(std::string &buffer,LocalUser *user)
393 ServerInstance->Logs->Log("USERINPUT", LOG_RAWIO, "C[%s] I %s", user->uuid.c_str(), buffer.c_str());
394 ProcessCommand(user,buffer);
397 bool CommandParser::AddCommand(Command *f)
399 /* create the command and push it onto the table */
400 if (cmdlist.find(f->name) == cmdlist.end())
402 cmdlist[f->name] = f;
408 CommandParser::CommandParser()
412 std::string CommandParser::TranslateUIDs(const std::vector<TranslateType>& to, const std::vector<std::string>& source, bool prefix_final, CommandBase* custom_translator)
414 std::vector<TranslateType>::const_iterator types = to.begin();
417 for (unsigned int i = 0; i < source.size(); i++)
419 TranslateType t = TR_TEXT;
420 // They might supply less translation types than parameters,
421 // in that case pretend that all remaining types are TR_TEXT
422 if (types != to.end())
428 bool last = (i == (source.size() - 1));
429 if (prefix_final && last)
432 TranslateSingleParam(t, source[i], dest, custom_translator, i);
441 void CommandParser::TranslateSingleParam(TranslateType to, const std::string& item, std::string& dest, CommandBase* custom_translator, unsigned int paramnumber)
447 /* Translate single nickname */
448 User* user = ServerInstance->FindNick(item);
450 dest.append(user->uuid);
457 if (custom_translator)
459 std::string translated = item;
460 custom_translator->EncodeParameter(translated, paramnumber);
461 dest.append(translated);
464 // If no custom translator was given, fall through