Don't require write support on help file.
[jelmer/ctrlproxy.git] / src / help.c
1 /*
2         ctrlproxy: A modular IRC proxy
3         help: module for access the help system
4
5         (c) 2006 Jelmer Vernooij <jelmer@nl.linux.org>
6         (c) 2004 Wilmer van der Gaast <wilmer@gaast.net>
7
8         This program is free software; you can redistribute it and/or modify
9         it under the terms of the GNU General Public License as published by
10         the Free Software Foundation; either version 2 of the License, or
11         (at your option) any later version.
12
13         This program is distributed in the hope that it will be useful,
14         but WITHOUT ANY WARRANTY; without even the implied warranty of
15         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16         GNU General Public License for more details.
17
18         You should have received a copy of the GNU General Public License
19         along with this program; if not, write to the Free Software
20         Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 */
22
23 #include "internals.h"
24 #include "help.h"
25 #include "log.h"
26
27 #define BUFSIZE 1100
28
29 void help_free(help_t *h)
30 {
31         if (h->file != NULL)
32 #if GLIB_MAJOR_VERSION == 2 && GLIB_MINOR_VERSION >= 8
33                 g_mapped_file_free(h->file);
34 #else
35                 g_free(h->file);
36 #endif
37         if (h->entries != NULL)
38                 g_hash_table_destroy(h->entries);
39         g_free(h);
40 }
41
42 GHashTable *help_build_hash(char *data, gsize len)
43 {
44         GHashTable *h = g_hash_table_new(g_str_hash, g_str_equal);
45         gsize i;
46         char *p;
47
48         i = 0;
49         while (i < len) {
50                 if (data[i] != '?') {
51                         log_global(LOG_WARNING, "Unknown character '0x%02x' in help file", 
52                                            data[i]);
53                         g_hash_table_destroy(h);
54                         return NULL;
55                 }
56                 /* Key starts here */
57                 p = g_strstr_len(data+i, len-i, "\n");
58                 if (p == NULL) {
59                         log_global(LOG_WARNING, "Error parsing help file");
60                         g_hash_table_destroy(h);
61                         return NULL;
62                 }
63                 g_hash_table_insert(h, g_strndup(data+i+1, p-(data+i)-1), p+1);
64                 p = g_strstr_len(data+i, len-i, "\n%\n");
65                 if (p == NULL) {
66                         log_global(LOG_WARNING, "Error parsing help file");
67                         g_hash_table_destroy(h);
68                         return NULL;
69                 }
70                 i = p-data+3;
71         }
72         
73         return h;
74 }
75
76 help_t *help_load_file( const char *helpfile )
77 {
78         help_t *h;
79         char *data;
80         GError *error = NULL;
81         gsize len;
82         
83         h = g_new0 (help_t, 1);
84         
85 #if GLIB_MAJOR_VERSION == 2 && GLIB_MINOR_VERSION >= 8
86         h->file = g_mapped_file_new(helpfile, FALSE, &error);
87         if (h->file != NULL) {
88                 len = g_mapped_file_get_length(h->file);
89                 data = g_mapped_file_get_contents(h->file);
90         }
91         
92         if( h->file == NULL ) {
93                 log_global(LOG_WARNING, "Unable to open help file `%s': %s", helpfile, 
94                                   error->message);
95                 help_free( h );
96                 return NULL;
97         }
98 #else
99         if (!g_file_get_contents(helpfile, &h->file, &len, &error)) {
100                 log_global(LOG_WARNING, "Unable to open help file `%s': %s", helpfile, 
101                                   error->message);
102                 help_free( h );
103                 return NULL;
104         } 
105         data = h->file;
106 #endif
107
108         h->entries = help_build_hash(data, len);
109
110         return h;
111 }
112
113 const char *help_get(help_t *h, const char *string)
114 {
115         if (h == NULL)
116                 return NULL;
117         return g_hash_table_lookup(h->entries, string);
118 }