Bug Summary

File:builds/wireshark/wireshark/epan/prefs.c
Warning:line 4703, 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-07-100537-3663-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 <gerald@wireshark.org>
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#ifdef HAVE_ZSTD1
3789 prefs_register_uint_preference(capture_module, "zstd_compression_level",
3790 "Zstandard compression level",
3791 "Compression level for saving and exporting Zstandard captures. "
3792 "Higher levels use more CPU and memory to produce smaller files. "
3793 "Use 1 to 22, or 0 for the library default (3). "
3794 "Also applies to TShark when rewriting captures with -r and -w.",
3795 10, &prefs.capture_zstd_compression_level);
3796#endif
3797
3798 prefs_register_enum_preference(capture_module, "process_info", "Record the processes that packets belong to",
3799 "What to record, in pcapng files, of the processes on this host that sent or received each packet."
3800 " Paths, command lines and user names can be sensitive.",
3801 (int*)(void*)(&prefs.capture_process_info), capture_process_info_vals, false0);
3802
3803 prefs_register_bool_preference(capture_module, "real_time_update", "Update packet list in real time during capture",
3804 "Update packet list in real time during capture?", &prefs.capture_real_time);
3805
3806 prefs_register_uint_preference(capture_module, "update_interval",
3807 "Capture update interval",
3808 "Capture update interval in ms",
3809 10,
3810 &prefs.capture_update_interval);
3811
3812 prefs_register_directory_preference(capture_module, "temp_dir", "Temporary directory",
3813 "Directory in which to write temporary capture files. Leave empty to use the "
3814 "system default (the TMPDIR environment variable, or /tmp). A directory chosen in "
3815 "the Capture Options dialog is saved here. Overridden by the --temp-dir option.",
3816 (const char **)&prefs.capture_temp_dir);
3817
3818 prefs_register_bool_preference(capture_module, "no_interface_load", "Don't load interfaces on startup",
3819 "Don't automatically load capture interfaces on startup", &prefs.capture_no_interface_load);
3820
3821 prefs_register_bool_preference(capture_module, "no_extcap", "Disable external capture interfaces",
3822 "Disable external capture modules (extcap)", &prefs.capture_no_extcap);
3823
3824 prefs_register_obsolete_preference(capture_module, "auto_scroll");
3825
3826 prefs_register_bool_preference(capture_module, "show_info", "Show capture information dialog while capturing",
3827 "Show capture information dialog while capturing?", &prefs.capture_show_info);
3828
3829 prefs_register_obsolete_preference(capture_module, "syntax_check_filter");
3830
3831 prefs_register_obsolete_preference(capture_module, "columns");
3832
3833 aggregation_field_register_uat(capture_module);
3834
3835 /* Name Resolution */
3836 nameres_module = prefs_register_module(prefs_top_level_modules, prefs_modules, "nameres", "Name Resolution",
3837 "Name Resolution", "ChCustPreferencesSection.html#ChCustPrefsNameSection", addr_resolve_pref_apply, true1);
3838 addr_resolve_pref_init(nameres_module);
3839 oid_pref_init(nameres_module);
3840 maxmind_db_pref_init(nameres_module);
3841
3842 /* Printing
3843 * None of these have any effect; we keep them as obsolete preferences
3844 * in order to avoid errors when reading older preference files.
3845 */
3846 printing = prefs_register_module(prefs_top_level_modules, prefs_modules, "print", "Printing",
3847 "Printing", NULL((void*)0), NULL((void*)0), false0);
3848 prefs_register_obsolete_preference(printing, "format");
3849 prefs_register_obsolete_preference(printing, "command");
3850 prefs_register_obsolete_preference(printing, "file");
3851
3852 /* Codecs */
3853 codecs_module = prefs_register_module(prefs_top_level_modules, prefs_modules, "codecs", "Codecs",
3854 "Codecs", NULL((void*)0), NULL((void*)0), true1);
3855
3856 /* Statistics */
3857 stats_module = prefs_register_module(prefs_top_level_modules, prefs_modules, "statistics", "Statistics",
3858 "Statistics", "ChCustPreferencesSection.html#_statistics", &stats_callback, true1);
3859
3860 prefs_register_uint_preference(stats_module, "update_interval",
3861 "Tap update interval in ms",
3862 "Determines time between tap updates",
3863 10,
3864 &prefs.tap_update_interval);
3865
3866 prefs_register_uint_preference(stats_module, "flow_graph_max_export_items",
3867 "Maximum Flow Graph items to export as image",
3868 "The maximum number of Flow Graph items (frames) "
3869 "to include when exporting the graph as an image. "
3870 "Note that some formats (e.g., JPEG) have inherent "
3871 "pixel limits and image viewers might be unable to "
3872 "handle very large images.",
3873 10,
3874 &prefs.flow_graph_max_export_items);
3875
3876 prefs_register_bool_preference(stats_module, "st_enable_burstinfo",
3877 "Enable the calculation of burst information",
3878 "If enabled burst rates will be calculated for statistics that use the stats_tree system. "
3879 "Burst rates are calculated over a much shorter time interval than the rate column.",
3880 &prefs.st_enable_burstinfo);
3881
3882 prefs_register_bool_preference(stats_module, "st_burst_showcount",
3883 "Show burst count for item rather than rate",
3884 "If selected the stats_tree statistics nodes will show the count of events "
3885 "within the burst window instead of a burst rate. Burst rate is calculated "
3886 "as number of events within burst window divided by the burst windown length.",
3887 &prefs.st_burst_showcount);
3888
3889 prefs_register_uint_preference(stats_module, "st_burst_resolution",
3890 "Burst rate resolution (ms)",
3891 "Sets the duration of the time interval into which events are grouped when calculating "
3892 "the burst rate. Higher resolution (smaller number) increases processing overhead.",
3893 10,&prefs.st_burst_resolution);
3894
3895 prefs_register_uint_preference(stats_module, "st_burst_windowlen",
3896 "Burst rate window size (ms)",
3897 "Sets the duration of the sliding window during which the burst rate is "
3898 "measured. Longer window relative to burst rate resolution increases "
3899 "processing overhead. Will be truncated to a multiple of burst resolution.",
3900 10,&prefs.st_burst_windowlen);
3901
3902 prefs_register_enum_preference(stats_module, "st_sort_defcolflag",
3903 "Default sort column for stats_tree stats",
3904 "Sets the default column by which stats based on the stats_tree "
3905 "system is sorted.",
3906 &prefs.st_sort_defcolflag, st_sort_col_vals, false0);
3907
3908 prefs_register_bool_preference(stats_module, "st_sort_defdescending",
3909 "Default stats_tree sort order is descending",
3910 "When selected, statistics based on the stats_tree system will by default "
3911 "be sorted in descending order.",
3912 &prefs.st_sort_defdescending);
3913
3914 prefs_register_bool_preference(stats_module, "st_sort_casesensitve",
3915 "Case sensitive sort of stats_tree item names",
3916 "When selected, the item/node names of statistics based on the stats_tree "
3917 "system will be sorted taking case into account. Else the case of the name "
3918 "will be ignored.",
3919 &prefs.st_sort_casesensitve);
3920
3921 prefs_register_bool_preference(stats_module, "st_sort_rng_nameonly",
3922 "Always sort 'range' nodes by name",
3923 "When selected, the stats_tree nodes representing a range of values "
3924 "(0-49, 50-100, etc.) will always be sorted by name (the range of the "
3925 "node). Else range nodes are sorted by the same column as the rest of "
3926 " the tree.",
3927 &prefs.st_sort_rng_nameonly);
3928
3929 prefs_register_bool_preference(stats_module, "st_sort_rng_fixorder",
3930 "Always sort 'range' nodes in ascending order",
3931 "When selected, the stats_tree nodes representing a range of values "
3932 "(0-49, 50-100, etc.) will always be sorted ascending; else it follows "
3933 "the sort direction of the tree. Only effective if \"Always sort "
3934 "'range' nodes by name\" is also selected.",
3935 &prefs.st_sort_rng_fixorder);
3936
3937 prefs_register_bool_preference(stats_module, "st_sort_showfullname",
3938 "Display the full stats_tree plug-in name",
3939 "When selected, the full name (including menu path) of the stats_tree "
3940 "plug-in is show in windows. If cleared the plug-in name is shown "
3941 "without menu path (only the part of the name after last '/' character.)",
3942 &prefs.st_sort_showfullname);
3943
3944 prefs_register_enum_preference(stats_module, "output_format",
3945 "Default output format",
3946 "Sets the default output format for statistical data. Only supported "
3947 "by taps using the stats_tree system currently; other taps may honor "
3948 "this preference in the future. ",
3949 &prefs.st_format, st_format_vals, false0);
3950
3951 module_t *conv_module;
3952 // avoid using prefs_register_stat to prevent lint complaint about recursion
3953 conv_module = prefs_register_submodule(stats_module, prefs_modules, "conv", "Conversations",
3954 "Conversations & Endpoints", NULL((void*)0), NULL((void*)0), true1);
3955 prefs_register_bool_preference(conv_module, "machine_readable",
3956 "Display exact (machine-readable) byte counts",
3957 "When enabled, exact machine-readable byte counts are displayed. "
3958 "When disabled, human readable numbers with SI prefixes are displayed.",
3959 &prefs.conv_machine_readable);
3960
3961 /* Protocols */
3962 protocols_module = prefs_register_module(prefs_top_level_modules, prefs_modules, "protocols", "Protocols",
3963 "Protocols", "ChCustPreferencesSection.html#ChCustPrefsProtocolsSection", NULL((void*)0), true1);
3964
3965 prefs_register_bool_preference(protocols_module, "display_hidden_proto_items",
3966 "Display hidden protocol items",
3967 "Display all hidden protocol items in the packet list.",
3968 &prefs.display_hidden_proto_items);
3969
3970 prefs_register_bool_preference(protocols_module, "display_byte_fields_with_spaces",
3971 "Display byte fields with a space character between bytes",
3972 "Display all byte fields with a space character between each byte in the packet list.",
3973 &prefs.display_byte_fields_with_spaces);
3974
3975 /*
3976 * Note the -t / option only affects the display of the packet timestamp
3977 * in the default time column; this is for all other absolute times.
3978 */
3979 prefs_register_enum_preference(protocols_module, "display_abs_time_ascii",
3980 "Format absolute times like asctime",
3981 "When to format absolute times similar to asctime instead of ISO 8601, for backwards compatibility with older Wireshark.",
3982 (int*)&prefs.display_abs_time_ascii, abs_time_format_options, false0);
3983
3984 prefs_register_bool_preference(protocols_module, "enable_incomplete_dissectors_check",
3985 "Look for incomplete dissectors",
3986 "Look for dissectors that left some bytes undecoded.",
3987 &prefs.enable_incomplete_dissectors_check);
3988
3989 prefs_register_bool_preference(protocols_module, "strict_conversation_tracking_heuristics",
3990 "Enable stricter conversation tracking heuristics",
3991 "Protocols may use things like VLAN ID or interface ID to narrow the potential for duplicate conversations. "
3992 "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",
3993 &prefs.strict_conversation_tracking_heuristics);
3994
3995 prefs_register_bool_preference(protocols_module, "ignore_dup_frames",
3996 "Ignore duplicate frames",
3997 "Ignore frames that are exact duplicates of any previous frame.",
3998 &prefs.ignore_dup_frames);
3999
4000 prefs_register_enum_preference(protocols_module, "conversation_deinterlacing_key",
4001 "Deinterlacing conversations key",
4002 "Separate into different conversations frames that look like duplicates but have different Interface, MAC, or VLAN field values.",
4003 (int *)&prefs.conversation_deinterlacing_key, conv_deint_options, false0);
4004
4005 prefs_register_uint_preference(protocols_module, "ignore_dup_frames_cache_entries",
4006 "The max number of hashes to keep in memory for determining duplicates frames",
4007 "If \"Ignore duplicate frames\" is set, this setting sets the maximum number "
4008 "of cache entries to maintain. A 0 means no limit.",
4009 10, &prefs.ignore_dup_frames_cache_entries);
4010
4011
4012 /* Obsolete preferences
4013 * These "modules" were reorganized/renamed to correspond to their GUI
4014 * configuration screen within the preferences dialog
4015 */
4016
4017 /* taps is now part of the stats module */
4018 prefs_register_module(prefs_top_level_modules, prefs_modules, "taps", "TAPS", "TAPS", NULL((void*)0), NULL((void*)0), false0);
4019 /* packet_list is now part of the protocol (parent) module */
4020 prefs_register_module(prefs_top_level_modules, prefs_modules, "packet_list", "PACKET_LIST", "PACKET_LIST", NULL((void*)0), NULL((void*)0), false0);
4021 /* stream is now part of the gui module */
4022 prefs_register_module(prefs_top_level_modules, prefs_modules, "stream", "STREAM", "STREAM", NULL((void*)0), NULL((void*)0), false0);
4023
4024}
4025
4026/* Parse through a list of comma-separated, possibly quoted strings.
4027 Return a list of the string data. */
4028GList *
4029prefs_get_string_list(const char *str)
4030{
4031 enum { PRE_STRING, IN_QUOT, NOT_IN_QUOT };
4032
4033 int state = PRE_STRING, i = 0;
4034 bool_Bool backslash = false0;
4035 unsigned char cur_c;
4036 const size_t default_size = 64;
4037 GString *slstr = NULL((void*)0);
4038 GList *sl = NULL((void*)0);
4039
4040 /* Allocate a buffer for the first string. */
4041 slstr = g_string_sized_new(default_size);
4042
4043 for (;;) {
4044 cur_c = str[i];
4045 if (cur_c == '\0') {
4046 /* It's the end of the input, so it's the end of the string we
4047 were working on, and there's no more input. */
4048 if (state == IN_QUOT || backslash) {
4049 /* We were in the middle of a quoted string or backslash escape,
4050 and ran out of characters; that's an error. */
4051 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)))))
;
4052 prefs_clear_string_list(sl);
4053 return NULL((void*)0);
4054 }
4055 if (slstr->len > 0)
4056 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))))
);
4057 else
4058 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)))))
;
4059 break;
4060 }
4061 if (cur_c == '"' && !backslash) {
4062 switch (state) {
4063 case PRE_STRING:
4064 /* We hadn't yet started processing a string; this starts the
4065 string, and we're now quoting. */
4066 state = IN_QUOT;
4067 break;
4068 case IN_QUOT:
4069 /* We're in the middle of a quoted string, and we saw a quotation
4070 mark; we're no longer quoting. */
4071 state = NOT_IN_QUOT;
4072 break;
4073 case NOT_IN_QUOT:
4074 /* We're working on a string, but haven't seen a quote; we're
4075 now quoting. */
4076 state = IN_QUOT;
4077 break;
4078 default:
4079 break;
4080 }
4081 } else if (cur_c == '\\' && !backslash) {
4082 /* We saw a backslash, and the previous character wasn't a
4083 backslash; escape the next character.
4084
4085 This also means we've started a new string. */
4086 backslash = true1;
4087 if (state == PRE_STRING)
4088 state = NOT_IN_QUOT;
4089 } else if (cur_c == ',' && state != IN_QUOT && !backslash) {
4090 /* We saw a comma, and we're not in the middle of a quoted string
4091 and it wasn't preceded by a backslash; it's the end of
4092 the string we were working on... */
4093 if (slstr->len > 0) {
4094 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))))
);
4095 slstr = g_string_sized_new(default_size);
4096 }
4097
4098 /* ...and the beginning of a new string. */
4099 state = PRE_STRING;
4100 } else if (!g_ascii_isspace(cur_c)((g_ascii_table[(guchar) (cur_c)] & G_ASCII_SPACE) != 0) || state != PRE_STRING) {
4101 /* Either this isn't a white-space character, or we've started a
4102 string (i.e., already seen a non-white-space character for that
4103 string and put it into the string).
4104
4105 The character is to be put into the string; do so. */
4106 g_string_append_c(slstr, cur_c)g_string_append_c_inline (slstr, cur_c);
4107
4108 /* If it was backslash-escaped, we're done with the backslash escape. */
4109 backslash = false0;
4110 }
4111 i++;
4112 }
4113 return(sl);
4114}
4115
4116char *join_string_list(GList *sl)
4117{
4118 GString *joined_str = g_string_new("");
4119 GList *cur, *first;
4120 char *str;
4121 unsigned item_count = 0;
4122
4123 cur = first = g_list_first(sl);
4124 while (cur) {
4125 item_count++;
4126 str = (char *)cur->data;
4127
4128 if (cur != first)
4129 g_string_append_c(joined_str, ',')g_string_append_c_inline (joined_str, ',');
4130
4131 if (item_count % 2) {
4132 /* Wrap the line. */
4133 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))
;
4134 } else
4135 g_string_append_c(joined_str, ' ')g_string_append_c_inline (joined_str, ' ');
4136
4137 g_string_append_c(joined_str, '"')g_string_append_c_inline (joined_str, '"');
4138 while (*str) {
4139 gunichar uc = g_utf8_get_char (str);
4140
4141 if (uc == '"' || uc == '\\')
4142 g_string_append_c(joined_str, '\\')g_string_append_c_inline (joined_str, '\\');
4143
4144 if (g_unichar_isprint(uc))
4145 g_string_append_unichar (joined_str, uc);
4146
4147 str = g_utf8_next_char (str)((str) + g_utf8_skip[*(const guchar *)(str)]);
4148 }
4149
4150 g_string_append_c(joined_str, '"')g_string_append_c_inline (joined_str, '"');
4151
4152 cur = cur->next;
4153 }
4154 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))))
;
4155}
4156
4157void
4158prefs_clear_string_list(GList *sl)
4159{
4160 g_list_free_full(sl, g_free);
4161}
4162
4163/*
4164 * Takes a string, a pointer to an array of "enum_val_t"s, and a default int
4165 * value.
4166 * The array must be terminated by an entry with a null "name" string.
4167 *
4168 * If the string matches a "name" string in an entry, the value from that
4169 * entry is returned.
4170 *
4171 * Otherwise, if a string matches a "description" string in an entry, the
4172 * value from that entry is returned; we do that for backwards compatibility,
4173 * as we used to have only a "name" string that was used both for command-line
4174 * and configuration-file values and in the GUI (which meant either that
4175 * the GUI had what might be somewhat cryptic values to select from or that
4176 * the "-o" flag took long strings, often with spaces in them).
4177 *
4178 * Otherwise, the default value that was passed as the third argument is
4179 * returned.
4180 */
4181static int
4182find_val_for_string(const char *needle, const enum_val_t *haystack,
4183 int default_value)
4184{
4185 int i;
4186
4187 for (i = 0; haystack[i].name != NULL((void*)0); i++) {
4188 if (g_ascii_strcasecmp(needle, haystack[i].name) == 0) {
4189 return haystack[i].value;
4190 }
4191 }
4192 for (i = 0; haystack[i].name != NULL((void*)0); i++) {
4193 if (g_ascii_strcasecmp(needle, haystack[i].description) == 0) {
4194 return haystack[i].value;
4195 }
4196 }
4197 return default_value;
4198}
4199
4200/* Preferences file format:
4201 * - Configuration directives start at the beginning of the line, and
4202 * are terminated with a colon.
4203 * - Directives can be continued on the next line by preceding them with
4204 * whitespace.
4205 *
4206 * Example:
4207
4208# This is a comment line
4209print.command: lpr
4210print.file: /a/very/long/path/
4211 to/wireshark-out.ps
4212 *
4213 */
4214
4215/*
4216 * Initialize non-dissector preferences used by the "register preference" API
4217 * to default values so the default values can be used when registered.
4218 *
4219 * String, filename, and directory preferences will be g_freed so they must
4220 * be g_mallocated.
4221 */
4222static void
4223prefs_set_global_defaults(wmem_allocator_t* pref_scope, const char** col_fmt, int num_cols)
4224{
4225 int i;
4226 fmt_data *cfmt;
4227
4228 prefs.gui_toolbar_main_style = TB_STYLE_ICONS0;
4229 /* We try to find the best font in the Qt code */
4230 wmem_free(pref_scope, prefs.gui_font_name);
4231 prefs.gui_font_name = wmem_strdup(pref_scope, "");
4232 wmem_free(pref_scope, prefs.gui_colorized_fg);
4233 prefs.gui_colorized_fg = wmem_strdup(pref_scope, "000000,000000,000000,000000,000000,000000,000000,000000,000000,000000");
4234 wmem_free(pref_scope, prefs.gui_colorized_bg);
4235 prefs.gui_colorized_bg = wmem_strdup(pref_scope, "ffc0c0,ffc0ff,e0c0e0,c0c0ff,c0e0e0,c0ffff,c0ffc0,ffffc0,e0e0c0,e0e0e0");
4236
4237 prefs.gui_geometry_save_position = true1;
4238 prefs.gui_geometry_save_size = true1;
4239 prefs.gui_geometry_save_maximized= true1;
4240 prefs.gui_fileopen_style = FO_STYLE_LAST_OPENED0;
4241 prefs.gui_recent_df_entries_max = 10;
4242 prefs.gui_recent_files_count_max = 10;
4243 wmem_free(pref_scope, prefs.gui_fileopen_dir);
4244 prefs.gui_fileopen_dir = wmem_strdup(pref_scope, get_persdatafile_dir());
4245 prefs.gui_fileopen_preview = 3;
4246 wmem_free(pref_scope, prefs.gui_tlskeylog_command);
4247 prefs.gui_tlskeylog_command = wmem_strdup(pref_scope, "");
4248 prefs.gui_ask_unsaved = true1;
4249 prefs.gui_autocomplete_filter = true1;
4250 prefs.gui_find_wrap = true1;
4251 prefs.gui_update_enabled = true1;
4252 prefs.gui_update_channel = UPDATE_CHANNEL_STABLE;
4253 prefs.gui_update_interval = 60*60*24; /* Seconds */
4254 prefs.gui_debounce_timer = 400; /* milliseconds */
4255 wmem_free(pref_scope, prefs.gui_window_title);
4256 prefs.gui_window_title = wmem_strdup(pref_scope, "");
4257 wmem_free(pref_scope, prefs.gui_prepend_window_title);
4258 prefs.gui_prepend_window_title = wmem_strdup(pref_scope, "");
4259 wmem_free(pref_scope, prefs.gui_start_title);
4260 prefs.gui_start_title = wmem_strdup(pref_scope, "The World's Most Popular Network Protocol Analyzer");
4261 prefs.gui_version_placement = version_both;
4262 prefs.gui_welcome_page_show_recent = true1;
4263 prefs.gui_layout_type = layout_type_2;
4264 prefs.gui_layout_content_1 = layout_pane_content_plist;
4265 prefs.gui_layout_content_2 = layout_pane_content_pdetails;
4266 prefs.gui_layout_content_3 = layout_pane_content_pbytes;
4267 prefs.gui_packet_list_elide_mode = ELIDE_RIGHT;
4268 prefs.gui_packet_list_copy_format_options_for_keyboard_shortcut = COPY_FORMAT_TEXT;
4269 prefs.gui_packet_list_copy_text_with_aligned_columns = false0;
4270 prefs.gui_packet_list_show_related = true1;
4271 prefs.gui_packet_list_show_minimap = true1;
4272 prefs.gui_packet_list_sortable = true1;
4273 prefs.gui_packet_list_cached_rows_max = 10000;
4274 prefs.gui_packet_list_multi_color_mode = PACKET_LIST_MULTI_COLOR_MODE_OFF;
4275 prefs.gui_packet_list_multi_color_shift_percent = 85;
4276 prefs.gui_packet_list_multi_color_details = false0;
4277 prefs.gui_packet_list_multi_color_separator = PACKET_LIST_MULTI_COLOR_SEPARATOR_DIAGONAL;
4278 wmem_free(pref_scope, prefs.gui_interfaces_hide_types);
4279 prefs.gui_interfaces_hide_types = wmem_strdup(pref_scope, "");
4280 prefs.gui_interfaces_show_hidden = false0;
4281 prefs.gui_interfaces_remote_display = true1;
4282 prefs.gui_packet_list_separator = false0;
4283 prefs.gui_packet_header_column_definition = true1;
4284 prefs.gui_packet_list_hover_style = true1;
4285 prefs.gui_show_selected_packet = false0;
4286 prefs.gui_show_file_load_time = false0;
4287 prefs.gui_max_export_objects = 1000;
4288 prefs.gui_max_tree_items = 1 * 1000 * 1000;
4289 prefs.gui_max_tree_depth = 5 * 100;
4290 prefs.gui_decimal_places1 = DEF_GUI_DECIMAL_PLACES12;
4291 prefs.gui_decimal_places2 = DEF_GUI_DECIMAL_PLACES24;
4292 prefs.gui_decimal_places3 = DEF_GUI_DECIMAL_PLACES36;
4293
4294 if (prefs.col_list) {
4295 free_col_info(prefs.col_list);
4296 prefs.col_list = NULL((void*)0);
4297 }
4298 for (i = 0; i < num_cols; i++) {
4299 cfmt = g_new0(fmt_data,1)((fmt_data *) g_malloc0_n ((1), sizeof (fmt_data)));
4300 cfmt->title = g_strdup(col_fmt[i * 2])g_strdup_inline (col_fmt[i * 2]);
4301 cfmt->visible = true1;
4302 cfmt->display = COLUMN_DISPLAY_STRINGS'R';
4303 parse_column_format(cfmt, col_fmt[(i * 2) + 1]);
4304 prefs.col_list = g_list_append(prefs.col_list, cfmt);
4305 }
4306 prefs.num_cols = num_cols;
4307
4308/* set the default values for the capture dialog box */
4309 prefs.capture_prom_mode = true1;
4310 prefs.capture_monitor_mode = false0;
4311 prefs.capture_pcap_ng = true1;
4312 prefs.capture_zstd_compression_level = 3;
4313 prefs.capture_process_info = CAPTURE_PROCESS_INFO_BASIC;
4314 prefs.capture_real_time = true1;
4315 prefs.capture_update_interval = DEFAULT_UPDATE_INTERVAL100;
4316 prefs.capture_no_extcap = false0;
4317 prefs.capture_show_info = false0;
4318
4319/* set the default values for the tap/statistics dialog box */
4320 prefs.tap_update_interval = TAP_UPDATE_DEFAULT_INTERVAL3000;
4321 prefs.flow_graph_max_export_items = 1000;
4322 prefs.st_enable_burstinfo = true1;
4323 prefs.st_burst_showcount = false0;
4324 prefs.st_burst_resolution = ST_DEF_BURSTRES5;
4325 prefs.st_burst_windowlen = ST_DEF_BURSTLEN100;
4326 prefs.st_sort_casesensitve = true1;
4327 prefs.st_sort_rng_fixorder = true1;
4328 prefs.st_sort_rng_nameonly = true1;
4329 prefs.st_sort_defcolflag = ST_SORT_COL_COUNT2;
4330 prefs.st_sort_defdescending = true1;
4331 prefs.st_sort_showfullname = false0;
4332 prefs.conv_machine_readable = false0;
4333
4334 /* protocols */
4335 prefs.display_hidden_proto_items = false0;
4336 prefs.display_byte_fields_with_spaces = false0;
4337 prefs.display_abs_time_ascii = ABS_TIME_ASCII_TREE;
4338 prefs.ignore_dup_frames = false0;
4339 prefs.ignore_dup_frames_cache_entries = 10000;
4340
4341 /* set the default values for the io graph dialog */
4342 prefs.gui_io_graph_automatic_update = true1;
4343 prefs.gui_io_graph_enable_legend = true1;
4344
4345 /* set the default values for the plot dialog */
4346 prefs.gui_plot_automatic_update = true1;
4347 prefs.gui_plot_enable_legend = true1;
4348 prefs.gui_plot_enable_auto_scroll = false0;
4349
4350 /* set the default values for the packet dialog */
4351 prefs.gui_packet_dialog_layout = layout_vertical;
4352 prefs.gui_packet_details_show_byteview = true1;
4353}
4354
4355/*
4356 * Reset a single dissector preference.
4357 */
4358void
4359reset_pref(pref_t *pref)
4360{
4361 if (!pref) return;
4362
4363 /*
4364 * This preference is no longer supported; it's not a
4365 * real preference, so we don't reset it (i.e., we
4366 * treat it as if it weren't found in the list of
4367 * preferences, and we weren't called in the first place).
4368 */
4369 if (pref->obsolete)
4370 return;
4371
4372 switch (pref->type) {
4373
4374 case PREF_UINT:
4375 *pref->varp.uint = pref->default_val.uint;
4376 break;
4377
4378 case PREF_INT:
4379 *pref->varp.intp = pref->default_val.intval;
4380 break;
4381
4382 case PREF_FLOAT:
4383 *pref->varp.floatp = pref->default_val.floatval;
4384 break;
4385
4386 case PREF_BOOL:
4387 *pref->varp.boolp = pref->default_val.boolval;
4388 break;
4389
4390 case PREF_ENUM:
4391 case PREF_PROTO_TCP_SNDAMB_ENUM:
4392 *pref->varp.enump = pref->default_val.enumval;
4393 break;
4394
4395 case PREF_STRING:
4396 case PREF_SAVE_FILENAME:
4397 case PREF_OPEN_FILENAME:
4398 case PREF_DIRNAME:
4399 case PREF_PASSWORD:
4400 case PREF_DISSECTOR:
4401 reset_string_like_preference(pref);
4402 break;
4403
4404 case PREF_RANGE:
4405 case PREF_DECODE_AS_RANGE:
4406 wmem_free(pref->scope, *pref->varp.range);
4407 *pref->varp.range = range_copy(pref->scope, pref->default_val.range);
4408 break;
4409
4410 case PREF_STATIC_TEXT:
4411 case PREF_UAT:
4412 /* Nothing to do */
4413 break;
4414
4415 case PREF_COLOR:
4416 *pref->varp.colorp = pref->default_val.color;
4417 break;
4418
4419 case PREF_CUSTOM:
4420 pref->custom_cbs.reset_cb(pref);
4421 break;
4422 }
4423}
4424
4425static void
4426reset_pref_cb(void *data, void *user_data)
4427{
4428 pref_t *pref = (pref_t *) data;
4429 module_t *module = (module_t *)user_data;
4430
4431 if (pref && (pref->type == PREF_RANGE || pref->type == PREF_DECODE_AS_RANGE)) {
4432 /*
4433 * Some dissectors expect the range (returned via prefs_get_range_value)
4434 * to remain valid if it has not changed. If it did change, then we
4435 * should set "prefs_changed_flags" to ensure that the preference apply
4436 * callback is invoked. That callback will notify dissectors that it
4437 * should no longer assume the range to be valid.
4438 */
4439 if (ranges_are_equal(*pref->varp.range, pref->default_val.range)) {
4440 /* Optimization: do not invoke apply callback if nothing changed. */
4441 return;
4442 }
4443 module->prefs_changed_flags |= prefs_get_effect_flags(pref);
4444 }
4445 reset_pref(pref);
4446}
4447
4448/*
4449 * Reset all preferences for a module.
4450 */
4451static bool_Bool
4452reset_module_prefs(const void *key _U___attribute__((unused)), void *value, void *data _U___attribute__((unused)))
4453{
4454 module_t *module = (module_t *)value;
4455 g_list_foreach(module->prefs, reset_pref_cb, module);
4456 return false0;
4457}
4458
4459/* Reset preferences */
4460void
4461prefs_reset(const char* app_env_var_prefix, const char** col_fmt, int num_cols)
4462{
4463 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
)
;
4464 prefs.saved_at_version = NULL((void*)0);
4465
4466 /*
4467 * Unload all UAT preferences.
4468 */
4469 uat_unload_all();
4470
4471 /*
4472 * Unload any loaded MIBs.
4473 */
4474 /* XXX - oids_cleanup not tested/supported at non-shutdown yet */
4475 //oids_cleanup();
4476
4477 /*
4478 * Reload all UAT preferences.
4479 */
4480 uat_load_all(app_env_var_prefix);
4481
4482 /*
4483 * Reset the non-dissector preferences.
4484 */
4485 prefs_set_global_defaults(wmem_epan_scope(), col_fmt, num_cols);
4486
4487 /*
4488 * Reset the non-UAT dissector preferences.
4489 */
4490 wmem_tree_foreach(prefs_modules, reset_module_prefs, NULL((void*)0));
4491}
4492
4493#ifdef _WIN32
4494static void
4495read_registry(void)
4496{
4497 HKEY hTestKey;
4498 DWORD data;
4499 DWORD data_size = sizeof(DWORD);
4500 DWORD ret;
4501
4502 ret = RegOpenKeyExA(HKEY_CURRENT_USER, REG_HKCU_WIRESHARK_KEY"Software\\Wireshark", 0, KEY_READ, &hTestKey);
4503 if (ret != ERROR_SUCCESS && ret != ERROR_FILE_NOT_FOUND) {
4504 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"
, 4504, __func__, "Cannot open HKCU ""Software\\Wireshark"": 0x%lx"
, ret); } } while (0)
;
4505 return;
4506 }
4507
4508 ret = RegQueryValueExA(hTestKey, LOG_HKCU_CONSOLE_OPEN"ConsoleOpen", NULL((void*)0), NULL((void*)0), (LPBYTE)&data, &data_size);
4509 if (ret == ERROR_SUCCESS) {
4510 ws_log_console_open = (ws_log_console_open_pref)data;
4511 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"
, 4511, __func__, "Got ""ConsoleOpen"" from Windows registry: %d"
, ws_log_console_open); } } while (0)
;
4512 }
4513 else if (ret != ERROR_FILE_NOT_FOUND) {
4514 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"
, 4514, __func__, "Error reading registry key ""ConsoleOpen"": 0x%lx"
, ret); } } while (0)
;
4515 }
4516
4517 RegCloseKey(hTestKey);
4518}
4519#endif
4520
4521void
4522prefs_read_module(const char *module, bool_Bool from_profile, const char* app_env_var_prefix)
4523{
4524 int err;
4525 char *pf_path;
4526 FILE *pf;
4527
4528 module_t *target_module = prefs_find_module(module);
4529 if (!target_module) {
4530 return;
4531 }
4532
4533 /* Construct the pathname of the user's preferences file for the module. */
4534 char *pf_name = g_strdup_printf("%s.cfg", module);
4535 pf_path = get_persconffile_path(pf_name, from_profile, app_env_var_prefix);
4536 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)
;
4537
4538 /* Read the user's module preferences file, if it exists and is not a dir. */
4539 if (!test_for_regular_file(pf_path) || ((pf = ws_fopenfopen(pf_path, "r")) == NULL((void*)0))) {
4540 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)
;
4541 /* Fall back to the user's generic preferences file. */
4542 pf_path = get_persconffile_path(PF_NAME"preferences", true1, app_env_var_prefix);
4543 pf = ws_fopenfopen(pf_path, "r");
4544 }
4545
4546 if (pf != NULL((void*)0)) {
4547 /* We succeeded in opening it; read it. */
4548 err = read_prefs_file(pf_path, pf, set_pref, target_module);
4549 if (err != 0) {
4550 /* We had an error reading the file; report it. */
4551 report_warning("Error reading your preferences file \"%s\": %s.",
4552 pf_path, g_strerror(err));
4553 } else
4554 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)
;
4555 fclose(pf);
4556 } else {
4557 /* We failed to open it. If we failed for some reason other than
4558 "it doesn't exist", return the errno and the pathname, so our
4559 caller can report the error. */
4560 if (errno(*__errno_location ()) != ENOENT2) {
4561 report_warning("Can't open your preferences file \"%s\": %s.",
4562 pf_path, g_strerror(errno(*__errno_location ())));
4563 } else
4564 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)
;
4565 }
4566
4567 return;
4568}
4569
4570/* Read the preferences file, fill in "prefs", and return a pointer to it.
4571
4572 If we got an error (other than "it doesn't exist") we report it through
4573 the UI. */
4574e_prefs *
4575read_prefs(const char* app_env_var_prefix)
4576{
4577 int err;
4578 char *pf_path;
4579 FILE *pf;
4580
4581 /* clean up libsmi structures before reading prefs */
4582 /* XXX - oids_cleanup not tested/supported at non-shutdown yet */
4583 // oids_cleanup();
4584
4585#ifdef _WIN32
4586 read_registry();
4587#endif
4588
4589 /*
4590 * If we don't already have the pathname of the global preferences
4591 * file, construct it. Then, in either case, try to open the file.
4592 */
4593 if (gpf_path == NULL((void*)0)) {
4594 /*
4595 * We don't have the path; try the new path first, and, if that
4596 * file doesn't exist, try the old path.
4597 */
4598 gpf_path = get_datafile_path(PF_NAME"preferences", app_env_var_prefix);
4599 if ((pf = ws_fopenfopen(gpf_path, "r")) == NULL((void*)0) && errno(*__errno_location ()) == ENOENT2) {
4600 /*
4601 * It doesn't exist by the new name; try the old name.
4602 */
4603 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)
;
4604 gpf_path = get_datafile_path(OLD_GPF_NAME"wireshark.conf", app_env_var_prefix);
4605 pf = ws_fopenfopen(gpf_path, "r");
4606 }
4607 } else {
4608 /*
4609 * We have the path; try it.
4610 */
4611 pf = ws_fopenfopen(gpf_path, "r");
4612 }
4613
4614 /*
4615 * If we were able to open the file, read it.
4616 * XXX - if it failed for a reason other than "it doesn't exist",
4617 * report the error.
4618 */
4619 if (pf != NULL((void*)0)) {
4620 /* We succeeded in opening it; read it. */
4621 err = read_prefs_file(gpf_path, pf, set_pref, NULL((void*)0));
4622 if (err != 0) {
4623 /* We had an error reading the file; report it. */
4624 report_warning("Error reading global preferences file \"%s\": %s.",
4625 gpf_path, g_strerror(err));
4626 }
4627 fclose(pf);
4628 } else {
4629 /* We failed to open it. If we failed for some reason other than
4630 "it doesn't exist", report the error. */
4631 if (errno(*__errno_location ()) != ENOENT2) {
4632 if (errno(*__errno_location ()) != 0) {
4633 report_warning("Can't open global preferences file \"%s\": %s.",
4634 gpf_path, g_strerror(errno(*__errno_location ())));
4635 }
4636 }
4637 }
4638
4639 /* Construct the pathname of the user's preferences file. */
4640 pf_path = get_persconffile_path(PF_NAME"preferences", true1, app_env_var_prefix);
4641
4642 /* Read the user's preferences file, if it exists. */
4643 if ((pf = ws_fopenfopen(pf_path, "r")) != NULL((void*)0)) {
4644
4645 /* We succeeded in opening it; read it. */
4646 err = read_prefs_file(pf_path, pf, set_pref, NULL((void*)0));
4647 if (err != 0) {
4648 /* We had an error reading the file; report it. */
4649 report_warning("Error reading your preferences file \"%s\": %s.",
4650 pf_path, g_strerror(err));
4651 } else
4652 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)
;
4653 fclose(pf);
4654 } else {
4655 /* We failed to open it. If we failed for some reason other than
4656 "it doesn't exist", return the errno and the pathname, so our
4657 caller can report the error. */
4658 if (errno(*__errno_location ()) != ENOENT2) {
4659 report_warning("Can't open your preferences file \"%s\": %s.",
4660 pf_path, g_strerror(errno(*__errno_location ())));
4661 } else
4662 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)
;
4663 }
4664
4665 /* load SMI modules if needed */
4666 oids_init(app_env_var_prefix);
4667
4668 return &prefs;
4669}
4670
4671/* read the preferences file (or similar) and call the callback
4672 * function to set each key/value pair found */
4673int
4674read_prefs_file(const char *pf_path, FILE *pf,
4675 pref_set_pair_cb pref_set_pair_fct, void *private_data)
4676{
4677 enum {
4678 START, /* beginning of a line */
4679 IN_VAR, /* processing key name */
4680 PRE_VAL, /* finished processing key name, skipping white space before value */
4681 IN_VAL, /* processing value */
4682 IN_SKIP /* skipping to the end of the line */
4683 } state = START;
4684 int got_c;
4685 GString *cur_val;
4686 GString *cur_var;
4687 bool_Bool got_val = false0;
4688 int fline = 1, pline = 1;
4689 char hint[] = "(save preferences to remove this warning)";
4690 char ver[128];
4691
4692 cur_val = g_string_new("");
4693 cur_var = g_string_new("");
4694
4695 /* Try to read in the profile name in the first line of the preferences file. */
4696 if (fscanf(pf, "# Configuration file for %127[^\r\n]", ver) == 1) {
1
Assuming the condition is false
2
Taking false branch
4697 /* Assume trailing period and remove it */
4698 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
)
;
4699 prefs.saved_at_version = g_strndup(ver, strlen(ver) - 1);
4700 }
4701 rewind(pf);
3
After calling 'rewind' reading 'errno' is required to find out if the call has failed
4702
4703 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'
4704 if (got_c == '\r') {
4705 /* Treat CR-LF at the end of a line like LF, so that if we're reading
4706 * a Windows-format file on UN*X, we handle it the same way we'd handle
4707 * a UN*X-format file. */
4708 got_c = ws_getc_unlockedgetc_unlocked(pf);
4709 if (got_c == EOF(-1))
4710 break;
4711 if (got_c != '\n') {
4712 /* Put back the character after the CR, and process the CR normally. */
4713 ungetc(got_c, pf);
4714 got_c = '\r';
4715 }
4716 }
4717 if (got_c == '\n') {
4718 state = START;
4719 fline++;
4720 continue;
4721 }
4722
4723 switch (state) {
4724 case START:
4725 if (g_ascii_isalnum(got_c)((g_ascii_table[(guchar) (got_c)] & G_ASCII_ALNUM) != 0)) {
4726 if (cur_var->len > 0) {
4727 if (got_val) {
4728 if (cur_val->len > 0) {
4729 if (cur_val->str[cur_val->len-1] == ',') {
4730 /*
4731 * If the pref has a trailing comma, eliminate it.
4732 */
4733 cur_val->str[cur_val->len-1] = '\0';
4734 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"
, 4734, __func__, "%s line %d: trailing comma in \"%s\" %s", pf_path
, pline, cur_var->str, hint); } } while (0)
;
4735 }
4736 }
4737 /* Call the routine to set the preference; it will parse
4738 the value as appropriate.
4739
4740 Since we're reading a file, rather than processing
4741 explicit user input, for range preferences, silently
4742 lower values in excess of the range's maximum, rather
4743 than reporting errors and failing. */
4744 switch (pref_set_pair_fct(cur_var->str, cur_val->str, private_data, false0)) {
4745
4746 case PREFS_SET_OK:
4747 break;
4748
4749 case PREFS_SET_SYNTAX_ERR:
4750 report_warning("Syntax error in preference \"%s\" at line %d of\n%s %s",
4751 cur_var->str, pline, pf_path, hint);
4752 break;
4753
4754 case PREFS_SET_NO_SUCH_PREF:
4755 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"
, 4756, __func__, "No such preference \"%s\" at line %d of\n%s %s"
, cur_var->str, pline, pf_path, hint); } } while (0)
4756 cur_var->str, pline, pf_path, hint)do { if (1) { ws_log_full("Epan", LOG_LEVEL_WARNING, "epan/prefs.c"
, 4756, __func__, "No such preference \"%s\" at line %d of\n%s %s"
, cur_var->str, pline, pf_path, hint); } } while (0)
;
4757 break;
4758
4759 case PREFS_SET_OBSOLETE:
4760 /*
4761 * If an attempt is made to save the
4762 * preferences, a popup warning will be
4763 * displayed stating that obsolete prefs
4764 * have been detected and the user will
4765 * be given the opportunity to save these
4766 * prefs under a different profile name.
4767 * The prefs in question need to be listed
4768 * in the console window so that the
4769 * user can make an informed choice.
4770 */
4771 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"
, 4772, __func__, "Obsolete preference \"%s\" at line %d of\n%s %s"
, cur_var->str, pline, pf_path, hint); } } while (0)
4772 cur_var->str, pline, pf_path, hint)do { if (1) { ws_log_full("Epan", LOG_LEVEL_WARNING, "epan/prefs.c"
, 4772, __func__, "Obsolete preference \"%s\" at line %d of\n%s %s"
, cur_var->str, pline, pf_path, hint); } } while (0)
;
4773 break;
4774 }
4775 } else {
4776 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"
, 4776, __func__, "Incomplete preference at line %d: of\n%s %s"
, pline, pf_path, hint); } } while (0)
;
4777 }
4778 }
4779 state = IN_VAR;
4780 got_val = false0;
4781 g_string_truncate(cur_var, 0)g_string_truncate_inline (cur_var, 0);
4782 g_string_append_c(cur_var, (char) got_c)g_string_append_c_inline (cur_var, (char) got_c);
4783 pline = fline;
4784 } else if (g_ascii_isspace(got_c)((g_ascii_table[(guchar) (got_c)] & G_ASCII_SPACE) != 0) && cur_var->len > 0 && got_val) {
4785 state = PRE_VAL;
4786 } else if (got_c == '#') {
4787 state = IN_SKIP;
4788 } else {
4789 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"
, 4789, __func__, "Malformed preference at line %d of\n%s %s"
, fline, pf_path, hint); } } while (0)
;
4790 }
4791 break;
4792 case IN_VAR:
4793 if (got_c != ':') {
4794 g_string_append_c(cur_var, (char) got_c)g_string_append_c_inline (cur_var, (char) got_c);
4795 } else {
4796 /* This is a colon (':') */
4797 state = PRE_VAL;
4798 g_string_truncate(cur_val, 0)g_string_truncate_inline (cur_val, 0);
4799 /*
4800 * Set got_val to true to accommodate prefs such as
4801 * "gui.fileopen.dir" that do not require a value.
4802 */
4803 got_val = true1;
4804 }
4805 break;
4806 case PRE_VAL:
4807 if (!g_ascii_isspace(got_c)((g_ascii_table[(guchar) (got_c)] & G_ASCII_SPACE) != 0)) {
4808 state = IN_VAL;
4809 g_string_append_c(cur_val, (char) got_c)g_string_append_c_inline (cur_val, (char) got_c);
4810 }
4811 break;
4812 case IN_VAL:
4813 g_string_append_c(cur_val, (char) got_c)g_string_append_c_inline (cur_val, (char) got_c);
4814 break;
4815 case IN_SKIP:
4816 break;
4817 }
4818 }
4819 if (cur_var->len > 0) {
4820 if (got_val) {
4821 /* Call the routine to set the preference; it will parse
4822 the value as appropriate.
4823
4824 Since we're reading a file, rather than processing
4825 explicit user input, for range preferences, silently
4826 lower values in excess of the range's maximum, rather
4827 than reporting errors and failing. */
4828 switch (pref_set_pair_fct(cur_var->str, cur_val->str, private_data, false0)) {
4829
4830 case PREFS_SET_OK:
4831 break;
4832
4833 case PREFS_SET_SYNTAX_ERR:
4834 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"
, 4835, __func__, "Syntax error in preference %s at line %d of\n%s %s"
, cur_var->str, pline, pf_path, hint); } } while (0)
4835 cur_var->str, pline, pf_path, hint)do { if (1) { ws_log_full("Epan", LOG_LEVEL_WARNING, "epan/prefs.c"
, 4835, __func__, "Syntax error in preference %s at line %d of\n%s %s"
, cur_var->str, pline, pf_path, hint); } } while (0)
;
4836 break;
4837
4838 case PREFS_SET_NO_SUCH_PREF:
4839 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"
, 4840, __func__, "No such preference \"%s\" at line %d of\n%s %s"
, cur_var->str, pline, pf_path, hint); } } while (0)
4840 cur_var->str, pline, pf_path, hint)do { if (1) { ws_log_full("Epan", LOG_LEVEL_WARNING, "epan/prefs.c"
, 4840, __func__, "No such preference \"%s\" at line %d of\n%s %s"
, cur_var->str, pline, pf_path, hint); } } while (0)
;
4841 break;
4842
4843 case PREFS_SET_OBSOLETE:
4844 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"
, 4845, __func__, "Obsolete preference \"%s\" at line %d of\n%s %s"
, cur_var->str, pline, pf_path, hint); } } while (0)
4845 cur_var->str, pline, pf_path, hint)do { if (1) { ws_log_full("Epan", LOG_LEVEL_WARNING, "epan/prefs.c"
, 4845, __func__, "Obsolete preference \"%s\" at line %d of\n%s %s"
, cur_var->str, pline, pf_path, hint); } } while (0)
;
4846 break;
4847 }
4848 } else {
4849 ws_warning("Incomplete preference at line %d of\n%s %s",do { if (1) { ws_log_full("Epan", LOG_LEVEL_WARNING, "epan/prefs.c"
, 4850, __func__, "Incomplete preference at line %d of\n%s %s"
, pline, pf_path, hint); } } while (0)
4850 pline, pf_path, hint)do { if (1) { ws_log_full("Epan", LOG_LEVEL_WARNING, "epan/prefs.c"
, 4850, __func__, "Incomplete preference at line %d of\n%s %s"
, pline, pf_path, hint); } } while (0)
;
4851 }
4852 }
4853
4854 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)))))
;
4855 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)))))
;
4856
4857 if (ferror(pf))
4858 return errno(*__errno_location ());
4859 else
4860 return 0;
4861}
4862
4863/*
4864 * If we were handed a preference starting with "uat:", try to turn it into
4865 * a valid uat entry.
4866 */
4867static bool_Bool
4868prefs_set_uat_pref(char *uat_entry, char **errmsg) {
4869 char *p, *colonp;
4870 uat_t *uat;
4871 bool_Bool ret;
4872
4873 colonp = strchr(uat_entry, ':');
4874 if (colonp == NULL((void*)0))
4875 return false0;
4876
4877 p = colonp;
4878 *p++ = '\0';
4879
4880 /*
4881 * Skip over any white space (there probably won't be any, but
4882 * as we allow it in the preferences file, we might as well
4883 * allow it here).
4884 */
4885 while (g_ascii_isspace(*p)((g_ascii_table[(guchar) (*p)] & G_ASCII_SPACE) != 0))
4886 p++;
4887 if (*p == '\0') {
4888 /*
4889 * Put the colon back, so if our caller uses, in an
4890 * error message, the string they passed us, the message
4891 * looks correct.
4892 */
4893 *colonp = ':';
4894 return false0;
4895 }
4896
4897 uat = uat_find(uat_entry);
4898 *colonp = ':';
4899 if (uat == NULL((void*)0)) {
4900 *errmsg = g_strdup("Unknown preference")g_strdup_inline ("Unknown preference");
4901 return false0;
4902 }
4903
4904 ret = uat_load_str(uat, p, errmsg);
4905 return ret;
4906}
4907
4908char *
4909prefs_sanitize_string(const char* str)
4910{
4911 char *sanitized;
4912 if (!prefs_regex) {
4913 prefs_regex = g_regex_new("\\s*\\R\\s*", (GRegexCompileFlags)G_REGEX_OPTIMIZE,
4914 (GRegexMatchFlags)G_REGEX_MATCH_BSR_ANYCRLF, NULL((void*)0));
4915 } else {
4916 g_regex_ref(prefs_regex);
4917 }
4918 sanitized = g_regex_replace(prefs_regex, str, -1, 0, " ", G_REGEX_MATCH_DEFAULT, NULL((void*)0));
4919 g_regex_unref(prefs_regex);
4920 return sanitized;
4921}
4922
4923/*
4924 * Given a string of the form "<pref name>:<pref value>", as might appear
4925 * as an argument to a "-o" option, parse it and set the preference in
4926 * question. Return an indication of whether it succeeded or failed
4927 * in some fashion.
4928 */
4929prefs_set_pref_e
4930prefs_set_pref(char *prefarg, char **errmsg)
4931{
4932 char *p, *colonp;
4933 prefs_set_pref_e ret;
4934
4935 *errmsg = NULL((void*)0);
4936
4937 colonp = strchr(prefarg, ':');
4938 if (colonp == NULL((void*)0)) {
4939 *errmsg = g_strdup("missing ':' (syntax is prefname:value).")g_strdup_inline ("missing ':' (syntax is prefname:value).");
4940 return PREFS_SET_SYNTAX_ERR;
4941 }
4942
4943 p = colonp;
4944 *p++ = '\0';
4945 /* XXX - Replace line terminators, or match and fail with errmsg, or ignore? */
4946
4947 /*
4948 * Skip over any white space (there probably won't be any, but
4949 * as we allow it in the preferences file, we might as well
4950 * allow it here).
4951 */
4952 while (g_ascii_isspace(*p)((g_ascii_table[(guchar) (*p)] & G_ASCII_SPACE) != 0))
4953 p++;
4954 /* The empty string is a legal value for range preferences (PREF_RANGE,
4955 * PREF_DECODE_AS_RANGE), and string-like preferences (PREF_STRING,
4956 * PREF_SAVE_FILENAME, PREF_OPEN_FILENAME, PREF_DIRNAME), indeed often
4957 * not just useful but the default. A user might have a value saved
4958 * to their preference file but want to override it to default behavior.
4959 * Individual preference handlers of those types should be prepared to
4960 * deal with an empty string. For other types, it is up to set_pref() to
4961 * test for the empty string and set PREFS_SET_SYNTAX_ERROR there.
4962 */
4963 if (strcmp(prefarg, "uat")) {
4964 ret = set_pref(prefarg, p, NULL((void*)0), true1);
4965 } else {
4966 ret = prefs_set_uat_pref(p, errmsg) ? PREFS_SET_OK : PREFS_SET_SYNTAX_ERR;
4967 }
4968 *colonp = ':'; /* put the colon back */
4969 return ret;
4970}
4971
4972unsigned prefs_get_uint_value(pref_t *pref, pref_source_t source)
4973{
4974 switch (source)
4975 {
4976 case pref_default:
4977 return pref->default_val.uint;
4978 case pref_stashed:
4979 return pref->stashed_val.uint;
4980 case pref_current:
4981 return *pref->varp.uint;
4982 default:
4983 ws_assert_not_reached()ws_log_fatal_full("Epan", LOG_LEVEL_ERROR, "epan/prefs.c", 4983
, __func__, "assertion \"not reached\" failed")
;
4984 break;
4985 }
4986
4987 return 0;
4988}
4989
4990unsigned int prefs_set_int_value(pref_t* pref, int value, pref_source_t source)
4991{
4992 int changed = 0;
4993 switch (source)
4994 {
4995 case pref_default:
4996 if (pref->default_val.intval != value) {
4997 pref->default_val.intval = value;
4998 changed = prefs_get_effect_flags(pref);
4999 }
5000 break;
5001 case pref_stashed:
5002 if (pref->stashed_val.intval != value) {
5003 pref->stashed_val.intval = value;
5004 changed = prefs_get_effect_flags(pref);
5005 }
5006 break;
5007 case pref_current:
5008 if (*pref->varp.intp != value) {
5009 *pref->varp.intp = value;
5010 changed = prefs_get_effect_flags(pref);
5011 }
5012 break;
5013 default:
5014 ws_assert_not_reached()ws_log_fatal_full("Epan", LOG_LEVEL_ERROR, "epan/prefs.c", 5014
, __func__, "assertion \"not reached\" failed")
;
5015 break;
5016 }
5017
5018 return changed;
5019}
5020
5021int prefs_get_int_value(pref_t* pref, pref_source_t source)
5022{
5023 switch (source)
5024 {
5025 case pref_default:
5026 return pref->default_val.intval;
5027 case pref_stashed:
5028 return pref->stashed_val.intval;
5029 case pref_current:
5030 return *pref->varp.intp;
5031 default:
5032 ws_assert_not_reached()ws_log_fatal_full("Epan", LOG_LEVEL_ERROR, "epan/prefs.c", 5032
, __func__, "assertion \"not reached\" failed")
;
5033 break;
5034 }
5035
5036 return 0;
5037}
5038
5039unsigned int prefs_set_float_value(pref_t* pref, double value, pref_source_t source)
5040{
5041 int changed = 0;
5042 switch (source)
5043 {
5044 case pref_default:
5045 if (pref->default_val.floatval != value) {
5046 pref->default_val.floatval = value;
5047 changed = prefs_get_effect_flags(pref);
5048 }
5049 break;
5050 case pref_stashed:
5051 if (pref->stashed_val.floatval != value) {
5052 pref->stashed_val.floatval = value;
5053 changed = prefs_get_effect_flags(pref);
5054 }
5055 break;
5056 case pref_current:
5057 if (*pref->varp.floatp != value) {
5058 *pref->varp.floatp = value;
5059 changed = prefs_get_effect_flags(pref);
5060 }
5061 break;
5062 default:
5063 ws_assert_not_reached()ws_log_fatal_full("Epan", LOG_LEVEL_ERROR, "epan/prefs.c", 5063
, __func__, "assertion \"not reached\" failed")
;
5064 break;
5065 }
5066
5067 return changed;
5068}
5069
5070double prefs_get_float_value(pref_t* pref, pref_source_t source)
5071{
5072 switch (source)
5073 {
5074 case pref_default:
5075 return pref->default_val.floatval;
5076 case pref_stashed:
5077 return pref->stashed_val.floatval;
5078 case pref_current:
5079 return *pref->varp.floatp;
5080 default:
5081 ws_assert_not_reached()ws_log_fatal_full("Epan", LOG_LEVEL_ERROR, "epan/prefs.c", 5081
, __func__, "assertion \"not reached\" failed")
;
5082 break;
5083 }
5084
5085 return 0;
5086}
5087
5088
5089const char *prefs_get_password_value(pref_t *pref, pref_source_t source)
5090{
5091 return prefs_get_string_value(pref, source);
5092}
5093
5094
5095unsigned int prefs_set_uint_value(pref_t *pref, unsigned value, pref_source_t source)
5096{
5097 unsigned int changed = 0;
5098 switch (source)
5099 {
5100 case pref_default:
5101 if (pref->default_val.uint != value) {
5102 pref->default_val.uint = value;
5103 changed = prefs_get_effect_flags(pref);
5104 }
5105 break;
5106 case pref_stashed:
5107 if (pref->stashed_val.uint != value) {
5108 pref->stashed_val.uint = value;
5109 changed = prefs_get_effect_flags(pref);
5110 }
5111 break;
5112 case pref_current:
5113 if (*pref->varp.uint != value) {
5114 *pref->varp.uint = value;
5115 changed = prefs_get_effect_flags(pref);
5116 }
5117 break;
5118 default:
5119 ws_assert_not_reached()ws_log_fatal_full("Epan", LOG_LEVEL_ERROR, "epan/prefs.c", 5119
, __func__, "assertion \"not reached\" failed")
;
5120 break;
5121 }
5122
5123 return changed;
5124}
5125
5126/*
5127 * For use by UI code that sets preferences.
5128 */
5129unsigned int
5130prefs_set_password_value(pref_t *pref, const char* value, pref_source_t source)
5131{
5132 return prefs_set_string_value(pref, value, source);
5133}
5134
5135
5136unsigned prefs_get_uint_base(pref_t *pref)
5137{
5138 return pref->info.base;
5139}
5140
5141/*
5142 * Returns true if the given device is hidden
5143 */
5144bool_Bool
5145prefs_is_capture_device_hidden(const char *name)
5146{
5147 char *tok, *devices;
5148 size_t len;
5149
5150 if (prefs.capture_devices_hide && name) {
5151 devices = g_strdup (prefs.capture_devices_hide)g_strdup_inline (prefs.capture_devices_hide);
5152 len = strlen (name);
5153 for (tok = strtok (devices, ","); tok; tok = strtok(NULL((void*)0), ",")) {
5154 if (strlen (tok) == len && strcmp (name, tok) == 0) {
5155 g_free (devices)(__builtin_object_size ((devices), 0) != ((size_t) - 1)) ? g_free_sized
(devices, __builtin_object_size ((devices), 0)) : (g_free) (
devices)
;
5156 return true1;
5157 }
5158 }
5159 g_free (devices)(__builtin_object_size ((devices), 0) != ((size_t) - 1)) ? g_free_sized
(devices, __builtin_object_size ((devices), 0)) : (g_free) (
devices)
;
5160 }
5161
5162 return false0;
5163}
5164
5165/*
5166 * Returns true if the given column is visible (not hidden)
5167 */
5168static bool_Bool
5169prefs_is_column_visible(const char *cols_hidden, int col)
5170{
5171 char *tok, *cols, *p;
5172 int cidx;
5173
5174 /*
5175 * Do we have a list of hidden columns?
5176 */
5177 if (cols_hidden) {
5178 /*
5179 * Yes - check the column against each of the ones in the
5180 * list.
5181 */
5182 cols = g_strdup(cols_hidden)g_strdup_inline (cols_hidden);
5183 for (tok = strtok(cols, ","); tok; tok = strtok(NULL((void*)0), ",")) {
5184 tok = g_strstrip(tok)g_strchomp (g_strchug (tok));
5185
5186 cidx = (int)strtol(tok, &p, 10);
5187 if (p == tok || *p != '\0') {
5188 continue;
5189 }
5190 if (cidx != col) {
5191 continue;
5192 }
5193 /*
5194 * OK, they match, so it's one of the hidden fields,
5195 * hence not visible.
5196 */
5197 g_free(cols)(__builtin_object_size ((cols), 0) != ((size_t) - 1)) ? g_free_sized
(cols, __builtin_object_size ((cols), 0)) : (g_free) (cols)
;
5198 return false0;
5199 }
5200 g_free(cols)(__builtin_object_size ((cols), 0) != ((size_t) - 1)) ? g_free_sized
(cols, __builtin_object_size ((cols), 0)) : (g_free) (cols)
;
5201 }
5202
5203 /*
5204 * No - either there are no hidden columns or this isn't one
5205 * of them - so it is visible.
5206 */
5207 return true1;
5208}
5209
5210/*
5211 * Returns true if the given column is visible (not hidden)
5212 */
5213static bool_Bool
5214prefs_is_column_fmt_visible(const char *cols_hidden, fmt_data *cfmt)
5215{
5216 char *tok, *cols;
5217 fmt_data cfmt_hidden;
5218
5219 /*
5220 * Do we have a list of hidden columns?
5221 */
5222 if (cols_hidden) {
5223 /*
5224 * Yes - check the column against each of the ones in the
5225 * list.
5226 */
5227 cols = g_strdup(cols_hidden)g_strdup_inline (cols_hidden);
5228 for (tok = strtok(cols, ","); tok; tok = strtok(NULL((void*)0), ",")) {
5229 tok = g_strstrip(tok)g_strchomp (g_strchug (tok));
5230
5231 /*
5232 * Parse this column format.
5233 */
5234 if (!parse_column_format(&cfmt_hidden, tok)) {
5235 /*
5236 * It's not valid; ignore it.
5237 */
5238 continue;
5239 }
5240
5241 /*
5242 * Does it match the column?
5243 */
5244 if (cfmt->fmt != cfmt_hidden.fmt) {
5245 /* No. */
5246 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
)
;
5247 cfmt_hidden.custom_fields = NULL((void*)0);
5248 continue;
5249 }
5250 if (cfmt->fmt == COL_CUSTOM) {
5251 /*
5252 * A custom column has to have the same custom field
5253 * and occurrence.
5254 */
5255 if (cfmt_hidden.custom_fields && cfmt->custom_fields) {
5256 if (strcmp(cfmt->custom_fields,
5257 cfmt_hidden.custom_fields) != 0) {
5258 /* Different fields. */
5259 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
)
;
5260 cfmt_hidden.custom_fields = NULL((void*)0);
5261 continue;
5262 }
5263 if (cfmt->custom_occurrence != cfmt_hidden.custom_occurrence) {
5264 /* Different occurrences settings. */
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 cfmt_hidden.custom_fields = NULL((void*)0);
5267 continue;
5268 }
5269 }
5270 }
5271
5272 /*
5273 * OK, they match, so it's one of the hidden fields,
5274 * hence not visible.
5275 */
5276 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
)
;
5277 g_free(cols)(__builtin_object_size ((cols), 0) != ((size_t) - 1)) ? g_free_sized
(cols, __builtin_object_size ((cols), 0)) : (g_free) (cols)
;
5278 return false0;
5279 }
5280 g_free(cols)(__builtin_object_size ((cols), 0) != ((size_t) - 1)) ? g_free_sized
(cols, __builtin_object_size ((cols), 0)) : (g_free) (cols)
;
5281 }
5282
5283 /*
5284 * No - either there are no hidden columns or this isn't one
5285 * of them - so it is visible.
5286 */
5287 return true1;
5288}
5289
5290/*
5291 * Returns true if the given device should capture in monitor mode by default
5292 */
5293bool_Bool
5294prefs_capture_device_monitor_mode(const char *name)
5295{
5296 char *tok, *devices;
5297 size_t len;
5298
5299 if (prefs.capture_devices_monitor_mode && name) {
5300 devices = g_strdup (prefs.capture_devices_monitor_mode)g_strdup_inline (prefs.capture_devices_monitor_mode);
5301 len = strlen (name);
5302 for (tok = strtok (devices, ","); tok; tok = strtok(NULL((void*)0), ",")) {
5303 if (strlen (tok) == len && strcmp (name, tok) == 0) {
5304 g_free (devices)(__builtin_object_size ((devices), 0) != ((size_t) - 1)) ? g_free_sized
(devices, __builtin_object_size ((devices), 0)) : (g_free) (
devices)
;
5305 return true1;
5306 }
5307 }
5308 g_free (devices)(__builtin_object_size ((devices), 0) != ((size_t) - 1)) ? g_free_sized
(devices, __builtin_object_size ((devices), 0)) : (g_free) (
devices)
;
5309 }
5310
5311 return false0;
5312}
5313
5314bool_Bool
5315prefs_has_layout_pane_content (layout_pane_content_e layout_pane_content)
5316{
5317 return ((prefs.gui_layout_content_1 == layout_pane_content) ||
5318 (prefs.gui_layout_content_2 == layout_pane_content) ||
5319 (prefs.gui_layout_content_3 == layout_pane_content));
5320}
5321
5322char
5323string_to_name_resolve(const char *string, e_addr_resolve *name_resolve)
5324{
5325 char c;
5326
5327 memset(name_resolve, 0, sizeof(e_addr_resolve));
5328 while ((c = *string++) != '\0') {
5329 switch (c) {
5330 case 'g':
5331 name_resolve->maxmind_geoip = true1;
5332 break;
5333 case 'm':
5334 name_resolve->mac_name = true1;
5335 break;
5336 case 'n':
5337 name_resolve->network_name = true1;
5338 break;
5339 case 'N':
5340 name_resolve->use_external_net_name_resolver = true1;
5341 break;
5342 case 't':
5343 name_resolve->transport_name = true1;
5344 break;
5345 case 'd':
5346 name_resolve->dns_pkt_addr_resolution = true1;
5347 break;
5348 case 's':
5349 name_resolve->handshake_sni_addr_resolution = true1;
5350 break;
5351 case 'v':
5352 name_resolve->vlan_name = true1;
5353 break;
5354 default:
5355 /*
5356 * Unrecognized letter.
5357 */
5358 return c;
5359 }
5360 }
5361 return '\0';
5362}
5363
5364static bool_Bool
5365deprecated_heur_dissector_pref(char *pref_name, const char *value)
5366{
5367 struct heur_pref_name
5368 {
5369 const char* pref_name;
5370 const char* short_name;
5371 bool_Bool more_dissectors; /* For multiple dissectors controlled by the same preference */
5372 };
5373
5374 static const struct heur_pref_name heur_prefs[] = {
5375 {"acn.heuristic_acn", "acn_udp", 0},
5376 {"bfcp.enable", "bfcp_tcp", 1},
5377 {"bfcp.enable", "bfcp_udp", 0},
5378 {"bt-dht.enable", "bittorrent_dht_udp", 0},
5379 {"bt-utp.enable", "bt_utp_udp", 0},
5380 {"cattp.enable", "cattp_udp", 0},
5381 {"cfp.enable", "fp_eth", 0},
5382 {"dicom.heuristic", "dicom_tcp", 0},
5383 {"dnp3.heuristics", "dnp3_tcp", 1},
5384 {"dnp3.heuristics", "dnp3_udp", 0},
5385 {"dvb-s2_modeadapt.enable", "dvb_s2_udp", 0},
5386 {"esl.enable", "esl_eth", 0},
5387 {"fp.udp_heur", "fp_udp", 0},
5388 {"gvsp.enable_heuristic", "gvsp_udp", 0},
5389 {"hdcp2.enable", "hdcp2_tcp", 0},
5390 {"hislip.enable_heuristic", "hislip_tcp", 0},
5391 {"infiniband.dissect_eoib", "mellanox_eoib", 1},
5392 {"infiniband.identify_payload", "eth_over_ib", 0},
5393 {"jxta.udp.heuristic", "jxta_udp", 0},
5394 {"jxta.tcp.heuristic", "jxta_tcp", 0},
5395 {"jxta.sctp.heuristic", "jxta_sctp", 0},
5396 {"mac-lte.heuristic_mac_lte_over_udp", "mac_lte_udp", 0},
5397 {"mbim.bulk_heuristic", "mbim_usb_bulk", 0},
5398 {"norm.heuristic_norm", "rmt_norm_udp", 0},
5399 {"openflow.heuristic", "openflow_tcp", 0},
5400 {"pdcp-lte.heuristic_pdcp_lte_over_udp", "pdcp_lte_udp", 0},
5401 {"rlc.heuristic_rlc_over_udp", "rlc_udp", 0},
5402 {"rlc-lte.heuristic_rlc_lte_over_udp", "rlc_lte_udp", 0},
5403 {"rtcp.heuristic_rtcp", "rtcp_udp", 1},
5404 {"rtcp.heuristic_rtcp", "rtcp_stun", 0},
5405 {"rtp.heuristic_rtp", "rtp_udp", 1},
5406 {"rtp.heuristic_rtp", "rtp_stun", 0},
5407 {"teredo.heuristic_teredo", "teredo_udp", 0},
5408 {"vssmonitoring.use_heuristics", "vssmonitoring_eth", 0},
5409 {"xml.heuristic", "xml_http", 1},
5410 {"xml.heuristic", "xml_sip", 1},
5411 {"xml.heuristic", "xml_media", 0},
5412 {"xml.heuristic_tcp", "xml_tcp", 0},
5413 {"xml.heuristic_udp", "xml_udp", 0},
5414 };
5415
5416 unsigned int i;
5417 heur_dtbl_entry_t* heuristic;
5418
5419
5420 for (i = 0; i < array_length(heur_prefs)(sizeof (heur_prefs) / sizeof (heur_prefs)[0]); i++)
5421 {
5422 if (strcmp(pref_name, heur_prefs[i].pref_name) == 0)
5423 {
5424 heuristic = find_heur_dissector_by_unique_short_name(heur_prefs[i].short_name);
5425 if (heuristic != NULL((void*)0)) {
5426 heuristic->enabled = ((g_ascii_strcasecmp(value, "true") == 0) ? true1 : false0);
5427 }
5428
5429 if (!heur_prefs[i].more_dissectors)
5430 return true1;
5431 }
5432 }
5433
5434
5435 return false0;
5436}
5437
5438static bool_Bool
5439deprecated_enable_dissector_pref(char *pref_name, const char *value)
5440{
5441 struct dissector_pref_name
5442 {
5443 const char* pref_name;
5444 const char* short_name;
5445 };
5446
5447 struct dissector_pref_name dissector_prefs[] = {
5448 {"transum.tsumenabled", "TRANSUM"},
5449 {"snort.enable_snort_dissector", "Snort"},
5450 {"prp.enable", "PRP"},
5451 };
5452
5453 unsigned int i;
5454 int proto_id;
5455
5456 for (i = 0; i < array_length(dissector_prefs)(sizeof (dissector_prefs) / sizeof (dissector_prefs)[0]); i++)
5457 {
5458 if (strcmp(pref_name, dissector_prefs[i].pref_name) == 0)
5459 {
5460 proto_id = proto_get_id_by_short_name(dissector_prefs[i].short_name);
5461 if (proto_id >= 0)
5462 proto_set_decoding(proto_id, ((g_ascii_strcasecmp(value, "true") == 0) ? true1 : false0));
5463 return true1;
5464 }
5465 }
5466
5467 return false0;
5468}
5469
5470static bool_Bool
5471deprecated_port_pref(char *pref_name, const char *value)
5472{
5473 struct port_pref_name
5474 {
5475 const char* pref_name;
5476 const char* module_name; /* the protocol filter name */
5477 const char* table_name;
5478 unsigned base;
5479 };
5480
5481 struct obsolete_pref_name
5482 {
5483 const char* pref_name;
5484 };
5485
5486 /* For now this is only supporting TCP/UDP port and RTP payload
5487 * types dissector preferences, which are assumed to be decimal */
5488 /* module_name is the filter name of the destination port preference,
5489 * which is usually the same as the original module but not
5490 * necessarily (e.g., if the preference is for what is now a PINO.)
5491 * XXX: Most of these were changed pre-2.0. Can we end support
5492 * for migrating legacy preferences at some point?
5493 */
5494 static const struct port_pref_name port_prefs[] = {
5495 /* TCP */
5496 {"cmp.tcp_alternate_port", "cmp", "tcp.port", 10},
5497 {"h248.tcp_port", "h248", "tcp.port", 10},
5498 {"cops.tcp.cops_port", "cops", "tcp.port", 10},
5499 {"dhcpfo.tcp_port", "dhcpfo", "tcp.port", 10},
5500 {"enttec.tcp_port", "enttec", "tcp.port", 10},
5501 {"forces.tcp_alternate_port", "forces", "tcp.port", 10},
5502 {"ged125.tcp_port", "ged125", "tcp.port", 10},
5503 {"hpfeeds.dissector_port", "hpfeeds", "tcp.port", 10},
5504 {"lsc.port", "lsc", "tcp.port", 10},
5505 {"megaco.tcp.txt_port", "megaco", "tcp.port", 10},
5506 {"netsync.tcp_port", "netsync", "tcp.port", 10},
5507 {"osi.tpkt_port", "osi", "tcp.port", 10},
5508 {"rsync.tcp_port", "rsync", "tcp.port", 10},
5509 {"sametime.tcp_port", "sametime", "tcp.port", 10},
5510 {"sigcomp.tcp.port2", "sigcomp", "tcp.port", 10},
5511 {"synphasor.tcp_port", "synphasor", "tcp.port", 10},
5512 {"tipc.alternate_port", "tipc", "tcp.port", 10},
5513 {"vnc.alternate_port", "vnc", "tcp.port", 10},
5514 {"scop.port", "scop", "tcp.port", 10},
5515 {"scop.port_secure", "scop", "tcp.port", 10},
5516 {"tpncp.tcp.trunkpack_port", "tpncp", "tcp.port", 10},
5517 /* UDP */
5518 {"h248.udp_port", "h248", "udp.port", 10},
5519 {"actrace.udp_port", "actrace", "udp.port", 10},
5520 {"brp.port", "brp", "udp.port", 10},
5521 {"bvlc.additional_udp_port", "bvlc", "udp.port", 10},
5522 {"capwap.udp.port.control", "capwap", "udp.port", 10},
5523 {"capwap.udp.port.data", "capwap", "udp.port", 10},
5524 {"coap.udp_port", "coap", "udp.port", 10},
5525 {"enttec.udp_port", "enttec", "udp.port", 10},
5526 {"forces.udp_alternate_port", "forces", "udp.port", 10},
5527 {"ldss.udp_port", "ldss", "udp.port", 10},
5528 {"lmp.udp_port", "lmp", "udp.port", 10},
5529 {"ltp.port", "ltp", "udp.port", 10},
5530 {"lwres.udp.lwres_port", "lwres", "udp.port", 10},
5531 {"megaco.udp.txt_port", "megaco", "udp.port", 10},
5532 {"pfcp.port_pfcp", "pfcp", "udp.port", 10},
5533 {"pgm.udp.encap_ucast_port", "pgm", "udp.port", 10},
5534 {"pgm.udp.encap_mcast_port", "pgm", "udp.port", 10},
5535 {"quic.udp.quic.port", "quic", "udp.port", 10},
5536 {"quic.udp.quics.port", "quic", "udp.port", 10},
5537 {"radius.alternate_port", "radius", "udp.port", 10},
5538 {"rdt.default_udp_port", "rdt", "udp.port", 10},
5539 {"alc.default.udp_port", "alc", "udp.port", 10},
5540 {"sigcomp.udp.port2", "sigcomp", "udp.port", 10},
5541 {"synphasor.udp_port", "synphasor", "udp.port", 10},
5542 {"tdmop.udpport", "tdmop", "udp.port", 10},
5543 {"uaudp.port1", "uaudp", "udp.port", 10},
5544 {"uaudp.port2", "uaudp", "udp.port", 10},
5545 {"uaudp.port3", "uaudp", "udp.port", 10},
5546 {"uaudp.port4", "uaudp", "udp.port", 10},
5547 {"uhd.dissector_port", "uhd", "udp.port", 10},
5548 {"vrt.dissector_port", "vrt", "udp.port", 10},
5549 {"tpncp.udp.trunkpack_port", "tpncp", "udp.port", 10},
5550 /* SCTP */
5551 {"hnbap.port", "hnbap", "sctp.port", 10},
5552 {"m2pa.port", "m2pa", "sctp.port", 10},
5553 {"megaco.sctp.txt_port", "megaco", "sctp.port", 10},
5554 {"rua.port", "rua", "sctp.port", 10},
5555 /* SCTP PPI */
5556 {"lapd.sctp_payload_protocol_identifier", "lapd", "sctp.ppi", 10},
5557 /* SCCP SSN */
5558 {"ranap.sccp_ssn", "ranap", "sccp.ssn", 10},
5559 };
5560
5561 static const struct port_pref_name port_range_prefs[] = {
5562 /* TCP */
5563 {"couchbase.tcp.ports", "couchbase", "tcp.port", 10},
5564 {"gsm_ipa.tcp_ports", "gsm_ipa", "tcp.port", 10},
5565 {"kafka.tcp.ports", "kafka", "tcp.port", 10},
5566 {"kt.tcp.ports", "kt", "tcp.port", 10},
5567 {"memcache.tcp.ports", "memcache", "tcp.port", 10},
5568 {"mrcpv2.tcp.port_range", "mrcpv2", "tcp.port", 10},
5569 {"pdu_transport.ports.tcp", "pdu_transport", "tcp.port", 10},
5570 {"rtsp.tcp.port_range", "rtsp", "tcp.port", 10},
5571 {"sip.tcp.ports", "sip", "tcp.port", 10},
5572 {"someip.ports.tcp", "someip", "tcp.port", 10},
5573 {"tds.tcp_ports", "tds", "tcp.port", 10},
5574 {"tpkt.tcp.ports", "tpkt", "tcp.port", 10},
5575 {"uma.tcp.ports", "uma", "tcp.port", 10},
5576 /* UDP */
5577 {"aruba_erm.udp.ports", "arubs_erm", "udp.port", 10},
5578 {"diameter.udp.ports", "diameter", "udp.port", 10},
5579 {"dmp.udp_ports", "dmp", "udp.port", 10},
5580 {"dns.udp.ports", "dns", "udp.port", 10},
5581 {"gsm_ipa.udp_ports", "gsm_ipa", "udp.port", 10},
5582 {"hcrt.dissector_udp_port", "hcrt", "udp.port", 10},
5583 {"memcache.udp.ports", "memcache", "udp.port", 10},
5584 {"nb_rtpmux.udp_ports", "nb_rtpmux", "udp.port", 10},
5585 {"gprs-ns.udp.ports", "gprs-ns", "udp.port", 10},
5586 {"p_mul.udp_ports", "p_mul", "udp.port", 10},
5587 {"pdu_transport.ports.udp", "pdu_transport", "udp.port", 10},
5588 {"radius.ports", "radius", "udp.port", 10},
5589 {"sflow.ports", "sflow", "udp.port", 10},
5590 {"someip.ports.udp", "someip", "udp.port", 10},
5591 {"sscop.udp.ports", "sscop", "udp.port", 10},
5592 {"tftp.udp_ports", "tftp", "udp.port", 10},
5593 {"tipc.udp.ports", "tipc", "udp.port", 10},
5594 /* RTP */
5595 {"amr.dynamic.payload.type", "amr", "rtp.pt", 10},
5596 {"amr.wb.dynamic.payload.type", "amr_wb", "rtp.pt", 10},
5597 {"dvb-s2_modeadapt.dynamic.payload.type", "dvb-s2_modeadapt", "rtp.pt", 10},
5598 {"evs.dynamic.payload.type", "evs", "rtp.pt", 10},
5599 {"h263p.dynamic.payload.type", "h263p", "rtp.pt", 10},
5600 {"h264.dynamic.payload.type", "h264", "rtp.pt", 10},
5601 {"h265.dynamic.payload.type", "h265", "rtp.pt", 10},
5602 {"ismacryp.dynamic.payload.type", "ismacryp", "rtp.pt", 10},
5603 {"iuup.dynamic.payload.type", "iuup", "rtp.pt", 10},
5604 {"lapd.rtp_payload_type", "lapd", "rtp.pt", 10},
5605 {"mp4ves.dynamic.payload.type", "mp4ves", "rtp.pt", 10},
5606 {"mtp2.rtp_payload_type", "mtp2", "rtp.pt", 10},
5607 {"opus.dynamic.payload.type", "opus", "rtp.pt", 10},
5608 {"rtp.rfc2198_payload_type", "rtp_rfc2198", "rtp.pt", 10},
5609 {"rtpevent.event_payload_type_value", "rtpevent", "rtp.pt", 10},
5610 {"rtpevent.cisco_nse_payload_type_value", "rtpevent", "rtp.pt", 10},
5611 {"rtpmidi.midi_payload_type_value", "rtpmidi", "rtp.pt", 10},
5612 {"vp8.dynamic.payload.type", "vp8", "rtp.pt", 10},
5613 /* SCTP */
5614 {"diameter.sctp.ports", "diameter", "sctp.port", 10},
5615 {"sgsap.sctp_ports", "sgsap", "sctp.port", 10},
5616 /* SCCP SSN */
5617 {"pcap.ssn", "pcap", "sccp.ssn", 10},
5618 };
5619
5620 /* These are subdissectors of TPKT/OSITP that used to have a
5621 TCP port preference even though they were never
5622 directly on TCP. Convert them to use Decode As
5623 with the TPKT dissector handle */
5624 static const struct port_pref_name tpkt_subdissector_port_prefs[] = {
5625 {"dap.tcp.port", "dap", "tcp.port", 10},
5626 {"disp.tcp.port", "disp", "tcp.port", 10},
5627 {"dop.tcp.port", "dop", "tcp.port", 10},
5628 {"dsp.tcp.port", "dsp", "tcp.port", 10},
5629 {"p1.tcp.port", "p1", "tcp.port", 10},
5630 {"p7.tcp.port", "p7", "tcp.port", 10},
5631 {"rdp.tcp.port", "rdp", "tcp.port", 10},
5632 };
5633
5634 /* These are obsolete preferences from the dissectors' view,
5635 (typically because of a switch from a single value to a
5636 range value) but the name of the preference conflicts
5637 with the generated preference name from the dissector table.
5638 Don't allow the obsolete preference through to be handled */
5639 static const struct obsolete_pref_name obsolete_prefs[] = {
5640 {"diameter.tcp.port"},
5641 {"kafka.tcp.port"},
5642 {"mrcpv2.tcp.port"},
5643 {"rtsp.tcp.port"},
5644 {"sip.tcp.port"},
5645 {"t38.tcp.port"},
5646 };
5647
5648 unsigned int i;
5649 unsigned uval;
5650 dissector_table_t sub_dissectors;
5651 dissector_handle_t handle, tpkt_handle;
5652 module_t *module;
5653 pref_t *pref;
5654
5655 static bool_Bool sanity_checked;
5656 if (!sanity_checked) {
5657 sanity_checked = true1;
5658 for (i = 0; i < G_N_ELEMENTS(port_prefs)(sizeof (port_prefs) / sizeof ((port_prefs)[0])); i++) {
5659 module = prefs_find_module(port_prefs[i].module_name);
5660 if (!module) {
5661 // We might not be Wireshark, and therefore might not have deprecated port prefs.
5662 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"
, 5662, __func__, "Deprecated ports pref check - module '%s' not found"
, port_prefs[i].module_name); } } while (0)
;
5663 continue;
5664 }
5665 pref = prefs_find_preference(module, port_prefs[i].table_name);
5666 if (!pref) {
5667 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"
, 5667, __func__, "Deprecated ports pref '%s.%s' not found", module
->name, port_prefs[i].table_name); } } while (0)
;
5668 continue;
5669 }
5670 if (pref->type != PREF_DECODE_AS_RANGE) {
5671 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"
, 5671, __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)
;
5672 }
5673 }
5674 }
5675
5676 for (i = 0; i < G_N_ELEMENTS(port_prefs)(sizeof (port_prefs) / sizeof ((port_prefs)[0])); i++) {
5677 if (strcmp(pref_name, port_prefs[i].pref_name) == 0) {
5678 if (!ws_basestrtou32(value, NULL((void*)0), &uval, port_prefs[i].base))
5679 return false0; /* number was bad */
5680
5681 module = prefs_find_module(port_prefs[i].module_name);
5682 pref = prefs_find_preference(module, port_prefs[i].table_name);
5683 if (pref != NULL((void*)0)) {
5684 module->prefs_changed_flags |= prefs_get_effect_flags(pref);
5685 if (pref->type == PREF_DECODE_AS_RANGE) {
5686 // The legacy preference was a port number, but the new
5687 // preference is a port range. Add to existing range.
5688 if (uval) {
5689 prefs_range_add_value(pref, uval);
5690 }
5691 }
5692 }
5693
5694 /* If the value is zero, it wouldn't add to the Decode As tables */
5695 if (uval != 0)
5696 {
5697 sub_dissectors = find_dissector_table(port_prefs[i].table_name);
5698 if (sub_dissectors != NULL((void*)0)) {
5699 handle = dissector_table_get_dissector_handle(sub_dissectors, module->title);
5700 if (handle != NULL((void*)0)) {
5701 dissector_change_uint(port_prefs[i].table_name, uval, handle);
5702 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));
5703 }
5704 }
5705 }
5706
5707 return true1;
5708 }
5709 }
5710
5711 for (i = 0; i < array_length(port_range_prefs)(sizeof (port_range_prefs) / sizeof (port_range_prefs)[0]); i++)
5712 {
5713 if (strcmp(pref_name, port_range_prefs[i].pref_name) == 0)
5714 {
5715 uint32_t range_i, range_j;
5716
5717 sub_dissectors = find_dissector_table(port_range_prefs[i].table_name);
5718 if (sub_dissectors != NULL((void*)0)) {
5719 switch (dissector_table_get_type(sub_dissectors)) {
5720 case FT_UINT8:
5721 case FT_UINT16:
5722 case FT_UINT24:
5723 case FT_UINT32:
5724 break;
5725
5726 default:
5727 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", 5727
, __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))
;
5728 ws_assert_not_reached()ws_log_fatal_full("Epan", LOG_LEVEL_ERROR, "epan/prefs.c", 5728
, __func__, "assertion \"not reached\" failed")
;
5729 }
5730
5731 module = prefs_find_module(port_range_prefs[i].module_name);
5732 pref = prefs_find_preference(module, port_range_prefs[i].table_name);
5733 if (pref != NULL((void*)0))
5734 {
5735 if (!prefs_set_range_value_work(pref, value, true1, &module->prefs_changed_flags))
5736 {
5737 return false0; /* number was bad */
5738 }
5739
5740 handle = dissector_table_get_dissector_handle(sub_dissectors, module->title);
5741 if (handle != NULL((void*)0)) {
5742
5743 for (range_i = 0; range_i < (*pref->varp.range)->nranges; range_i++) {
5744 for (range_j = (*pref->varp.range)->ranges[range_i].low; range_j < (*pref->varp.range)->ranges[range_i].high; range_j++) {
5745 dissector_change_uint(port_range_prefs[i].table_name, range_j, handle);
5746 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));
5747 }
5748
5749 dissector_change_uint(port_range_prefs[i].table_name, (*pref->varp.range)->ranges[range_i].high, handle);
5750 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));
5751 }
5752 }
5753 }
5754 }
5755
5756 return true1;
5757 }
5758 }
5759
5760 for (i = 0; i < array_length(tpkt_subdissector_port_prefs)(sizeof (tpkt_subdissector_port_prefs) / sizeof (tpkt_subdissector_port_prefs
)[0])
; i++)
5761 {
5762 if (strcmp(pref_name, tpkt_subdissector_port_prefs[i].pref_name) == 0)
5763 {
5764 /* XXX - give an error if it doesn't fit in a unsigned? */
5765 if (!ws_basestrtou32(value, NULL((void*)0), &uval, tpkt_subdissector_port_prefs[i].base))
5766 return false0; /* number was bad */
5767
5768 /* If the value is 0 or 102 (default TPKT port), don't add to the Decode As tables */
5769 if ((uval != 0) && (uval != 102))
5770 {
5771 tpkt_handle = find_dissector("tpkt");
5772 if (tpkt_handle != NULL((void*)0)) {
5773 dissector_change_uint(tpkt_subdissector_port_prefs[i].table_name, uval, tpkt_handle);
5774 }
5775 }
5776
5777 return true1;
5778 }
5779 }
5780
5781 for (i = 0; i < array_length(obsolete_prefs)(sizeof (obsolete_prefs) / sizeof (obsolete_prefs)[0]); i++)
5782 {
5783 if (strcmp(pref_name, obsolete_prefs[i].pref_name) == 0)
5784 {
5785 /* Just ignore the preference */
5786 return true1;
5787 }
5788 }
5789 return false0;
5790}
5791
5792static prefs_set_pref_e
5793set_pref(char *pref_name, const char *value, void *private_data,
5794 bool_Bool return_range_errors)
5795{
5796 unsigned cval;
5797 unsigned uval;
5798 bool_Bool bval;
5799 int enum_val, ival;
5800 double fval;
5801 char *dotp, *last_dotp;
5802 module_t *module, *containing_module, *target_module;
5803 pref_t *pref;
5804 bool_Bool converted_pref = false0;
5805
5806 target_module = (module_t*)private_data;
5807
5808 if (deprecated_heur_dissector_pref(pref_name, value)) {
5809 /* Handled within deprecated_heur_dissector_pref() if found */
5810 } else if (deprecated_enable_dissector_pref(pref_name, value)) {
5811 /* Handled within deprecated_enable_dissector_pref() if found */
5812 } else if (deprecated_port_pref(pref_name, value)) {
5813 /* Handled within deprecated_port_pref() if found */
5814 } else if (strcmp(pref_name, "console.log.level") == 0) {
5815 /* Handled on the command line within ws_log_parse_args() */
5816 return PREFS_SET_OK;
5817 } else {
5818 /* To which module does this preference belong? */
5819 module = NULL((void*)0);
5820 last_dotp = pref_name;
5821 while (!module) {
5822 dotp = strchr(last_dotp, '.');
5823 if (dotp == NULL((void*)0)) {
5824 /* Either there's no such module, or no module was specified.
5825 In either case, that means there's no such preference. */
5826 return PREFS_SET_NO_SUCH_PREF;
5827 }
5828 *dotp = '\0'; /* separate module and preference name */
5829 module = prefs_find_module(pref_name);
5830
5831 /*
5832 * XXX - "Diameter" rather than "diameter" was used in earlier
5833 * versions of Wireshark; if we didn't find the module, and its name
5834 * was "Diameter", look for "diameter" instead.
5835 *
5836 * In addition, the BEEP protocol used to be the BXXP protocol,
5837 * so if we didn't find the module, and its name was "bxxp",
5838 * look for "beep" instead.
5839 *
5840 * Also, the preferences for GTP v0 and v1 were combined under
5841 * a single "gtp" heading, and the preferences for SMPP were
5842 * moved to "smpp-gsm-sms" and then moved to "gsm-sms-ud".
5843 * However, SMPP now has its own preferences, so we just map
5844 * "smpp-gsm-sms" to "gsm-sms-ud", and then handle SMPP below.
5845 *
5846 * We also renamed "dcp" to "dccp", "x.25" to "x25", "x411" to "p1"
5847 * and "nsip" to "gprs_ns".
5848 *
5849 * The SynOptics Network Management Protocol (SONMP) is now known by
5850 * its modern name, the Nortel Discovery Protocol (NDP).
5851 */
5852 if (module == NULL((void*)0)) {
5853 /*
5854 * See if there's a backwards-compatibility name
5855 * that maps to this module.
5856 */
5857 module = prefs_find_module_alias(pref_name);
5858 if (module == NULL((void*)0)) {
5859 /*
5860 * There's no alias for the module; see if the
5861 * module name matches any protocol aliases.
5862 */
5863 header_field_info *hfinfo = proto_registrar_get_byalias(pref_name);
5864 if (hfinfo) {
5865 module = (module_t *) wmem_tree_lookup_string(prefs_modules, hfinfo->abbrev, WMEM_TREE_STRING_NOCASE0x00000001);
5866 }
5867 }
5868 if (module) {
5869 converted_pref = true1;
5870 }
5871 }
5872 *dotp = '.'; /* put the preference string back */
5873 dotp++; /* skip past separator to preference name */
5874 last_dotp = dotp;
5875 }
5876
5877 /* The pref is located in the module or a submodule.
5878 * Assume module, then search for a submodule holding the pref. */
5879 containing_module = module;
5880 pref = prefs_find_preference_with_submodule(module, dotp, &containing_module);
5881
5882 if (pref == NULL((void*)0)) {
5883 /* "gui" prefix was added to column preferences for better organization
5884 * within the preferences file
5885 */
5886 if (module == gui_column_module) {
5887 /* While this has a subtree, there is no apply callback, so no
5888 * need to use prefs_find_preference_with_submodule to update
5889 * containing_module. It would not be useful. */
5890 pref = prefs_find_preference(module, pref_name);
5891 }
5892 else if (strcmp(module->name, "tcp") == 0) {
5893 /* Handle old names for TCP preferences. */
5894 if (strcmp(dotp, "dissect_experimental_options_with_magic") == 0)
5895 pref = prefs_find_preference(module, "dissect_experimental_options_rfc6994");
5896 } else if (strcmp(module->name, "extcap") == 0) {
5897 /* Handle the old "sshdump.remotesudo" preference; map it to the new
5898 "sshdump.remotepriv" preference, and map the boolean values to the
5899 appropriate strings of the new preference. */
5900 if (strcmp(dotp, "sshdump.remotesudo") == 0) {
5901 pref = prefs_find_preference(module, "sshdump.remotepriv");
5902 if (g_ascii_strcasecmp(value, "true") == 0)
5903 value = "sudo";
5904 else
5905 value = "none";
5906 }
5907 }
5908 if (pref) {
5909 converted_pref = true1;
5910 }
5911 }
5912 if (pref == NULL((void*)0) ) {
5913 if (strcmp(module->name, "extcap") == 0 && g_list_length(module->prefs) <= 1) {
5914 /*
5915 * Assume that we've skipped extcap preference registration
5916 * and that only extcap.gui_save_on_start is loaded.
5917 */
5918 return PREFS_SET_OK;
5919 }
5920 return PREFS_SET_NO_SUCH_PREF; /* no such preference */
5921 }
5922
5923 if (target_module && target_module != containing_module) {
5924 /* Ignore */
5925 return PREFS_SET_OK;
5926 }
5927
5928 if (pref->obsolete)
5929 return PREFS_SET_OBSOLETE; /* no such preference any more */
5930
5931 if (converted_pref) {
5932 ws_warning("Preference \"%s\" has been converted to \"%s.%s\"\n"do { if (1) { ws_log_full("Epan", LOG_LEVEL_WARNING, "epan/prefs.c"
, 5934, __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)
5933 "Save your preferences to make this change permanent.",do { if (1) { ws_log_full("Epan", LOG_LEVEL_WARNING, "epan/prefs.c"
, 5934, __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)
5934 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"
, 5934, __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)
;
5935 }
5936
5937 switch (pref->type) {
5938
5939 case PREF_UINT:
5940 if (!ws_basestrtou32(value, NULL((void*)0), &uval, pref->info.base))
5941 return PREFS_SET_SYNTAX_ERR; /* number was bad */
5942 if (*pref->varp.uint != uval) {
5943 containing_module->prefs_changed_flags |= prefs_get_effect_flags(pref);
5944 *pref->varp.uint = uval;
5945 }
5946 break;
5947
5948 case PREF_INT:
5949 if (!ws_strtoi32(value, NULL((void*)0), &ival))
5950 return PREFS_SET_SYNTAX_ERR; /* number was bad */
5951 if (*pref->varp.intp != ival) {
5952 containing_module->prefs_changed_flags |= prefs_get_effect_flags(pref);
5953 *pref->varp.intp = ival;
5954 }
5955 break;
5956
5957 case PREF_FLOAT:
5958 fval = g_ascii_strtod(value, NULL((void*)0));
5959 if (errno(*__errno_location ()) == ERANGE34)
5960 return PREFS_SET_SYNTAX_ERR; /* number was bad */
5961
5962 if (*pref->varp.floatp != fval) {
5963 containing_module->prefs_changed_flags |= prefs_get_effect_flags(pref);
5964 *pref->varp.floatp = fval;
5965 }
5966 break;
5967
5968 case PREF_BOOL:
5969 /* XXX - give an error if it's neither "true" nor "false"? */
5970 if (g_ascii_strcasecmp(value, "true") == 0)
5971 bval = true1;
5972 else
5973 bval = false0;
5974 if (*pref->varp.boolp != bval) {
5975 containing_module->prefs_changed_flags |= prefs_get_effect_flags(pref);
5976 *pref->varp.boolp = bval;
5977 }
5978 break;
5979
5980 case PREF_ENUM:
5981 /* XXX - give an error if it doesn't match? */
5982 enum_val = find_val_for_string(value, pref->info.enum_info.enumvals,
5983 *pref->varp.enump);
5984 if (*pref->varp.enump != enum_val) {
5985 containing_module->prefs_changed_flags |= prefs_get_effect_flags(pref);
5986 *pref->varp.enump = enum_val;
5987 }
5988 break;
5989
5990 case PREF_STRING:
5991 case PREF_SAVE_FILENAME:
5992 case PREF_OPEN_FILENAME:
5993 case PREF_DIRNAME:
5994 case PREF_DISSECTOR:
5995 containing_module->prefs_changed_flags |= prefs_set_string_value(pref, value, pref_current);
5996 break;
5997
5998 case PREF_PASSWORD:
5999 /* Read value is every time empty */
6000 containing_module->prefs_changed_flags |= prefs_set_string_value(pref, "", pref_current);
6001 break;
6002
6003 case PREF_RANGE:
6004 {
6005 if (!prefs_set_range_value_work(pref, value, return_range_errors,
6006 &containing_module->prefs_changed_flags))
6007 return PREFS_SET_SYNTAX_ERR; /* number was bad */
6008 break;
6009 }
6010 case PREF_DECODE_AS_RANGE:
6011 {
6012 /* This is for backwards compatibility in case any of the preferences
6013 that shared the "Decode As" preference name and used to be PREF_RANGE
6014 are now applied directly to the Decode As functionality */
6015 range_t *newrange;
6016 dissector_table_t sub_dissectors;
6017 dissector_handle_t handle;
6018 uint32_t i, j;
6019
6020 if (range_convert_str_work(pref->scope, &newrange, value, pref->info.max_value,
6021 return_range_errors) != CVT_NO_ERROR) {
6022 return PREFS_SET_SYNTAX_ERR; /* number was bad */
6023 }
6024
6025 if (!ranges_are_equal(*pref->varp.range, newrange)) {
6026 wmem_free(pref->scope, *pref->varp.range);
6027 *pref->varp.range = newrange;
6028 containing_module->prefs_changed_flags |= prefs_get_effect_flags(pref);
6029
6030 const char* table_name = prefs_get_dissector_table(pref);
6031 sub_dissectors = find_dissector_table(table_name);
6032 if (sub_dissectors != NULL((void*)0)) {
6033 handle = dissector_table_get_dissector_handle(sub_dissectors, module->title);
6034 if (handle != NULL((void*)0)) {
6035 /* Delete all of the old values from the dissector table */
6036 for (i = 0; i < (*pref->varp.range)->nranges; i++) {
6037 for (j = (*pref->varp.range)->ranges[i].low; j < (*pref->varp.range)->ranges[i].high; j++) {
6038 dissector_delete_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_delete_uint(table_name, (*pref->varp.range)->ranges[i].high, handle);
6043 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));
6044 }
6045
6046 /* Add new values to the dissector table */
6047 for (i = 0; i < newrange->nranges; i++) {
6048 for (j = newrange->ranges[i].low; j < newrange->ranges[i].high; j++) {
6049 dissector_change_uint(table_name, j, handle);
6050 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));
6051 }
6052
6053 dissector_change_uint(table_name, newrange->ranges[i].high, handle);
6054 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));
6055 }
6056
6057 /* XXX - Do we save the decode_as_entries file here? */
6058 }
6059 }
6060 } else {
6061 wmem_free(pref->scope, newrange);
6062 }
6063 break;
6064 }
6065
6066 case PREF_COLOR:
6067 {
6068 if (!ws_hexstrtou32(value, NULL((void*)0), &cval))
6069 return PREFS_SET_SYNTAX_ERR; /* number was bad */
6070 if ((pref->varp.colorp->red != RED_COMPONENT(cval)(uint16_t) (((((cval) >> 16) & 0xff) * 65535 / 255)
)
) ||
6071 (pref->varp.colorp->green != GREEN_COMPONENT(cval)(uint16_t) (((((cval) >> 8) & 0xff) * 65535 / 255))) ||
6072 (pref->varp.colorp->blue != BLUE_COMPONENT(cval)(uint16_t) ( (((cval) & 0xff) * 65535 / 255)))) {
6073 containing_module->prefs_changed_flags |= prefs_get_effect_flags(pref);
6074 pref->varp.colorp->red = RED_COMPONENT(cval)(uint16_t) (((((cval) >> 16) & 0xff) * 65535 / 255)
)
;
6075 pref->varp.colorp->green = GREEN_COMPONENT(cval)(uint16_t) (((((cval) >> 8) & 0xff) * 65535 / 255));
6076 pref->varp.colorp->blue = BLUE_COMPONENT(cval)(uint16_t) ( (((cval) & 0xff) * 65535 / 255));
6077 }
6078 break;
6079 }
6080
6081 case PREF_CUSTOM:
6082 return pref->custom_cbs.set_cb(pref, value, &containing_module->prefs_changed_flags);
6083
6084 case PREF_STATIC_TEXT:
6085 case PREF_UAT:
6086 break;
6087
6088 case PREF_PROTO_TCP_SNDAMB_ENUM:
6089 {
6090 /* There's no point in setting the TCP sequence override
6091 * value from the command line, because the pref is different
6092 * for each frame and reset to the default (0) for each new
6093 * file.
6094 */
6095 break;
6096 }
6097 }
6098 }
6099
6100 return PREFS_SET_OK;
6101}
6102
6103typedef struct {
6104 FILE *pf;
6105 bool_Bool is_gui_module;
6106 bool_Bool is_extcap_module;
6107} write_gui_pref_arg_t;
6108
6109const char *
6110prefs_pref_type_name(pref_t *pref)
6111{
6112 const char *type_name = "[Unknown]";
6113
6114 if (!pref) {
6115 return type_name; /* ...or maybe assert? */
6116 }
6117
6118 if (pref->obsolete) {
6119 type_name = "Obsolete";
6120 } else {
6121 switch (pref->type) {
6122
6123 case PREF_UINT:
6124 switch (pref->info.base) {
6125
6126 case 10:
6127 type_name = "Decimal";
6128 break;
6129
6130 case 8:
6131 type_name = "Octal";
6132 break;
6133
6134 case 16:
6135 type_name = "Hexadecimal";
6136 break;
6137 }
6138 break;
6139
6140 case PREF_INT:
6141 type_name = "Integer";
6142 break;
6143
6144 case PREF_FLOAT:
6145 type_name = "Float";
6146 break;
6147
6148 case PREF_BOOL:
6149 type_name = "Boolean";
6150 break;
6151
6152 case PREF_ENUM:
6153 case PREF_PROTO_TCP_SNDAMB_ENUM:
6154 type_name = "Choice";
6155 break;
6156
6157 case PREF_STRING:
6158 type_name = "String";
6159 break;
6160
6161 case PREF_SAVE_FILENAME:
6162 case PREF_OPEN_FILENAME:
6163 type_name = "Filename";
6164 break;
6165
6166 case PREF_DIRNAME:
6167 type_name = "Directory";
6168 break;
6169
6170 case PREF_RANGE:
6171 type_name = "Range";
6172 break;
6173
6174 case PREF_COLOR:
6175 type_name = "Color";
6176 break;
6177
6178 case PREF_CUSTOM:
6179 if (pref->custom_cbs.type_name_cb)
6180 return pref->custom_cbs.type_name_cb();
6181 type_name = "Custom";
6182 break;
6183
6184 case PREF_DECODE_AS_RANGE:
6185 type_name = "Range (for Decode As)";
6186 break;
6187
6188 case PREF_STATIC_TEXT:
6189 type_name = "Static text";
6190 break;
6191
6192 case PREF_UAT:
6193 type_name = "UAT";
6194 break;
6195
6196 case PREF_PASSWORD:
6197 type_name = "Password";
6198 break;
6199
6200 case PREF_DISSECTOR:
6201 type_name = "Dissector";
6202 break;
6203 }
6204 }
6205
6206 return type_name;
6207}
6208
6209unsigned int
6210prefs_get_effect_flags(pref_t *pref)
6211{
6212 if (pref == NULL((void*)0))
6213 return 0;
6214
6215 return pref->effect_flags;
6216}
6217
6218void
6219prefs_set_effect_flags(pref_t *pref, unsigned int flags)
6220{
6221 if (pref != NULL((void*)0)) {
6222 if (flags == 0) {
6223 ws_error("Setting \"%s\" preference effect flags to 0", pref->name)ws_log_fatal_full("Epan", LOG_LEVEL_ERROR, "epan/prefs.c", 6223
, __func__, "Setting \"%s\" preference effect flags to 0", pref
->name)
;
6224 }
6225 pref->effect_flags = flags;
6226 }
6227}
6228
6229void
6230prefs_set_effect_flags_by_name(module_t * module, const char *pref, unsigned int flags)
6231{
6232 prefs_set_effect_flags(prefs_find_preference(module, pref), flags);
6233}
6234
6235unsigned int
6236prefs_get_module_effect_flags(module_t * module)
6237{
6238 if (module == NULL((void*)0))
6239 return 0;
6240
6241 return module->effect_flags;
6242}
6243
6244void
6245prefs_set_module_effect_flags(module_t * module, unsigned int flags)
6246{
6247 if (module != NULL((void*)0)) {
6248 if (flags == 0) {
6249 ws_error("Setting module \"%s\" preference effect flags to 0", module->name)ws_log_fatal_full("Epan", LOG_LEVEL_ERROR, "epan/prefs.c", 6249
, __func__, "Setting module \"%s\" preference effect flags to 0"
, module->name)
;
6250 }
6251 module->effect_flags = flags;
6252 }
6253}
6254
6255char *
6256prefs_pref_type_description(pref_t *pref)
6257{
6258 const char *type_desc = "An unknown preference type";
6259
6260 if (!pref) {
6261 return ws_strdup_printf("%s.", type_desc)wmem_strdup_printf(((void*)0), "%s.", type_desc); /* ...or maybe assert? */
6262 }
6263
6264 if (pref->obsolete) {
6265 type_desc = "An obsolete preference";
6266 } else {
6267 switch (pref->type) {
6268
6269 case PREF_UINT:
6270 switch (pref->info.base) {
6271
6272 case 10:
6273 type_desc = "A decimal number";
6274 break;
6275
6276 case 8:
6277 type_desc = "An octal number";
6278 break;
6279
6280 case 16:
6281 type_desc = "A hexadecimal number";
6282 break;
6283 }
6284 break;
6285
6286 case PREF_INT:
6287 type_desc = "A decimal number";
6288 break;
6289
6290 case PREF_FLOAT:
6291 type_desc = "A floating point number";
6292 break;
6293
6294 case PREF_BOOL:
6295 type_desc = "true or false (case-insensitive)";
6296 break;
6297
6298 case PREF_ENUM:
6299 case PREF_PROTO_TCP_SNDAMB_ENUM:
6300 {
6301 const enum_val_t *enum_valp = pref->info.enum_info.enumvals;
6302 GString *enum_str = g_string_new("One of: ");
6303 GString *desc_str = g_string_new("\nEquivalently, one of: ");
6304 bool_Bool distinct = false0;
6305 while (enum_valp->name != NULL((void*)0)) {
6306 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))
;
6307 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))
;
6308 if (g_strcmp0(enum_valp->name, enum_valp->description) != 0) {
6309 distinct = true1;
6310 }
6311 enum_valp++;
6312 if (enum_valp->name != NULL((void*)0)) {
6313 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))
;
6314 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))
;
6315 }
6316 }
6317 if (distinct) {
6318 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))
;
6319 }
6320 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)))))
;
6321 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))
;
6322 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))))
;
6323 }
6324
6325 case PREF_STRING:
6326 type_desc = "A string";
6327 break;
6328
6329 case PREF_SAVE_FILENAME:
6330 case PREF_OPEN_FILENAME:
6331 type_desc = "A path to a file";
6332 break;
6333
6334 case PREF_DIRNAME:
6335 type_desc = "A path to a directory";
6336 break;
6337
6338 case PREF_RANGE:
6339 {
6340 type_desc = "A string denoting an positive integer range (e.g., \"1-20,30-40\")";
6341 break;
6342 }
6343
6344 case PREF_COLOR:
6345 {
6346 type_desc = "A six-digit hexadecimal RGB color triplet (e.g. fce94f)";
6347 break;
6348 }
6349
6350 case PREF_CUSTOM:
6351 if (pref->custom_cbs.type_description_cb)
6352 return pref->custom_cbs.type_description_cb();
6353 type_desc = "A custom value";
6354 break;
6355
6356 case PREF_DECODE_AS_RANGE:
6357 type_desc = "A string denoting an positive integer range for Decode As";
6358 break;
6359
6360 case PREF_STATIC_TEXT:
6361 type_desc = "[Static text]";
6362 break;
6363
6364 case PREF_UAT:
6365 type_desc = "Configuration data stored in its own file";
6366 break;
6367
6368 case PREF_PASSWORD:
6369 type_desc = "Password (never stored on disk)";
6370 break;
6371
6372 case PREF_DISSECTOR:
6373 type_desc = "A dissector name";
6374 break;
6375
6376 default:
6377 break;
6378 }
6379 }
6380
6381 return g_strdup(type_desc)g_strdup_inline (type_desc);
6382}
6383
6384bool_Bool
6385prefs_pref_is_default(pref_t *pref)
6386{
6387 if (!pref) return false0;
6388
6389 if (pref->obsolete) {
6390 return false0;
6391 }
6392
6393 switch (pref->type) {
6394
6395 case PREF_UINT:
6396 if (pref->default_val.uint == *pref->varp.uint)
6397 return true1;
6398 break;
6399
6400 case PREF_INT:
6401 if (pref->default_val.intval == *pref->varp.intp)
6402 return true1;
6403 break;
6404
6405 case PREF_FLOAT:
6406 if (pref->default_val.floatval == *pref->varp.floatp)
6407 return true1;
6408 break;
6409
6410 case PREF_BOOL:
6411 if (pref->default_val.boolval == *pref->varp.boolp)
6412 return true1;
6413 break;
6414
6415 case PREF_ENUM:
6416 case PREF_PROTO_TCP_SNDAMB_ENUM:
6417 if (pref->default_val.enumval == *pref->varp.enump)
6418 return true1;
6419 break;
6420
6421 case PREF_STRING:
6422 case PREF_SAVE_FILENAME:
6423 case PREF_OPEN_FILENAME:
6424 case PREF_DIRNAME:
6425 case PREF_PASSWORD:
6426 case PREF_DISSECTOR:
6427 if (!(g_strcmp0(pref->default_val.string, *pref->varp.string)))
6428 return true1;
6429 break;
6430
6431 case PREF_DECODE_AS_RANGE:
6432 case PREF_RANGE:
6433 {
6434 if ((ranges_are_equal(pref->default_val.range, *pref->varp.range)))
6435 return true1;
6436 break;
6437 }
6438
6439 case PREF_COLOR:
6440 {
6441 if ((pref->default_val.color.red == pref->varp.colorp->red) &&
6442 (pref->default_val.color.green == pref->varp.colorp->green) &&
6443 (pref->default_val.color.blue == pref->varp.colorp->blue))
6444 return true1;
6445 break;
6446 }
6447
6448 case PREF_CUSTOM:
6449 return pref->custom_cbs.is_default_cb(pref);
6450
6451 case PREF_STATIC_TEXT:
6452 case PREF_UAT:
6453 return false0;
6454 /* ws_assert_not_reached(); */
6455 break;
6456 }
6457
6458 return false0;
6459}
6460
6461char *
6462prefs_pref_to_str(pref_t *pref, pref_source_t source)
6463{
6464 const char *pref_text = "[Unknown]";
6465 void *valp; /* pointer to preference value */
6466 color_t *pref_color;
6467 char *tmp_value, *ret_value;
6468
6469 if (!pref) {
6470 return g_strdup(pref_text)g_strdup_inline (pref_text);
6471 }
6472
6473 switch (source) {
6474 case pref_default:
6475 valp = &pref->default_val;
6476 /* valp = &boolval, &enumval, etc. are implied by union property */
6477 pref_color = &pref->default_val.color;
6478 break;
6479 case pref_stashed:
6480 valp = &pref->stashed_val;
6481 /* valp = &boolval, &enumval, etc. are implied by union property */
6482 pref_color = &pref->stashed_val.color;
6483 break;
6484 case pref_current:
6485 valp = pref->varp.uint;
6486 /* valp = boolval, enumval, etc. are implied by union property */
6487 pref_color = pref->varp.colorp;
6488 break;
6489 default:
6490 return g_strdup(pref_text)g_strdup_inline (pref_text);
6491 }
6492
6493 if (pref->obsolete) {
6494 pref_text = "[Obsolete]";
6495 } else {
6496 switch (pref->type) {
6497
6498 case PREF_UINT:
6499 {
6500 unsigned pref_uint = *(unsigned *) valp;
6501 switch (pref->info.base) {
6502
6503 case 10:
6504 return ws_strdup_printf("%u", pref_uint)wmem_strdup_printf(((void*)0), "%u", pref_uint);
6505
6506 case 8:
6507 return ws_strdup_printf("%#o", pref_uint)wmem_strdup_printf(((void*)0), "%#o", pref_uint);
6508
6509 case 16:
6510 return ws_strdup_printf("%#x", pref_uint)wmem_strdup_printf(((void*)0), "%#x", pref_uint);
6511 }
6512 break;
6513 }
6514 case PREF_INT:
6515 return ws_strdup_printf("%d", *(int*)valp)wmem_strdup_printf(((void*)0), "%d", *(int*)valp);
6516
6517 case PREF_FLOAT:
6518 return ws_strdup_printf("%.*f", pref->info.base, *(double*)valp)wmem_strdup_printf(((void*)0), "%.*f", pref->info.base, *(
double*)valp)
;
6519
6520 case PREF_BOOL:
6521 return g_strdup((*(bool *) valp) ? "TRUE" : "FALSE")g_strdup_inline ((*(_Bool *) valp) ? "TRUE" : "FALSE");
6522
6523 case PREF_ENUM:
6524 case PREF_PROTO_TCP_SNDAMB_ENUM:
6525 {
6526 int pref_enumval = *(int *) valp;
6527 const enum_val_t *enum_valp = pref->info.enum_info.enumvals;
6528 /*
6529 * TODO - We write the "description" value, because the "name" values
6530 * weren't validated to be command line friendly until 5.0, and a few
6531 * of them had to be changed. This allows older versions of Wireshark
6532 * to read preferences that they supported, as we supported either
6533 * the short name or the description when reading the preference files
6534 * or an "-o" option. Once 5.0 is the oldest supported version, switch
6535 * to writing the name below.
6536 */
6537 while (enum_valp->name != NULL((void*)0)) {
6538 if (enum_valp->value == pref_enumval)
6539 return g_strdup(enum_valp->description)g_strdup_inline (enum_valp->description);
6540 enum_valp++;
6541 }
6542 break;
6543 }
6544
6545 case PREF_STRING:
6546 case PREF_SAVE_FILENAME:
6547 case PREF_OPEN_FILENAME:
6548 case PREF_DIRNAME:
6549 case PREF_PASSWORD:
6550 case PREF_DISSECTOR:
6551 return prefs_sanitize_string(*(const char **) valp);
6552
6553 case PREF_DECODE_AS_RANGE:
6554 case PREF_RANGE:
6555 /* Convert wmem to g_alloc memory */
6556 tmp_value = range_convert_range(NULL((void*)0), *(range_t **) valp);
6557 ret_value = g_strdup(tmp_value)g_strdup_inline (tmp_value);
6558 wmem_free(NULL((void*)0), tmp_value);
6559 return ret_value;
6560
6561 case PREF_COLOR:
6562 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))
6563 (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))
6564 (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))
6565 (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))
;
6566
6567 case PREF_CUSTOM:
6568 if (pref->custom_cbs.to_str_cb)
6569 return pref->custom_cbs.to_str_cb(pref, source == pref_default ? true1 : false0);
6570 pref_text = "[Custom]";
6571 break;
6572
6573 case PREF_STATIC_TEXT:
6574 pref_text = "[Static text]";
6575 break;
6576
6577 case PREF_UAT:
6578 {
6579 uat_t *uat = pref->varp.uat;
6580 if (uat && uat->filename)
6581 return ws_strdup_printf("[Managed in the file \"%s\"]", uat->filename)wmem_strdup_printf(((void*)0), "[Managed in the file \"%s\"]"
, uat->filename)
;
6582 else
6583 pref_text = "[Managed in an unknown file]";
6584 break;
6585 }
6586
6587 default:
6588 break;
6589 }
6590 }
6591
6592 return g_strdup(pref_text)g_strdup_inline (pref_text);
6593}
6594
6595/*
6596 * Write out a single dissector preference.
6597 */
6598void
6599pref_write_individual(void *data, void *user_data)
6600{
6601 pref_t *pref = (pref_t *)data;
6602 write_pref_arg_t *arg = (write_pref_arg_t *)user_data;
6603 char **desc_lines;
6604 int i;
6605
6606 if (!pref || pref->obsolete) {
6607 /*
6608 * This preference is no longer supported; it's not a
6609 * real preference, so we don't write it out (i.e., we
6610 * treat it as if it weren't found in the list of
6611 * preferences, and we weren't called in the first place).
6612 */
6613 return;
6614 }
6615
6616 switch (pref->type) {
6617
6618 case PREF_STATIC_TEXT:
6619 case PREF_UAT:
6620 /* Nothing to do; don't bother printing the description */
6621 return;
6622 case PREF_DECODE_AS_RANGE:
6623 /* Data is saved through Decode As mechanism and not part of preferences file */
6624 return;
6625 case PREF_PROTO_TCP_SNDAMB_ENUM:
6626 /* Not written to the preference file because the override is only
6627 * for the lifetime of the capture file and there is no single
6628 * value to write.
6629 */
6630 return;
6631 default:
6632 break;
6633 }
6634
6635 if (pref->type != PREF_CUSTOM || pref->custom_cbs.type_name_cb() != NULL((void*)0)) {
6636 /*
6637 * The prefix will either be the module name or the parent
6638 * name if it's a subtree
6639 */
6640 const char *name_prefix = (arg->module->name != NULL((void*)0)) ? arg->module->name : arg->module->parent->name;
6641 char *type_desc, *pref_text;
6642 const char * def_prefix = prefs_pref_is_default(pref) ? "#" : "";
6643
6644 if (pref->type == PREF_CUSTOM)
6645 fprintf(arg->pf, "\n# %s", pref->custom_cbs.type_name_cb());
6646 fprintf(arg->pf, "\n");
6647 if (pref->description &&
6648 (g_ascii_strncasecmp(pref->description,"", 2) != 0)) {
6649 if (pref->type != PREF_CUSTOM) {
6650 /* We get duplicate lines otherwise. */
6651
6652 desc_lines = g_strsplit(pref->description, "\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 }
6658 } else {
6659 fprintf(arg->pf, "# No description\n");
6660 }
6661
6662 type_desc = prefs_pref_type_description(pref);
6663 desc_lines = g_strsplit(type_desc, "\n", 0);
6664 for (i = 0; desc_lines[i] != NULL((void*)0); ++i) {
6665 fprintf(arg->pf, "# %s\n", desc_lines[i]);
6666 }
6667 g_strfreev(desc_lines);
6668 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)
;
6669
6670 pref_text = prefs_pref_to_str(pref, pref_current);
6671 fprintf(arg->pf, "%s%s.%s: ", def_prefix, name_prefix, pref->name);
6672 if (pref->type != PREF_PASSWORD)
6673 {
6674 desc_lines = g_strsplit(pref_text, "\n", 0);
6675 for (i = 0; desc_lines[i] != NULL((void*)0); ++i) {
6676 fprintf(arg->pf, "%s%s\n", i == 0 ? "" : def_prefix, desc_lines[i]);
6677 }
6678 if (i == 0)
6679 fprintf(arg->pf, "\n");
6680 g_strfreev(desc_lines);
6681 } else {
6682 /* We never store password value */
6683 fprintf(arg->pf, "\n");
6684 }
6685 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)
;
6686 }
6687
6688}
6689
6690static void
6691count_non_uat_pref(void *data, void *user_data)
6692{
6693 pref_t *pref = (pref_t *)data;
6694 int *arg = (int *)user_data;
6695
6696 switch (pref->type)
6697 {
6698 case PREF_UAT:
6699 case PREF_DECODE_AS_RANGE:
6700 case PREF_PROTO_TCP_SNDAMB_ENUM:
6701 //These types are not written in preference file
6702 break;
6703 default:
6704 (*arg)++;
6705 break;
6706 }
6707}
6708
6709int
6710prefs_num_non_uat(module_t *module)
6711{
6712 int num = 0;
6713
6714 g_list_foreach(module->prefs, count_non_uat_pref, &num);
6715
6716 return num;
6717}
6718
6719/*
6720 * Write out all preferences for a module.
6721 */
6722static unsigned
6723write_module_prefs(module_t *module, void *user_data)
6724{
6725 write_gui_pref_arg_t *gui_pref_arg = (write_gui_pref_arg_t*)user_data;
6726 write_pref_arg_t arg;
6727
6728 /* The GUI module needs to be explicitly called out so it
6729 can be written out of order */
6730 if ((module == gui_module) && (gui_pref_arg->is_gui_module != true1))
6731 return 0;
6732
6733 if ((module == extcap_module) && (gui_pref_arg->is_extcap_module != true1))
6734 return 0;
6735
6736 /* Write a header for the main modules and GUI sub-modules */
6737 if (((module->parent == NULL((void*)0)) || (module->parent == gui_module)) &&
6738 ((prefs_module_has_submodules(module)) ||
6739 (prefs_num_non_uat(module) > 0) ||
6740 (module->name == NULL((void*)0)))) {
6741 if ((module->name == NULL((void*)0)) && (module->parent != NULL((void*)0))) {
6742 fprintf(gui_pref_arg->pf, "\n####### %s: %s ########\n", module->parent->title, module->title);
6743 } else {
6744 fprintf(gui_pref_arg->pf, "\n####### %s ########\n", module->title);
6745 }
6746 }
6747
6748 arg.module = module;
6749 arg.pf = gui_pref_arg->pf;
6750 g_list_foreach(arg.module->prefs, pref_write_individual, &arg);
6751
6752 if (prefs_module_has_submodules(module))
6753 return prefs_modules_foreach_submodules(module->submodules, write_module_prefs, user_data);
6754
6755 return 0;
6756}
6757
6758#ifdef _WIN32
6759static void
6760write_registry(void)
6761{
6762 HKEY hTestKey;
6763 DWORD data;
6764 DWORD data_size;
6765 DWORD ret;
6766
6767 ret = RegCreateKeyExA(HKEY_CURRENT_USER, REG_HKCU_WIRESHARK_KEY"Software\\Wireshark", 0, NULL((void*)0),
6768 REG_OPTION_NON_VOLATILE, KEY_WRITE, NULL((void*)0),
6769 &hTestKey, NULL((void*)0));
6770 if (ret != ERROR_SUCCESS) {
6771 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"
, 6771, __func__, "Cannot open HKCU ""Software\\Wireshark"": 0x%lx"
, ret); } } while (0)
;
6772 return;
6773 }
6774
6775 data = ws_log_console_open;
6776 data_size = sizeof(DWORD);
6777 ret = RegSetValueExA(hTestKey, LOG_HKCU_CONSOLE_OPEN"ConsoleOpen", 0, REG_DWORD, (const BYTE *)&data, data_size);
6778 if (ret == ERROR_SUCCESS) {
6779 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"
, 6779, __func__, "Wrote ""ConsoleOpen"" to Windows registry: 0x%lu"
, data); } } while (0)
;
6780 }
6781 else {
6782 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"
, 6782, __func__, "Error writing registry key ""ConsoleOpen"": 0x%lx"
, ret); } } while (0)
;
6783 }
6784
6785 RegCloseKey(hTestKey);
6786}
6787#endif
6788
6789int
6790prefs_write_module(const char *module, bool_Bool from_profile, const char* app_env_var_prefix)
6791{
6792 write_gui_pref_arg_t write_pref_info;
6793
6794 module_t *target_module = prefs_find_module(module);
6795 if (!target_module) {
6796 return ENOENT2;
6797 }
6798
6799 char *pf_name = g_strdup_printf("%s.cfg", module);
6800 char *pf_path = get_persconffile_path(pf_name, from_profile, app_env_var_prefix);
6801 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)
;
6802
6803 FILE *pf;
6804 if ((pf = ws_fopenfopen(pf_path, "w")) == NULL((void*)0)) {
6805 int err = errno(*__errno_location ());
6806 if (err != EISDIR21) {
6807 ws_warning("Unable to save %s preferences \"%s\": %s",do { if (1) { ws_log_full("Epan", LOG_LEVEL_WARNING, "epan/prefs.c"
, 6808, __func__, "Unable to save %s preferences \"%s\": %s",
module, pf_path, g_strerror(err)); } } while (0)
6808 module, pf_path, g_strerror(err))do { if (1) { ws_log_full("Epan", LOG_LEVEL_WARNING, "epan/prefs.c"
, 6808, __func__, "Unable to save %s preferences \"%s\": %s",
module, pf_path, g_strerror(err)); } } while (0)
;
6809 }
6810 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)
;
6811 return err;
6812 }
6813 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)
;
6814
6815 fprintf(pf, "# %s configuration file for Wireshark " VERSION"4.7.4" ".\n"
6816 "#\n"
6817 "# This file is regenerated each time preferences are saved within\n"
6818 "# Wireshark. Making manual changes should be safe, however.\n"
6819 "# Preferences that have been commented out have not been\n"
6820 "# changed from their default value.\n", target_module->title);
6821
6822 write_pref_info.pf = pf;
6823 write_pref_info.is_gui_module = (target_module == gui_module);
6824 write_pref_info.is_extcap_module = (target_module == extcap_module);
6825
6826 write_module_prefs(target_module, &write_pref_info);
6827
6828 fclose(pf);
6829
6830 return 0;
6831}
6832
6833/* Write out "prefs" to the user's preferences file, and return 0.
6834
6835 If the preferences file path is NULL, write to stdout.
6836
6837 If we got an error, stuff a pointer to the path of the preferences
6838 file into "*pf_path_return", and return the errno.
6839
6840 Note that we don't write extcap.cfg here; that's done by
6841 extcap_write_preferences().
6842*/
6843 int
6844 write_prefs(const char *app_env_var_prefix, char **pf_path_return)
6845{
6846 char *pf_path;
6847 FILE *pf;
6848 write_gui_pref_arg_t write_gui_pref_info;
6849
6850#ifdef _WIN32
6851 write_registry();
6852#endif
6853
6854 /* To do:
6855 * - Split output lines longer than MAX_VAL_LEN
6856 * - Create a function for the preference directory check/creation
6857 * so that duplication can be avoided with filter.c
6858 */
6859
6860 if (pf_path_return != NULL((void*)0)) {
6861 pf_path = get_persconffile_path(PF_NAME"preferences", true1, app_env_var_prefix);
6862 if ((pf = ws_fopenfopen(pf_path, "w")) == NULL((void*)0)) {
6863 *pf_path_return = pf_path;
6864 return errno(*__errno_location ());
6865 }
6866 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)
;
6867 } else {
6868 pf = stdoutstdout;
6869 }
6870
6871 /*
6872 * If the preferences file is being written, be sure to write UAT files
6873 * first that were migrated from the preferences file.
6874 */
6875 if (pf_path_return != NULL((void*)0)) {
6876 if (prefs.filter_expressions_old) {
6877 char *err = NULL((void*)0);
6878 prefs.filter_expressions_old = false0;
6879 if (!uat_save(uat_get_table_by_name("Display expressions"), app_env_var_prefix, &err)) {
6880 ws_warning("Unable to save Display expressions: %s", err)do { if (1) { ws_log_full("Epan", LOG_LEVEL_WARNING, "epan/prefs.c"
, 6880, __func__, "Unable to save Display expressions: %s", err
); } } while (0)
;
6881 g_free(err)(__builtin_object_size ((err), 0) != ((size_t) - 1)) ? g_free_sized
(err, __builtin_object_size ((err), 0)) : (g_free) (err)
;
6882 }
6883 }
6884 }
6885
6886 fputs("# Configuration file for Wireshark " VERSION"4.7.4" ".\n"
6887 "#\n"
6888 "# This file is regenerated each time preferences are saved within\n"
6889 "# Wireshark. Making manual changes should be safe, however.\n"
6890 "# Preferences that have been commented out have not been\n"
6891 "# changed from their default value.\n", pf);
6892
6893 /*
6894 * For "backwards compatibility" the GUI module is written first as it's
6895 * at the top of the file. This is followed by all modules that can't
6896 * fit into the preferences read/write API. Finally the remaining modules
6897 * are written in alphabetical order (including of course the protocol preferences)
6898 */
6899 write_gui_pref_info.pf = pf;
6900 write_gui_pref_info.is_gui_module = true1;
6901 write_gui_pref_info.is_extcap_module = false0;
6902
6903 write_module_prefs(gui_module, &write_gui_pref_info);
6904
6905 write_gui_pref_info.is_gui_module = false0;
6906 if (pf_path_return == NULL((void*)0)) {
6907 /* If we're writing the prefs to stdout, write the extcap prefs. */
6908 write_gui_pref_info.is_extcap_module = true1;
6909 }
6910 prefs_module_list_foreach(prefs_top_level_modules, write_module_prefs, &write_gui_pref_info, true1);
6911
6912 fclose(pf);
6913
6914 /* XXX - catch I/O errors (e.g. "ran out of disk space") and return
6915 an error indication, or maybe write to a new preferences file and
6916 rename that file on top of the old one only if there are not I/O
6917 errors. */
6918 return 0;
6919}
6920
6921/** The col_list is only partly managed by the custom preference API
6922 * because its data is shared between multiple preferences, so
6923 * it's freed here
6924 */
6925static void
6926free_col_info(GList *list)
6927{
6928 fmt_data *cfmt;
6929 GList *list_head = list;
6930
6931 while (list != NULL((void*)0)) {
6932 cfmt = (fmt_data *)list->data;
6933
6934 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)
;
6935 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
)
;
6936 g_free(cfmt)(__builtin_object_size ((cfmt), 0) != ((size_t) - 1)) ? g_free_sized
(cfmt, __builtin_object_size ((cfmt), 0)) : (g_free) (cfmt)
;
6937 list = g_list_next(list)((list) ? (((GList *)(list))->next) : ((void*)0));
6938 }
6939 g_list_free(list_head);
6940}
6941
6942/*
6943 * Editor modelines
6944 *
6945 * Local Variables:
6946 * c-basic-offset: 4
6947 * tab-width: 8
6948 * indent-tabs-mode: nil
6949 * End:
6950 *
6951 * ex: set shiftwidth=4 tabstop=8 expandtab:
6952 * :indentSize=4:tabSize=8:noTabs=true:
6953 */