]> git.netwichtig.de Git - user/henk/code/inspircd.git/blob - src/command_parse.cpp
d0b1148165815f494225d1dcff3986643876f7d6
[user/henk/code/inspircd.git] / src / command_parse.cpp
1 /*       +------------------------------------+
2  *       | Inspire Internet Relay Chat Daemon |
3  *       +------------------------------------+
4  *
5  *  InspIRCd: (C) 2002-2009 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
34         /* Module matched */
35         if (MOD_RESULT == 1)
36                 return 0;
37
38         /* Module explicitly didnt match */
39         if (MOD_RESULT == -1)
40                 return 1;
41
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 */
45                 return 1;
46
47         return (data != input); // this seems back to front, but returns 0 if they *match*, 1 else
48 }
49
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.
59  */
60 int CommandParser::LoopCall(User* user, Command* CommandObj, const std::vector<std::string>& parameters, unsigned int splithere, unsigned int extra)
61 {
62         if (splithere >= parameters.size())
63                 return 0;
64
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.
67          */
68         if (parameters[splithere].find(',') == std::string::npos)
69                 return 0;
70
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.
73          * ...VOOODOOOO!
74          */
75         std::set<irc::string> dupes;
76
77         /* Create two lists, one for channel names, one for keys
78          */
79         irc::commasepstream items1(parameters[splithere]);
80         irc::commasepstream items2(parameters[extra]);
81         std::string extrastuff;
82         std::string item;
83         unsigned int max = 0;
84
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.
88          */
89         while (items1.GetToken(item) && (max++ < ServerInstance->Config->MaxTargets))
90         {
91                 if (dupes.find(item.c_str()) == dupes.end())
92                 {
93                         std::vector<std::string> new_parameters;
94
95                         for (unsigned int t = 0; (t < parameters.size()) && (t < MAXPARAMETERS); t++)
96                                 new_parameters.push_back(parameters[t]);
97
98                         if (!items2.GetToken(extrastuff))
99                                 extrastuff = "";
100
101                         new_parameters[splithere] = item.c_str();
102                         new_parameters[extra] = extrastuff.c_str();
103
104                         CommandObj->Handle(new_parameters, user);
105
106                         dupes.insert(item.c_str());
107                 }
108         }
109         return 1;
110 }
111
112 int CommandParser::LoopCall(User* user, Command* CommandObj, const std::vector<std::string>& parameters, unsigned int splithere)
113 {
114         if (splithere >= parameters.size())
115                 return 0;
116
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.
119          */
120         if (parameters[splithere].find(',') == std::string::npos)
121                 return 0;
122
123         std::set<irc::string> dupes;
124
125         /* Only one commasepstream here */
126         irc::commasepstream items1(parameters[splithere]);
127         std::string item;
128         unsigned int max = 0;
129
130         /* Parse the commasepstream until there are no tokens remaining.
131          * Each token we parse out, call the command handler that called us
132          * with it
133          */
134         while (items1.GetToken(item) && (max++ < ServerInstance->Config->MaxTargets))
135         {
136                 if (dupes.find(item.c_str()) == dupes.end())
137                 {
138                         std::vector<std::string> new_parameters;
139
140                         for (unsigned int t = 0; (t < parameters.size()) && (t < MAXPARAMETERS); t++)
141                                 new_parameters.push_back(parameters[t]);
142
143                         new_parameters[splithere] = item.c_str();
144
145                         /* Execute the command handler. */
146                         CommandObj->Handle(new_parameters, user);
147
148                         dupes.insert(item.c_str());
149                 }
150         }
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.
154          */
155         return 1;
156 }
157
158 bool CommandParser::IsValidCommand(const std::string &commandname, unsigned int pcnt, User * user)
159 {
160         Commandtable::iterator n = cmdlist.find(commandname);
161
162         if (n != cmdlist.end())
163         {
164                 if ((pcnt >= n->second->min_params) && (n->second->source != "<core>"))
165                 {
166                         if (IS_LOCAL(user) && n->second->flags_needed)
167                         {
168                                 if (user->IsModeSet(n->second->flags_needed))
169                                 {
170                                         return (user->HasPermission(commandname));
171                                 }
172                         }
173                         else
174                         {
175                                 return true;
176                         }
177                 }
178         }
179         return false;
180 }
181
182 Command* CommandParser::GetHandler(const std::string &commandname)
183 {
184         Commandtable::iterator n = cmdlist.find(commandname);
185         if (n != cmdlist.end())
186                 return n->second;
187
188         return NULL;
189 }
190
191 // calls a handler function for a command
192
193 CmdResult CommandParser::CallHandler(const std::string &commandname, const std::vector<std::string>& parameters, User *user)
194 {
195         Commandtable::iterator n = cmdlist.find(commandname);
196
197         if (n != cmdlist.end())
198         {
199                 if (parameters.size() >= n->second->min_params)
200                 {
201                         bool bOkay = false;
202
203                         if (IS_LOCAL(user) && n->second->flags_needed)
204                         {
205                                 /* if user is local, and flags are needed .. */
206
207                                 if (user->IsModeSet(n->second->flags_needed))
208                                 {
209                                         /* if user has the flags, and now has the permissions, go ahead */
210                                         if (user->HasPermission(commandname))
211                                                 bOkay = true;
212                                 }
213                         }
214                         else
215                         {
216                                 /* remote or no flags required anyway */
217                                 bOkay = true;
218                         }
219
220                         if (bOkay)
221                         {
222                                 return n->second->Handle(parameters,user);
223                         }
224                 }
225         }
226         return CMD_INVALID;
227 }
228
229 void CommandParser::DoLines(User* current, bool one_only)
230 {
231         while (current->BufferIsReady())
232         {
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();
236                 current->cmds_in++;
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
239
240                 // ProcessBuffer returns false if the user has gone over penalty
241                 if (!ServerInstance->Parser->ProcessBuffer(single_line, current) || one_only)
242                         break;
243         }
244 }
245
246 bool CommandParser::ProcessCommand(User *user, std::string &cmd)
247 {
248         std::vector<std::string> command_p;
249         irc::tokenstream tokens(cmd);
250         std::string command, token;
251         tokens.GetToken(command);
252
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.
257          */
258         if (command[0] == ':')
259                 tokens.GetToken(command);
260
261         while (tokens.GetToken(token) && (command_p.size() <= MAXPARAMETERS))
262                 command_p.push_back(token);
263
264         std::transform(command.begin(), command.end(), command.begin(), ::toupper);
265
266         /* find the command, check it exists */
267         Commandtable::iterator cm = cmdlist.find(command);
268
269         if (cm == cmdlist.end())
270         {
271                 int MOD_RESULT = 0;
272                 FOREACH_RESULT(I_OnPreCommand,OnPreCommand(command, command_p, user, false, cmd));
273                 if (MOD_RESULT == 1)
274                         return true;
275
276                 /*
277                  * This double lookup is in case a module (abbreviation) wishes to change a command.
278                  * Sure, the double lookup is a bit painful, but bear in mind this only happens for unknowns anyway.
279                  *
280                  * Thanks dz for making me actually understand why this is necessary!
281                  * -- w00t
282                  */
283                 cm = cmdlist.find(command);
284                 if (cm == cmdlist.end())
285                 {
286                         if (user->registered == REG_ALL)
287                                 user->WriteNumeric(ERR_UNKNOWNCOMMAND, "%s %s :Unknown command",user->nick.c_str(),command.c_str());
288                         ServerInstance->stats->statsUnknown++;
289                         return true;
290                 }
291         }
292
293         if (cm->second->max_params && command_p.size() > cm->second->max_params)
294         {
295                 /*
296                  * command_p input (assuming max_params 1):
297                  *      this
298                  *      is
299                  *      a
300                  *      test
301                  */
302                 std::string lparam = "";
303
304                 /*
305                  * The '-1' here is a clever trick, we'll go backwards throwing everything into a temporary param
306                  * and then just toss that into the array.
307                  * -- w00t
308                  */
309                 while (command_p.size() > (cm->second->max_params - 1))
310                 {
311                         // BE CAREFUL: .end() returns past the end of the vector, hence decrement.
312                         std::vector<std::string>::iterator it = --command_p.end();
313
314                         lparam.insert(0, " " + *(it));
315                         command_p.erase(it); // remove last element
316                 }
317
318                 /* we now have (each iteration):
319                  *      ' test'
320                  *      ' a test'
321                  *      ' is a test' <-- final string
322                  * ...now remove the ' ' at the start...
323                  */
324                 lparam.erase(lparam.begin());
325
326                 /* param is now 'is a test', which is exactly what we wanted! */
327                 command_p.push_back(lparam);
328         }
329
330         /*
331          * We call OnPreCommand here seperately if the command exists, so the magic above can
332          * truncate to max_params if necessary. -- w00t
333          */
334         int MOD_RESULT = 0;
335         FOREACH_RESULT(I_OnPreCommand,OnPreCommand(command, command_p, user, false, cmd));
336         if (MOD_RESULT == 1)
337                 return true;
338
339         /* Modify the user's penalty */
340         bool do_more = true;
341         if (!user->HasPrivPermission("users/flood/no-throttle"))
342         {
343                 user->IncreasePenalty(cm->second->Penalty);
344                 do_more = (user->Penalty < 10);
345         }
346
347         /* activity resets the ping pending timer */
348         if (user->MyClass)
349                 user->nping = ServerInstance->Time() + user->MyClass->GetPingTime();
350
351         if (cm->second->flags_needed)
352         {
353                 if (!user->IsModeSet(cm->second->flags_needed))
354                 {
355                         user->WriteNumeric(ERR_NOPRIVILEGES, "%s :Permission Denied - You do not have the required operator privileges",user->nick.c_str());
356                         return do_more;
357                 }
358                 if (!user->HasPermission(command))
359                 {
360                         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());
361                         return do_more;
362                 }
363         }
364         if ((user->registered == REG_ALL) && (!IS_OPER(user)) && (cm->second->IsDisabled()))
365         {
366                 /* command is disabled! */
367                 if (ServerInstance->Config->DisabledDontExist)
368                 {
369                         user->WriteNumeric(ERR_UNKNOWNCOMMAND, "%s %s :Unknown command",user->nick.c_str(),command.c_str());
370                 }
371                 else
372                 {
373                         user->WriteNumeric(ERR_UNKNOWNCOMMAND, "%s %s :This command has been disabled.",
374                                                                                 user->nick.c_str(), command.c_str());
375                 }
376
377                 ServerInstance->SNO->WriteToSnoMask('d', "%s denied for %s (%s@%s)",
378                                 command.c_str(), user->nick.c_str(), user->ident.c_str(), user->host.c_str());
379                 return do_more;
380         }
381         if (command_p.size() < cm->second->min_params)
382         {
383                 user->WriteNumeric(ERR_NEEDMOREPARAMS, "%s %s :Not enough parameters.", user->nick.c_str(), command.c_str());
384                 if ((ServerInstance->Config->SyntaxHints) && (user->registered == REG_ALL) && (cm->second->syntax.length()))
385                         user->WriteNumeric(RPL_SYNTAX, "%s :SYNTAX %s %s", user->nick.c_str(), cm->second->command.c_str(), cm->second->syntax.c_str());
386                 return do_more;
387         }
388         if ((user->registered != REG_ALL) && (!cm->second->WorksBeforeReg()))
389         {
390                 user->WriteNumeric(ERR_NOTREGISTERED, "%s :You have not registered",command.c_str());
391                 return do_more;
392         }
393         else
394         {
395                 /* passed all checks.. first, do the (ugly) stats counters. */
396                 cm->second->use_count++;
397                 cm->second->total_bytes += cmd.length();
398
399                 /* module calls too */
400                 MOD_RESULT = 0;
401                 FOREACH_RESULT(I_OnPreCommand,OnPreCommand(command, command_p, user, true, cmd));
402                 if (MOD_RESULT == 1)
403                         return do_more;
404
405                 /*
406                  * WARNING: be careful, the user may be deleted soon
407                  */
408                 CmdResult result = cm->second->Handle(command_p, user);
409
410                 FOREACH_MOD(I_OnPostCommand,OnPostCommand(command, command_p, user, result,cmd));
411                 return do_more;
412         }
413 }
414
415 void CommandParser::RemoveCommands(const char* source)
416 {
417         Commandtable::iterator i,safei;
418         for (i = cmdlist.begin(); i != cmdlist.end();)
419         {
420                 safei = i;
421                 i++;
422                 RemoveCommand(safei, source);
423         }
424 }
425
426 void CommandParser::RemoveCommand(Commandtable::iterator safei, const char* source)
427 {
428         Command* x = safei->second;
429         if (x->source == std::string(source))
430         {
431                 cmdlist.erase(safei);
432                 delete x;
433         }
434 }
435
436 bool CommandParser::ProcessBuffer(std::string &buffer,User *user)
437 {
438         std::string::size_type a;
439
440         if (!user)
441                 return true;
442
443         while ((a = buffer.rfind("\n")) != std::string::npos)
444                 buffer.erase(a);
445         while ((a = buffer.rfind("\r")) != std::string::npos)
446                 buffer.erase(a);
447
448         if (buffer.length())
449         {
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);
452         }
453
454         return true;
455 }
456
457 bool CommandParser::CreateCommand(Command *f, void* so_handle)
458 {
459         if (so_handle)
460         {
461                 if (RFCCommands.find(f->command) == RFCCommands.end())
462                         RFCCommands[f->command] = so_handle;
463                 else
464                 {
465                         ServerInstance->Logs->Log("COMMAND",DEFAULT,"ERK! Somehow, we loaded a cmd_*.so file twice! Only the first instance is being recorded.");
466                         return false;
467                 }
468         }
469
470         /* create the command and push it onto the table */
471         if (cmdlist.find(f->command) == cmdlist.end())
472         {
473                 cmdlist[f->command] = f;
474                 return true;
475         }
476         else return false;
477 }
478
479 CommandParser::CommandParser(InspIRCd* Instance) : ServerInstance(Instance)
480 {
481         para.resize(128);
482 }
483
484 bool CommandParser::FindSym(void** v, void* h, const std::string &name)
485 {
486         *v = dlsym(h, "init_command");
487         const char* err = dlerror();
488         if (err && !(*v))
489         {
490                 ServerInstance->Logs->Log("COMMAND",SPARSE, "Error loading core command %s: %s\n", name.c_str(), err);
491                 return false;
492         }
493         return true;
494 }
495
496 bool CommandParser::ReloadCommand(std::string cmd, User* user)
497 {
498         char filename[MAXBUF];
499         std::transform(cmd.begin(), cmd.end(), cmd.begin(), ::toupper);
500
501         SharedObjectList::iterator command = RFCCommands.find(cmd);
502
503         if (command != RFCCommands.end())
504         {
505                 Command* cmdptr = cmdlist.find(cmd)->second;
506                 cmdlist.erase(cmdlist.find(cmd));
507
508                 RFCCommands.erase(cmd);
509                 std::transform(cmd.begin(), cmd.end(), cmd.begin(), ::tolower);
510                 delete cmdptr;
511                 dlclose(command->second);
512
513                 snprintf(filename, MAXBUF, "cmd_%s.so", cmd.c_str());
514                 const char* err = this->LoadCommand(filename);
515                 if (err)
516                 {
517                         if (user)
518                                 user->WriteServ("NOTICE %s :*** Error loading 'cmd_%s.so': %s", user->nick.c_str(), cmd.c_str(), err);
519                         return false;
520                 }
521
522                 return true;
523         }
524
525         return false;
526 }
527
528 CmdResult CommandReload::Handle(const std::vector<std::string>& parameters, User *user)
529 {
530         if (parameters.size() < 1)
531                 return CMD_FAILURE;
532
533         user->WriteServ("NOTICE %s :*** Reloading command '%s'",user->nick.c_str(), parameters[0].c_str());
534         if (ServerInstance->Parser->ReloadCommand(parameters[0], user))
535         {
536                 user->WriteServ("NOTICE %s :*** Successfully reloaded command '%s'", user->nick.c_str(), parameters[0].c_str());
537                 ServerInstance->SNO->WriteToSnoMask('A', "RELOAD: %s reloaded the '%s' command.", user->nick.c_str(), parameters[0].c_str());
538                 return CMD_SUCCESS;
539         }
540         else
541         {
542                 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());
543                 return CMD_FAILURE;
544         }
545 }
546
547 const char* CommandParser::LoadCommand(const char* name)
548 {
549         char filename[MAXBUF];
550         void* h;
551         Command* (*cmd_factory_func)(InspIRCd*);
552
553         /* Command already exists? Succeed silently - this is needed for REHASH */
554         if (RFCCommands.find(name) != RFCCommands.end())
555         {
556                 ServerInstance->Logs->Log("COMMAND",DEBUG,"Not reloading command %s/%s, it already exists", LIBRARYDIR, name);
557                 return NULL;
558         }
559
560         snprintf(filename, MAXBUF, "%s/%s", LIBRARYDIR, name);
561         h = dlopen(filename, RTLD_NOW | RTLD_GLOBAL);
562
563         if (!h)
564         {
565                 const char* n = dlerror();
566                 ServerInstance->Logs->Log("COMMAND",SPARSE, "Error loading core command %s: %s", name, n);
567                 return n;
568         }
569
570         if (this->FindSym((void **)&cmd_factory_func, h, name))
571         {
572                 Command* newcommand = cmd_factory_func(ServerInstance);
573                 this->CreateCommand(newcommand, h);
574         }
575         return NULL;
576 }
577
578 /** This is only invoked on startup
579  */
580 void CommandParser::SetupCommandTable()
581 {
582         printf("\nLoading core commands");
583         fflush(stdout);
584
585         DIR* library = opendir(LIBRARYDIR);
586         if (library)
587         {
588                 dirent* entry = NULL;
589                 while (0 != (entry = readdir(library)))
590                 {
591                         if (InspIRCd::Match(entry->d_name, "cmd_*.so", ascii_case_insensitive_map))
592                         {
593                                 printf(".");
594                                 fflush(stdout);
595
596                                 const char* err = this->LoadCommand(entry->d_name);
597                                 if (err)
598                                 {
599                                         printf("Error loading %s: %s", entry->d_name, err);
600                                         exit(EXIT_STATUS_BADHANDLER);
601                                 }
602                         }
603                 }
604                 closedir(library);
605                 printf("\n");
606         }
607
608         if (cmdlist.find("RELOAD") == cmdlist.end())
609                 this->CreateCommand(new CommandReload(ServerInstance));
610 }
611
612 int CommandParser::TranslateUIDs(const std::vector<TranslateType> to, const std::string &source, std::string &dest)
613 {
614         irc::spacesepstream items(source);
615         std::vector<TranslateType>::const_iterator types = to.begin();
616         User* user = NULL;
617         std::string item;
618         int translations = 0;
619         dest.clear();
620
621         while (items.GetToken(item))
622         {
623                 TranslateType t = *types;
624                 types++;
625
626                 switch (t)
627                 {
628                         case TR_NICK:
629                                 /* Translate single nickname */
630                                 user = ServerInstance->FindNick(item);
631                                 if (user)
632                                 {
633                                         dest.append(user->uuid);
634                                         translations++;
635                                 }
636                                 else
637                                         dest.append(item);
638                         break;
639                         break;
640                         case TR_END:
641                         case TR_TEXT:
642                         default:
643                                 /* Do nothing */
644                                 dest.append(item);
645                         break;
646                 }
647                 dest.append(" ");
648         }
649
650         if (!dest.empty())
651                 dest.erase(dest.end() - 1);
652         return translations;
653 }
654
655 int CommandParser::TranslateUIDs(TranslateType to, const std::string &source, std::string &dest)
656 {
657         User* user = NULL;
658         std::string item;
659         int translations = 0;
660         dest.clear();
661
662         switch (to)
663         {
664                 case TR_NICK:
665                         /* Translate single nickname */
666                         user = ServerInstance->FindNick(source);
667                         if (user)
668                         {
669                                 dest = user->uuid;
670                                 translations++;
671                         }
672                         else
673                                 dest = source;
674                 break;
675                 case TR_END:
676                 case TR_TEXT:
677                 default:
678                         /* Do nothing */
679                         dest = source;
680                 break;
681         }
682
683         return translations;
684 }