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