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 CommandBase::Params& 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 CommandBase::Params 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 CommandBase::Params params(new_parameters, parameters.GetTags());
97 CmdResult result = handler->Handle(user, params);
100 // Run the OnPostCommand hook with the last parameter being true to indicate
101 // that the event is being called in a loop.
103 FOREACH_MOD(OnPostCommand, (handler, new_parameters, localuser, result, true));
111 Command* CommandParser::GetHandler(const std::string &commandname)
113 CommandMap::iterator n = cmdlist.find(commandname);
114 if (n != cmdlist.end())
120 // calls a handler function for a command
122 CmdResult CommandParser::CallHandler(const std::string& commandname, const CommandBase::Params& parameters, User* user, Command** cmd)
124 CommandMap::iterator n = cmdlist.find(commandname);
126 if (n != cmdlist.end())
128 if ((!parameters.empty()) && (parameters.back().empty()) && (!n->second->allow_empty_last_param))
131 if (parameters.size() >= n->second->min_params)
135 if (IS_LOCAL(user) && n->second->flags_needed)
137 /* if user is local, and flags are needed .. */
139 if (user->IsModeSet(n->second->flags_needed))
141 /* if user has the flags, and now has the permissions, go ahead */
142 if (user->HasPermission(commandname))
148 /* remote or no flags required anyway */
157 ClientProtocol::TagMap tags;
158 return n->second->Handle(user, CommandBase::Params(parameters, tags));
165 void CommandParser::ProcessCommand(LocalUser* user, std::string& command, CommandBase::Params& command_p)
167 /* find the command, check it exists */
168 Command* handler = GetHandler(command);
170 // Penalty to give if the command fails before the handler is executed
171 unsigned int failpenalty = 0;
173 /* Modify the user's penalty regardless of whether or not the command exists */
174 if (!user->HasPrivPermission("users/flood/no-throttle"))
176 // If it *doesn't* exist, give it a slightly heftier penalty than normal to deter flooding us crap
177 unsigned int penalty = (handler ? handler->Penalty * 1000 : 2000);
178 user->CommandFloodPenalty += penalty;
180 // Increase their penalty later if we fail and the command has 0 penalty by default (i.e. in Command::Penalty) to
181 // throttle sending ERR_* from the command parser. If the command does have a non-zero penalty then this is not
182 // needed because we've increased their penalty above.
189 ModResult MOD_RESULT;
190 FIRST_MOD_RESULT(OnPreCommand, MOD_RESULT, (command, command_p, user, false));
191 if (MOD_RESULT == MOD_RES_DENY)
195 * This double lookup is in case a module (abbreviation) wishes to change a command.
196 * Sure, the double lookup is a bit painful, but bear in mind this only happens for unknowns anyway.
198 * Thanks dz for making me actually understand why this is necessary!
201 handler = GetHandler(command);
204 if (user->registered == REG_ALL)
205 user->WriteNumeric(ERR_UNKNOWNCOMMAND, command, "Unknown command");
206 ServerInstance->stats.Unknown++;
211 // If we were given more parameters than max_params then append the excess parameter(s)
212 // to command_p[maxparams-1], i.e. to the last param that is still allowed
213 if (handler->max_params && command_p.size() > handler->max_params)
216 * command_p input (assuming max_params 1):
223 // Iterator to the last parameter that will be kept
224 const CommandBase::Params::iterator lastkeep = command_p.begin() + (handler->max_params - 1);
225 // Iterator to the first excess parameter
226 const CommandBase::Params::iterator firstexcess = lastkeep + 1;
228 // Append all excess parameter(s) to the last parameter, seperated by spaces
229 for (CommandBase::Params::const_iterator i = firstexcess; i != command_p.end(); ++i)
231 lastkeep->push_back(' ');
232 lastkeep->append(*i);
235 // Erase the excess parameter(s)
236 command_p.erase(firstexcess, command_p.end());
240 * We call OnPreCommand here seperately if the command exists, so the magic above can
241 * truncate to max_params if necessary. -- w00t
243 ModResult MOD_RESULT;
244 FIRST_MOD_RESULT(OnPreCommand, MOD_RESULT, (command, command_p, user, false));
245 if (MOD_RESULT == MOD_RES_DENY)
248 /* activity resets the ping pending timer */
249 user->nping = ServerInstance->Time() + user->MyClass->GetPingTime();
251 if (handler->flags_needed)
253 if (!user->IsModeSet(handler->flags_needed))
255 user->CommandFloodPenalty += failpenalty;
256 user->WriteNumeric(ERR_NOPRIVILEGES, "Permission Denied - You do not have the required operator privileges");
260 if (!user->HasPermission(command))
262 user->CommandFloodPenalty += failpenalty;
263 user->WriteNumeric(ERR_NOPRIVILEGES, InspIRCd::Format("Permission Denied - Oper type %s does not have access to command %s",
264 user->oper->name.c_str(), command.c_str()));
269 if ((user->registered == REG_ALL) && (!user->IsOper()) && (handler->IsDisabled()))
271 /* command is disabled! */
272 user->CommandFloodPenalty += failpenalty;
273 if (ServerInstance->Config->DisabledDontExist)
275 user->WriteNumeric(ERR_UNKNOWNCOMMAND, command, "Unknown command");
279 user->WriteNumeric(ERR_UNKNOWNCOMMAND, command, "This command has been disabled.");
282 ServerInstance->SNO->WriteToSnoMask('a', "%s denied for %s (%s@%s)",
283 command.c_str(), user->nick.c_str(), user->ident.c_str(), user->GetRealHost().c_str());
287 if ((!command_p.empty()) && (command_p.back().empty()) && (!handler->allow_empty_last_param))
288 command_p.pop_back();
290 if (command_p.size() < handler->min_params)
292 user->CommandFloodPenalty += failpenalty;
293 user->WriteNumeric(ERR_NEEDMOREPARAMS, command, "Not enough parameters.");
294 if ((ServerInstance->Config->SyntaxHints) && (user->registered == REG_ALL) && (handler->syntax.length()))
295 user->WriteNumeric(RPL_SYNTAX, handler->name, handler->syntax);
299 if ((user->registered != REG_ALL) && (!handler->WorksBeforeReg()))
301 user->CommandFloodPenalty += failpenalty;
302 user->WriteNumeric(ERR_NOTREGISTERED, command, "You have not registered");
306 /* passed all checks.. first, do the (ugly) stats counters. */
307 handler->use_count++;
309 /* module calls too */
310 FIRST_MOD_RESULT(OnPreCommand, MOD_RESULT, (command, command_p, user, true));
311 if (MOD_RESULT == MOD_RES_DENY)
315 * WARNING: be careful, the user may be deleted soon
317 CmdResult result = handler->Handle(user, command_p);
319 FOREACH_MOD(OnPostCommand, (handler, command_p, user, result, false));
323 void CommandParser::RemoveCommand(Command* x)
325 CommandMap::iterator n = cmdlist.find(x->name);
326 if (n != cmdlist.end() && n->second == x)
330 CommandBase::CommandBase(Module* mod, const std::string& cmd, unsigned int minpara, unsigned int maxpara)
331 : ServiceProvider(mod, cmd, SERVICE_COMMAND)
333 , min_params(minpara)
334 , max_params(maxpara)
337 , works_before_reg(false)
338 , allow_empty_last_param(true)
343 CommandBase::~CommandBase()
347 void CommandBase::EncodeParameter(std::string& parameter, unsigned int index)
351 RouteDescriptor CommandBase::GetRouting(User* user, const Params& parameters)
353 return ROUTE_LOCALONLY;
356 Command::Command(Module* mod, const std::string& cmd, unsigned int minpara, unsigned int maxpara)
357 : CommandBase(mod, cmd, minpara, maxpara)
358 , force_manual_route(false)
364 ServerInstance->Parser.RemoveCommand(this);
367 void Command::RegisterService()
369 if (!ServerInstance->Parser.AddCommand(this))
370 throw ModuleException("Command already exists: " + name);
373 void CommandParser::ProcessBuffer(LocalUser* user, const std::string& buffer)
375 ClientProtocol::ParseOutput parseoutput;
376 if (!user->serializer->Parse(user, buffer, parseoutput))
379 std::string& command = parseoutput.cmd;
380 std::transform(command.begin(), command.end(), command.begin(), ::toupper);
382 CommandBase::Params parameters(parseoutput.params, parseoutput.tags);
383 ProcessCommand(user, command, parameters);
386 bool CommandParser::AddCommand(Command *f)
388 /* create the command and push it onto the table */
389 if (cmdlist.find(f->name) == cmdlist.end())
391 cmdlist[f->name] = f;
397 CommandParser::CommandParser()
401 std::string CommandParser::TranslateUIDs(const std::vector<TranslateType>& to, const CommandBase::Params& source, bool prefix_final, CommandBase* custom_translator)
403 std::vector<TranslateType>::const_iterator types = to.begin();
406 for (unsigned int i = 0; i < source.size(); i++)
408 TranslateType t = TR_TEXT;
409 // They might supply less translation types than parameters,
410 // in that case pretend that all remaining types are TR_TEXT
411 if (types != to.end())
417 bool last = (i == (source.size() - 1));
418 if (prefix_final && last)
421 TranslateSingleParam(t, source[i], dest, custom_translator, i);
430 void CommandParser::TranslateSingleParam(TranslateType to, const std::string& item, std::string& dest, CommandBase* custom_translator, unsigned int paramnumber)
436 /* Translate single nickname */
437 User* user = ServerInstance->FindNick(item);
439 dest.append(user->uuid);
446 if (custom_translator)
448 std::string translated = item;
449 custom_translator->EncodeParameter(translated, paramnumber);
450 dest.append(translated);
453 // If no custom translator was given, fall through