]>
Commit | Line | Data |
---|---|---|
d76ed9a9 AS |
1 | /* helpfile.c - Help file loading and display |
2 | * Copyright 2000-2004 srvx Development Team | |
3 | * | |
83ff05c3 | 4 | * This file is part of x3. |
d76ed9a9 | 5 | * |
d0f04f71 | 6 | * x3 is free software; you can redistribute it and/or modify |
d76ed9a9 AS |
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 srvx; if not, write to the Free Software Foundation, | |
18 | * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. | |
19 | */ | |
20 | ||
21 | #include "conf.h" | |
22 | #include "helpfile.h" | |
23 | #include "log.h" | |
24 | #include "modcmd.h" | |
25 | #include "nickserv.h" | |
63c95a47 | 26 | #include "spamserv.h" |
d76ed9a9 AS |
27 | |
28 | #if defined(HAVE_DIRENT_H) | |
29 | #include <dirent.h> | |
30 | #endif | |
31 | ||
32 | #if defined(HAVE_SYS_STAT_H) | |
33 | #include <sys/stat.h> | |
34 | #endif | |
35 | ||
36 | static const struct message_entry msgtab[] = { | |
37 | { "HFMSG_MISSING_HELPFILE", "The help file could not be found. Sorry!" }, | |
38 | { "HFMSG_HELP_NOT_STRING", "Help file error (help data was not a string)." }, | |
39 | { NULL, NULL } | |
40 | }; | |
41 | ||
42 | #define DEFAULT_LINE_SIZE MAX_LINE_SIZE | |
43 | #define DEFAULT_TABLE_SIZE 80 | |
44 | ||
63c95a47 | 45 | extern struct userNode *global, *chanserv, *opserv, *nickserv, *spamserv; |
d76ed9a9 AS |
46 | struct userNode *message_dest; |
47 | struct userNode *message_source; | |
48 | struct language *lang_C; | |
49 | struct dict *languages; | |
50 | ||
51 | static void language_cleanup(void) | |
52 | { | |
53 | dict_delete(languages); | |
54 | } | |
55 | ||
56 | static void language_free_helpfile(void *data) | |
57 | { | |
58 | struct helpfile *hf = data; | |
59 | close_helpfile(hf); | |
60 | } | |
61 | ||
62 | static void language_free(void *data) | |
63 | { | |
64 | struct language *lang = data; | |
65 | dict_delete(lang->messages); | |
66 | dict_delete(lang->helpfiles); | |
67 | free(lang->name); | |
68 | free(lang); | |
69 | } | |
70 | ||
71 | static struct language *language_alloc(const char *name) | |
72 | { | |
73 | struct language *lang = calloc(1, sizeof(*lang)); | |
74 | lang->name = strdup(name); | |
75 | lang->parent = lang_C; | |
76 | if (!languages) { | |
77 | languages = dict_new(); | |
78 | dict_set_free_data(languages, language_free); | |
79 | } | |
80 | dict_insert(languages, lang->name, lang); | |
81 | return lang; | |
82 | } | |
83 | ||
84 | /* Language names should use a lang or lang_COUNTRY type system, where | |
85 | * lang is a two-letter code according to ISO-639-1 (or three-letter | |
86 | * code according to ISO-639-2 for languages not in ISO-639-1), and | |
87 | * COUNTRY is the ISO 3166 country code in all upper case. | |
88 | * | |
89 | * See also: | |
90 | * http://www.loc.gov/standards/iso639-2/ | |
91 | * http://www.loc.gov/standards/iso639-2/langhome.html | |
92 | * http://www.iso.ch/iso/en/prods-services/iso3166ma/index.html | |
93 | */ | |
94 | struct language *language_find(const char *name) | |
95 | { | |
96 | struct language *lang; | |
97 | char alt_name[MAXLEN]; | |
98 | const char *uscore; | |
99 | ||
100 | if ((lang = dict_find(languages, name, NULL))) | |
101 | return lang; | |
102 | if ((uscore = strchr(name, '_'))) { | |
103 | strncpy(alt_name, name, uscore-name); | |
104 | alt_name[uscore-name] = 0; | |
105 | if ((lang = dict_find(languages, alt_name, NULL))) | |
106 | return lang; | |
107 | } | |
108 | if (!lang_C) { | |
109 | lang_C = language_alloc("C"); | |
110 | lang_C->messages = dict_new(); | |
111 | lang_C->helpfiles = dict_new(); | |
112 | } | |
113 | return lang_C; | |
114 | } | |
115 | ||
116 | static void language_set_messages(struct language *lang, dict_t dict) | |
117 | { | |
118 | dict_iterator_t it, it2; | |
119 | struct record_data *rd; | |
120 | char *msg; | |
121 | int extra, missing; | |
122 | ||
123 | extra = missing = 0; | |
124 | for (it = dict_first(dict), it2 = dict_first(lang_C->messages); it; ) { | |
125 | const char *msgid = iter_key(it); | |
126 | int diff = it2 ? irccasecmp(msgid, iter_key(it2)) : -1; | |
127 | if (diff < 0) { | |
128 | extra++; | |
129 | it = iter_next(it); | |
130 | continue; | |
131 | } else if (diff > 0) { | |
132 | missing++; | |
133 | it2 = iter_next(it2); | |
134 | continue; | |
135 | } | |
136 | rd = iter_data(it); | |
137 | switch (rd->type) { | |
138 | case RECDB_QSTRING: | |
139 | msg = strdup(rd->d.qstring); | |
140 | break; | |
141 | case RECDB_STRING_LIST: | |
142 | /* XXX: maybe do an unlistify_help() type thing */ | |
143 | default: | |
144 | log_module(MAIN_LOG, LOG_WARNING, "Unsupported record type for message %s in language %s", msgid, lang->name); | |
145 | continue; | |
146 | } | |
147 | dict_insert(lang->messages, strdup(msgid), msg); | |
148 | it = iter_next(it); | |
149 | it2 = iter_next(it2); | |
150 | } | |
151 | while (it2) { | |
152 | missing++; | |
153 | it2 = iter_next(it2); | |
154 | } | |
155 | if (extra || missing) | |
156 | log_module(MAIN_LOG, LOG_WARNING, "In language %s, %d extra and %d missing messages.", lang->name, extra, missing); | |
157 | } | |
158 | ||
159 | static struct language *language_read(const char *name) | |
160 | { | |
161 | DIR *dir; | |
162 | struct dirent *dirent; | |
163 | struct language *lang; | |
164 | struct helpfile *hf; | |
165 | char filename[MAXLEN], *uscore; | |
166 | FILE *file; | |
167 | dict_t dict; | |
168 | ||
169 | /* Never try to read the C language from disk. */ | |
170 | if (!irccasecmp(name, "C")) | |
171 | return lang_C; | |
172 | ||
173 | /* Open the directory stream; if we can't, fail. */ | |
174 | snprintf(filename, sizeof(filename), "languages/%s", name); | |
2f61d1d7 | 175 | if (!(dir = opendir(filename))) { |
176 | log_module(MAIN_LOG, LOG_ERROR, "Unable to open language directory languages/%s: %s", name, strerror(errno)); | |
d76ed9a9 | 177 | return NULL; |
2f61d1d7 | 178 | } |
d76ed9a9 AS |
179 | if (!(lang = dict_find(languages, name, NULL))) |
180 | lang = language_alloc(name); | |
181 | ||
182 | /* Find the parent language. */ | |
183 | snprintf(filename, sizeof(filename), "languages/%s/parent", name); | |
184 | if (!(file = fopen(filename, "r")) | |
185 | || !fgets(filename, sizeof(filename), file)) { | |
186 | strcpy(filename, "C"); | |
187 | } | |
188 | if (!(lang->parent = language_find(filename))) { | |
189 | uscore = strchr(filename, '_'); | |
190 | if (uscore) { | |
191 | *uscore = 0; | |
192 | lang->parent = language_find(filename); | |
193 | } | |
194 | if (!lang->parent) | |
195 | lang->parent = lang_C; | |
196 | } | |
197 | ||
198 | /* (Re-)initialize the language's dicts. */ | |
199 | dict_delete(lang->messages); | |
200 | lang->messages = dict_new(); | |
201 | dict_set_free_keys(lang->messages, free); | |
202 | dict_set_free_data(lang->messages, free); | |
203 | lang->helpfiles = dict_new(); | |
204 | dict_set_free_data(lang->helpfiles, language_free_helpfile); | |
205 | ||
206 | /* Read all the translations from the directory. */ | |
207 | while ((dirent = readdir(dir))) { | |
208 | snprintf(filename, sizeof(filename), "languages/%s/%s", name, dirent->d_name); | |
209 | if (!strcmp(dirent->d_name,"parent")) { | |
210 | continue; | |
211 | } else if (!strcmp(dirent->d_name, "strings.db")) { | |
212 | dict = parse_database(filename); | |
213 | language_set_messages(lang, dict); | |
214 | free_database(dict); | |
215 | } else if ((hf = dict_find(lang_C->helpfiles, dirent->d_name, NULL))) { | |
216 | hf = open_helpfile(filename, hf->expand); | |
217 | dict_insert(lang->helpfiles, hf->name, hf); | |
218 | } | |
219 | } | |
220 | ||
221 | /* All done. */ | |
222 | closedir(dir); | |
223 | return lang; | |
224 | } | |
225 | ||
226 | static void language_read_list(void) | |
227 | { | |
2f61d1d7 | 228 | struct stat sbuf; |
d76ed9a9 AS |
229 | struct dirent *dirent; |
230 | DIR *dir; | |
2f61d1d7 | 231 | char namebuf[MAXLEN]; |
d76ed9a9 AS |
232 | |
233 | if (!(dir = opendir("languages"))) | |
234 | return; | |
235 | while ((dirent = readdir(dir))) { | |
236 | if (dirent->d_name[0] == '.') | |
237 | continue; | |
2f61d1d7 | 238 | snprintf(namebuf, sizeof(namebuf), "languages/%s", dirent->d_name); |
239 | if (stat(namebuf, &sbuf) < 0) { | |
240 | log_module(MAIN_LOG, LOG_INFO, "Skipping language entry '%s' (unable to stat).", dirent->d_name); | |
241 | continue; | |
242 | } | |
243 | if (!S_ISDIR(sbuf.st_mode)) { | |
244 | log_module(MAIN_LOG, LOG_INFO, "Skipping language entry '%s' (not directory).", dirent->d_name); | |
d76ed9a9 | 245 | continue; |
d76ed9a9 | 246 | } |
d76ed9a9 AS |
247 | language_alloc(dirent->d_name); |
248 | } | |
249 | closedir(dir); | |
250 | } | |
251 | ||
252 | const char *language_find_message(struct language *lang, const char *msgid) { | |
253 | struct language *curr; | |
254 | const char *msg; | |
255 | if (!lang) | |
256 | lang = lang_C; | |
257 | for (curr = lang; curr; curr = curr->parent) | |
258 | if ((msg = dict_find(curr->messages, msgid, NULL))) | |
259 | return msg; | |
260 | log_module(MAIN_LOG, LOG_ERROR, "Tried to find unregistered message \"%s\" (original language %s)", msgid, lang->name); | |
261 | return NULL; | |
262 | } | |
263 | ||
e6892204 AS |
264 | int strlen_vis(char *str) |
265 | { | |
266 | int count; | |
267 | for(count=0;*str;str++) | |
268 | if(!iscntrl(*str)) | |
269 | count++; | |
270 | return count; | |
271 | } | |
272 | ||
d76ed9a9 AS |
273 | void |
274 | table_send(struct userNode *from, const char *to, unsigned int size, irc_send_func irc_send, struct helpfile_table table) { | |
275 | unsigned int ii, jj, len, nreps, reps, tot_width, pos, spaces, *max_width; | |
276 | char line[MAX_LINE_SIZE+1]; | |
277 | struct handle_info *hi; | |
e6892204 | 278 | char *sepstr = NULL; |
a8370a20 | 279 | unsigned int sepsize = 0; |
d76ed9a9 AS |
280 | |
281 | if (IsChannelName(to) || *to == '$') { | |
282 | message_dest = NULL; | |
283 | hi = NULL; | |
284 | } else { | |
285 | message_dest = GetUserH(to); | |
286 | if (!message_dest) { | |
287 | log_module(MAIN_LOG, LOG_ERROR, "Unable to find user with nickname %s (in table_send from %s).", to, from->nick); | |
288 | return; | |
289 | } | |
290 | hi = message_dest->handle_info; | |
291 | #ifdef WITH_PROTOCOL_P10 | |
292 | to = message_dest->numeric; | |
293 | #endif | |
294 | } | |
295 | message_source = from; | |
296 | ||
297 | /* If size or irc_send are 0, we should try to use a default. */ | |
298 | if (size) | |
299 | {} /* keep size */ | |
300 | else if (!hi) | |
301 | size = DEFAULT_TABLE_SIZE; | |
302 | else if (hi->table_width) | |
303 | size = hi->table_width; | |
304 | else if (hi->screen_width) | |
305 | size = hi->screen_width; | |
306 | else | |
307 | size = DEFAULT_TABLE_SIZE; | |
308 | ||
309 | if (irc_send) | |
310 | {} /* use that function */ | |
311 | else if (hi) | |
312 | irc_send = HANDLE_FLAGGED(hi, USE_PRIVMSG) ? irc_privmsg : irc_notice; | |
313 | else | |
314 | irc_send = IsChannelName(to) ? irc_privmsg : irc_notice; | |
315 | ||
316 | /* Limit size to how much we can show at once */ | |
317 | if (size > sizeof(line)) | |
318 | size = sizeof(line); | |
319 | ||
320 | /* Figure out how wide columns should be */ | |
321 | max_width = alloca(table.width * sizeof(int)); | |
322 | for (jj=tot_width=0; jj<table.width; jj++) { | |
323 | /* Find the widest width for this column */ | |
324 | max_width[jj] = 0; | |
325 | for (ii=0; ii<table.length; ii++) { | |
326 | len = strlen(table.contents[ii][jj]); | |
327 | if (len > max_width[jj]) | |
328 | max_width[jj] = len; | |
329 | } | |
330 | /* Separate columns with spaces */ | |
331 | tot_width += max_width[jj] + 1; | |
332 | } | |
333 | /* How many rows to put in a line? */ | |
334 | if ((table.flags & TABLE_REPEAT_ROWS) && (size > tot_width)) | |
335 | nreps = size / tot_width; | |
336 | else | |
337 | nreps = 1; | |
338 | /* Send headers line.. */ | |
339 | if (table.flags & TABLE_NO_HEADERS) { | |
340 | ii = 0; | |
341 | } else { | |
342 | /* Sending headers needs special treatment: either show them | |
343 | * once, or repeat them as many times as we repeat the columns | |
344 | * in a row. */ | |
345 | for (pos=ii=0; ii<((table.flags & TABLE_REPEAT_HEADERS)?nreps:1); ii++) { | |
346 | for (jj=0; 1; ) { | |
347 | len = strlen(table.contents[0][jj]); | |
de9510bc | 348 | //line[pos++] = '\02'; /* bold header */ |
d76ed9a9 AS |
349 | spaces = max_width[jj] - len; |
350 | if (table.flags & TABLE_PAD_LEFT) | |
351 | while (spaces--) | |
352 | line[pos++] = ' '; | |
353 | memcpy(line+pos, table.contents[0][jj], len); | |
354 | pos += len; | |
de9510bc | 355 | //line[pos++] = '\02'; /* end bold header */ |
d76ed9a9 AS |
356 | if (++jj == table.width) |
357 | break; | |
358 | if (!(table.flags & TABLE_PAD_LEFT)) | |
359 | while (spaces--) | |
360 | line[pos++] = ' '; | |
361 | line[pos++] = ' '; | |
362 | } | |
e1443247 | 363 | line[pos++] = ' '; |
d76ed9a9 AS |
364 | } |
365 | line[pos] = 0; | |
a8370a20 AS |
366 | |
367 | /* Dont show ---- bars in 'clean' style. */ | |
368 | if(!(hi && hi->userlist_style == HI_STYLE_CLEAN)) { | |
369 | //sepsize = strlen_vis(line); | |
370 | sepsize = tot_width * nreps; | |
371 | sepstr = malloc(sepsize + 1); | |
372 | memset(sepstr, '-', sepsize); | |
373 | sepstr[sepsize] = 0; | |
338a82b5 | 374 | irc_send(from, to, sepstr); /* ----------------- */ |
a8370a20 AS |
375 | } |
376 | irc_send(from, to, line); /* alpha beta roe */ | |
377 | if(!(hi && hi->userlist_style == HI_STYLE_CLEAN)) | |
338a82b5 | 378 | irc_send(from, to, sepstr); /* ----------------- */ |
d76ed9a9 AS |
379 | ii = 1; |
380 | } | |
381 | /* Send the table. */ | |
382 | for (jj=0, pos=0, reps=0; ii<table.length; ) { | |
383 | while (1) { | |
384 | len = strlen(table.contents[ii][jj]); | |
385 | spaces = max_width[jj] - len; | |
386 | if (table.flags & TABLE_PAD_LEFT) | |
387 | while (spaces--) line[pos++] = ' '; | |
388 | memcpy(line+pos, table.contents[ii][jj], len); | |
389 | pos += len; | |
390 | if (++jj == table.width) { | |
391 | jj = 0, ++ii, ++reps; | |
392 | if ((reps == nreps) || (ii == table.length)) { | |
393 | line[pos] = 0; | |
394 | irc_send(from, to, line); | |
395 | pos = reps = 0; | |
396 | break; | |
397 | } | |
398 | } | |
399 | if (!(table.flags & TABLE_PAD_LEFT)) | |
400 | while (spaces--) | |
401 | line[pos++] = ' '; | |
402 | line[pos++] = ' '; | |
403 | } | |
404 | } | |
a8370a20 AS |
405 | /* Send end bar */ |
406 | if (!(table.flags & TABLE_NO_HEADERS) && | |
407 | !(table.flags & TABLE_NO_FOOTER) && | |
408 | !(hi && hi->userlist_style == HI_STYLE_CLEAN)) { | |
409 | char endstr[MAX_LINE_SIZE+1]; | |
18757dc0 | 410 | sprintf(endstr, "End (%d rows)", table.length-1); |
a8370a20 AS |
411 | |
412 | /* Copy above into the sepstr, centered */ | |
413 | if(sepsize > strlen(endstr)+2) | |
e6892204 | 414 | { |
a8370a20 AS |
415 | char* eptr = endstr; |
416 | char* sptr = sepstr+(sepsize/2) - (strlen(endstr)+2)/2; | |
417 | while(*eptr) | |
418 | *sptr++ = *eptr++; | |
e6892204 | 419 | } |
a8370a20 | 420 | irc_send(from, to, sepstr); |
e6892204 AS |
421 | } |
422 | ||
a8370a20 AS |
423 | if(!(hi && hi->userlist_style == HI_STYLE_CLEAN)) |
424 | free(sepstr); | |
425 | ||
d76ed9a9 AS |
426 | if (!(table.flags & TABLE_NO_FREE)) { |
427 | /* Deallocate table memory (but not the string memory). */ | |
428 | for (ii=0; ii<table.length; ii++) | |
429 | free(table.contents[ii]); | |
430 | free(table.contents); | |
431 | } | |
432 | } | |
433 | ||
434 | static int | |
435 | vsend_message(const char *dest, struct userNode *src, struct handle_info *handle, int msg_type, expand_func_t expand_f, const char *format, va_list al) | |
436 | { | |
437 | void (*irc_send)(struct userNode *from, const char *to, const char *msg); | |
438 | static struct string_buffer input; | |
439 | unsigned int size, ipos, pos, length, chars_sent, use_color; | |
440 | unsigned int expand_pos, expand_ipos, newline_ipos; | |
441 | char line[MAX_LINE_SIZE]; | |
442 | ||
443 | if (IsChannelName(dest) || *dest == '$') { | |
444 | message_dest = NULL; | |
445 | } else if (!(message_dest = GetUserH(dest))) { | |
446 | log_module(MAIN_LOG, LOG_ERROR, "Unable to find user with nickname %s (in vsend_message from %s).", dest, src->nick); | |
447 | return 0; | |
448 | } else if (message_dest->dead) { | |
449 | /* No point in sending to a user who is leaving. */ | |
450 | return 0; | |
451 | } else { | |
452 | #ifdef WITH_PROTOCOL_P10 | |
453 | dest = message_dest->numeric; | |
454 | #endif | |
455 | } | |
456 | message_source = src; | |
a32da4c7 | 457 | if (!(msg_type & MSG_TYPE_NOXLATE) |
458 | && !(format = handle_find_message(handle, format))) | |
d76ed9a9 AS |
459 | return 0; |
460 | /* fill in a buffer with the string */ | |
461 | input.used = 0; | |
462 | string_buffer_append_vprintf(&input, format, al); | |
463 | ||
464 | /* figure out how to send the messages */ | |
465 | if (handle) { | |
466 | msg_type |= (HANDLE_FLAGGED(handle, USE_PRIVMSG) ? 1 : 0); | |
467 | use_color = HANDLE_FLAGGED(handle, MIRC_COLOR); | |
468 | size = handle->screen_width; | |
469 | if (size > sizeof(line)) | |
470 | size = sizeof(line); | |
471 | } else { | |
472 | size = sizeof(line); | |
473 | use_color = 1; | |
474 | } | |
a32da4c7 | 475 | if (!size || !(msg_type & MSG_TYPE_MULTILINE)) |
d76ed9a9 AS |
476 | size = DEFAULT_LINE_SIZE; |
477 | switch (msg_type & 3) { | |
478 | case 0: | |
479 | irc_send = irc_notice; | |
480 | break; | |
481 | case 2: | |
482 | irc_send = irc_wallchops; | |
483 | break; | |
484 | case 1: | |
485 | default: | |
486 | irc_send = irc_privmsg; | |
487 | } | |
488 | ||
489 | /* This used to be two passes, but if you do that and allow | |
490 | * arbitrary sizes for ${}-expansions (as with help indexes), | |
491 | * that requires a very big intermediate buffer. | |
492 | */ | |
493 | expand_ipos = newline_ipos = ipos = 0; | |
494 | expand_pos = pos = 0; | |
495 | chars_sent = 0; | |
496 | while (input.list[ipos]) { | |
497 | char ch, *value, *free_value; | |
498 | ||
499 | while ((ch = input.list[ipos]) && (ch != '$') && (ch != '\n') && (pos < size)) { | |
500 | line[pos++] = ch; | |
501 | ipos++; | |
502 | } | |
503 | ||
504 | if (!input.list[ipos]) | |
505 | goto send_line; | |
506 | if (input.list[ipos] == '\n') { | |
507 | ipos++; | |
508 | goto send_line; | |
509 | } | |
510 | if (pos == size) { | |
511 | unsigned int new_ipos; | |
512 | /* Scan backwards for a space in the input, until we hit | |
513 | * either the last newline or the last variable expansion. | |
514 | * Print the line up to that point, and start from there. | |
515 | */ | |
516 | for (new_ipos = ipos; | |
517 | (new_ipos > expand_ipos) && (new_ipos > newline_ipos); | |
518 | --new_ipos) | |
519 | if (input.list[new_ipos] == ' ') | |
520 | break; | |
521 | pos -= ipos - new_ipos; | |
522 | if (new_ipos == newline_ipos) { | |
523 | /* Single word was too big to fit on one line; skip | |
524 | * forward to its end and print it as a whole. | |
525 | */ | |
526 | while (input.list[new_ipos] | |
527 | && (input.list[new_ipos] != ' ') | |
528 | && (input.list[new_ipos] != '\n') | |
529 | && (input.list[new_ipos] != '$')) | |
530 | line[pos++] = input.list[new_ipos++]; | |
531 | } | |
532 | ipos = new_ipos; | |
533 | while (input.list[ipos] == ' ') | |
534 | ipos++; | |
535 | goto send_line; | |
536 | } | |
537 | ||
538 | free_value = 0; | |
539 | switch (input.list[++ipos]) { | |
540 | /* Literal '$' or end of string. */ | |
541 | case 0: | |
542 | ipos--; | |
543 | case '$': | |
544 | value = "$"; | |
545 | break; | |
546 | /* The following two expand to mIRC color codes if enabled | |
547 | by the user. */ | |
548 | case 'b': | |
549 | value = use_color ? "\002" : ""; | |
550 | break; | |
551 | case 'o': | |
552 | value = use_color ? "\017" : ""; | |
553 | break; | |
554 | case 'r': | |
555 | value = use_color ? "\026" : ""; | |
556 | break; | |
557 | case 'u': | |
558 | value = use_color ? "\037" : ""; | |
559 | break; | |
560 | /* Service nicks. */ | |
561 | case 'S': | |
562 | value = src->nick; | |
563 | break; | |
564 | case 'G': | |
565 | value = global ? global->nick : "Global"; | |
566 | break; | |
567 | case 'C': | |
568 | value = chanserv ? chanserv->nick : "ChanServ"; | |
569 | break; | |
570 | case 'O': | |
571 | value = opserv ? opserv->nick : "OpServ"; | |
572 | break; | |
573 | case 'N': | |
574 | value = nickserv ? nickserv->nick : "NickServ"; | |
575 | break; | |
63c95a47 | 576 | case 'X': |
577 | value = spamserv ? spamserv->nick : "SpamServ"; | |
578 | break; | |
d76ed9a9 AS |
579 | case 's': |
580 | value = self->name; | |
581 | break; | |
582 | case 'H': | |
583 | value = handle ? handle->handle : "Account"; | |
584 | break; | |
a32da4c7 | 585 | #define SEND_LINE(TRUNCED) do { \ |
586 | line[pos] = 0; \ | |
587 | if (pos > 0) { \ | |
588 | if (!(msg_type & MSG_TYPE_MULTILINE) && (pos > 1) && TRUNCED) \ | |
589 | line[pos-2] = line[pos-1] = '.'; \ | |
590 | irc_send(src, dest, line); \ | |
591 | } \ | |
592 | chars_sent += pos; \ | |
593 | pos = 0; \ | |
594 | newline_ipos = ipos; \ | |
595 | if (!(msg_type & MSG_TYPE_MULTILINE)) return chars_sent; \ | |
596 | } while (0) | |
d76ed9a9 AS |
597 | /* Custom expansion handled by helpfile-specific function. */ |
598 | case '{': | |
599 | case '(': { | |
600 | struct helpfile_expansion exp; | |
601 | char *name_end = input.list + ipos + 1, *colon = NULL; | |
602 | ||
603 | while (*name_end != '}' && *name_end != ')' && *name_end) { | |
604 | if (*name_end == ':') { | |
605 | colon = name_end; | |
606 | *colon = '\0'; | |
607 | } | |
608 | name_end++; | |
609 | } | |
610 | if (!*name_end) | |
611 | goto fallthrough; | |
612 | *name_end = '\0'; | |
613 | if (colon) { | |
614 | struct module *module = module_find(input.list + ipos + 1); | |
615 | if (module && module->expand_help) | |
616 | exp = module->expand_help(colon + 1); | |
617 | else { | |
618 | *colon = ':'; | |
619 | goto fallthrough; | |
620 | } | |
621 | } else if (expand_f) | |
622 | exp = expand_f(input.list + ipos + 1); | |
623 | else | |
624 | goto fallthrough; | |
625 | switch (exp.type) { | |
626 | case HF_STRING: | |
627 | free_value = value = exp.value.str; | |
628 | if (!value) | |
629 | value = ""; | |
630 | break; | |
631 | case HF_TABLE: | |
632 | /* Must send current line, then emit table. */ | |
a32da4c7 | 633 | SEND_LINE(0); |
d76ed9a9 AS |
634 | table_send(src, (message_dest ? message_dest->nick : dest), 0, irc_send, exp.value.table); |
635 | value = ""; | |
636 | break; | |
637 | default: | |
638 | value = ""; | |
639 | log_module(MAIN_LOG, LOG_ERROR, "Invalid exp.type %d from expansion function %p.", exp.type, expand_f); | |
640 | break; | |
641 | } | |
642 | ipos = name_end - input.list; | |
643 | break; | |
644 | } | |
645 | default: | |
646 | fallthrough: | |
647 | value = alloca(3); | |
648 | value[0] = '$'; | |
649 | value[1] = input.list[ipos]; | |
650 | value[2] = 0; | |
651 | } | |
652 | ipos++; | |
653 | while ((pos + strlen(value) > size) || strchr(value, '\n')) { | |
654 | unsigned int avail; | |
655 | avail = size - pos - 1; | |
656 | length = strcspn(value, "\n "); | |
657 | if (length <= avail) { | |
658 | strncpy(line+pos, value, length); | |
659 | pos += length; | |
660 | value += length; | |
661 | /* copy over spaces, until (possible) end of line */ | |
662 | while (*value == ' ') { | |
663 | if (pos < size-1) | |
664 | line[pos++] = *value; | |
665 | value++; | |
666 | } | |
667 | } else { | |
668 | /* word to send is too big to send now.. what to do? */ | |
669 | if (pos > 0) { | |
670 | /* try to put it on a separate line */ | |
a32da4c7 | 671 | SEND_LINE(1); |
d76ed9a9 AS |
672 | } else { |
673 | /* already at start of line; only send part of it */ | |
674 | strncpy(line, value, avail); | |
675 | pos += avail; | |
676 | value += length; | |
677 | /* skip any trailing spaces */ | |
678 | while (*value == ' ') | |
679 | value++; | |
680 | } | |
681 | } | |
682 | /* if we're looking at a newline, send the accumulated text */ | |
683 | if (*value == '\n') { | |
a32da4c7 | 684 | SEND_LINE(0); |
d76ed9a9 AS |
685 | value++; |
686 | } | |
687 | } | |
688 | length = strlen(value); | |
689 | memcpy(line + pos, value, length); | |
690 | if (free_value) | |
691 | free(free_value); | |
692 | pos += length; | |
693 | if ((pos < size-1) && input.list[ipos]) { | |
694 | expand_pos = pos; | |
695 | expand_ipos = ipos; | |
696 | continue; | |
697 | } | |
698 | send_line: | |
699 | expand_pos = pos; | |
700 | expand_ipos = ipos; | |
a32da4c7 | 701 | SEND_LINE(0); |
d76ed9a9 AS |
702 | #undef SEND_LINE |
703 | } | |
704 | return chars_sent; | |
705 | } | |
706 | ||
707 | int | |
708 | send_message(struct userNode *dest, struct userNode *src, const char *format, ...) | |
709 | { | |
710 | int res; | |
711 | va_list ap; | |
712 | ||
713 | if (IsLocal(dest)) return 0; | |
714 | va_start(ap, format); | |
715 | res = vsend_message(dest->nick, src, dest->handle_info, 0, NULL, format, ap); | |
716 | va_end(ap); | |
717 | return res; | |
718 | } | |
719 | ||
720 | int | |
721 | send_message_type(int msg_type, struct userNode *dest, struct userNode *src, const char *format, ...) { | |
722 | int res; | |
723 | va_list ap; | |
724 | ||
725 | if (IsLocal(dest)) return 0; | |
726 | va_start(ap, format); | |
727 | res = vsend_message(dest->nick, src, dest->handle_info, msg_type, NULL, format, ap); | |
728 | va_end(ap); | |
729 | return res; | |
730 | } | |
731 | ||
732 | int | |
733 | send_target_message(int msg_type, const char *dest, struct userNode *src, const char *format, ...) | |
734 | { | |
735 | int res; | |
736 | va_list ap; | |
737 | ||
738 | va_start(ap, format); | |
739 | res = vsend_message(dest, src, NULL, msg_type, NULL, format, ap); | |
740 | va_end(ap); | |
741 | return res; | |
742 | } | |
743 | ||
744 | int | |
745 | _send_help(struct userNode *dest, struct userNode *src, expand_func_t expand, const char *format, ...) | |
746 | { | |
747 | int res; | |
748 | ||
749 | va_list ap; | |
750 | va_start(ap, format); | |
a32da4c7 | 751 | res = vsend_message(dest->nick, src, dest->handle_info, 12, expand, format, ap); |
d76ed9a9 AS |
752 | va_end(ap); |
753 | return res; | |
754 | } | |
755 | ||
756 | int | |
757 | send_help(struct userNode *dest, struct userNode *src, struct helpfile *hf, const char *topic) | |
758 | { | |
759 | struct helpfile *lang_hf; | |
760 | struct record_data *rec; | |
761 | struct language *curr; | |
762 | ||
763 | if (!topic) | |
764 | topic = "<index>"; | |
765 | if (!hf) { | |
766 | _send_help(dest, src, NULL, "HFMSG_MISSING_HELPFILE"); | |
1d957482 | 767 | return false; |
d76ed9a9 AS |
768 | } |
769 | for (curr = (dest->handle_info ? dest->handle_info->language : lang_C); | |
770 | curr; | |
771 | curr = curr->parent) { | |
772 | lang_hf = dict_find(curr->helpfiles, hf->name, NULL); | |
773 | if (!lang_hf) | |
774 | continue; | |
775 | rec = dict_find(lang_hf->db, topic, NULL); | |
1d957482 AS |
776 | if (rec && rec->type == RECDB_QSTRING) { |
777 | _send_help(dest, src, hf->expand, rec->d.qstring); | |
778 | return true; | |
779 | } | |
d76ed9a9 AS |
780 | } |
781 | rec = dict_find(hf->db, "<missing>", NULL); | |
782 | if (!rec) | |
1d957482 AS |
783 | return false; |
784 | if (rec->type != RECDB_QSTRING) { | |
785 | send_message(dest, src, "HFMSG_HELP_NOT_STRING"); | |
786 | return false; | |
787 | } | |
788 | _send_help(dest, src, hf->expand, rec->d.qstring); | |
789 | return true; | |
d76ed9a9 AS |
790 | } |
791 | ||
fc8798ec | 792 | int |
567a5f26 | 793 | send_help_brief(struct userNode *dest, struct userNode *src, struct helpfile *hf, const char *topic) |
fc8798ec AS |
794 | { |
795 | struct helpfile *lang_hf; | |
796 | struct record_data *rec; | |
797 | struct language *curr; | |
798 | ||
799 | if (!topic) | |
800 | topic = "<index>"; | |
801 | if (!hf) { | |
802 | _send_help(dest, src, NULL, "HFMSG_MISSING_HELPFILE"); | |
803 | return 0; | |
804 | } | |
805 | for (curr = (dest->handle_info ? dest->handle_info->language : lang_C); | |
806 | curr; | |
807 | curr = curr->parent) { | |
808 | lang_hf = dict_find(curr->helpfiles, hf->name, NULL); | |
809 | if (!lang_hf) | |
810 | continue; | |
811 | rec = dict_find(lang_hf->db, topic, NULL); | |
812 | if (rec && rec->type == RECDB_QSTRING) | |
e6892204 AS |
813 | { |
814 | char* buf; | |
815 | int res; | |
816 | ||
817 | buf = malloc(strlen(rec->d.qstring) + 1); | |
818 | strcpy(buf, rec->d.qstring); | |
819 | *strchr(buf, '\n') = 0; | |
820 | ||
821 | res = _send_help(dest, src, hf->expand, buf); | |
822 | free(buf); | |
823 | return res; | |
824 | } | |
fc8798ec AS |
825 | } |
826 | rec = dict_find(hf->db, "<missing>", NULL); | |
827 | if (!rec) | |
180e0971 | 828 | return 0; /* send_message(dest, src, "MSG_TOPIC_UNKNOWN"); */ |
fc8798ec | 829 | if (rec->type != RECDB_QSTRING) |
180e0971 | 830 | return 0; /* send_message(dest, src, "HFMSG_HELP_NOT_STRING"); */ |
fc8798ec AS |
831 | return _send_help(dest, src, hf->expand, rec->d.qstring); |
832 | } | |
833 | ||
d76ed9a9 AS |
834 | /* Grammar supported by this parser: |
835 | * condition = expr | prefix expr | |
836 | * expr = atomicexpr | atomicexpr op atomicexpr | |
837 | * op = '&&' | '||' | 'and' | 'or' | |
838 | * atomicexpr = '(' expr ')' | identifier | |
839 | * identifier = ( '0'-'9' 'A'-'Z' 'a'-'z' '-' '_' '/' )+ | ! identifier | |
840 | * | |
841 | * Whitespace is ignored. The parser is implemented as a recursive | |
842 | * descent parser by functions like: | |
843 | * static int helpfile_eval_<element>(const char *start, const char **end); | |
844 | */ | |
845 | ||
846 | enum helpfile_op { | |
847 | OP_INVALID, | |
848 | OP_BOOL_AND, | |
849 | OP_BOOL_OR | |
850 | }; | |
851 | ||
852 | static const struct { | |
853 | const char *str; | |
854 | enum helpfile_op op; | |
855 | } helpfile_operators[] = { | |
856 | { "&&", OP_BOOL_AND }, | |
857 | { "and", OP_BOOL_AND }, | |
858 | { "||", OP_BOOL_OR }, | |
859 | { "or", OP_BOOL_OR }, | |
860 | { NULL, OP_INVALID } | |
861 | }; | |
862 | ||
863 | static const char *identifier_chars = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz-_/"; | |
864 | ||
865 | static int helpfile_eval_expr(const char *start, const char **end); | |
866 | static int helpfile_eval_atomicexpr(const char *start, const char **end); | |
867 | static int helpfile_eval_identifier(const char *start, const char **end); | |
868 | ||
869 | static int | |
870 | helpfile_eval_identifier(const char *start, const char **end) | |
871 | { | |
872 | /* Skip leading whitespace. */ | |
873 | while (isspace(*start) && (start < *end)) | |
874 | start++; | |
875 | if (start == *end) { | |
876 | log_module(MAIN_LOG, LOG_FATAL, "Expected identifier in helpfile condition."); | |
877 | return -1; | |
878 | } | |
879 | ||
880 | if (start[0] == '!') { | |
881 | int res = helpfile_eval_identifier(start+1, end); | |
882 | if (res < 0) | |
883 | return res; | |
884 | return !res; | |
885 | } else if (start[0] == '/') { | |
886 | const char *sep; | |
887 | char *id_str, *value; | |
888 | ||
889 | for (sep = start; | |
890 | strchr(identifier_chars, sep[0]) && (sep < *end); | |
891 | ++sep) ; | |
892 | memcpy(id_str = alloca(sep+1-start), start, sep-start); | |
893 | id_str[sep-start] = '\0'; | |
894 | value = conf_get_data(id_str+1, RECDB_QSTRING); | |
895 | *end = sep; | |
896 | if (!value) | |
897 | return 0; | |
898 | return enabled_string(value) || true_string(value); | |
899 | } else if ((*end - start >= 4) && !ircncasecmp(start, "true", 4)) { | |
900 | *end = start + 4; | |
901 | return 1; | |
902 | } else if ((*end - start >= 5) && !ircncasecmp(start, "false", 5)) { | |
903 | *end = start + 5; | |
904 | return 0; | |
905 | } else { | |
2f61d1d7 | 906 | log_module(MAIN_LOG, LOG_FATAL, "Unexpected helpfile identifier '%.*s'.", (int)(*end-start), start); |
d76ed9a9 AS |
907 | return -1; |
908 | } | |
909 | } | |
910 | ||
911 | static int | |
912 | helpfile_eval_atomicexpr(const char *start, const char **end) | |
913 | { | |
914 | const char *sep; | |
915 | int res; | |
916 | ||
917 | /* Skip leading whitespace. */ | |
918 | while (isspace(*start) && (start < *end)) | |
919 | start++; | |
920 | if (start == *end) { | |
921 | log_module(MAIN_LOG, LOG_FATAL, "Expected atomic expression in helpfile condition."); | |
922 | return -1; | |
923 | } | |
924 | ||
925 | /* If it's not parenthesized, it better be a valid identifier. */ | |
926 | if (*start != '(') | |
927 | return helpfile_eval_identifier(start, end); | |
928 | ||
929 | /* Parse the internal expression. */ | |
930 | start++; | |
931 | sep = *end; | |
932 | res = helpfile_eval_expr(start, &sep); | |
933 | ||
934 | /* Check for the closing parenthesis. */ | |
935 | while (isspace(*sep) && (sep < *end)) | |
936 | sep++; | |
937 | if ((sep == *end) || (sep[0] != ')')) { | |
2f61d1d7 | 938 | log_module(MAIN_LOG, LOG_FATAL, "Expected close parenthesis at '%.*s'.", (int)(*end-sep), sep); |
d76ed9a9 AS |
939 | return -1; |
940 | } | |
941 | ||
942 | /* Report the end location and result. */ | |
943 | *end = sep + 1; | |
944 | return res; | |
945 | } | |
946 | ||
947 | static int | |
948 | helpfile_eval_expr(const char *start, const char **end) | |
949 | { | |
950 | const char *sep, *sep2; | |
951 | unsigned int ii, len; | |
952 | int res_a, res_b; | |
953 | enum helpfile_op op; | |
954 | ||
955 | /* Parse the first atomicexpr. */ | |
956 | sep = *end; | |
957 | res_a = helpfile_eval_atomicexpr(start, &sep); | |
958 | if (res_a < 0) | |
959 | return res_a; | |
960 | ||
961 | /* Figure out what follows that. */ | |
962 | while (isspace(*sep) && (sep < *end)) | |
963 | sep++; | |
964 | if (sep == *end) | |
965 | return res_a; | |
966 | op = OP_INVALID; | |
967 | for (ii = 0; helpfile_operators[ii].str; ++ii) { | |
968 | len = strlen(helpfile_operators[ii].str); | |
969 | if (ircncasecmp(sep, helpfile_operators[ii].str, len)) | |
970 | continue; | |
971 | op = helpfile_operators[ii].op; | |
972 | sep += len; | |
973 | } | |
974 | if (op == OP_INVALID) { | |
2f61d1d7 | 975 | log_module(MAIN_LOG, LOG_FATAL, "Unrecognized helpfile operator at '%.*s'.", (int)(*end-sep), sep); |
d76ed9a9 AS |
976 | return -1; |
977 | } | |
978 | ||
979 | /* Parse the next atomicexpr. */ | |
980 | sep2 = *end; | |
981 | res_b = helpfile_eval_atomicexpr(sep, &sep2); | |
982 | if (res_b < 0) | |
983 | return res_b; | |
984 | ||
985 | /* Make sure there's no trailing garbage */ | |
986 | while (isspace(*sep2) && (sep2 < *end)) | |
987 | sep2++; | |
988 | if (sep2 != *end) { | |
2f61d1d7 | 989 | log_module(MAIN_LOG, LOG_FATAL, "Trailing garbage in helpfile expression: '%.*s'.", (int)(*end-sep2), sep2); |
d76ed9a9 AS |
990 | return -1; |
991 | } | |
992 | ||
993 | /* Record where we stopped parsing. */ | |
994 | *end = sep2; | |
995 | ||
996 | /* Do the logic on the subexpressions. */ | |
997 | switch (op) { | |
998 | case OP_BOOL_AND: | |
999 | return res_a && res_b; | |
1000 | case OP_BOOL_OR: | |
1001 | return res_a || res_b; | |
1002 | default: | |
1003 | return -1; | |
1004 | } | |
1005 | } | |
1006 | ||
1007 | static int | |
1008 | helpfile_eval_condition(const char *start, const char **end) | |
1009 | { | |
1010 | const char *term; | |
1011 | ||
1012 | /* Skip the prefix if there is one. */ | |
1013 | for (term = start; isalnum(*term) && (term < *end); ++term) ; | |
1014 | if (term != start) { | |
1015 | if ((term + 2 >= *end) || (term[0] != ':') || (term[1] != ' ')) { | |
2f61d1d7 | 1016 | log_module(MAIN_LOG, LOG_FATAL, "In helpfile condition '%.*s' expected prefix to end with ': '.",(int)(*end-start), start); |
d76ed9a9 AS |
1017 | return -1; |
1018 | } | |
1019 | start = term + 2; | |
1020 | } | |
1021 | ||
1022 | /* Evaluate the remaining string as an expression. */ | |
1023 | return helpfile_eval_expr(start, end); | |
1024 | } | |
1025 | ||
1026 | static int | |
1027 | unlistify_help(const char *key, void *data, void *extra) | |
1028 | { | |
1029 | struct record_data *rd = data; | |
1030 | dict_t newdb = extra; | |
1031 | ||
1032 | switch (rd->type) { | |
1033 | case RECDB_QSTRING: | |
1034 | dict_insert(newdb, strdup(key), alloc_record_data_qstring(GET_RECORD_QSTRING(rd))); | |
1035 | return 0; | |
1036 | case RECDB_STRING_LIST: { | |
1037 | struct string_list *slist = GET_RECORD_STRING_LIST(rd); | |
1038 | char *dest; | |
1039 | unsigned int totlen, len, i; | |
1040 | ||
1041 | for (i=totlen=0; i<slist->used; i++) | |
1042 | totlen = totlen + strlen(slist->list[i]) + 1; | |
1043 | dest = alloca(totlen+1); | |
1044 | for (i=totlen=0; i<slist->used; i++) { | |
1045 | len = strlen(slist->list[i]); | |
1046 | memcpy(dest+totlen, slist->list[i], len); | |
1047 | dest[totlen+len] = '\n'; | |
1048 | totlen = totlen + len + 1; | |
1049 | } | |
1050 | dest[totlen] = 0; | |
1051 | dict_insert(newdb, strdup(key), alloc_record_data_qstring(dest)); | |
1052 | return 0; | |
1053 | } | |
1054 | case RECDB_OBJECT: { | |
1055 | dict_iterator_t it; | |
1056 | ||
1057 | for (it = dict_first(GET_RECORD_OBJECT(rd)); it; it = iter_next(it)) { | |
1058 | const char *k2, *end; | |
1059 | int res; | |
1060 | ||
1061 | /* Evaluate the expression for this subentry. */ | |
1062 | k2 = iter_key(it); | |
1063 | end = k2 + strlen(k2); | |
1064 | res = helpfile_eval_condition(k2, &end); | |
1065 | /* If the evaluation failed, bail. */ | |
1066 | if (res < 0) { | |
1067 | log_module(MAIN_LOG, LOG_FATAL, " .. while processing entry '%s' condition '%s'.", key, k2); | |
1068 | return 1; | |
1069 | } | |
1070 | /* If the condition was false, try another. */ | |
1071 | if (!res) | |
1072 | continue; | |
1073 | /* If we cannot unlistify the contents, bail. */ | |
1074 | if (unlistify_help(key, iter_data(it), extra)) | |
1075 | return 1; | |
1076 | return 0; | |
1077 | } | |
1078 | /* If none of the conditions apply, just omit the entry. */ | |
1079 | return 0; | |
1080 | } | |
1081 | default: | |
1082 | return 1; | |
1083 | } | |
1084 | } | |
1085 | ||
1086 | struct helpfile * | |
1087 | open_helpfile(const char *fname, expand_func_t expand) | |
1088 | { | |
1089 | struct helpfile *hf; | |
1090 | char *slash; | |
1091 | dict_t db = parse_database(fname); | |
1092 | hf = calloc(1, sizeof(*hf)); | |
1093 | hf->expand = expand; | |
1094 | hf->db = alloc_database(); | |
1095 | dict_set_free_keys(hf->db, free); | |
1096 | if ((slash = strrchr(fname, '/'))) { | |
1097 | hf->name = strdup(slash + 1); | |
1098 | } else { | |
1099 | hf->name = strdup(fname); | |
1100 | dict_insert(language_find("C")->helpfiles, hf->name, hf); | |
1101 | } | |
1102 | if (db) { | |
1103 | dict_foreach(db, unlistify_help, hf->db); | |
1104 | free_database(db); | |
1105 | } | |
1106 | return hf; | |
1107 | } | |
1108 | ||
1109 | void close_helpfile(struct helpfile *hf) | |
1110 | { | |
1111 | if (!hf) | |
1112 | return; | |
1113 | free((char*)hf->name); | |
1114 | free_database(hf->db); | |
1115 | free(hf); | |
1116 | } | |
1117 | ||
1118 | void message_register_table(const struct message_entry *table) | |
1119 | { | |
1120 | if (!lang_C) | |
1121 | language_find("C"); | |
1122 | while (table->msgid) { | |
1123 | dict_insert(lang_C->messages, table->msgid, (char*)table->format); | |
1124 | table++; | |
1125 | } | |
1126 | } | |
1127 | ||
1128 | void helpfile_init(void) | |
1129 | { | |
1130 | message_register_table(msgtab); | |
1131 | language_read_list(); | |
1132 | } | |
1133 | ||
1134 | void helpfile_finalize(void) | |
1135 | { | |
1136 | dict_iterator_t it; | |
1137 | for (it = dict_first(languages); it; it = iter_next(it)) | |
1138 | language_read(iter_key(it)); | |
1139 | reg_exit_func(language_cleanup); | |
1140 | } |