]>
jfr.im git - irc/evilnet/x3.git/blob - src/helpfile.c
1 /* helpfile.c - Help file loading and display
2 * Copyright 2000-2004 srvx Development Team
4 * This file is part of x3.
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
))) {
175 log_module(MAIN_LOG
, LOG_ERROR
, "Unable to open language directory languages/%s: %s", name
, strerror(errno
));
178 if (!(lang
= dict_find(languages
, name
, NULL
)))
179 lang
= language_alloc(name
);
181 /* Find the parent language. */
182 snprintf(filename
, sizeof(filename
), "languages/%s/parent", name
);
183 if (!(file
= fopen(filename
, "r"))
184 || !fgets(filename
, sizeof(filename
), file
)) {
185 strcpy(filename
, "C");
187 if (!(lang
->parent
= language_find(filename
))) {
188 uscore
= strchr(filename
, '_');
191 lang
->parent
= language_find(filename
);
194 lang
->parent
= lang_C
;
197 /* (Re-)initialize the language's dicts. */
198 dict_delete(lang
->messages
);
199 lang
->messages
= dict_new();
200 dict_set_free_keys(lang
->messages
, free
);
201 dict_set_free_data(lang
->messages
, free
);
202 lang
->helpfiles
= dict_new();
203 dict_set_free_data(lang
->helpfiles
, language_free_helpfile
);
205 /* Read all the translations from the directory. */
206 while ((dirent
= readdir(dir
))) {
207 snprintf(filename
, sizeof(filename
), "languages/%s/%s", name
, dirent
->d_name
);
208 if (!strcmp(dirent
->d_name
,"parent")) {
210 } else if (!strcmp(dirent
->d_name
, "strings.db")) {
211 dict
= parse_database(filename
);
212 language_set_messages(lang
, dict
);
214 } else if ((hf
= dict_find(lang_C
->helpfiles
, dirent
->d_name
, NULL
))) {
215 hf
= open_helpfile(filename
, hf
->expand
);
216 dict_insert(lang
->helpfiles
, hf
->name
, hf
);
225 static void language_read_list(void)
228 struct dirent
*dirent
;
230 char namebuf
[MAXLEN
];
232 if (!(dir
= opendir("languages")))
234 while ((dirent
= readdir(dir
))) {
235 if (dirent
->d_name
[0] == '.')
237 snprintf(namebuf
, sizeof(namebuf
), "languages/%s", dirent
->d_name
);
238 if (stat(namebuf
, &sbuf
) < 0) {
239 log_module(MAIN_LOG
, LOG_INFO
, "Skipping language entry '%s' (unable to stat).", dirent
->d_name
);
242 if (!S_ISDIR(sbuf
.st_mode
)) {
243 log_module(MAIN_LOG
, LOG_INFO
, "Skipping language entry '%s' (not directory).", dirent
->d_name
);
246 language_alloc(dirent
->d_name
);
251 const char *language_find_message(struct language
*lang
, const char *msgid
) {
252 struct language
*curr
;
256 for (curr
= lang
; curr
; curr
= curr
->parent
)
257 if ((msg
= dict_find(curr
->messages
, msgid
, NULL
)))
259 log_module(MAIN_LOG
, LOG_ERROR
, "Tried to find unregistered message \"%s\" (original language %s)", msgid
, lang
->name
);
263 int strlen_vis(char *str
)
266 for(count
=0;*str
;str
++)
273 table_send(struct userNode
*from
, const char *to
, unsigned int size
, irc_send_func irc_send
, struct helpfile_table table
) {
274 unsigned int ii
, jj
, len
, nreps
, reps
, tot_width
, pos
, spaces
, *max_width
;
275 char line
[MAX_LINE_SIZE
+1];
276 struct handle_info
*hi
;
280 if (IsChannelName(to
) || *to
== '$') {
284 message_dest
= GetUserH(to
);
286 log_module(MAIN_LOG
, LOG_ERROR
, "Unable to find user with nickname %s (in table_send from %s).", to
, from
->nick
);
289 hi
= message_dest
->handle_info
;
290 #ifdef WITH_PROTOCOL_P10
291 to
= message_dest
->numeric
;
294 message_source
= from
;
296 /* If size or irc_send are 0, we should try to use a default. */
300 size
= DEFAULT_TABLE_SIZE
;
301 else if (hi
->table_width
)
302 size
= hi
->table_width
;
303 else if (hi
->screen_width
)
304 size
= hi
->screen_width
;
306 size
= DEFAULT_TABLE_SIZE
;
309 {} /* use that function */
311 irc_send
= HANDLE_FLAGGED(hi
, USE_PRIVMSG
) ? irc_privmsg
: irc_notice
;
313 irc_send
= IsChannelName(to
) ? irc_privmsg
: irc_notice
;
315 /* Limit size to how much we can show at once */
316 if (size
> sizeof(line
))
319 /* Figure out how wide columns should be */
320 max_width
= alloca(table
.width
* sizeof(int));
321 for (jj
=tot_width
=0; jj
<table
.width
; jj
++) {
322 /* Find the widest width for this column */
324 for (ii
=0; ii
<table
.length
; ii
++) {
325 len
= strlen(table
.contents
[ii
][jj
]);
326 if (len
> max_width
[jj
])
329 /* Separate columns with spaces */
330 tot_width
+= max_width
[jj
] + 1;
332 /* How many rows to put in a line? */
333 if ((table
.flags
& TABLE_REPEAT_ROWS
) && (size
> tot_width
))
334 nreps
= size
/ tot_width
;
337 /* Send headers line.. */
338 if (table
.flags
& TABLE_NO_HEADERS
) {
341 /* Sending headers needs special treatment: either show them
342 * once, or repeat them as many times as we repeat the columns
344 for (pos
=ii
=0; ii
<((table
.flags
& TABLE_REPEAT_HEADERS
)?nreps
:1); ii
++) {
346 len
= strlen(table
.contents
[0][jj
]);
347 //line[pos++] = '\02'; /* bold header */
348 spaces
= max_width
[jj
] - len
;
349 if (table
.flags
& TABLE_PAD_LEFT
)
352 memcpy(line
+pos
, table
.contents
[0][jj
], len
);
354 //line[pos++] = '\02'; /* end bold header */
355 if (++jj
== table
.width
)
357 if (!(table
.flags
& TABLE_PAD_LEFT
))
364 sepsize
= strlen_vis(line
);
365 sepstr
= malloc(sepsize
+ 1);
366 memset(sepstr
, '-', sepsize
);
368 if(hi
&& hi
->userlist_style
!= HI_STYLE_CLEAN
)
369 irc_send(from
, to
, sepstr
); /* ----------------- */
370 irc_send(from
, to
, line
); /* alpha beta roe */
371 if(hi
&& hi
->userlist_style
!= HI_STYLE_CLEAN
)
372 irc_send(from
, to
, sepstr
); /* ----------------- */
375 /* Send the table. */
376 for (jj
=0, pos
=0, reps
=0; ii
<table
.length
; ) {
378 len
= strlen(table
.contents
[ii
][jj
]);
379 spaces
= max_width
[jj
] - len
;
380 if (table
.flags
& TABLE_PAD_LEFT
)
381 while (spaces
--) line
[pos
++] = ' ';
382 memcpy(line
+pos
, table
.contents
[ii
][jj
], len
);
384 if (++jj
== table
.width
) {
385 jj
= 0, ++ii
, ++reps
;
386 if ((reps
== nreps
) || (ii
== table
.length
)) {
388 irc_send(from
, to
, line
);
393 if (!(table
.flags
& TABLE_PAD_LEFT
))
399 if (!(table
.flags
& TABLE_NO_HEADERS
)) {
400 /* Send end bar & free its memory */
403 sepstr
[sepsize
/2-1] = 'E';
404 sepstr
[sepsize
/2] = 'n';
405 sepstr
[sepsize
/2+1]= 'd';
408 if(hi
&& hi
->userlist_style
!= HI_STYLE_CLEAN
)
409 irc_send(from
, to
, sepstr
);
413 if (!(table
.flags
& TABLE_NO_FREE
)) {
414 /* Deallocate table memory (but not the string memory). */
415 for (ii
=0; ii
<table
.length
; ii
++)
416 free(table
.contents
[ii
]);
417 free(table
.contents
);
422 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
)
424 void (*irc_send
)(struct userNode
*from
, const char *to
, const char *msg
);
425 static struct string_buffer input
;
426 unsigned int size
, ipos
, pos
, length
, chars_sent
, use_color
;
427 unsigned int expand_pos
, expand_ipos
, newline_ipos
;
428 char line
[MAX_LINE_SIZE
];
430 if (IsChannelName(dest
) || *dest
== '$') {
432 } else if (!(message_dest
= GetUserH(dest
))) {
433 log_module(MAIN_LOG
, LOG_ERROR
, "Unable to find user with nickname %s (in vsend_message from %s).", dest
, src
->nick
);
435 } else if (message_dest
->dead
) {
436 /* No point in sending to a user who is leaving. */
439 #ifdef WITH_PROTOCOL_P10
440 dest
= message_dest
->numeric
;
443 message_source
= src
;
444 if (!(msg_type
& MSG_TYPE_NOXLATE
)
445 && !(format
= handle_find_message(handle
, format
)))
447 /* fill in a buffer with the string */
449 string_buffer_append_vprintf(&input
, format
, al
);
451 /* figure out how to send the messages */
453 msg_type
|= (HANDLE_FLAGGED(handle
, USE_PRIVMSG
) ? 1 : 0);
454 use_color
= HANDLE_FLAGGED(handle
, MIRC_COLOR
);
455 size
= handle
->screen_width
;
456 if (size
> sizeof(line
))
462 if (!size
|| !(msg_type
& MSG_TYPE_MULTILINE
))
463 size
= DEFAULT_LINE_SIZE
;
464 switch (msg_type
& 3) {
466 irc_send
= irc_notice
;
469 irc_send
= irc_wallchops
;
473 irc_send
= irc_privmsg
;
476 /* This used to be two passes, but if you do that and allow
477 * arbitrary sizes for ${}-expansions (as with help indexes),
478 * that requires a very big intermediate buffer.
480 expand_ipos
= newline_ipos
= ipos
= 0;
481 expand_pos
= pos
= 0;
483 while (input
.list
[ipos
]) {
484 char ch
, *value
, *free_value
;
486 while ((ch
= input
.list
[ipos
]) && (ch
!= '$') && (ch
!= '\n') && (pos
< size
)) {
491 if (!input
.list
[ipos
])
493 if (input
.list
[ipos
] == '\n') {
498 unsigned int new_ipos
;
499 /* Scan backwards for a space in the input, until we hit
500 * either the last newline or the last variable expansion.
501 * Print the line up to that point, and start from there.
503 for (new_ipos
= ipos
;
504 (new_ipos
> expand_ipos
) && (new_ipos
> newline_ipos
);
506 if (input
.list
[new_ipos
] == ' ')
508 pos
-= ipos
- new_ipos
;
509 if (new_ipos
== newline_ipos
) {
510 /* Single word was too big to fit on one line; skip
511 * forward to its end and print it as a whole.
513 while (input
.list
[new_ipos
]
514 && (input
.list
[new_ipos
] != ' ')
515 && (input
.list
[new_ipos
] != '\n')
516 && (input
.list
[new_ipos
] != '$'))
517 line
[pos
++] = input
.list
[new_ipos
++];
520 while (input
.list
[ipos
] == ' ')
526 switch (input
.list
[++ipos
]) {
527 /* Literal '$' or end of string. */
533 /* The following two expand to mIRC color codes if enabled
536 value
= use_color
? "\002" : "";
539 value
= use_color
? "\017" : "";
542 value
= use_color
? "\026" : "";
545 value
= use_color
? "\037" : "";
552 value
= global
? global
->nick
: "Global";
555 value
= chanserv
? chanserv
->nick
: "ChanServ";
558 value
= opserv
? opserv
->nick
: "OpServ";
561 value
= nickserv
? nickserv
->nick
: "NickServ";
567 value
= handle
? handle
->handle
: "Account";
569 #define SEND_LINE(TRUNCED) do { \
572 if (!(msg_type & MSG_TYPE_MULTILINE) && (pos > 1) && TRUNCED) \
573 line[pos-2] = line[pos-1] = '.'; \
574 irc_send(src, dest, line); \
578 newline_ipos = ipos; \
579 if (!(msg_type & MSG_TYPE_MULTILINE)) return chars_sent; \
581 /* Custom expansion handled by helpfile-specific function. */
584 struct helpfile_expansion exp
;
585 char *name_end
= input
.list
+ ipos
+ 1, *colon
= NULL
;
587 while (*name_end
!= '}' && *name_end
!= ')' && *name_end
) {
588 if (*name_end
== ':') {
598 struct module *module = module_find(input
.list
+ ipos
+ 1);
599 if (module && module->expand_help
)
600 exp
= module->expand_help(colon
+ 1);
606 exp
= expand_f(input
.list
+ ipos
+ 1);
611 free_value
= value
= exp
.value
.str
;
616 /* Must send current line, then emit table. */
618 table_send(src
, (message_dest
? message_dest
->nick
: dest
), 0, irc_send
, exp
.value
.table
);
623 log_module(MAIN_LOG
, LOG_ERROR
, "Invalid exp.type %d from expansion function %p.", exp
.type
, expand_f
);
626 ipos
= name_end
- input
.list
;
633 value
[1] = input
.list
[ipos
];
637 while ((pos
+ strlen(value
) > size
) || strchr(value
, '\n')) {
639 avail
= size
- pos
- 1;
640 length
= strcspn(value
, "\n ");
641 if (length
<= avail
) {
642 strncpy(line
+pos
, value
, length
);
645 /* copy over spaces, until (possible) end of line */
646 while (*value
== ' ') {
648 line
[pos
++] = *value
;
652 /* word to send is too big to send now.. what to do? */
654 /* try to put it on a separate line */
657 /* already at start of line; only send part of it */
658 strncpy(line
, value
, avail
);
661 /* skip any trailing spaces */
662 while (*value
== ' ')
666 /* if we're looking at a newline, send the accumulated text */
667 if (*value
== '\n') {
672 length
= strlen(value
);
673 memcpy(line
+ pos
, value
, length
);
677 if ((pos
< size
-1) && input
.list
[ipos
]) {
692 send_message(struct userNode
*dest
, struct userNode
*src
, const char *format
, ...)
697 if (IsLocal(dest
)) return 0;
698 va_start(ap
, format
);
699 res
= vsend_message(dest
->nick
, src
, dest
->handle_info
, 0, NULL
, format
, ap
);
705 send_message_type(int msg_type
, struct userNode
*dest
, struct userNode
*src
, const char *format
, ...) {
709 if (IsLocal(dest
)) return 0;
710 va_start(ap
, format
);
711 res
= vsend_message(dest
->nick
, src
, dest
->handle_info
, msg_type
, NULL
, format
, ap
);
717 send_target_message(int msg_type
, const char *dest
, struct userNode
*src
, const char *format
, ...)
722 va_start(ap
, format
);
723 res
= vsend_message(dest
, src
, NULL
, msg_type
, NULL
, format
, ap
);
729 _send_help(struct userNode
*dest
, struct userNode
*src
, expand_func_t expand
, const char *format
, ...)
734 va_start(ap
, format
);
735 res
= vsend_message(dest
->nick
, src
, dest
->handle_info
, 12, expand
, format
, ap
);
741 send_help(struct userNode
*dest
, struct userNode
*src
, struct helpfile
*hf
, const char *topic
)
743 struct helpfile
*lang_hf
;
744 struct record_data
*rec
;
745 struct language
*curr
;
750 _send_help(dest
, src
, NULL
, "HFMSG_MISSING_HELPFILE");
753 for (curr
= (dest
->handle_info
? dest
->handle_info
->language
: lang_C
);
755 curr
= curr
->parent
) {
756 lang_hf
= dict_find(curr
->helpfiles
, hf
->name
, NULL
);
759 rec
= dict_find(lang_hf
->db
, topic
, NULL
);
760 if (rec
&& rec
->type
== RECDB_QSTRING
) {
761 _send_help(dest
, src
, hf
->expand
, rec
->d
.qstring
);
765 rec
= dict_find(hf
->db
, "<missing>", NULL
);
768 if (rec
->type
!= RECDB_QSTRING
) {
769 send_message(dest
, src
, "HFMSG_HELP_NOT_STRING");
772 _send_help(dest
, src
, hf
->expand
, rec
->d
.qstring
);
777 send_help_brief(struct userNode
*dest
, struct userNode
*src
, struct helpfile
*hf
, const char *topic
)
779 struct helpfile
*lang_hf
;
780 struct record_data
*rec
;
781 struct language
*curr
;
786 _send_help(dest
, src
, NULL
, "HFMSG_MISSING_HELPFILE");
789 for (curr
= (dest
->handle_info
? dest
->handle_info
->language
: lang_C
);
791 curr
= curr
->parent
) {
792 lang_hf
= dict_find(curr
->helpfiles
, hf
->name
, NULL
);
795 rec
= dict_find(lang_hf
->db
, topic
, NULL
);
796 if (rec
&& rec
->type
== RECDB_QSTRING
)
801 buf
= malloc(strlen(rec
->d
.qstring
) + 1);
802 strcpy(buf
, rec
->d
.qstring
);
803 *strchr(buf
, '\n') = 0;
805 res
= _send_help(dest
, src
, hf
->expand
, buf
);
810 rec
= dict_find(hf
->db
, "<missing>", NULL
);
812 return 0; /* send_message(dest, src, "MSG_TOPIC_UNKNOWN"); */
813 if (rec
->type
!= RECDB_QSTRING
)
814 return 0; /* send_message(dest, src, "HFMSG_HELP_NOT_STRING"); */
815 return _send_help(dest
, src
, hf
->expand
, rec
->d
.qstring
);
818 /* Grammar supported by this parser:
819 * condition = expr | prefix expr
820 * expr = atomicexpr | atomicexpr op atomicexpr
821 * op = '&&' | '||' | 'and' | 'or'
822 * atomicexpr = '(' expr ')' | identifier
823 * identifier = ( '0'-'9' 'A'-'Z' 'a'-'z' '-' '_' '/' )+ | ! identifier
825 * Whitespace is ignored. The parser is implemented as a recursive
826 * descent parser by functions like:
827 * static int helpfile_eval_<element>(const char *start, const char **end);
836 static const struct {
839 } helpfile_operators
[] = {
840 { "&&", OP_BOOL_AND
},
841 { "and", OP_BOOL_AND
},
842 { "||", OP_BOOL_OR
},
843 { "or", OP_BOOL_OR
},
847 static const char *identifier_chars
= "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz-_/";
849 static int helpfile_eval_expr(const char *start
, const char **end
);
850 static int helpfile_eval_atomicexpr(const char *start
, const char **end
);
851 static int helpfile_eval_identifier(const char *start
, const char **end
);
854 helpfile_eval_identifier(const char *start
, const char **end
)
856 /* Skip leading whitespace. */
857 while (isspace(*start
) && (start
< *end
))
860 log_module(MAIN_LOG
, LOG_FATAL
, "Expected identifier in helpfile condition.");
864 if (start
[0] == '!') {
865 int res
= helpfile_eval_identifier(start
+1, end
);
869 } else if (start
[0] == '/') {
871 char *id_str
, *value
;
874 strchr(identifier_chars
, sep
[0]) && (sep
< *end
);
876 memcpy(id_str
= alloca(sep
+1-start
), start
, sep
-start
);
877 id_str
[sep
-start
] = '\0';
878 value
= conf_get_data(id_str
+1, RECDB_QSTRING
);
882 return enabled_string(value
) || true_string(value
);
883 } else if ((*end
- start
>= 4) && !ircncasecmp(start
, "true", 4)) {
886 } else if ((*end
- start
>= 5) && !ircncasecmp(start
, "false", 5)) {
890 log_module(MAIN_LOG
, LOG_FATAL
, "Unexpected helpfile identifier '%.*s'.", (int)(*end
-start
), start
);
896 helpfile_eval_atomicexpr(const char *start
, const char **end
)
901 /* Skip leading whitespace. */
902 while (isspace(*start
) && (start
< *end
))
905 log_module(MAIN_LOG
, LOG_FATAL
, "Expected atomic expression in helpfile condition.");
909 /* If it's not parenthesized, it better be a valid identifier. */
911 return helpfile_eval_identifier(start
, end
);
913 /* Parse the internal expression. */
916 res
= helpfile_eval_expr(start
, &sep
);
918 /* Check for the closing parenthesis. */
919 while (isspace(*sep
) && (sep
< *end
))
921 if ((sep
== *end
) || (sep
[0] != ')')) {
922 log_module(MAIN_LOG
, LOG_FATAL
, "Expected close parenthesis at '%.*s'.", (int)(*end
-sep
), sep
);
926 /* Report the end location and result. */
932 helpfile_eval_expr(const char *start
, const char **end
)
934 const char *sep
, *sep2
;
935 unsigned int ii
, len
;
939 /* Parse the first atomicexpr. */
941 res_a
= helpfile_eval_atomicexpr(start
, &sep
);
945 /* Figure out what follows that. */
946 while (isspace(*sep
) && (sep
< *end
))
951 for (ii
= 0; helpfile_operators
[ii
].str
; ++ii
) {
952 len
= strlen(helpfile_operators
[ii
].str
);
953 if (ircncasecmp(sep
, helpfile_operators
[ii
].str
, len
))
955 op
= helpfile_operators
[ii
].op
;
958 if (op
== OP_INVALID
) {
959 log_module(MAIN_LOG
, LOG_FATAL
, "Unrecognized helpfile operator at '%.*s'.", (int)(*end
-sep
), sep
);
963 /* Parse the next atomicexpr. */
965 res_b
= helpfile_eval_atomicexpr(sep
, &sep2
);
969 /* Make sure there's no trailing garbage */
970 while (isspace(*sep2
) && (sep2
< *end
))
973 log_module(MAIN_LOG
, LOG_FATAL
, "Trailing garbage in helpfile expression: '%.*s'.", (int)(*end
-sep2
), sep2
);
977 /* Record where we stopped parsing. */
980 /* Do the logic on the subexpressions. */
983 return res_a
&& res_b
;
985 return res_a
|| res_b
;
992 helpfile_eval_condition(const char *start
, const char **end
)
996 /* Skip the prefix if there is one. */
997 for (term
= start
; isalnum(*term
) && (term
< *end
); ++term
) ;
999 if ((term
+ 2 >= *end
) || (term
[0] != ':') || (term
[1] != ' ')) {
1000 log_module(MAIN_LOG
, LOG_FATAL
, "In helpfile condition '%.*s' expected prefix to end with ': '.",(int)(*end
-start
), start
);
1006 /* Evaluate the remaining string as an expression. */
1007 return helpfile_eval_expr(start
, end
);
1011 unlistify_help(const char *key
, void *data
, void *extra
)
1013 struct record_data
*rd
= data
;
1014 dict_t newdb
= extra
;
1018 dict_insert(newdb
, strdup(key
), alloc_record_data_qstring(GET_RECORD_QSTRING(rd
)));
1020 case RECDB_STRING_LIST
: {
1021 struct string_list
*slist
= GET_RECORD_STRING_LIST(rd
);
1023 unsigned int totlen
, len
, i
;
1025 for (i
=totlen
=0; i
<slist
->used
; i
++)
1026 totlen
= totlen
+ strlen(slist
->list
[i
]) + 1;
1027 dest
= alloca(totlen
+1);
1028 for (i
=totlen
=0; i
<slist
->used
; i
++) {
1029 len
= strlen(slist
->list
[i
]);
1030 memcpy(dest
+totlen
, slist
->list
[i
], len
);
1031 dest
[totlen
+len
] = '\n';
1032 totlen
= totlen
+ len
+ 1;
1035 dict_insert(newdb
, strdup(key
), alloc_record_data_qstring(dest
));
1038 case RECDB_OBJECT
: {
1041 for (it
= dict_first(GET_RECORD_OBJECT(rd
)); it
; it
= iter_next(it
)) {
1042 const char *k2
, *end
;
1045 /* Evaluate the expression for this subentry. */
1047 end
= k2
+ strlen(k2
);
1048 res
= helpfile_eval_condition(k2
, &end
);
1049 /* If the evaluation failed, bail. */
1051 log_module(MAIN_LOG
, LOG_FATAL
, " .. while processing entry '%s' condition '%s'.", key
, k2
);
1054 /* If the condition was false, try another. */
1057 /* If we cannot unlistify the contents, bail. */
1058 if (unlistify_help(key
, iter_data(it
), extra
))
1062 /* If none of the conditions apply, just omit the entry. */
1071 open_helpfile(const char *fname
, expand_func_t expand
)
1073 struct helpfile
*hf
;
1075 dict_t db
= parse_database(fname
);
1076 hf
= calloc(1, sizeof(*hf
));
1077 hf
->expand
= expand
;
1078 hf
->db
= alloc_database();
1079 dict_set_free_keys(hf
->db
, free
);
1080 if ((slash
= strrchr(fname
, '/'))) {
1081 hf
->name
= strdup(slash
+ 1);
1083 hf
->name
= strdup(fname
);
1084 dict_insert(language_find("C")->helpfiles
, hf
->name
, hf
);
1087 dict_foreach(db
, unlistify_help
, hf
->db
);
1093 void close_helpfile(struct helpfile
*hf
)
1097 free((char*)hf
->name
);
1098 free_database(hf
->db
);
1102 void message_register_table(const struct message_entry
*table
)
1106 while (table
->msgid
) {
1107 dict_insert(lang_C
->messages
, table
->msgid
, (char*)table
->format
);
1112 void helpfile_init(void)
1114 message_register_table(msgtab
);
1115 language_read_list();
1118 void helpfile_finalize(void)
1121 for (it
= dict_first(languages
); it
; it
= iter_next(it
))
1122 language_read(iter_key(it
));
1123 reg_exit_func(language_cleanup
);