ViewVC Help
View File | Revision Log | Show Annotations | View Changeset | Root Listing
root/svn/ircd-hybrid/trunk/src/parse.c
Revision: 8620
Committed: Sat Nov 3 17:46:37 2018 UTC (6 years, 9 months ago) by michael
Content type: text/x-csrc
File size: 18843 byte(s)
Log Message:
- Stylistic changes

File Contents

# Content
1 /*
2 * ircd-hybrid: an advanced, lightweight Internet Relay Chat Daemon (ircd)
3 *
4 * Copyright (c) 1997-2018 ircd-hybrid development team
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
19 * USA
20 */
21
22 /*! \file parse.c
23 * \brief The message parser.
24 * \version $Id$
25 */
26
27 #include "stdinc.h"
28 #include "client.h"
29 #include "parse.h"
30 #include "channel.h"
31 #include "hash.h"
32 #include "id.h"
33 #include "irc_string.h"
34 #include "ircd.h"
35 #include "numeric.h"
36 #include "log.h"
37 #include "send.h"
38 #include "conf.h"
39 #include "memory.h"
40 #include "user.h"
41 #include "server.h"
42
43
44 /*
45 * (based on orabidoo's parser code)
46 *
47 * This has always just been a trie. Look at volume III of Knuth ACP
48 *
49 *
50 * ok, you start out with an array of pointers, each one corresponds
51 * to a letter at the current position in the command being examined.
52 *
53 * so roughly you have this for matching 'trie' or 'tie'
54 *
55 * 't' points -> [MessageTree *] 'r' -> [MessageTree *] -> 'i'
56 * -> [MessageTree *] -> [MessageTree *] -> 'e' and matches
57 *
58 * 'i' -> [MessageTree *] -> 'e' and matches
59 *
60 * BUGS (Limitations!)
61 *
62 * I designed this trie to parse ircd commands. Hence it currently
63 * casefolds. This is trivial to fix by increasing MAXPTRLEN.
64 * This trie also "folds" '{' etc. down. This means, the input to this
65 * trie must be alpha tokens only. This again, is a limitation that
66 * can be overcome by increasing MAXPTRLEN to include upper/lower case
67 * at the expense of more memory. At the extreme end, you could make
68 * MAXPTRLEN 128.
69 *
70 * This is also not a patricia trie. On short ircd tokens, this is
71 * not likely going to matter.
72 *
73 * Diane Bruce (Dianora), June 6 2003
74 */
75
76 /*
77 * Must be a power of 2, and larger than 26 [a-z]|[A-Z]. It's used to allocate
78 * the set of pointers at each node of the tree.
79 * There are MAXPTRLEN pointers at each node. Obviously, there have to be more
80 * pointers than ASCII letters. 32 is a nice number since there is then no need
81 * to shift 'A'/'a' to base 0 index, at the expense of a few never used
82 * pointers.
83 * For a small parser like this, this is a good compromise and does
84 * make it somewhat faster. - Dianora
85 */
86 enum { MAXPTRLEN = 32 };
87
88
89 static struct MessageTree
90 {
91 int links; /* Count of all pointers (including msg) at this node
92 * used as reference count for deletion of _this_ node.
93 */
94 struct Message *msg;
95 struct MessageTree *pointers[MAXPTRLEN];
96 } msg_tree;
97
98
99 /* remove_unknown()
100 *
101 * inputs -
102 * output -
103 * side effects -
104 */
105 static void
106 parse_remove_unknown(struct Client *client_p, const char *lsender, char *lbuffer)
107 {
108 /*
109 * Do kill if it came from a server because it means there is a ghost
110 * user on the other server which needs to be removed. -avalon
111 * Tell opers about this. -Taner
112 */
113 /*
114 * '[0-9]something' is an ID (KILL/SQUIT depending on its length)
115 * 'nodots' is a nickname (KILL)
116 * 'no.dot.at.start' is a server (SQUIT)
117 */
118 if ((IsDigit(*lsender) && strlen(lsender) <= IRC_MAXSID) || strchr(lsender, '.'))
119 {
120 sendto_realops_flags(UMODE_DEBUG, L_ADMIN, SEND_NOTICE,
121 "Unknown prefix (%s) from %s, Squitting %s",
122 lbuffer, client_get_name(client_p, SHOW_IP), lsender);
123 sendto_realops_flags(UMODE_DEBUG, L_OPER, SEND_NOTICE,
124 "Unknown prefix (%s) from %s, Squitting %s",
125 lbuffer, client_get_name(client_p, MASK_IP), lsender);
126 sendto_one(client_p, ":%s SQUIT %s :(Unknown prefix (%s) from %s)",
127 me.id, lsender, lbuffer, client_p->name);
128 }
129 else
130 sendto_one(client_p, ":%s KILL %s :%s (Unknown Client)",
131 me.id, lsender, me.name);
132 }
133
134 /*
135 *
136 * parc number of arguments ('sender' counted as one!)
137 * parv[0] pointer to 'sender' (may point to empty string) (not used)
138 * parv[1]..parv[parc-1]
139 * pointers to additional parameters, this is a NULL
140 * terminated list (parv[parc] == NULL).
141 *
142 * *WARNING*
143 * Numerics are mostly error reports. If there is something
144 * wrong with the message, just *DROP* it! Don't even think of
145 * sending back a neat error message -- big danger of creating
146 * a ping pong error message...
147 *
148 * Rewritten by Nemesi, Jan 1999, to support numeric nicks in parv[1]
149 *
150 * Called when we get a numeric message from a remote _server_ and we are
151 * supposed to forward it somewhere. Note that we always ignore numerics sent
152 * to 'me' and simply drop the message if we can't handle with this properly:
153 * the savvy approach is NEVER generate an error in response to an... error :)
154 */
155 static void
156 parse_handle_numeric(unsigned int numeric, struct Client *source_p, int parc, char *parv[])
157 {
158 struct Client *target_p = NULL;
159 struct Channel *chptr = NULL;
160
161 /*
162 * Avoid trash, we need it to come from a server and have a target
163 */
164 if (parc < 2 || !IsServer(source_p))
165 return;
166
167 /*
168 * Who should receive this message ? Will we do something with it ?
169 * Note that we use findUser functions, so the target can't be neither
170 * a server, nor a channel (?) nor a list of targets (?) .. u2.10
171 * should never generate numeric replies to non-users anyway
172 * Ahem... it can be a channel actually, csc bots use it :\ --Nem
173 */
174 if (IsChanPrefix(*parv[1]))
175 chptr = hash_find_channel(parv[1]);
176 else
177 target_p = find_person(source_p, parv[1]);
178
179 if ((target_p == NULL || target_p->from == source_p->from) && chptr == NULL)
180 return;
181
182 /*
183 * Remap low number numerics, not that I understand WHY.. --Nemesi
184 */
185 /*
186 * Numerics below 100 talk about the current 'connection', you're not
187 * connected to a remote server so it doesn't make sense to send them
188 * remotely - but the information they contain may be useful, so we
189 * remap them up. Weird, but true. -- Isomer
190 */
191 if (numeric < 100)
192 numeric += 100;
193
194 if (target_p)
195 {
196 /* Fake it for server hiding, if it's our client */
197 if ((ConfigServerHide.hide_servers || IsHidden(source_p)) && MyConnect(target_p) &&
198 !HasUMode(target_p, UMODE_OPER))
199 sendto_one_numeric(target_p, &me, numeric | SND_EXPLICIT, "%s", parv[2]);
200 else
201 sendto_one_numeric(target_p, source_p, numeric | SND_EXPLICIT, "%s", parv[2]);
202 }
203 else
204 sendto_channel_butone(source_p, source_p, chptr, 0, "%u %s %s",
205 numeric, chptr->name, parv[2]);
206 }
207
208 /* handle_command()
209 *
210 * inputs - pointer to message block
211 * - pointer to client
212 * - pointer to client message is from
213 * - count of number of args
214 * - pointer to argv[] array
215 * output - -1 if error from server
216 * side effects -
217 */
218 static void
219 parse_handle_command(struct Message *message, struct Client *source_p,
220 unsigned int i, char *para[])
221 {
222 if (IsServer(source_p->from))
223 ++message->rcount;
224
225 ++message->count;
226
227 /* Check right amount of parameters is passed... --is */
228 if (i < message->args_min)
229 sendto_one_numeric(source_p, &me, ERR_NEEDMOREPARAMS, message->cmd);
230 else
231 message->handlers[source_p->from->handler](source_p, i, para);
232 }
233
234 /*
235 * parse a buffer.
236 *
237 * NOTE: parse() should not be called recusively by any other functions!
238 */
239 void
240 parse(struct Client *client_p, char *pbuffer, char *bufend)
241 {
242 struct Client *from = client_p;
243 struct Message *message = NULL;
244 char *para[MAXPARA + 2]; /* <command> + <parameters> + NULL */
245 char *ch = NULL;
246 char *s = NULL;
247 unsigned int numeric = 0;
248 unsigned int parc = 0;
249 unsigned int paramcount;
250
251 if (IsDefunct(client_p))
252 return;
253
254 assert(client_p->connection);
255 assert(client_p->connection->fd);
256 assert(client_p->connection->fd->flags.open);
257
258
259 assert((bufend - pbuffer) < IRCD_BUFSIZE);
260
261 for (ch = pbuffer; *ch == ' '; ++ch) /* Skip spaces */
262 ;
263
264 if (*ch == ':')
265 {
266 /*
267 * Copy the prefix to 'sender' assuming it terminates
268 * with SPACE (or NULL, which is an error, though).
269 */
270 const char *const sender = ++ch;
271
272 if ((s = strchr(ch, ' ')))
273 {
274 *s = '\0';
275 ch = ++s;
276 }
277
278 if (*sender && IsServer(client_p))
279 {
280 if ((from = hash_find_id(sender)) == NULL)
281 from = hash_find_client(sender);
282
283 /*
284 * Hmm! If the client corresponding to the prefix is not found--what is
285 * the correct action??? Now, I will ignore the message (old IRC just
286 * let it through as if the prefix just wasn't there...) --msa
287 */
288 if (from == NULL)
289 {
290 ++ServerStats.is_unpf;
291 parse_remove_unknown(client_p, sender, pbuffer);
292 return;
293 }
294
295 if (from->from != client_p)
296 {
297 ++ServerStats.is_wrdi;
298 sendto_realops_flags(UMODE_DEBUG, L_ADMIN, SEND_NOTICE,
299 "Fake direction: dropped message from %s[%s] via %s",
300 from->name, from->from->name,
301 client_get_name(client_p, SHOW_IP));
302 sendto_realops_flags(UMODE_DEBUG, L_OPER, SEND_NOTICE,
303 "Fake direction: dropped message from %s[%s] via %s",
304 from->name, from->from->name,
305 client_get_name(client_p, MASK_IP));
306 return;
307 }
308 }
309
310 while (*ch == ' ')
311 ++ch;
312 }
313
314 if (*ch == '\0')
315 {
316 ++ServerStats.is_empt;
317 return;
318 }
319
320 /*
321 * Extract the command code from the packet. Point s to the end
322 * of the command code and calculate the length using pointer
323 * arithmetic. Note: only need length for numerics and *all*
324 * numerics must have parameters and thus a space after the command
325 * code. -avalon
326 */
327
328 /* EOB is 3 characters long but is not a numeric */
329 if (*(ch + 3) == ' ' && /* Ok, let's see if it's a possible numeric */
330 IsDigit(*ch) && IsDigit(*(ch + 1)) && IsDigit(*(ch + 2)))
331 {
332 numeric = (*ch - '0') * 100 + (*(ch + 1) - '0') * 10 + (*(ch + 2) - '0');
333 paramcount = 2; /* Destination, and the rest of it */
334 ++ServerStats.is_num;
335 s = ch + 3; /* I know this is ' ' from above if */
336 *s++ = '\0'; /* Blow away the ' ', and point s to next part */
337 }
338 else
339 {
340 if ((s = strchr(ch, ' ')))
341 *s++ = '\0';
342
343 if ((message = find_command(ch)) == NULL)
344 {
345 /*
346 * Note: Give error message *only* to recognized
347 * persons. It's a nightmare situation to have
348 * two programs sending "Unknown command"'s or
349 * equivalent to each other at full blast....
350 * If it has got to person state, it at least
351 * seems to be well behaving. Perhaps this message
352 * should never be generated, though... --msa
353 * Hm, when is the buffer empty -- if a command
354 * code has been found ?? -Armin
355 */
356 if (*pbuffer)
357 if (IsClient(from))
358 sendto_one_numeric(from, &me, ERR_UNKNOWNCOMMAND, ch);
359
360 ++ServerStats.is_unco;
361 return;
362 }
363
364 assert(message->cmd);
365
366 paramcount = message->args_max;
367
368 size_t length = bufend - ((s) ? s : ch);
369 message->bytes += length;
370 }
371
372 /*
373 * Must the following loop really be so devious? On surface it
374 * splits the message to parameters from blank spaces. But, if
375 * paramcount has been reached, the rest of the message goes into
376 * this last parameter (about same effect as ":" has...) --msa
377 */
378
379 /* Note initially true: s == NULL || *(s - 1) == '\0' !! */
380
381 para[parc] = ch;
382
383 if (message && (message->flags & MFLG_EXTRA))
384 {
385 /*
386 * XXX: This will have to go away after the command handler rewrite
387 */
388 para[++parc] = message->extra;
389 }
390
391 if (s)
392 {
393 if (paramcount > MAXPARA)
394 paramcount = MAXPARA;
395
396 while (1)
397 {
398 while (*s == ' ')
399 *s++ = '\0';
400
401 if (*s == '\0')
402 break;
403
404 if (*s == ':')
405 {
406 /* The rest is single parameter--can include blanks also. */
407 para[++parc] = s + (numeric == 0); /* Keep the colon if it's a numeric */
408 break;
409 }
410
411 para[++parc] = s;
412
413 if (parc >= paramcount)
414 break;
415
416 while (*s && *s != ' ')
417 ++s;
418 }
419 }
420
421 para[++parc] = NULL;
422
423 if (message)
424 parse_handle_command(message, from, parc, para);
425 else
426 parse_handle_numeric(numeric, from, parc, para);
427 }
428
429 /* add_msg_element()
430 *
431 * inputs - pointer to MessageTree
432 * - pointer to Message to add for given command
433 * - pointer to current portion of command being added
434 * output - NONE
435 * side effects - recursively build the Message Tree ;-)
436 */
437 /*
438 * How this works.
439 *
440 * The code first checks to see if its reached the end of the command
441 * If so, that struct MessageTree has a msg pointer updated and the links
442 * count incremented, since a msg pointer is a reference.
443 * Then the code descends recursively, building the trie.
444 * If a pointer index inside the struct MessageTree is NULL a new
445 * child struct MessageTree has to be allocated.
446 * The links (reference count) is incremented as they are created
447 * in the parent.
448 */
449 static void
450 add_msg_element(struct MessageTree *mtree_p, struct Message *msg_p,
451 const char *cmd)
452 {
453 struct MessageTree *ntree_p = NULL;
454
455 if (*cmd == '\0')
456 {
457 mtree_p->msg = msg_p;
458 mtree_p->links++; /* Have msg pointer, so up ref count */
459 }
460 else
461 {
462 /*
463 * *cmd & (MAXPTRLEN-1)
464 * convert the char pointed to at *cmd from ASCII to an integer
465 * between 0 and MAXPTRLEN.
466 * Thus 'A' -> 0x1 'B' -> 0x2 'c' -> 0x3 etc.
467 */
468 if ((ntree_p = mtree_p->pointers[*cmd & (MAXPTRLEN - 1)]) == NULL)
469 {
470 ntree_p = xcalloc(sizeof(*ntree_p));
471 mtree_p->pointers[*cmd & (MAXPTRLEN - 1)] = ntree_p;
472
473 mtree_p->links++; /* Have new pointer, so up ref count */
474 }
475
476 add_msg_element(ntree_p, msg_p, cmd + 1);
477 }
478 }
479
480 /* del_msg_element()
481 *
482 * inputs - Pointer to MessageTree to delete from
483 * - pointer to command name to delete
484 * output - NONE
485 * side effects - recursively deletes a token from the Message Tree ;-)
486 */
487 /*
488 * How this works.
489 *
490 * Well, first off, the code recursively descends into the trie
491 * until it finds the terminating letter of the command being removed.
492 * Once it has done that, it marks the msg pointer as NULL then
493 * reduces the reference count on that allocated struct MessageTree
494 * since a command counts as a reference.
495 *
496 * Then it pops up the recurse stack. As it comes back up the recurse
497 * The code checks to see if the child now has no pointers or msg
498 * i.e. the links count has gone to zero. If it's no longer used, the
499 * child struct MessageTree can be deleted. The parent reference
500 * to this child is then removed and the parents link count goes down.
501 * Thus, we continue to go back up removing all unused MessageTree(s)
502 */
503 static void
504 del_msg_element(struct MessageTree *mtree_p, const char *cmd)
505 {
506 struct MessageTree *ntree_p = NULL;
507
508 /*
509 * In case this is called for a nonexistent command
510 * check that there is a msg pointer here, else links-- goes -ve
511 * -db
512 */
513 if (*cmd == '\0' && mtree_p->msg)
514 {
515 mtree_p->msg = NULL;
516 mtree_p->links--;
517 }
518 else
519 {
520 if ((ntree_p = mtree_p->pointers[*cmd & (MAXPTRLEN - 1)]))
521 {
522 del_msg_element(ntree_p, cmd + 1);
523
524 if (ntree_p->links == 0)
525 {
526 mtree_p->pointers[*cmd & (MAXPTRLEN - 1)] = NULL;
527 mtree_p->links--;
528 xfree(ntree_p);
529 }
530 }
531 }
532 }
533
534 /* msg_tree_parse()
535 *
536 * inputs - Pointer to command to find
537 * - Pointer to MessageTree root
538 * output - Find given command returning Message * if found NULL if not
539 * side effects - none
540 */
541 static struct Message *
542 msg_tree_parse(const char *cmd)
543 {
544 struct MessageTree *mtree = &msg_tree;
545
546 assert(!EmptyString(cmd));
547
548 while (IsAlpha(*cmd) && (mtree = mtree->pointers[*cmd & (MAXPTRLEN - 1)]))
549 if (*++cmd == '\0')
550 return mtree->msg;
551
552 return NULL;
553 }
554
555 /* mod_add_cmd()
556 *
557 * inputs - pointer to struct Message
558 * output - none
559 * side effects - load this one command name
560 */
561 void
562 mod_add_cmd(struct Message *msg)
563 {
564 assert(msg);
565 assert(msg->cmd);
566
567 /* Command already added? */
568 if (msg_tree_parse(msg->cmd) == NULL)
569 add_msg_element(&msg_tree, msg, msg->cmd);
570 }
571
572 /* mod_del_cmd()
573 *
574 * inputs - pointer to struct Message
575 * output - none
576 * side effects - unload this one command name
577 */
578 void
579 mod_del_cmd(struct Message *msg)
580 {
581 assert(msg);
582 assert(msg->cmd);
583
584 if (msg_tree_parse(msg->cmd))
585 del_msg_element(&msg_tree, msg->cmd);
586 }
587
588 /* find_command()
589 *
590 * inputs - command name
591 * output - pointer to struct Message
592 * side effects - none
593 */
594 struct Message *
595 find_command(const char *cmd)
596 {
597 return msg_tree_parse(cmd);
598 }
599
600 static void
601 recurse_report_messages(struct Client *source_p, const struct MessageTree *mtree)
602 {
603 if (mtree->msg)
604 sendto_one_numeric(source_p, &me, RPL_STATSCOMMANDS,
605 mtree->msg->cmd,
606 mtree->msg->count, mtree->msg->bytes,
607 mtree->msg->rcount);
608
609 for (unsigned int i = 0; i < MAXPTRLEN; ++i)
610 if (mtree->pointers[i])
611 recurse_report_messages(source_p, mtree->pointers[i]);
612 }
613
614 /* report_messages()
615 *
616 * inputs - pointer to client to report to
617 * output - NONE
618 * side effects - client is shown list of commands
619 */
620 void
621 report_messages(struct Client *source_p)
622 {
623 const struct MessageTree *const mtree = &msg_tree;
624
625 for (unsigned int i = 0; i < MAXPTRLEN; ++i)
626 if (mtree->pointers[i])
627 recurse_report_messages(source_p, mtree->pointers[i]);
628 }
629
630 /* m_not_oper()
631 * inputs -
632 * output -
633 * side effects - just returns a nastyogram to given user
634 */
635 int
636 m_not_oper(struct Client *source_p, int parc, char *parv[])
637 {
638 sendto_one_numeric(source_p, &me, ERR_NOPRIVILEGES);
639 return 0;
640 }
641
642 int
643 m_unregistered(struct Client *source_p, int parc, char *parv[])
644 {
645 sendto_one_numeric(source_p, &me, ERR_NOTREGISTERED);
646 return 0;
647 }
648
649 int
650 m_registered(struct Client *source_p, int parc, char *parv[])
651 {
652 sendto_one_numeric(source_p, &me, ERR_ALREADYREGISTRED);
653 return 0;
654 }
655
656 int
657 m_ignore(struct Client *source_p, int parc, char *parv[])
658 {
659 return 0;
660 }

Properties

Name Value
svn:eol-style native
svn:keywords Id