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(this, 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 void CommandParser::DoLines(User* current, bool one_only)
231 while (current->BufferIsReady())
233 // use GetBuffer to copy single lines into the sanitized string
234 std::string single_line = current->GetBuffer();
235 current->bytes_in += single_line.length();
237 if (single_line.length() > MAXBUF - 2) // MAXBUF is 514 to allow for neccessary line terminators
238 single_line.resize(MAXBUF - 2); // So to trim to 512 here, we use MAXBUF - 2
240 // ProcessBuffer returns false if the user has gone over penalty
241 if (!ServerInstance->Parser->ProcessBuffer(single_line, current) || one_only)
246 bool CommandParser::ProcessCommand(User *user, std::string &cmd)
248 std::vector<std::string> command_p;
249 irc::tokenstream tokens(cmd);
250 std::string command, token;
251 tokens.GetToken(command);
253 /* A client sent a nick prefix on their command (ick)
254 * rhapsody and some braindead bouncers do this --
255 * the rfc says they shouldnt but also says the ircd should
256 * discard it if they do.
258 if (command[0] == ':')
259 tokens.GetToken(command);
261 while (tokens.GetToken(token) && (command_p.size() <= MAXPARAMETERS))
262 command_p.push_back(token);
264 std::transform(command.begin(), command.end(), command.begin(), ::toupper);
266 /* find the command, check it exists */
267 Commandtable::iterator cm = cmdlist.find(command);
269 /* Modify the user's penalty regardless of whether or not the command exists */
271 if (!user->HasPrivPermission("users/flood/no-throttle"))
273 // If it *doesn't* exist, give it a slightly heftier penalty than normal to deter flooding us crap
274 user->IncreasePenalty(cm != cmdlist.end() ? cm->second->Penalty : 2);
275 do_more = (user->Penalty < 10);
279 if (cm == cmdlist.end())
281 ModResult MOD_RESULT;
282 FIRST_MOD_RESULT(ServerInstance, OnPreCommand, MOD_RESULT, (command, command_p, user, false, cmd));
283 if (MOD_RESULT == MOD_RES_DENY)
287 * This double lookup is in case a module (abbreviation) wishes to change a command.
288 * Sure, the double lookup is a bit painful, but bear in mind this only happens for unknowns anyway.
290 * Thanks dz for making me actually understand why this is necessary!
293 cm = cmdlist.find(command);
294 if (cm == cmdlist.end())
296 if (user->registered == REG_ALL)
297 user->WriteNumeric(ERR_UNKNOWNCOMMAND, "%s %s :Unknown command",user->nick.c_str(),command.c_str());
298 ServerInstance->stats->statsUnknown++;
303 if (cm->second->max_params && command_p.size() > cm->second->max_params)
306 * command_p input (assuming max_params 1):
312 std::string lparam = "";
315 * The '-1' here is a clever trick, we'll go backwards throwing everything into a temporary param
316 * and then just toss that into the array.
319 while (command_p.size() > (cm->second->max_params - 1))
321 // BE CAREFUL: .end() returns past the end of the vector, hence decrement.
322 std::vector<std::string>::iterator it = --command_p.end();
324 lparam.insert(0, " " + *(it));
325 command_p.erase(it); // remove last element
328 /* we now have (each iteration):
331 * ' is a test' <-- final string
332 * ...now remove the ' ' at the start...
334 lparam.erase(lparam.begin());
336 /* param is now 'is a test', which is exactly what we wanted! */
337 command_p.push_back(lparam);
341 * We call OnPreCommand here seperately if the command exists, so the magic above can
342 * truncate to max_params if necessary. -- w00t
344 ModResult MOD_RESULT;
345 FIRST_MOD_RESULT(ServerInstance, OnPreCommand, MOD_RESULT, (command, command_p, user, false, cmd));
346 if (MOD_RESULT == MOD_RES_DENY)
349 /* activity resets the ping pending timer */
351 user->nping = ServerInstance->Time() + user->MyClass->GetPingTime();
353 if (cm->second->flags_needed)
355 if (!user->IsModeSet(cm->second->flags_needed))
357 user->WriteNumeric(ERR_NOPRIVILEGES, "%s :Permission Denied - You do not have the required operator privileges",user->nick.c_str());
360 if (!user->HasPermission(command))
362 user->WriteNumeric(ERR_NOPRIVILEGES, "%s :Permission Denied - Oper type %s does not have access to command %s",user->nick.c_str(),user->oper.c_str(),command.c_str());
366 if ((user->registered == REG_ALL) && (!IS_OPER(user)) && (cm->second->IsDisabled()))
368 /* command is disabled! */
369 if (ServerInstance->Config->DisabledDontExist)
371 user->WriteNumeric(ERR_UNKNOWNCOMMAND, "%s %s :Unknown command",user->nick.c_str(),command.c_str());
375 user->WriteNumeric(ERR_UNKNOWNCOMMAND, "%s %s :This command has been disabled.",
376 user->nick.c_str(), command.c_str());
379 ServerInstance->SNO->WriteToSnoMask('t', "%s denied for %s (%s@%s)",
380 command.c_str(), user->nick.c_str(), user->ident.c_str(), user->host.c_str());
383 if (command_p.size() < cm->second->min_params)
385 user->WriteNumeric(ERR_NEEDMOREPARAMS, "%s %s :Not enough parameters.", user->nick.c_str(), command.c_str());
386 if ((ServerInstance->Config->SyntaxHints) && (user->registered == REG_ALL) && (cm->second->syntax.length()))
387 user->WriteNumeric(RPL_SYNTAX, "%s :SYNTAX %s %s", user->nick.c_str(), cm->second->command.c_str(), cm->second->syntax.c_str());
390 if ((user->registered != REG_ALL) && (!cm->second->WorksBeforeReg()))
392 user->WriteNumeric(ERR_NOTREGISTERED, "%s :You have not registered",command.c_str());
397 /* passed all checks.. first, do the (ugly) stats counters. */
398 cm->second->use_count++;
399 cm->second->total_bytes += cmd.length();
401 /* module calls too */
402 FIRST_MOD_RESULT(ServerInstance, OnPreCommand, MOD_RESULT, (command, command_p, user, true, cmd));
403 if (MOD_RESULT == MOD_RES_DENY)
407 * WARNING: be careful, the user may be deleted soon
409 CmdResult result = cm->second->Handle(command_p, user);
411 FOREACH_MOD(I_OnPostCommand,OnPostCommand(command, command_p, user, result,cmd));
416 void CommandParser::RemoveCommands(Module* source)
418 Commandtable::iterator i,safei;
419 for (i = cmdlist.begin(); i != cmdlist.end();)
423 RemoveCommand(safei, source);
427 void CommandParser::RemoveCommand(Commandtable::iterator safei, Module* source)
429 Command* x = safei->second;
430 if (x->creator == source)
432 cmdlist.erase(safei);
436 bool CommandParser::ProcessBuffer(std::string &buffer,User *user)
438 std::string::size_type a;
443 while ((a = buffer.rfind("\n")) != std::string::npos)
445 while ((a = buffer.rfind("\r")) != std::string::npos)
450 ServerInstance->Logs->Log("USERINPUT", DEBUG,"C[%d] I :%s %s",user->GetFd(), user->nick.c_str(), buffer.c_str());
451 return this->ProcessCommand(user,buffer);
457 bool CommandParser::CreateCommand(Command *f)
459 /* create the command and push it onto the table */
460 if (cmdlist.find(f->command) == cmdlist.end())
462 cmdlist[f->command] = f;
468 CommandParser::CommandParser(InspIRCd* Instance) : ServerInstance(Instance)
473 int CommandParser::TranslateUIDs(const std::vector<TranslateType> to, const std::vector<std::string> &source, std::string &dest, bool prefix_final, Command* custom_translator)
475 std::vector<TranslateType>::const_iterator types = to.begin();
478 int translations = 0;
481 for(i=0; i < source.size(); i++)
484 std::string item = source[i];
486 if (types == to.end())
494 if (prefix_final && i == source.size() - 1)
500 /* Translate single nickname */
501 user = ServerInstance->FindNick(item);
504 dest.append(user->uuid);
511 if (custom_translator)
512 custom_translator->EncodeParameter(item, i);
522 if (i != source.size() - 1)
529 int CommandParser::TranslateUIDs(TranslateType to, const std::string &source, std::string &dest)
533 int translations = 0;
539 /* Translate single nickname */
540 user = ServerInstance->FindNick(source);