1 /* helpfile.c - Help file loading and display
2 * Copyright 2000-2004 srvx Development Team
4 * This file is part of srvx.
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.
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.
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.
27 #if defined(HAVE_DIRENT_H)
31 #if defined(HAVE_SYS_STAT_H)
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)." },
41 #define DEFAULT_LINE_SIZE MAX_LINE_SIZE
42 #define DEFAULT_TABLE_SIZE 80
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;
50 static void language_cleanup(void)
52 dict_delete(languages);
55 static void language_free_helpfile(void *data)
57 struct helpfile *hf = data;
61 static void language_free(void *data)
63 struct language *lang = data;
64 dict_delete(lang->messages);
65 dict_delete(lang->helpfiles);
70 static struct language *language_alloc(const char *name)
72 struct language *lang = calloc(1, sizeof(*lang));
73 lang->name = strdup(name);
74 lang->parent = lang_C;
76 languages = dict_new();
77 dict_set_free_data(languages, language_free);
79 dict_insert(languages, lang->name, lang);
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.
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
93 struct language *language_find(const char *name)
95 struct language *lang;
96 char alt_name[MAXLEN];
99 if ((lang = dict_find(languages, name, NULL)))
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)))
108 lang_C = language_alloc("C");
109 lang_C->messages = dict_new();
110 lang_C->helpfiles = dict_new();
115 static void language_set_messages(struct language *lang, dict_t dict)
117 dict_iterator_t it, it2;
118 struct record_data *rd;
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;
130 } else if (diff > 0) {
132 it2 = iter_next(it2);
138 msg = strdup(rd->d.qstring);
140 case RECDB_STRING_LIST:
141 /* XXX: maybe do an unlistify_help() type thing */
143 log_module(MAIN_LOG, LOG_WARNING, "Unsupported record type for message %s in language %s", msgid, lang->name);
146 dict_insert(lang->messages, strdup(msgid), msg);
148 it2 = iter_next(it2);
152 it2 = iter_next(it2);
154 if (extra || missing)
155 log_module(MAIN_LOG, LOG_WARNING, "In language %s, %d extra and %d missing messages.", lang->name, extra, missing);
158 static struct language *language_read(const char *name)
161 struct dirent *dirent;
162 struct language *lang;
164 char filename[MAXLEN], *uscore;
168 /* Never try to read the C language from disk. */
169 if (!irccasecmp(name, "C"))
172 /* Open the directory stream; if we can't, fail. */
173 snprintf(filename, sizeof(filename), "languages/%s", name);
174 if (!(dir = opendir(filename)))
176 if (!(lang = dict_find(languages, name, NULL)))
177 lang = language_alloc(name);
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");
185 if (!(lang->parent = language_find(filename))) {
186 uscore = strchr(filename, '_');
189 lang->parent = language_find(filename);
192 lang->parent = lang_C;
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);
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")) {
208 } else if (!strcmp(dirent->d_name, "strings.db")) {
209 dict = parse_database(filename);
210 language_set_messages(lang, 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);
223 static void language_read_list(void)
225 struct dirent *dirent;
228 if (!(dir = opendir("languages")))
230 while ((dirent = readdir(dir))) {
231 if (dirent->d_name[0] == '.')
233 #ifdef HAVE_DIRENT_D_TYPE
234 if (dirent->d_type != DT_DIR)
238 char namebuf[MAXLEN];
240 snprintf(namebuf, sizeof(namebuf), "languages/%s", dirent->d_name);
241 if (stat(namebuf, &sbuf) < 0)
243 if (!S_ISDIR(sbuf.st_mode))
247 language_alloc(dirent->d_name);
252 const char *language_find_message(struct language *lang, const char *msgid) {
253 struct language *curr;
257 for (curr = lang; curr; curr = curr->parent)
258 if ((msg = dict_find(curr->messages, msgid, NULL)))
260 log_module(MAIN_LOG, LOG_ERROR, "Tried to find unregistered message \"%s\" (original language %s)", msgid, lang->name);
265 table_send(struct userNode *from, const char *to, unsigned int size, irc_send_func irc_send, struct helpfile_table table) {
266 unsigned int ii, jj, len, nreps, reps, tot_width, pos, spaces, *max_width;
267 char line[MAX_LINE_SIZE+1];
268 struct handle_info *hi;
270 if (IsChannelName(to) || *to == '$') {
274 message_dest = GetUserH(to);
276 log_module(MAIN_LOG, LOG_ERROR, "Unable to find user with nickname %s (in table_send from %s).", to, from->nick);
279 hi = message_dest->handle_info;
280 #ifdef WITH_PROTOCOL_P10
281 to = message_dest->numeric;
284 message_source = from;
286 /* If size or irc_send are 0, we should try to use a default. */
290 size = DEFAULT_TABLE_SIZE;
291 else if (hi->table_width)
292 size = hi->table_width;
293 else if (hi->screen_width)
294 size = hi->screen_width;
296 size = DEFAULT_TABLE_SIZE;
299 {} /* use that function */
301 irc_send = HANDLE_FLAGGED(hi, USE_PRIVMSG) ? irc_privmsg : irc_notice;
303 irc_send = IsChannelName(to) ? irc_privmsg : irc_notice;
305 /* Limit size to how much we can show at once */
306 if (size > sizeof(line))
309 /* Figure out how wide columns should be */
310 max_width = alloca(table.width * sizeof(int));
311 for (jj=tot_width=0; jj<table.width; jj++) {
312 /* Find the widest width for this column */
314 for (ii=0; ii<table.length; ii++) {
315 len = strlen(table.contents[ii][jj]);
316 if (len > max_width[jj])
319 /* Separate columns with spaces */
320 tot_width += max_width[jj] + 1;
322 /* How many rows to put in a line? */
323 if ((table.flags & TABLE_REPEAT_ROWS) && (size > tot_width))
324 nreps = size / tot_width;
327 /* Send headers line.. */
328 if (table.flags & TABLE_NO_HEADERS) {
331 /* Sending headers needs special treatment: either show them
332 * once, or repeat them as many times as we repeat the columns
334 for (pos=ii=0; ii<((table.flags & TABLE_REPEAT_HEADERS)?nreps:1); ii++) {
336 len = strlen(table.contents[0][jj]);
337 spaces = max_width[jj] - len;
338 if (table.flags & TABLE_PAD_LEFT)
341 memcpy(line+pos, table.contents[0][jj], len);
343 if (++jj == table.width)
345 if (!(table.flags & TABLE_PAD_LEFT))
352 irc_send(from, to, line);
355 /* Send the table. */
356 for (jj=0, pos=0, reps=0; ii<table.length; ) {
358 len = strlen(table.contents[ii][jj]);
359 spaces = max_width[jj] - len;
360 if (table.flags & TABLE_PAD_LEFT)
361 while (spaces--) line[pos++] = ' ';
362 memcpy(line+pos, table.contents[ii][jj], len);
364 if (++jj == table.width) {
365 jj = 0, ++ii, ++reps;
366 if ((reps == nreps) || (ii == table.length)) {
368 irc_send(from, to, line);
373 if (!(table.flags & TABLE_PAD_LEFT))
379 if (!(table.flags & TABLE_NO_FREE)) {
380 /* Deallocate table memory (but not the string memory). */
381 for (ii=0; ii<table.length; ii++)
382 free(table.contents[ii]);
383 free(table.contents);
388 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)
390 void (*irc_send)(struct userNode *from, const char *to, const char *msg);
391 static struct string_buffer input;
392 unsigned int size, ipos, pos, length, chars_sent, use_color;
393 unsigned int expand_pos, expand_ipos, newline_ipos;
394 char line[MAX_LINE_SIZE];
396 if (IsChannelName(dest) || *dest == '$') {
398 } else if (!(message_dest = GetUserH(dest))) {
399 log_module(MAIN_LOG, LOG_ERROR, "Unable to find user with nickname %s (in vsend_message from %s).", dest, src->nick);
401 } else if (message_dest->dead) {
402 /* No point in sending to a user who is leaving. */
405 #ifdef WITH_PROTOCOL_P10
406 dest = message_dest->numeric;
409 message_source = src;
410 if (!(msg_type & 4) && !(format = handle_find_message(handle, format)))
412 /* fill in a buffer with the string */
414 string_buffer_append_vprintf(&input, format, al);
416 /* figure out how to send the messages */
418 msg_type |= (HANDLE_FLAGGED(handle, USE_PRIVMSG) ? 1 : 0);
419 use_color = HANDLE_FLAGGED(handle, MIRC_COLOR);
420 size = handle->screen_width;
421 if (size > sizeof(line))
428 size = DEFAULT_LINE_SIZE;
429 switch (msg_type & 3) {
431 irc_send = irc_notice;
434 irc_send = irc_wallchops;
438 irc_send = irc_privmsg;
441 /* This used to be two passes, but if you do that and allow
442 * arbitrary sizes for ${}-expansions (as with help indexes),
443 * that requires a very big intermediate buffer.
445 expand_ipos = newline_ipos = ipos = 0;
446 expand_pos = pos = 0;
448 while (input.list[ipos]) {
449 char ch, *value, *free_value;
451 while ((ch = input.list[ipos]) && (ch != '$') && (ch != '\n') && (pos < size)) {
456 if (!input.list[ipos])
458 if (input.list[ipos] == '\n') {
463 unsigned int new_ipos;
464 /* Scan backwards for a space in the input, until we hit
465 * either the last newline or the last variable expansion.
466 * Print the line up to that point, and start from there.
468 for (new_ipos = ipos;
469 (new_ipos > expand_ipos) && (new_ipos > newline_ipos);
471 if (input.list[new_ipos] == ' ')
473 pos -= ipos - new_ipos;
474 if (new_ipos == newline_ipos) {
475 /* Single word was too big to fit on one line; skip
476 * forward to its end and print it as a whole.
478 while (input.list[new_ipos]
479 && (input.list[new_ipos] != ' ')
480 && (input.list[new_ipos] != '\n')
481 && (input.list[new_ipos] != '$'))
482 line[pos++] = input.list[new_ipos++];
485 while (input.list[ipos] == ' ')
491 switch (input.list[++ipos]) {
492 /* Literal '$' or end of string. */
498 /* The following two expand to mIRC color codes if enabled
501 value = use_color ? "\002" : "";
504 value = use_color ? "\017" : "";
507 value = use_color ? "\026" : "";
510 value = use_color ? "\037" : "";
517 value = global ? global->nick : "Global";
520 value = chanserv ? chanserv->nick : "ChanServ";
523 value = opserv ? opserv->nick : "OpServ";
526 value = nickserv ? nickserv->nick : "NickServ";
532 value = handle ? handle->handle : "Account";
534 #define SEND_LINE() do { line[pos] = 0; if (pos > 0) irc_send(src, dest, line); chars_sent += pos; pos = 0; newline_ipos = ipos; } while (0)
535 /* Custom expansion handled by helpfile-specific function. */
538 struct helpfile_expansion exp;
539 char *name_end = input.list + ipos + 1, *colon = NULL;
541 while (*name_end != '}' && *name_end != ')' && *name_end) {
542 if (*name_end == ':') {
552 struct module *module = module_find(input.list + ipos + 1);
553 if (module && module->expand_help)
554 exp = module->expand_help(colon + 1);
560 exp = expand_f(input.list + ipos + 1);
565 free_value = value = exp.value.str;
570 /* Must send current line, then emit table. */
572 table_send(src, (message_dest ? message_dest->nick : dest), 0, irc_send, exp.value.table);
577 log_module(MAIN_LOG, LOG_ERROR, "Invalid exp.type %d from expansion function %p.", exp.type, expand_f);
580 ipos = name_end - input.list;
587 value[1] = input.list[ipos];
591 while ((pos + strlen(value) > size) || strchr(value, '\n')) {
593 avail = size - pos - 1;
594 length = strcspn(value, "\n ");
595 if (length <= avail) {
596 strncpy(line+pos, value, length);
599 /* copy over spaces, until (possible) end of line */
600 while (*value == ' ') {
602 line[pos++] = *value;
606 /* word to send is too big to send now.. what to do? */
608 /* try to put it on a separate line */
611 /* already at start of line; only send part of it */
612 strncpy(line, value, avail);
615 /* skip any trailing spaces */
616 while (*value == ' ')
620 /* if we're looking at a newline, send the accumulated text */
621 if (*value == '\n') {
626 length = strlen(value);
627 memcpy(line + pos, value, length);
631 if ((pos < size-1) && input.list[ipos]) {
646 send_message(struct userNode *dest, struct userNode *src, const char *format, ...)
651 if (IsLocal(dest)) return 0;
652 va_start(ap, format);
653 res = vsend_message(dest->nick, src, dest->handle_info, 0, NULL, format, ap);
659 send_message_type(int msg_type, struct userNode *dest, struct userNode *src, const char *format, ...) {
663 if (IsLocal(dest)) return 0;
664 va_start(ap, format);
665 res = vsend_message(dest->nick, src, dest->handle_info, msg_type, NULL, format, ap);
671 send_target_message(int msg_type, const char *dest, struct userNode *src, const char *format, ...)
676 va_start(ap, format);
677 res = vsend_message(dest, src, NULL, msg_type, NULL, format, ap);
683 _send_help(struct userNode *dest, struct userNode *src, expand_func_t expand, const char *format, ...)
688 va_start(ap, format);
689 res = vsend_message(dest->nick, src, dest->handle_info, 4, expand, format, ap);
695 send_help(struct userNode *dest, struct userNode *src, struct helpfile *hf, const char *topic)
697 struct helpfile *lang_hf;
698 struct record_data *rec;
699 struct language *curr;
704 _send_help(dest, src, NULL, "HFMSG_MISSING_HELPFILE");
707 for (curr = (dest->handle_info ? dest->handle_info->language : lang_C);
709 curr = curr->parent) {
710 lang_hf = dict_find(curr->helpfiles, hf->name, NULL);
713 rec = dict_find(lang_hf->db, topic, NULL);
714 if (rec && rec->type == RECDB_QSTRING)
715 return _send_help(dest, src, hf->expand, rec->d.qstring);
717 rec = dict_find(hf->db, "<missing>", NULL);
719 return send_message(dest, src, "MSG_TOPIC_UNKNOWN");
720 if (rec->type != RECDB_QSTRING)
721 return send_message(dest, src, "HFMSG_HELP_NOT_STRING");
722 return _send_help(dest, src, hf->expand, rec->d.qstring);
725 /* Grammar supported by this parser:
726 * condition = expr | prefix expr
727 * expr = atomicexpr | atomicexpr op atomicexpr
728 * op = '&&' | '||' | 'and' | 'or'
729 * atomicexpr = '(' expr ')' | identifier
730 * identifier = ( '0'-'9' 'A'-'Z' 'a'-'z' '-' '_' '/' )+ | ! identifier
732 * Whitespace is ignored. The parser is implemented as a recursive
733 * descent parser by functions like:
734 * static int helpfile_eval_<element>(const char *start, const char **end);
743 static const struct {
746 } helpfile_operators[] = {
747 { "&&", OP_BOOL_AND },
748 { "and", OP_BOOL_AND },
749 { "||", OP_BOOL_OR },
750 { "or", OP_BOOL_OR },
754 static const char *identifier_chars = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz-_/";
756 static int helpfile_eval_expr(const char *start, const char **end);
757 static int helpfile_eval_atomicexpr(const char *start, const char **end);
758 static int helpfile_eval_identifier(const char *start, const char **end);
761 helpfile_eval_identifier(const char *start, const char **end)
763 /* Skip leading whitespace. */
764 while (isspace(*start) && (start < *end))
767 log_module(MAIN_LOG, LOG_FATAL, "Expected identifier in helpfile condition.");
771 if (start[0] == '!') {
772 int res = helpfile_eval_identifier(start+1, end);
776 } else if (start[0] == '/') {
778 char *id_str, *value;
781 strchr(identifier_chars, sep[0]) && (sep < *end);
783 memcpy(id_str = alloca(sep+1-start), start, sep-start);
784 id_str[sep-start] = '\0';
785 value = conf_get_data(id_str+1, RECDB_QSTRING);
789 return enabled_string(value) || true_string(value);
790 } else if ((*end - start >= 4) && !ircncasecmp(start, "true", 4)) {
793 } else if ((*end - start >= 5) && !ircncasecmp(start, "false", 5)) {
797 log_module(MAIN_LOG, LOG_FATAL, "Unexpected helpfile identifier '%.*s'.", *end-start, start);
803 helpfile_eval_atomicexpr(const char *start, const char **end)
808 /* Skip leading whitespace. */
809 while (isspace(*start) && (start < *end))
812 log_module(MAIN_LOG, LOG_FATAL, "Expected atomic expression in helpfile condition.");
816 /* If it's not parenthesized, it better be a valid identifier. */
818 return helpfile_eval_identifier(start, end);
820 /* Parse the internal expression. */
823 res = helpfile_eval_expr(start, &sep);
825 /* Check for the closing parenthesis. */
826 while (isspace(*sep) && (sep < *end))
828 if ((sep == *end) || (sep[0] != ')')) {
829 log_module(MAIN_LOG, LOG_FATAL, "Expected close parenthesis at '%.*s'.", *end-sep, sep);
833 /* Report the end location and result. */
839 helpfile_eval_expr(const char *start, const char **end)
841 const char *sep, *sep2;
842 unsigned int ii, len;
846 /* Parse the first atomicexpr. */
848 res_a = helpfile_eval_atomicexpr(start, &sep);
852 /* Figure out what follows that. */
853 while (isspace(*sep) && (sep < *end))
858 for (ii = 0; helpfile_operators[ii].str; ++ii) {
859 len = strlen(helpfile_operators[ii].str);
860 if (ircncasecmp(sep, helpfile_operators[ii].str, len))
862 op = helpfile_operators[ii].op;
865 if (op == OP_INVALID) {
866 log_module(MAIN_LOG, LOG_FATAL, "Unrecognized helpfile operator at '%.*s'.", *end-sep, sep);
870 /* Parse the next atomicexpr. */
872 res_b = helpfile_eval_atomicexpr(sep, &sep2);
876 /* Make sure there's no trailing garbage */
877 while (isspace(*sep2) && (sep2 < *end))
880 log_module(MAIN_LOG, LOG_FATAL, "Trailing garbage in helpfile expression: '%.*s'.", *end-sep2, sep2);
884 /* Record where we stopped parsing. */
887 /* Do the logic on the subexpressions. */
890 return res_a && res_b;
892 return res_a || res_b;
899 helpfile_eval_condition(const char *start, const char **end)
903 /* Skip the prefix if there is one. */
904 for (term = start; isalnum(*term) && (term < *end); ++term) ;
906 if ((term + 2 >= *end) || (term[0] != ':') || (term[1] != ' ')) {
907 log_module(MAIN_LOG, LOG_FATAL, "In helpfile condition '%.*s' expected prefix to end with ': '.", *end-start, start);
913 /* Evaluate the remaining string as an expression. */
914 return helpfile_eval_expr(start, end);
918 unlistify_help(const char *key, void *data, void *extra)
920 struct record_data *rd = data;
921 dict_t newdb = extra;
925 dict_insert(newdb, strdup(key), alloc_record_data_qstring(GET_RECORD_QSTRING(rd)));
927 case RECDB_STRING_LIST: {
928 struct string_list *slist = GET_RECORD_STRING_LIST(rd);
930 unsigned int totlen, len, i;
932 for (i=totlen=0; i<slist->used; i++)
933 totlen = totlen + strlen(slist->list[i]) + 1;
934 dest = alloca(totlen+1);
935 for (i=totlen=0; i<slist->used; i++) {
936 len = strlen(slist->list[i]);
937 memcpy(dest+totlen, slist->list[i], len);
938 dest[totlen+len] = '\n';
939 totlen = totlen + len + 1;
942 dict_insert(newdb, strdup(key), alloc_record_data_qstring(dest));
948 for (it = dict_first(GET_RECORD_OBJECT(rd)); it; it = iter_next(it)) {
949 const char *k2, *end;
952 /* Evaluate the expression for this subentry. */
954 end = k2 + strlen(k2);
955 res = helpfile_eval_condition(k2, &end);
956 /* If the evaluation failed, bail. */
958 log_module(MAIN_LOG, LOG_FATAL, " .. while processing entry '%s' condition '%s'.", key, k2);
961 /* If the condition was false, try another. */
964 /* If we cannot unlistify the contents, bail. */
965 if (unlistify_help(key, iter_data(it), extra))
969 /* If none of the conditions apply, just omit the entry. */
978 open_helpfile(const char *fname, expand_func_t expand)
982 dict_t db = parse_database(fname);
983 hf = calloc(1, sizeof(*hf));
985 hf->db = alloc_database();
986 dict_set_free_keys(hf->db, free);
987 if ((slash = strrchr(fname, '/'))) {
988 hf->name = strdup(slash + 1);
990 hf->name = strdup(fname);
991 dict_insert(language_find("C")->helpfiles, hf->name, hf);
994 dict_foreach(db, unlistify_help, hf->db);
1000 void close_helpfile(struct helpfile *hf)
1004 free((char*)hf->name);
1005 free_database(hf->db);
1009 void message_register_table(const struct message_entry *table)
1013 while (table->msgid) {
1014 dict_insert(lang_C->messages, table->msgid, (char*)table->format);
1019 void helpfile_init(void)
1021 message_register_table(msgtab);
1022 language_read_list();
1025 void helpfile_finalize(void)
1028 for (it = dict_first(languages); it; it = iter_next(it))
1029 language_read(iter_key(it));
1030 reg_exit_func(language_cleanup);