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 int 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")
41 /* See below. 1 because they dont match */
44 return (data != input); // this seems back to front, but returns 0 if they *match*, 1 else
47 bool CommandParser::LoopCall(User* user, Command* handler, const std::vector<std::string>& parameters, unsigned int splithere, int extra, bool usemax)
49 if (splithere >= parameters.size())
52 /* First check if we have more than one item in the list, if we don't we return false here and the handler
53 * which called us just carries on as it was.
55 if (parameters[splithere].find(',') == std::string::npos)
58 /** Some lame ircds will weed out dupes using some shitty O(n^2) algorithm.
59 * By using std::set (thanks for the idea w00t) we can cut this down a ton.
62 * Only check for duplicates if there is one list (allow them in JOIN).
64 std::set<irc::string> dupes;
65 bool check_dupes = (extra < 0);
67 /* Create two sepstreams, if we have only one list, then initialize the second sepstream with
68 * an empty string. The second parameter of the constructor of the sepstream tells whether
69 * or not to allow empty tokens.
70 * We allow empty keys, so "JOIN #a,#b ,bkey" will be interpreted as "JOIN #a", "JOIN #b bkey"
72 irc::commasepstream items1(parameters[splithere]);
73 irc::commasepstream items2(extra >= 0 ? parameters[extra] : "", true);
76 LocalUser* localuser = IS_LOCAL(user);
78 /* Attempt to iterate these lists and call the command handler
79 * for every parameter or parameter pair until there are no more
82 while (items1.GetToken(item) && (!usemax || max++ < ServerInstance->Config->MaxTargets))
84 if ((!check_dupes) || (dupes.insert(item.c_str()).second))
86 std::vector<std::string> new_parameters(parameters);
87 new_parameters[splithere] = item;
91 // If we have two lists then get the next item from the second list.
92 // In case it runs out of elements then 'item' will be an empty string.
93 items2.GetToken(item);
94 new_parameters[extra] = item;
97 CmdResult result = handler->Handle(new_parameters, user);
100 // Run the OnPostCommand hook with the last parameter (original line) being empty
101 // to indicate that the command had more targets in its original form.
103 FOREACH_MOD(I_OnPostCommand, OnPostCommand(handler, new_parameters, localuser, result, item));
111 bool CommandParser::IsValidCommand(const std::string &commandname, unsigned int pcnt, User * user)
113 Commandtable::iterator n = cmdlist.find(commandname);
115 if (n != cmdlist.end())
117 if ((pcnt >= n->second->min_params))
119 if (IS_LOCAL(user) && n->second->flags_needed)
121 if (user->IsModeSet(n->second->flags_needed))
123 return (user->HasPermission(commandname));
135 Command* CommandParser::GetHandler(const std::string &commandname)
137 Commandtable::iterator n = cmdlist.find(commandname);
138 if (n != cmdlist.end())
144 // calls a handler function for a command
146 CmdResult CommandParser::CallHandler(const std::string &commandname, const std::vector<std::string>& parameters, User *user)
148 Commandtable::iterator n = cmdlist.find(commandname);
150 if (n != cmdlist.end())
152 if ((!parameters.empty()) && (parameters.back().empty()) && (!n->second->allow_empty_last_param))
155 if (parameters.size() >= n->second->min_params)
159 if (IS_LOCAL(user) && n->second->flags_needed)
161 /* if user is local, and flags are needed .. */
163 if (user->IsModeSet(n->second->flags_needed))
165 /* if user has the flags, and now has the permissions, go ahead */
166 if (user->HasPermission(commandname))
172 /* remote or no flags required anyway */
178 return n->second->Handle(parameters,user);
185 void CommandParser::ProcessCommand(LocalUser *user, std::string &cmd)
187 std::vector<std::string> command_p;
188 irc::tokenstream tokens(cmd);
189 std::string command, token;
190 tokens.GetToken(command);
192 /* A client sent a nick prefix on their command (ick)
193 * rhapsody and some braindead bouncers do this --
194 * the rfc says they shouldnt but also says the ircd should
195 * discard it if they do.
197 if (command[0] == ':')
198 tokens.GetToken(command);
200 while (tokens.GetToken(token))
201 command_p.push_back(token);
203 std::transform(command.begin(), command.end(), command.begin(), ::toupper);
205 /* find the command, check it exists */
206 Command* handler = GetHandler(command);
208 /* Modify the user's penalty regardless of whether or not the command exists */
209 if (!user->HasPrivPermission("users/flood/no-throttle"))
211 // If it *doesn't* exist, give it a slightly heftier penalty than normal to deter flooding us crap
212 user->CommandFloodPenalty += handler ? handler->Penalty * 1000 : 2000;
217 ModResult MOD_RESULT;
218 FIRST_MOD_RESULT(OnPreCommand, MOD_RESULT, (command, command_p, user, false, cmd));
219 if (MOD_RESULT == MOD_RES_DENY)
223 * This double lookup is in case a module (abbreviation) wishes to change a command.
224 * Sure, the double lookup is a bit painful, but bear in mind this only happens for unknowns anyway.
226 * Thanks dz for making me actually understand why this is necessary!
229 handler = GetHandler(command);
232 if (user->registered == REG_ALL)
233 user->WriteNumeric(ERR_UNKNOWNCOMMAND, "%s %s :Unknown command",user->nick.c_str(),command.c_str());
234 ServerInstance->stats->statsUnknown++;
239 // If we were given more parameters than max_params then append the excess parameter(s)
240 // to command_p[maxparams-1], i.e. to the last param that is still allowed
241 if (handler->max_params && command_p.size() > handler->max_params)
244 * command_p input (assuming max_params 1):
251 // Iterator to the last parameter that will be kept
252 const std::vector<std::string>::iterator lastkeep = command_p.begin() + (handler->max_params - 1);
253 // Iterator to the first excess parameter
254 const std::vector<std::string>::iterator firstexcess = lastkeep + 1;
256 // Append all excess parameter(s) to the last parameter, seperated by spaces
257 for (std::vector<std::string>::const_iterator i = firstexcess; i != command_p.end(); ++i)
259 lastkeep->push_back(' ');
260 lastkeep->append(*i);
263 // Erase the excess parameter(s)
264 command_p.erase(firstexcess, command_p.end());
268 * We call OnPreCommand here seperately if the command exists, so the magic above can
269 * truncate to max_params if necessary. -- w00t
271 ModResult MOD_RESULT;
272 FIRST_MOD_RESULT(OnPreCommand, MOD_RESULT, (command, command_p, user, false, cmd));
273 if (MOD_RESULT == MOD_RES_DENY)
276 /* activity resets the ping pending timer */
277 user->nping = ServerInstance->Time() + user->MyClass->GetPingTime();
279 if (handler->flags_needed)
281 if (!user->IsModeSet(handler->flags_needed))
283 user->WriteNumeric(ERR_NOPRIVILEGES, "%s :Permission Denied - You do not have the required operator privileges",user->nick.c_str());
287 if (!user->HasPermission(command))
289 user->WriteNumeric(ERR_NOPRIVILEGES, "%s :Permission Denied - Oper type %s does not have access to command %s",
290 user->nick.c_str(), user->oper->name.c_str(), command.c_str());
295 if ((user->registered == REG_ALL) && (!user->IsOper()) && (handler->IsDisabled()))
297 /* command is disabled! */
298 if (ServerInstance->Config->DisabledDontExist)
300 user->WriteNumeric(ERR_UNKNOWNCOMMAND, "%s %s :Unknown command",user->nick.c_str(),command.c_str());
304 user->WriteNumeric(ERR_UNKNOWNCOMMAND, "%s %s :This command has been disabled.",
305 user->nick.c_str(), command.c_str());
308 ServerInstance->SNO->WriteToSnoMask('t', "%s denied for %s (%s@%s)",
309 command.c_str(), user->nick.c_str(), user->ident.c_str(), user->host.c_str());
313 if ((!command_p.empty()) && (command_p.back().empty()) && (!handler->allow_empty_last_param))
314 command_p.pop_back();
316 if (command_p.size() < handler->min_params)
318 user->WriteNumeric(ERR_NEEDMOREPARAMS, "%s %s :Not enough parameters.", user->nick.c_str(), command.c_str());
319 if ((ServerInstance->Config->SyntaxHints) && (user->registered == REG_ALL) && (handler->syntax.length()))
320 user->WriteNumeric(RPL_SYNTAX, "%s :SYNTAX %s %s", user->nick.c_str(), handler->name.c_str(), handler->syntax.c_str());
324 if ((user->registered != REG_ALL) && (!handler->WorksBeforeReg()))
326 user->WriteNumeric(ERR_NOTREGISTERED, "%s :You have not registered",command.c_str());
330 /* passed all checks.. first, do the (ugly) stats counters. */
331 handler->use_count++;
333 /* module calls too */
334 FIRST_MOD_RESULT(OnPreCommand, MOD_RESULT, (command, command_p, user, true, cmd));
335 if (MOD_RESULT == MOD_RES_DENY)
339 * WARNING: be careful, the user may be deleted soon
341 CmdResult result = handler->Handle(command_p, user);
343 FOREACH_MOD(I_OnPostCommand, OnPostCommand(handler, command_p, user, result, cmd));
347 void CommandParser::RemoveCommand(Command* x)
349 Commandtable::iterator n = cmdlist.find(x->name);
350 if (n != cmdlist.end() && n->second == x)
356 ServerInstance->Parser->RemoveCommand(this);
359 void CommandParser::ProcessBuffer(std::string &buffer,LocalUser *user)
361 if (!user || buffer.empty())
364 ServerInstance->Logs->Log("USERINPUT", LOG_RAWIO, "C[%s] I :%s %s",
365 user->uuid.c_str(), user->nick.c_str(), buffer.c_str());
366 ProcessCommand(user,buffer);
369 bool CommandParser::AddCommand(Command *f)
371 /* create the command and push it onto the table */
372 if (cmdlist.find(f->name) == cmdlist.end())
374 cmdlist[f->name] = f;
380 CommandParser::CommandParser()
384 std::string CommandParser::TranslateUIDs(const std::vector<TranslateType>& to, const std::vector<std::string>& source, bool prefix_final, Command* custom_translator)
386 std::vector<TranslateType>::const_iterator types = to.begin();
389 for (unsigned int i = 0; i < source.size(); i++)
391 TranslateType t = TR_TEXT;
392 // They might supply less translation types than parameters,
393 // in that case pretend that all remaining types are TR_TEXT
394 if (types != to.end())
400 bool last = (i == (source.size() - 1));
401 if (prefix_final && last)
404 TranslateSingleParam(t, source[i], dest, custom_translator, i);
413 void CommandParser::TranslateSingleParam(TranslateType to, const std::string& item, std::string& dest, Command* custom_translator, unsigned int paramnumber)
419 /* Translate single nickname */
420 User* user = ServerInstance->FindNick(item);
422 dest.append(user->uuid);
429 if (custom_translator)
431 std::string translated = item;
432 custom_translator->EncodeParameter(translated, paramnumber);
433 dest.append(translated);
436 // If no custom translator was given, fall through