1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2009 InspIRCd Development Team
6 * See: http://wiki.inspircd.org/Credits
8 * This program is free but copyrighted software; see
9 * the file COPYING for details.
11 * ---------------------------------------------------
18 #include "socketengine.h"
20 #include "command_parse.h"
21 #include "exitcodes.h"
23 /* Directory Searching for Unix-Only */
29 int InspIRCd::PassCompare(Extensible* ex, const std::string &data, const std::string &input, const std::string &hashtype)
32 FIRST_MOD_RESULT(OnPassCompare, res, (ex, data, input, hashtype));
35 if (res == MOD_RES_ALLOW)
38 /* Module explicitly didnt match */
39 if (res == MOD_RES_DENY)
42 /* We dont handle any hash types except for plaintext - Thanks tra26 */
43 if (hashtype != "" && hashtype != "plaintext")
44 /* See below. 1 because they dont match */
47 return (data != input); // this seems back to front, but returns 0 if they *match*, 1 else
50 /* LoopCall is used to call a command classes handler repeatedly based on the contents of a comma seperated list.
51 * There are two overriden versions of this method, one of which takes two potential lists and the other takes one.
52 * We need a version which takes two potential lists for JOIN, because a JOIN may contain two lists of items at once,
53 * the channel names and their keys as follows:
54 * JOIN #chan1,#chan2,#chan3 key1,,key3
55 * Therefore, we need to deal with both lists concurrently. The first instance of this method does that by creating
56 * two instances of irc::commasepstream and reading them both together until the first runs out of tokens.
57 * The second version is much simpler and just has the one stream to read, and is used in NAMES, WHOIS, PRIVMSG etc.
58 * Both will only parse until they reach ServerInstance->Config->MaxTargets number of targets, to stop abuse via spam.
60 int CommandParser::LoopCall(User* user, Command* CommandObj, const std::vector<std::string>& parameters, unsigned int splithere, unsigned int extra)
62 if (splithere >= parameters.size())
65 /* First check if we have more than one item in the list, if we don't we return zero here and the handler
66 * which called us just carries on as it was.
68 if (parameters[splithere].find(',') == std::string::npos)
71 /** Some lame ircds will weed out dupes using some shitty O(n^2) algorithm.
72 * By using std::set (thanks for the idea w00t) we can cut this down a ton.
75 std::set<irc::string> dupes;
77 /* Create two lists, one for channel names, one for keys
79 irc::commasepstream items1(parameters[splithere]);
80 irc::commasepstream items2(parameters[extra]);
81 std::string extrastuff;
85 /* Attempt to iterate these lists and call the command objech
86 * which called us, for every parameter pair until there are
87 * no more left to parse.
89 while (items1.GetToken(item) && (max++ < ServerInstance->Config->MaxTargets))
91 if (dupes.find(item.c_str()) == dupes.end())
93 std::vector<std::string> new_parameters;
95 for (unsigned int t = 0; (t < parameters.size()) && (t < MAXPARAMETERS); t++)
96 new_parameters.push_back(parameters[t]);
98 if (!items2.GetToken(extrastuff))
101 new_parameters[splithere] = item.c_str();
102 new_parameters[extra] = extrastuff.c_str();
104 CommandObj->Handle(new_parameters, user);
106 dupes.insert(item.c_str());
112 int CommandParser::LoopCall(User* user, Command* CommandObj, const std::vector<std::string>& parameters, unsigned int splithere)
114 if (splithere >= parameters.size())
117 /* First check if we have more than one item in the list, if we don't we return zero here and the handler
118 * which called us just carries on as it was.
120 if (parameters[splithere].find(',') == std::string::npos)
123 std::set<irc::string> dupes;
125 /* Only one commasepstream here */
126 irc::commasepstream items1(parameters[splithere]);
128 unsigned int max = 0;
130 /* Parse the commasepstream until there are no tokens remaining.
131 * Each token we parse out, call the command handler that called us
134 while (items1.GetToken(item) && (max++ < ServerInstance->Config->MaxTargets))
136 if (dupes.find(item.c_str()) == dupes.end())
138 std::vector<std::string> new_parameters;
140 for (unsigned int t = 0; (t < parameters.size()) && (t < MAXPARAMETERS); t++)
141 new_parameters.push_back(parameters[t]);
143 new_parameters[splithere] = item.c_str();
145 /* Execute the command handler. */
146 CommandObj->Handle(new_parameters, user);
148 dupes.insert(item.c_str());
151 /* By returning 1 we tell our caller that nothing is to be done,
152 * as all the previous calls handled the data. This makes the parent
153 * return without doing any processing.
158 bool CommandParser::IsValidCommand(const std::string &commandname, unsigned int pcnt, User * user)
160 Commandtable::iterator n = cmdlist.find(commandname);
162 if (n != cmdlist.end())
164 if ((pcnt >= n->second->min_params))
166 if (IS_LOCAL(user) && n->second->flags_needed)
168 if (user->IsModeSet(n->second->flags_needed))
170 return (user->HasPermission(commandname));
182 Command* CommandParser::GetHandler(const std::string &commandname)
184 Commandtable::iterator n = cmdlist.find(commandname);
185 if (n != cmdlist.end())
191 // calls a handler function for a command
193 CmdResult CommandParser::CallHandler(const std::string &commandname, const std::vector<std::string>& parameters, User *user)
195 Commandtable::iterator n = cmdlist.find(commandname);
197 if (n != cmdlist.end())
199 if (parameters.size() >= n->second->min_params)
203 if (IS_LOCAL(user) && n->second->flags_needed)
205 /* if user is local, and flags are needed .. */
207 if (user->IsModeSet(n->second->flags_needed))
209 /* if user has the flags, and now has the permissions, go ahead */
210 if (user->HasPermission(commandname))
216 /* remote or no flags required anyway */
222 return n->second->Handle(parameters,user);
229 bool CommandParser::ProcessCommand(User *user, std::string &cmd)
231 std::vector<std::string> command_p;
232 irc::tokenstream tokens(cmd);
233 std::string command, token;
234 tokens.GetToken(command);
236 /* A client sent a nick prefix on their command (ick)
237 * rhapsody and some braindead bouncers do this --
238 * the rfc says they shouldnt but also says the ircd should
239 * discard it if they do.
241 if (command[0] == ':')
242 tokens.GetToken(command);
244 while (tokens.GetToken(token) && (command_p.size() <= MAXPARAMETERS))
245 command_p.push_back(token);
247 std::transform(command.begin(), command.end(), command.begin(), ::toupper);
249 /* find the command, check it exists */
250 Commandtable::iterator cm = cmdlist.find(command);
252 /* Modify the user's penalty regardless of whether or not the command exists */
254 if (!user->HasPrivPermission("users/flood/no-throttle"))
256 // If it *doesn't* exist, give it a slightly heftier penalty than normal to deter flooding us crap
257 user->IncreasePenalty(cm != cmdlist.end() ? cm->second->Penalty : 2);
258 do_more = (user->Penalty < 10);
262 if (cm == cmdlist.end())
264 ModResult MOD_RESULT;
265 FIRST_MOD_RESULT(OnPreCommand, MOD_RESULT, (command, command_p, user, false, cmd));
266 if (MOD_RESULT == MOD_RES_DENY)
270 * This double lookup is in case a module (abbreviation) wishes to change a command.
271 * Sure, the double lookup is a bit painful, but bear in mind this only happens for unknowns anyway.
273 * Thanks dz for making me actually understand why this is necessary!
276 cm = cmdlist.find(command);
277 if (cm == cmdlist.end())
279 if (user->registered == REG_ALL)
280 user->WriteNumeric(ERR_UNKNOWNCOMMAND, "%s %s :Unknown command",user->nick.c_str(),command.c_str());
281 ServerInstance->stats->statsUnknown++;
286 if (cm->second->max_params && command_p.size() > cm->second->max_params)
289 * command_p input (assuming max_params 1):
295 std::string lparam = "";
298 * The '-1' here is a clever trick, we'll go backwards throwing everything into a temporary param
299 * and then just toss that into the array.
302 while (command_p.size() > (cm->second->max_params - 1))
304 // BE CAREFUL: .end() returns past the end of the vector, hence decrement.
305 std::vector<std::string>::iterator it = --command_p.end();
307 lparam.insert(0, " " + *(it));
308 command_p.erase(it); // remove last element
311 /* we now have (each iteration):
314 * ' is a test' <-- final string
315 * ...now remove the ' ' at the start...
317 lparam.erase(lparam.begin());
319 /* param is now 'is a test', which is exactly what we wanted! */
320 command_p.push_back(lparam);
324 * We call OnPreCommand here seperately if the command exists, so the magic above can
325 * truncate to max_params if necessary. -- w00t
327 ModResult MOD_RESULT;
328 FIRST_MOD_RESULT(OnPreCommand, MOD_RESULT, (command, command_p, user, false, cmd));
329 if (MOD_RESULT == MOD_RES_DENY)
332 /* activity resets the ping pending timer */
334 user->nping = ServerInstance->Time() + user->MyClass->GetPingTime();
336 if (cm->second->flags_needed)
338 if (!user->IsModeSet(cm->second->flags_needed))
340 user->WriteNumeric(ERR_NOPRIVILEGES, "%s :Permission Denied - You do not have the required operator privileges",user->nick.c_str());
343 if (!user->HasPermission(command))
345 user->WriteNumeric(ERR_NOPRIVILEGES, "%s :Permission Denied - Oper type %s does not have access to command %s",user->nick.c_str(),irc::Spacify(user->oper.c_str()),command.c_str());
349 if ((user->registered == REG_ALL) && (!IS_OPER(user)) && (cm->second->IsDisabled()))
351 /* command is disabled! */
352 if (ServerInstance->Config->DisabledDontExist)
354 user->WriteNumeric(ERR_UNKNOWNCOMMAND, "%s %s :Unknown command",user->nick.c_str(),command.c_str());
358 user->WriteNumeric(ERR_UNKNOWNCOMMAND, "%s %s :This command has been disabled.",
359 user->nick.c_str(), command.c_str());
362 ServerInstance->SNO->WriteToSnoMask('t', "%s denied for %s (%s@%s)",
363 command.c_str(), user->nick.c_str(), user->ident.c_str(), user->host.c_str());
366 if (command_p.size() < cm->second->min_params)
368 user->WriteNumeric(ERR_NEEDMOREPARAMS, "%s %s :Not enough parameters.", user->nick.c_str(), command.c_str());
369 if ((ServerInstance->Config->SyntaxHints) && (user->registered == REG_ALL) && (cm->second->syntax.length()))
370 user->WriteNumeric(RPL_SYNTAX, "%s :SYNTAX %s %s", user->nick.c_str(), cm->second->command.c_str(), cm->second->syntax.c_str());
373 if ((user->registered != REG_ALL) && (!cm->second->WorksBeforeReg()))
375 user->WriteNumeric(ERR_NOTREGISTERED, "%s :You have not registered",command.c_str());
380 /* passed all checks.. first, do the (ugly) stats counters. */
381 cm->second->use_count++;
382 cm->second->total_bytes += cmd.length();
384 /* module calls too */
385 FIRST_MOD_RESULT(OnPreCommand, MOD_RESULT, (command, command_p, user, true, cmd));
386 if (MOD_RESULT == MOD_RES_DENY)
390 * WARNING: be careful, the user may be deleted soon
392 CmdResult result = cm->second->Handle(command_p, user);
394 FOREACH_MOD(I_OnPostCommand,OnPostCommand(command, command_p, user, result,cmd));
399 void CommandParser::RemoveCommands(Module* source)
401 Commandtable::iterator i,safei;
402 for (i = cmdlist.begin(); i != cmdlist.end();)
406 RemoveCommand(safei, source);
410 void CommandParser::RemoveCommand(Commandtable::iterator safei, Module* source)
412 Command* x = safei->second;
413 if (x->creator == source)
415 cmdlist.erase(safei);
419 bool CommandParser::ProcessBuffer(std::string &buffer,User *user)
421 if (!user || buffer.empty())
424 ServerInstance->Logs->Log("USERINPUT", DEBUG, "C[%d] I :%s %s",
425 user->GetFd(), user->nick.c_str(), buffer.c_str());
426 return ProcessCommand(user,buffer);
429 bool CommandParser::CreateCommand(Command *f)
431 /* create the command and push it onto the table */
432 if (cmdlist.find(f->command) == cmdlist.end())
434 cmdlist[f->command] = f;
440 CommandParser::CommandParser()
445 int CommandParser::TranslateUIDs(const std::vector<TranslateType> to, const std::vector<std::string> &source, std::string &dest, bool prefix_final, Command* custom_translator)
447 std::vector<TranslateType>::const_iterator types = to.begin();
450 int translations = 0;
453 for(i=0; i < source.size(); i++)
456 std::string item = source[i];
458 if (types == to.end())
466 if (prefix_final && i == source.size() - 1)
472 /* Translate single nickname */
473 user = ServerInstance->FindNick(item);
476 dest.append(user->uuid);
483 if (custom_translator)
484 custom_translator->EncodeParameter(item, i);
494 if (i != source.size() - 1)
501 int CommandParser::TranslateUIDs(TranslateType to, const std::string &source, std::string &dest)
505 int translations = 0;
511 /* Translate single nickname */
512 user = ServerInstance->FindNick(source);