Bug Summary

File:builds/wireshark/wireshark/epan/prefs.c
Warning:line 4692, column 21
Value of 'errno' was not checked and may be overwritten by function 'getc_unlocked'

Annotated Source Code

Press '?' to see keyboard shortcuts

clang -cc1 -cc1 -triple x86_64-pc-linux-gnu -analyze -disable-free -clear-ast-before-backend -disable-llvm-verifier -discard-value-names -main-file-name prefs.c -analyzer-checker=core -analyzer-checker=apiModeling -analyzer-checker=unix -analyzer-checker=deadcode -analyzer-checker=security.insecureAPI.UncheckedReturn -analyzer-checker=security.insecureAPI.getpw -analyzer-checker=security.insecureAPI.gets -analyzer-checker=security.insecureAPI.mktemp -analyzer-checker=security.insecureAPI.mkstemp -analyzer-checker=security.insecureAPI.vfork -analyzer-checker=nullability.NullPassedToNonnull -analyzer-checker=nullability.NullReturnedFromNonnull -analyzer-output plist -w -setup-static-analyzer -mrelocation-model pic -pic-level 2 -fhalf-no-semantic-interposition -fno-delete-null-pointer-checks -mframe-pointer=all -relaxed-aliasing -fmath-errno -ffp-contract=on -fno-rounding-math -ffloat16-excess-precision=fast -fbfloat16-excess-precision=fast -mconstructor-aliases -funwind-tables=2 -target-cpu x86-64 -tune-cpu generic -debugger-tuning=gdb -fdebug-compilation-dir=/builds/wireshark/wireshark/build -fcoverage-compilation-dir=/builds/wireshark/wireshark/build -resource-dir /usr/lib/llvm-22/lib/clang/22 -isystem /usr/include/glib-2.0 -isystem /usr/lib/x86_64-linux-gnu/glib-2.0/include -isystem /builds/wireshark/wireshark/epan -isystem /builds/wireshark/wireshark/build/epan -isystem /usr/include/mit-krb5 -isystem /usr/include/lua5.5 -isystem /usr/include/libxml2 -D CARES_NO_DEPRECATED -D G_DISABLE_DEPRECATED -D G_DISABLE_SINGLE_INCLUDES -D REX_API=extern -D WS_BUILD_DLL -D WS_DEBUG -D WS_DEBUG_UTF_8 -D epan_EXPORTS -I /builds/wireshark/wireshark/build -I /builds/wireshark/wireshark -I /builds/wireshark/wireshark/include -I /builds/wireshark/wireshark/wiretap -D _GLIBCXX_ASSERTIONS -internal-isystem /usr/lib/llvm-22/lib/clang/22/include -internal-isystem /usr/local/include -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/16/../../../../x86_64-linux-gnu/include -internal-externc-isystem /usr/include/x86_64-linux-gnu -internal-externc-isystem /include -internal-externc-isystem /usr/include -fmacro-prefix-map=/builds/wireshark/wireshark/= -fmacro-prefix-map=/builds/wireshark/wireshark/build/= -fmacro-prefix-map=../= -Wno-format-nonliteral -std=gnu17 -ferror-limit 19 -fvisibility=hidden -fwrapv -fwrapv-pointer -fstrict-flex-arrays=3 -stack-protector 2 -fstack-clash-protection -fcf-protection=full -fgnuc-version=4.2.1 -fskip-odr-check-in-gmf -fexceptions -fcolor-diagnostics -analyzer-output=html -faddrsig -fdwarf2-cfi-asm -o /builds/wireshark/wireshark/sbout/2026-10-02-100859-3662-1 -x c /builds/wireshark/wireshark/epan/prefs.c
1/* prefs.c
2 * Routines for handling preferences
3 *
4 * Wireshark - Network traffic analyzer
5 * By Gerald Combs <[email protected]>
6 * Copyright 1998 Gerald Combs
7 *
8 * SPDX-License-Identifier: GPL-2.0-or-later
9 */
10
11#include "config.h"
12#define WS_LOG_DOMAIN"Epan" LOG_DOMAIN_EPAN"Epan"
13
14#include "ws_diag_control.h"
15
16#include <stdlib.h>
17#include <string.h>
18#include <errno(*__errno_location ()).h>
19#ifdef _WIN32
20#include <windows.h>
21#endif
22
23#include <glib.h>
24
25#include <stdio.h>
26#include <wsutil/filesystem.h>
27#include <epan/addr_resolv.h>
28#include <epan/oids.h>
29#include <epan/maxmind_db.h>
30#include <epan/packet.h>
31#include <epan/prefs.h>
32#include <epan/proto.h>
33#include <epan/strutil.h>
34#include <epan/column.h>
35#include <epan/decode_as.h>
36#include <wsutil/file_util.h>
37#include <wsutil/report_message.h>
38#include <wsutil/wslog.h>
39#include <wsutil/ws_assert.h>
40#include <wsutil/array.h>
41
42#include <epan/prefs-int.h>
43#include <epan/uat-int.h>
44
45#include "epan/filter_expressions.h"
46#include "epan/aggregation_fields.h"
47
48#include "epan/wmem_scopes.h"
49#include <epan/stats_tree.h>
50
51#define REG_HKCU_WIRESHARK_KEY"Software\\Wireshark" "Software\\Wireshark"
52
53/*
54 * Module alias.
55 */
56typedef struct pref_module_alias {
57 const char *name; /**< name of module alias */
58 module_t *module; /**< module for which it's an alias */
59} module_alias_t;
60
61/* Internal functions */
62static void prefs_register_modules(void);
63static module_t *prefs_find_module_alias(const char *name);
64static prefs_set_pref_e set_pref(char*, const char*, void *, bool_Bool);
65static void free_col_info(GList *);
66static void prefs_set_global_defaults(wmem_allocator_t* pref_scope, const char** col_fmt, int num_cols);
67static bool_Bool prefs_is_column_visible(const char *cols_hidden, int col);
68static bool_Bool prefs_is_column_fmt_visible(const char *cols_hidden, fmt_data *cfmt);
69static int find_val_for_string(const char *needle, const enum_val_t *haystack, int default_value);
70
71#define PF_NAME"preferences" "preferences"
72#define OLD_GPF_NAME"wireshark.conf" "wireshark.conf" /* old name for global preferences file */
73
74static char *gpf_path;
75static char *cols_hidden_list;
76static char *cols_hidden_fmt_list;
77
78e_prefs prefs;
79
80static const enum_val_t gui_console_open_type[] = {
81 {"NEVER", "NEVER", LOG_CONSOLE_OPEN_NEVER},
82 {"AUTOMATIC", "AUTOMATIC", LOG_CONSOLE_OPEN_AUTO},
83 {"ALWAYS", "ALWAYS", LOG_CONSOLE_OPEN_ALWAYS},
84 {NULL((void*)0), NULL((void*)0), -1}
85};
86
87static const enum_val_t gui_version_placement_type[] = {
88 {"WELCOME", "WELCOME", version_welcome_only},
89 {"TITLE", "TITLE", version_title_only},
90 {"BOTH", "BOTH", version_both},
91 {"NEITHER", "NEITHER", version_neither},
92 {NULL((void*)0), NULL((void*)0), -1}
93};
94
95static const enum_val_t gui_fileopen_style[] = {
96 {"LAST_OPENED", "LAST_OPENED", FO_STYLE_LAST_OPENED0},
97 {"SPECIFIED", "SPECIFIED", FO_STYLE_SPECIFIED1},
98 {"CWD", "CWD", FO_STYLE_CWD2},
99 {NULL((void*)0), NULL((void*)0), -1}
100};
101
102static const enum_val_t gui_toolbar_style[] = {
103 {"ICONS", "ICONS", 0},
104 {"TEXT", "TEXT", 1},
105 {"BOTH", "BOTH", 2},
106 {NULL((void*)0), NULL((void*)0), -1}
107};
108
109static const enum_val_t gui_layout_content[] = {
110 {"NONE", "NONE", 0},
111 {"PLIST", "PLIST", 1},
112 {"PDETAILS", "PDETAILS", 2},
113 {"PBYTES", "PBYTES", 3},
114 {"PDIAGRAM", "PDIAGRAM", 4},
115 {NULL((void*)0), NULL((void*)0), -1}
116};
117
118static const enum_val_t gui_packet_dialog_layout[] = {
119 {"vertical", "Vertical (Stacked)", layout_vertical},
120 {"horizontal", "Horizontal (Side-by-side)", layout_horizontal},
121 {NULL((void*)0), NULL((void*)0), -1}
122};
123
124static const enum_val_t capture_process_info_vals[] = {
125 {"NONE", "Nothing", CAPTURE_PROCESS_INFO_NONE},
126 {"BASIC", "Process ID and name", CAPTURE_PROCESS_INFO_BASIC},
127 {"FULL", "Process ID, name, path, command line and user", CAPTURE_PROCESS_INFO_FULL},
128 {NULL((void*)0), NULL((void*)0), -1}
129};
130
131static const enum_val_t gui_update_channel[] = {
132 {"DEVELOPMENT", "DEVELOPMENT", UPDATE_CHANNEL_DEVELOPMENT},
133 {"STABLE", "STABLE", UPDATE_CHANNEL_STABLE},
134 {NULL((void*)0), NULL((void*)0), -1}
135};
136
137static const enum_val_t gui_packet_list_multi_color_modes[] = {
138 {"off", "Off", PACKET_LIST_MULTI_COLOR_MODE_OFF},
139 {"scrollbar_only", "Scrollbar Only", PACKET_LIST_MULTI_COLOR_MODE_SCROLLBAR_ONLY},
140 {"full_stripes", "Full Stripes", PACKET_LIST_MULTI_COLOR_MODE_FULL},
141 {"shift_right", "Shift Right", PACKET_LIST_MULTI_COLOR_MODE_SHIFT_RIGHT},
142 {NULL((void*)0), NULL((void*)0), -1}
143};
144
145static const enum_val_t gui_packet_list_multi_color_separators[] = {
146 {"vertical", "Vertical", PACKET_LIST_MULTI_COLOR_SEPARATOR_VERTICAL},
147 {"diagonal", "Diagonal", PACKET_LIST_MULTI_COLOR_SEPARATOR_DIAGONAL},
148 {"bubble", "Bubble", PACKET_LIST_MULTI_COLOR_SEPARATOR_BUBBLE},
149 {NULL((void*)0), NULL((void*)0), -1}
150};
151
152static const enum_val_t gui_packet_list_copy_format_options_for_keyboard_shortcut[] = {
153 {"TEXT", "Text", COPY_FORMAT_TEXT},
154 {"CSV", "CSV", COPY_FORMAT_CSV},
155 {"YAML", "YAML", COPY_FORMAT_YAML},
156 {"HTML", "HTML", COPY_FORMAT_HTML},
157 {NULL((void*)0), NULL((void*)0), -1}
158};
159
160/* None : Historical behavior, no deinterlacing */
161#define CONV_DEINT_CHOICE_NONE0 0
162/* MI : MAC & Interface */
163#define CONV_DEINT_CHOICE_MI0x04 + 0x02 CONV_DEINT_KEY_MAC0x04 + CONV_DEINT_KEY_INTERFACE0x02
164/* VM : VLAN & MAC */
165#define CONV_DEINT_CHOICE_VM0x08 + 0x04 CONV_DEINT_KEY_VLAN0x08 + CONV_DEINT_KEY_MAC0x04
166/* VMI : VLAN & MAC & Interface */
167#define CONV_DEINT_CHOICE_VMI0x08 + 0x04 + 0x02 CONV_DEINT_KEY_VLAN0x08 + CONV_DEINT_KEY_MAC0x04 + CONV_DEINT_KEY_INTERFACE0x02
168
169static const enum_val_t conv_deint_options[] = {
170 {"NONE", "NONE", CONV_DEINT_CHOICE_NONE0},
171 {".MI", ".MI", CONV_DEINT_CHOICE_MI0x04 + 0x02 },
172 {"VM.", "VM.", CONV_DEINT_CHOICE_VM0x08 + 0x04 },
173 {"VMI", "VMI", CONV_DEINT_CHOICE_VMI0x08 + 0x04 + 0x02 },
174 {NULL((void*)0), NULL((void*)0), -1}
175};
176
177static const enum_val_t abs_time_format_options[] = {
178 {"NEVER", "Never", ABS_TIME_ASCII_NEVER},
179 {"TREE", "Protocol tree only", ABS_TIME_ASCII_TREE},
180 {"COLUMN", "Protocol tree and columns", ABS_TIME_ASCII_COLUMN},
181 {"ALWAYS", "Always", ABS_TIME_ASCII_ALWAYS},
182 {NULL((void*)0), NULL((void*)0), -1}
183};
184
185static const enum_val_t gui_packet_list_elide_mode[] = {
186 {"LEFT", "LEFT", ELIDE_LEFT},
187 {"RIGHT", "RIGHT", ELIDE_RIGHT},
188 {"MIDDLE", "MIDDLE", ELIDE_MIDDLE},
189 {"NONE", "NONE", ELIDE_NONE},
190 {NULL((void*)0), NULL((void*)0), -1}
191};
192
193/** Struct to hold preference data */
194struct preference {
195 const char *name; /**< name of preference */
196 const char *title; /**< title to use in GUI */
197 const char *description; /**< human-readable description of preference */
198 wmem_allocator_t* scope; /**< memory scope allocator for this preference */
199 int ordinal; /**< ordinal number of this preference */
200 pref_type_e type; /**< type of that preference */
201 bool_Bool obsolete; /**< obsolete preference flag */
202 unsigned int effect_flags; /**< Flags of types effected by preference (PREF_EFFECT_DISSECTION, PREF_EFFECT_CAPTURE, etc).
203 Flags must be non-zero to ensure saving to disk */
204 union { /* The Qt preference code assumes that these will all be pointers (and unique) */
205 unsigned *uint;
206 bool_Bool *boolp;
207 int *enump;
208 int* intp;
209 double* floatp;
210 char **string;
211 range_t **range;
212 struct epan_uat* uat;
213 color_t *colorp;
214 GList** list;
215 } varp; /**< pointer to variable storing the value */
216 union {
217 unsigned uint;
218 bool_Bool boolval;
219 int enumval;
220 int intval;
221 double floatval;
222 char *string;
223 range_t *range;
224 color_t color;
225 GList* list;
226 } stashed_val; /**< original value, when editing from the GUI */
227 union {
228 unsigned uint;
229 bool_Bool boolval;
230 int enumval;
231 int intval;
232 double floatval;
233 char *string;
234 range_t *range;
235 color_t color;
236 GList* list;
237 } default_val; /**< the default value of the preference */
238 union {
239 unsigned base; /**< input/output base, for PREF_UINT */
240 uint32_t max_value; /**< maximum value of a range */
241 struct {
242 const enum_val_t *enumvals; /**< list of name & values */
243 bool_Bool radio_buttons; /**< true if it should be shown as
244 radio buttons rather than as an
245 option menu or combo box in
246 the preferences tab */
247 } enum_info; /**< for PREF_ENUM */
248 } info; /**< display/text file information */
249 struct pref_custom_cbs custom_cbs; /**< for PREF_CUSTOM */
250 const char *dissector_table; /**< for PREF_DECODE_AS_RANGE */
251 const char *dissector_desc; /**< for PREF_DECODE_AS_RANGE */
252};
253
254const char* prefs_get_description(pref_t *pref)
255{
256 return pref->description;
257}
258
259const char* prefs_get_title(pref_t *pref)
260{
261 return pref->title;
262}
263
264int prefs_get_type(pref_t *pref)
265{
266 return pref->type;
267}
268
269const char* prefs_get_name(pref_t *pref)
270{
271 return pref->name;
272}
273
274uint32_t prefs_get_max_value(pref_t *pref)
275{
276 return pref->info.max_value;
277}
278
279const char* prefs_get_dissector_table(pref_t *pref)
280{
281 return pref->dissector_table;
282}
283
284static const char* prefs_get_dissector_description(pref_t *pref)
285{
286 return pref->dissector_desc;
287}
288
289/*
290 * List of all modules with preference settings.
291 */
292static wmem_tree_t *prefs_modules;
293
294/*
295 * List of all modules that should show up at the top level of the
296 * tree in the preference dialog box.
297 */
298static wmem_tree_t *prefs_top_level_modules;
299
300/*
301 * List of aliases for modules.
302 */
303static wmem_tree_t *prefs_module_aliases;
304
305/*
306 * Regex to match line terminators. Prefs are written and read to file line by
307 * line, so unescaped line terminators cause unexpected behavior.
308 */
309static GRegex *prefs_regex;
310
311/** Sets up memory used by proto routines. Called at program startup */
312void
313prefs_init(const char** col_fmt, int num_cols)
314{
315 memset(&prefs, 0, sizeof(prefs));
316 prefs_modules = wmem_tree_new(wmem_epan_scope());
317 prefs_top_level_modules = wmem_tree_new(wmem_epan_scope());
318 prefs_module_aliases = wmem_tree_new(wmem_epan_scope());
319 if (!prefs_regex)
320 prefs_regex = g_regex_new("\\s*\\R\\s*", (GRegexCompileFlags)G_REGEX_OPTIMIZE,
321 (GRegexMatchFlags)G_REGEX_MATCH_BSR_ANYCRLF, NULL((void*)0));
322
323 prefs_set_global_defaults(wmem_epan_scope(), col_fmt, num_cols);
324 prefs_register_modules();
325}
326
327const wmem_tree_t* prefs_get_module_tree(void)
328{
329 return prefs_modules;
330}
331
332/*
333 * Free the strings for a string-like preference.
334 */
335static void
336free_string_like_preference(pref_t *pref)
337{
338 wmem_free(pref->scope, *pref->varp.string);
339 *pref->varp.string = NULL((void*)0);
340 wmem_free(pref->scope, pref->default_val.string);
341 pref->default_val.string = NULL((void*)0);
342}
343
344void
345pref_free_individual(void *data, void *user_data _U___attribute__((unused)))
346{
347 pref_t *pref = (pref_t *)data;
348
349 switch (pref->type) {
350 case PREF_BOOL:
351 case PREF_ENUM:
352 case PREF_UINT:
353 case PREF_INT:
354 case PREF_FLOAT:
355 case PREF_STATIC_TEXT:
356 case PREF_UAT:
357 case PREF_COLOR:
358 break;
359 case PREF_STRING:
360 case PREF_SAVE_FILENAME:
361 case PREF_OPEN_FILENAME:
362 case PREF_DIRNAME:
363 case PREF_PASSWORD:
364 case PREF_DISSECTOR:
365 free_string_like_preference(pref);
366 break;
367 case PREF_RANGE:
368 case PREF_DECODE_AS_RANGE:
369 wmem_free(pref->scope, *pref->varp.range);
370 *pref->varp.range = NULL((void*)0);
371 wmem_free(pref->scope, pref->default_val.range);
372 pref->default_val.range = NULL((void*)0);
373 break;
374 case PREF_CUSTOM:
375 if (strcmp(pref->name, "columns") == 0)
376 pref->stashed_val.boolval = true1;
377 pref->custom_cbs.free_cb(pref);
378 break;
379 /* non-generic preferences */
380 case PREF_PROTO_TCP_SNDAMB_ENUM:
381 break;
382 }
383
384 wmem_free(pref->scope, pref);
385}
386
387static unsigned
388free_module_prefs(module_t *module, void *data _U___attribute__((unused)))
389{
390 if (module->prefs) {
391 g_list_foreach(module->prefs, pref_free_individual, NULL((void*)0));
392 g_list_free(module->prefs);
393 }
394 module->prefs = NULL((void*)0);
395 module->numprefs = 0;
396 if (module->submodules) {
397 prefs_module_list_foreach(module->submodules, free_module_prefs, NULL((void*)0), false0);
398 }
399 /* We don't free the actual module: its submodules pointer points to
400 a wmem_tree and the module itself is stored in a wmem_tree
401 */
402
403 return 0;
404}
405
406/** Frees memory used by proto routines. Called at program shutdown */
407void
408prefs_cleanup(void)
409{
410 /* This isn't strictly necessary since we're exiting anyway, but let's
411 * do what clean up we can.
412 */
413 prefs_module_list_foreach(prefs_modules, free_module_prefs, NULL((void*)0), false0);
414
415 /* Clean the uats */
416 uat_cleanup();
417
418 /*
419 * Unload any loaded MIBs.
420 */
421 oids_cleanup();
422
423 /* Shut down mmdbresolve */
424 maxmind_db_pref_cleanup();
425
426 g_free(prefs.saved_at_version)(__builtin_object_size ((prefs.saved_at_version), 0) != ((size_t
) - 1)) ? g_free_sized (prefs.saved_at_version, __builtin_object_size
((prefs.saved_at_version), 0)) : (g_free) (prefs.saved_at_version
)
;
427 g_free(gpf_path)(__builtin_object_size ((gpf_path), 0) != ((size_t) - 1)) ? g_free_sized
(gpf_path, __builtin_object_size ((gpf_path), 0)) : (g_free)
(gpf_path)
;
428 gpf_path = NULL((void*)0);
429 g_regex_unref(prefs_regex);
430 prefs_regex = NULL((void*)0);
431}
432
433static void
434prefs_deregister_module(wmem_tree_t* pref_tree, const char *name, const char *title, wmem_tree_t *all_modules)
435{
436 /* Remove this module from the list of all modules */
437 module_t *module = (module_t *)wmem_tree_remove_string(all_modules, name, WMEM_TREE_STRING_NOCASE0x00000001);
438
439 if (!module)
440 return;
441
442 wmem_tree_remove_string(pref_tree, title, WMEM_TREE_STRING_NOCASE0x00000001);
443 free_module_prefs(module, NULL((void*)0));
444 wmem_free(module->scope, module);
445}
446
447static void
448prefs_update_existing_subtree(module_t* module, const char* name, const char* description,
449 const char* help, void (*apply_cb)(void), wmem_tree_t* master_pref_tree)
450{
451 module->name = name;
452 module->apply_cb = apply_cb;
453 module->description = description;
454 module->help = help;
455
456 /* Registering it as a module (not just as a subtree) twice is an
457 * error in the code for the same reason as below. */
458 if (prefs_find_module(name) != NULL((void*)0)) {
459 ws_error("Preference module \"%s\" is being registered twice", name)ws_log_fatal_full("Epan", LOG_LEVEL_ERROR, "epan/prefs.c", 459
, __func__, "Preference module \"%s\" is being registered twice"
, name)
;
460 }
461 wmem_tree_insert_string(master_pref_tree, name, module,
462 WMEM_TREE_STRING_NOCASE0x00000001);
463}
464
465static module_t*
466prefs_create_module(wmem_allocator_t* scope, module_t* parent, const char* name,
467 const char* title, const char* description,
468 const char* help, void (*apply_cb)(void),
469 bool_Bool use_gui)
470{
471 module_t* module = wmem_new(scope, module_t)((module_t*)wmem_alloc((scope), sizeof(module_t)));
472 module->name = name;
473 module->title = title;
474 module->description = description;
475 module->help = help;
476 module->apply_cb = apply_cb;
477 module->scope = scope;
478 module->prefs = NULL((void*)0); /* no preferences, to start */
479 module->parent = parent;
480 module->submodules = NULL((void*)0); /* no submodules, to start */
481 module->numprefs = 0;
482 module->prefs_changed_flags = 0;
483 module->obsolete = false0;
484 module->use_gui = use_gui;
485 /* A module's preferences affects dissection unless otherwise told */
486 module->effect_flags = PREF_EFFECT_DISSECTION(1u << 0);
487
488 return module;
489}
490
491/*
492 * Register a module that will have preferences.
493 * Specify the module under which to register it, the name used for the
494 * module in the preferences file, the title used in the tab for it
495 * in a preferences dialog box, and a routine to call back when the
496 * preferences are applied.
497 */
498module_t*
499prefs_register_module(wmem_tree_t* pref_tree, wmem_tree_t* master_pref_tree, const char* name, const char* title,
500 const char* description, const char* help, void (*apply_cb)(void),
501 const bool_Bool use_gui)
502{
503 module_t* module;
504
505 /* this module may have been created as a subtree item previously */
506 if ((module = (module_t*)wmem_tree_lookup_string(pref_tree, title, WMEM_TREE_STRING_NOCASE0x00000001))) {
507 /* the module is currently a subtree */
508 prefs_update_existing_subtree(module, name, description, help, apply_cb, master_pref_tree);
509 return module;
510 }
511
512 module = prefs_create_module(wmem_tree_get_data_scope(master_pref_tree), NULL((void*)0), name, title, description, help, apply_cb, use_gui);
513
514 /* Accept any letter case to conform with protocol names. ASN1 protocols
515 * don't use lower case names, so we can't require lower case.
516 */
517 if (module_check_valid_name(name, false0) != '\0') {
518 ws_error("Preference module \"%s\" contains invalid characters", name)ws_log_fatal_full("Epan", LOG_LEVEL_ERROR, "epan/prefs.c", 518
, __func__, "Preference module \"%s\" contains invalid characters"
, name)
;
519 }
520
521 /*
522 * Make sure there's not already a module with that
523 * name. Crash if there is, as that's an error in the
524 * code, and the code has to be fixed not to register
525 * more than one module with the same name.
526 *
527 * We search the list of all modules; the subtree stuff
528 * doesn't require preferences in subtrees to have names
529 * that reflect the subtree they're in (that would require
530 * protocol preferences to have a bogus "protocol.", or
531 * something such as that, to be added to all their names).
532 */
533 if (wmem_tree_lookup_string(master_pref_tree, name, WMEM_TREE_STRING_NOCASE0x00000001) != NULL((void*)0))
534 ws_error("Preference module \"%s\" is being registered twice", name)ws_log_fatal_full("Epan", LOG_LEVEL_ERROR, "epan/prefs.c", 534
, __func__, "Preference module \"%s\" is being registered twice"
, name)
;
535
536 /*
537 * Insert this module in the list of all modules.
538 */
539 wmem_tree_insert_string(master_pref_tree, name, module, WMEM_TREE_STRING_NOCASE0x00000001);
540
541 /*
542 * It goes at the top.
543 */
544 wmem_tree_insert_string(pref_tree, title, module, WMEM_TREE_STRING_NOCASE0x00000001);
545
546 return module;
547}
548
549static module_t*
550prefs_register_submodule(module_t* parent, wmem_tree_t* master_pref_tree, const char* name, const char* title,
551 const char* description, const char* help, void (*apply_cb)(void),
552 const bool_Bool use_gui)
553{
554 module_t* module;
555
556 /* this module may have been created as a subtree item previously */
557 if ((module = (module_t*)wmem_tree_lookup_string(parent->submodules, title, WMEM_TREE_STRING_NOCASE0x00000001))) {
558 /* the module is currently a subtree */
559 prefs_update_existing_subtree(module, name, description, help, apply_cb, master_pref_tree);
560 return module;
561 }
562
563 module = prefs_create_module(wmem_tree_get_data_scope(master_pref_tree), parent, name, title, description, help, apply_cb, use_gui);
564
565 /* Accept any letter case to conform with protocol names. ASN1 protocols
566 * don't use lower case names, so we can't require lower case. */
567 if (module_check_valid_name(name, false0) != '\0') {
568 ws_error("Preference module \"%s\" contains invalid characters", name)ws_log_fatal_full("Epan", LOG_LEVEL_ERROR, "epan/prefs.c", 568
, __func__, "Preference module \"%s\" contains invalid characters"
, name)
;
569 }
570
571 /*
572 * Make sure there's not already a module with that
573 * name. Crash if there is, as that's an error in the
574 * code, and the code has to be fixed not to register
575 * more than one module with the same name.
576 *
577 * We search the list of all modules; the subtree stuff
578 * doesn't require preferences in subtrees to have names
579 * that reflect the subtree they're in (that would require
580 * protocol preferences to have a bogus "protocol.", or
581 * something such as that, to be added to all their names).
582 */
583 if (wmem_tree_lookup_string(master_pref_tree, name, WMEM_TREE_STRING_NOCASE0x00000001) != NULL((void*)0))
584 ws_error("Preference module \"%s\" is being registered twice", name)ws_log_fatal_full("Epan", LOG_LEVEL_ERROR, "epan/prefs.c", 584
, __func__, "Preference module \"%s\" is being registered twice"
, name)
;
585
586 /*
587 * Insert this module in the list of all modules.
588 */
589 wmem_tree_insert_string(master_pref_tree, name, module, WMEM_TREE_STRING_NOCASE0x00000001);
590
591 /*
592 * It goes into the list for this module.
593 */
594
595 if (parent->submodules == NULL((void*)0))
596 parent->submodules = wmem_tree_new(parent->scope);
597
598 wmem_tree_insert_string(parent->submodules, title, module, WMEM_TREE_STRING_NOCASE0x00000001);
599
600 return module;
601}
602
603/*
604 * Register a subtree that will have modules under it.
605 * Specify the module under which to register it or NULL to register it
606 * at the top level and the title used in the tab for it in a preferences
607 * dialog box.
608 */
609static module_t*
610prefs_register_subtree(module_t* parent, wmem_tree_t* master_pref_tree, const char* title, const char* description,
611 void (*apply_cb)(void))
612{
613 module_t* module;
614
615 /* this module may have been created as a subtree item previously */
616 if ((module = (module_t*)wmem_tree_lookup_string(parent->submodules, title, WMEM_TREE_STRING_NOCASE0x00000001))) {
617 /* the module is currently a subtree */
618 prefs_update_existing_subtree(module, NULL((void*)0), description, NULL((void*)0), apply_cb, master_pref_tree);
619 return module;
620 }
621
622 module = prefs_create_module(wmem_tree_get_data_scope(master_pref_tree), parent, NULL((void*)0), title, description, NULL((void*)0), apply_cb, parent->use_gui);
623
624
625 /*
626 * It goes into the list for this module.
627 */
628 if (parent->submodules == NULL((void*)0))
629 parent->submodules = wmem_tree_new(parent->scope);
630
631 wmem_tree_insert_string(parent->submodules, title, module, WMEM_TREE_STRING_NOCASE0x00000001);
632
633 return module;
634}
635
636void
637prefs_register_module_alias(const char *name, module_t *module)
638{
639 module_alias_t *alias;
640
641 /*
642 * Accept any name that can occur in protocol names. We allow upper-case
643 * letters, to handle the Diameter dissector having used "Diameter" rather
644 * than "diameter" as its preference module name in the past.
645 *
646 * Crash if the name is invalid, as that's an error in the code, but the name
647 * can be used on the command line, and shouldn't require quoting, etc.
648 */
649 if (module_check_valid_name(name, false0) != '\0') {
650 ws_error("Preference module alias \"%s\" contains invalid characters", name)ws_log_fatal_full("Epan", LOG_LEVEL_ERROR, "epan/prefs.c", 650
, __func__, "Preference module alias \"%s\" contains invalid characters"
, name)
;
651 }
652
653 /*
654 * Make sure there's not already an alias with that
655 * name. Crash if there is, as that's an error in the
656 * code, and the code has to be fixed not to register
657 * more than one alias with the same name.
658 *
659 * We search the list of all aliases.
660 */
661 if (prefs_find_module_alias(name) != NULL((void*)0))
662 ws_error("Preference module alias \"%s\" is being registered twice", name)ws_log_fatal_full("Epan", LOG_LEVEL_ERROR, "epan/prefs.c", 662
, __func__, "Preference module alias \"%s\" is being registered twice"
, name)
;
663
664 alias = wmem_new(wmem_tree_get_data_scope(prefs_module_aliases), module_alias_t)((module_alias_t*)wmem_alloc((wmem_tree_get_data_scope(prefs_module_aliases
)), sizeof(module_alias_t)))
;
665 alias->name = name;
666 alias->module = module;
667
668 /*
669 * Insert this module in the list of all modules.
670 */
671 wmem_tree_insert_string(prefs_module_aliases, name, alias, WMEM_TREE_STRING_NOCASE0x00000001);
672}
673
674/*
675 * Register that a protocol has preferences.
676 */
677static module_t *protocols_module;
678
679module_t *
680prefs_register_protocol(int id, void (*apply_cb)(void))
681{
682 protocol_t *protocol = find_protocol_by_id(id);
683 if (protocol == NULL((void*)0))
684 ws_error("Protocol preferences being registered with an invalid protocol ID")ws_log_fatal_full("Epan", LOG_LEVEL_ERROR, "epan/prefs.c", 684
, __func__, "Protocol preferences being registered with an invalid protocol ID"
)
;
685 return prefs_register_submodule(protocols_module, prefs_modules,
686 proto_get_protocol_filter_name(id),
687 proto_get_protocol_short_name(protocol),
688 proto_get_protocol_name(id), NULL((void*)0), apply_cb, true1);
689}
690
691void
692prefs_deregister_protocol (int id)
693{
694 protocol_t *protocol = find_protocol_by_id(id);
695 if (protocol == NULL((void*)0))
696 ws_error("Protocol preferences being de-registered with an invalid protocol ID")ws_log_fatal_full("Epan", LOG_LEVEL_ERROR, "epan/prefs.c", 696
, __func__, "Protocol preferences being de-registered with an invalid protocol ID"
)
;
697 prefs_deregister_module (protocols_module->submodules,
698 proto_get_protocol_filter_name(id),
699 proto_get_protocol_short_name(protocol),
700 prefs_modules);
701}
702
703module_t *
704prefs_register_protocol_subtree(const char *subtree, int id, void (*apply_cb)(void))
705{
706 protocol_t *protocol;
707 module_t *subtree_module;
708 module_t *new_module;
709 char *sep = NULL((void*)0), *ptr = NULL((void*)0), *orig = NULL((void*)0);
710
711 subtree_module = protocols_module;
712
713 if (subtree) {
714 /* take a copy of the buffer, orig keeps a base pointer while ptr
715 * walks through the string */
716 orig = ptr = wmem_strdup(subtree_module->scope, subtree);
717
718 while (ptr && *ptr) {
719
720 if ((sep = strchr(ptr, '/')))
721 *sep++ = '\0';
722
723 if (!(new_module = (module_t*)wmem_tree_lookup_string(subtree_module->submodules, ptr, WMEM_TREE_STRING_NOCASE0x00000001))) {
724 /*
725 * There's no such module; create it, with the description
726 * being the name (if it's later registered explicitly
727 * with a description, that will override it).
728 */
729 ptr = wmem_strdup(wmem_tree_get_data_scope(prefs_modules), ptr);
730 new_module = prefs_register_subtree(subtree_module, prefs_modules, ptr, ptr, NULL((void*)0));
731 }
732
733 subtree_module = new_module;
734 ptr = sep;
735
736 }
737
738 wmem_free(subtree_module->scope, orig);
739 }
740
741 protocol = find_protocol_by_id(id);
742 if (protocol == NULL((void*)0))
743 ws_error("Protocol subtree being registered with an invalid protocol ID")ws_log_fatal_full("Epan", LOG_LEVEL_ERROR, "epan/prefs.c", 743
, __func__, "Protocol subtree being registered with an invalid protocol ID"
)
;
744 return prefs_register_submodule(subtree_module, prefs_modules,
745 proto_get_protocol_filter_name(id),
746 proto_get_protocol_short_name(protocol),
747 proto_get_protocol_name(id), NULL((void*)0), apply_cb, true1);
748}
749
750
751/*
752 * Register that a protocol used to have preferences but no longer does,
753 * by creating an "obsolete" module for it.
754 */
755module_t *
756prefs_register_protocol_obsolete(int id)
757{
758 module_t *module;
759 protocol_t *protocol = find_protocol_by_id(id);
760 if (protocol == NULL((void*)0))
761 ws_error("Protocol being registered with an invalid protocol ID")ws_log_fatal_full("Epan", LOG_LEVEL_ERROR, "epan/prefs.c", 761
, __func__, "Protocol being registered with an invalid protocol ID"
)
;
762 module = prefs_register_submodule(protocols_module, prefs_modules,
763 proto_get_protocol_filter_name(id),
764 proto_get_protocol_short_name(protocol),
765 proto_get_protocol_name(id), NULL((void*)0), NULL((void*)0), true1);
766 module->obsolete = true1;
767 return module;
768}
769
770/*
771 * Register that a statistical tap has preferences.
772 *
773 * "name" is a name for the tap to use on the command line with "-o"
774 * and in preference files.
775 *
776 * "title" is a short human-readable name for the tap.
777 *
778 * "description" is a longer human-readable description of the tap.
779 */
780static module_t *stats_module;
781
782module_t *
783prefs_register_stat(const char *name, const char *title,
784 const char *description, void (*apply_cb)(void))
785{
786 return prefs_register_submodule(stats_module, prefs_modules, name, title, description, NULL((void*)0),
787 apply_cb, true1);
788}
789
790/*
791 * Register that a codec has preferences.
792 *
793 * "name" is a name for the codec to use on the command line with "-o"
794 * and in preference files.
795 *
796 * "title" is a short human-readable name for the codec.
797 *
798 * "description" is a longer human-readable description of the codec.
799 */
800static module_t *codecs_module;
801
802module_t *
803prefs_register_codec(const char *name, const char *title,
804 const char *description, void (*apply_cb)(void))
805{
806 return prefs_register_submodule(codecs_module, prefs_modules, name, title, description, NULL((void*)0),
807 apply_cb, true1);
808}
809
810module_t *
811prefs_find_module(const char *name)
812{
813 return (module_t *)wmem_tree_lookup_string(prefs_modules, name, WMEM_TREE_STRING_NOCASE0x00000001);
814}
815
816/*
817 * Call a callback function, with a specified argument, for each module
818 * in a list of modules. If the list is NULL, searches the top-level
819 * list in the display tree of modules. If any callback returns a
820 * non-zero value, we stop and return that value, otherwise we
821 * return 0.
822 *
823 * Normally "obsolete" modules are ignored; their sole purpose is to allow old
824 * preferences for dissectors that no longer have preferences to be
825 * silently ignored in preference files. Does not ignore subtrees,
826 * as this can be used when walking the display tree of modules.
827 */
828
829typedef struct {
830 module_cb callback;
831 void *user_data;
832 unsigned ret;
833 bool_Bool skip_obsolete;
834} call_foreach_t;
835
836static bool_Bool
837call_foreach_cb(const void *key _U___attribute__((unused)), void *value, void *data)
838{
839 module_t *module = (module_t*)value;
840 call_foreach_t *call_data = (call_foreach_t*)data;
841
842 if (!call_data->skip_obsolete || !module->obsolete)
843 call_data->ret = (*call_data->callback)(module, call_data->user_data);
844
845 return (call_data->ret != 0);
846}
847
848unsigned
849prefs_module_list_foreach(const wmem_tree_t *module_list, module_cb callback,
850 void *user_data, bool_Bool skip_obsolete)
851{
852 call_foreach_t call_data;
853
854 call_data.callback = callback;
855 call_data.user_data = user_data;
856 call_data.ret = 0;
857 call_data.skip_obsolete = skip_obsolete;
858 wmem_tree_foreach(module_list, call_foreach_cb, &call_data);
859 return call_data.ret;
860}
861
862/*
863 * Returns true if module has any submodules
864 */
865bool_Bool
866prefs_module_has_submodules(module_t *module)
867{
868 if (module->submodules == NULL((void*)0)) {
869 return false0;
870 }
871
872 if (wmem_tree_is_empty(module->submodules)) {
873 return false0;
874 }
875
876 return true1;
877}
878
879/*
880 * Call a callback function, with a specified argument, for each module
881 * in the list of all modules. (This list does not include subtrees.)
882 *
883 * Ignores "obsolete" modules; their sole purpose is to allow old
884 * preferences for dissectors that no longer have preferences to be
885 * silently ignored in preference files.
886 */
887unsigned
888prefs_modules_foreach(const wmem_tree_t* module, module_cb callback, void *user_data)
889{
890 return prefs_module_list_foreach(module, callback, user_data, true1);
891}
892
893/*
894 * Call a callback function, with a specified argument, for each submodule
895 * of specified modules. If the module is NULL, goes through the top-level
896 * list in the display tree of modules.
897 *
898 * Ignores "obsolete" modules; their sole purpose is to allow old
899 * preferences for dissectors that no longer have preferences to be
900 * silently ignored in preference files. Does not ignore subtrees,
901 * as this can be used when walking the display tree of modules.
902 */
903unsigned
904prefs_modules_foreach_submodules(const wmem_tree_t* module, module_cb callback,
905 void *user_data)
906{
907 return prefs_module_list_foreach(module, callback, user_data, true1);
908}
909
910unsigned prefs_modules_for_all_modules(module_cb callback, void* user_data)
911{
912 return prefs_module_list_foreach(prefs_top_level_modules, callback, user_data, true1);
913}
914
915static bool_Bool
916call_apply_cb(const void *key _U___attribute__((unused)), void *value, void *data _U___attribute__((unused)))
917{
918 module_t *module = (module_t *)value;
919
920 if (module->obsolete)
921 return false0;
922 if (module->prefs_changed_flags) {
923 if (module->apply_cb != NULL((void*)0))
924 (*module->apply_cb)();
925 module->prefs_changed_flags = 0;
926 }
927 if (module->submodules)
928 wmem_tree_foreach(module->submodules, call_apply_cb, NULL((void*)0));
929 return false0;
930}
931
932/*
933 * Call the "apply" callback function for each module if any of its
934 * preferences have changed, and then clear the flag saying its
935 * preferences have changed, as the module has been notified of that
936 * fact.
937 */
938void
939prefs_apply_all(void)
940{
941 wmem_tree_foreach(prefs_modules, call_apply_cb, NULL((void*)0));
942}
943
944/*
945 * Call the "apply" callback function for a specific module if any of
946 * its preferences have changed, and then clear the flag saying its
947 * preferences have changed, as the module has been notified of that
948 * fact.
949 */
950void
951prefs_apply(module_t *module)
952{
953 if (module && module->prefs_changed_flags)
954 call_apply_cb(NULL((void*)0), module, NULL((void*)0));
955}
956
957static module_t *
958prefs_find_module_alias(const char *name)
959{
960 module_alias_t *alias;
961
962 alias = (module_alias_t *)wmem_tree_lookup_string(prefs_module_aliases, name, WMEM_TREE_STRING_NOCASE0x00000001);
963 if (alias == NULL((void*)0))
964 return NULL((void*)0);
965 return alias->module;
966}
967
968/*
969 * Register a preference in a module's list of preferences.
970 * If it has a title, give it an ordinal number; otherwise, it's a
971 * preference that won't show up in the UI, so it shouldn't get an
972 * ordinal number (the ordinal should be the ordinal in the set of
973 * *visible* preferences).
974 */
975static pref_t *
976register_preference(module_t *module, const char *name, const char *title,
977 const char *description, pref_type_e type, bool_Bool obsolete)
978{
979 pref_t *preference;
980 const char *p;
981 const char *name_prefix = (module->name != NULL((void*)0)) ? module->name : module->parent->name;
982
983 preference = wmem_new(module->scope, pref_t)((pref_t*)wmem_alloc((module->scope), sizeof(pref_t)));
984 preference->name = name;
985 preference->title = title;
986 preference->scope = module->scope;
987 preference->description = description;
988 preference->type = type;
989 preference->obsolete = obsolete;
990 /* Default to module's preference effects */
991 preference->effect_flags = module->effect_flags;
992
993 if (title != NULL((void*)0))
994 preference->ordinal = module->numprefs;
995 else
996 preference->ordinal = -1; /* no ordinal for you */
997
998 /*
999 * Make sure that only lower-case ASCII letters, numbers,
1000 * underscores, and dots appear in the preference name.
1001 *
1002 * Crash if there is, as that's an error in the code;
1003 * you can make the title and description nice strings
1004 * with capitalization, white space, punctuation, etc.,
1005 * but the name can be used on the command line,
1006 * and shouldn't require quoting, shifting, etc.
1007 */
1008 for (p = name; *p != '\0'; p++)
1009 if (!(g_ascii_islower(*p)((g_ascii_table[(guchar) (*p)] & G_ASCII_LOWER) != 0) || g_ascii_isdigit(*p)((g_ascii_table[(guchar) (*p)] & G_ASCII_DIGIT) != 0) || *p == '_' || *p == '.'))
1010 ws_error("Preference \"%s.%s\" contains invalid characters", module->name, name)ws_log_fatal_full("Epan", LOG_LEVEL_ERROR, "epan/prefs.c", 1010
, __func__, "Preference \"%s.%s\" contains invalid characters"
, module->name, name)
;
1011
1012 /*
1013 * Make sure there's not already a preference with that
1014 * name. Crash if there is, as that's an error in the
1015 * code, and the code has to be fixed not to register
1016 * more than one preference with the same name.
1017 */
1018 if (prefs_find_preference(module, name) != NULL((void*)0))
1019 ws_error("Preference %s has already been registered", name)ws_log_fatal_full("Epan", LOG_LEVEL_ERROR, "epan/prefs.c", 1019
, __func__, "Preference %s has already been registered", name
)
;
1020
1021 if ((!preference->obsolete) &&
1022 /* Don't compare if it's a subtree */
1023 (module->name != NULL((void*)0))) {
1024 /*
1025 * Make sure the preference name doesn't begin with the
1026 * module name, as that's redundant and Just Silly.
1027 */
1028 if (!((strncmp(name, module->name, strlen(module->name)) != 0) ||
1029 (((name[strlen(module->name)]) != '.') && ((name[strlen(module->name)]) != '_'))))
1030 ws_error("Preference %s begins with the module name", name)ws_log_fatal_full("Epan", LOG_LEVEL_ERROR, "epan/prefs.c", 1030
, __func__, "Preference %s begins with the module name", name
)
;
1031 }
1032
1033 /* The title shows up in the preferences dialog. Make sure it's UI-friendly. */
1034 if (preference->title) {
1035 const char *cur_char;
1036 if (preference->type != PREF_STATIC_TEXT && g_utf8_strlen(preference->title, -1) > 80) { // Arbitrary.
1037 ws_error("Title for preference %s.%s is too long: %s", name_prefix, preference->name, preference->title)ws_log_fatal_full("Epan", LOG_LEVEL_ERROR, "epan/prefs.c", 1037
, __func__, "Title for preference %s.%s is too long: %s", name_prefix
, preference->name, preference->title)
;
1038 }
1039
1040 if (!g_utf8_validate(preference->title, -1, NULL((void*)0))) {
1041 ws_error("Title for preference %s.%s isn't valid UTF-8.", name_prefix, preference->name)ws_log_fatal_full("Epan", LOG_LEVEL_ERROR, "epan/prefs.c", 1041
, __func__, "Title for preference %s.%s isn't valid UTF-8.", name_prefix
, preference->name)
;
1042 }
1043
1044 for (cur_char = preference->title; *cur_char; cur_char = g_utf8_next_char(cur_char)((cur_char) + g_utf8_skip[*(const guchar *)(cur_char)])) {
1045 if (!g_unichar_isprint(g_utf8_get_char(cur_char))) {
1046 ws_error("Title for preference %s.%s isn't printable UTF-8.", name_prefix, preference->name)ws_log_fatal_full("Epan", LOG_LEVEL_ERROR, "epan/prefs.c", 1046
, __func__, "Title for preference %s.%s isn't printable UTF-8."
, name_prefix, preference->name)
;
1047 }
1048 }
1049 }
1050
1051 if (preference->description) {
1052 if (!g_utf8_validate(preference->description, -1, NULL((void*)0))) {
1053 ws_error("Description for preference %s.%s isn't valid UTF-8.", name_prefix, preference->name)ws_log_fatal_full("Epan", LOG_LEVEL_ERROR, "epan/prefs.c", 1053
, __func__, "Description for preference %s.%s isn't valid UTF-8."
, name_prefix, preference->name)
;
1054 }
1055 }
1056
1057 /*
1058 * We passed all of our checks. Add the preference.
1059 */
1060 module->prefs = g_list_append(module->prefs, preference);
1061 if (title != NULL((void*)0))
1062 module->numprefs++;
1063
1064 return preference;
1065}
1066
1067/*
1068 * Find a preference in a module's list of preferences, given the module
1069 * and the preference's name.
1070 */
1071typedef struct {
1072 GList *list_entry;
1073 const char *name;
1074 module_t *submodule;
1075} find_pref_arg_t;
1076
1077static int
1078preference_match(const void *a, const void *b)
1079{
1080 const pref_t *pref = (const pref_t *)a;
1081 const char *name = (const char *)b;
1082
1083 return strcmp(name, pref->name);
1084}
1085
1086static bool_Bool
1087module_find_pref_cb(const void *key _U___attribute__((unused)), void *value, void *data)
1088{
1089 find_pref_arg_t* arg = (find_pref_arg_t*)data;
1090 GList *list_entry;
1091 module_t *module = (module_t *)value;
1092
1093 if (module == NULL((void*)0))
1094 return false0;
1095
1096 list_entry = g_list_find_custom(module->prefs, arg->name,
1097 preference_match);
1098
1099 if (list_entry == NULL((void*)0))
1100 return false0;
1101
1102 arg->list_entry = list_entry;
1103 arg->submodule = module;
1104 return true1;
1105}
1106
1107/* Tries to find a preference, setting containing_module to the (sub)module
1108 * holding this preference. */
1109static pref_t *
1110prefs_find_preference_with_submodule(module_t *module, const char *name,
1111 module_t **containing_module)
1112{
1113 find_pref_arg_t arg;
1114 GList *list_entry;
1115
1116 if (module == NULL((void*)0))
1117 return NULL((void*)0); /* invalid parameters */
1118
1119 list_entry = g_list_find_custom(module->prefs, name,
1120 preference_match);
1121 arg.submodule = NULL((void*)0);
1122
1123 if (list_entry == NULL((void*)0))
1124 {
1125 arg.list_entry = NULL((void*)0);
1126 if (module->submodules != NULL((void*)0))
1127 {
1128 arg.name = name;
1129 wmem_tree_foreach(module->submodules, module_find_pref_cb, &arg);
1130 }
1131
1132 list_entry = arg.list_entry;
1133 }
1134
1135 if (list_entry == NULL((void*)0))
1136 return NULL((void*)0); /* no such preference */
1137
1138 if (containing_module)
1139 *containing_module = arg.submodule ? arg.submodule : module;
1140
1141 return (pref_t *) list_entry->data;
1142}
1143
1144pref_t *
1145prefs_find_preference(module_t *module, const char *name)
1146{
1147 return prefs_find_preference_with_submodule(module, name, NULL((void*)0));
1148}
1149
1150/*
1151 * Returns true if the given protocol has registered preferences
1152 */
1153bool_Bool
1154prefs_is_registered_protocol(const char *name)
1155{
1156 module_t *m = prefs_find_module(name);
1157
1158 return (m != NULL((void*)0) && !m->obsolete);
1159}
1160
1161/*
1162 * Returns the module title of a registered protocol
1163 */
1164const char *
1165prefs_get_title_by_name(const char *name)
1166{
1167 module_t *m = prefs_find_module(name);
1168
1169 return (m != NULL((void*)0) && !m->obsolete) ? m->title : NULL((void*)0);
1170}
1171
1172/*
1173 * Register a preference with an unsigned integral value.
1174 */
1175void
1176prefs_register_uint_preference(module_t *module, const char *name,
1177 const char *title, const char *description,
1178 unsigned base, unsigned *var)
1179{
1180 pref_t *preference;
1181
1182 preference = register_preference(module, name, title, description,
1183 PREF_UINT, false0);
1184 preference->varp.uint = var;
1185 preference->default_val.uint = *var;
1186 ws_assert(base > 0 && base != 1 && base < 37)do { if ((1) && !(base > 0 && base != 1 &&
base < 37)) ws_log_fatal_full("Epan", LOG_LEVEL_ERROR, "epan/prefs.c"
, 1186, __func__, "assertion failed: %s", "base > 0 && base != 1 && base < 37"
); } while (0)
;
1187 preference->info.base = base;
1188}
1189
1190/*
1191 * XXX Add a prefs_register_{uint16|port}_preference which sets max_value?
1192 */
1193
1194
1195/*
1196 * Register a preference with an integer value.
1197 */
1198void
1199prefs_register_int_preference(module_t* module, const char* name,
1200 const char* title, const char* description, int* var)
1201{
1202 pref_t* preference;
1203
1204 preference = register_preference(module, name, title, description,
1205 PREF_INT, false0);
1206 preference->varp.intp = var;
1207 preference->default_val.intval = *var;
1208}
1209
1210/*
1211 * Register a preference with a float (double) value.
1212 */
1213void prefs_register_float_preference(module_t* module, const char* name,
1214 const char* title, const char* description, unsigned num_decimal, double* var)
1215{
1216 pref_t* preference;
1217
1218 preference = register_preference(module, name, title, description,
1219 PREF_FLOAT, false0);
1220 preference->varp.floatp = var;
1221 preference->default_val.floatval = *var;
1222 ws_assert(num_decimal <= 10)do { if ((1) && !(num_decimal <= 10)) ws_log_fatal_full
("Epan", LOG_LEVEL_ERROR, "epan/prefs.c", 1222, __func__, "assertion failed: %s"
, "num_decimal <= 10"); } while (0)
;
1223 preference->info.base = num_decimal;
1224}
1225
1226/*
1227 * Register a "custom" preference with a unsigned integral value.
1228 * XXX - This should be temporary until we can find a better way
1229 * to do "custom" preferences
1230 */
1231static void
1232prefs_register_uint_custom_preference(module_t *module, const char *name,
1233 const char *title, const char *description,
1234 struct pref_custom_cbs* custom_cbs, unsigned *var)
1235{
1236 pref_t *preference;
1237
1238 preference = register_preference(module, name, title, description,
1239 PREF_CUSTOM, false0);
1240
1241 preference->custom_cbs = *custom_cbs;
1242 preference->varp.uint = var;
1243 preference->default_val.uint = *var;
1244}
1245
1246/*
1247 * Register a preference with an Boolean value.
1248 */
1249void
1250prefs_register_bool_preference(module_t *module, const char *name,
1251 const char *title, const char *description,
1252 bool_Bool *var)
1253{
1254 pref_t *preference;
1255
1256 preference = register_preference(module, name, title, description,
1257 PREF_BOOL, false0);
1258 preference->varp.boolp = var;
1259 preference->default_val.boolval = *var;
1260}
1261
1262unsigned int prefs_set_bool_value(pref_t *pref, bool_Bool value, pref_source_t source)
1263{
1264 unsigned int changed = 0;
1265
1266 switch (source)
1267 {
1268 case pref_default:
1269 if (pref->default_val.boolval != value) {
1270 pref->default_val.boolval = value;
1271 changed = prefs_get_effect_flags(pref);
1272 }
1273 break;
1274 case pref_stashed:
1275 if (pref->stashed_val.boolval != value) {
1276 pref->stashed_val.boolval = value;
1277 changed = prefs_get_effect_flags(pref);
1278 }
1279 break;
1280 case pref_current:
1281 if (*pref->varp.boolp != value) {
1282 *pref->varp.boolp = value;
1283 changed = prefs_get_effect_flags(pref);
1284 }
1285 break;
1286 default:
1287 ws_assert_not_reached()ws_log_fatal_full("Epan", LOG_LEVEL_ERROR, "epan/prefs.c", 1287
, __func__, "assertion \"not reached\" failed")
;
1288 break;
1289 }
1290
1291 return changed;
1292}
1293
1294void prefs_invert_bool_value(pref_t *pref, pref_source_t source)
1295{
1296 switch (source)
1297 {
1298 case pref_default:
1299 pref->default_val.boolval = !pref->default_val.boolval;
1300 break;
1301 case pref_stashed:
1302 pref->stashed_val.boolval = !pref->stashed_val.boolval;
1303 break;
1304 case pref_current:
1305 *pref->varp.boolp = !(*pref->varp.boolp);
1306 break;
1307 default:
1308 ws_assert_not_reached()ws_log_fatal_full("Epan", LOG_LEVEL_ERROR, "epan/prefs.c", 1308
, __func__, "assertion \"not reached\" failed")
;
1309 break;
1310 }
1311}
1312
1313bool_Bool prefs_get_bool_value(pref_t *pref, pref_source_t source)
1314{
1315 switch (source)
1316 {
1317 case pref_default:
1318 return pref->default_val.boolval;
1319 case pref_stashed:
1320 return pref->stashed_val.boolval;
1321 case pref_current:
1322 return *pref->varp.boolp;
1323 default:
1324 ws_assert_not_reached()ws_log_fatal_full("Epan", LOG_LEVEL_ERROR, "epan/prefs.c", 1324
, __func__, "assertion \"not reached\" failed")
;
1325 break;
1326 }
1327
1328 return false0;
1329}
1330
1331/*
1332 * Register a preference with an enumerated value.
1333 */
1334/*
1335 * XXX Should we get rid of the radio_buttons parameter and make that
1336 * behavior automatic depending on the number of items?
1337 */
1338void
1339prefs_register_enum_preference(module_t *module, const char *name,
1340 const char *title, const char *description,
1341 int *var, const enum_val_t *enumvals,
1342 bool_Bool radio_buttons)
1343{
1344 pref_t *preference;
1345
1346 /* Validate that the "name one would use on the command line for the value"
1347 * doesn't require quoting, etc. It's all treated case-insensitively so we
1348 * don't care about upper vs lower case.
1349 */
1350 for (size_t i = 0; enumvals[i].name != NULL((void*)0); i++) {
1351 for (const char *p = enumvals[i].name; *p != '\0'; p++)
1352 if (!(g_ascii_isalnum(*p)((g_ascii_table[(guchar) (*p)] & G_ASCII_ALNUM) != 0) || *p == '_' || *p == '.' || *p == '-'))
1353 ws_error("Preference \"%s.%s\" enum value name \"%s\" contains invalid characters",ws_log_fatal_full("Epan", LOG_LEVEL_ERROR, "epan/prefs.c", 1354
, __func__, "Preference \"%s.%s\" enum value name \"%s\" contains invalid characters"
, module->name, name, enumvals[i].name)
1354 module->name, name, enumvals[i].name)ws_log_fatal_full("Epan", LOG_LEVEL_ERROR, "epan/prefs.c", 1354
, __func__, "Preference \"%s.%s\" enum value name \"%s\" contains invalid characters"
, module->name, name, enumvals[i].name)
;
1355 }
1356
1357
1358 preference = register_preference(module, name, title, description,
1359 PREF_ENUM, false0);
1360 preference->varp.enump = var;
1361 preference->default_val.enumval = *var;
1362 preference->info.enum_info.enumvals = enumvals;
1363 preference->info.enum_info.radio_buttons = radio_buttons;
1364}
1365
1366unsigned int prefs_set_enum_value(pref_t *pref, int value, pref_source_t source)
1367{
1368 unsigned int changed = 0;
1369
1370 switch (source)
1371 {
1372 case pref_default:
1373 if (pref->default_val.enumval != value) {
1374 pref->default_val.enumval = value;
1375 changed = prefs_get_effect_flags(pref);
1376 }
1377 break;
1378 case pref_stashed:
1379 if (pref->stashed_val.enumval != value) {
1380 pref->stashed_val.enumval = value;
1381 changed = prefs_get_effect_flags(pref);
1382 }
1383 break;
1384 case pref_current:
1385 if (*pref->varp.enump != value) {
1386 *pref->varp.enump = value;
1387 changed = prefs_get_effect_flags(pref);
1388 }
1389 break;
1390 default:
1391 ws_assert_not_reached()ws_log_fatal_full("Epan", LOG_LEVEL_ERROR, "epan/prefs.c", 1391
, __func__, "assertion \"not reached\" failed")
;
1392 break;
1393 }
1394
1395 return changed;
1396}
1397
1398unsigned int prefs_set_enum_string_value(pref_t *pref, const char *value, pref_source_t source)
1399{
1400 int enum_val = find_val_for_string(value, pref->info.enum_info.enumvals, *pref->varp.enump);
1401
1402 return prefs_set_enum_value(pref, enum_val, source);
1403}
1404
1405int prefs_get_enum_value(pref_t *pref, pref_source_t source)
1406{
1407 switch (source)
1408 {
1409 case pref_default:
1410 return pref->default_val.enumval;
1411 case pref_stashed:
1412 return pref->stashed_val.enumval;
1413 case pref_current:
1414 return *pref->varp.enump;
1415 default:
1416 ws_assert_not_reached()ws_log_fatal_full("Epan", LOG_LEVEL_ERROR, "epan/prefs.c", 1416
, __func__, "assertion \"not reached\" failed")
;
1417 break;
1418 }
1419
1420 return 0;
1421}
1422
1423const enum_val_t* prefs_get_enumvals(pref_t *pref)
1424{
1425 return pref->info.enum_info.enumvals;
1426}
1427
1428bool_Bool prefs_get_enum_radiobuttons(pref_t *pref)
1429{
1430 return pref->info.enum_info.radio_buttons;
1431}
1432
1433/*
1434 * For use by UI code that sets preferences.
1435 */
1436unsigned int
1437prefs_set_custom_value(pref_t *pref, const char *value, pref_source_t source _U___attribute__((unused)))
1438{
1439 /* XXX - support pref source for custom preferences */
1440 unsigned int changed = 0;
1441 pref->custom_cbs.set_cb(pref, value, &changed);
1442 return changed;
1443}
1444
1445static void
1446register_string_like_preference(module_t *module, const char *name,
1447 const char *title, const char *description,
1448 char **var, pref_type_e type,
1449 struct pref_custom_cbs* custom_cbs,
1450 bool_Bool free_tmp)
1451{
1452 pref_t *pref;
1453 char *tmp;
1454
1455 pref = register_preference(module, name, title, description, type, false0);
1456
1457 /*
1458 * String preference values should be non-null (as you can't
1459 * keep them null after using the preferences GUI, you can at best
1460 * have them be null strings) and freeable (as we free them
1461 * if we change them).
1462 *
1463 * If the value is a null pointer, make it a copy of a null
1464 * string, otherwise make it a copy of the value.
1465 */
1466 tmp = *var;
1467 if (*var == NULL((void*)0)) {
1468 *var = wmem_strdup(pref->scope, "");
1469 } else {
1470 *var = wmem_strdup(pref->scope, *var);
1471 }
1472 if (free_tmp) {
1473 wmem_free(pref->scope, tmp);
1474 }
1475 pref->varp.string = var;
1476 pref->default_val.string = wmem_strdup(pref->scope, *var);
1477 pref->stashed_val.string = NULL((void*)0);
1478 if (type == PREF_CUSTOM) {
1479 ws_assert(custom_cbs)do { if ((1) && !(custom_cbs)) ws_log_fatal_full("Epan"
, LOG_LEVEL_ERROR, "epan/prefs.c", 1479, __func__, "assertion failed: %s"
, "custom_cbs"); } while (0)
;
1480 pref->custom_cbs = *custom_cbs;
1481 }
1482}
1483
1484/*
1485 * Assign to a string preference.
1486 */
1487static void
1488pref_set_string_like_pref_value(pref_t *pref, const char *value)
1489{
1490 wmem_free(pref->scope, *pref->varp.string);
1491 *pref->varp.string = wmem_strdup(pref->scope, value);
1492}
1493
1494/*
1495 * For use by UI code that sets preferences.
1496 */
1497unsigned int
1498prefs_set_string_value(pref_t *pref, const char* value, pref_source_t source)
1499{
1500 unsigned int changed = 0;
1501
1502 switch (source)
1503 {
1504 case pref_default:
1505 if (*pref->default_val.string) {
1506 if (strcmp(pref->default_val.string, value) != 0) {
1507 changed = prefs_get_effect_flags(pref);
1508 wmem_free(pref->scope, pref->default_val.string);
1509 pref->default_val.string = wmem_strdup(pref->scope, value);
1510 }
1511 } else if (value) {
1512 pref->default_val.string = wmem_strdup(pref->scope, value);
1513 }
1514 break;
1515 case pref_stashed:
1516 if (pref->stashed_val.string) {
1517 if (strcmp(pref->stashed_val.string, value) != 0) {
1518 changed = prefs_get_effect_flags(pref);
1519 wmem_free(pref->scope, pref->stashed_val.string);
1520 pref->stashed_val.string = wmem_strdup(pref->scope, value);
1521 }
1522 } else if (value) {
1523 pref->stashed_val.string = wmem_strdup(pref->scope, value);
1524 }
1525 break;
1526 case pref_current:
1527 if (*pref->varp.string) {
1528 if (strcmp(*pref->varp.string, value) != 0) {
1529 changed = prefs_get_effect_flags(pref);
1530 pref_set_string_like_pref_value(pref, value);
1531 }
1532 } else if (value) {
1533 pref_set_string_like_pref_value(pref, value);
1534 }
1535 break;
1536 default:
1537 ws_assert_not_reached()ws_log_fatal_full("Epan", LOG_LEVEL_ERROR, "epan/prefs.c", 1537
, __func__, "assertion \"not reached\" failed")
;
1538 break;
1539 }
1540
1541 return changed;
1542}
1543
1544const char *prefs_get_string_value(pref_t *pref, pref_source_t source)
1545{
1546 switch (source)
1547 {
1548 case pref_default:
1549 return pref->default_val.string;
1550 case pref_stashed:
1551 return pref->stashed_val.string;
1552 case pref_current:
1553 return *pref->varp.string;
1554 default:
1555 ws_assert_not_reached()ws_log_fatal_full("Epan", LOG_LEVEL_ERROR, "epan/prefs.c", 1555
, __func__, "assertion \"not reached\" failed")
;
1556 break;
1557 }
1558
1559 return NULL((void*)0);
1560}
1561
1562/*
1563 * Reset the value of a string-like preference.
1564 */
1565static void
1566reset_string_like_preference(pref_t *pref)
1567{
1568 wmem_free(pref->scope, *pref->varp.string);
1569 *pref->varp.string = wmem_strdup(pref->scope, pref->default_val.string);
1570}
1571
1572/*
1573 * Register a preference with a character-string value.
1574 */
1575void
1576prefs_register_string_preference(module_t *module, const char *name,
1577 const char *title, const char *description,
1578 const char **var)
1579{
1580DIAG_OFF(cast-qual)clang diagnostic push clang diagnostic ignored "-Wcast-qual"
1581 register_string_like_preference(module, name, title, description,
1582 (char **)var, PREF_STRING, NULL((void*)0), false0);
1583DIAG_ON(cast-qual)clang diagnostic pop
1584}
1585
1586/*
1587 * Register a preference with a file name (string) value.
1588 */
1589void
1590prefs_register_filename_preference(module_t *module, const char *name,
1591 const char *title, const char *description,
1592 const char **var, bool_Bool for_writing)
1593{
1594DIAG_OFF(cast-qual)clang diagnostic push clang diagnostic ignored "-Wcast-qual"
1595 register_string_like_preference(module, name, title, description, (char **)var,
1596 for_writing ? PREF_SAVE_FILENAME : PREF_OPEN_FILENAME, NULL((void*)0), false0);
1597DIAG_ON(cast-qual)clang diagnostic pop
1598}
1599
1600/*
1601 * Register a preference with a directory name (string) value.
1602 */
1603void
1604prefs_register_directory_preference(module_t *module, const char *name,
1605 const char *title, const char *description,
1606 const char **var)
1607{
1608DIAG_OFF(cast-qual)clang diagnostic push clang diagnostic ignored "-Wcast-qual"
1609 register_string_like_preference(module, name, title, description,
1610 (char **)var, PREF_DIRNAME, NULL((void*)0), false0);
1611DIAG_ON(cast-qual)clang diagnostic pop
1612}
1613
1614/* Refactoring to handle both PREF_RANGE and PREF_DECODE_AS_RANGE */
1615static pref_t*
1616prefs_register_range_preference_common(module_t *module, const char *name,
1617 const char *title, const char *description,
1618 range_t **var, uint32_t max_value, pref_type_e type)
1619{
1620 pref_t *preference;
1621
1622 preference = register_preference(module, name, title, description, type, false0);
1623 preference->info.max_value = max_value;
1624
1625 /*
1626 * Range preference values should be non-null (as you can't
1627 * keep them null after using the preferences GUI, you can at best
1628 * have them be empty ranges) and freeable (as we free them
1629 * if we change them).
1630 *
1631 * If the value is a null pointer, make it an empty range.
1632 */
1633 if (*var == NULL((void*)0))
1634 *var = range_empty(preference->scope);
1635 preference->varp.range = var;
1636 preference->default_val.range = range_copy(preference->scope, *var);
1637 preference->stashed_val.range = NULL((void*)0);
1638
1639 return preference;
1640}
1641
1642/*
1643 * Register a preference with a ranged value.
1644 */
1645void
1646prefs_register_range_preference(module_t *module, const char *name,
1647 const char *title, const char *description,
1648 range_t **var, uint32_t max_value)
1649{
1650 prefs_register_range_preference_common(module, name, title,
1651 description, var, max_value, PREF_RANGE);
1652}
1653
1654bool_Bool
1655prefs_set_range_value_work(pref_t *pref, const char *value,
1656 bool_Bool return_range_errors, unsigned int *changed_flags)
1657{
1658 range_t *newrange;
1659
1660 if (range_convert_str_work(pref->scope, &newrange, value, pref->info.max_value,
1661 return_range_errors) != CVT_NO_ERROR) {
1662 return false0; /* number was bad */
1663 }
1664
1665 if (!ranges_are_equal(*pref->varp.range, newrange)) {
1666 *changed_flags |= prefs_get_effect_flags(pref);
1667 wmem_free(pref->scope, *pref->varp.range);
1668 *pref->varp.range = newrange;
1669 } else {
1670 wmem_free(pref->scope, newrange);
1671 }
1672 return true1;
1673}
1674
1675/*
1676 * For use by UI code that sets preferences.
1677 */
1678unsigned int
1679prefs_set_stashed_range_value(pref_t *pref, const char *value)
1680{
1681 range_t *newrange;
1682
1683 if (range_convert_str_work(pref->scope, &newrange, value, pref->info.max_value,
1684 true1) != CVT_NO_ERROR) {
1685 return 0; /* number was bad */
1686 }
1687
1688 if (!ranges_are_equal(pref->stashed_val.range, newrange)) {
1689 wmem_free(pref->scope, pref->stashed_val.range);
1690 pref->stashed_val.range = newrange;
1691 } else {
1692 wmem_free(pref->scope, newrange);
1693 }
1694 return prefs_get_effect_flags(pref);
1695
1696}
1697
1698bool_Bool prefs_add_list_value(pref_t *pref, void* value, pref_source_t source)
1699{
1700 switch (source)
1701 {
1702 case pref_default:
1703 pref->default_val.list = g_list_prepend(pref->default_val.list, value);
1704 break;
1705 case pref_stashed:
1706 pref->stashed_val.list = g_list_prepend(pref->stashed_val.list, value);
1707 break;
1708 case pref_current:
1709 *pref->varp.list = g_list_prepend(*pref->varp.list, value);
1710 break;
1711 default:
1712 ws_assert_not_reached()ws_log_fatal_full("Epan", LOG_LEVEL_ERROR, "epan/prefs.c", 1712
, __func__, "assertion \"not reached\" failed")
;
1713 break;
1714 }
1715
1716 return true1;
1717}
1718
1719GList* prefs_get_list_value(pref_t *pref, pref_source_t source)
1720{
1721 switch (source)
1722 {
1723 case pref_default:
1724 return pref->default_val.list;
1725 case pref_stashed:
1726 return pref->stashed_val.list;
1727 case pref_current:
1728 return *pref->varp.list;
1729 default:
1730 ws_assert_not_reached()ws_log_fatal_full("Epan", LOG_LEVEL_ERROR, "epan/prefs.c", 1730
, __func__, "assertion \"not reached\" failed")
;
1731 break;
1732 }
1733
1734 return NULL((void*)0);
1735}
1736
1737bool_Bool prefs_set_range_value(pref_t *pref, range_t *value, pref_source_t source)
1738{
1739 bool_Bool changed = false0;
1740
1741 switch (source)
1742 {
1743 case pref_default:
1744 if (!ranges_are_equal(pref->default_val.range, value)) {
1745 wmem_free(pref->scope, pref->default_val.range);
1746 pref->default_val.range = range_copy(pref->scope, value);
1747 changed = true1;
1748 }
1749 break;
1750 case pref_stashed:
1751 if (!ranges_are_equal(pref->stashed_val.range, value)) {
1752 wmem_free(pref->scope, pref->stashed_val.range);
1753 pref->stashed_val.range = range_copy(pref->scope, value);
1754 changed = true1;
1755 }
1756 break;
1757 case pref_current:
1758 if (!ranges_are_equal(*pref->varp.range, value)) {
1759 wmem_free(pref->scope, *pref->varp.range);
1760 *pref->varp.range = range_copy(pref->scope, value);
1761 changed = true1;
1762 }
1763 break;
1764 default:
1765 ws_assert_not_reached()ws_log_fatal_full("Epan", LOG_LEVEL_ERROR, "epan/prefs.c", 1765
, __func__, "assertion \"not reached\" failed")
;
1766 break;
1767 }
1768
1769 return changed;
1770}
1771
1772range_t* prefs_get_range_value_real(pref_t *pref, pref_source_t source)
1773{
1774 switch (source)
1775 {
1776 case pref_default:
1777 return pref->default_val.range;
1778 case pref_stashed:
1779 return pref->stashed_val.range;
1780 case pref_current:
1781 return *pref->varp.range;
1782 default:
1783 ws_assert_not_reached()ws_log_fatal_full("Epan", LOG_LEVEL_ERROR, "epan/prefs.c", 1783
, __func__, "assertion \"not reached\" failed")
;
1784 break;
1785 }
1786
1787 return NULL((void*)0);
1788}
1789
1790range_t* prefs_get_range_value(const char *module_name, const char* pref_name)
1791{
1792 pref_t *pref = prefs_find_preference(prefs_find_module(module_name), pref_name);
1793 if (pref == NULL((void*)0)) {
1794 return NULL((void*)0);
1795 }
1796 return prefs_get_range_value_real(pref, pref_current);
1797}
1798
1799void
1800prefs_range_add_value(pref_t *pref, uint32_t val)
1801{
1802 range_add_value(pref->scope, pref->varp.range, val);
1803}
1804
1805void
1806prefs_range_remove_value(pref_t *pref, uint32_t val)
1807{
1808 range_remove_value(pref->scope, pref->varp.range, val);
1809}
1810
1811/*
1812 * Register a static text 'preference'. It can be used to add explanatory
1813 * text inline with other preferences in the GUI.
1814 * Note: Static preferences are not saved to the preferences file.
1815 */
1816void
1817prefs_register_static_text_preference(module_t *module, const char *name,
1818 const char *title,
1819 const char *description)
1820{
1821 register_preference(module, name, title, description, PREF_STATIC_TEXT, false0);
1822}
1823
1824/*
1825 * Register a uat 'preference'. It adds a button that opens the uat's window in the
1826 * preferences tab of the module.
1827 */
1828extern void
1829prefs_register_uat_preference(module_t *module, const char *name,
1830 const char *title, const char *description,
1831 uat_t* uat)
1832{
1833 pref_t* preference = register_preference(module, name, title, description, PREF_UAT, false0);
1834
1835 preference->varp.uat = uat;
1836}
1837
1838struct epan_uat* prefs_get_uat_value(pref_t *pref)
1839{
1840 return pref->varp.uat;
1841}
1842
1843/*
1844 * Register a color preference.
1845 */
1846void
1847prefs_register_color_preference(module_t *module, const char *name,
1848 const char *title, const char *description,
1849 color_t *color)
1850{
1851 pref_t* preference = register_preference(module, name, title, description, PREF_COLOR, false0);
1852
1853 preference->varp.colorp = color;
1854 preference->default_val.color = *color;
1855}
1856
1857bool_Bool prefs_set_color_value(pref_t *pref, color_t value, pref_source_t source)
1858{
1859 bool_Bool changed = false0;
1860
1861 switch (source)
1862 {
1863 case pref_default:
1864 if ((pref->default_val.color.red != value.red) ||
1865 (pref->default_val.color.green != value.green) ||
1866 (pref->default_val.color.blue != value.blue)) {
1867 changed = true1;
1868 pref->default_val.color = value;
1869 }
1870 break;
1871 case pref_stashed:
1872 if ((pref->stashed_val.color.red != value.red) ||
1873 (pref->stashed_val.color.green != value.green) ||
1874 (pref->stashed_val.color.blue != value.blue)) {
1875 changed = true1;
1876 pref->stashed_val.color = value;
1877 }
1878 break;
1879 case pref_current:
1880 if ((pref->varp.colorp->red != value.red) ||
1881 (pref->varp.colorp->green != value.green) ||
1882 (pref->varp.colorp->blue != value.blue)) {
1883 changed = true1;
1884 *pref->varp.colorp = value;
1885 }
1886 break;
1887 default:
1888 ws_assert_not_reached()ws_log_fatal_full("Epan", LOG_LEVEL_ERROR, "epan/prefs.c", 1888
, __func__, "assertion \"not reached\" failed")
;
1889 break;
1890 }
1891
1892 return changed;
1893}
1894
1895color_t* prefs_get_color_value(pref_t *pref, pref_source_t source)
1896{
1897 switch (source)
1898 {
1899 case pref_default:
1900 return &pref->default_val.color;
1901 case pref_stashed:
1902 return &pref->stashed_val.color;
1903 case pref_current:
1904 return pref->varp.colorp;
1905 default:
1906 ws_assert_not_reached()ws_log_fatal_full("Epan", LOG_LEVEL_ERROR, "epan/prefs.c", 1906
, __func__, "assertion \"not reached\" failed")
;
1907 break;
1908 }
1909
1910 return NULL((void*)0);
1911}
1912
1913/*
1914 * Register a "custom" preference with a list.
1915 * XXX - This should be temporary until we can find a better way
1916 * to do "custom" preferences
1917 */
1918typedef void (*pref_custom_list_init_cb) (pref_t* pref, GList** value);
1919
1920static void
1921prefs_register_list_custom_preference(module_t *module, const char *name,
1922 const char *title, const char *description,
1923 struct pref_custom_cbs* custom_cbs,
1924 pref_custom_list_init_cb init_cb,
1925 GList** list)
1926{
1927 pref_t* preference = register_preference(module, name, title, description, PREF_CUSTOM, false0);
1928
1929 preference->custom_cbs = *custom_cbs;
1930 init_cb(preference, list);
1931}
1932
1933/*
1934 * Register a custom preference.
1935 */
1936void
1937prefs_register_custom_preference(module_t *module, const char *name,
1938 const char *title, const char *description,
1939 struct pref_custom_cbs* custom_cbs,
1940 void **custom_data _U___attribute__((unused)))
1941{
1942 pref_t* preference = register_preference(module, name, title, description, PREF_CUSTOM, false0);
1943
1944 preference->custom_cbs = *custom_cbs;
1945 /* XXX - wait until we can handle void** pointers
1946 preference->custom_cbs.init_cb(preference, custom_data);
1947 */
1948}
1949
1950/*
1951 * Register a dedicated TCP preference for SEQ analysis overriding.
1952 * This is similar to the data structure from enum preference, except
1953 * that when a preference dialog is used, the stashed value is the list
1954 * of frame data pointers whose sequence analysis override will be set
1955 * to the current value if the dialog is accepted.
1956 *
1957 * We don't need to read or write the value from the preferences file
1958 * (or command line), because the override is reset to the default (0)
1959 * for each frame when a new capture file is loaded.
1960 */
1961void
1962prefs_register_custom_preference_TCP_Analysis(module_t *module, const char *name,
1963 const char *title, const char *description,
1964 int *var, const enum_val_t *enumvals,
1965 bool_Bool radio_buttons)
1966{
1967 pref_t *preference;
1968
1969 preference = register_preference(module, name, title, description,
1970 PREF_PROTO_TCP_SNDAMB_ENUM, false0);
1971 preference->varp.enump = var;
1972 preference->default_val.enumval = *var;
1973 preference->stashed_val.list = NULL((void*)0);
1974 preference->info.enum_info.enumvals = enumvals;
1975 preference->info.enum_info.radio_buttons = radio_buttons;
1976}
1977
1978/*
1979 * Register a (internal) "Decode As" preference with a ranged value.
1980 */
1981void prefs_register_decode_as_range_preference(module_t *module, const char *name,
1982 const char *title, const char *description, range_t **var,
1983 uint32_t max_value, const char *dissector_table, const char *dissector_description)
1984{
1985 pref_t *preference;
1986
1987 preference = prefs_register_range_preference_common(module, name, title,
1988 description, var, max_value, PREF_DECODE_AS_RANGE);
1989 preference->dissector_desc = dissector_description;
1990 preference->dissector_table = dissector_table;
1991}
1992
1993/*
1994 * Register a preference with password value.
1995 */
1996void
1997prefs_register_password_preference(module_t *module, const char *name,
1998 const char *title, const char *description,
1999 const char **var)
2000{
2001DIAG_OFF(cast-qual)clang diagnostic push clang diagnostic ignored "-Wcast-qual"
2002 register_string_like_preference(module, name, title, description,
2003 (char **)var, PREF_PASSWORD, NULL((void*)0), false0);
2004DIAG_ON(cast-qual)clang diagnostic pop
2005}
2006
2007/*
2008 * Register a preference with a dissector name.
2009 */
2010void
2011prefs_register_dissector_preference(module_t *module, const char *name,
2012 const char *title, const char *description,
2013 const char **var)
2014{
2015DIAG_OFF(cast-qual)clang diagnostic push clang diagnostic ignored "-Wcast-qual"
2016 register_string_like_preference(module, name, title, description,
2017 (char **)var, PREF_DISSECTOR, NULL((void*)0), false0);
2018DIAG_ON(cast-qual)clang diagnostic pop
2019}
2020
2021bool_Bool prefs_add_decode_as_value(pref_t *pref, unsigned value, bool_Bool replace)
2022{
2023 switch(pref->type)
2024 {
2025 case PREF_DECODE_AS_RANGE:
2026 if (replace)
2027 {
2028 /* If range has single value, replace it */
2029 if (((*pref->varp.range)->nranges == 1) &&
2030 ((*pref->varp.range)->ranges[0].low == (*pref->varp.range)->ranges[0].high)) {
2031 wmem_free(pref->scope, *pref->varp.range);
2032 *pref->varp.range = range_empty(pref->scope);
2033 }
2034 }
2035
2036 prefs_range_add_value(pref, value);
2037 break;
2038 default:
2039 /* XXX - Worth asserting over? */
2040 break;
2041 }
2042
2043 return true1;
2044}
2045
2046bool_Bool prefs_remove_decode_as_value(pref_t *pref, unsigned value, bool_Bool set_default _U___attribute__((unused)))
2047{
2048 switch(pref->type)
2049 {
2050 case PREF_DECODE_AS_RANGE:
2051 /* XXX - We could set to the default if the value is the only one
2052 * in the range.
2053 */
2054 prefs_range_remove_value(pref, value);
2055 break;
2056 default:
2057 break;
2058 }
2059
2060 return true1;
2061}
2062
2063/*
2064 * Register a preference that used to be supported but no longer is.
2065 */
2066void
2067prefs_register_obsolete_preference(module_t *module, const char *name)
2068{
2069 register_preference(module, name, NULL((void*)0), NULL((void*)0), PREF_STATIC_TEXT, true1);
2070}
2071
2072bool_Bool
2073prefs_is_preference_obsolete(pref_t *pref)
2074{
2075 return pref->obsolete;
2076}
2077
2078void
2079prefs_set_preference_effect_fields(module_t *module, const char *name)
2080{
2081 prefs_set_preference_effect(module, name, PREF_EFFECT_FIELDS(1u << 3));
2082}
2083
2084void prefs_set_preference_effect(module_t* module, const char* name, unsigned flags) {
2085 pref_t* pref = prefs_find_preference(module, name);
2086 if (pref) {
2087 prefs_set_effect_flags(pref, prefs_get_effect_flags(pref) | flags);
2088 }
2089}
2090
2091unsigned
2092pref_stash(pref_t *pref, void *unused _U___attribute__((unused)))
2093{
2094 ws_assert(!pref->obsolete)do { if ((1) && !(!pref->obsolete)) ws_log_fatal_full
("Epan", LOG_LEVEL_ERROR, "epan/prefs.c", 2094, __func__, "assertion failed: %s"
, "!pref->obsolete"); } while (0)
;
2095
2096 switch (pref->type) {
2097
2098 case PREF_UINT:
2099 pref->stashed_val.uint = *pref->varp.uint;
2100 break;
2101
2102 case PREF_BOOL:
2103 pref->stashed_val.boolval = *pref->varp.boolp;
2104 break;
2105
2106 case PREF_ENUM:
2107 pref->stashed_val.enumval = *pref->varp.enump;
2108 break;
2109
2110 case PREF_INT:
2111 pref->stashed_val.intval = *pref->varp.intp;
2112 break;
2113
2114 case PREF_FLOAT:
2115 pref->stashed_val.floatval = *pref->varp.floatp;
2116 break;
2117
2118 case PREF_STRING:
2119 case PREF_SAVE_FILENAME:
2120 case PREF_OPEN_FILENAME:
2121 case PREF_DIRNAME:
2122 case PREF_PASSWORD:
2123 case PREF_DISSECTOR:
2124 wmem_free(pref->scope, pref->stashed_val.string);
2125 pref->stashed_val.string = wmem_strdup(pref->scope, *pref->varp.string);
2126 break;
2127
2128 case PREF_DECODE_AS_RANGE:
2129 case PREF_RANGE:
2130 wmem_free(pref->scope, pref->stashed_val.range);
2131 pref->stashed_val.range = range_copy(pref->scope, *pref->varp.range);
2132 break;
2133
2134 case PREF_COLOR:
2135 pref->stashed_val.color = *pref->varp.colorp;
2136 break;
2137
2138 case PREF_STATIC_TEXT:
2139 case PREF_UAT:
2140 case PREF_CUSTOM:
2141 case PREF_PROTO_TCP_SNDAMB_ENUM:
2142 break;
2143
2144 default:
2145 ws_assert_not_reached()ws_log_fatal_full("Epan", LOG_LEVEL_ERROR, "epan/prefs.c", 2145
, __func__, "assertion \"not reached\" failed")
;
2146 break;
2147 }
2148 return 0;
2149}
2150
2151unsigned pref_get_changed_flags(pref_t *pref, void *unstash_data_p)
2152{
2153 pref_unstash_data_t *unstash_data = (pref_unstash_data_t *)unstash_data_p;
2154
2155 ws_assert(!pref->obsolete)do { if ((1) && !(!pref->obsolete)) ws_log_fatal_full
("Epan", LOG_LEVEL_ERROR, "epan/prefs.c", 2155, __func__, "assertion failed: %s"
, "!pref->obsolete"); } while (0)
;
2156
2157 switch (pref->type) {
2158
2159 case PREF_UINT:
2160 if (*pref->varp.uint != pref->stashed_val.uint) {
2161 unstash_data->module->prefs_changed_flags |= prefs_get_effect_flags(pref);
2162 }
2163 break;
2164
2165 case PREF_INT:
2166 if (*pref->varp.intp != pref->stashed_val.intval) {
2167 unstash_data->module->prefs_changed_flags |= prefs_get_effect_flags(pref);
2168 }
2169 break;
2170
2171 case PREF_FLOAT:
2172 if (*pref->varp.floatp != pref->stashed_val.floatval) {
2173 unstash_data->module->prefs_changed_flags |= prefs_get_effect_flags(pref);
2174 }
2175 break;
2176
2177 case PREF_BOOL:
2178 if (*pref->varp.boolp != pref->stashed_val.boolval) {
2179 unstash_data->module->prefs_changed_flags |= prefs_get_effect_flags(pref);
2180 }
2181 break;
2182
2183 case PREF_ENUM:
2184 if (*pref->varp.enump != pref->stashed_val.enumval) {
2185 unstash_data->module->prefs_changed_flags |= prefs_get_effect_flags(pref);
2186 }
2187 break;
2188
2189 case PREF_PROTO_TCP_SNDAMB_ENUM:
2190 {
2191 /* The preference dialogs are modal so the frame_data pointers should
2192 * still be valid; otherwise we could store the frame numbers to
2193 * change.
2194 */
2195 frame_data *fdata;
2196 for (GList* elem = pref->stashed_val.list; elem != NULL((void*)0); elem = elem->next) {
2197 fdata = (frame_data*)elem->data;
2198 if (fdata->tcp_snd_manual_analysis != *pref->varp.enump) {
2199 unstash_data->module->prefs_changed_flags |= prefs_get_effect_flags(pref);
2200 }
2201 }
2202 break;
2203 }
2204
2205 case PREF_STRING:
2206 case PREF_SAVE_FILENAME:
2207 case PREF_OPEN_FILENAME:
2208 case PREF_DIRNAME:
2209 case PREF_PASSWORD:
2210 case PREF_DISSECTOR:
2211 if (pref->stashed_val.string == NULL((void*)0)) {
2212 /* XXX - This shouldn't happen, but there's an issue with how the
2213 * Preferences Dialog handles newly registered extcap prefs. */
2214 ws_debug("stashed pref %s is NULL", prefs_get_name(pref))do { if (1) { ws_log_full("Epan", LOG_LEVEL_DEBUG, "epan/prefs.c"
, 2214, __func__, "stashed pref %s is NULL", prefs_get_name(pref
)); } } while (0)
;
2215 break;
2216 }
2217 if (strcmp(*pref->varp.string, pref->stashed_val.string) != 0) {
2218 unstash_data->module->prefs_changed_flags |= prefs_get_effect_flags(pref);
2219 }
2220 break;
2221
2222 case PREF_DECODE_AS_RANGE:
2223 case PREF_RANGE:
2224 if (!ranges_are_equal(*pref->varp.range, pref->stashed_val.range)) {
2225 unstash_data->module->prefs_changed_flags |= prefs_get_effect_flags(pref);
2226 }
2227 break;
2228
2229 case PREF_COLOR:
2230 if ((pref->varp.colorp->blue != pref->stashed_val.color.blue) ||
2231 (pref->varp.colorp->red != pref->stashed_val.color.red) ||
2232 (pref->varp.colorp->green != pref->stashed_val.color.green)) {
2233 unstash_data->module->prefs_changed_flags |= prefs_get_effect_flags(pref);
2234 }
2235 break;
2236
2237 case PREF_UAT:
2238 if (pref->varp.uat && pref->varp.uat->changed) {
2239 unstash_data->module->prefs_changed_flags |= prefs_get_effect_flags(pref);
2240 }
2241 break;
2242
2243 case PREF_STATIC_TEXT:
2244 case PREF_CUSTOM:
2245 break;
2246
2247 default:
2248 ws_assert_not_reached()ws_log_fatal_full("Epan", LOG_LEVEL_ERROR, "epan/prefs.c", 2248
, __func__, "assertion \"not reached\" failed")
;
2249 break;
2250 }
2251 return 0;
2252}
2253
2254unsigned
2255pref_unstash(pref_t *pref, void *unstash_data_p)
2256{
2257 pref_unstash_data_t *unstash_data = (pref_unstash_data_t *)unstash_data_p;
2258 dissector_table_t sub_dissectors = NULL((void*)0);
2259 dissector_handle_t handle = NULL((void*)0);
2260
2261 ws_assert(!pref->obsolete)do { if ((1) && !(!pref->obsolete)) ws_log_fatal_full
("Epan", LOG_LEVEL_ERROR, "epan/prefs.c", 2261, __func__, "assertion failed: %s"
, "!pref->obsolete"); } while (0)
;
2262
2263 /* Revert the preference to its saved value. */
2264 switch (pref->type) {
2265
2266 case PREF_UINT:
2267 if (*pref->varp.uint != pref->stashed_val.uint) {
2268 *pref->varp.uint = pref->stashed_val.uint;
2269 }
2270 break;
2271
2272 case PREF_INT:
2273 if (*pref->varp.intp != pref->stashed_val.intval) {
2274 *pref->varp.intp = pref->stashed_val.intval;
2275 }
2276 break;
2277
2278 case PREF_FLOAT:
2279 if (*pref->varp.floatp != pref->stashed_val.floatval) {
2280 *pref->varp.floatp = pref->stashed_val.floatval;
2281 }
2282 break;
2283
2284 case PREF_BOOL:
2285 if (*pref->varp.boolp != pref->stashed_val.boolval) {
2286 *pref->varp.boolp = pref->stashed_val.boolval;
2287 }
2288 break;
2289
2290 case PREF_ENUM:
2291 if (*pref->varp.enump != pref->stashed_val.enumval) {
2292 *pref->varp.enump = pref->stashed_val.enumval;
2293 }
2294 break;
2295
2296 case PREF_PROTO_TCP_SNDAMB_ENUM:
2297 {
2298 /* The preference dialogs are modal so the frame_data pointers should
2299 * still be valid; otherwise we could store the frame numbers to
2300 * change.
2301 */
2302 frame_data *fdata;
2303 for (GList* elem = pref->stashed_val.list; elem != NULL((void*)0); elem = elem->next) {
2304 fdata = (frame_data*)elem->data;
2305 if (fdata->tcp_snd_manual_analysis != *pref->varp.enump) {
2306 fdata->tcp_snd_manual_analysis = *pref->varp.enump;
2307 }
2308 }
2309 break;
2310 }
2311
2312 case PREF_STRING:
2313 case PREF_SAVE_FILENAME:
2314 case PREF_OPEN_FILENAME:
2315 case PREF_DIRNAME:
2316 case PREF_PASSWORD:
2317 case PREF_DISSECTOR:
2318 if (pref->stashed_val.string == NULL((void*)0)) {
2319 /* XXX - This shouldn't happen, but there's an issue with how the
2320 * Preferences Dialog handles newly registered extcap prefs. */
2321 ws_debug("stashed pref %s is NULL", prefs_get_name(pref))do { if (1) { ws_log_full("Epan", LOG_LEVEL_DEBUG, "epan/prefs.c"
, 2321, __func__, "stashed pref %s is NULL", prefs_get_name(pref
)); } } while (0)
;
2322 break;
2323 }
2324 if (strcmp(*pref->varp.string, pref->stashed_val.string) != 0) {
2325 wmem_free(pref->scope, *pref->varp.string);
2326 *pref->varp.string = wmem_strdup(pref->scope, pref->stashed_val.string);
2327 }
2328 break;
2329
2330 case PREF_DECODE_AS_RANGE:
2331 {
2332 const char* table_name = prefs_get_dissector_table(pref);
2333 if (!ranges_are_equal(*pref->varp.range, pref->stashed_val.range)) {
2334 uint32_t i, j;
2335
2336 if (unstash_data->handle_decode_as) {
2337 sub_dissectors = find_dissector_table(table_name);
2338 if (sub_dissectors != NULL((void*)0)) {
2339 const char *handle_desc = prefs_get_dissector_description(pref);
2340 // It should perhaps be possible to get this via dissector name.
2341 handle = dissector_table_get_dissector_handle(sub_dissectors, handle_desc);
2342 if (handle != NULL((void*)0)) {
2343 /* Set the current handle to NULL for all the old values
2344 * in the dissector table. If there isn't an initial
2345 * handle, this actually deletes the entry. (If there
2346 * is an initial entry, keep it around so that the
2347 * user can see the original value.)
2348 *
2349 * XXX - If there's an initial handle which is not this,
2350 * reset it instead? At least this leaves the initial
2351 * handle visible in the Decode As table.
2352 */
2353 for (i = 0; i < (*pref->varp.range)->nranges; i++) {
2354 for (j = (*pref->varp.range)->ranges[i].low; j < (*pref->varp.range)->ranges[i].high; j++) {
2355 dissector_change_uint(table_name, j, NULL((void*)0));
2356 decode_build_reset_list(table_name, dissector_table_get_type(sub_dissectors), GUINT_TO_POINTER(j)((gpointer) (gulong) (j)), NULL((void*)0), NULL((void*)0));
2357 }
2358
2359 dissector_change_uint(table_name, (*pref->varp.range)->ranges[i].high, NULL((void*)0));
2360 decode_build_reset_list(table_name, dissector_table_get_type(sub_dissectors), GUINT_TO_POINTER((*pref->varp.range)->ranges[i].high)((gpointer) (gulong) ((*pref->varp.range)->ranges[i].high
))
, NULL((void*)0), NULL((void*)0));
2361 }
2362 }
2363 }
2364 }
2365
2366 wmem_free(pref->scope, *pref->varp.range);
2367 *pref->varp.range = range_copy(pref->scope, pref->stashed_val.range);
2368
2369 if (unstash_data->handle_decode_as) {
2370 if ((sub_dissectors != NULL((void*)0)) && (handle != NULL((void*)0))) {
2371
2372 /* Add new values to the dissector table */
2373 for (i = 0; i < (*pref->varp.range)->nranges; i++) {
2374
2375 for (j = (*pref->varp.range)->ranges[i].low; j < (*pref->varp.range)->ranges[i].high; j++) {
2376 dissector_change_uint(table_name, j, handle);
2377 decode_build_reset_list(table_name, dissector_table_get_type(sub_dissectors), GUINT_TO_POINTER(j)((gpointer) (gulong) (j)), NULL((void*)0), NULL((void*)0));
2378 }
2379
2380 dissector_change_uint(table_name, (*pref->varp.range)->ranges[i].high, handle);
2381 decode_build_reset_list(table_name, dissector_table_get_type(sub_dissectors), GUINT_TO_POINTER((*pref->varp.range)->ranges[i].high)((gpointer) (gulong) ((*pref->varp.range)->ranges[i].high
))
, NULL((void*)0), NULL((void*)0));
2382 }
2383 }
2384 }
2385 }
2386 break;
2387 }
2388
2389 case PREF_RANGE:
2390 if (!ranges_are_equal(*pref->varp.range, pref->stashed_val.range)) {
2391 wmem_free(pref->scope, *pref->varp.range);
2392 *pref->varp.range = range_copy(pref->scope, pref->stashed_val.range);
2393 }
2394 break;
2395
2396 case PREF_COLOR:
2397 if ((pref->varp.colorp->blue != pref->stashed_val.color.blue) ||
2398 (pref->varp.colorp->red != pref->stashed_val.color.red) ||
2399 (pref->varp.colorp->green != pref->stashed_val.color.green)) {
2400 *pref->varp.colorp = pref->stashed_val.color;
2401 }
2402 break;
2403
2404 case PREF_UAT:
2405 case PREF_STATIC_TEXT:
2406 case PREF_CUSTOM:
2407 break;
2408
2409 default:
2410 ws_assert_not_reached()ws_log_fatal_full("Epan", LOG_LEVEL_ERROR, "epan/prefs.c", 2410
, __func__, "assertion \"not reached\" failed")
;
2411 break;
2412 }
2413 return 0;
2414}
2415
2416void
2417reset_stashed_pref(pref_t *pref) {
2418
2419 ws_assert(!pref->obsolete)do { if ((1) && !(!pref->obsolete)) ws_log_fatal_full
("Epan", LOG_LEVEL_ERROR, "epan/prefs.c", 2419, __func__, "assertion failed: %s"
, "!pref->obsolete"); } while (0)
;
2420
2421 switch (pref->type) {
2422
2423 case PREF_UINT:
2424 pref->stashed_val.uint = pref->default_val.uint;
2425 break;
2426
2427 case PREF_INT:
2428 pref->stashed_val.intval = pref->default_val.intval;
2429 break;
2430
2431 case PREF_FLOAT:
2432 pref->stashed_val.floatval = pref->default_val.floatval;
2433 break;
2434
2435 case PREF_BOOL:
2436 pref->stashed_val.boolval = pref->default_val.boolval;
2437 break;
2438
2439 case PREF_ENUM:
2440 pref->stashed_val.enumval = pref->default_val.enumval;
2441 break;
2442
2443 case PREF_STRING:
2444 case PREF_SAVE_FILENAME:
2445 case PREF_OPEN_FILENAME:
2446 case PREF_DIRNAME:
2447 case PREF_PASSWORD:
2448 case PREF_DISSECTOR:
2449 wmem_free(pref->scope, pref->stashed_val.string);
2450 pref->stashed_val.string = wmem_strdup(pref->scope, pref->default_val.string);
2451 break;
2452
2453 case PREF_DECODE_AS_RANGE:
2454 case PREF_RANGE:
2455 wmem_free(pref->scope, pref->stashed_val.range);
2456 pref->stashed_val.range = range_copy(pref->scope, pref->default_val.range);
2457 break;
2458
2459 case PREF_PROTO_TCP_SNDAMB_ENUM:
2460 if (pref->stashed_val.list != NULL((void*)0)) {
2461 g_list_free(pref->stashed_val.list);
2462 pref->stashed_val.list = NULL((void*)0);
2463 }
2464 break;
2465
2466 case PREF_COLOR:
2467 memcpy(&pref->stashed_val.color, &pref->default_val.color, sizeof(color_t));
2468 break;
2469
2470 case PREF_STATIC_TEXT:
2471 case PREF_UAT:
2472 case PREF_CUSTOM:
2473 break;
2474
2475 default:
2476 ws_assert_not_reached()ws_log_fatal_full("Epan", LOG_LEVEL_ERROR, "epan/prefs.c", 2476
, __func__, "assertion \"not reached\" failed")
;
2477 break;
2478 }
2479}
2480
2481unsigned
2482pref_clean_stash(pref_t *pref, void *unused _U___attribute__((unused)))
2483{
2484 ws_assert(!pref->obsolete)do { if ((1) && !(!pref->obsolete)) ws_log_fatal_full
("Epan", LOG_LEVEL_ERROR, "epan/prefs.c", 2484, __func__, "assertion failed: %s"
, "!pref->obsolete"); } while (0)
;
2485
2486 switch (pref->type) {
2487
2488 case PREF_UINT:
2489 case PREF_INT:
2490 case PREF_FLOAT:
2491 case PREF_BOOL:
2492 case PREF_ENUM:
2493 break;
2494
2495 case PREF_STRING:
2496 case PREF_SAVE_FILENAME:
2497 case PREF_OPEN_FILENAME:
2498 case PREF_DIRNAME:
2499 case PREF_PASSWORD:
2500 case PREF_DISSECTOR:
2501 if (pref->stashed_val.string != NULL((void*)0)) {
2502 wmem_free(pref->scope, pref->stashed_val.string);
2503 pref->stashed_val.string = NULL((void*)0);
2504 }
2505 break;
2506
2507 case PREF_DECODE_AS_RANGE:
2508 case PREF_RANGE:
2509 if (pref->stashed_val.range != NULL((void*)0)) {
2510 wmem_free(pref->scope, pref->stashed_val.range);
2511 pref->stashed_val.range = NULL((void*)0);
2512 }
2513 break;
2514
2515 case PREF_STATIC_TEXT:
2516 case PREF_UAT:
2517 case PREF_COLOR:
2518 case PREF_CUSTOM:
2519 break;
2520
2521 case PREF_PROTO_TCP_SNDAMB_ENUM:
2522 if (pref->stashed_val.list != NULL((void*)0)) {
2523 g_list_free(pref->stashed_val.list);
2524 pref->stashed_val.list = NULL((void*)0);
2525 }
2526 break;
2527
2528 default:
2529 ws_assert_not_reached()ws_log_fatal_full("Epan", LOG_LEVEL_ERROR, "epan/prefs.c", 2529
, __func__, "assertion \"not reached\" failed")
;
2530 break;
2531 }
2532 return 0;
2533}
2534
2535/*
2536 * Call a callback function, with a specified argument, for each preference
2537 * in a given module.
2538 *
2539 * If any of the callbacks return a non-zero value, stop and return that
2540 * value, otherwise return 0.
2541 */
2542unsigned
2543prefs_pref_foreach(module_t *module, pref_cb callback, void *user_data)
2544{
2545 GList *elem;
2546 pref_t *pref;
2547 unsigned ret;
2548
2549 for (elem = g_list_first(module->prefs); elem != NULL((void*)0); elem = g_list_next(elem)((elem) ? (((GList *)(elem))->next) : ((void*)0))) {
2550 pref = (pref_t *)elem->data;
2551 if (!pref || pref->obsolete) {
2552 /*
2553 * This preference is no longer supported; it's
2554 * not a real preference, so we don't call the
2555 * callback for it (i.e., we treat it as if it
2556 * weren't found in the list of preferences,
2557 * and we weren't called in the first place).
2558 */
2559 continue;
2560 }
2561
2562 ret = (*callback)(pref, user_data);
2563 if (ret != 0)
2564 return ret;
2565 }
2566 return 0;
2567}
2568
2569static const enum_val_t st_sort_col_vals[] = {
2570 { "name", "Node name (topic/item)", ST_SORT_COL_NAME1 },
2571 { "count", "Item count", ST_SORT_COL_COUNT2 },
2572 { "average", "Average value of the node", ST_SORT_COL_AVG3 },
2573 { "min", "Minimum value of the node", ST_SORT_COL_MIN4 },
2574 { "max", "Maximum value of the node", ST_SORT_COL_MAX5 },
2575 { "burst", "Burst rate of the node", ST_SORT_COL_BURSTRATE6 },
2576 { NULL((void*)0), NULL((void*)0), 0 }
2577};
2578
2579static const enum_val_t st_format_vals[] = {
2580 { "text", "Plain text", ST_FORMAT_PLAIN },
2581 { "csv", "Comma separated values", ST_FORMAT_CSV },
2582 { "xml", "XML document", ST_FORMAT_XML },
2583 { "yaml", "YAML document", ST_FORMAT_YAML },
2584 { NULL((void*)0), NULL((void*)0), 0 }
2585};
2586
2587static void
2588stats_callback(void)
2589{
2590 /* Test for a sane tap update interval */
2591 if (prefs.tap_update_interval < 100 || prefs.tap_update_interval > 10000)
2592 prefs.tap_update_interval = TAP_UPDATE_DEFAULT_INTERVAL3000;
2593
2594 /* burst resolution can't be less than 1 (ms) */
2595 if (prefs.st_burst_resolution < 1) {
2596 prefs.st_burst_resolution = 1;
2597 }
2598 else if (prefs.st_burst_resolution > ST_MAX_BURSTRES600000) {
2599 prefs.st_burst_resolution = ST_MAX_BURSTRES600000;
2600 }
2601 /* make sure burst window value makes sense */
2602 if (prefs.st_burst_windowlen < prefs.st_burst_resolution) {
2603 prefs.st_burst_windowlen = prefs.st_burst_resolution;
2604 }
2605 /* round burst window down to multiple of resolution */
2606 prefs.st_burst_windowlen -= prefs.st_burst_windowlen%prefs.st_burst_resolution;
2607 if ((prefs.st_burst_windowlen/prefs.st_burst_resolution) > ST_MAX_BURSTBUCKETS100) {
2608 prefs.st_burst_windowlen = prefs.st_burst_resolution*ST_MAX_BURSTBUCKETS100;
2609 }
2610}
2611
2612static void
2613gui_callback(void)
2614{
2615 /* Ensure there is at least one file count */
2616 if (prefs.gui_recent_files_count_max == 0)
2617 prefs.gui_recent_files_count_max = 10;
2618
2619 /* Ensure there is at least one display filter entry */
2620 if (prefs.gui_recent_df_entries_max == 0)
2621 prefs.gui_recent_df_entries_max = 10;
2622
2623 /* number of decimal places should be between 2 and 10 */
2624 if (prefs.gui_decimal_places1 < 2) {
2625 prefs.gui_decimal_places1 = 2;
2626 } else if (prefs.gui_decimal_places1 > 10) {
2627 prefs.gui_decimal_places1 = 10;
2628 }
2629 /* number of decimal places should be between 2 and 10 */
2630 if (prefs.gui_decimal_places2 < 2) {
2631 prefs.gui_decimal_places2 = 2;
2632 } else if (prefs.gui_decimal_places2 > 10) {
2633 prefs.gui_decimal_places2 = 10;
2634 }
2635 /* number of decimal places should be between 2 and 10 */
2636 if (prefs.gui_decimal_places3 < 2) {
2637 prefs.gui_decimal_places3 = 2;
2638 } else if (prefs.gui_decimal_places3 > 10) {
2639 prefs.gui_decimal_places3 = 10;
2640 }
2641}
2642
2643static void
2644gui_layout_callback(void)
2645{
2646 if (prefs.gui_layout_type == layout_unused ||
2647 prefs.gui_layout_type >= layout_type_max) {
2648 /* XXX - report an error? It's not a syntax error - we'd need to
2649 add a way of reporting a *semantic* error. */
2650 prefs.gui_layout_type = layout_type_2;
2651 }
2652}
2653
2654/******************************************************
2655 * All custom preference function callbacks
2656 ******************************************************/
2657static void custom_pref_no_cb(pref_t* pref _U___attribute__((unused))) {}
2658
2659/*
2660 * Column preference functions
2661 */
2662#define PRS_COL_HIDDEN_FMT"column.hidden" "column.hidden"
2663#define PRS_COL_HIDDEN"column.hide" "column.hide"
2664#define PRS_COL_FMT"column.format" "column.format"
2665#define PRS_COL_NUM"column.number" "column.number"
2666static module_t *gui_column_module;
2667
2668static prefs_set_pref_e
2669column_hidden_set_cb(pref_t* pref, const char* value, unsigned int* changed_flags)
2670{
2671 GList *clp;
2672 fmt_data *cfmt;
2673 pref_t *format_pref;
2674
2675 /*
2676 * Prefer the new preference to the old format-based preference if we've
2677 * read it. (We probably could just compare the string to NULL and "".)
2678 */
2679 prefs.cols_hide_new = true1;
2680
2681 (*changed_flags) |= prefs_set_string_value(pref, value, pref_current);
2682
2683 /*
2684 * Set the "visible" flag for the existing columns; we need to
2685 * do this if we set PRS_COL_HIDDEN but don't set PRS_COL_FMT
2686 * after setting it (which might be the case if, for example, we
2687 * set PRS_COL_HIDDEN on the command line).
2688 */
2689 format_pref = prefs_find_preference(gui_column_module, PRS_COL_FMT"column.format");
2690 clp = (format_pref) ? *format_pref->varp.list : NULL((void*)0);
2691 int cidx = 1;
2692 while (clp) {
2693 cfmt = (fmt_data *)clp->data;
2694 cfmt->visible = prefs_is_column_visible(*pref->varp.string, cidx);
2695 cidx++;
2696 clp = clp->next;
2697 }
2698
2699 return PREFS_SET_OK;
2700}
2701
2702static const char *
2703column_hidden_type_name_cb(void)
2704{
2705 return "Packet list hidden columns";
2706}
2707
2708static char *
2709column_hidden_type_description_cb(void)
2710{
2711 return g_strdup("List all column indices (1-indexed) to hide in the packet list.")g_strdup_inline ("List all column indices (1-indexed) to hide in the packet list."
)
;
2712}
2713
2714static char *
2715column_hidden_to_str_cb(pref_t* pref, bool_Bool default_val)
2716{
2717 GString *cols_hidden;
2718 GList *clp;
2719 fmt_data *cfmt;
2720 pref_t *format_pref;
2721 int cidx = 1;
2722
2723 if (default_val)
2724 return g_strdup(pref->default_val.string)g_strdup_inline (pref->default_val.string);
2725
2726 cols_hidden = g_string_new("");
2727 format_pref = prefs_find_preference(gui_column_module, PRS_COL_FMT"column.format");
2728 clp = (format_pref) ? *format_pref->varp.list : NULL((void*)0);
2729 while (clp) {
2730 cfmt = (fmt_data *) clp->data;
2731 if (!cfmt->visible) {
2732 if (cols_hidden->len)
2733 g_string_append (cols_hidden, ",")(__builtin_constant_p (",") ? __extension__ ({ const char * const
__val = (","); g_string_append_len_inline (cols_hidden, __val
, (__val != ((void*)0)) ? (gssize) strlen (((__val) + !(__val
))) : (gssize) -1); }) : g_string_append_len_inline (cols_hidden
, ",", (gssize) -1))
;
2734 g_string_append_printf (cols_hidden, "%i", cidx);
2735 }
2736 clp = clp->next;
2737 cidx++;
2738 }
2739
2740 return g_string_free (cols_hidden, FALSE)(__builtin_constant_p ((0)) ? (((0)) ? (g_string_free) ((cols_hidden
), ((0))) : g_string_free_and_steal (cols_hidden)) : (g_string_free
) ((cols_hidden), ((0))))
;
2741}
2742
2743static bool_Bool
2744column_hidden_is_default_cb(pref_t* pref)
2745{
2746 char *cur_hidden_str = column_hidden_to_str_cb(pref, false0);
2747 bool_Bool is_default = g_strcmp0(cur_hidden_str, pref->default_val.string) == 0;
2748
2749 g_free(cur_hidden_str)(__builtin_object_size ((cur_hidden_str), 0) != ((size_t) - 1
)) ? g_free_sized (cur_hidden_str, __builtin_object_size ((cur_hidden_str
), 0)) : (g_free) (cur_hidden_str)
;
2750 return is_default;
2751}
2752
2753static prefs_set_pref_e
2754column_hidden_fmt_set_cb(pref_t* pref, const char* value, unsigned int* changed_flags)
2755{
2756 GList *clp;
2757 fmt_data *cfmt;
2758 pref_t *format_pref;
2759
2760 (*changed_flags) |= prefs_set_string_value(pref, value, pref_current);
2761
2762 /*
2763 * Set the "visible" flag for the existing columns; we need to
2764 * do this if we set PRS_COL_HIDDEN_FMT but don't set PRS_COL_FMT
2765 * after setting it (which might be the case if, for example, we
2766 * set PRS_COL_HIDDEN_FMT on the command line; it shouldn't happen
2767 * when reading the configuration file because we write (both of)
2768 * the hidden column prefs before the column format prefs.)
2769 */
2770 format_pref = prefs_find_preference(gui_column_module, PRS_COL_FMT"column.format");
2771 clp = (format_pref) ? *format_pref->varp.list : NULL((void*)0);
2772 while (clp) {
2773 cfmt = (fmt_data *)clp->data;
2774 cfmt->visible = prefs_is_column_fmt_visible(*pref->varp.string, cfmt);
2775 clp = clp->next;
2776 }
2777
2778 return PREFS_SET_OK;
2779}
2780
2781static const char *
2782column_hidden_fmt_type_name_cb(void)
2783{
2784 return "Packet list hidden column formats (deprecated)";
2785}
2786
2787static char *
2788column_hidden_fmt_type_description_cb(void)
2789{
2790 return g_strdup("List all column formats to hide in the packet list. Deprecated in favor of the index-based preference.")g_strdup_inline ("List all column formats to hide in the packet list. Deprecated in favor of the index-based preference."
)
;
2791}
2792
2793static char *
2794column_hidden_fmt_to_str_cb(pref_t* pref, bool_Bool default_val)
2795{
2796 GString *cols_hidden;
2797 GList *clp;
2798 fmt_data *cfmt;
2799 pref_t *format_pref;
2800
2801 if (default_val)
2802 return g_strdup(pref->default_val.string)g_strdup_inline (pref->default_val.string);
2803
2804 cols_hidden = g_string_new("");
2805 format_pref = prefs_find_preference(gui_column_module, PRS_COL_FMT"column.format");
2806 clp = (format_pref) ? *format_pref->varp.list : NULL((void*)0);
2807 while (clp) {
2808 char *prefs_fmt;
2809 cfmt = (fmt_data *) clp->data;
2810 if (!cfmt->visible) {
2811 if (cols_hidden->len)
2812 g_string_append (cols_hidden, ",")(__builtin_constant_p (",") ? __extension__ ({ const char * const
__val = (","); g_string_append_len_inline (cols_hidden, __val
, (__val != ((void*)0)) ? (gssize) strlen (((__val) + !(__val
))) : (gssize) -1); }) : g_string_append_len_inline (cols_hidden
, ",", (gssize) -1))
;
2813 prefs_fmt = column_fmt_data_to_str(cfmt);
2814 g_string_append(cols_hidden, prefs_fmt)(__builtin_constant_p (prefs_fmt) ? __extension__ ({ const char
* const __val = (prefs_fmt); g_string_append_len_inline (cols_hidden
, __val, (__val != ((void*)0)) ? (gssize) strlen (((__val) + !
(__val))) : (gssize) -1); }) : g_string_append_len_inline (cols_hidden
, prefs_fmt, (gssize) -1))
;
2815 g_free(prefs_fmt)(__builtin_object_size ((prefs_fmt), 0) != ((size_t) - 1)) ? g_free_sized
(prefs_fmt, __builtin_object_size ((prefs_fmt), 0)) : (g_free
) (prefs_fmt)
;
2816 }
2817 clp = clp->next;
2818 }
2819
2820 return g_string_free (cols_hidden, FALSE)(__builtin_constant_p ((0)) ? (((0)) ? (g_string_free) ((cols_hidden
), ((0))) : g_string_free_and_steal (cols_hidden)) : (g_string_free
) ((cols_hidden), ((0))))
;
2821}
2822
2823static bool_Bool
2824column_hidden_fmt_is_default_cb(pref_t* pref)
2825{
2826 char *cur_hidden_str = column_hidden_fmt_to_str_cb(pref, false0);
2827 bool_Bool is_default = g_strcmp0(cur_hidden_str, pref->default_val.string) == 0;
2828
2829 g_free(cur_hidden_str)(__builtin_object_size ((cur_hidden_str), 0) != ((size_t) - 1
)) ? g_free_sized (cur_hidden_str, __builtin_object_size ((cur_hidden_str
), 0)) : (g_free) (cur_hidden_str)
;
2830 return is_default;
2831}
2832
2833/* Number of columns "preference". This is only used internally and is not written to the
2834 * preference file
2835 */
2836static void
2837column_num_reset_cb(pref_t* pref)
2838{
2839 *pref->varp.uint = pref->default_val.uint;
2840}
2841
2842static prefs_set_pref_e
2843column_num_set_cb(pref_t* pref _U___attribute__((unused)), const char* value _U___attribute__((unused)), unsigned int* changed_flags _U___attribute__((unused)))
2844{
2845 /* Don't write this to the preferences file */
2846 return PREFS_SET_OK;
2847}
2848
2849static const char *
2850column_num_type_name_cb(void)
2851{
2852 return NULL((void*)0);
2853}
2854
2855static char *
2856column_num_type_description_cb(void)
2857{
2858 return g_strdup("")g_strdup_inline ("");
2859}
2860
2861static bool_Bool
2862column_num_is_default_cb(pref_t* pref _U___attribute__((unused)))
2863{
2864 return true1;
2865}
2866
2867static char *
2868column_num_to_str_cb(pref_t* pref _U___attribute__((unused)), bool_Bool default_val _U___attribute__((unused)))
2869{
2870 return g_strdup("")g_strdup_inline ("");
2871}
2872
2873/*
2874 * Column format custom preference functions
2875 */
2876static void
2877column_format_init_cb(pref_t* pref, GList** value)
2878{
2879 fmt_data *src_cfmt, *dest_cfmt;
2880 GList *entry;
2881
2882 pref->varp.list = value;
2883
2884 pref->default_val.list = NULL((void*)0);
2885 for (entry = *pref->varp.list; entry != NULL((void*)0); entry = g_list_next(entry)((entry) ? (((GList *)(entry))->next) : ((void*)0))) {
2886 src_cfmt = (fmt_data *)entry->data;
2887 dest_cfmt = g_new(fmt_data,1)((fmt_data *) g_malloc_n ((1), sizeof (fmt_data)));
2888 dest_cfmt->title = g_strdup(src_cfmt->title)g_strdup_inline (src_cfmt->title);
2889 dest_cfmt->fmt = src_cfmt->fmt;
2890 if (src_cfmt->custom_fields) {
2891 dest_cfmt->custom_fields = g_strdup(src_cfmt->custom_fields)g_strdup_inline (src_cfmt->custom_fields);
2892 dest_cfmt->custom_occurrence = src_cfmt->custom_occurrence;
2893 } else {
2894 dest_cfmt->custom_fields = NULL((void*)0);
2895 dest_cfmt->custom_occurrence = 0;
2896 }
2897 dest_cfmt->visible = src_cfmt->visible;
2898 dest_cfmt->display = src_cfmt->display;
2899 pref->default_val.list = g_list_append(pref->default_val.list, dest_cfmt);
2900 }
2901
2902 column_register_fields();
2903}
2904
2905static void
2906column_format_free_cb(pref_t* pref)
2907{
2908 free_col_info(*pref->varp.list);
2909 free_col_info(pref->default_val.list);
2910}
2911
2912static void
2913column_format_reset_cb(pref_t* pref)
2914{
2915 fmt_data *src_cfmt, *dest_cfmt;
2916 GList *entry;
2917 pref_t *col_num_pref;
2918
2919 free_col_info(*pref->varp.list);
2920 *pref->varp.list = NULL((void*)0);
2921
2922 for (entry = pref->default_val.list; entry != NULL((void*)0); entry = g_list_next(entry)((entry) ? (((GList *)(entry))->next) : ((void*)0))) {
2923 src_cfmt = (fmt_data *)entry->data;
2924 dest_cfmt = g_new(fmt_data,1)((fmt_data *) g_malloc_n ((1), sizeof (fmt_data)));
2925 dest_cfmt->title = g_strdup(src_cfmt->title)g_strdup_inline (src_cfmt->title);
2926 dest_cfmt->fmt = src_cfmt->fmt;
2927 if (src_cfmt->custom_fields) {
2928 dest_cfmt->custom_fields = g_strdup(src_cfmt->custom_fields)g_strdup_inline (src_cfmt->custom_fields);
2929 dest_cfmt->custom_occurrence = src_cfmt->custom_occurrence;
2930 } else {
2931 dest_cfmt->custom_fields = NULL((void*)0);
2932 dest_cfmt->custom_occurrence = 0;
2933 }
2934 dest_cfmt->visible = src_cfmt->visible;
2935 dest_cfmt->display = src_cfmt->display;
2936 *pref->varp.list = g_list_append(*pref->varp.list, dest_cfmt);
2937 }
2938
2939 col_num_pref = prefs_find_preference(gui_column_module, PRS_COL_NUM"column.number");
2940 ws_assert(col_num_pref != NULL)do { if ((1) && !(col_num_pref != ((void*)0))) ws_log_fatal_full
("Epan", LOG_LEVEL_ERROR, "epan/prefs.c", 2940, __func__, "assertion failed: %s"
, "col_num_pref != ((void*)0)"); } while (0)
; /* Should never happen */
2941 column_num_reset_cb(col_num_pref);
2942}
2943
2944static prefs_set_pref_e
2945column_format_set_cb(pref_t* pref, const char* value, unsigned int* changed_flags _U___attribute__((unused)))
2946{
2947 GList *col_l, *col_l_elt;
2948 fmt_data *cfmt;
2949 int llen;
2950 pref_t *hidden_pref, *col_num_pref;
2951
2952 col_l = prefs_get_string_list(value);
2953 if (col_l == NULL((void*)0))
2954 return PREFS_SET_SYNTAX_ERR;
2955 if ((g_list_length(col_l) % 2) != 0) {
2956 /* A title didn't have a matching format. */
2957 prefs_clear_string_list(col_l);
2958 return PREFS_SET_SYNTAX_ERR;
2959 }
2960 /* Check to make sure all column formats are valid. */
2961 col_l_elt = g_list_first(col_l);
2962 while (col_l_elt) {
2963 fmt_data cfmt_check;
2964
2965 /* Go past the title. */
2966 col_l_elt = col_l_elt->next;
2967
2968 /* Some predefined columns have been migrated to use custom columns.
2969 * We'll convert these silently here */
2970 try_convert_to_custom_column((char **)&col_l_elt->data);
2971
2972 /* Parse the format to see if it's valid. */
2973 if (!parse_column_format(&cfmt_check, (char *)col_l_elt->data)) {
2974 /* It's not a valid column format. */
2975 prefs_clear_string_list(col_l);
2976 return PREFS_SET_SYNTAX_ERR;
2977 }
2978 if (cfmt_check.fmt == COL_CUSTOM) {
2979 /* We don't need the custom column field on this pass. */
2980 g_free(cfmt_check.custom_fields)(__builtin_object_size ((cfmt_check.custom_fields), 0) != ((size_t
) - 1)) ? g_free_sized (cfmt_check.custom_fields, __builtin_object_size
((cfmt_check.custom_fields), 0)) : (g_free) (cfmt_check.custom_fields
)
;
2981 }
2982
2983 /* Go past the format. */
2984 col_l_elt = col_l_elt->next;
2985 }
2986
2987 /* They're all valid; process them. */
2988 free_col_info(*pref->varp.list);
2989 *pref->varp.list = NULL((void*)0);
2990 if (prefs.cols_hide_new) {
2991 hidden_pref = prefs_find_preference(gui_column_module, PRS_COL_HIDDEN"column.hide");
2992 } else {
2993 hidden_pref = prefs_find_preference(gui_column_module, PRS_COL_HIDDEN_FMT"column.hidden");
2994 }
2995 ws_assert(hidden_pref != NULL)do { if ((1) && !(hidden_pref != ((void*)0))) ws_log_fatal_full
("Epan", LOG_LEVEL_ERROR, "epan/prefs.c", 2995, __func__, "assertion failed: %s"
, "hidden_pref != ((void*)0)"); } while (0)
; /* Should never happen */
2996 col_num_pref = prefs_find_preference(gui_column_module, PRS_COL_NUM"column.number");
2997 ws_assert(col_num_pref != NULL)do { if ((1) && !(col_num_pref != ((void*)0))) ws_log_fatal_full
("Epan", LOG_LEVEL_ERROR, "epan/prefs.c", 2997, __func__, "assertion failed: %s"
, "col_num_pref != ((void*)0)"); } while (0)
; /* Should never happen */
2998 llen = g_list_length(col_l);
2999 *col_num_pref->varp.uint = llen / 2;
3000 col_l_elt = g_list_first(col_l);
3001 int cidx = 1;
3002 while (col_l_elt) {
3003 cfmt = g_new(fmt_data,1)((fmt_data *) g_malloc_n ((1), sizeof (fmt_data)));
3004 cfmt->title = g_strdup((char *)col_l_elt->data)g_strdup_inline ((char *)col_l_elt->data);
3005 col_l_elt = col_l_elt->next;
3006 parse_column_format(cfmt, (char *)col_l_elt->data);
3007 if (prefs.cols_hide_new) {
3008 cfmt->visible = prefs_is_column_visible(*hidden_pref->varp.string, cidx);
3009 } else {
3010 cfmt->visible = prefs_is_column_fmt_visible(*hidden_pref->varp.string, cfmt);
3011 }
3012 col_l_elt = col_l_elt->next;
3013 *pref->varp.list = g_list_append(*pref->varp.list, cfmt);
3014 cidx++;
3015 }
3016
3017 prefs_clear_string_list(col_l);
3018 free_string_like_preference(hidden_pref);
3019 column_register_fields();
3020 return PREFS_SET_OK;
3021}
3022
3023
3024static const char *
3025column_format_type_name_cb(void)
3026{
3027 return "Packet list column format";
3028}
3029
3030static char *
3031column_format_type_description_cb(void)
3032{
3033 return g_strdup("Each pair of strings consists of a column title and its format")g_strdup_inline ("Each pair of strings consists of a column title and its format"
)
;
3034}
3035
3036static bool_Bool
3037column_format_is_default_cb(pref_t* pref)
3038{
3039 GList *clp = *pref->varp.list,
3040 *pref_col = g_list_first(clp),
3041 *def_col = g_list_first(pref->default_val.list);
3042 fmt_data *cfmt, *def_cfmt;
3043 bool_Bool is_default = true1;
3044 pref_t *col_num_pref;
3045
3046 /* See if the column data has changed from the default */
3047 col_num_pref = prefs_find_preference(gui_column_module, PRS_COL_NUM"column.number");
3048 if (col_num_pref && *col_num_pref->varp.uint != col_num_pref->default_val.uint) {
3049 is_default = false0;
3050 } else {
3051 while (pref_col && def_col) {
3052 cfmt = (fmt_data *) pref_col->data;
3053 def_cfmt = (fmt_data *) def_col->data;
3054 if ((g_strcmp0(cfmt->title, def_cfmt->title) != 0) ||
3055 (cfmt->fmt != def_cfmt->fmt) ||
3056 (((cfmt->fmt == COL_CUSTOM) && (cfmt->custom_fields)) &&
3057 ((g_strcmp0(cfmt->custom_fields, def_cfmt->custom_fields) != 0) ||
3058 (cfmt->display != def_cfmt->display)))) {
3059 is_default = false0;
3060 break;
3061 }
3062
3063 pref_col = pref_col->next;
3064 def_col = def_col->next;
3065 }
3066 }
3067
3068 return is_default;
3069}
3070
3071static char *
3072column_format_to_str_cb(pref_t* pref, bool_Bool default_val)
3073{
3074 GList *pref_l = default_val ? pref->default_val.list : *pref->varp.list;
3075 GList *clp = g_list_first(pref_l);
3076 GList *col_l;
3077 fmt_data *cfmt;
3078 char *column_format_str;
3079
3080 col_l = NULL((void*)0);
3081 while (clp) {
3082 cfmt = (fmt_data *) clp->data;
3083 col_l = g_list_append(col_l, g_strdup(cfmt->title)g_strdup_inline (cfmt->title));
3084 col_l = g_list_append(col_l, column_fmt_data_to_str(cfmt));
3085 clp = clp->next;
3086 }
3087
3088 column_format_str = join_string_list(col_l);
3089 prefs_clear_string_list(col_l);
3090 return column_format_str;
3091}
3092
3093static prefs_set_pref_e
3094colorized_frame_set_cb(pref_t* pref, const char* value, unsigned int* changed_flags)
3095{
3096 (*changed_flags) |= prefs_set_string_value(pref, value, pref_current);
3097 return PREFS_SET_OK;
3098}
3099
3100static const char *
3101colorized_frame_type_name_cb(void)
3102{
3103 /* Don't write the colors of the 10 easy-access-colorfilters to the preferences
3104 * file until the colors can be changed in the GUI. Currently this is not really
3105 * possible since the STOCK-icons for these colors are hardcoded.
3106 *
3107 * XXX Find a way to change the colors of the STOCK-icons on the fly and then
3108 * add these 10 colors to the list of colors that can be changed through
3109 * the preferences.
3110 *
3111 */
3112 return NULL((void*)0);
3113}
3114
3115static char *
3116colorized_frame_type_description_cb(void)
3117{
3118 return g_strdup("")g_strdup_inline ("");
3119}
3120
3121static bool_Bool
3122colorized_frame_is_default_cb(pref_t* pref _U___attribute__((unused)))
3123{
3124 return true1;
3125}
3126
3127static char *
3128colorized_frame_to_str_cb(pref_t* pref _U___attribute__((unused)), bool_Bool default_val _U___attribute__((unused)))
3129{
3130 return g_strdup("")g_strdup_inline ("");
3131}
3132
3133/*
3134 * Register all non-dissector modules' preferences.
3135 */
3136static module_t *gui_module;
3137static module_t *gui_color_module;
3138static module_t *nameres_module;
3139static module_t *extcap_module;
3140
3141static void
3142prefs_register_modules(void)
3143{
3144 module_t *printing, *capture_module, *console_module,
3145 *gui_layout_module, *gui_font_module;
3146 unsigned int layout_gui_flags;
3147 struct pref_custom_cbs custom_cbs;
3148
3149 if (protocols_module != NULL((void*)0)) {
3150 /* Already setup preferences */
3151 return;
3152 }
3153
3154 /* Extcap
3155 * The extcap preferences used to be in the main preference file, but are
3156 * now (since 4.4.0) written separately to "extcap.cfg". It occasionally
3157 * seems to cause issues that this is registered as a top level module.
3158 */
3159 extcap_module = prefs_register_module(prefs_top_level_modules, prefs_modules, "extcap", "Extcap Utilities",
3160 "Extcap Utilities", NULL((void*)0), NULL((void*)0), false0);
3161 /* Extcap preferences don't affect dissection */
3162 prefs_set_module_effect_flags(extcap_module, PREF_EFFECT_CAPTURE(1u << 1));
3163
3164 /* Setting default value to true */
3165 prefs.extcap_save_on_start = true1;
3166 prefs_register_bool_preference(extcap_module, "gui_save_on_start",
3167 "Save arguments on start of capture",
3168 "Save arguments on start of capture",
3169 &prefs.extcap_save_on_start);
3170
3171 /* GUI
3172 * These are "simple" GUI preferences that can be read/written using the
3173 * preference module API. These preferences still use their own
3174 * configuration screens for access, but this cuts down on the
3175 * preference "string compare list" in set_pref()
3176 */
3177 gui_module = prefs_register_module(prefs_top_level_modules, prefs_modules, "gui", "User Interface",
3178 "User Interface", NULL((void*)0), &gui_callback, false0);
3179 /*
3180 * The GUI preferences don't affect dissection in general.
3181 * Any changes are signaled in other ways, so PREF_EFFECT_GUI doesn't
3182 * explicitly do anything, but wslua_set_preference expects *some*
3183 * effect flag to be set if the preference was changed.
3184 * We have to do this again for all the submodules (except for the
3185 * layout submodule, which has its own effect flag).
3186 */
3187 unsigned gui_effect_flags = prefs_get_module_effect_flags(gui_module);
3188 gui_effect_flags |= PREF_EFFECT_GUI(1u << 4);
3189 gui_effect_flags &= (~PREF_EFFECT_DISSECTION(1u << 0));
3190 prefs_set_module_effect_flags(gui_module, gui_effect_flags);
3191
3192 /*
3193 * gui.console_open is stored in the registry in addition to the
3194 * preferences file. It is also read independently by ws_log_init()
3195 * for early log initialization of the console.
3196 */
3197 prefs_register_enum_preference(gui_module, "console_open",
3198 "Open a console window",
3199 "Open a console window (Windows only)",
3200 (int *)&ws_log_console_open, gui_console_open_type, false0);
3201
3202 prefs_register_obsolete_preference(gui_module, "scrollbar_on_right");
3203 prefs_register_obsolete_preference(gui_module, "packet_list_sel_browse");
3204 prefs_register_obsolete_preference(gui_module, "protocol_tree_sel_browse");
3205 prefs_register_obsolete_preference(gui_module, "tree_view_altern_colors");
3206 prefs_register_obsolete_preference(gui_module, "expert_composite_eyecandy");
3207 prefs_register_obsolete_preference(gui_module, "filter_toolbar_show_in_statusbar");
3208 prefs_register_obsolete_preference(gui_module, "restore_filter_after_following_stream");
3209
3210 prefs_register_obsolete_preference(gui_module, "protocol_tree_line_style");
3211
3212 prefs_register_obsolete_preference(gui_module, "protocol_tree_expander_style");
3213
3214 prefs_register_obsolete_preference(gui_module, "hex_dump_highlight_style");
3215
3216 prefs_register_obsolete_preference(gui_module, "packet_editor.enabled");
3217
3218 gui_column_module = prefs_register_subtree(gui_module, prefs_modules, "Columns", "Columns", NULL((void*)0));
3219 prefs_set_module_effect_flags(gui_column_module, gui_effect_flags);
3220 /* For reading older preference files with "column." preferences */
3221 prefs_register_module_alias("column", gui_column_module);
3222
3223
3224 custom_cbs.free_cb = free_string_like_preference;
3225 custom_cbs.reset_cb = reset_string_like_preference;
3226 custom_cbs.set_cb = column_hidden_set_cb;
3227 custom_cbs.type_name_cb = column_hidden_type_name_cb;
3228 custom_cbs.type_description_cb = column_hidden_type_description_cb;
3229 custom_cbs.is_default_cb = column_hidden_is_default_cb;
3230 custom_cbs.to_str_cb = column_hidden_to_str_cb;
3231 register_string_like_preference(gui_column_module, PRS_COL_HIDDEN"column.hide", "Packet list hidden columns",
3232 "List all column indices (1-indexed) to hide in the packet list",
3233 &cols_hidden_list, PREF_CUSTOM, &custom_cbs, false0);
3234
3235 custom_cbs.set_cb = column_hidden_fmt_set_cb;
3236 custom_cbs.type_name_cb = column_hidden_fmt_type_name_cb;
3237 custom_cbs.type_description_cb = column_hidden_fmt_type_description_cb;
3238 custom_cbs.is_default_cb = column_hidden_fmt_is_default_cb;
3239 custom_cbs.to_str_cb = column_hidden_fmt_to_str_cb;
3240
3241 register_string_like_preference(gui_column_module, PRS_COL_HIDDEN_FMT"column.hidden", "Packet list hidden column formats (deprecated)",
3242 "List all column formats to hide in the packet list; deprecated in favor of the index-based preference",
3243 &cols_hidden_fmt_list, PREF_CUSTOM, &custom_cbs, false0);
3244
3245 custom_cbs.free_cb = column_format_free_cb;
3246 custom_cbs.reset_cb = column_format_reset_cb;
3247 custom_cbs.set_cb = column_format_set_cb;
3248 custom_cbs.type_name_cb = column_format_type_name_cb;
3249 custom_cbs.type_description_cb = column_format_type_description_cb;
3250 custom_cbs.is_default_cb = column_format_is_default_cb;
3251 custom_cbs.to_str_cb = column_format_to_str_cb;
3252
3253 prefs_register_list_custom_preference(gui_column_module, PRS_COL_FMT"column.format", "Packet list column format",
3254 "Each pair of strings consists of a column title and its format", &custom_cbs,
3255 column_format_init_cb, &prefs.col_list);
3256
3257 /* Number of columns. This is only used internally and is not written to the
3258 * preference file
3259 */
3260 custom_cbs.free_cb = custom_pref_no_cb;
3261 custom_cbs.reset_cb = column_num_reset_cb;
3262 custom_cbs.set_cb = column_num_set_cb;
3263 custom_cbs.type_name_cb = column_num_type_name_cb;
3264 custom_cbs.type_description_cb = column_num_type_description_cb;
3265 custom_cbs.is_default_cb = column_num_is_default_cb;
3266 custom_cbs.to_str_cb = column_num_to_str_cb;
3267 prefs_register_uint_custom_preference(gui_column_module, PRS_COL_NUM"column.number", "Number of columns",
3268 "Number of columns in col_list", &custom_cbs, &prefs.num_cols);
3269
3270 /* User Interface : Font */
3271 gui_font_module = prefs_register_subtree(gui_module, prefs_modules, "Font", "Font", NULL((void*)0));
3272 prefs_set_module_effect_flags(gui_font_module, gui_effect_flags);
3273
3274 prefs_register_obsolete_preference(gui_font_module, "font_name");
3275
3276 prefs_register_obsolete_preference(gui_font_module, "gtk2.font_name");
3277
3278 register_string_like_preference(gui_font_module, "qt.font_name", "Font name",
3279 "Font name for packet list, protocol tree, and hex dump panes. (Qt)",
3280 &prefs.gui_font_name, PREF_STRING, NULL((void*)0), true1);
3281
3282 /* User Interface : Colors */
3283 gui_color_module = prefs_register_subtree(gui_module, prefs_modules, "Colors", "Colors", NULL((void*)0));
3284 unsigned gui_color_effect_flags = gui_effect_flags | PREF_EFFECT_GUI_COLOR(1u << 5);
3285 prefs_set_module_effect_flags(gui_color_module, gui_color_effect_flags);
3286
3287 /* The appearance mode moved to global recent_common storage
3288 (recent.gui_color_scheme) so it no longer flips when switching
3289 profiles. Keep the old per-profile key registered as obsolete so
3290 existing preferences files load without an "unknown preference"
3291 warning. */
3292 prefs_register_obsolete_preference(gui_color_module, "color_scheme");
3293
3294 custom_cbs.free_cb = free_string_like_preference;
3295 custom_cbs.reset_cb = reset_string_like_preference;
3296 custom_cbs.set_cb = colorized_frame_set_cb;
3297 custom_cbs.type_name_cb = colorized_frame_type_name_cb;
3298 custom_cbs.type_description_cb = colorized_frame_type_description_cb;
3299 custom_cbs.is_default_cb = colorized_frame_is_default_cb;
3300 custom_cbs.to_str_cb = colorized_frame_to_str_cb;
3301 register_string_like_preference(gui_column_module, "colorized_frame.fg", "Colorized Foreground",
3302 "Filter Colorized Foreground",
3303 &prefs.gui_colorized_fg, PREF_CUSTOM, &custom_cbs, true1);
3304
3305 custom_cbs.free_cb = free_string_like_preference;
3306 custom_cbs.reset_cb = reset_string_like_preference;
3307 custom_cbs.set_cb = colorized_frame_set_cb;
3308 custom_cbs.type_name_cb = colorized_frame_type_name_cb;
3309 custom_cbs.type_description_cb = colorized_frame_type_description_cb;
3310 custom_cbs.is_default_cb = colorized_frame_is_default_cb;
3311 custom_cbs.to_str_cb = colorized_frame_to_str_cb;
3312 register_string_like_preference(gui_column_module, "colorized_frame.bg", "Colorized Background",
3313 "Filter Colorized Background",
3314 &prefs.gui_colorized_bg, PREF_CUSTOM, &custom_cbs, true1);
3315
3316 prefs_register_enum_preference(gui_module, "fileopen.style",
3317 "Where to start the File Open dialog box",
3318 "Where to start the File Open dialog box",
3319 (int*)&prefs.gui_fileopen_style, gui_fileopen_style, false0);
3320
3321 prefs_register_uint_preference(gui_module, "recent_files_count.max",
3322 "The max. number of items in the open recent files list",
3323 "The max. number of items in the open recent files list",
3324 10,
3325 &prefs.gui_recent_files_count_max);
3326
3327 prefs_register_uint_preference(gui_module, "recent_display_filter_entries.max",
3328 "The max. number of entries in the display filter list",
3329 "The max. number of entries in the display filter list",
3330 10,
3331 &prefs.gui_recent_df_entries_max);
3332
3333 register_string_like_preference(gui_module, "fileopen.dir", "Start Directory",
3334 "Directory to start in when opening File Open dialog.",
3335 &prefs.gui_fileopen_dir, PREF_DIRNAME, NULL((void*)0), true1);
3336
3337 prefs_register_obsolete_preference(gui_module, "fileopen.remembered_dir");
3338
3339 prefs_register_uint_preference(gui_module, "fileopen.preview",
3340 "The preview timeout in the File Open dialog",
3341 "The preview timeout in the File Open dialog",
3342 10,
3343 &prefs.gui_fileopen_preview);
3344
3345 register_string_like_preference(gui_module, "tlskeylog_command", "Program to launch with TLS Keylog",
3346 "Program path or command line to launch with SSLKEYLOGFILE",
3347 &prefs.gui_tlskeylog_command, PREF_STRING, NULL((void*)0), true1);
3348
3349 prefs_register_bool_preference(gui_module, "ask_unsaved",
3350 "Ask to save unsaved capture files",
3351 "Ask to save unsaved capture files?",
3352 &prefs.gui_ask_unsaved);
3353
3354 prefs_register_bool_preference(gui_module, "autocomplete_filter",
3355 "Display autocompletion for filter text",
3356 "Display an autocomplete suggestion for display and capture filter controls",
3357 &prefs.gui_autocomplete_filter);
3358
3359 prefs_register_bool_preference(gui_module, "find_wrap",
3360 "Wrap to beginning/end of file during search",
3361 "Wrap to beginning/end of file during search?",
3362 &prefs.gui_find_wrap);
3363
3364 prefs_register_obsolete_preference(gui_module, "use_pref_save");
3365
3366 prefs_register_bool_preference(gui_module, "geometry.save.position",
3367 "Save window position at exit",
3368 "Save window position at exit?",
3369 &prefs.gui_geometry_save_position);
3370
3371 prefs_register_bool_preference(gui_module, "geometry.save.size",
3372 "Save window size at exit",
3373 "Save window size at exit?",
3374 &prefs.gui_geometry_save_size);
3375
3376 prefs_register_bool_preference(gui_module, "geometry.save.maximized",
3377 "Save window maximized state at exit",
3378 "Save window maximized state at exit?",
3379 &prefs.gui_geometry_save_maximized);
3380
3381 prefs_register_obsolete_preference(gui_module, "macosx_style");
3382
3383 prefs_register_obsolete_preference(gui_module, "geometry.main.x");
3384 prefs_register_obsolete_preference(gui_module, "geometry.main.y");
3385 prefs_register_obsolete_preference(gui_module, "geometry.main.width");
3386 prefs_register_obsolete_preference(gui_module, "geometry.main.height");
3387 prefs_register_obsolete_preference(gui_module, "toolbar_main_show");
3388
3389 prefs_register_enum_preference(gui_module, "toolbar_main_style",
3390 "Main Toolbar style",
3391 "Main Toolbar style",
3392 &prefs.gui_toolbar_main_style, gui_toolbar_style, false0);
3393
3394 prefs_register_obsolete_preference(gui_module, "toolbar_filter_style");
3395 prefs_register_obsolete_preference(gui_module, "webbrowser");
3396
3397 prefs_register_bool_preference(gui_module, "update.enabled",
3398 "Check for updates",
3399 "Check for updates (Windows and macOS only)",
3400 &prefs.gui_update_enabled);
3401
3402 prefs_register_enum_preference(gui_module, "update.channel",
3403 "Update channel",
3404 "The type of update to fetch. You should probably leave this set to STABLE.",
3405 (int*)(void*)(&prefs.gui_update_channel), gui_update_channel, false0);
3406
3407 prefs_register_uint_preference(gui_module, "update.interval",
3408 "How often to check for software updates",
3409 "How often to check for software updates in seconds",
3410 10,
3411 &prefs.gui_update_interval);
3412
3413 prefs_register_uint_preference(gui_module, "debounce.timer",
3414 "How long to wait before processing computationally intensive user input",
3415 "How long to wait (in milliseconds) before processing "
3416 "computationally intensive user input. "
3417 "If you type quickly, consider lowering the value for a 'snappier' "
3418 "experience. "
3419 "If you type slowly, consider increasing the value to avoid performance issues. "
3420 "This is currently used to delay searches in View -> Internals -> Supported Protocols "
3421 "and Preferences -> Advanced menu.",
3422 10,
3423 &prefs.gui_debounce_timer);
3424
3425 register_string_like_preference(gui_module, "window_title", "Custom window title",
3426 "Custom window title to be appended to the existing title\n"
3427 "%C = capture comment from command line\n"
3428 "%F = file path of the capture file\n"
3429 "%P = profile name\n"
3430 "%S = a conditional separator (\" - \") that only shows when surrounded by variables with values or static text\n"
3431 "%V = version info",
3432 &prefs.gui_window_title, PREF_STRING, NULL((void*)0), true1);
3433
3434 register_string_like_preference(gui_module, "prepend_window_title", "Custom window title prefix",
3435 "Custom window title to be prepended to the existing title\n"
3436 "%C = capture comment from command line\n"
3437 "%F = file path of the capture file\n"
3438 "%P = profile name\n"
3439 "%S = a conditional separator (\" - \") that only shows when surrounded by variables with values or static text\n"
3440 "%V = version info",
3441 &prefs.gui_prepend_window_title, PREF_STRING, NULL((void*)0), true1);
3442
3443 register_string_like_preference(gui_module, "start_title", "Custom start page title",
3444 "Custom start page title",
3445 &prefs.gui_start_title, PREF_STRING, NULL((void*)0), true1);
3446
3447 prefs_register_enum_preference(gui_module, "version_placement",
3448 "Show version in the start page and/or main screen's title bar",
3449 "Show version in the start page and/or main screen's title bar",
3450 (int*)(void*)(&prefs.gui_version_placement), gui_version_placement_type, false0);
3451
3452 prefs_register_obsolete_preference(gui_module, "auto_scroll_on_expand");
3453 prefs_register_obsolete_preference(gui_module, "auto_scroll_percentage");
3454
3455 prefs_register_uint_preference(gui_module, "max_export_objects",
3456 "Maximum number of exported objects",
3457 "The maximum number of objects that can be exported",
3458 10,
3459 &prefs.gui_max_export_objects);
3460 prefs_register_uint_preference(gui_module, "max_tree_items",
3461 "Maximum number of tree items",
3462 "The maximum number of items that can be added to the dissection tree (Increase with caution)",
3463 10,
3464 &prefs.gui_max_tree_items);
3465 /*
3466 * Used independently by proto_tree_add_node, call_dissector*, dissector_try_heuristic,
3467 * and increment_dissection_depth.
3468 */
3469 prefs_register_uint_preference(gui_module, "max_tree_depth",
3470 "Maximum dissection depth",
3471 "The maximum depth for dissection tree and protocol layer checks. (Increase with caution)",
3472 10,
3473 &prefs.gui_max_tree_depth);
3474
3475 prefs_register_bool_preference(gui_module, "welcome_page.show_recent",
3476 "Show recent files on the welcome page",
3477 "This will enable or disable the 'Open' list on the welcome page.",
3478 &prefs.gui_welcome_page_show_recent);
3479
3480 /* User Interface : Layout */
3481 gui_layout_module = prefs_register_subtree(gui_module, prefs_modules, "Layout", "Layout", gui_layout_callback);
3482 /* Adjust the preference effects of layout GUI for better handling of preferences at Wireshark (GUI) level */
3483 layout_gui_flags = prefs_get_module_effect_flags(gui_layout_module);
3484 layout_gui_flags |= PREF_EFFECT_GUI_LAYOUT(1u << 2);
3485 layout_gui_flags &= (~PREF_EFFECT_DISSECTION(1u << 0));
3486
3487 prefs_register_uint_preference(gui_layout_module, "layout_type",
3488 "Layout type",
3489 "Layout type (1-6)",
3490 10,
3491 (unsigned*)(void*)(&prefs.gui_layout_type));
3492 prefs_set_effect_flags_by_name(gui_layout_module, "layout_type", layout_gui_flags);
3493
3494 prefs_register_enum_preference(gui_layout_module, "layout_content_1",
3495 "Layout content of the pane 1",
3496 "Layout content of the pane 1",
3497 (int*)(void*)(&prefs.gui_layout_content_1), gui_layout_content, false0);
3498 prefs_set_effect_flags_by_name(gui_layout_module, "layout_content_1", layout_gui_flags);
3499
3500 prefs_register_enum_preference(gui_layout_module, "layout_content_2",
3501 "Layout content of the pane 2",
3502 "Layout content of the pane 2",
3503 (int*)(void*)(&prefs.gui_layout_content_2), gui_layout_content, false0);
3504 prefs_set_effect_flags_by_name(gui_layout_module, "layout_content_2", layout_gui_flags);
3505
3506 prefs_register_enum_preference(gui_layout_module, "layout_content_3",
3507 "Layout content of the pane 3",
3508 "Layout content of the pane 3",
3509 (int*)(void*)(&prefs.gui_layout_content_3), gui_layout_content, false0);
3510 prefs_set_effect_flags_by_name(gui_layout_module, "layout_content_3", layout_gui_flags);
3511
3512 prefs_register_bool_preference(gui_layout_module, "packet_list_separator.enabled",
3513 "Enable Packet List Separator",
3514 "Enable Packet List Separator",
3515 &prefs.gui_packet_list_separator);
3516
3517 prefs_register_bool_preference(gui_layout_module, "packet_header_column_definition.enabled",
3518 "Show column definition in packet list header",
3519 "Show column definition in packet list header",
3520 &prefs.gui_packet_header_column_definition);
3521
3522 /* packet_list_hover_style affects the colors, not the layout.
3523 * It's in the layout module to group it with the other packet list
3524 * preferences for the user's benefit with the dialog.
3525 */
3526 prefs_register_bool_preference(gui_layout_module, "packet_list_hover_style.enabled",
3527 "Enable Packet List mouse-over colorization",
3528 "Enable Packet List mouse-over colorization",
3529 &prefs.gui_packet_list_hover_style);
3530 prefs_set_effect_flags_by_name(gui_layout_module, "packet_list_hover_style.enabled", gui_color_effect_flags);
3531
3532 prefs_register_bool_preference(gui_layout_module, "show_selected_packet.enabled",
3533 "Show selected packet in the Status Bar",
3534 "Show selected packet in the Status Bar",
3535 &prefs.gui_show_selected_packet);
3536
3537 prefs_register_bool_preference(gui_layout_module, "show_file_load_time.enabled",
3538 "Show file load time in the Status Bar",
3539 "Show file load time in the Status Bar",
3540 &prefs.gui_show_file_load_time);
3541
3542 prefs_register_enum_preference(gui_layout_module, "packet_dialog_layout",
3543 "Packet Dialog layout",
3544 "Packet Dialog layout",
3545 (int*)(&prefs.gui_packet_dialog_layout), gui_packet_dialog_layout, false0);
3546
3547 prefs_register_enum_preference(gui_module, "packet_list_elide_mode",
3548 "Elide mode",
3549 "The position of \"...\" (ellipsis) in packet list text.",
3550 (int*)(void*)(&prefs.gui_packet_list_elide_mode), gui_packet_list_elide_mode, false0);
3551 prefs_register_uint_preference(gui_module, "decimal_places1",
3552 "Count of decimal places for values of type 1",
3553 "Sets the count of decimal places for values of type 1."
3554 "Type 1 values are defined by authors."
3555 "Value can be in range 2 to 10.",
3556 10,&prefs.gui_decimal_places1);
3557
3558 prefs_register_uint_preference(gui_module, "decimal_places2",
3559 "Count of decimal places for values of type 2",
3560 "Sets the count of decimal places for values of type 2."
3561 "Type 2 values are defined by authors."
3562 "Value can be in range 2 to 10.",
3563 10,&prefs.gui_decimal_places2);
3564
3565 prefs_register_uint_preference(gui_module, "decimal_places3",
3566 "Count of decimal places for values of type 3",
3567 "Sets the count of decimal places for values of type 3."
3568 "Type 3 values are defined by authors."
3569 "Value can be in range 2 to 10.",
3570 10,&prefs.gui_decimal_places3);
3571
3572 prefs_register_bool_preference(gui_module, "rtp_player_use_disk1",
3573 "RTP Player saves temporary data to disk",
3574 "If set to true, RTP Player saves temporary data to "
3575 "temp files on disk. If not set, it uses memory."
3576 "Every stream uses one file therefore you might touch "
3577 "OS limit for count of opened files."
3578 "When ui.rtp_player_use_disk2 is set to true too, it uses "
3579 " two files per RTP stream together."
3580 ,&prefs.gui_rtp_player_use_disk1);
3581
3582 prefs_register_bool_preference(gui_module, "rtp_player_use_disk2",
3583 "RTP Player saves temporary dictionary for data to disk",
3584 "If set to true, RTP Player saves temporary dictionary to "
3585 "temp files on disk. If not set, it uses memory."
3586 "Every stream uses one file therefore you might touch "
3587 "OS limit for count of opened files."
3588 "When ui.rtp_player_use_disk1 is set to true too, it uses "
3589 " two files per RTP stream."
3590 ,&prefs.gui_rtp_player_use_disk2);
3591
3592 prefs_register_enum_preference(gui_layout_module, "gui_packet_list_copy_format_options_for_keyboard_shortcut",
3593 "Allows text to be copied with selected format",
3594 "Allows text to be copied with selected format when copied via keyboard",
3595 (int*)(void*)(&prefs.gui_packet_list_copy_format_options_for_keyboard_shortcut),
3596 gui_packet_list_copy_format_options_for_keyboard_shortcut, false0);
3597
3598 prefs_register_bool_preference(gui_layout_module, "gui_packet_list_copy_text_with_aligned_columns",
3599 "Allows text to be copied with aligned columns",
3600 "Allows text to be copied with aligned columns when copied via menu or keyboard",
3601 &prefs.gui_packet_list_copy_text_with_aligned_columns);
3602
3603 prefs_register_bool_preference(gui_layout_module, "packet_list_show_related",
3604 "Show Related Packets",
3605 "Show related packet indicators in the first column",
3606 &prefs.gui_packet_list_show_related);
3607
3608 prefs_register_bool_preference(gui_layout_module, "packet_list_show_minimap",
3609 "Enable Intelligent Scroll Bar",
3610 "Show the intelligent scroll bar (a minimap of packet list colors in the scrollbar)",
3611 &prefs.gui_packet_list_show_minimap);
3612 prefs_set_effect_flags_by_name(gui_layout_module, "packet_list_show_minimap", gui_color_effect_flags);
3613
3614 prefs_register_enum_preference(gui_layout_module, "packet_list_multi_color_mode",
3615 "Multi-Color Display Mode",
3616 "How to display multiple colors: Equal Stripes (entire row) or Shift Right (configurable primary color percentage)",
3617 (int*)(void*)(&prefs.gui_packet_list_multi_color_mode), gui_packet_list_multi_color_modes, false0);
3618 prefs_set_effect_flags_by_name(gui_layout_module, "packet_list_multi_color_mode", gui_color_effect_flags);
3619
3620 prefs_register_uint_preference(gui_layout_module, "packet_list_multi_color_shift_percent",
3621 "Shift Right percentage",
3622 "Primary color percentage in Shift Right mode (75, 80, 85, 90, or 95)",
3623 10,
3624 &prefs.gui_packet_list_multi_color_shift_percent);
3625 prefs_set_effect_flags_by_name(gui_layout_module, "packet_list_multi_color_shift_percent", gui_color_effect_flags);
3626
3627 prefs_register_bool_preference(gui_module, "packet_list_multi_color_details",
3628 "Display Multiple Colors in Packet Details",
3629 "Show all matching color filter names in packet details pane and TShark output when multiple color filters match",
3630 &prefs.gui_packet_list_multi_color_details);
3631 /* This preference affects what is shown in the packet detail proto tree,
3632 * so changing it requires re-dissection to take effect immediately. */
3633 prefs_set_preference_effect(gui_module, "packet_list_multi_color_details",
3634 PREF_EFFECT_DISSECTION(1u << 0));
3635
3636 prefs_register_enum_preference(gui_layout_module, "packet_list_multi_color_separator",
3637 "Color Stripe Separator Style",
3638 "Shape of the boundary between color stripes: Vertical, Diagonal (candy-cane), or Bubble (half-moon)",
3639 (int*)(void*)(&prefs.gui_packet_list_multi_color_separator), gui_packet_list_multi_color_separators, false0);
3640 prefs_set_effect_flags_by_name(gui_layout_module, "packet_list_multi_color_separator", gui_color_effect_flags);
3641
3642 prefs_register_bool_preference(gui_module, "packet_list_is_sortable",
3643 "Allow packet list to be sortable",
3644 "To prevent sorting by mistake (which can take some time to calculate), it can be disabled",
3645 &prefs.gui_packet_list_sortable);
3646
3647 prefs_register_uint_preference(gui_module, "packet_list_cached_rows_max",
3648 "Maximum cached rows",
3649 "Maximum number of rows that can be sorted by columns that require dissection. Increasing this increases memory consumption by caching column text",
3650 10,
3651 &prefs.gui_packet_list_cached_rows_max);
3652
3653 prefs_register_bool_preference(gui_module, "interfaces_show_hidden",
3654 "Show hidden interfaces",
3655 "Show all interfaces, including interfaces marked as hidden",
3656 &prefs.gui_interfaces_show_hidden);
3657
3658 prefs_register_bool_preference(gui_module, "interfaces_remote_display",
3659 "Show Remote interfaces",
3660 "Show remote interfaces in the interface selection",
3661 &prefs.gui_interfaces_remote_display);
3662
3663 register_string_like_preference(gui_module, "interfaces_hidden_types", "Hide interface types in list",
3664 "Hide the given interface types in the startup list.\n"
3665 "A comma-separated string of interface type values (e.g. 5,9).\n"
3666 "0 = Wired,\n"
3667 "1 = AirPCAP,\n"
3668 "2 = Pipe,\n"
3669 "3 = STDIN,\n"
3670 "4 = Bluetooth,\n"
3671 "5 = Wireless,\n"
3672 "6 = Dial-Up,\n"
3673 "7 = USB,\n"
3674 "8 = External Capture,\n"
3675 "9 = Virtual",
3676 &prefs.gui_interfaces_hide_types, PREF_STRING, NULL((void*)0), true1);
3677
3678 prefs_register_bool_preference(gui_module, "io_graph_automatic_update",
3679 "Enables automatic updates for IO Graph",
3680 "Enables automatic updates for IO Graph",
3681 &prefs.gui_io_graph_automatic_update);
3682
3683 prefs_register_bool_preference(gui_module, "io_graph_enable_legend",
3684 "Enables the legend of IO Graph",
3685 "Enables the legend of IO Graph",
3686 &prefs.gui_io_graph_enable_legend);
3687
3688 prefs_register_bool_preference(gui_module, "plot_automatic_update",
3689 "Enables automatic updates for Plot",
3690 "Enables automatic updates for Plot",
3691 &prefs.gui_plot_automatic_update);
3692
3693 prefs_register_bool_preference(gui_module, "plot_enable_legend",
3694 "Enables the legend of Plot",
3695 "Enables the legend of Plot",
3696 &prefs.gui_plot_enable_legend);
3697
3698 prefs_register_bool_preference(gui_module, "plot_enable_auto_scroll",
3699 "Enables auto scroll of Plot",
3700 "Enables auto scroll of Plot",
3701 &prefs.gui_plot_enable_auto_scroll);
3702
3703 prefs_register_bool_preference(gui_module, "show_byteview_in_dialog",
3704 "Show the byte view in the packet details dialog",
3705 "Show the byte view in the packet details dialog",
3706 &prefs.gui_packet_details_show_byteview);
3707
3708 /* Console
3709 * These are preferences that can be read/written using the
3710 * preference module API. These preferences still use their own
3711 * configuration screens for access, but this cuts down on the
3712 * preference "string compare list" in set_pref()
3713 */
3714 console_module = prefs_register_module(prefs_top_level_modules, prefs_modules, "console", "Console",
3715 "Console logging and debugging output", NULL((void*)0), NULL((void*)0), false0);
3716
3717 prefs_register_obsolete_preference(console_module, "log.level");
3718
3719 prefs_register_bool_preference(console_module, "incomplete_dissectors_check_debug",
3720 "Print debug line for incomplete dissectors",
3721 "Look for dissectors that left some bytes undecoded (debug)",
3722 &prefs.incomplete_dissectors_check_debug);
3723
3724 /* Display filter Expressions
3725 * This used to be an array of individual fields that has now been
3726 * converted to a UAT. Just make it part of the GUI category even
3727 * though the name of the preference will never be seen in preference
3728 * file
3729 */
3730 filter_expression_register_uat(gui_module);
3731
3732 /* Capture
3733 * These are preferences that can be read/written using the
3734 * preference module API. These preferences still use their own
3735 * configuration screens for access, but this cuts down on the
3736 * preference "string compare list" in set_pref()
3737 */
3738 capture_module = prefs_register_module(prefs_top_level_modules, prefs_modules, "capture", "Capture",
3739 "Capture preferences", NULL((void*)0), apply_aggregation_prefs, false0);
3740 /* Capture preferences don't affect dissection */
3741 prefs_set_module_effect_flags(capture_module, PREF_EFFECT_CAPTURE(1u << 1));
3742
3743 register_string_like_preference(capture_module, "device", "Default capture device",
3744 "Default capture device",
3745 &prefs.capture_device, PREF_STRING, NULL((void*)0), false0);
3746
3747 register_string_like_preference(capture_module, "devices_linktypes", "Interface link-layer header type",
3748 "Interface link-layer header types (Ex: en0(1),en1(143),...)",
3749 &prefs.capture_devices_linktypes, PREF_STRING, NULL((void*)0), false0);
3750
3751 register_string_like_preference(capture_module, "devices_descr", "Interface descriptions",
3752 "Interface descriptions (Ex: eth0(eth0 descr),eth1(eth1 descr),...)",
3753 &prefs.capture_devices_descr, PREF_STRING, NULL((void*)0), false0);
3754
3755 register_string_like_preference(capture_module, "devices_hide", "Hide interface",
3756 "Hide interface? (Ex: eth0,eth3,...)",
3757 &prefs.capture_devices_hide, PREF_STRING, NULL((void*)0), false0);
3758
3759 register_string_like_preference(capture_module, "devices_monitor_mode", "Capture in monitor mode",
3760 "By default, capture in monitor mode on interface? (Ex: eth0,eth3,...)",
3761 &prefs.capture_devices_monitor_mode, PREF_STRING, NULL((void*)0), false0);
3762
3763 register_string_like_preference(capture_module, "devices_buffersize", "Interface buffer size",
3764 "Interface buffer size (Ex: en0(1),en1(143),...)",
3765 &prefs.capture_devices_buffersize, PREF_STRING, NULL((void*)0), false0);
3766
3767 register_string_like_preference(capture_module, "devices_snaplen", "Interface snap length",
3768 "Interface snap length (Ex: en0(65535),en1(1430),...)",
3769 &prefs.capture_devices_snaplen, PREF_STRING, NULL((void*)0), false0);
3770
3771 register_string_like_preference(capture_module, "devices_pmode", "Interface promiscuous mode",
3772 "Interface promiscuous mode (Ex: en0(0),en1(1),...)",
3773 &prefs.capture_devices_pmode, PREF_STRING, NULL((void*)0), false0);
3774
3775 prefs_register_bool_preference(capture_module, "prom_mode", "Capture in promiscuous mode",
3776 "Capture in promiscuous mode?", &prefs.capture_prom_mode);
3777
3778 prefs_register_bool_preference(capture_module, "monitor_mode", "Capture in monitor mode on 802.11 devices",
3779 "Capture in monitor mode on all 802.11 devices that support it?", &prefs.capture_monitor_mode);
3780
3781 register_string_like_preference(capture_module, "devices_filter", "Interface capture filter",
3782 "Interface capture filter (Ex: en0(tcp),en1(udp),...)",
3783 &prefs.capture_devices_filter, PREF_STRING, NULL((void*)0), false0);
3784
3785 prefs_register_bool_preference(capture_module, "pcap_ng", "Capture in pcapng format",
3786 "Capture in pcapng format?", &prefs.capture_pcap_ng);
3787
3788 prefs_register_enum_preference(capture_module, "process_info", "Record the processes that packets belong to",
3789 "What to record, in pcapng files, of the processes on this host that sent or received each packet."
3790 " Paths, command lines and user names can be sensitive.",
3791 (int*)(void*)(&prefs.capture_process_info), capture_process_info_vals, false0);
3792
3793 prefs_register_bool_preference(capture_module, "real_time_update", "Update packet list in real time during capture",
3794 "Update packet list in real time during capture?", &prefs.capture_real_time);
3795
3796 prefs_register_uint_preference(capture_module, "update_interval",
3797 "Capture update interval",
3798 "Capture update interval in ms",
3799 10,
3800 &prefs.capture_update_interval);
3801
3802 prefs_register_directory_preference(capture_module, "temp_dir", "Temporary directory",
3803 "Directory in which to write temporary capture files. Leave empty to use the "
3804 "system default (the TMPDIR environment variable, or /tmp). A directory chosen in "
3805 "the Capture Options dialog is saved here. Overridden by the --temp-dir option.",
3806 (const char **)&prefs.capture_temp_dir);
3807
3808 prefs_register_bool_preference(capture_module, "no_interface_load", "Don't load interfaces on startup",
3809 "Don't automatically load capture interfaces on startup", &prefs.capture_no_interface_load);
3810
3811 prefs_register_bool_preference(capture_module, "no_extcap", "Disable external capture interfaces",
3812 "Disable external capture modules (extcap)", &prefs.capture_no_extcap);
3813
3814 prefs_register_obsolete_preference(capture_module, "auto_scroll");
3815
3816 prefs_register_bool_preference(capture_module, "show_info", "Show capture information dialog while capturing",
3817 "Show capture information dialog while capturing?", &prefs.capture_show_info);
3818
3819 prefs_register_obsolete_preference(capture_module, "syntax_check_filter");
3820
3821 prefs_register_obsolete_preference(capture_module, "columns");
3822
3823 aggregation_field_register_uat(capture_module);
3824
3825 /* Name Resolution */
3826 nameres_module = prefs_register_module(prefs_top_level_modules, prefs_modules, "nameres", "Name Resolution",
3827 "Name Resolution", "ChCustPreferencesSection.html#ChCustPrefsNameSection", addr_resolve_pref_apply, true1);
3828 addr_resolve_pref_init(nameres_module);
3829 oid_pref_init(nameres_module);
3830 maxmind_db_pref_init(nameres_module);
3831
3832 /* Printing
3833 * None of these have any effect; we keep them as obsolete preferences
3834 * in order to avoid errors when reading older preference files.
3835 */
3836 printing = prefs_register_module(prefs_top_level_modules, prefs_modules, "print", "Printing",
3837 "Printing", NULL((void*)0), NULL((void*)0), false0);
3838 prefs_register_obsolete_preference(printing, "format");
3839 prefs_register_obsolete_preference(printing, "command");
3840 prefs_register_obsolete_preference(printing, "file");
3841
3842 /* Codecs */
3843 codecs_module = prefs_register_module(prefs_top_level_modules, prefs_modules, "codecs", "Codecs",
3844 "Codecs", NULL((void*)0), NULL((void*)0), true1);
3845
3846 /* Statistics */
3847 stats_module = prefs_register_module(prefs_top_level_modules, prefs_modules, "statistics", "Statistics",
3848 "Statistics", "ChCustPreferencesSection.html#_statistics", &stats_callback, true1);
3849
3850 prefs_register_uint_preference(stats_module, "update_interval",
3851 "Tap update interval in ms",
3852 "Determines time between tap updates",
3853 10,
3854 &prefs.tap_update_interval);
3855
3856 prefs_register_uint_preference(stats_module, "flow_graph_max_export_items",
3857 "Maximum Flow Graph items to export as image",
3858 "The maximum number of Flow Graph items (frames) "
3859 "to include when exporting the graph as an image. "
3860 "Note that some formats (e.g., JPEG) have inherent "
3861 "pixel limits and image viewers might be unable to "
3862 "handle very large images.",
3863 10,
3864 &prefs.flow_graph_max_export_items);
3865
3866 prefs_register_bool_preference(stats_module, "st_enable_burstinfo",
3867 "Enable the calculation of burst information",
3868 "If enabled burst rates will be calculated for statistics that use the stats_tree system. "
3869 "Burst rates are calculated over a much shorter time interval than the rate column.",
3870 &prefs.st_enable_burstinfo);
3871
3872 prefs_register_bool_preference(stats_module, "st_burst_showcount",
3873 "Show burst count for item rather than rate",
3874 "If selected the stats_tree statistics nodes will show the count of events "
3875 "within the burst window instead of a burst rate. Burst rate is calculated "
3876 "as number of events within burst window divided by the burst windown length.",
3877 &prefs.st_burst_showcount);
3878
3879 prefs_register_uint_preference(stats_module, "st_burst_resolution",
3880 "Burst rate resolution (ms)",
3881 "Sets the duration of the time interval into which events are grouped when calculating "
3882 "the burst rate. Higher resolution (smaller number) increases processing overhead.",
3883 10,&prefs.st_burst_resolution);
3884
3885 prefs_register_uint_preference(stats_module, "st_burst_windowlen",
3886 "Burst rate window size (ms)",
3887 "Sets the duration of the sliding window during which the burst rate is "
3888 "measured. Longer window relative to burst rate resolution increases "
3889 "processing overhead. Will be truncated to a multiple of burst resolution.",
3890 10,&prefs.st_burst_windowlen);
3891
3892 prefs_register_enum_preference(stats_module, "st_sort_defcolflag",
3893 "Default sort column for stats_tree stats",
3894 "Sets the default column by which stats based on the stats_tree "
3895 "system is sorted.",
3896 &prefs.st_sort_defcolflag, st_sort_col_vals, false0);
3897
3898 prefs_register_bool_preference(stats_module, "st_sort_defdescending",
3899 "Default stats_tree sort order is descending",
3900 "When selected, statistics based on the stats_tree system will by default "
3901 "be sorted in descending order.",
3902 &prefs.st_sort_defdescending);
3903
3904 prefs_register_bool_preference(stats_module, "st_sort_casesensitve",
3905 "Case sensitive sort of stats_tree item names",
3906 "When selected, the item/node names of statistics based on the stats_tree "
3907 "system will be sorted taking case into account. Else the case of the name "
3908 "will be ignored.",
3909 &prefs.st_sort_casesensitve);
3910
3911 prefs_register_bool_preference(stats_module, "st_sort_rng_nameonly",
3912 "Always sort 'range' nodes by name",
3913 "When selected, the stats_tree nodes representing a range of values "
3914 "(0-49, 50-100, etc.) will always be sorted by name (the range of the "
3915 "node). Else range nodes are sorted by the same column as the rest of "
3916 " the tree.",
3917 &prefs.st_sort_rng_nameonly);
3918
3919 prefs_register_bool_preference(stats_module, "st_sort_rng_fixorder",
3920 "Always sort 'range' nodes in ascending order",
3921 "When selected, the stats_tree nodes representing a range of values "
3922 "(0-49, 50-100, etc.) will always be sorted ascending; else it follows "
3923 "the sort direction of the tree. Only effective if \"Always sort "
3924 "'range' nodes by name\" is also selected.",
3925 &prefs.st_sort_rng_fixorder);
3926
3927 prefs_register_bool_preference(stats_module, "st_sort_showfullname",
3928 "Display the full stats_tree plug-in name",
3929 "When selected, the full name (including menu path) of the stats_tree "
3930 "plug-in is show in windows. If cleared the plug-in name is shown "
3931 "without menu path (only the part of the name after last '/' character.)",
3932 &prefs.st_sort_showfullname);
3933
3934 prefs_register_enum_preference(stats_module, "output_format",
3935 "Default output format",
3936 "Sets the default output format for statistical data. Only supported "
3937 "by taps using the stats_tree system currently; other taps may honor "
3938 "this preference in the future. ",
3939 &prefs.st_format, st_format_vals, false0);
3940
3941 module_t *conv_module;
3942 // avoid using prefs_register_stat to prevent lint complaint about recursion
3943 conv_module = prefs_register_submodule(stats_module, prefs_modules, "conv", "Conversations",
3944 "Conversations & Endpoints", NULL((void*)0), NULL((void*)0), true1);
3945 prefs_register_bool_preference(conv_module, "machine_readable",
3946 "Display exact (machine-readable) byte counts",
3947 "When enabled, exact machine-readable byte counts are displayed. "
3948 "When disabled, human readable numbers with SI prefixes are displayed.",
3949 &prefs.conv_machine_readable);
3950
3951 /* Protocols */
3952 protocols_module = prefs_register_module(prefs_top_level_modules, prefs_modules, "protocols", "Protocols",
3953 "Protocols", "ChCustPreferencesSection.html#ChCustPrefsProtocolsSection", NULL((void*)0), true1);
3954
3955 prefs_register_bool_preference(protocols_module, "display_hidden_proto_items",
3956 "Display hidden protocol items",
3957 "Display all hidden protocol items in the packet list.",
3958 &prefs.display_hidden_proto_items);
3959
3960 prefs_register_bool_preference(protocols_module, "display_byte_fields_with_spaces",
3961 "Display byte fields with a space character between bytes",
3962 "Display all byte fields with a space character between each byte in the packet list.",
3963 &prefs.display_byte_fields_with_spaces);
3964
3965 /*
3966 * Note the -t / option only affects the display of the packet timestamp
3967 * in the default time column; this is for all other absolute times.
3968 */
3969 prefs_register_enum_preference(protocols_module, "display_abs_time_ascii",
3970 "Format absolute times like asctime",
3971 "When to format absolute times similar to asctime instead of ISO 8601, for backwards compatibility with older Wireshark.",
3972 (int*)&prefs.display_abs_time_ascii, abs_time_format_options, false0);
3973
3974 prefs_register_bool_preference(protocols_module, "enable_incomplete_dissectors_check",
3975 "Look for incomplete dissectors",
3976 "Look for dissectors that left some bytes undecoded.",
3977 &prefs.enable_incomplete_dissectors_check);
3978
3979 prefs_register_bool_preference(protocols_module, "strict_conversation_tracking_heuristics",
3980 "Enable stricter conversation tracking heuristics",
3981 "Protocols may use things like VLAN ID or interface ID to narrow the potential for duplicate conversations. "
3982 "Currently ICMP and ICMPv6 use this preference to add VLAN ID to conversation tracking, and IPv4 uses this preference to take VLAN ID into account during reassembly",
3983 &prefs.strict_conversation_tracking_heuristics);
3984
3985 prefs_register_bool_preference(protocols_module, "ignore_dup_frames",
3986 "Ignore duplicate frames",
3987 "Ignore frames that are exact duplicates of any previous frame.",
3988 &prefs.ignore_dup_frames);
3989
3990 prefs_register_enum_preference(protocols_module, "conversation_deinterlacing_key",
3991 "Deinterlacing conversations key",
3992 "Separate into different conversations frames that look like duplicates but have different Interface, MAC, or VLAN field values.",
3993 (int *)&prefs.conversation_deinterlacing_key, conv_deint_options, false0);
3994
3995 prefs_register_uint_preference(protocols_module, "ignore_dup_frames_cache_entries",
3996 "The max number of hashes to keep in memory for determining duplicates frames",
3997 "If \"Ignore duplicate frames\" is set, this setting sets the maximum number "
3998 "of cache entries to maintain. A 0 means no limit.",
3999 10, &prefs.ignore_dup_frames_cache_entries);
4000
4001
4002 /* Obsolete preferences
4003 * These "modules" were reorganized/renamed to correspond to their GUI
4004 * configuration screen within the preferences dialog
4005 */
4006
4007 /* taps is now part of the stats module */
4008 prefs_register_module(prefs_top_level_modules, prefs_modules, "taps", "TAPS", "TAPS", NULL((void*)0), NULL((void*)0), false0);
4009 /* packet_list is now part of the protocol (parent) module */
4010 prefs_register_module(prefs_top_level_modules, prefs_modules, "packet_list", "PACKET_LIST", "PACKET_LIST", NULL((void*)0), NULL((void*)0), false0);
4011 /* stream is now part of the gui module */
4012 prefs_register_module(prefs_top_level_modules, prefs_modules, "stream", "STREAM", "STREAM", NULL((void*)0), NULL((void*)0), false0);
4013
4014}
4015
4016/* Parse through a list of comma-separated, possibly quoted strings.
4017 Return a list of the string data. */
4018GList *
4019prefs_get_string_list(const char *str)
4020{
4021 enum { PRE_STRING, IN_QUOT, NOT_IN_QUOT };
4022
4023 int state = PRE_STRING, i = 0;
4024 bool_Bool backslash = false0;
4025 unsigned char cur_c;
4026 const size_t default_size = 64;
4027 GString *slstr = NULL((void*)0);
4028 GList *sl = NULL((void*)0);
4029
4030 /* Allocate a buffer for the first string. */
4031 slstr = g_string_sized_new(default_size);
4032
4033 for (;;) {
4034 cur_c = str[i];
4035 if (cur_c == '\0') {
4036 /* It's the end of the input, so it's the end of the string we
4037 were working on, and there's no more input. */
4038 if (state == IN_QUOT || backslash) {
4039 /* We were in the middle of a quoted string or backslash escape,
4040 and ran out of characters; that's an error. */
4041 g_string_free(slstr, TRUE)(__builtin_constant_p ((!(0))) ? (((!(0))) ? (g_string_free) (
(slstr), ((!(0)))) : g_string_free_and_steal (slstr)) : (g_string_free
) ((slstr), ((!(0)))))
;
4042 prefs_clear_string_list(sl);
4043 return NULL((void*)0);
4044 }
4045 if (slstr->len > 0)
4046 sl = g_list_append(sl, g_string_free(slstr, FALSE)(__builtin_constant_p ((0)) ? (((0)) ? (g_string_free) ((slstr
), ((0))) : g_string_free_and_steal (slstr)) : (g_string_free
) ((slstr), ((0))))
);
4047 else
4048 g_string_free(slstr, TRUE)(__builtin_constant_p ((!(0))) ? (((!(0))) ? (g_string_free) (
(slstr), ((!(0)))) : g_string_free_and_steal (slstr)) : (g_string_free
) ((slstr), ((!(0)))))
;
4049 break;
4050 }
4051 if (cur_c == '"' && !backslash) {
4052 switch (state) {
4053 case PRE_STRING:
4054 /* We hadn't yet started processing a string; this starts the
4055 string, and we're now quoting. */
4056 state = IN_QUOT;
4057 break;
4058 case IN_QUOT:
4059 /* We're in the middle of a quoted string, and we saw a quotation
4060 mark; we're no longer quoting. */
4061 state = NOT_IN_QUOT;
4062 break;
4063 case NOT_IN_QUOT:
4064 /* We're working on a string, but haven't seen a quote; we're
4065 now quoting. */
4066 state = IN_QUOT;
4067 break;
4068 default:
4069 break;
4070 }
4071 } else if (cur_c == '\\' && !backslash) {
4072 /* We saw a backslash, and the previous character wasn't a
4073 backslash; escape the next character.
4074
4075 This also means we've started a new string. */
4076 backslash = true1;
4077 if (state == PRE_STRING)
4078 state = NOT_IN_QUOT;
4079 } else if (cur_c == ',' && state != IN_QUOT && !backslash) {
4080 /* We saw a comma, and we're not in the middle of a quoted string
4081 and it wasn't preceded by a backslash; it's the end of
4082 the string we were working on... */
4083 if (slstr->len > 0) {
4084 sl = g_list_append(sl, g_string_free(slstr, FALSE)(__builtin_constant_p ((0)) ? (((0)) ? (g_string_free) ((slstr
), ((0))) : g_string_free_and_steal (slstr)) : (g_string_free
) ((slstr), ((0))))
);
4085 slstr = g_string_sized_new(default_size);
4086 }
4087
4088 /* ...and the beginning of a new string. */
4089 state = PRE_STRING;
4090 } else if (!g_ascii_isspace(cur_c)((g_ascii_table[(guchar) (cur_c)] & G_ASCII_SPACE) != 0) || state != PRE_STRING) {
4091 /* Either this isn't a white-space character, or we've started a
4092 string (i.e., already seen a non-white-space character for that
4093 string and put it into the string).
4094
4095 The character is to be put into the string; do so. */
4096 g_string_append_c(slstr, cur_c)g_string_append_c_inline (slstr, cur_c);
4097
4098 /* If it was backslash-escaped, we're done with the backslash escape. */
4099 backslash = false0;
4100 }
4101 i++;
4102 }
4103 return(sl);
4104}
4105
4106char *join_string_list(GList *sl)
4107{
4108 GString *joined_str = g_string_new("");
4109 GList *cur, *first;
4110 char *str;
4111 unsigned item_count = 0;
4112
4113 cur = first = g_list_first(sl);
4114 while (cur) {
4115 item_count++;
4116 str = (char *)cur->data;
4117
4118 if (cur != first)
4119 g_string_append_c(joined_str, ',')g_string_append_c_inline (joined_str, ',');
4120
4121 if (item_count % 2) {
4122 /* Wrap the line. */
4123 g_string_append(joined_str, "\n\t")(__builtin_constant_p ("\n\t") ? __extension__ ({ const char *
const __val = ("\n\t"); g_string_append_len_inline (joined_str
, __val, (__val != ((void*)0)) ? (gssize) strlen (((__val) + !
(__val))) : (gssize) -1); }) : g_string_append_len_inline (joined_str
, "\n\t", (gssize) -1))
;
4124 } else
4125 g_string_append_c(joined_str, ' ')g_string_append_c_inline (joined_str, ' ');
4126
4127 g_string_append_c(joined_str, '"')g_string_append_c_inline (joined_str, '"');
4128 while (*str) {
4129 gunichar uc = g_utf8_get_char (str);
4130
4131 if (uc == '"' || uc == '\\')
4132 g_string_append_c(joined_str, '\\')g_string_append_c_inline (joined_str, '\\');
4133
4134 if (g_unichar_isprint(uc))
4135 g_string_append_unichar (joined_str, uc);
4136
4137 str = g_utf8_next_char (str)((str) + g_utf8_skip[*(const guchar *)(str)]);
4138 }
4139
4140 g_string_append_c(joined_str, '"')g_string_append_c_inline (joined_str, '"');
4141
4142 cur = cur->next;
4143 }
4144 return g_string_free(joined_str, FALSE)(__builtin_constant_p ((0)) ? (((0)) ? (g_string_free) ((joined_str
), ((0))) : g_string_free_and_steal (joined_str)) : (g_string_free
) ((joined_str), ((0))))
;
4145}
4146
4147void
4148prefs_clear_string_list(GList *sl)
4149{
4150 g_list_free_full(sl, g_free);
4151}
4152
4153/*
4154 * Takes a string, a pointer to an array of "enum_val_t"s, and a default int
4155 * value.
4156 * The array must be terminated by an entry with a null "name" string.
4157 *
4158 * If the string matches a "name" string in an entry, the value from that
4159 * entry is returned.
4160 *
4161 * Otherwise, if a string matches a "description" string in an entry, the
4162 * value from that entry is returned; we do that for backwards compatibility,
4163 * as we used to have only a "name" string that was used both for command-line
4164 * and configuration-file values and in the GUI (which meant either that
4165 * the GUI had what might be somewhat cryptic values to select from or that
4166 * the "-o" flag took long strings, often with spaces in them).
4167 *
4168 * Otherwise, the default value that was passed as the third argument is
4169 * returned.
4170 */
4171static int
4172find_val_for_string(const char *needle, const enum_val_t *haystack,
4173 int default_value)
4174{
4175 int i;
4176
4177 for (i = 0; haystack[i].name != NULL((void*)0); i++) {
4178 if (g_ascii_strcasecmp(needle, haystack[i].name) == 0) {
4179 return haystack[i].value;
4180 }
4181 }
4182 for (i = 0; haystack[i].name != NULL((void*)0); i++) {
4183 if (g_ascii_strcasecmp(needle, haystack[i].description) == 0) {
4184 return haystack[i].value;
4185 }
4186 }
4187 return default_value;
4188}
4189
4190/* Preferences file format:
4191 * - Configuration directives start at the beginning of the line, and
4192 * are terminated with a colon.
4193 * - Directives can be continued on the next line by preceding them with
4194 * whitespace.
4195 *
4196 * Example:
4197
4198# This is a comment line
4199print.command: lpr
4200print.file: /a/very/long/path/
4201 to/wireshark-out.ps
4202 *
4203 */
4204
4205/*
4206 * Initialize non-dissector preferences used by the "register preference" API
4207 * to default values so the default values can be used when registered.
4208 *
4209 * String, filename, and directory preferences will be g_freed so they must
4210 * be g_mallocated.
4211 */
4212static void
4213prefs_set_global_defaults(wmem_allocator_t* pref_scope, const char** col_fmt, int num_cols)
4214{
4215 int i;
4216 fmt_data *cfmt;
4217
4218 prefs.gui_toolbar_main_style = TB_STYLE_ICONS0;
4219 /* We try to find the best font in the Qt code */
4220 wmem_free(pref_scope, prefs.gui_font_name);
4221 prefs.gui_font_name = wmem_strdup(pref_scope, "");
4222 wmem_free(pref_scope, prefs.gui_colorized_fg);
4223 prefs.gui_colorized_fg = wmem_strdup(pref_scope, "000000,000000,000000,000000,000000,000000,000000,000000,000000,000000");
4224 wmem_free(pref_scope, prefs.gui_colorized_bg);
4225 prefs.gui_colorized_bg = wmem_strdup(pref_scope, "ffc0c0,ffc0ff,e0c0e0,c0c0ff,c0e0e0,c0ffff,c0ffc0,ffffc0,e0e0c0,e0e0e0");
4226
4227 prefs.gui_geometry_save_position = true1;
4228 prefs.gui_geometry_save_size = true1;
4229 prefs.gui_geometry_save_maximized= true1;
4230 prefs.gui_fileopen_style = FO_STYLE_LAST_OPENED0;
4231 prefs.gui_recent_df_entries_max = 10;
4232 prefs.gui_recent_files_count_max = 10;
4233 wmem_free(pref_scope, prefs.gui_fileopen_dir);
4234 prefs.gui_fileopen_dir = wmem_strdup(pref_scope, get_persdatafile_dir());
4235 prefs.gui_fileopen_preview = 3;
4236 wmem_free(pref_scope, prefs.gui_tlskeylog_command);
4237 prefs.gui_tlskeylog_command = wmem_strdup(pref_scope, "");
4238 prefs.gui_ask_unsaved = true1;
4239 prefs.gui_autocomplete_filter = true1;
4240 prefs.gui_find_wrap = true1;
4241 prefs.gui_update_enabled = true1;
4242 prefs.gui_update_channel = UPDATE_CHANNEL_STABLE;
4243 prefs.gui_update_interval = 60*60*24; /* Seconds */
4244 prefs.gui_debounce_timer = 400; /* milliseconds */
4245 wmem_free(pref_scope, prefs.gui_window_title);
4246 prefs.gui_window_title = wmem_strdup(pref_scope, "");
4247 wmem_free(pref_scope, prefs.gui_prepend_window_title);
4248 prefs.gui_prepend_window_title = wmem_strdup(pref_scope, "");
4249 wmem_free(pref_scope, prefs.gui_start_title);
4250 prefs.gui_start_title = wmem_strdup(pref_scope, "The World's Most Popular Network Protocol Analyzer");
4251 prefs.gui_version_placement = version_both;
4252 prefs.gui_welcome_page_show_recent = true1;
4253 prefs.gui_layout_type = layout_type_2;
4254 prefs.gui_layout_content_1 = layout_pane_content_plist;
4255 prefs.gui_layout_content_2 = layout_pane_content_pdetails;
4256 prefs.gui_layout_content_3 = layout_pane_content_pbytes;
4257 prefs.gui_packet_list_elide_mode = ELIDE_RIGHT;
4258 prefs.gui_packet_list_copy_format_options_for_keyboard_shortcut = COPY_FORMAT_TEXT;
4259 prefs.gui_packet_list_copy_text_with_aligned_columns = false0;
4260 prefs.gui_packet_list_show_related = true1;
4261 prefs.gui_packet_list_show_minimap = true1;
4262 prefs.gui_packet_list_sortable = true1;
4263 prefs.gui_packet_list_cached_rows_max = 10000;
4264 prefs.gui_packet_list_multi_color_mode = PACKET_LIST_MULTI_COLOR_MODE_OFF;
4265 prefs.gui_packet_list_multi_color_shift_percent = 85;
4266 prefs.gui_packet_list_multi_color_details = false0;
4267 prefs.gui_packet_list_multi_color_separator = PACKET_LIST_MULTI_COLOR_SEPARATOR_DIAGONAL;
4268 wmem_free(pref_scope, prefs.gui_interfaces_hide_types);
4269 prefs.gui_interfaces_hide_types = wmem_strdup(pref_scope, "");
4270 prefs.gui_interfaces_show_hidden = false0;
4271 prefs.gui_interfaces_remote_display = true1;
4272 prefs.gui_packet_list_separator = false0;
4273 prefs.gui_packet_header_column_definition = true1;
4274 prefs.gui_packet_list_hover_style = true1;
4275 prefs.gui_show_selected_packet = false0;
4276 prefs.gui_show_file_load_time = false0;
4277 prefs.gui_max_export_objects = 1000;
4278 prefs.gui_max_tree_items = 1 * 1000 * 1000;
4279 prefs.gui_max_tree_depth = 5 * 100;
4280 prefs.gui_decimal_places1 = DEF_GUI_DECIMAL_PLACES12;
4281 prefs.gui_decimal_places2 = DEF_GUI_DECIMAL_PLACES24;
4282 prefs.gui_decimal_places3 = DEF_GUI_DECIMAL_PLACES36;
4283
4284 if (prefs.col_list) {
4285 free_col_info(prefs.col_list);
4286 prefs.col_list = NULL((void*)0);
4287 }
4288 for (i = 0; i < num_cols; i++) {
4289 cfmt = g_new0(fmt_data,1)((fmt_data *) g_malloc0_n ((1), sizeof (fmt_data)));
4290 cfmt->title = g_strdup(col_fmt[i * 2])g_strdup_inline (col_fmt[i * 2]);
4291 cfmt->visible = true1;
4292 cfmt->display = COLUMN_DISPLAY_STRINGS'R';
4293 parse_column_format(cfmt, col_fmt[(i * 2) + 1]);
4294 prefs.col_list = g_list_append(prefs.col_list, cfmt);
4295 }
4296 prefs.num_cols = num_cols;
4297
4298/* set the default values for the capture dialog box */
4299 prefs.capture_prom_mode = true1;
4300 prefs.capture_monitor_mode = false0;
4301 prefs.capture_pcap_ng = true1;
4302 prefs.capture_process_info = CAPTURE_PROCESS_INFO_BASIC;
4303 prefs.capture_real_time = true1;
4304 prefs.capture_update_interval = DEFAULT_UPDATE_INTERVAL100;
4305 prefs.capture_no_extcap = false0;
4306 prefs.capture_show_info = false0;
4307
4308/* set the default values for the tap/statistics dialog box */
4309 prefs.tap_update_interval = TAP_UPDATE_DEFAULT_INTERVAL3000;
4310 prefs.flow_graph_max_export_items = 1000;
4311 prefs.st_enable_burstinfo = true1;
4312 prefs.st_burst_showcount = false0;
4313 prefs.st_burst_resolution = ST_DEF_BURSTRES5;
4314 prefs.st_burst_windowlen = ST_DEF_BURSTLEN100;
4315 prefs.st_sort_casesensitve = true1;
4316 prefs.st_sort_rng_fixorder = true1;
4317 prefs.st_sort_rng_nameonly = true1;
4318 prefs.st_sort_defcolflag = ST_SORT_COL_COUNT2;
4319 prefs.st_sort_defdescending = true1;
4320 prefs.st_sort_showfullname = false0;
4321 prefs.conv_machine_readable = false0;
4322
4323 /* protocols */
4324 prefs.display_hidden_proto_items = false0;
4325 prefs.display_byte_fields_with_spaces = false0;
4326 prefs.display_abs_time_ascii = ABS_TIME_ASCII_TREE;
4327 prefs.ignore_dup_frames = false0;
4328 prefs.ignore_dup_frames_cache_entries = 10000;
4329
4330 /* set the default values for the io graph dialog */
4331 prefs.gui_io_graph_automatic_update = true1;
4332 prefs.gui_io_graph_enable_legend = true1;
4333
4334 /* set the default values for the plot dialog */
4335 prefs.gui_plot_automatic_update = true1;
4336 prefs.gui_plot_enable_legend = true1;
4337 prefs.gui_plot_enable_auto_scroll = false0;
4338
4339 /* set the default values for the packet dialog */
4340 prefs.gui_packet_dialog_layout = layout_vertical;
4341 prefs.gui_packet_details_show_byteview = true1;
4342}
4343
4344/*
4345 * Reset a single dissector preference.
4346 */
4347void
4348reset_pref(pref_t *pref)
4349{
4350 if (!pref) return;
4351
4352 /*
4353 * This preference is no longer supported; it's not a
4354 * real preference, so we don't reset it (i.e., we
4355 * treat it as if it weren't found in the list of
4356 * preferences, and we weren't called in the first place).
4357 */
4358 if (pref->obsolete)
4359 return;
4360
4361 switch (pref->type) {
4362
4363 case PREF_UINT:
4364 *pref->varp.uint = pref->default_val.uint;
4365 break;
4366
4367 case PREF_INT:
4368 *pref->varp.intp = pref->default_val.intval;
4369 break;
4370
4371 case PREF_FLOAT:
4372 *pref->varp.floatp = pref->default_val.floatval;
4373 break;
4374
4375 case PREF_BOOL:
4376 *pref->varp.boolp = pref->default_val.boolval;
4377 break;
4378
4379 case PREF_ENUM:
4380 case PREF_PROTO_TCP_SNDAMB_ENUM:
4381 *pref->varp.enump = pref->default_val.enumval;
4382 break;
4383
4384 case PREF_STRING:
4385 case PREF_SAVE_FILENAME:
4386 case PREF_OPEN_FILENAME:
4387 case PREF_DIRNAME:
4388 case PREF_PASSWORD:
4389 case PREF_DISSECTOR:
4390 reset_string_like_preference(pref);
4391 break;
4392
4393 case PREF_RANGE:
4394 case PREF_DECODE_AS_RANGE:
4395 wmem_free(pref->scope, *pref->varp.range);
4396 *pref->varp.range = range_copy(pref->scope, pref->default_val.range);
4397 break;
4398
4399 case PREF_STATIC_TEXT:
4400 case PREF_UAT:
4401 /* Nothing to do */
4402 break;
4403
4404 case PREF_COLOR:
4405 *pref->varp.colorp = pref->default_val.color;
4406 break;
4407
4408 case PREF_CUSTOM:
4409 pref->custom_cbs.reset_cb(pref);
4410 break;
4411 }
4412}
4413
4414static void
4415reset_pref_cb(void *data, void *user_data)
4416{
4417 pref_t *pref = (pref_t *) data;
4418 module_t *module = (module_t *)user_data;
4419
4420 if (pref && (pref->type == PREF_RANGE || pref->type == PREF_DECODE_AS_RANGE)) {
4421 /*
4422 * Some dissectors expect the range (returned via prefs_get_range_value)
4423 * to remain valid if it has not changed. If it did change, then we
4424 * should set "prefs_changed_flags" to ensure that the preference apply
4425 * callback is invoked. That callback will notify dissectors that it
4426 * should no longer assume the range to be valid.
4427 */
4428 if (ranges_are_equal(*pref->varp.range, pref->default_val.range)) {
4429 /* Optimization: do not invoke apply callback if nothing changed. */
4430 return;
4431 }
4432 module->prefs_changed_flags |= prefs_get_effect_flags(pref);
4433 }
4434 reset_pref(pref);
4435}
4436
4437/*
4438 * Reset all preferences for a module.
4439 */
4440static bool_Bool
4441reset_module_prefs(const void *key _U___attribute__((unused)), void *value, void *data _U___attribute__((unused)))
4442{
4443 module_t *module = (module_t *)value;
4444 g_list_foreach(module->prefs, reset_pref_cb, module);
4445 return false0;
4446}
4447
4448/* Reset preferences */
4449void
4450prefs_reset(const char* app_env_var_prefix, const char** col_fmt, int num_cols)
4451{
4452 g_free(prefs.saved_at_version)(__builtin_object_size ((prefs.saved_at_version), 0) != ((size_t
) - 1)) ? g_free_sized (prefs.saved_at_version, __builtin_object_size
((prefs.saved_at_version), 0)) : (g_free) (prefs.saved_at_version
)
;
4453 prefs.saved_at_version = NULL((void*)0);
4454
4455 /*
4456 * Unload all UAT preferences.
4457 */
4458 uat_unload_all();
4459
4460 /*
4461 * Unload any loaded MIBs.
4462 */
4463 /* XXX - oids_cleanup not tested/supported at non-shutdown yet */
4464 //oids_cleanup();
4465
4466 /*
4467 * Reload all UAT preferences.
4468 */
4469 uat_load_all(app_env_var_prefix);
4470
4471 /*
4472 * Reset the non-dissector preferences.
4473 */
4474 prefs_set_global_defaults(wmem_epan_scope(), col_fmt, num_cols);
4475
4476 /*
4477 * Reset the non-UAT dissector preferences.
4478 */
4479 wmem_tree_foreach(prefs_modules, reset_module_prefs, NULL((void*)0));
4480}
4481
4482#ifdef _WIN32
4483static void
4484read_registry(void)
4485{
4486 HKEY hTestKey;
4487 DWORD data;
4488 DWORD data_size = sizeof(DWORD);
4489 DWORD ret;
4490
4491 ret = RegOpenKeyExA(HKEY_CURRENT_USER, REG_HKCU_WIRESHARK_KEY"Software\\Wireshark", 0, KEY_READ, &hTestKey);
4492 if (ret != ERROR_SUCCESS && ret != ERROR_FILE_NOT_FOUND) {
4493 ws_noisy("Cannot open HKCU "REG_HKCU_WIRESHARK_KEY": 0x%lx", ret)do { if (1) { ws_log_full("Epan", LOG_LEVEL_NOISY, "epan/prefs.c"
, 4493, __func__, "Cannot open HKCU ""Software\\Wireshark"": 0x%lx"
, ret); } } while (0)
;
4494 return;
4495 }
4496
4497 ret = RegQueryValueExA(hTestKey, LOG_HKCU_CONSOLE_OPEN"ConsoleOpen", NULL((void*)0), NULL((void*)0), (LPBYTE)&data, &data_size);
4498 if (ret == ERROR_SUCCESS) {
4499 ws_log_console_open = (ws_log_console_open_pref)data;
4500 ws_noisy("Got "LOG_HKCU_CONSOLE_OPEN" from Windows registry: %d", ws_log_console_open)do { if (1) { ws_log_full("Epan", LOG_LEVEL_NOISY, "epan/prefs.c"
, 4500, __func__, "Got ""ConsoleOpen"" from Windows registry: %d"
, ws_log_console_open); } } while (0)
;
4501 }
4502 else if (ret != ERROR_FILE_NOT_FOUND) {
4503 ws_noisy("Error reading registry key "LOG_HKCU_CONSOLE_OPEN": 0x%lx", ret)do { if (1) { ws_log_full("Epan", LOG_LEVEL_NOISY, "epan/prefs.c"
, 4503, __func__, "Error reading registry key ""ConsoleOpen"": 0x%lx"
, ret); } } while (0)
;
4504 }
4505
4506 RegCloseKey(hTestKey);
4507}
4508#endif
4509
4510void
4511prefs_read_module(const char *module, bool_Bool from_profile, const char* app_env_var_prefix)
4512{
4513 int err;
4514 char *pf_path;
4515 FILE *pf;
4516
4517 module_t *target_module = prefs_find_module(module);
4518 if (!target_module) {
4519 return;
4520 }
4521
4522 /* Construct the pathname of the user's preferences file for the module. */
4523 char *pf_name = g_strdup_printf("%s.cfg", module);
4524 pf_path = get_persconffile_path(pf_name, from_profile, app_env_var_prefix);
4525 g_free(pf_name)(__builtin_object_size ((pf_name), 0) != ((size_t) - 1)) ? g_free_sized
(pf_name, __builtin_object_size ((pf_name), 0)) : (g_free) (
pf_name)
;
4526
4527 /* Read the user's module preferences file, if it exists and is not a dir. */
4528 if (!test_for_regular_file(pf_path) || ((pf = ws_fopenfopen(pf_path, "r")) == NULL((void*)0))) {
4529 g_free(pf_path)(__builtin_object_size ((pf_path), 0) != ((size_t) - 1)) ? g_free_sized
(pf_path, __builtin_object_size ((pf_path), 0)) : (g_free) (
pf_path)
;
4530 /* Fall back to the user's generic preferences file. */
4531 pf_path = get_persconffile_path(PF_NAME"preferences", true1, app_env_var_prefix);
4532 pf = ws_fopenfopen(pf_path, "r");
4533 }
4534
4535 if (pf != NULL((void*)0)) {
4536 /* We succeeded in opening it; read it. */
4537 err = read_prefs_file(pf_path, pf, set_pref, target_module);
4538 if (err != 0) {
4539 /* We had an error reading the file; report it. */
4540 report_warning("Error reading your preferences file \"%s\": %s.",
4541 pf_path, g_strerror(err));
4542 } else
4543 g_free(pf_path)(__builtin_object_size ((pf_path), 0) != ((size_t) - 1)) ? g_free_sized
(pf_path, __builtin_object_size ((pf_path), 0)) : (g_free) (
pf_path)
;
4544 fclose(pf);
4545 } else {
4546 /* We failed to open it. If we failed for some reason other than
4547 "it doesn't exist", return the errno and the pathname, so our
4548 caller can report the error. */
4549 if (errno(*__errno_location ()) != ENOENT2) {
4550 report_warning("Can't open your preferences file \"%s\": %s.",
4551 pf_path, g_strerror(errno(*__errno_location ())));
4552 } else
4553 g_free(pf_path)(__builtin_object_size ((pf_path), 0) != ((size_t) - 1)) ? g_free_sized
(pf_path, __builtin_object_size ((pf_path), 0)) : (g_free) (
pf_path)
;
4554 }
4555
4556 return;
4557}
4558
4559/* Read the preferences file, fill in "prefs", and return a pointer to it.
4560
4561 If we got an error (other than "it doesn't exist") we report it through
4562 the UI. */
4563e_prefs *
4564read_prefs(const char* app_env_var_prefix)
4565{
4566 int err;
4567 char *pf_path;
4568 FILE *pf;
4569
4570 /* clean up libsmi structures before reading prefs */
4571 /* XXX - oids_cleanup not tested/supported at non-shutdown yet */
4572 // oids_cleanup();
4573
4574#ifdef _WIN32
4575 read_registry();
4576#endif
4577
4578 /*
4579 * If we don't already have the pathname of the global preferences
4580 * file, construct it. Then, in either case, try to open the file.
4581 */
4582 if (gpf_path == NULL((void*)0)) {
4583 /*
4584 * We don't have the path; try the new path first, and, if that
4585 * file doesn't exist, try the old path.
4586 */
4587 gpf_path = get_datafile_path(PF_NAME"preferences", app_env_var_prefix);
4588 if ((pf = ws_fopenfopen(gpf_path, "r")) == NULL((void*)0) && errno(*__errno_location ()) == ENOENT2) {
4589 /*
4590 * It doesn't exist by the new name; try the old name.
4591 */
4592 g_free(gpf_path)(__builtin_object_size ((gpf_path), 0) != ((size_t) - 1)) ? g_free_sized
(gpf_path, __builtin_object_size ((gpf_path), 0)) : (g_free)
(gpf_path)
;
4593 gpf_path = get_datafile_path(OLD_GPF_NAME"wireshark.conf", app_env_var_prefix);
4594 pf = ws_fopenfopen(gpf_path, "r");
4595 }
4596 } else {
4597 /*
4598 * We have the path; try it.
4599 */
4600 pf = ws_fopenfopen(gpf_path, "r");
4601 }
4602
4603 /*
4604 * If we were able to open the file, read it.
4605 * XXX - if it failed for a reason other than "it doesn't exist",
4606 * report the error.
4607 */
4608 if (pf != NULL((void*)0)) {
4609 /* We succeeded in opening it; read it. */
4610 err = read_prefs_file(gpf_path, pf, set_pref, NULL((void*)0));
4611 if (err != 0) {
4612 /* We had an error reading the file; report it. */
4613 report_warning("Error reading global preferences file \"%s\": %s.",
4614 gpf_path, g_strerror(err));
4615 }
4616 fclose(pf);
4617 } else {
4618 /* We failed to open it. If we failed for some reason other than
4619 "it doesn't exist", report the error. */
4620 if (errno(*__errno_location ()) != ENOENT2) {
4621 if (errno(*__errno_location ()) != 0) {
4622 report_warning("Can't open global preferences file \"%s\": %s.",
4623 gpf_path, g_strerror(errno(*__errno_location ())));
4624 }
4625 }
4626 }
4627
4628 /* Construct the pathname of the user's preferences file. */
4629 pf_path = get_persconffile_path(PF_NAME"preferences", true1, app_env_var_prefix);
4630
4631 /* Read the user's preferences file, if it exists. */
4632 if ((pf = ws_fopenfopen(pf_path, "r")) != NULL((void*)0)) {
4633
4634 /* We succeeded in opening it; read it. */
4635 err = read_prefs_file(pf_path, pf, set_pref, NULL((void*)0));
4636 if (err != 0) {
4637 /* We had an error reading the file; report it. */
4638 report_warning("Error reading your preferences file \"%s\": %s.",
4639 pf_path, g_strerror(err));
4640 } else
4641 g_free(pf_path)(__builtin_object_size ((pf_path), 0) != ((size_t) - 1)) ? g_free_sized
(pf_path, __builtin_object_size ((pf_path), 0)) : (g_free) (
pf_path)
;
4642 fclose(pf);
4643 } else {
4644 /* We failed to open it. If we failed for some reason other than
4645 "it doesn't exist", return the errno and the pathname, so our
4646 caller can report the error. */
4647 if (errno(*__errno_location ()) != ENOENT2) {
4648 report_warning("Can't open your preferences file \"%s\": %s.",
4649 pf_path, g_strerror(errno(*__errno_location ())));
4650 } else
4651 g_free(pf_path)(__builtin_object_size ((pf_path), 0) != ((size_t) - 1)) ? g_free_sized
(pf_path, __builtin_object_size ((pf_path), 0)) : (g_free) (
pf_path)
;
4652 }
4653
4654 /* load SMI modules if needed */
4655 oids_init(app_env_var_prefix);
4656
4657 return &prefs;
4658}
4659
4660/* read the preferences file (or similar) and call the callback
4661 * function to set each key/value pair found */
4662int
4663read_prefs_file(const char *pf_path, FILE *pf,
4664 pref_set_pair_cb pref_set_pair_fct, void *private_data)
4665{
4666 enum {
4667 START, /* beginning of a line */
4668 IN_VAR, /* processing key name */
4669 PRE_VAL, /* finished processing key name, skipping white space before value */
4670 IN_VAL, /* processing value */
4671 IN_SKIP /* skipping to the end of the line */
4672 } state = START;
4673 int got_c;
4674 GString *cur_val;
4675 GString *cur_var;
4676 bool_Bool got_val = false0;
4677 int fline = 1, pline = 1;
4678 char hint[] = "(save preferences to remove this warning)";
4679 char ver[128];
4680
4681 cur_val = g_string_new("");
4682 cur_var = g_string_new("");
4683
4684 /* Try to read in the profile name in the first line of the preferences file. */
4685 if (fscanf(pf, "# Configuration file for %127[^\r\n]", ver) == 1) {
1
Assuming the condition is false
2
Taking false branch
4686 /* Assume trailing period and remove it */
4687 g_free(prefs.saved_at_version)(__builtin_object_size ((prefs.saved_at_version), 0) != ((size_t
) - 1)) ? g_free_sized (prefs.saved_at_version, __builtin_object_size
((prefs.saved_at_version), 0)) : (g_free) (prefs.saved_at_version
)
;
4688 prefs.saved_at_version = g_strndup(ver, strlen(ver) - 1);
4689 }
4690 rewind(pf);
3
After calling 'rewind' reading 'errno' is required to find out if the call has failed
4691
4692 while ((got_c = ws_getc_unlockedgetc_unlocked(pf)) != EOF(-1)) {
4
Value of 'errno' was not checked and may be overwritten by function 'getc_unlocked'
4693 if (got_c == '\r') {
4694 /* Treat CR-LF at the end of a line like LF, so that if we're reading
4695 * a Windows-format file on UN*X, we handle it the same way we'd handle
4696 * a UN*X-format file. */
4697 got_c = ws_getc_unlockedgetc_unlocked(pf);
4698 if (got_c == EOF(-1))
4699 break;
4700 if (got_c != '\n') {
4701 /* Put back the character after the CR, and process the CR normally. */
4702 ungetc(got_c, pf);
4703 got_c = '\r';
4704 }
4705 }
4706 if (got_c == '\n') {
4707 state = START;
4708 fline++;
4709 continue;
4710 }
4711
4712 switch (state) {
4713 case START:
4714 if (g_ascii_isalnum(got_c)((g_ascii_table[(guchar) (got_c)] & G_ASCII_ALNUM) != 0)) {
4715 if (cur_var->len > 0) {
4716 if (got_val) {
4717 if (cur_val->len > 0) {
4718 if (cur_val->str[cur_val->len-1] == ',') {
4719 /*
4720 * If the pref has a trailing comma, eliminate it.
4721 */
4722 cur_val->str[cur_val->len-1] = '\0';
4723 ws_warning("%s line %d: trailing comma in \"%s\" %s", pf_path, pline, cur_var->str, hint)do { if (1) { ws_log_full("Epan", LOG_LEVEL_WARNING, "epan/prefs.c"
, 4723, __func__, "%s line %d: trailing comma in \"%s\" %s", pf_path
, pline, cur_var->str, hint); } } while (0)
;
4724 }
4725 }
4726 /* Call the routine to set the preference; it will parse
4727 the value as appropriate.
4728
4729 Since we're reading a file, rather than processing
4730 explicit user input, for range preferences, silently
4731 lower values in excess of the range's maximum, rather
4732 than reporting errors and failing. */
4733 switch (pref_set_pair_fct(cur_var->str, cur_val->str, private_data, false0)) {
4734
4735 case PREFS_SET_OK:
4736 break;
4737
4738 case PREFS_SET_SYNTAX_ERR:
4739 report_warning("Syntax error in preference \"%s\" at line %d of\n%s %s",
4740 cur_var->str, pline, pf_path, hint);
4741 break;
4742
4743 case PREFS_SET_NO_SUCH_PREF:
4744 ws_warning("No such preference \"%s\" at line %d of\n%s %s",do { if (1) { ws_log_full("Epan", LOG_LEVEL_WARNING, "epan/prefs.c"
, 4745, __func__, "No such preference \"%s\" at line %d of\n%s %s"
, cur_var->str, pline, pf_path, hint); } } while (0)
4745 cur_var->str, pline, pf_path, hint)do { if (1) { ws_log_full("Epan", LOG_LEVEL_WARNING, "epan/prefs.c"
, 4745, __func__, "No such preference \"%s\" at line %d of\n%s %s"
, cur_var->str, pline, pf_path, hint); } } while (0)
;
4746 break;
4747
4748 case PREFS_SET_OBSOLETE:
4749 /*
4750 * If an attempt is made to save the
4751 * preferences, a popup warning will be
4752 * displayed stating that obsolete prefs
4753 * have been detected and the user will
4754 * be given the opportunity to save these
4755 * prefs under a different profile name.
4756 * The prefs in question need to be listed
4757 * in the console window so that the
4758 * user can make an informed choice.
4759 */
4760 ws_warning("Obsolete preference \"%s\" at line %d of\n%s %s",do { if (1) { ws_log_full("Epan", LOG_LEVEL_WARNING, "epan/prefs.c"
, 4761, __func__, "Obsolete preference \"%s\" at line %d of\n%s %s"
, cur_var->str, pline, pf_path, hint); } } while (0)
4761 cur_var->str, pline, pf_path, hint)do { if (1) { ws_log_full("Epan", LOG_LEVEL_WARNING, "epan/prefs.c"
, 4761, __func__, "Obsolete preference \"%s\" at line %d of\n%s %s"
, cur_var->str, pline, pf_path, hint); } } while (0)
;
4762 break;
4763 }
4764 } else {
4765 ws_warning("Incomplete preference at line %d: of\n%s %s", pline, pf_path, hint)do { if (1) { ws_log_full("Epan", LOG_LEVEL_WARNING, "epan/prefs.c"
, 4765, __func__, "Incomplete preference at line %d: of\n%s %s"
, pline, pf_path, hint); } } while (0)
;
4766 }
4767 }
4768 state = IN_VAR;
4769 got_val = false0;
4770 g_string_truncate(cur_var, 0)g_string_truncate_inline (cur_var, 0);
4771 g_string_append_c(cur_var, (char) got_c)g_string_append_c_inline (cur_var, (char) got_c);
4772 pline = fline;
4773 } else if (g_ascii_isspace(got_c)((g_ascii_table[(guchar) (got_c)] & G_ASCII_SPACE) != 0) && cur_var->len > 0 && got_val) {
4774 state = PRE_VAL;
4775 } else if (got_c == '#') {
4776 state = IN_SKIP;
4777 } else {
4778 ws_warning("Malformed preference at line %d of\n%s %s", fline, pf_path, hint)do { if (1) { ws_log_full("Epan", LOG_LEVEL_WARNING, "epan/prefs.c"
, 4778, __func__, "Malformed preference at line %d of\n%s %s"
, fline, pf_path, hint); } } while (0)
;
4779 }
4780 break;
4781 case IN_VAR:
4782 if (got_c != ':') {
4783 g_string_append_c(cur_var, (char) got_c)g_string_append_c_inline (cur_var, (char) got_c);
4784 } else {
4785 /* This is a colon (':') */
4786 state = PRE_VAL;
4787 g_string_truncate(cur_val, 0)g_string_truncate_inline (cur_val, 0);
4788 /*
4789 * Set got_val to true to accommodate prefs such as
4790 * "gui.fileopen.dir" that do not require a value.
4791 */
4792 got_val = true1;
4793 }
4794 break;
4795 case PRE_VAL:
4796 if (!g_ascii_isspace(got_c)((g_ascii_table[(guchar) (got_c)] & G_ASCII_SPACE) != 0)) {
4797 state = IN_VAL;
4798 g_string_append_c(cur_val, (char) got_c)g_string_append_c_inline (cur_val, (char) got_c);
4799 }
4800 break;
4801 case IN_VAL:
4802 g_string_append_c(cur_val, (char) got_c)g_string_append_c_inline (cur_val, (char) got_c);
4803 break;
4804 case IN_SKIP:
4805 break;
4806 }
4807 }
4808 if (cur_var->len > 0) {
4809 if (got_val) {
4810 /* Call the routine to set the preference; it will parse
4811 the value as appropriate.
4812
4813 Since we're reading a file, rather than processing
4814 explicit user input, for range preferences, silently
4815 lower values in excess of the range's maximum, rather
4816 than reporting errors and failing. */
4817 switch (pref_set_pair_fct(cur_var->str, cur_val->str, private_data, false0)) {
4818
4819 case PREFS_SET_OK:
4820 break;
4821
4822 case PREFS_SET_SYNTAX_ERR:
4823 ws_warning("Syntax error in preference %s at line %d of\n%s %s",do { if (1) { ws_log_full("Epan", LOG_LEVEL_WARNING, "epan/prefs.c"
, 4824, __func__, "Syntax error in preference %s at line %d of\n%s %s"
, cur_var->str, pline, pf_path, hint); } } while (0)
4824 cur_var->str, pline, pf_path, hint)do { if (1) { ws_log_full("Epan", LOG_LEVEL_WARNING, "epan/prefs.c"
, 4824, __func__, "Syntax error in preference %s at line %d of\n%s %s"
, cur_var->str, pline, pf_path, hint); } } while (0)
;
4825 break;
4826
4827 case PREFS_SET_NO_SUCH_PREF:
4828 ws_warning("No such preference \"%s\" at line %d of\n%s %s",do { if (1) { ws_log_full("Epan", LOG_LEVEL_WARNING, "epan/prefs.c"
, 4829, __func__, "No such preference \"%s\" at line %d of\n%s %s"
, cur_var->str, pline, pf_path, hint); } } while (0)
4829 cur_var->str, pline, pf_path, hint)do { if (1) { ws_log_full("Epan", LOG_LEVEL_WARNING, "epan/prefs.c"
, 4829, __func__, "No such preference \"%s\" at line %d of\n%s %s"
, cur_var->str, pline, pf_path, hint); } } while (0)
;
4830 break;
4831
4832 case PREFS_SET_OBSOLETE:
4833 ws_warning("Obsolete preference \"%s\" at line %d of\n%s %s",do { if (1) { ws_log_full("Epan", LOG_LEVEL_WARNING, "epan/prefs.c"
, 4834, __func__, "Obsolete preference \"%s\" at line %d of\n%s %s"
, cur_var->str, pline, pf_path, hint); } } while (0)
4834 cur_var->str, pline, pf_path, hint)do { if (1) { ws_log_full("Epan", LOG_LEVEL_WARNING, "epan/prefs.c"
, 4834, __func__, "Obsolete preference \"%s\" at line %d of\n%s %s"
, cur_var->str, pline, pf_path, hint); } } while (0)
;
4835 break;
4836 }
4837 } else {
4838 ws_warning("Incomplete preference at line %d of\n%s %s",do { if (1) { ws_log_full("Epan", LOG_LEVEL_WARNING, "epan/prefs.c"
, 4839, __func__, "Incomplete preference at line %d of\n%s %s"
, pline, pf_path, hint); } } while (0)
4839 pline, pf_path, hint)do { if (1) { ws_log_full("Epan", LOG_LEVEL_WARNING, "epan/prefs.c"
, 4839, __func__, "Incomplete preference at line %d of\n%s %s"
, pline, pf_path, hint); } } while (0)
;
4840 }
4841 }
4842
4843 g_string_free(cur_val, TRUE)(__builtin_constant_p ((!(0))) ? (((!(0))) ? (g_string_free) (
(cur_val), ((!(0)))) : g_string_free_and_steal (cur_val)) : (
g_string_free) ((cur_val), ((!(0)))))
;
4844 g_string_free(cur_var, TRUE)(__builtin_constant_p ((!(0))) ? (((!(0))) ? (g_string_free) (
(cur_var), ((!(0)))) : g_string_free_and_steal (cur_var)) : (
g_string_free) ((cur_var), ((!(0)))))
;
4845
4846 if (ferror(pf))
4847 return errno(*__errno_location ());
4848 else
4849 return 0;
4850}
4851
4852/*
4853 * If we were handed a preference starting with "uat:", try to turn it into
4854 * a valid uat entry.
4855 */
4856static bool_Bool
4857prefs_set_uat_pref(char *uat_entry, char **errmsg) {
4858 char *p, *colonp;
4859 uat_t *uat;
4860 bool_Bool ret;
4861
4862 colonp = strchr(uat_entry, ':');
4863 if (colonp == NULL((void*)0))
4864 return false0;
4865
4866 p = colonp;
4867 *p++ = '\0';
4868
4869 /*
4870 * Skip over any white space (there probably won't be any, but
4871 * as we allow it in the preferences file, we might as well
4872 * allow it here).
4873 */
4874 while (g_ascii_isspace(*p)((g_ascii_table[(guchar) (*p)] & G_ASCII_SPACE) != 0))
4875 p++;
4876 if (*p == '\0') {
4877 /*
4878 * Put the colon back, so if our caller uses, in an
4879 * error message, the string they passed us, the message
4880 * looks correct.
4881 */
4882 *colonp = ':';
4883 return false0;
4884 }
4885
4886 uat = uat_find(uat_entry);
4887 *colonp = ':';
4888 if (uat == NULL((void*)0)) {
4889 *errmsg = g_strdup("Unknown preference")g_strdup_inline ("Unknown preference");
4890 return false0;
4891 }
4892
4893 ret = uat_load_str(uat, p, errmsg);
4894 return ret;
4895}
4896
4897char *
4898prefs_sanitize_string(const char* str)
4899{
4900 char *sanitized;
4901 if (!prefs_regex) {
4902 prefs_regex = g_regex_new("\\s*\\R\\s*", (GRegexCompileFlags)G_REGEX_OPTIMIZE,
4903 (GRegexMatchFlags)G_REGEX_MATCH_BSR_ANYCRLF, NULL((void*)0));
4904 } else {
4905 g_regex_ref(prefs_regex);
4906 }
4907 sanitized = g_regex_replace(prefs_regex, str, -1, 0, " ", G_REGEX_MATCH_DEFAULT, NULL((void*)0));
4908 g_regex_unref(prefs_regex);
4909 return sanitized;
4910}
4911
4912/*
4913 * Given a string of the form "<pref name>:<pref value>", as might appear
4914 * as an argument to a "-o" option, parse it and set the preference in
4915 * question. Return an indication of whether it succeeded or failed
4916 * in some fashion.
4917 */
4918prefs_set_pref_e
4919prefs_set_pref(char *prefarg, char **errmsg)
4920{
4921 char *p, *colonp;
4922 prefs_set_pref_e ret;
4923
4924 *errmsg = NULL((void*)0);
4925
4926 colonp = strchr(prefarg, ':');
4927 if (colonp == NULL((void*)0)) {
4928 *errmsg = g_strdup("missing ':' (syntax is prefname:value).")g_strdup_inline ("missing ':' (syntax is prefname:value).");
4929 return PREFS_SET_SYNTAX_ERR;
4930 }
4931
4932 p = colonp;
4933 *p++ = '\0';
4934 /* XXX - Replace line terminators, or match and fail with errmsg, or ignore? */
4935
4936 /*
4937 * Skip over any white space (there probably won't be any, but
4938 * as we allow it in the preferences file, we might as well
4939 * allow it here).
4940 */
4941 while (g_ascii_isspace(*p)((g_ascii_table[(guchar) (*p)] & G_ASCII_SPACE) != 0))
4942 p++;
4943 /* The empty string is a legal value for range preferences (PREF_RANGE,
4944 * PREF_DECODE_AS_RANGE), and string-like preferences (PREF_STRING,
4945 * PREF_SAVE_FILENAME, PREF_OPEN_FILENAME, PREF_DIRNAME), indeed often
4946 * not just useful but the default. A user might have a value saved
4947 * to their preference file but want to override it to default behavior.
4948 * Individual preference handlers of those types should be prepared to
4949 * deal with an empty string. For other types, it is up to set_pref() to
4950 * test for the empty string and set PREFS_SET_SYNTAX_ERROR there.
4951 */
4952 if (strcmp(prefarg, "uat")) {
4953 ret = set_pref(prefarg, p, NULL((void*)0), true1);
4954 } else {
4955 ret = prefs_set_uat_pref(p, errmsg) ? PREFS_SET_OK : PREFS_SET_SYNTAX_ERR;
4956 }
4957 *colonp = ':'; /* put the colon back */
4958 return ret;
4959}
4960
4961unsigned prefs_get_uint_value(pref_t *pref, pref_source_t source)
4962{
4963 switch (source)
4964 {
4965 case pref_default:
4966 return pref->default_val.uint;
4967 case pref_stashed:
4968 return pref->stashed_val.uint;
4969 case pref_current:
4970 return *pref->varp.uint;
4971 default:
4972 ws_assert_not_reached()ws_log_fatal_full("Epan", LOG_LEVEL_ERROR, "epan/prefs.c", 4972
, __func__, "assertion \"not reached\" failed")
;
4973 break;
4974 }
4975
4976 return 0;
4977}
4978
4979unsigned int prefs_set_int_value(pref_t* pref, int value, pref_source_t source)
4980{
4981 int changed = 0;
4982 switch (source)
4983 {
4984 case pref_default:
4985 if (pref->default_val.intval != value) {
4986 pref->default_val.intval = value;
4987 changed = prefs_get_effect_flags(pref);
4988 }
4989 break;
4990 case pref_stashed:
4991 if (pref->stashed_val.intval != value) {
4992 pref->stashed_val.intval = value;
4993 changed = prefs_get_effect_flags(pref);
4994 }
4995 break;
4996 case pref_current:
4997 if (*pref->varp.intp != value) {
4998 *pref->varp.intp = value;
4999 changed = prefs_get_effect_flags(pref);
5000 }
5001 break;
5002 default:
5003 ws_assert_not_reached()ws_log_fatal_full("Epan", LOG_LEVEL_ERROR, "epan/prefs.c", 5003
, __func__, "assertion \"not reached\" failed")
;
5004 break;
5005 }
5006
5007 return changed;
5008}
5009
5010int prefs_get_int_value(pref_t* pref, pref_source_t source)
5011{
5012 switch (source)
5013 {
5014 case pref_default:
5015 return pref->default_val.intval;
5016 case pref_stashed:
5017 return pref->stashed_val.intval;
5018 case pref_current:
5019 return *pref->varp.intp;
5020 default:
5021 ws_assert_not_reached()ws_log_fatal_full("Epan", LOG_LEVEL_ERROR, "epan/prefs.c", 5021
, __func__, "assertion \"not reached\" failed")
;
5022 break;
5023 }
5024
5025 return 0;
5026}
5027
5028unsigned int prefs_set_float_value(pref_t* pref, double value, pref_source_t source)
5029{
5030 int changed = 0;
5031 switch (source)
5032 {
5033 case pref_default:
5034 if (pref->default_val.floatval != value) {
5035 pref->default_val.floatval = value;
5036 changed = prefs_get_effect_flags(pref);
5037 }
5038 break;
5039 case pref_stashed:
5040 if (pref->stashed_val.floatval != value) {
5041 pref->stashed_val.floatval = value;
5042 changed = prefs_get_effect_flags(pref);
5043 }
5044 break;
5045 case pref_current:
5046 if (*pref->varp.floatp != value) {
5047 *pref->varp.floatp = value;
5048 changed = prefs_get_effect_flags(pref);
5049 }
5050 break;
5051 default:
5052 ws_assert_not_reached()ws_log_fatal_full("Epan", LOG_LEVEL_ERROR, "epan/prefs.c", 5052
, __func__, "assertion \"not reached\" failed")
;
5053 break;
5054 }
5055
5056 return changed;
5057}
5058
5059double prefs_get_float_value(pref_t* pref, pref_source_t source)
5060{
5061 switch (source)
5062 {
5063 case pref_default:
5064 return pref->default_val.floatval;
5065 case pref_stashed:
5066 return pref->stashed_val.floatval;
5067 case pref_current:
5068 return *pref->varp.floatp;
5069 default:
5070 ws_assert_not_reached()ws_log_fatal_full("Epan", LOG_LEVEL_ERROR, "epan/prefs.c", 5070
, __func__, "assertion \"not reached\" failed")
;
5071 break;
5072 }
5073
5074 return 0;
5075}
5076
5077
5078const char *prefs_get_password_value(pref_t *pref, pref_source_t source)
5079{
5080 return prefs_get_string_value(pref, source);
5081}
5082
5083
5084unsigned int prefs_set_uint_value(pref_t *pref, unsigned value, pref_source_t source)
5085{
5086 unsigned int changed = 0;
5087 switch (source)
5088 {
5089 case pref_default:
5090 if (pref->default_val.uint != value) {
5091 pref->default_val.uint = value;
5092 changed = prefs_get_effect_flags(pref);
5093 }
5094 break;
5095 case pref_stashed:
5096 if (pref->stashed_val.uint != value) {
5097 pref->stashed_val.uint = value;
5098 changed = prefs_get_effect_flags(pref);
5099 }
5100 break;
5101 case pref_current:
5102 if (*pref->varp.uint != value) {
5103 *pref->varp.uint = value;
5104 changed = prefs_get_effect_flags(pref);
5105 }
5106 break;
5107 default:
5108 ws_assert_not_reached()ws_log_fatal_full("Epan", LOG_LEVEL_ERROR, "epan/prefs.c", 5108
, __func__, "assertion \"not reached\" failed")
;
5109 break;
5110 }
5111
5112 return changed;
5113}
5114
5115/*
5116 * For use by UI code that sets preferences.
5117 */
5118unsigned int
5119prefs_set_password_value(pref_t *pref, const char* value, pref_source_t source)
5120{
5121 return prefs_set_string_value(pref, value, source);
5122}
5123
5124
5125unsigned prefs_get_uint_base(pref_t *pref)
5126{
5127 return pref->info.base;
5128}
5129
5130/*
5131 * Returns true if the given device is hidden
5132 */
5133bool_Bool
5134prefs_is_capture_device_hidden(const char *name)
5135{
5136 char *tok, *devices;
5137 size_t len;
5138
5139 if (prefs.capture_devices_hide && name) {
5140 devices = g_strdup (prefs.capture_devices_hide)g_strdup_inline (prefs.capture_devices_hide);
5141 len = strlen (name);
5142 for (tok = strtok (devices, ","); tok; tok = strtok(NULL((void*)0), ",")) {
5143 if (strlen (tok) == len && strcmp (name, tok) == 0) {
5144 g_free (devices)(__builtin_object_size ((devices), 0) != ((size_t) - 1)) ? g_free_sized
(devices, __builtin_object_size ((devices), 0)) : (g_free) (
devices)
;
5145 return true1;
5146 }
5147 }
5148 g_free (devices)(__builtin_object_size ((devices), 0) != ((size_t) - 1)) ? g_free_sized
(devices, __builtin_object_size ((devices), 0)) : (g_free) (
devices)
;
5149 }
5150
5151 return false0;
5152}
5153
5154/*
5155 * Returns true if the given column is visible (not hidden)
5156 */
5157static bool_Bool
5158prefs_is_column_visible(const char *cols_hidden, int col)
5159{
5160 char *tok, *cols, *p;
5161 int cidx;
5162
5163 /*
5164 * Do we have a list of hidden columns?
5165 */
5166 if (cols_hidden) {
5167 /*
5168 * Yes - check the column against each of the ones in the
5169 * list.
5170 */
5171 cols = g_strdup(cols_hidden)g_strdup_inline (cols_hidden);
5172 for (tok = strtok(cols, ","); tok; tok = strtok(NULL((void*)0), ",")) {
5173 tok = g_strstrip(tok)g_strchomp (g_strchug (tok));
5174
5175 cidx = (int)strtol(tok, &p, 10);
5176 if (p == tok || *p != '\0') {
5177 continue;
5178 }
5179 if (cidx != col) {
5180 continue;
5181 }
5182 /*
5183 * OK, they match, so it's one of the hidden fields,
5184 * hence not visible.
5185 */
5186 g_free(cols)(__builtin_object_size ((cols), 0) != ((size_t) - 1)) ? g_free_sized
(cols, __builtin_object_size ((cols), 0)) : (g_free) (cols)
;
5187 return false0;
5188 }
5189 g_free(cols)(__builtin_object_size ((cols), 0) != ((size_t) - 1)) ? g_free_sized
(cols, __builtin_object_size ((cols), 0)) : (g_free) (cols)
;
5190 }
5191
5192 /*
5193 * No - either there are no hidden columns or this isn't one
5194 * of them - so it is visible.
5195 */
5196 return true1;
5197}
5198
5199/*
5200 * Returns true if the given column is visible (not hidden)
5201 */
5202static bool_Bool
5203prefs_is_column_fmt_visible(const char *cols_hidden, fmt_data *cfmt)
5204{
5205 char *tok, *cols;
5206 fmt_data cfmt_hidden;
5207
5208 /*
5209 * Do we have a list of hidden columns?
5210 */
5211 if (cols_hidden) {
5212 /*
5213 * Yes - check the column against each of the ones in the
5214 * list.
5215 */
5216 cols = g_strdup(cols_hidden)g_strdup_inline (cols_hidden);
5217 for (tok = strtok(cols, ","); tok; tok = strtok(NULL((void*)0), ",")) {
5218 tok = g_strstrip(tok)g_strchomp (g_strchug (tok));
5219
5220 /*
5221 * Parse this column format.
5222 */
5223 if (!parse_column_format(&cfmt_hidden, tok)) {
5224 /*
5225 * It's not valid; ignore it.
5226 */
5227 continue;
5228 }
5229
5230 /*
5231 * Does it match the column?
5232 */
5233 if (cfmt->fmt != cfmt_hidden.fmt) {
5234 /* No. */
5235 g_free(cfmt_hidden.custom_fields)(__builtin_object_size ((cfmt_hidden.custom_fields), 0) != ((
size_t) - 1)) ? g_free_sized (cfmt_hidden.custom_fields, __builtin_object_size
((cfmt_hidden.custom_fields), 0)) : (g_free) (cfmt_hidden.custom_fields
)
;
5236 cfmt_hidden.custom_fields = NULL((void*)0);
5237 continue;
5238 }
5239 if (cfmt->fmt == COL_CUSTOM) {
5240 /*
5241 * A custom column has to have the same custom field
5242 * and occurrence.
5243 */
5244 if (cfmt_hidden.custom_fields && cfmt->custom_fields) {
5245 if (strcmp(cfmt->custom_fields,
5246 cfmt_hidden.custom_fields) != 0) {
5247 /* Different fields. */
5248 g_free(cfmt_hidden.custom_fields)(__builtin_object_size ((cfmt_hidden.custom_fields), 0) != ((
size_t) - 1)) ? g_free_sized (cfmt_hidden.custom_fields, __builtin_object_size
((cfmt_hidden.custom_fields), 0)) : (g_free) (cfmt_hidden.custom_fields
)
;
5249 cfmt_hidden.custom_fields = NULL((void*)0);
5250 continue;
5251 }
5252 if (cfmt->custom_occurrence != cfmt_hidden.custom_occurrence) {
5253 /* Different occurrences settings. */
5254 g_free(cfmt_hidden.custom_fields)(__builtin_object_size ((cfmt_hidden.custom_fields), 0) != ((
size_t) - 1)) ? g_free_sized (cfmt_hidden.custom_fields, __builtin_object_size
((cfmt_hidden.custom_fields), 0)) : (g_free) (cfmt_hidden.custom_fields
)
;
5255 cfmt_hidden.custom_fields = NULL((void*)0);
5256 continue;
5257 }
5258 }
5259 }
5260
5261 /*
5262 * OK, they match, so it's one of the hidden fields,
5263 * hence not visible.
5264 */
5265 g_free(cfmt_hidden.custom_fields)(__builtin_object_size ((cfmt_hidden.custom_fields), 0) != ((
size_t) - 1)) ? g_free_sized (cfmt_hidden.custom_fields, __builtin_object_size
((cfmt_hidden.custom_fields), 0)) : (g_free) (cfmt_hidden.custom_fields
)
;
5266 g_free(cols)(__builtin_object_size ((cols), 0) != ((size_t) - 1)) ? g_free_sized
(cols, __builtin_object_size ((cols), 0)) : (g_free) (cols)
;
5267 return false0;
5268 }
5269 g_free(cols)(__builtin_object_size ((cols), 0) != ((size_t) - 1)) ? g_free_sized
(cols, __builtin_object_size ((cols), 0)) : (g_free) (cols)
;
5270 }
5271
5272 /*
5273 * No - either there are no hidden columns or this isn't one
5274 * of them - so it is visible.
5275 */
5276 return true1;
5277}
5278
5279/*
5280 * Returns true if the given device should capture in monitor mode by default
5281 */
5282bool_Bool
5283prefs_capture_device_monitor_mode(const char *name)
5284{
5285 char *tok, *devices;
5286 size_t len;
5287
5288 if (prefs.capture_devices_monitor_mode && name) {
5289 devices = g_strdup (prefs.capture_devices_monitor_mode)g_strdup_inline (prefs.capture_devices_monitor_mode);
5290 len = strlen (name);
5291 for (tok = strtok (devices, ","); tok; tok = strtok(NULL((void*)0), ",")) {
5292 if (strlen (tok) == len && strcmp (name, tok) == 0) {
5293 g_free (devices)(__builtin_object_size ((devices), 0) != ((size_t) - 1)) ? g_free_sized
(devices, __builtin_object_size ((devices), 0)) : (g_free) (
devices)
;
5294 return true1;
5295 }
5296 }
5297 g_free (devices)(__builtin_object_size ((devices), 0) != ((size_t) - 1)) ? g_free_sized
(devices, __builtin_object_size ((devices), 0)) : (g_free) (
devices)
;
5298 }
5299
5300 return false0;
5301}
5302
5303bool_Bool
5304prefs_has_layout_pane_content (layout_pane_content_e layout_pane_content)
5305{
5306 return ((prefs.gui_layout_content_1 == layout_pane_content) ||
5307 (prefs.gui_layout_content_2 == layout_pane_content) ||
5308 (prefs.gui_layout_content_3 == layout_pane_content));
5309}
5310
5311char
5312string_to_name_resolve(const char *string, e_addr_resolve *name_resolve)
5313{
5314 char c;
5315
5316 memset(name_resolve, 0, sizeof(e_addr_resolve));
5317 while ((c = *string++) != '\0') {
5318 switch (c) {
5319 case 'g':
5320 name_resolve->maxmind_geoip = true1;
5321 break;
5322 case 'm':
5323 name_resolve->mac_name = true1;
5324 break;
5325 case 'n':
5326 name_resolve->network_name = true1;
5327 break;
5328 case 'N':
5329 name_resolve->use_external_net_name_resolver = true1;
5330 break;
5331 case 't':
5332 name_resolve->transport_name = true1;
5333 break;
5334 case 'd':
5335 name_resolve->dns_pkt_addr_resolution = true1;
5336 break;
5337 case 's':
5338 name_resolve->handshake_sni_addr_resolution = true1;
5339 break;
5340 case 'v':
5341 name_resolve->vlan_name = true1;
5342 break;
5343 default:
5344 /*
5345 * Unrecognized letter.
5346 */
5347 return c;
5348 }
5349 }
5350 return '\0';
5351}
5352
5353static bool_Bool
5354deprecated_heur_dissector_pref(char *pref_name, const char *value)
5355{
5356 struct heur_pref_name
5357 {
5358 const char* pref_name;
5359 const char* short_name;
5360 bool_Bool more_dissectors; /* For multiple dissectors controlled by the same preference */
5361 };
5362
5363 static const struct heur_pref_name heur_prefs[] = {
5364 {"acn.heuristic_acn", "acn_udp", 0},
5365 {"bfcp.enable", "bfcp_tcp", 1},
5366 {"bfcp.enable", "bfcp_udp", 0},
5367 {"bt-dht.enable", "bittorrent_dht_udp", 0},
5368 {"bt-utp.enable", "bt_utp_udp", 0},
5369 {"cattp.enable", "cattp_udp", 0},
5370 {"cfp.enable", "fp_eth", 0},
5371 {"dicom.heuristic", "dicom_tcp", 0},
5372 {"dnp3.heuristics", "dnp3_tcp", 1},
5373 {"dnp3.heuristics", "dnp3_udp", 0},
5374 {"dvb-s2_modeadapt.enable", "dvb_s2_udp", 0},
5375 {"esl.enable", "esl_eth", 0},
5376 {"fp.udp_heur", "fp_udp", 0},
5377 {"gvsp.enable_heuristic", "gvsp_udp", 0},
5378 {"hdcp2.enable", "hdcp2_tcp", 0},
5379 {"hislip.enable_heuristic", "hislip_tcp", 0},
5380 {"infiniband.dissect_eoib", "mellanox_eoib", 1},
5381 {"infiniband.identify_payload", "eth_over_ib", 0},
5382 {"jxta.udp.heuristic", "jxta_udp", 0},
5383 {"jxta.tcp.heuristic", "jxta_tcp", 0},
5384 {"jxta.sctp.heuristic", "jxta_sctp", 0},
5385 {"mac-lte.heuristic_mac_lte_over_udp", "mac_lte_udp", 0},
5386 {"mbim.bulk_heuristic", "mbim_usb_bulk", 0},
5387 {"norm.heuristic_norm", "rmt_norm_udp", 0},
5388 {"openflow.heuristic", "openflow_tcp", 0},
5389 {"pdcp-lte.heuristic_pdcp_lte_over_udp", "pdcp_lte_udp", 0},
5390 {"rlc.heuristic_rlc_over_udp", "rlc_udp", 0},
5391 {"rlc-lte.heuristic_rlc_lte_over_udp", "rlc_lte_udp", 0},
5392 {"rtcp.heuristic_rtcp", "rtcp_udp", 1},
5393 {"rtcp.heuristic_rtcp", "rtcp_stun", 0},
5394 {"rtp.heuristic_rtp", "rtp_udp", 1},
5395 {"rtp.heuristic_rtp", "rtp_stun", 0},
5396 {"teredo.heuristic_teredo", "teredo_udp", 0},
5397 {"vssmonitoring.use_heuristics", "vssmonitoring_eth", 0},
5398 {"xml.heuristic", "xml_http", 1},
5399 {"xml.heuristic", "xml_sip", 1},
5400 {"xml.heuristic", "xml_media", 0},
5401 {"xml.heuristic_tcp", "xml_tcp", 0},
5402 {"xml.heuristic_udp", "xml_udp", 0},
5403 };
5404
5405 unsigned int i;
5406 heur_dtbl_entry_t* heuristic;
5407
5408
5409 for (i = 0; i < array_length(heur_prefs)(sizeof (heur_prefs) / sizeof (heur_prefs)[0]); i++)
5410 {
5411 if (strcmp(pref_name, heur_prefs[i].pref_name) == 0)
5412 {
5413 heuristic = find_heur_dissector_by_unique_short_name(heur_prefs[i].short_name);
5414 if (heuristic != NULL((void*)0)) {
5415 heuristic->enabled = ((g_ascii_strcasecmp(value, "true") == 0) ? true1 : false0);
5416 }
5417
5418 if (!heur_prefs[i].more_dissectors)
5419 return true1;
5420 }
5421 }
5422
5423
5424 return false0;
5425}
5426
5427static bool_Bool
5428deprecated_enable_dissector_pref(char *pref_name, const char *value)
5429{
5430 struct dissector_pref_name
5431 {
5432 const char* pref_name;
5433 const char* short_name;
5434 };
5435
5436 struct dissector_pref_name dissector_prefs[] = {
5437 {"transum.tsumenabled", "TRANSUM"},
5438 {"snort.enable_snort_dissector", "Snort"},
5439 {"prp.enable", "PRP"},
5440 };
5441
5442 unsigned int i;
5443 int proto_id;
5444
5445 for (i = 0; i < array_length(dissector_prefs)(sizeof (dissector_prefs) / sizeof (dissector_prefs)[0]); i++)
5446 {
5447 if (strcmp(pref_name, dissector_prefs[i].pref_name) == 0)
5448 {
5449 proto_id = proto_get_id_by_short_name(dissector_prefs[i].short_name);
5450 if (proto_id >= 0)
5451 proto_set_decoding(proto_id, ((g_ascii_strcasecmp(value, "true") == 0) ? true1 : false0));
5452 return true1;
5453 }
5454 }
5455
5456 return false0;
5457}
5458
5459static bool_Bool
5460deprecated_port_pref(char *pref_name, const char *value)
5461{
5462 struct port_pref_name
5463 {
5464 const char* pref_name;
5465 const char* module_name; /* the protocol filter name */
5466 const char* table_name;
5467 unsigned base;
5468 };
5469
5470 struct obsolete_pref_name
5471 {
5472 const char* pref_name;
5473 };
5474
5475 /* For now this is only supporting TCP/UDP port and RTP payload
5476 * types dissector preferences, which are assumed to be decimal */
5477 /* module_name is the filter name of the destination port preference,
5478 * which is usually the same as the original module but not
5479 * necessarily (e.g., if the preference is for what is now a PINO.)
5480 * XXX: Most of these were changed pre-2.0. Can we end support
5481 * for migrating legacy preferences at some point?
5482 */
5483 static const struct port_pref_name port_prefs[] = {
5484 /* TCP */
5485 {"cmp.tcp_alternate_port", "cmp", "tcp.port", 10},
5486 {"h248.tcp_port", "h248", "tcp.port", 10},
5487 {"cops.tcp.cops_port", "cops", "tcp.port", 10},
5488 {"dhcpfo.tcp_port", "dhcpfo", "tcp.port", 10},
5489 {"enttec.tcp_port", "enttec", "tcp.port", 10},
5490 {"forces.tcp_alternate_port", "forces", "tcp.port", 10},
5491 {"ged125.tcp_port", "ged125", "tcp.port", 10},
5492 {"hpfeeds.dissector_port", "hpfeeds", "tcp.port", 10},
5493 {"lsc.port", "lsc", "tcp.port", 10},
5494 {"megaco.tcp.txt_port", "megaco", "tcp.port", 10},
5495 {"netsync.tcp_port", "netsync", "tcp.port", 10},
5496 {"osi.tpkt_port", "osi", "tcp.port", 10},
5497 {"rsync.tcp_port", "rsync", "tcp.port", 10},
5498 {"sametime.tcp_port", "sametime", "tcp.port", 10},
5499 {"sigcomp.tcp.port2", "sigcomp", "tcp.port", 10},
5500 {"synphasor.tcp_port", "synphasor", "tcp.port", 10},
5501 {"tipc.alternate_port", "tipc", "tcp.port", 10},
5502 {"vnc.alternate_port", "vnc", "tcp.port", 10},
5503 {"scop.port", "scop", "tcp.port", 10},
5504 {"scop.port_secure", "scop", "tcp.port", 10},
5505 {"tpncp.tcp.trunkpack_port", "tpncp", "tcp.port", 10},
5506 /* UDP */
5507 {"h248.udp_port", "h248", "udp.port", 10},
5508 {"actrace.udp_port", "actrace", "udp.port", 10},
5509 {"brp.port", "brp", "udp.port", 10},
5510 {"bvlc.additional_udp_port", "bvlc", "udp.port", 10},
5511 {"capwap.udp.port.control", "capwap", "udp.port", 10},
5512 {"capwap.udp.port.data", "capwap", "udp.port", 10},
5513 {"coap.udp_port", "coap", "udp.port", 10},
5514 {"enttec.udp_port", "enttec", "udp.port", 10},
5515 {"forces.udp_alternate_port", "forces", "udp.port", 10},
5516 {"ldss.udp_port", "ldss", "udp.port", 10},
5517 {"lmp.udp_port", "lmp", "udp.port", 10},
5518 {"ltp.port", "ltp", "udp.port", 10},
5519 {"lwres.udp.lwres_port", "lwres", "udp.port", 10},
5520 {"megaco.udp.txt_port", "megaco", "udp.port", 10},
5521 {"pfcp.port_pfcp", "pfcp", "udp.port", 10},
5522 {"pgm.udp.encap_ucast_port", "pgm", "udp.port", 10},
5523 {"pgm.udp.encap_mcast_port", "pgm", "udp.port", 10},
5524 {"quic.udp.quic.port", "quic", "udp.port", 10},
5525 {"quic.udp.quics.port", "quic", "udp.port", 10},
5526 {"radius.alternate_port", "radius", "udp.port", 10},
5527 {"rdt.default_udp_port", "rdt", "udp.port", 10},
5528 {"alc.default.udp_port", "alc", "udp.port", 10},
5529 {"sigcomp.udp.port2", "sigcomp", "udp.port", 10},
5530 {"synphasor.udp_port", "synphasor", "udp.port", 10},
5531 {"tdmop.udpport", "tdmop", "udp.port", 10},
5532 {"uaudp.port1", "uaudp", "udp.port", 10},
5533 {"uaudp.port2", "uaudp", "udp.port", 10},
5534 {"uaudp.port3", "uaudp", "udp.port", 10},
5535 {"uaudp.port4", "uaudp", "udp.port", 10},
5536 {"uhd.dissector_port", "uhd", "udp.port", 10},
5537 {"vrt.dissector_port", "vrt", "udp.port", 10},
5538 {"tpncp.udp.trunkpack_port", "tpncp", "udp.port", 10},
5539 /* SCTP */
5540 {"hnbap.port", "hnbap", "sctp.port", 10},
5541 {"m2pa.port", "m2pa", "sctp.port", 10},
5542 {"megaco.sctp.txt_port", "megaco", "sctp.port", 10},
5543 {"rua.port", "rua", "sctp.port", 10},
5544 /* SCTP PPI */
5545 {"lapd.sctp_payload_protocol_identifier", "lapd", "sctp.ppi", 10},
5546 /* SCCP SSN */
5547 {"ranap.sccp_ssn", "ranap", "sccp.ssn", 10},
5548 };
5549
5550 static const struct port_pref_name port_range_prefs[] = {
5551 /* TCP */
5552 {"couchbase.tcp.ports", "couchbase", "tcp.port", 10},
5553 {"gsm_ipa.tcp_ports", "gsm_ipa", "tcp.port", 10},
5554 {"kafka.tcp.ports", "kafka", "tcp.port", 10},
5555 {"kt.tcp.ports", "kt", "tcp.port", 10},
5556 {"memcache.tcp.ports", "memcache", "tcp.port", 10},
5557 {"mrcpv2.tcp.port_range", "mrcpv2", "tcp.port", 10},
5558 {"pdu_transport.ports.tcp", "pdu_transport", "tcp.port", 10},
5559 {"rtsp.tcp.port_range", "rtsp", "tcp.port", 10},
5560 {"sip.tcp.ports", "sip", "tcp.port", 10},
5561 {"someip.ports.tcp", "someip", "tcp.port", 10},
5562 {"tds.tcp_ports", "tds", "tcp.port", 10},
5563 {"tpkt.tcp.ports", "tpkt", "tcp.port", 10},
5564 {"uma.tcp.ports", "uma", "tcp.port", 10},
5565 /* UDP */
5566 {"aruba_erm.udp.ports", "arubs_erm", "udp.port", 10},
5567 {"diameter.udp.ports", "diameter", "udp.port", 10},
5568 {"dmp.udp_ports", "dmp", "udp.port", 10},
5569 {"dns.udp.ports", "dns", "udp.port", 10},
5570 {"gsm_ipa.udp_ports", "gsm_ipa", "udp.port", 10},
5571 {"hcrt.dissector_udp_port", "hcrt", "udp.port", 10},
5572 {"memcache.udp.ports", "memcache", "udp.port", 10},
5573 {"nb_rtpmux.udp_ports", "nb_rtpmux", "udp.port", 10},
5574 {"gprs-ns.udp.ports", "gprs-ns", "udp.port", 10},
5575 {"p_mul.udp_ports", "p_mul", "udp.port", 10},
5576 {"pdu_transport.ports.udp", "pdu_transport", "udp.port", 10},
5577 {"radius.ports", "radius", "udp.port", 10},
5578 {"sflow.ports", "sflow", "udp.port", 10},
5579 {"someip.ports.udp", "someip", "udp.port", 10},
5580 {"sscop.udp.ports", "sscop", "udp.port", 10},
5581 {"tftp.udp_ports", "tftp", "udp.port", 10},
5582 {"tipc.udp.ports", "tipc", "udp.port", 10},
5583 /* RTP */
5584 {"amr.dynamic.payload.type", "amr", "rtp.pt", 10},
5585 {"amr.wb.dynamic.payload.type", "amr_wb", "rtp.pt", 10},
5586 {"dvb-s2_modeadapt.dynamic.payload.type", "dvb-s2_modeadapt", "rtp.pt", 10},
5587 {"evs.dynamic.payload.type", "evs", "rtp.pt", 10},
5588 {"h263p.dynamic.payload.type", "h263p", "rtp.pt", 10},
5589 {"h264.dynamic.payload.type", "h264", "rtp.pt", 10},
5590 {"h265.dynamic.payload.type", "h265", "rtp.pt", 10},
5591 {"ismacryp.dynamic.payload.type", "ismacryp", "rtp.pt", 10},
5592 {"iuup.dynamic.payload.type", "iuup", "rtp.pt", 10},
5593 {"lapd.rtp_payload_type", "lapd", "rtp.pt", 10},
5594 {"mp4ves.dynamic.payload.type", "mp4ves", "rtp.pt", 10},
5595 {"mtp2.rtp_payload_type", "mtp2", "rtp.pt", 10},
5596 {"opus.dynamic.payload.type", "opus", "rtp.pt", 10},
5597 {"rtp.rfc2198_payload_type", "rtp_rfc2198", "rtp.pt", 10},
5598 {"rtpevent.event_payload_type_value", "rtpevent", "rtp.pt", 10},
5599 {"rtpevent.cisco_nse_payload_type_value", "rtpevent", "rtp.pt", 10},
5600 {"rtpmidi.midi_payload_type_value", "rtpmidi", "rtp.pt", 10},
5601 {"vp8.dynamic.payload.type", "vp8", "rtp.pt", 10},
5602 /* SCTP */
5603 {"diameter.sctp.ports", "diameter", "sctp.port", 10},
5604 {"sgsap.sctp_ports", "sgsap", "sctp.port", 10},
5605 /* SCCP SSN */
5606 {"pcap.ssn", "pcap", "sccp.ssn", 10},
5607 };
5608
5609 /* These are subdissectors of TPKT/OSITP that used to have a
5610 TCP port preference even though they were never
5611 directly on TCP. Convert them to use Decode As
5612 with the TPKT dissector handle */
5613 static const struct port_pref_name tpkt_subdissector_port_prefs[] = {
5614 {"dap.tcp.port", "dap", "tcp.port", 10},
5615 {"disp.tcp.port", "disp", "tcp.port", 10},
5616 {"dop.tcp.port", "dop", "tcp.port", 10},
5617 {"dsp.tcp.port", "dsp", "tcp.port", 10},
5618 {"p1.tcp.port", "p1", "tcp.port", 10},
5619 {"p7.tcp.port", "p7", "tcp.port", 10},
5620 {"rdp.tcp.port", "rdp", "tcp.port", 10},
5621 };
5622
5623 /* These are obsolete preferences from the dissectors' view,
5624 (typically because of a switch from a single value to a
5625 range value) but the name of the preference conflicts
5626 with the generated preference name from the dissector table.
5627 Don't allow the obsolete preference through to be handled */
5628 static const struct obsolete_pref_name obsolete_prefs[] = {
5629 {"diameter.tcp.port"},
5630 {"kafka.tcp.port"},
5631 {"mrcpv2.tcp.port"},
5632 {"rtsp.tcp.port"},
5633 {"sip.tcp.port"},
5634 {"t38.tcp.port"},
5635 };
5636
5637 unsigned int i;
5638 unsigned uval;
5639 dissector_table_t sub_dissectors;
5640 dissector_handle_t handle, tpkt_handle;
5641 module_t *module;
5642 pref_t *pref;
5643
5644 static bool_Bool sanity_checked;
5645 if (!sanity_checked) {
5646 sanity_checked = true1;
5647 for (i = 0; i < G_N_ELEMENTS(port_prefs)(sizeof (port_prefs) / sizeof ((port_prefs)[0])); i++) {
5648 module = prefs_find_module(port_prefs[i].module_name);
5649 if (!module) {
5650 // We might not be Wireshark, and therefore might not have deprecated port prefs.
5651 ws_noisy("Deprecated ports pref check - module '%s' not found", port_prefs[i].module_name)do { if (1) { ws_log_full("Epan", LOG_LEVEL_NOISY, "epan/prefs.c"
, 5651, __func__, "Deprecated ports pref check - module '%s' not found"
, port_prefs[i].module_name); } } while (0)
;
5652 continue;
5653 }
5654 pref = prefs_find_preference(module, port_prefs[i].table_name);
5655 if (!pref) {
5656 ws_warning("Deprecated ports pref '%s.%s' not found", module->name, port_prefs[i].table_name)do { if (1) { ws_log_full("Epan", LOG_LEVEL_WARNING, "epan/prefs.c"
, 5656, __func__, "Deprecated ports pref '%s.%s' not found", module
->name, port_prefs[i].table_name); } } while (0)
;
5657 continue;
5658 }
5659 if (pref->type != PREF_DECODE_AS_RANGE) {
5660 ws_warning("Deprecated ports pref '%s.%s' has wrong type: %#x (%s)", module->name, port_prefs[i].table_name, pref->type, prefs_pref_type_name(pref))do { if (1) { ws_log_full("Epan", LOG_LEVEL_WARNING, "epan/prefs.c"
, 5660, __func__, "Deprecated ports pref '%s.%s' has wrong type: %#x (%s)"
, module->name, port_prefs[i].table_name, pref->type, prefs_pref_type_name
(pref)); } } while (0)
;
5661 }
5662 }
5663 }
5664
5665 for (i = 0; i < G_N_ELEMENTS(port_prefs)(sizeof (port_prefs) / sizeof ((port_prefs)[0])); i++) {
5666 if (strcmp(pref_name, port_prefs[i].pref_name) == 0) {
5667 if (!ws_basestrtou32(value, NULL((void*)0), &uval, port_prefs[i].base))
5668 return false0; /* number was bad */
5669
5670 module = prefs_find_module(port_prefs[i].module_name);
5671 pref = prefs_find_preference(module, port_prefs[i].table_name);
5672 if (pref != NULL((void*)0)) {
5673 module->prefs_changed_flags |= prefs_get_effect_flags(pref);
5674 if (pref->type == PREF_DECODE_AS_RANGE) {
5675 // The legacy preference was a port number, but the new
5676 // preference is a port range. Add to existing range.
5677 if (uval) {
5678 prefs_range_add_value(pref, uval);
5679 }
5680 }
5681 }
5682
5683 /* If the value is zero, it wouldn't add to the Decode As tables */
5684 if (uval != 0)
5685 {
5686 sub_dissectors = find_dissector_table(port_prefs[i].table_name);
5687 if (sub_dissectors != NULL((void*)0)) {
5688 handle = dissector_table_get_dissector_handle(sub_dissectors, module->title);
5689 if (handle != NULL((void*)0)) {
5690 dissector_change_uint(port_prefs[i].table_name, uval, handle);
5691 decode_build_reset_list(port_prefs[i].table_name, dissector_table_get_type(sub_dissectors), GUINT_TO_POINTER(uval)((gpointer) (gulong) (uval)), NULL((void*)0), NULL((void*)0));
5692 }
5693 }
5694 }
5695
5696 return true1;
5697 }
5698 }
5699
5700 for (i = 0; i < array_length(port_range_prefs)(sizeof (port_range_prefs) / sizeof (port_range_prefs)[0]); i++)
5701 {
5702 if (strcmp(pref_name, port_range_prefs[i].pref_name) == 0)
5703 {
5704 uint32_t range_i, range_j;
5705
5706 sub_dissectors = find_dissector_table(port_range_prefs[i].table_name);
5707 if (sub_dissectors != NULL((void*)0)) {
5708 switch (dissector_table_get_type(sub_dissectors)) {
5709 case FT_UINT8:
5710 case FT_UINT16:
5711 case FT_UINT24:
5712 case FT_UINT32:
5713 break;
5714
5715 default:
5716 ws_error("The dissector table %s (%s) is not an integer type - are you using a buggy plugin?", port_range_prefs[i].table_name, get_dissector_table_ui_name(port_range_prefs[i].table_name))ws_log_fatal_full("Epan", LOG_LEVEL_ERROR, "epan/prefs.c", 5716
, __func__, "The dissector table %s (%s) is not an integer type - are you using a buggy plugin?"
, port_range_prefs[i].table_name, get_dissector_table_ui_name
(port_range_prefs[i].table_name))
;
5717 ws_assert_not_reached()ws_log_fatal_full("Epan", LOG_LEVEL_ERROR, "epan/prefs.c", 5717
, __func__, "assertion \"not reached\" failed")
;
5718 }
5719
5720 module = prefs_find_module(port_range_prefs[i].module_name);
5721 pref = prefs_find_preference(module, port_range_prefs[i].table_name);
5722 if (pref != NULL((void*)0))
5723 {
5724 if (!prefs_set_range_value_work(pref, value, true1, &module->prefs_changed_flags))
5725 {
5726 return false0; /* number was bad */
5727 }
5728
5729 handle = dissector_table_get_dissector_handle(sub_dissectors, module->title);
5730 if (handle != NULL((void*)0)) {
5731
5732 for (range_i = 0; range_i < (*pref->varp.range)->nranges; range_i++) {
5733 for (range_j = (*pref->varp.range)->ranges[range_i].low; range_j < (*pref->varp.range)->ranges[range_i].high; range_j++) {
5734 dissector_change_uint(port_range_prefs[i].table_name, range_j, handle);
5735 decode_build_reset_list(port_range_prefs[i].table_name, dissector_table_get_type(sub_dissectors), GUINT_TO_POINTER(range_j)((gpointer) (gulong) (range_j)), NULL((void*)0), NULL((void*)0));
5736 }
5737
5738 dissector_change_uint(port_range_prefs[i].table_name, (*pref->varp.range)->ranges[range_i].high, handle);
5739 decode_build_reset_list(port_range_prefs[i].table_name, dissector_table_get_type(sub_dissectors), GUINT_TO_POINTER((*pref->varp.range)->ranges[range_i].high)((gpointer) (gulong) ((*pref->varp.range)->ranges[range_i
].high))
, NULL((void*)0), NULL((void*)0));
5740 }
5741 }
5742 }
5743 }
5744
5745 return true1;
5746 }
5747 }
5748
5749 for (i = 0; i < array_length(tpkt_subdissector_port_prefs)(sizeof (tpkt_subdissector_port_prefs) / sizeof (tpkt_subdissector_port_prefs
)[0])
; i++)
5750 {
5751 if (strcmp(pref_name, tpkt_subdissector_port_prefs[i].pref_name) == 0)
5752 {
5753 /* XXX - give an error if it doesn't fit in a unsigned? */
5754 if (!ws_basestrtou32(value, NULL((void*)0), &uval, tpkt_subdissector_port_prefs[i].base))
5755 return false0; /* number was bad */
5756
5757 /* If the value is 0 or 102 (default TPKT port), don't add to the Decode As tables */
5758 if ((uval != 0) && (uval != 102))
5759 {
5760 tpkt_handle = find_dissector("tpkt");
5761 if (tpkt_handle != NULL((void*)0)) {
5762 dissector_change_uint(tpkt_subdissector_port_prefs[i].table_name, uval, tpkt_handle);
5763 }
5764 }
5765
5766 return true1;
5767 }
5768 }
5769
5770 for (i = 0; i < array_length(obsolete_prefs)(sizeof (obsolete_prefs) / sizeof (obsolete_prefs)[0]); i++)
5771 {
5772 if (strcmp(pref_name, obsolete_prefs[i].pref_name) == 0)
5773 {
5774 /* Just ignore the preference */
5775 return true1;
5776 }
5777 }
5778 return false0;
5779}
5780
5781static prefs_set_pref_e
5782set_pref(char *pref_name, const char *value, void *private_data,
5783 bool_Bool return_range_errors)
5784{
5785 unsigned cval;
5786 unsigned uval;
5787 bool_Bool bval;
5788 int enum_val, ival;
5789 double fval;
5790 char *dotp, *last_dotp;
5791 module_t *module, *containing_module, *target_module;
5792 pref_t *pref;
5793 bool_Bool converted_pref = false0;
5794
5795 target_module = (module_t*)private_data;
5796
5797 if (deprecated_heur_dissector_pref(pref_name, value)) {
5798 /* Handled within deprecated_heur_dissector_pref() if found */
5799 } else if (deprecated_enable_dissector_pref(pref_name, value)) {
5800 /* Handled within deprecated_enable_dissector_pref() if found */
5801 } else if (deprecated_port_pref(pref_name, value)) {
5802 /* Handled within deprecated_port_pref() if found */
5803 } else if (strcmp(pref_name, "console.log.level") == 0) {
5804 /* Handled on the command line within ws_log_parse_args() */
5805 return PREFS_SET_OK;
5806 } else {
5807 /* To which module does this preference belong? */
5808 module = NULL((void*)0);
5809 last_dotp = pref_name;
5810 while (!module) {
5811 dotp = strchr(last_dotp, '.');
5812 if (dotp == NULL((void*)0)) {
5813 /* Either there's no such module, or no module was specified.
5814 In either case, that means there's no such preference. */
5815 return PREFS_SET_NO_SUCH_PREF;
5816 }
5817 *dotp = '\0'; /* separate module and preference name */
5818 module = prefs_find_module(pref_name);
5819
5820 /*
5821 * XXX - "Diameter" rather than "diameter" was used in earlier
5822 * versions of Wireshark; if we didn't find the module, and its name
5823 * was "Diameter", look for "diameter" instead.
5824 *
5825 * In addition, the BEEP protocol used to be the BXXP protocol,
5826 * so if we didn't find the module, and its name was "bxxp",
5827 * look for "beep" instead.
5828 *
5829 * Also, the preferences for GTP v0 and v1 were combined under
5830 * a single "gtp" heading, and the preferences for SMPP were
5831 * moved to "smpp-gsm-sms" and then moved to "gsm-sms-ud".
5832 * However, SMPP now has its own preferences, so we just map
5833 * "smpp-gsm-sms" to "gsm-sms-ud", and then handle SMPP below.
5834 *
5835 * We also renamed "dcp" to "dccp", "x.25" to "x25", "x411" to "p1"
5836 * and "nsip" to "gprs_ns".
5837 *
5838 * The SynOptics Network Management Protocol (SONMP) is now known by
5839 * its modern name, the Nortel Discovery Protocol (NDP).
5840 */
5841 if (module == NULL((void*)0)) {
5842 /*
5843 * See if there's a backwards-compatibility name
5844 * that maps to this module.
5845 */
5846 module = prefs_find_module_alias(pref_name);
5847 if (module == NULL((void*)0)) {
5848 /*
5849 * There's no alias for the module; see if the
5850 * module name matches any protocol aliases.
5851 */
5852 header_field_info *hfinfo = proto_registrar_get_byalias(pref_name);
5853 if (hfinfo) {
5854 module = (module_t *) wmem_tree_lookup_string(prefs_modules, hfinfo->abbrev, WMEM_TREE_STRING_NOCASE0x00000001);
5855 }
5856 }
5857 if (module) {
5858 converted_pref = true1;
5859 }
5860 }
5861 *dotp = '.'; /* put the preference string back */
5862 dotp++; /* skip past separator to preference name */
5863 last_dotp = dotp;
5864 }
5865
5866 /* The pref is located in the module or a submodule.
5867 * Assume module, then search for a submodule holding the pref. */
5868 containing_module = module;
5869 pref = prefs_find_preference_with_submodule(module, dotp, &containing_module);
5870
5871 if (pref == NULL((void*)0)) {
5872 /* "gui" prefix was added to column preferences for better organization
5873 * within the preferences file
5874 */
5875 if (module == gui_column_module) {
5876 /* While this has a subtree, there is no apply callback, so no
5877 * need to use prefs_find_preference_with_submodule to update
5878 * containing_module. It would not be useful. */
5879 pref = prefs_find_preference(module, pref_name);
5880 }
5881 else if (strcmp(module->name, "tcp") == 0) {
5882 /* Handle old names for TCP preferences. */
5883 if (strcmp(dotp, "dissect_experimental_options_with_magic") == 0)
5884 pref = prefs_find_preference(module, "dissect_experimental_options_rfc6994");
5885 } else if (strcmp(module->name, "extcap") == 0) {
5886 /* Handle the old "sshdump.remotesudo" preference; map it to the new
5887 "sshdump.remotepriv" preference, and map the boolean values to the
5888 appropriate strings of the new preference. */
5889 if (strcmp(dotp, "sshdump.remotesudo") == 0) {
5890 pref = prefs_find_preference(module, "sshdump.remotepriv");
5891 if (g_ascii_strcasecmp(value, "true") == 0)
5892 value = "sudo";
5893 else
5894 value = "none";
5895 }
5896 }
5897 if (pref) {
5898 converted_pref = true1;
5899 }
5900 }
5901 if (pref == NULL((void*)0) ) {
5902 if (strcmp(module->name, "extcap") == 0 && g_list_length(module->prefs) <= 1) {
5903 /*
5904 * Assume that we've skipped extcap preference registration
5905 * and that only extcap.gui_save_on_start is loaded.
5906 */
5907 return PREFS_SET_OK;
5908 }
5909 return PREFS_SET_NO_SUCH_PREF; /* no such preference */
5910 }
5911
5912 if (target_module && target_module != containing_module) {
5913 /* Ignore */
5914 return PREFS_SET_OK;
5915 }
5916
5917 if (pref->obsolete)
5918 return PREFS_SET_OBSOLETE; /* no such preference any more */
5919
5920 if (converted_pref) {
5921 ws_warning("Preference \"%s\" has been converted to \"%s.%s\"\n"do { if (1) { ws_log_full("Epan", LOG_LEVEL_WARNING, "epan/prefs.c"
, 5923, __func__, "Preference \"%s\" has been converted to \"%s.%s\"\n"
"Save your preferences to make this change permanent.", pref_name
, module->name ? module->name : module->parent->name
, prefs_get_name(pref)); } } while (0)
5922 "Save your preferences to make this change permanent.",do { if (1) { ws_log_full("Epan", LOG_LEVEL_WARNING, "epan/prefs.c"
, 5923, __func__, "Preference \"%s\" has been converted to \"%s.%s\"\n"
"Save your preferences to make this change permanent.", pref_name
, module->name ? module->name : module->parent->name
, prefs_get_name(pref)); } } while (0)
5923 pref_name, module->name ? module->name : module->parent->name, prefs_get_name(pref))do { if (1) { ws_log_full("Epan", LOG_LEVEL_WARNING, "epan/prefs.c"
, 5923, __func__, "Preference \"%s\" has been converted to \"%s.%s\"\n"
"Save your preferences to make this change permanent.", pref_name
, module->name ? module->name : module->parent->name
, prefs_get_name(pref)); } } while (0)
;
5924 }
5925
5926 switch (pref->type) {
5927
5928 case PREF_UINT:
5929 if (!ws_basestrtou32(value, NULL((void*)0), &uval, pref->info.base))
5930 return PREFS_SET_SYNTAX_ERR; /* number was bad */
5931 if (*pref->varp.uint != uval) {
5932 containing_module->prefs_changed_flags |= prefs_get_effect_flags(pref);
5933 *pref->varp.uint = uval;
5934 }
5935 break;
5936
5937 case PREF_INT:
5938 if (!ws_strtoi32(value, NULL((void*)0), &ival))
5939 return PREFS_SET_SYNTAX_ERR; /* number was bad */
5940 if (*pref->varp.intp != ival) {
5941 containing_module->prefs_changed_flags |= prefs_get_effect_flags(pref);
5942 *pref->varp.intp = ival;
5943 }
5944 break;
5945
5946 case PREF_FLOAT:
5947 fval = g_ascii_strtod(value, NULL((void*)0));
5948 if (errno(*__errno_location ()) == ERANGE34)
5949 return PREFS_SET_SYNTAX_ERR; /* number was bad */
5950
5951 if (*pref->varp.floatp != fval) {
5952 containing_module->prefs_changed_flags |= prefs_get_effect_flags(pref);
5953 *pref->varp.floatp = fval;
5954 }
5955 break;
5956
5957 case PREF_BOOL:
5958 /* XXX - give an error if it's neither "true" nor "false"? */
5959 if (g_ascii_strcasecmp(value, "true") == 0)
5960 bval = true1;
5961 else
5962 bval = false0;
5963 if (*pref->varp.boolp != bval) {
5964 containing_module->prefs_changed_flags |= prefs_get_effect_flags(pref);
5965 *pref->varp.boolp = bval;
5966 }
5967 break;
5968
5969 case PREF_ENUM:
5970 /* XXX - give an error if it doesn't match? */
5971 enum_val = find_val_for_string(value, pref->info.enum_info.enumvals,
5972 *pref->varp.enump);
5973 if (*pref->varp.enump != enum_val) {
5974 containing_module->prefs_changed_flags |= prefs_get_effect_flags(pref);
5975 *pref->varp.enump = enum_val;
5976 }
5977 break;
5978
5979 case PREF_STRING:
5980 case PREF_SAVE_FILENAME:
5981 case PREF_OPEN_FILENAME:
5982 case PREF_DIRNAME:
5983 case PREF_DISSECTOR:
5984 containing_module->prefs_changed_flags |= prefs_set_string_value(pref, value, pref_current);
5985 break;
5986
5987 case PREF_PASSWORD:
5988 /* Read value is every time empty */
5989 containing_module->prefs_changed_flags |= prefs_set_string_value(pref, "", pref_current);
5990 break;
5991
5992 case PREF_RANGE:
5993 {
5994 if (!prefs_set_range_value_work(pref, value, return_range_errors,
5995 &containing_module->prefs_changed_flags))
5996 return PREFS_SET_SYNTAX_ERR; /* number was bad */
5997 break;
5998 }
5999 case PREF_DECODE_AS_RANGE:
6000 {
6001 /* This is for backwards compatibility in case any of the preferences
6002 that shared the "Decode As" preference name and used to be PREF_RANGE
6003 are now applied directly to the Decode As functionality */
6004 range_t *newrange;
6005 dissector_table_t sub_dissectors;
6006 dissector_handle_t handle;
6007 uint32_t i, j;
6008
6009 if (range_convert_str_work(pref->scope, &newrange, value, pref->info.max_value,
6010 return_range_errors) != CVT_NO_ERROR) {
6011 return PREFS_SET_SYNTAX_ERR; /* number was bad */
6012 }
6013
6014 if (!ranges_are_equal(*pref->varp.range, newrange)) {
6015 wmem_free(pref->scope, *pref->varp.range);
6016 *pref->varp.range = newrange;
6017 containing_module->prefs_changed_flags |= prefs_get_effect_flags(pref);
6018
6019 const char* table_name = prefs_get_dissector_table(pref);
6020 sub_dissectors = find_dissector_table(table_name);
6021 if (sub_dissectors != NULL((void*)0)) {
6022 handle = dissector_table_get_dissector_handle(sub_dissectors, module->title);
6023 if (handle != NULL((void*)0)) {
6024 /* Delete all of the old values from the dissector table */
6025 for (i = 0; i < (*pref->varp.range)->nranges; i++) {
6026 for (j = (*pref->varp.range)->ranges[i].low; j < (*pref->varp.range)->ranges[i].high; j++) {
6027 dissector_delete_uint(table_name, j, handle);
6028 decode_build_reset_list(table_name, dissector_table_get_type(sub_dissectors), GUINT_TO_POINTER(j)((gpointer) (gulong) (j)), NULL((void*)0), NULL((void*)0));
6029 }
6030
6031 dissector_delete_uint(table_name, (*pref->varp.range)->ranges[i].high, handle);
6032 decode_build_reset_list(table_name, dissector_table_get_type(sub_dissectors), GUINT_TO_POINTER((*pref->varp.range)->ranges[i].high)((gpointer) (gulong) ((*pref->varp.range)->ranges[i].high
))
, NULL((void*)0), NULL((void*)0));
6033 }
6034
6035 /* Add new values to the dissector table */
6036 for (i = 0; i < newrange->nranges; i++) {
6037 for (j = newrange->ranges[i].low; j < newrange->ranges[i].high; j++) {
6038 dissector_change_uint(table_name, j, handle);
6039 decode_build_reset_list(table_name, dissector_table_get_type(sub_dissectors), GUINT_TO_POINTER(j)((gpointer) (gulong) (j)), NULL((void*)0), NULL((void*)0));
6040 }
6041
6042 dissector_change_uint(table_name, newrange->ranges[i].high, handle);
6043 decode_build_reset_list(table_name, dissector_table_get_type(sub_dissectors), GUINT_TO_POINTER(newrange->ranges[i].high)((gpointer) (gulong) (newrange->ranges[i].high)), NULL((void*)0), NULL((void*)0));
6044 }
6045
6046 /* XXX - Do we save the decode_as_entries file here? */
6047 }
6048 }
6049 } else {
6050 wmem_free(pref->scope, newrange);
6051 }
6052 break;
6053 }
6054
6055 case PREF_COLOR:
6056 {
6057 if (!ws_hexstrtou32(value, NULL((void*)0), &cval))
6058 return PREFS_SET_SYNTAX_ERR; /* number was bad */
6059 if ((pref->varp.colorp->red != RED_COMPONENT(cval)(uint16_t) (((((cval) >> 16) & 0xff) * 65535 / 255)
)
) ||
6060 (pref->varp.colorp->green != GREEN_COMPONENT(cval)(uint16_t) (((((cval) >> 8) & 0xff) * 65535 / 255))) ||
6061 (pref->varp.colorp->blue != BLUE_COMPONENT(cval)(uint16_t) ( (((cval) & 0xff) * 65535 / 255)))) {
6062 containing_module->prefs_changed_flags |= prefs_get_effect_flags(pref);
6063 pref->varp.colorp->red = RED_COMPONENT(cval)(uint16_t) (((((cval) >> 16) & 0xff) * 65535 / 255)
)
;
6064 pref->varp.colorp->green = GREEN_COMPONENT(cval)(uint16_t) (((((cval) >> 8) & 0xff) * 65535 / 255));
6065 pref->varp.colorp->blue = BLUE_COMPONENT(cval)(uint16_t) ( (((cval) & 0xff) * 65535 / 255));
6066 }
6067 break;
6068 }
6069
6070 case PREF_CUSTOM:
6071 return pref->custom_cbs.set_cb(pref, value, &containing_module->prefs_changed_flags);
6072
6073 case PREF_STATIC_TEXT:
6074 case PREF_UAT:
6075 break;
6076
6077 case PREF_PROTO_TCP_SNDAMB_ENUM:
6078 {
6079 /* There's no point in setting the TCP sequence override
6080 * value from the command line, because the pref is different
6081 * for each frame and reset to the default (0) for each new
6082 * file.
6083 */
6084 break;
6085 }
6086 }
6087 }
6088
6089 return PREFS_SET_OK;
6090}
6091
6092typedef struct {
6093 FILE *pf;
6094 bool_Bool is_gui_module;
6095 bool_Bool is_extcap_module;
6096} write_gui_pref_arg_t;
6097
6098const char *
6099prefs_pref_type_name(pref_t *pref)
6100{
6101 const char *type_name = "[Unknown]";
6102
6103 if (!pref) {
6104 return type_name; /* ...or maybe assert? */
6105 }
6106
6107 if (pref->obsolete) {
6108 type_name = "Obsolete";
6109 } else {
6110 switch (pref->type) {
6111
6112 case PREF_UINT:
6113 switch (pref->info.base) {
6114
6115 case 10:
6116 type_name = "Decimal";
6117 break;
6118
6119 case 8:
6120 type_name = "Octal";
6121 break;
6122
6123 case 16:
6124 type_name = "Hexadecimal";
6125 break;
6126 }
6127 break;
6128
6129 case PREF_INT:
6130 type_name = "Integer";
6131 break;
6132
6133 case PREF_FLOAT:
6134 type_name = "Float";
6135 break;
6136
6137 case PREF_BOOL:
6138 type_name = "Boolean";
6139 break;
6140
6141 case PREF_ENUM:
6142 case PREF_PROTO_TCP_SNDAMB_ENUM:
6143 type_name = "Choice";
6144 break;
6145
6146 case PREF_STRING:
6147 type_name = "String";
6148 break;
6149
6150 case PREF_SAVE_FILENAME:
6151 case PREF_OPEN_FILENAME:
6152 type_name = "Filename";
6153 break;
6154
6155 case PREF_DIRNAME:
6156 type_name = "Directory";
6157 break;
6158
6159 case PREF_RANGE:
6160 type_name = "Range";
6161 break;
6162
6163 case PREF_COLOR:
6164 type_name = "Color";
6165 break;
6166
6167 case PREF_CUSTOM:
6168 if (pref->custom_cbs.type_name_cb)
6169 return pref->custom_cbs.type_name_cb();
6170 type_name = "Custom";
6171 break;
6172
6173 case PREF_DECODE_AS_RANGE:
6174 type_name = "Range (for Decode As)";
6175 break;
6176
6177 case PREF_STATIC_TEXT:
6178 type_name = "Static text";
6179 break;
6180
6181 case PREF_UAT:
6182 type_name = "UAT";
6183 break;
6184
6185 case PREF_PASSWORD:
6186 type_name = "Password";
6187 break;
6188
6189 case PREF_DISSECTOR:
6190 type_name = "Dissector";
6191 break;
6192 }
6193 }
6194
6195 return type_name;
6196}
6197
6198unsigned int
6199prefs_get_effect_flags(pref_t *pref)
6200{
6201 if (pref == NULL((void*)0))
6202 return 0;
6203
6204 return pref->effect_flags;
6205}
6206
6207void
6208prefs_set_effect_flags(pref_t *pref, unsigned int flags)
6209{
6210 if (pref != NULL((void*)0)) {
6211 if (flags == 0) {
6212 ws_error("Setting \"%s\" preference effect flags to 0", pref->name)ws_log_fatal_full("Epan", LOG_LEVEL_ERROR, "epan/prefs.c", 6212
, __func__, "Setting \"%s\" preference effect flags to 0", pref
->name)
;
6213 }
6214 pref->effect_flags = flags;
6215 }
6216}
6217
6218void
6219prefs_set_effect_flags_by_name(module_t * module, const char *pref, unsigned int flags)
6220{
6221 prefs_set_effect_flags(prefs_find_preference(module, pref), flags);
6222}
6223
6224unsigned int
6225prefs_get_module_effect_flags(module_t * module)
6226{
6227 if (module == NULL((void*)0))
6228 return 0;
6229
6230 return module->effect_flags;
6231}
6232
6233void
6234prefs_set_module_effect_flags(module_t * module, unsigned int flags)
6235{
6236 if (module != NULL((void*)0)) {
6237 if (flags == 0) {
6238 ws_error("Setting module \"%s\" preference effect flags to 0", module->name)ws_log_fatal_full("Epan", LOG_LEVEL_ERROR, "epan/prefs.c", 6238
, __func__, "Setting module \"%s\" preference effect flags to 0"
, module->name)
;
6239 }
6240 module->effect_flags = flags;
6241 }
6242}
6243
6244char *
6245prefs_pref_type_description(pref_t *pref)
6246{
6247 const char *type_desc = "An unknown preference type";
6248
6249 if (!pref) {
6250 return ws_strdup_printf("%s.", type_desc)wmem_strdup_printf(((void*)0), "%s.", type_desc); /* ...or maybe assert? */
6251 }
6252
6253 if (pref->obsolete) {
6254 type_desc = "An obsolete preference";
6255 } else {
6256 switch (pref->type) {
6257
6258 case PREF_UINT:
6259 switch (pref->info.base) {
6260
6261 case 10:
6262 type_desc = "A decimal number";
6263 break;
6264
6265 case 8:
6266 type_desc = "An octal number";
6267 break;
6268
6269 case 16:
6270 type_desc = "A hexadecimal number";
6271 break;
6272 }
6273 break;
6274
6275 case PREF_INT:
6276 type_desc = "A decimal number";
6277 break;
6278
6279 case PREF_FLOAT:
6280 type_desc = "A floating point number";
6281 break;
6282
6283 case PREF_BOOL:
6284 type_desc = "true or false (case-insensitive)";
6285 break;
6286
6287 case PREF_ENUM:
6288 case PREF_PROTO_TCP_SNDAMB_ENUM:
6289 {
6290 const enum_val_t *enum_valp = pref->info.enum_info.enumvals;
6291 GString *enum_str = g_string_new("One of: ");
6292 GString *desc_str = g_string_new("\nEquivalently, one of: ");
6293 bool_Bool distinct = false0;
6294 while (enum_valp->name != NULL((void*)0)) {
6295 g_string_append(enum_str, enum_valp->name)(__builtin_constant_p (enum_valp->name) ? __extension__ ({
const char * const __val = (enum_valp->name); g_string_append_len_inline
(enum_str, __val, (__val != ((void*)0)) ? (gssize) strlen ((
(__val) + !(__val))) : (gssize) -1); }) : g_string_append_len_inline
(enum_str, enum_valp->name, (gssize) -1))
;
6296 g_string_append(desc_str, enum_valp->description)(__builtin_constant_p (enum_valp->description) ? __extension__
({ const char * const __val = (enum_valp->description); g_string_append_len_inline
(desc_str, __val, (__val != ((void*)0)) ? (gssize) strlen ((
(__val) + !(__val))) : (gssize) -1); }) : g_string_append_len_inline
(desc_str, enum_valp->description, (gssize) -1))
;
6297 if (g_strcmp0(enum_valp->name, enum_valp->description) != 0) {
6298 distinct = true1;
6299 }
6300 enum_valp++;
6301 if (enum_valp->name != NULL((void*)0)) {
6302 g_string_append(enum_str, ", ")(__builtin_constant_p (", ") ? __extension__ ({ const char * const
__val = (", "); g_string_append_len_inline (enum_str, __val,
(__val != ((void*)0)) ? (gssize) strlen (((__val) + !(__val)
)) : (gssize) -1); }) : g_string_append_len_inline (enum_str,
", ", (gssize) -1))
;
6303 g_string_append(desc_str, ", ")(__builtin_constant_p (", ") ? __extension__ ({ const char * const
__val = (", "); g_string_append_len_inline (desc_str, __val,
(__val != ((void*)0)) ? (gssize) strlen (((__val) + !(__val)
)) : (gssize) -1); }) : g_string_append_len_inline (desc_str,
", ", (gssize) -1))
;
6304 }
6305 }
6306 if (distinct) {
6307 g_string_append(enum_str, desc_str->str)(__builtin_constant_p (desc_str->str) ? __extension__ ({ const
char * const __val = (desc_str->str); g_string_append_len_inline
(enum_str, __val, (__val != ((void*)0)) ? (gssize) strlen ((
(__val) + !(__val))) : (gssize) -1); }) : g_string_append_len_inline
(enum_str, desc_str->str, (gssize) -1))
;
6308 }
6309 g_string_free(desc_str, TRUE)(__builtin_constant_p ((!(0))) ? (((!(0))) ? (g_string_free) (
(desc_str), ((!(0)))) : g_string_free_and_steal (desc_str)) :
(g_string_free) ((desc_str), ((!(0)))))
;
6310 g_string_append(enum_str, "\n(case-insensitive).")(__builtin_constant_p ("\n(case-insensitive).") ? __extension__
({ const char * const __val = ("\n(case-insensitive)."); g_string_append_len_inline
(enum_str, __val, (__val != ((void*)0)) ? (gssize) strlen ((
(__val) + !(__val))) : (gssize) -1); }) : g_string_append_len_inline
(enum_str, "\n(case-insensitive).", (gssize) -1))
;
6311 return g_string_free(enum_str, FALSE)(__builtin_constant_p ((0)) ? (((0)) ? (g_string_free) ((enum_str
), ((0))) : g_string_free_and_steal (enum_str)) : (g_string_free
) ((enum_str), ((0))))
;
6312 }
6313
6314 case PREF_STRING:
6315 type_desc = "A string";
6316 break;
6317
6318 case PREF_SAVE_FILENAME:
6319 case PREF_OPEN_FILENAME:
6320 type_desc = "A path to a file";
6321 break;
6322
6323 case PREF_DIRNAME:
6324 type_desc = "A path to a directory";
6325 break;
6326
6327 case PREF_RANGE:
6328 {
6329 type_desc = "A string denoting an positive integer range (e.g., \"1-20,30-40\")";
6330 break;
6331 }
6332
6333 case PREF_COLOR:
6334 {
6335 type_desc = "A six-digit hexadecimal RGB color triplet (e.g. fce94f)";
6336 break;
6337 }
6338
6339 case PREF_CUSTOM:
6340 if (pref->custom_cbs.type_description_cb)
6341 return pref->custom_cbs.type_description_cb();
6342 type_desc = "A custom value";
6343 break;
6344
6345 case PREF_DECODE_AS_RANGE:
6346 type_desc = "A string denoting an positive integer range for Decode As";
6347 break;
6348
6349 case PREF_STATIC_TEXT:
6350 type_desc = "[Static text]";
6351 break;
6352
6353 case PREF_UAT:
6354 type_desc = "Configuration data stored in its own file";
6355 break;
6356
6357 case PREF_PASSWORD:
6358 type_desc = "Password (never stored on disk)";
6359 break;
6360
6361 case PREF_DISSECTOR:
6362 type_desc = "A dissector name";
6363 break;
6364
6365 default:
6366 break;
6367 }
6368 }
6369
6370 return g_strdup(type_desc)g_strdup_inline (type_desc);
6371}
6372
6373bool_Bool
6374prefs_pref_is_default(pref_t *pref)
6375{
6376 if (!pref) return false0;
6377
6378 if (pref->obsolete) {
6379 return false0;
6380 }
6381
6382 switch (pref->type) {
6383
6384 case PREF_UINT:
6385 if (pref->default_val.uint == *pref->varp.uint)
6386 return true1;
6387 break;
6388
6389 case PREF_INT:
6390 if (pref->default_val.intval == *pref->varp.intp)
6391 return true1;
6392 break;
6393
6394 case PREF_FLOAT:
6395 if (pref->default_val.floatval == *pref->varp.floatp)
6396 return true1;
6397 break;
6398
6399 case PREF_BOOL:
6400 if (pref->default_val.boolval == *pref->varp.boolp)
6401 return true1;
6402 break;
6403
6404 case PREF_ENUM:
6405 case PREF_PROTO_TCP_SNDAMB_ENUM:
6406 if (pref->default_val.enumval == *pref->varp.enump)
6407 return true1;
6408 break;
6409
6410 case PREF_STRING:
6411 case PREF_SAVE_FILENAME:
6412 case PREF_OPEN_FILENAME:
6413 case PREF_DIRNAME:
6414 case PREF_PASSWORD:
6415 case PREF_DISSECTOR:
6416 if (!(g_strcmp0(pref->default_val.string, *pref->varp.string)))
6417 return true1;
6418 break;
6419
6420 case PREF_DECODE_AS_RANGE:
6421 case PREF_RANGE:
6422 {
6423 if ((ranges_are_equal(pref->default_val.range, *pref->varp.range)))
6424 return true1;
6425 break;
6426 }
6427
6428 case PREF_COLOR:
6429 {
6430 if ((pref->default_val.color.red == pref->varp.colorp->red) &&
6431 (pref->default_val.color.green == pref->varp.colorp->green) &&
6432 (pref->default_val.color.blue == pref->varp.colorp->blue))
6433 return true1;
6434 break;
6435 }
6436
6437 case PREF_CUSTOM:
6438 return pref->custom_cbs.is_default_cb(pref);
6439
6440 case PREF_STATIC_TEXT:
6441 case PREF_UAT:
6442 return false0;
6443 /* ws_assert_not_reached(); */
6444 break;
6445 }
6446
6447 return false0;
6448}
6449
6450char *
6451prefs_pref_to_str(pref_t *pref, pref_source_t source)
6452{
6453 const char *pref_text = "[Unknown]";
6454 void *valp; /* pointer to preference value */
6455 color_t *pref_color;
6456 char *tmp_value, *ret_value;
6457
6458 if (!pref) {
6459 return g_strdup(pref_text)g_strdup_inline (pref_text);
6460 }
6461
6462 switch (source) {
6463 case pref_default:
6464 valp = &pref->default_val;
6465 /* valp = &boolval, &enumval, etc. are implied by union property */
6466 pref_color = &pref->default_val.color;
6467 break;
6468 case pref_stashed:
6469 valp = &pref->stashed_val;
6470 /* valp = &boolval, &enumval, etc. are implied by union property */
6471 pref_color = &pref->stashed_val.color;
6472 break;
6473 case pref_current:
6474 valp = pref->varp.uint;
6475 /* valp = boolval, enumval, etc. are implied by union property */
6476 pref_color = pref->varp.colorp;
6477 break;
6478 default:
6479 return g_strdup(pref_text)g_strdup_inline (pref_text);
6480 }
6481
6482 if (pref->obsolete) {
6483 pref_text = "[Obsolete]";
6484 } else {
6485 switch (pref->type) {
6486
6487 case PREF_UINT:
6488 {
6489 unsigned pref_uint = *(unsigned *) valp;
6490 switch (pref->info.base) {
6491
6492 case 10:
6493 return ws_strdup_printf("%u", pref_uint)wmem_strdup_printf(((void*)0), "%u", pref_uint);
6494
6495 case 8:
6496 return ws_strdup_printf("%#o", pref_uint)wmem_strdup_printf(((void*)0), "%#o", pref_uint);
6497
6498 case 16:
6499 return ws_strdup_printf("%#x", pref_uint)wmem_strdup_printf(((void*)0), "%#x", pref_uint);
6500 }
6501 break;
6502 }
6503 case PREF_INT:
6504 return ws_strdup_printf("%d", *(int*)valp)wmem_strdup_printf(((void*)0), "%d", *(int*)valp);
6505
6506 case PREF_FLOAT:
6507 return ws_strdup_printf("%.*f", pref->info.base, *(double*)valp)wmem_strdup_printf(((void*)0), "%.*f", pref->info.base, *(
double*)valp)
;
6508
6509 case PREF_BOOL:
6510 return g_strdup((*(bool *) valp) ? "TRUE" : "FALSE")g_strdup_inline ((*(_Bool *) valp) ? "TRUE" : "FALSE");
6511
6512 case PREF_ENUM:
6513 case PREF_PROTO_TCP_SNDAMB_ENUM:
6514 {
6515 int pref_enumval = *(int *) valp;
6516 const enum_val_t *enum_valp = pref->info.enum_info.enumvals;
6517 /*
6518 * TODO - We write the "description" value, because the "name" values
6519 * weren't validated to be command line friendly until 5.0, and a few
6520 * of them had to be changed. This allows older versions of Wireshark
6521 * to read preferences that they supported, as we supported either
6522 * the short name or the description when reading the preference files
6523 * or an "-o" option. Once 5.0 is the oldest supported version, switch
6524 * to writing the name below.
6525 */
6526 while (enum_valp->name != NULL((void*)0)) {
6527 if (enum_valp->value == pref_enumval)
6528 return g_strdup(enum_valp->description)g_strdup_inline (enum_valp->description);
6529 enum_valp++;
6530 }
6531 break;
6532 }
6533
6534 case PREF_STRING:
6535 case PREF_SAVE_FILENAME:
6536 case PREF_OPEN_FILENAME:
6537 case PREF_DIRNAME:
6538 case PREF_PASSWORD:
6539 case PREF_DISSECTOR:
6540 return prefs_sanitize_string(*(const char **) valp);
6541
6542 case PREF_DECODE_AS_RANGE:
6543 case PREF_RANGE:
6544 /* Convert wmem to g_alloc memory */
6545 tmp_value = range_convert_range(NULL((void*)0), *(range_t **) valp);
6546 ret_value = g_strdup(tmp_value)g_strdup_inline (tmp_value);
6547 wmem_free(NULL((void*)0), tmp_value);
6548 return ret_value;
6549
6550 case PREF_COLOR:
6551 return ws_strdup_printf("%02x%02x%02x",wmem_strdup_printf(((void*)0), "%02x%02x%02x", (pref_color->
red * 255 / 65535), (pref_color->green * 255 / 65535), (pref_color
->blue * 255 / 65535))
6552 (pref_color->red * 255 / 65535),wmem_strdup_printf(((void*)0), "%02x%02x%02x", (pref_color->
red * 255 / 65535), (pref_color->green * 255 / 65535), (pref_color
->blue * 255 / 65535))
6553 (pref_color->green * 255 / 65535),wmem_strdup_printf(((void*)0), "%02x%02x%02x", (pref_color->
red * 255 / 65535), (pref_color->green * 255 / 65535), (pref_color
->blue * 255 / 65535))
6554 (pref_color->blue * 255 / 65535))wmem_strdup_printf(((void*)0), "%02x%02x%02x", (pref_color->
red * 255 / 65535), (pref_color->green * 255 / 65535), (pref_color
->blue * 255 / 65535))
;
6555
6556 case PREF_CUSTOM:
6557 if (pref->custom_cbs.to_str_cb)
6558 return pref->custom_cbs.to_str_cb(pref, source == pref_default ? true1 : false0);
6559 pref_text = "[Custom]";
6560 break;
6561
6562 case PREF_STATIC_TEXT:
6563 pref_text = "[Static text]";
6564 break;
6565
6566 case PREF_UAT:
6567 {
6568 uat_t *uat = pref->varp.uat;
6569 if (uat && uat->filename)
6570 return ws_strdup_printf("[Managed in the file \"%s\"]", uat->filename)wmem_strdup_printf(((void*)0), "[Managed in the file \"%s\"]"
, uat->filename)
;
6571 else
6572 pref_text = "[Managed in an unknown file]";
6573 break;
6574 }
6575
6576 default:
6577 break;
6578 }
6579 }
6580
6581 return g_strdup(pref_text)g_strdup_inline (pref_text);
6582}
6583
6584/*
6585 * Write out a single dissector preference.
6586 */
6587void
6588pref_write_individual(void *data, void *user_data)
6589{
6590 pref_t *pref = (pref_t *)data;
6591 write_pref_arg_t *arg = (write_pref_arg_t *)user_data;
6592 char **desc_lines;
6593 int i;
6594
6595 if (!pref || pref->obsolete) {
6596 /*
6597 * This preference is no longer supported; it's not a
6598 * real preference, so we don't write it out (i.e., we
6599 * treat it as if it weren't found in the list of
6600 * preferences, and we weren't called in the first place).
6601 */
6602 return;
6603 }
6604
6605 switch (pref->type) {
6606
6607 case PREF_STATIC_TEXT:
6608 case PREF_UAT:
6609 /* Nothing to do; don't bother printing the description */
6610 return;
6611 case PREF_DECODE_AS_RANGE:
6612 /* Data is saved through Decode As mechanism and not part of preferences file */
6613 return;
6614 case PREF_PROTO_TCP_SNDAMB_ENUM:
6615 /* Not written to the preference file because the override is only
6616 * for the lifetime of the capture file and there is no single
6617 * value to write.
6618 */
6619 return;
6620 default:
6621 break;
6622 }
6623
6624 if (pref->type != PREF_CUSTOM || pref->custom_cbs.type_name_cb() != NULL((void*)0)) {
6625 /*
6626 * The prefix will either be the module name or the parent
6627 * name if it's a subtree
6628 */
6629 const char *name_prefix = (arg->module->name != NULL((void*)0)) ? arg->module->name : arg->module->parent->name;
6630 char *type_desc, *pref_text;
6631 const char * def_prefix = prefs_pref_is_default(pref) ? "#" : "";
6632
6633 if (pref->type == PREF_CUSTOM)
6634 fprintf(arg->pf, "\n# %s", pref->custom_cbs.type_name_cb());
6635 fprintf(arg->pf, "\n");
6636 if (pref->description &&
6637 (g_ascii_strncasecmp(pref->description,"", 2) != 0)) {
6638 if (pref->type != PREF_CUSTOM) {
6639 /* We get duplicate lines otherwise. */
6640
6641 desc_lines = g_strsplit(pref->description, "\n", 0);
6642 for (i = 0; desc_lines[i] != NULL((void*)0); ++i) {
6643 fprintf(arg->pf, "# %s\n", desc_lines[i]);
6644 }
6645 g_strfreev(desc_lines);
6646 }
6647 } else {
6648 fprintf(arg->pf, "# No description\n");
6649 }
6650
6651 type_desc = prefs_pref_type_description(pref);
6652 desc_lines = g_strsplit(type_desc, "\n", 0);
6653 for (i = 0; desc_lines[i] != NULL((void*)0); ++i) {
6654 fprintf(arg->pf, "# %s\n", desc_lines[i]);
6655 }
6656 g_strfreev(desc_lines);
6657 g_free(type_desc)(__builtin_object_size ((type_desc), 0) != ((size_t) - 1)) ? g_free_sized
(type_desc, __builtin_object_size ((type_desc), 0)) : (g_free
) (type_desc)
;
6658
6659 pref_text = prefs_pref_to_str(pref, pref_current);
6660 fprintf(arg->pf, "%s%s.%s: ", def_prefix, name_prefix, pref->name);
6661 if (pref->type != PREF_PASSWORD)
6662 {
6663 desc_lines = g_strsplit(pref_text, "\n", 0);
6664 for (i = 0; desc_lines[i] != NULL((void*)0); ++i) {
6665 fprintf(arg->pf, "%s%s\n", i == 0 ? "" : def_prefix, desc_lines[i]);
6666 }
6667 if (i == 0)
6668 fprintf(arg->pf, "\n");
6669 g_strfreev(desc_lines);
6670 } else {
6671 /* We never store password value */
6672 fprintf(arg->pf, "\n");
6673 }
6674 g_free(pref_text)(__builtin_object_size ((pref_text), 0) != ((size_t) - 1)) ? g_free_sized
(pref_text, __builtin_object_size ((pref_text), 0)) : (g_free
) (pref_text)
;
6675 }
6676
6677}
6678
6679static void
6680count_non_uat_pref(void *data, void *user_data)
6681{
6682 pref_t *pref = (pref_t *)data;
6683 int *arg = (int *)user_data;
6684
6685 switch (pref->type)
6686 {
6687 case PREF_UAT:
6688 case PREF_DECODE_AS_RANGE:
6689 case PREF_PROTO_TCP_SNDAMB_ENUM:
6690 //These types are not written in preference file
6691 break;
6692 default:
6693 (*arg)++;
6694 break;
6695 }
6696}
6697
6698int
6699prefs_num_non_uat(module_t *module)
6700{
6701 int num = 0;
6702
6703 g_list_foreach(module->prefs, count_non_uat_pref, &num);
6704
6705 return num;
6706}
6707
6708/*
6709 * Write out all preferences for a module.
6710 */
6711static unsigned
6712write_module_prefs(module_t *module, void *user_data)
6713{
6714 write_gui_pref_arg_t *gui_pref_arg = (write_gui_pref_arg_t*)user_data;
6715 write_pref_arg_t arg;
6716
6717 /* The GUI module needs to be explicitly called out so it
6718 can be written out of order */
6719 if ((module == gui_module) && (gui_pref_arg->is_gui_module != true1))
6720 return 0;
6721
6722 if ((module == extcap_module) && (gui_pref_arg->is_extcap_module != true1))
6723 return 0;
6724
6725 /* Write a header for the main modules and GUI sub-modules */
6726 if (((module->parent == NULL((void*)0)) || (module->parent == gui_module)) &&
6727 ((prefs_module_has_submodules(module)) ||
6728 (prefs_num_non_uat(module) > 0) ||
6729 (module->name == NULL((void*)0)))) {
6730 if ((module->name == NULL((void*)0)) && (module->parent != NULL((void*)0))) {
6731 fprintf(gui_pref_arg->pf, "\n####### %s: %s ########\n", module->parent->title, module->title);
6732 } else {
6733 fprintf(gui_pref_arg->pf, "\n####### %s ########\n", module->title);
6734 }
6735 }
6736
6737 arg.module = module;
6738 arg.pf = gui_pref_arg->pf;
6739 g_list_foreach(arg.module->prefs, pref_write_individual, &arg);
6740
6741 if (prefs_module_has_submodules(module))
6742 return prefs_modules_foreach_submodules(module->submodules, write_module_prefs, user_data);
6743
6744 return 0;
6745}
6746
6747#ifdef _WIN32
6748static void
6749write_registry(void)
6750{
6751 HKEY hTestKey;
6752 DWORD data;
6753 DWORD data_size;
6754 DWORD ret;
6755
6756 ret = RegCreateKeyExA(HKEY_CURRENT_USER, REG_HKCU_WIRESHARK_KEY"Software\\Wireshark", 0, NULL((void*)0),
6757 REG_OPTION_NON_VOLATILE, KEY_WRITE, NULL((void*)0),
6758 &hTestKey, NULL((void*)0));
6759 if (ret != ERROR_SUCCESS) {
6760 ws_noisy("Cannot open HKCU "REG_HKCU_WIRESHARK_KEY": 0x%lx", ret)do { if (1) { ws_log_full("Epan", LOG_LEVEL_NOISY, "epan/prefs.c"
, 6760, __func__, "Cannot open HKCU ""Software\\Wireshark"": 0x%lx"
, ret); } } while (0)
;
6761 return;
6762 }
6763
6764 data = ws_log_console_open;
6765 data_size = sizeof(DWORD);
6766 ret = RegSetValueExA(hTestKey, LOG_HKCU_CONSOLE_OPEN"ConsoleOpen", 0, REG_DWORD, (const BYTE *)&data, data_size);
6767 if (ret == ERROR_SUCCESS) {
6768 ws_noisy("Wrote "LOG_HKCU_CONSOLE_OPEN" to Windows registry: 0x%lu", data)do { if (1) { ws_log_full("Epan", LOG_LEVEL_NOISY, "epan/prefs.c"
, 6768, __func__, "Wrote ""ConsoleOpen"" to Windows registry: 0x%lu"
, data); } } while (0)
;
6769 }
6770 else {
6771 ws_noisy("Error writing registry key "LOG_HKCU_CONSOLE_OPEN": 0x%lx", ret)do { if (1) { ws_log_full("Epan", LOG_LEVEL_NOISY, "epan/prefs.c"
, 6771, __func__, "Error writing registry key ""ConsoleOpen"": 0x%lx"
, ret); } } while (0)
;
6772 }
6773
6774 RegCloseKey(hTestKey);
6775}
6776#endif
6777
6778int
6779prefs_write_module(const char *module, bool_Bool from_profile, const char* app_env_var_prefix)
6780{
6781 write_gui_pref_arg_t write_pref_info;
6782
6783 module_t *target_module = prefs_find_module(module);
6784 if (!target_module) {
6785 return ENOENT2;
6786 }
6787
6788 char *pf_name = g_strdup_printf("%s.cfg", module);
6789 char *pf_path = get_persconffile_path(pf_name, from_profile, app_env_var_prefix);
6790 g_free(pf_name)(__builtin_object_size ((pf_name), 0) != ((size_t) - 1)) ? g_free_sized
(pf_name, __builtin_object_size ((pf_name), 0)) : (g_free) (
pf_name)
;
6791
6792 FILE *pf;
6793 if ((pf = ws_fopenfopen(pf_path, "w")) == NULL((void*)0)) {
6794 int err = errno(*__errno_location ());
6795 if (err != EISDIR21) {
6796 ws_warning("Unable to save %s preferences \"%s\": %s",do { if (1) { ws_log_full("Epan", LOG_LEVEL_WARNING, "epan/prefs.c"
, 6797, __func__, "Unable to save %s preferences \"%s\": %s",
module, pf_path, g_strerror(err)); } } while (0)
6797 module, pf_path, g_strerror(err))do { if (1) { ws_log_full("Epan", LOG_LEVEL_WARNING, "epan/prefs.c"
, 6797, __func__, "Unable to save %s preferences \"%s\": %s",
module, pf_path, g_strerror(err)); } } while (0)
;
6798 }
6799 g_free(pf_path)(__builtin_object_size ((pf_path), 0) != ((size_t) - 1)) ? g_free_sized
(pf_path, __builtin_object_size ((pf_path), 0)) : (g_free) (
pf_path)
;
6800 return err;
6801 }
6802 g_free(pf_path)(__builtin_object_size ((pf_path), 0) != ((size_t) - 1)) ? g_free_sized
(pf_path, __builtin_object_size ((pf_path), 0)) : (g_free) (
pf_path)
;
6803
6804 fprintf(pf, "# %s configuration file for Wireshark " VERSION"4.7.4" ".\n"
6805 "#\n"
6806 "# This file is regenerated each time preferences are saved within\n"
6807 "# Wireshark. Making manual changes should be safe, however.\n"
6808 "# Preferences that have been commented out have not been\n"
6809 "# changed from their default value.\n", target_module->title);
6810
6811 write_pref_info.pf = pf;
6812 write_pref_info.is_gui_module = (target_module == gui_module);
6813 write_pref_info.is_extcap_module = (target_module == extcap_module);
6814
6815 write_module_prefs(target_module, &write_pref_info);
6816
6817 fclose(pf);
6818
6819 return 0;
6820}
6821
6822/* Write out "prefs" to the user's preferences file, and return 0.
6823
6824 If the preferences file path is NULL, write to stdout.
6825
6826 If we got an error, stuff a pointer to the path of the preferences
6827 file into "*pf_path_return", and return the errno.
6828
6829 Note that we don't write extcap.cfg here; that's done by
6830 extcap_write_preferences().
6831*/
6832 int
6833 write_prefs(const char *app_env_var_prefix, char **pf_path_return)
6834{
6835 char *pf_path;
6836 FILE *pf;
6837 write_gui_pref_arg_t write_gui_pref_info;
6838
6839#ifdef _WIN32
6840 write_registry();
6841#endif
6842
6843 /* To do:
6844 * - Split output lines longer than MAX_VAL_LEN
6845 * - Create a function for the preference directory check/creation
6846 * so that duplication can be avoided with filter.c
6847 */
6848
6849 if (pf_path_return != NULL((void*)0)) {
6850 pf_path = get_persconffile_path(PF_NAME"preferences", true1, app_env_var_prefix);
6851 if ((pf = ws_fopenfopen(pf_path, "w")) == NULL((void*)0)) {
6852 *pf_path_return = pf_path;
6853 return errno(*__errno_location ());
6854 }
6855 g_free(pf_path)(__builtin_object_size ((pf_path), 0) != ((size_t) - 1)) ? g_free_sized
(pf_path, __builtin_object_size ((pf_path), 0)) : (g_free) (
pf_path)
;
6856 } else {
6857 pf = stdoutstdout;
6858 }
6859
6860 /*
6861 * If the preferences file is being written, be sure to write UAT files
6862 * first that were migrated from the preferences file.
6863 */
6864 if (pf_path_return != NULL((void*)0)) {
6865 if (prefs.filter_expressions_old) {
6866 char *err = NULL((void*)0);
6867 prefs.filter_expressions_old = false0;
6868 if (!uat_save(uat_get_table_by_name("Display expressions"), app_env_var_prefix, &err)) {
6869 ws_warning("Unable to save Display expressions: %s", err)do { if (1) { ws_log_full("Epan", LOG_LEVEL_WARNING, "epan/prefs.c"
, 6869, __func__, "Unable to save Display expressions: %s", err
); } } while (0)
;
6870 g_free(err)(__builtin_object_size ((err), 0) != ((size_t) - 1)) ? g_free_sized
(err, __builtin_object_size ((err), 0)) : (g_free) (err)
;
6871 }
6872 }
6873 }
6874
6875 fputs("# Configuration file for Wireshark " VERSION"4.7.4" ".\n"
6876 "#\n"
6877 "# This file is regenerated each time preferences are saved within\n"
6878 "# Wireshark. Making manual changes should be safe, however.\n"
6879 "# Preferences that have been commented out have not been\n"
6880 "# changed from their default value.\n", pf);
6881
6882 /*
6883 * For "backwards compatibility" the GUI module is written first as it's
6884 * at the top of the file. This is followed by all modules that can't
6885 * fit into the preferences read/write API. Finally the remaining modules
6886 * are written in alphabetical order (including of course the protocol preferences)
6887 */
6888 write_gui_pref_info.pf = pf;
6889 write_gui_pref_info.is_gui_module = true1;
6890 write_gui_pref_info.is_extcap_module = false0;
6891
6892 write_module_prefs(gui_module, &write_gui_pref_info);
6893
6894 write_gui_pref_info.is_gui_module = false0;
6895 if (pf_path_return == NULL((void*)0)) {
6896 /* If we're writing the prefs to stdout, write the extcap prefs. */
6897 write_gui_pref_info.is_extcap_module = true1;
6898 }
6899 prefs_module_list_foreach(prefs_top_level_modules, write_module_prefs, &write_gui_pref_info, true1);
6900
6901 fclose(pf);
6902
6903 /* XXX - catch I/O errors (e.g. "ran out of disk space") and return
6904 an error indication, or maybe write to a new preferences file and
6905 rename that file on top of the old one only if there are not I/O
6906 errors. */
6907 return 0;
6908}
6909
6910/** The col_list is only partly managed by the custom preference API
6911 * because its data is shared between multiple preferences, so
6912 * it's freed here
6913 */
6914static void
6915free_col_info(GList *list)
6916{
6917 fmt_data *cfmt;
6918 GList *list_head = list;
6919
6920 while (list != NULL((void*)0)) {
6921 cfmt = (fmt_data *)list->data;
6922
6923 g_free(cfmt->title)(__builtin_object_size ((cfmt->title), 0) != ((size_t) - 1
)) ? g_free_sized (cfmt->title, __builtin_object_size ((cfmt
->title), 0)) : (g_free) (cfmt->title)
;
6924 g_free(cfmt->custom_fields)(__builtin_object_size ((cfmt->custom_fields), 0) != ((size_t
) - 1)) ? g_free_sized (cfmt->custom_fields, __builtin_object_size
((cfmt->custom_fields), 0)) : (g_free) (cfmt->custom_fields
)
;
6925 g_free(cfmt)(__builtin_object_size ((cfmt), 0) != ((size_t) - 1)) ? g_free_sized
(cfmt, __builtin_object_size ((cfmt), 0)) : (g_free) (cfmt)
;
6926 list = g_list_next(list)((list) ? (((GList *)(list))->next) : ((void*)0));
6927 }
6928 g_list_free(list_head);
6929}
6930
6931/*
6932 * Editor modelines
6933 *
6934 * Local Variables:
6935 * c-basic-offset: 4
6936 * tab-width: 8
6937 * indent-tabs-mode: nil
6938 * End:
6939 *
6940 * ex: set shiftwidth=4 tabstop=8 expandtab:
6941 * :indentSize=4:tabSize=8:noTabs=true:
6942 */