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