2 * Code for reading and writing the disabled protocols file.
6 * Wireshark - Network traffic analyzer
7 * By Gerald Combs <gerald@wireshark.org>
8 * Copyright 1998 Gerald Combs
10 * This program is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU General Public License
12 * as published by the Free Software Foundation; either version 2
13 * of the License, or (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
40 #include <epan/filesystem.h>
41 #include <epan/proto.h>
43 #include "disabled_protos.h"
44 #include "file_util.h"
46 #define GLOBAL_PROTOCOLS_FILE_NAME "disabled_protos"
47 #define PROTOCOLS_FILE_NAME "disabled_protos"
50 * List of disabled protocols
52 static GList *global_disabled_protos = NULL;
53 static GList *disabled_protos = NULL;
55 #define INIT_BUF_SIZE 128
58 * Read in a list of disabled protocols.
60 * On success, "*pref_path_return" is set to NULL.
61 * On error, "*pref_path_return" is set to point to the pathname of
62 * the file we tried to read - it should be freed by our caller -
63 * and "*open_errno_return" is set to the error if an open failed
64 * or "*read_errno_return" is set to the error if a read failed.
67 static int read_disabled_protos_list_file(const char *ff_path, FILE *ff,
71 read_disabled_protos_list(char **gpath_return, int *gopen_errno_return,
72 int *gread_errno_return,
73 char **path_return, int *open_errno_return,
74 int *read_errno_return)
77 char *gff_path, *ff_path;
80 /* Construct the pathname of the global disabled protocols file. */
81 gff_path = get_datafile_path(GLOBAL_PROTOCOLS_FILE_NAME);
83 /* Read the global disabled protocols file, if it exists. */
85 if ((ff = eth_fopen(gff_path, "r")) != NULL) {
86 /* We succeeded in opening it; read it. */
87 err = read_disabled_protos_list_file(gff_path, ff,
88 &global_disabled_protos);
90 /* We had an error reading the file; return the errno and the
91 pathname, so our caller can report the error. */
92 *gopen_errno_return = 0;
93 *gread_errno_return = err;
94 *gpath_return = gff_path;
99 /* We failed to open it. If we failed for some reason other than
100 "it doesn't exist", return the errno and the pathname, so our
101 caller can report the error. */
102 if (errno != ENOENT) {
103 *gopen_errno_return = errno;
104 *gread_errno_return = 0;
105 *gpath_return = gff_path;
110 /* Construct the pathname of the user's disabled protocols file. */
111 ff_path = get_persconffile_path(PROTOCOLS_FILE_NAME, FALSE);
113 /* Read the user's disabled protocols file, if it exists. */
115 if ((ff = eth_fopen(ff_path, "r")) != NULL) {
116 /* We succeeded in opening it; read it. */
117 err = read_disabled_protos_list_file(ff_path, ff, &disabled_protos);
119 /* We had an error reading the file; return the errno and the
120 pathname, so our caller can report the error. */
121 *open_errno_return = 0;
122 *read_errno_return = err;
123 *path_return = ff_path;
128 /* We failed to open it. If we failed for some reason other than
129 "it doesn't exist", return the errno and the pathname, so our
130 caller can report the error. */
131 if (errno != ENOENT) {
132 *open_errno_return = errno;
133 *read_errno_return = 0;
134 *path_return = ff_path;
141 read_disabled_protos_list_file(const char *ff_path, FILE *ff,
152 /* If we already have a list of protocols, discard it. */
154 fl_ent = g_list_first(*flp);
155 while (fl_ent != NULL) {
156 prot = (protocol_def *) fl_ent->data;
159 fl_ent = fl_ent->next;
165 /* Allocate the protocol name buffer. */
166 prot_name_len = INIT_BUF_SIZE;
167 prot_name = g_malloc(prot_name_len + 1);
169 for (line = 1; ; line++) {
170 /* Lines in a disabled protocol file contain the "filter name" of
171 a protocol to be disabled. */
173 /* Skip over leading white space, if any. */
174 while ((c = getc(ff)) != EOF && isspace(c)) {
183 goto error; /* I/O error */
185 break; /* Nothing more to read */
187 ungetc(c, ff); /* Unread the non-white-space character. */
189 /* Get the name of the protocol. */
194 break; /* End of file, or I/O error */
196 break; /* Trailing white space, or end of line. */
198 break; /* Start of comment, running to end of line. */
199 /* Add this character to the protocol name string. */
200 if (prot_name_index >= prot_name_len) {
201 /* protocol name buffer isn't long enough; double its length. */
203 prot_name = g_realloc(prot_name, prot_name_len + 1);
205 prot_name[prot_name_index] = c;
209 if (isspace(c) && c != '\n') {
210 /* Skip over trailing white space. */
211 while ((c = getc(ff)) != EOF && c != '\n' && isspace(c))
213 if (c != EOF && c != '\n' && c != '#') {
214 /* Non-white-space after the protocol name; warn about it,
215 in case we come up with a reason to use it. */
216 g_warning("'%s' line %d has extra stuff after the protocol name.",
220 if (c != EOF && c != '\n') {
221 /* Skip to end of line. */
222 while ((c = getc(ff)) != EOF && c != '\n')
228 goto error; /* I/O error */
230 /* EOF, not error; no newline seen before EOF */
231 g_warning("'%s' line %d doesn't have a newline.", ff_path,
234 break; /* nothing more to read */
237 /* Null-terminate the protocol name. */
238 if (prot_name_index >= prot_name_len) {
239 /* protocol name buffer isn't long enough; double its length. */
241 prot_name = g_realloc(prot_name, prot_name_len + 1);
243 prot_name[prot_name_index] = '\0';
245 /* Add the new protocol to the list of disabled protocols */
246 prot = (protocol_def *) g_malloc(sizeof(protocol_def));
247 prot->name = g_strdup(prot_name);
248 *flp = g_list_append(*flp, prot);
258 * Disable protocols as per the stored configuration
261 set_disabled_protos_list(void)
268 * assume all protocols are enabled by default
270 if (disabled_protos == NULL)
273 fl_ent = g_list_first(disabled_protos);
275 while (fl_ent != NULL) {
276 prot = (protocol_def *) fl_ent->data;
277 i = proto_get_id_by_filter_name(prot->name);
279 /* XXX - complain here? */
281 if (proto_can_toggle_protocol(i))
282 proto_set_decoding(i, FALSE);
285 fl_ent = fl_ent->next;
289 if (global_disabled_protos == NULL)
292 fl_ent = g_list_first(global_disabled_protos);
294 while (fl_ent != NULL) {
295 prot = (protocol_def *) fl_ent->data;
296 i = proto_get_id_by_filter_name(prot->name);
298 /* XXX - complain here? */
300 if (proto_can_toggle_protocol(i)) {
301 proto_set_decoding(i, FALSE);
302 proto_set_cant_toggle(i);
306 fl_ent = fl_ent->next;
311 * Write out a list of disabled protocols.
313 * On success, "*pref_path_return" is set to NULL.
314 * On error, "*pref_path_return" is set to point to the pathname of
315 * the file we tried to read - it should be freed by our caller -
316 * and "*errno_return" is set to the error.
319 save_disabled_protos_list(char **pref_path_return, int *errno_return)
321 gchar *ff_path, *ff_path_new;
322 const gchar *ff_name;
325 protocol_t *protocol;
328 *pref_path_return = NULL; /* assume no error */
330 ff_name = PROTOCOLS_FILE_NAME;
332 ff_path = get_persconffile_path(ff_name, TRUE);
334 /* Write to "XXX.new", and rename if that succeeds.
335 That means we don't trash the file if we fail to write it out
337 ff_path_new = g_strdup_printf("%s.new", ff_path);
339 if ((ff = eth_fopen(ff_path_new, "w")) == NULL) {
340 *pref_path_return = ff_path;
341 *errno_return = errno;
346 /* Iterate over all the protocols */
348 for (i = proto_get_first_protocol(&cookie); i != -1;
349 i = proto_get_next_protocol(&cookie)) {
351 if (!proto_can_toggle_protocol(i)) {
355 protocol = find_protocol_by_id(i);
356 if (proto_is_protocol_enabled(protocol)) {
360 /* Write out the protocol name. */
361 fprintf(ff, "%s\n", proto_get_protocol_filter_name(i));
364 if (fclose(ff) == EOF) {
365 *pref_path_return = ff_path;
366 *errno_return = errno;
367 eth_unlink(ff_path_new);
373 /* ANSI C doesn't say whether "rename()" removes the target if it
374 exists; the Win32 call to rename files doesn't do so, which I
375 infer is the reason why the MSVC++ "rename()" doesn't do so.
376 We must therefore remove the target file first, on Windows. */
377 if (eth_remove(ff_path) < 0 && errno != ENOENT) {
378 /* It failed for some reason other than "it's not there"; if
379 it's not there, we don't need to remove it, so we just
381 *pref_path_return = ff_path;
382 *errno_return = errno;
383 eth_unlink(ff_path_new);
389 if (eth_rename(ff_path_new, ff_path) < 0) {
390 *pref_path_return = ff_path;
391 *errno_return = errno;
392 eth_unlink(ff_path_new);