]> git.netwichtig.de Git - user/henk/code/inspircd.git/blob - src/command_parse.cpp
Add optional max_params for commands, which means that we can compress 'extra' params...
[user/henk/code/inspircd.git] / src / command_parse.cpp
1 /*       +------------------------------------+
2  *       | Inspire Internet Relay Chat Daemon |
3  *       +------------------------------------+
4  *
5  *  InspIRCd: (C) 2002-2008 InspIRCd Development Team
6  * See: http://www.inspircd.org/wiki/index.php/Credits
7  *
8  * This program is free but copyrighted software; see
9  *          the file COPYING for details.
10  *
11  * ---------------------------------------------------
12  */
13
14 /* $Core */
15
16 #include "inspircd.h"
17 #include "xline.h"
18 #include "socketengine.h"
19 #include "socket.h"
20 #include "command_parse.h"
21 #include "exitcodes.h"
22
23 /* Directory Searching for Unix-Only */
24 #ifndef WIN32
25 #include <dirent.h>
26 #include <dlfcn.h>
27 #endif
28
29 int InspIRCd::PassCompare(Extensible* ex, const std::string &data, const std::string &input, const std::string &hashtype)
30 {
31         int MOD_RESULT = 0;
32         FOREACH_RESULT_I(this,I_OnPassCompare,OnPassCompare(ex, data, input, hashtype))
33         if (MOD_RESULT == 1)
34                 return 0;
35         if (MOD_RESULT == -1)
36                 return 1;
37         return data != input; // this seems back to front, but returns 0 if they *match*, 1 else
38 }
39
40 /* LoopCall is used to call a command classes handler repeatedly based on the contents of a comma seperated list.
41  * There are two overriden versions of this method, one of which takes two potential lists and the other takes one.
42  * We need a version which takes two potential lists for JOIN, because a JOIN may contain two lists of items at once,
43  * the channel names and their keys as follows:
44  * JOIN #chan1,#chan2,#chan3 key1,,key3
45  * Therefore, we need to deal with both lists concurrently. The first instance of this method does that by creating
46  * two instances of irc::commasepstream and reading them both together until the first runs out of tokens.
47  * The second version is much simpler and just has the one stream to read, and is used in NAMES, WHOIS, PRIVMSG etc.
48  * Both will only parse until they reach ServerInstance->Config->MaxTargets number of targets, to stop abuse via spam.
49  */
50 int CommandParser::LoopCall(User* user, Command* CommandObj, const std::vector<std::string>& parameters, unsigned int splithere, unsigned int extra)
51 {
52         if (splithere >= parameters.size())
53                 return 0;
54
55         /* First check if we have more than one item in the list, if we don't we return zero here and the handler
56          * which called us just carries on as it was.
57          */
58         if (parameters[splithere].find(',') == std::string::npos)
59                 return 0;
60
61         /** Some lame ircds will weed out dupes using some shitty O(n^2) algorithm.
62          * By using std::map (thanks for the idea w00t) we can cut this down a ton.
63          * ...VOOODOOOO!
64          */
65         std::map<irc::string, bool> dupes;
66
67         /* Create two lists, one for channel names, one for keys
68          */
69         irc::commasepstream items1(parameters[splithere]);
70         irc::commasepstream items2(parameters[extra]);
71         std::string extrastuff;
72         std::string item;
73         unsigned int max = 0;
74
75         /* Attempt to iterate these lists and call the command objech
76          * which called us, for every parameter pair until there are
77          * no more left to parse.
78          */
79         while (items1.GetToken(item) && (max++ < ServerInstance->Config->MaxTargets))
80         {
81                 if (dupes.find(item.c_str()) == dupes.end())
82                 {
83                         std::vector<std::string> new_parameters;
84
85                         for (unsigned int t = 0; (t < parameters.size()) && (t < MAXPARAMETERS); t++)
86                                 new_parameters.push_back(parameters[t]);
87
88                         if (!items2.GetToken(extrastuff))
89                                 extrastuff = "";
90
91                         new_parameters[splithere] = item.c_str();
92                         new_parameters[extra] = extrastuff.c_str();
93
94                         CommandObj->Handle(new_parameters, user);
95
96                         dupes[item.c_str()] = true;
97                 }
98         }
99         return 1;
100 }
101
102 int CommandParser::LoopCall(User* user, Command* CommandObj, const std::vector<std::string>& parameters, unsigned int splithere)
103 {
104         if (splithere >= parameters.size())
105                 return 0;
106
107         /* First check if we have more than one item in the list, if we don't we return zero here and the handler
108          * which called us just carries on as it was.
109          */
110         if (parameters[splithere].find(',') == std::string::npos)
111                 return 0;
112
113         std::map<irc::string, bool> dupes;
114
115         /* Only one commasepstream here */
116         irc::commasepstream items1(parameters[splithere]);
117         std::string item;
118         unsigned int max = 0;
119
120         /* Parse the commasepstream until there are no tokens remaining.
121          * Each token we parse out, call the command handler that called us
122          * with it
123          */
124         while (items1.GetToken(item) && (max++ < ServerInstance->Config->MaxTargets))
125         {
126                 if (dupes.find(item.c_str()) == dupes.end())
127                 {
128                         std::vector<std::string> new_parameters;
129
130                         for (unsigned int t = 0; (t < parameters.size()) && (t < MAXPARAMETERS); t++)
131                                 new_parameters.push_back(parameters[t]);
132
133                         new_parameters[splithere] = item.c_str();
134
135                         /* Execute the command handler. */
136                         CommandObj->Handle(new_parameters, user);
137
138                         dupes[item.c_str()] = true;
139                 }
140         }
141         /* By returning 1 we tell our caller that nothing is to be done,
142          * as all the previous calls handled the data. This makes the parent
143          * return without doing any processing.
144          */
145         return 1;
146 }
147
148 bool CommandParser::IsValidCommand(const std::string &commandname, unsigned int pcnt, User * user)
149 {
150         Commandtable::iterator n = cmdlist.find(commandname);
151
152         if (n != cmdlist.end())
153         {
154                 if ((pcnt >= n->second->min_params) && (n->second->source != "<core>"))
155                 {
156                         if (IS_LOCAL(user) && n->second->flags_needed)
157                         {
158                                 if (user->IsModeSet(n->second->flags_needed))
159                                 {
160                                         return (user->HasPermission(commandname));
161                                 }
162                         }
163                         else
164                         {
165                                 return true;
166                         }
167                 }
168         }
169         return false;
170 }
171
172 Command* CommandParser::GetHandler(const std::string &commandname)
173 {
174         Commandtable::iterator n = cmdlist.find(commandname);
175         if (n != cmdlist.end())
176                 return n->second;
177
178         return NULL;
179 }
180
181 // calls a handler function for a command
182
183 CmdResult CommandParser::CallHandler(const std::string &commandname, const std::vector<std::string>& parameters, User *user)
184 {
185         Commandtable::iterator n = cmdlist.find(commandname);
186
187         if (n != cmdlist.end())
188         {
189                 if (parameters.size() >= n->second->min_params)
190                 {
191                         bool bOkay = false;
192
193                         if (IS_LOCAL(user) && n->second->flags_needed)
194                         {
195                                 /* if user is local, and flags are needed .. */
196
197                                 if (user->IsModeSet(n->second->flags_needed))
198                                 {
199                                         /* if user has the flags, and now has the permissions, go ahead */
200                                         if (user->HasPermission(commandname))
201                                                 bOkay = true;
202                                 }
203                         }
204                         else
205                         {
206                                 /* remote or no flags required anyway */
207                                 bOkay = true;
208                         }
209
210                         if (bOkay)
211                         {
212                                 return n->second->Handle(parameters,user);
213                         }
214                 }
215         }
216         return CMD_INVALID;
217 }
218
219 void CommandParser::DoLines(User* current, bool one_only)
220 {
221         // while there are complete lines to process...
222         unsigned int floodlines = 0;
223
224         while (current->BufferIsReady())
225         {
226                 if (current->MyClass)
227                 {
228                         if (ServerInstance->Time() > current->reset_due)
229                         {
230                                 current->reset_due = ServerInstance->Time() + current->MyClass->GetThreshold();
231                                 current->lines_in = 0;
232                         }
233
234                         if (++current->lines_in > current->MyClass->GetFlood() && current->MyClass->GetFlood())
235                         {
236                                 ServerInstance->FloodQuitUser(current);
237                                 return;
238                         }
239
240                         if ((++floodlines > current->MyClass->GetFlood()) && (current->MyClass->GetFlood() != 0))
241                         {
242                                 ServerInstance->FloodQuitUser(current);
243                                 return;
244                         }
245                 }
246
247                 // use GetBuffer to copy single lines into the sanitized string
248                 std::string single_line = current->GetBuffer();
249                 current->bytes_in += single_line.length();
250                 current->cmds_in++;
251                 if (single_line.length() > MAXBUF - 2)  // MAXBUF is 514 to allow for neccessary line terminators
252                         single_line.resize(MAXBUF - 2); // So to trim to 512 here, we use MAXBUF - 2
253
254                 // ProcessBuffer returns false if the user has gone over penalty
255                 if (!ServerInstance->Parser->ProcessBuffer(single_line, current) || one_only)
256                         break;
257         }
258 }
259
260 bool CommandParser::ProcessCommand(User *user, std::string &cmd)
261 {
262         std::vector<std::string> command_p;
263         irc::tokenstream tokens(cmd);
264         std::string command, token;
265         tokens.GetToken(command);
266
267         /* A client sent a nick prefix on their command (ick)
268          * rhapsody and some braindead bouncers do this --
269          * the rfc says they shouldnt but also says the ircd should
270          * discard it if they do.
271          */
272         if (command[0] == ':')
273                 tokens.GetToken(command);
274
275         while (tokens.GetToken(token) && (command_p.size() <= MAXPARAMETERS))
276                 command_p.push_back(token);
277
278         std::transform(command.begin(), command.end(), command.begin(), ::toupper);
279                 
280         int MOD_RESULT = 0;
281         FOREACH_RESULT(I_OnPreCommand,OnPreCommand(command, command_p, user, false, cmd));
282         if (MOD_RESULT == 1) {
283                 return true;
284         }
285
286         /* find the command, check it exists */
287         Commandtable::iterator cm = cmdlist.find(command);
288         
289         if (cm == cmdlist.end())
290         {
291                 if (user->registered == REG_ALL)
292                 {
293                         user->WriteNumeric(ERR_UNKNOWNCOMMAND, "%s %s :Unknown command",user->nick.c_str(),command.c_str());
294                 }
295                 ServerInstance->stats->statsUnknown++;
296                 return true;
297         }
298
299         if (cm->second->max_params && command_p.size() > cm->second->max_params)
300         {
301                 /*
302                  * command_p input (assuming max_params 1):
303                  *      this
304                  *      is
305                  *      a
306                  *      test
307                  */
308                 std::string lparam = "";
309
310                 /*
311                  * The '-1' here is a clever trick, we'll go backwards throwing everything into a temporary param
312                  * and then just toss that into the array.
313                  * -- w00t
314                  */
315                 while (command_p.size() > (cm->second->max_params - 1))
316                 {
317                         // BE CAREFUL: .end() returns past the end of the vector, hence decrement.
318                         std::vector<std::string>::iterator it = --command_p.end();
319                 
320                         lparam.insert(0, " " + *(it));
321                         command_p.erase(it); // remove last element
322                 }
323
324                 /* we now have (each iteration):
325                  *      ' test'
326                  *      ' a test'
327                  *      ' is a test' <-- final string
328                  * ...now remove the ' ' at the start...
329                  */
330                 lparam.erase(lparam.begin());
331
332                 /* param is now 'is a test', which is exactly what we wanted! */
333                 command_p.push_back(lparam);
334         }
335
336         /* Modify the user's penalty */
337         bool do_more = true;
338         if (!user->ExemptFromPenalty)
339         {
340                 user->IncreasePenalty(cm->second->Penalty);
341                 do_more = (user->Penalty < 10);
342                 if (!do_more)
343                         user->OverPenalty = true;
344         }
345
346         /* activity resets the ping pending timer */
347         if (user->MyClass)
348                 user->nping = ServerInstance->Time() + user->MyClass->GetPingTime();
349
350         if (cm->second->flags_needed)
351         {
352                 if (!user->IsModeSet(cm->second->flags_needed))
353                 {
354                         user->WriteNumeric(ERR_NOPRIVILEGES, "%s :Permission Denied - You do not have the required operator privileges",user->nick.c_str());
355                         return do_more;
356                 }
357                 if (!user->HasPermission(command))
358                 {
359                         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());
360                         return do_more;
361                 }
362         }
363         if ((user->registered == REG_ALL) && (!IS_OPER(user)) && (cm->second->IsDisabled()))
364         {
365                 /* command is disabled! */
366                 if (ServerInstance->Config->DisabledDontExist)
367                 {
368                         user->WriteNumeric(ERR_UNKNOWNCOMMAND, "%s %s :Unknown command",user->nick.c_str(),command.c_str());
369                 }
370                 else
371                 {
372                         user->WriteNumeric(ERR_UNKNOWNCOMMAND, "%s %s :This command has been disabled.",
373                                                                                 user->nick.c_str(), command.c_str());
374                 }
375
376                 ServerInstance->SNO->WriteToSnoMask('d', "%s denied for %s (%s@%s)",
377                                 command.c_str(), user->nick.c_str(), user->ident.c_str(), user->host.c_str());
378                 return do_more;
379         }
380         if (command_p.size() < cm->second->min_params)
381         {
382                 user->WriteNumeric(ERR_NEEDMOREPARAMS, "%s %s :Not enough parameters.", user->nick.c_str(), command.c_str());
383                 if ((ServerInstance->Config->SyntaxHints) && (user->registered == REG_ALL) && (cm->second->syntax.length()))
384                         user->WriteNumeric(RPL_SYNTAX, "%s :SYNTAX %s %s", user->nick.c_str(), cm->second->command.c_str(), cm->second->syntax.c_str());
385                 return do_more;
386         }
387         if ((user->registered != REG_ALL) && (!cm->second->WorksBeforeReg()))
388         {
389                 user->WriteNumeric(ERR_NOTREGISTERED, "%s :You have not registered",command.c_str());
390                 return do_more;
391         }
392         else
393         {
394                 /* passed all checks.. first, do the (ugly) stats counters. */
395                 cm->second->use_count++;
396                 cm->second->total_bytes += cmd.length();
397
398                 /* module calls too */
399                 MOD_RESULT = 0;
400                 FOREACH_RESULT(I_OnPreCommand,OnPreCommand(command, command_p, user, true, cmd));
401                 if (MOD_RESULT == 1)
402                         return do_more;
403
404                 /*
405                  * WARNING: be careful, the user may be deleted soon
406                  */
407                 CmdResult result = cm->second->Handle(command_p, user);
408
409                 FOREACH_MOD(I_OnPostCommand,OnPostCommand(command, command_p, user, result,cmd));
410                 return do_more;
411         }
412 }
413
414 void CommandParser::RemoveCommands(const char* source)
415 {
416         Commandtable::iterator i,safei;
417         for (i = cmdlist.begin(); i != cmdlist.end();)
418         {
419                 safei = i;
420                 i++;
421                 RemoveCommand(safei, source);
422         }
423 }
424
425 void CommandParser::RemoveCommand(Commandtable::iterator safei, const char* source)
426 {
427         Command* x = safei->second;
428         if (x->source == std::string(source))
429         {
430                 cmdlist.erase(safei);
431                 delete x;
432         }
433 }
434
435 bool CommandParser::ProcessBuffer(std::string &buffer,User *user)
436 {
437         std::string::size_type a;
438
439         if (!user)
440                 return true;
441
442         while ((a = buffer.rfind("\n")) != std::string::npos)
443                 buffer.erase(a);
444         while ((a = buffer.rfind("\r")) != std::string::npos)
445                 buffer.erase(a);
446
447         if (buffer.length())
448         {
449                 ServerInstance->Logs->Log("USERINPUT", DEBUG,"C[%d] I :%s %s",user->GetFd(), user->nick.c_str(), buffer.c_str());
450                 return this->ProcessCommand(user,buffer);
451         }
452
453         return true;
454 }
455
456 bool CommandParser::CreateCommand(Command *f, void* so_handle)
457 {
458         if (so_handle)
459         {
460                 if (RFCCommands.find(f->command) == RFCCommands.end())
461                         RFCCommands[f->command] = so_handle;
462                 else
463                 {
464                         ServerInstance->Logs->Log("COMMAND",DEFAULT,"ERK! Somehow, we loaded a cmd_*.so file twice! Only the first instance is being recorded.");
465                         return false;
466                 }
467         }
468
469         /* create the command and push it onto the table */
470         if (cmdlist.find(f->command) == cmdlist.end())
471         {
472                 cmdlist[f->command] = f;
473                 return true;
474         }
475         else return false;
476 }
477
478 CommandParser::CommandParser(InspIRCd* Instance) : ServerInstance(Instance)
479 {
480         para.resize(128);
481 }
482
483 bool CommandParser::FindSym(void** v, void* h, const std::string &name)
484 {
485         *v = dlsym(h, "init_command");
486         const char* err = dlerror();
487         if (err && !(*v))
488         {
489                 ServerInstance->Logs->Log("COMMAND",SPARSE, "Error loading core command %s: %s\n", name.c_str(), err);
490                 return false;
491         }
492         return true;
493 }
494
495 bool CommandParser::ReloadCommand(std::string cmd, User* user)
496 {
497         char filename[MAXBUF];
498         std::transform(cmd.begin(), cmd.end(), cmd.begin(), ::toupper);
499
500         SharedObjectList::iterator command = RFCCommands.find(cmd);
501
502         if (command != RFCCommands.end())
503         {
504                 Command* cmdptr = cmdlist.find(cmd)->second;
505                 cmdlist.erase(cmdlist.find(cmd));
506
507                 RFCCommands.erase(cmd);
508                 std::transform(cmd.begin(), cmd.end(), cmd.begin(), ::tolower);
509                 delete cmdptr;
510                 dlclose(command->second);
511
512                 snprintf(filename, MAXBUF, "cmd_%s.so", cmd.c_str());
513                 const char* err = this->LoadCommand(filename);
514                 if (err)
515                 {
516                         if (user)
517                                 user->WriteServ("NOTICE %s :*** Error loading 'cmd_%s.so': %s", user->nick.c_str(), cmd.c_str(), err);
518                         return false;
519                 }
520
521                 return true;
522         }
523
524         return false;
525 }
526
527 CmdResult cmd_reload::Handle(const std::vector<std::string>& parameters, User *user)
528 {
529         if (parameters.size() < 1)
530                 return CMD_FAILURE;
531
532         user->WriteServ("NOTICE %s :*** Reloading command '%s'",user->nick.c_str(), parameters[0].c_str());
533         if (ServerInstance->Parser->ReloadCommand(parameters[0], user))
534         {
535                 user->WriteServ("NOTICE %s :*** Successfully reloaded command '%s'", user->nick.c_str(), parameters[0].c_str());
536                 ServerInstance->SNO->WriteToSnoMask('A', "RELOAD: %s reloaded the '%s' command.", user->nick.c_str(), parameters[0].c_str());
537                 return CMD_SUCCESS;
538         }
539         else
540         {
541                 user->WriteServ("NOTICE %s :*** Could not reload command '%s' -- fix this problem, then /REHASH as soon as possible!", user->nick.c_str(), parameters[0].c_str());
542                 return CMD_FAILURE;
543         }
544 }
545
546 const char* CommandParser::LoadCommand(const char* name)
547 {
548         char filename[MAXBUF];
549         void* h;
550         Command* (*cmd_factory_func)(InspIRCd*);
551
552         /* Command already exists? Succeed silently - this is needed for REHASH */
553         if (RFCCommands.find(name) != RFCCommands.end())
554         {
555                 ServerInstance->Logs->Log("COMMAND",DEBUG,"Not reloading command %s/%s, it already exists", LIBRARYDIR, name);
556                 return NULL;
557         }
558
559         snprintf(filename, MAXBUF, "%s/%s", LIBRARYDIR, name);
560         h = dlopen(filename, RTLD_NOW | RTLD_GLOBAL);
561
562         if (!h)
563         {
564                 const char* n = dlerror();
565                 ServerInstance->Logs->Log("COMMAND",SPARSE, "Error loading core command %s: %s", name, n);
566                 return n;
567         }
568
569         if (this->FindSym((void **)&cmd_factory_func, h, name))
570         {
571                 Command* newcommand = cmd_factory_func(ServerInstance);
572                 this->CreateCommand(newcommand, h);
573         }
574         return NULL;
575 }
576
577 void CommandParser::SetupCommandTable(User* user)
578 {
579         RFCCommands.clear();
580
581         if (!user)
582         {
583                 printf("\nLoading core commands");
584                 fflush(stdout);
585         }
586
587         DIR* library = opendir(LIBRARYDIR);
588         if (library)
589         {
590                 dirent* entry = NULL;
591                 while (0 != (entry = readdir(library)))
592                 {
593                         if (InspIRCd::Match(entry->d_name, "cmd_*.so"))
594                         {
595                                 if (!user)
596                                 {
597                                         printf(".");
598                                         fflush(stdout);
599                                 }
600                                 const char* err = this->LoadCommand(entry->d_name);
601                                 if (err)
602                                 {
603                                         if (user)
604                                         {
605                                                 user->WriteServ("NOTICE %s :*** Failed to load core command %s: %s", user->nick.c_str(), entry->d_name, err);
606                                         }
607                                         else
608                                         {
609                                                 printf("Error loading %s: %s", entry->d_name, err);
610                                                 exit(EXIT_STATUS_BADHANDLER);
611                                         }
612                                 }
613                         }
614                 }
615                 closedir(library);
616                 if (!user)
617                         printf("\n");
618         }
619
620         if (cmdlist.find("RELOAD") == cmdlist.end())
621                 this->CreateCommand(new cmd_reload(ServerInstance));
622 }
623
624 int CommandParser::TranslateUIDs(TranslateType to, const std::string &source, std::string &dest)
625 {
626         User* user = NULL;
627         std::string item;
628         int translations = 0;
629         dest.clear();
630
631         switch (to)
632         {
633                 case TR_NICK:
634                         /* Translate single nickname */
635                         user = ServerInstance->FindNick(source);
636                         if (user)
637                         {
638                                 dest = user->uuid;
639                                 translations++;
640                         }
641                         else
642                                 dest = source;
643                 break;
644                 case TR_NICKLIST:
645                 {
646                         /* Translate comma seperated list of nicknames */
647                         irc::commasepstream items(source);
648                         while (items.GetToken(item))
649                         {
650                                 user = ServerInstance->FindNick(item);
651                                 if (user)
652                                 {
653                                         dest.append(user->uuid);
654                                         translations++;
655                                 }
656                                 else
657                                         dest.append(item);
658                                 dest.append(",");
659                         }
660                         if (!dest.empty())
661                                 dest.erase(dest.end() - 1);
662                 }
663                 break;
664                 case TR_SPACENICKLIST:
665                 {
666                         /* Translate space seperated list of nicknames */
667                         irc::spacesepstream items(source);
668                         while (items.GetToken(item))
669                         {
670                                 user = ServerInstance->FindNick(item);
671                                 if (user)
672                                 {
673                                         dest.append(user->uuid);
674                                         translations++;
675                                 }
676                                 else
677                                         dest.append(item);
678                                 dest.append(" ");
679                         }
680                         if (!dest.empty())
681                                 dest.erase(dest.end() - 1);
682                 }
683                 break;
684                 case TR_END:
685                 case TR_TEXT:
686                 default:
687                         /* Do nothing */
688                         dest = source;
689                 break;
690         }
691
692         return translations;
693 }
694
695