6 * User Accessible Tables
7 * Mantain an array of user accessible data strucures
9 * (c) 2007, Luis E. Garcia Ontanon <luis@ontanon.org>
11 * Wireshark - Network traffic analyzer
12 * By Gerald Combs <gerald@wireshark.org>
13 * Copyright 2001 Gerald Combs
15 * This program is free software; you can redistribute it and/or
16 * modify it under the terms of the GNU General Public License
17 * as published by the Free Software Foundation; either version 2
18 * of the License, or (at your option) any later version.
20 * This program is distributed in the hope that it will be useful,
21 * but WITHOUT ANY WARRANTY; without even the implied warranty of
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 * GNU General Public License for more details.
25 * You should have received a copy of the GNU General Public License
26 * along with this program; if not, write to the Free Software
27 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
35 #include "ws_symbol_export.h"
39 #endif /* __cplusplus */
42 * uat mantains a dynamically allocated table accessible to the user
43 * via a file and/or gui tables.
45 * the file is located either in userdir(when first read or when writen) or
46 * in datadir for defaults (read only , it will be always written to userdir).
48 * the behaviour of the table is controlled by a series of callbacks
49 * the caller must provide.
51 * BEWARE that the user can change an uat at (almost) any time,
52 * That is pointers to records in an uat are valid only during the call
53 * to the function that obtains them (do not store them).
55 * UATs are meant for short tables of user data (passwords and such) there's
56 * no quick access, you must iterate through them each time to fetch the record
57 * you are looking for. Use uat_dup() or uat_se_dup() if necessary.
59 * Only users via gui or editing the file can add/remove records your code cannot.
62 /* obscure data type to handle an uat */
63 typedef struct _uat_t uat_t
;
64 /********************************************
66 * these instruct uat on how to deal with user info and data in records
67 ********************************************/
70 * Callbacks dealing with the entire table
76 * to be called after to the table has being edited
77 * Will be called once the user clicks the Apply or OK button
80 typedef void (*uat_post_update_cb_t
)(void);
84 * Callbacks dealing with records (these deal with entire records)
89 * used to copy a record
90 * optional, memcpy will be used if not given
93 typedef void* (*uat_copy_cb_t
)(void*, const void*, size_t);
99 * destroy a record's child data
100 * (do not free the container, it will be handled by uat)
101 * it is optional, no child data will be freed if no present
104 typedef void (*uat_free_cb_t
)(void*);
109 * to be called after any record fields had been updated
110 * optional, record will be updated always if not given
111 * update(record,&error)
113 typedef void (*uat_update_cb_t
)(void* , const char** );
117 * Callbacks for single fields (these deal with single values)
118 * the caller should provide one of these for every field!
122 * given an input string (ptr, len) checks if the value is OK for a field in the record.
123 * it will return TRUE if OK or else
124 * it will return FALSE and may set *error to inform the user on what's
125 * wrong with the given input
126 * optional, if not given any input is considered OK and the set cb will be called
127 * chk(record, ptr, len, chk_data, fld_data, &error)
129 typedef gboolean (*uat_fld_chk_cb_t
)(void*, const char*, unsigned, const void*, const void*, const char**);
134 * given an input string (ptr, len) sets the value of a field in the record,
135 * it will return TRUE if OK or else
136 * it will return FALSE and may set *error to inform the user on what's
137 * wrong with the given input
139 * set(record, ptr, len, set_data, fld_data)
141 typedef void (*uat_fld_set_cb_t
)(void*, const char*, unsigned, const void*, const void*);
144 * given a record returns a string representation of the field
146 * tostr(record, &out_ptr, &out_len, tostr_data, fld_data)
148 typedef void (*uat_fld_tostr_cb_t
)(void*, const char**, unsigned*, const void*, const void*);
153 * used for file and dialog representation of fields in columns,
154 * when the file is read it modifies the way the value is passed back to the fld_set_cb
155 * (see definition bellow for description)
158 typedef enum _uat_text_mode_t
{
166 ,"\x20\x00\x30", as " \00",3
170 ,"\x20\x30\x00\x20", for " 0\0 ",4
174 accepts \x?? and other escapes
175 gets "",0 on empty string
181 ,A1b2C3d4, as "\001\002\003\004",4
185 ,a1b2c3d4, on "\001\002\003\004",4
187 "a1b2c3d4" as "\001\002\003\004",4
188 "a1 b2:c3d4" as "\001\002\003\004",4
196 /* processed like a PT_TXTMOD_STRING, but shows a filename dialog */
197 PT_TXTMOD_DIRECTORYNAME
198 /* processed like a PT_TXTMOD_STRING, but shows a directory dialog */
206 typedef struct _uat_field_t
{
209 uat_text_mode_t mode
;
212 uat_fld_chk_cb_t chk
;
213 uat_fld_set_cb_t set
;
214 uat_fld_tostr_cb_t tostr
;
223 const void* fld_data
;
226 struct _fld_data_t
* priv
;
230 #define UAT_END_FIELDS {NULL,NULL,PT_TXTMOD_NONE,{0,0,0},{0,0,0},0,0,FLDFILL}
233 * Flags to indicate what the settings in this UAT affect.
234 * This is used when UATs are changed interactively, to indicate what needs
235 * to be redone when the UAT is changed.
237 #define UAT_AFFECTS_DISSECTION 0x00000001 /* affects packet dissection */
238 #define UAT_AFFECTS_FIELDS 0x00000002 /* affects what named fields exist */
242 * @param name The name of the table
243 * @param size The size of the structure
244 * @param filename The filename to be used (either in userdir or datadir)
245 * @param from_profile TRUE if profile directory to be used
246 * @param data_ptr A pointer to a null terminated array of pointers to the data
247 * @param num_items_ptr A pointer with number of items
248 * @param flags flags indicating what this UAT affects
249 * @param help A pointer to help text
250 * @param copy_cb A function that copies the data in the struct
251 * @param update_cb Will be called when a record is updated
252 * @param free_cb Will be called to destroy a struct in the dataset
253 * @param post_update_cb Will be called once the user clicks the Apply or OK button
254 * @param flds_array A pointer to an array of uat_field_t structs
256 * @return A freshly-allocated and populated uat_t struct.
259 uat_t
* uat_new(const char* name
,
261 const char* filename
,
262 gboolean from_profile
,
264 guint
* num_items_ptr
,
267 uat_copy_cb_t copy_cb
,
268 uat_update_cb_t update_cb
,
269 uat_free_cb_t free_cb
,
270 uat_post_update_cb_t post_update_cb
,
271 uat_field_t
* flds_array
);
273 /** Populate a uat using its file.
275 * @param uat_in Pointer to a uat. Must not be NULL.
276 * @param err Upon failure, points to an error string.
278 * @return TRUE on success, FALSE on failure.
281 gboolean
uat_load(uat_t
* uat_in
, const char** err
);
283 /** Create or update a single uat entry using a string.
285 * @param uat_in Pointer to a uat. Must not be NULL.
286 * @param entry The string representation of the entry. Format must match
287 * what's written to the uat's output file.
288 * @param err Upon failure, points to an error string.
290 * @return TRUE on success, FALSE on failure.
292 gboolean
uat_load_str(uat_t
* uat_in
, char* entry
, char** err
);
294 /** Given a uat name or filename, find its pointer.
296 * @param name The name or filename of the uat
298 * @return A pointer to the uat on success, NULL on failure.
300 uat_t
*uat_find(gchar
*name
);
305 * make a reliable copy of an uat for internal use,
306 * so that pointers to records can be kept through calls.
307 * return NULL on zero len.
309 void* uat_dup(uat_t
*, guint
* len_p
); /* to be freed */
310 void* uat_se_dup(uat_t
*, guint
* len_p
);
312 uat_t
* uat_get_table_by_name(const char* name
);
315 * Some common uat_fld_chk_cbs
318 gboolean
uat_fld_chk_str(void*, const char*, unsigned, const void*, const void*, const char** err
);
319 gboolean
uat_fld_chk_oid(void*, const char*, unsigned, const void*, const void*, const char** err
);
321 gboolean
uat_fld_chk_proto(void*, const char*, unsigned, const void*, const void*, const char** err
);
323 gboolean
uat_fld_chk_num_dec(void*, const char*, unsigned, const void*, const void*, const char** err
);
325 gboolean
uat_fld_chk_num_hex(void*, const char*, unsigned, const void*, const void*, const char** err
);
327 gboolean
uat_fld_chk_enum(void*, const char*, unsigned, const void*, const void*, const char**);
329 gboolean
uat_fld_chk_range(void*, const char*, unsigned, const void*, const void*, const char**);
331 #define CHK_STR_IS_DECL(what) \
332 gboolean uat_fld_chk_str_ ## what (void*, const char*, unsigned, const void*, const void*, const char**)
334 typedef void (*uat_cb_t
)(void* uat
,void* user_data
);
336 void uat_foreach_table(uat_cb_t cb
,void* user_data
);
337 void uat_unload_all(void);
339 char* uat_undquote(const char* si
, guint in_len
, guint
* len_p
);
340 char* uat_unbinstring(const char* si
, guint in_len
, guint
* len_p
);
341 char* uat_unesc(const char* si
, guint in_len
, guint
* len_p
);
342 char* uat_esc(const char* buf
, guint len
);
344 /* Some strings entirely made of ... already declared */
346 CHK_STR_IS_DECL(isprint
);
348 CHK_STR_IS_DECL(isalpha
);
350 CHK_STR_IS_DECL(isalnum
);
352 CHK_STR_IS_DECL(isdigit
);
354 CHK_STR_IS_DECL(isxdigit
);
356 #define CHK_STR_IS_DEF(what) \
357 gboolean uat_fld_chk_str_ ## what (void* u1 _U_, const char* strptr, guint len, const void* u2 _U_, const void* u3 _U_, const char** err) { \
358 guint i; for (i=0;i<len;i++) { \
359 char c = strptr[i]; \
360 if (! what((int)c)) { \
361 *err = ep_strdup_printf("invalid char pos=%d value=%.2x",i,c); return FALSE; } } \
362 *err = NULL; return TRUE; }
367 * to define basic uat_fld_set_cbs, uat_fld_tostr_cbs
368 * for those elements in uat_field_t array
373 * a simple c-string contained in (((rec_t*)rec)->(field_name))
375 #define UAT_CSTRING_CB_DEF(basename,field_name,rec_t) \
376 static void basename ## _ ## field_name ## _set_cb(void* rec, const char* buf, guint len, const void* u1 _U_, const void* u2 _U_) {\
377 char* new_buf = g_strndup(buf,len); \
378 g_free((((rec_t*)rec)->field_name)); \
379 (((rec_t*)rec)->field_name) = new_buf; } \
380 static void basename ## _ ## field_name ## _tostr_cb(void* rec, const char** out_ptr, unsigned* out_len, const void* u1 _U_, const void* u2 _U_) {\
381 if (((rec_t*)rec)->field_name ) { \
382 *out_ptr = (((rec_t*)rec)->field_name); \
383 *out_len = (unsigned)strlen((((rec_t*)rec)->field_name)); \
385 *out_ptr = ""; *out_len = 0; } }
387 #define UAT_FLD_CSTRING(basename,field_name,title,desc) \
388 {#field_name, title, PT_TXTMOD_STRING,{uat_fld_chk_str,basename ## _ ## field_name ## _set_cb,basename ## _ ## field_name ## _tostr_cb},{0,0,0},0,desc,FLDFILL}
390 #define UAT_FLD_CSTRING_ISPRINT(basename,field_name,title,desc) \
391 {#field_name, title, PT_TXTMOD_STRING,{uat_fld_chk_str_isprint,basename ## _ ## field_name ## _set_cb,basename ## _ ## field_name ## _tostr_cb},{0,0,0},0,desc,FLDFILL}
393 #define UAT_FLD_CSTRING_OTHER(basename,field_name,title,chk,desc) \
394 {#field_name, title, PT_TXTMOD_STRING,{ chk ,basename ## _ ## field_name ## _set_cb,basename ## _ ## field_name ## _tostr_cb},{0,0,0},0,desc,FLDFILL}
397 * FILENAME and DIRECTORYNAME,
398 * a simple c-string contained in (((rec_t*)rec)->(field_name))
400 #define UAT_FILENAME_CB_DEF(basename,field_name,rec_t) UAT_CSTRING_CB_DEF(basename,field_name,rec_t)
402 #define UAT_FLD_FILENAME(basename,field_name,title,desc) \
403 {#field_name, title, PT_TXTMOD_FILENAME,{uat_fld_chk_str,basename ## _ ## field_name ## _set_cb,basename ## _ ## field_name ## _tostr_cb},{0,0,0},0,desc,FLDFILL}
405 #define UAT_FLD_FILENAME_OTHER(basename,field_name,title,chk,desc) \
406 {#field_name, title, PT_TXTMOD_FILENAME,{chk,basename ## _ ## field_name ## _set_cb,basename ## _ ## field_name ## _tostr_cb},{0,0,0},0,desc,FLDFILL}
408 #define UAT_DIRECTORYNAME_CB_DEF(basename,field_name,rec_t) UAT_CSTRING_CB_DEF(basename,field_name,rec_t)
410 #define UAT_FLD_DIRECTORYNAME(basename,field_name,title,desc) \
411 {#field_name, title, PT_TXTMOD_DIRECTORYNAME,{uat_fld_chk_str,basename ## _ ## field_name ## _set_cb,basename ## _ ## field_name ## _tostr_cb},{0,0,0},0,desc,FLDFILL}
414 * OID - just a CSTRING with a specific check routine
416 #define UAT_FLD_OID(basename,field_name,title,desc) \
417 {#field_name, title, PT_TXTMOD_STRING,{uat_fld_chk_oid,basename ## _ ## field_name ## _set_cb,basename ## _ ## field_name ## _tostr_cb},{0,0,0},0,desc,FLDFILL}
423 #define UAT_LSTRING_CB_DEF(basename,field_name,rec_t,ptr_element,len_element) \
424 static void basename ## _ ## field_name ## _set_cb(void* rec, const char* buf, guint len, const void* u1 _U_, const void* u2 _U_) {\
425 char* new_val = uat_unesc(buf,len,&(((rec_t*)rec)->len_element)); \
426 g_free((((rec_t*)rec)->ptr_element)); \
427 (((rec_t*)rec)->ptr_element) = new_val; }\
428 static void basename ## _ ## field_name ## _tostr_cb(void* rec, const char** out_ptr, unsigned* out_len, const void* u1 _U_, const void* u2 _U_) {\
429 if (((rec_t*)rec)->ptr_element ) { \
430 *out_ptr = uat_esc(((rec_t*)rec)->ptr_element, (((rec_t*)rec)->len_element)); \
431 *out_len = (unsigned)strlen(*out_ptr); \
433 *out_ptr = ""; *out_len = 0; } }
435 #define UAT_FLD_LSTRING(basename,field_name,title, desc) \
436 {#field_name, title, PT_TXTMOD_STRING,{0,basename ## _ ## field_name ## _set_cb,basename ## _ ## field_name ## _tostr_cb},{0,0,0},0,desc,FLDFILL}
441 * a buffer_ptr contained in (((rec_t*)rec)->(field_name))
442 * and its len in (((rec_t*)rec)->(len_name))
443 * XXX: UNTESTED and probably BROKEN
445 #define UAT_BUFFER_CB_DEF(basename,field_name,rec_t,ptr_element,len_element) \
446 static void basename ## _ ## field_name ## _set_cb(void* rec, const char* buf, guint len, const void* u1 _U_, const void* u2 _U_) {\
447 char* new_buf = len ? (char *)g_memdup(buf,len) : NULL; \
448 g_free((((rec_t*)rec)->ptr_element)); \
449 (((rec_t*)rec)->ptr_element) = new_buf; \
450 (((rec_t*)rec)->len_element) = len; } \
451 static void basename ## _ ## field_name ## _tostr_cb(void* rec, const char** out_ptr, unsigned* out_len, const void* u1 _U_, const void* u2 _U_) {\
452 *out_ptr = ((rec_t*)rec)->ptr_element ? (const char*)ep_memdup(((rec_t*)rec)->ptr_element,((rec_t*)rec)->len_element) : ""; \
453 *out_len = ((rec_t*)rec)->len_element; }
455 #define UAT_FLD_BUFFER(basename,field_name,title,desc) \
456 {#field_name, title, PT_TXTMOD_HEXBYTES,{0,basename ## _ ## field_name ## _set_cb,basename ## _ ## field_name ## _tostr_cb},{0,0,0},0,desc,FLDFILL}
461 * a decimal number contained in
463 #define UAT_DEC_CB_DEF(basename,field_name,rec_t) \
464 static void basename ## _ ## field_name ## _set_cb(void* rec, const char* buf, guint len, const void* u1 _U_, const void* u2 _U_) {\
465 ((rec_t*)rec)->field_name = (guint)strtol(ep_strndup(buf,len),NULL,10); } \
466 static void basename ## _ ## field_name ## _tostr_cb(void* rec, const char** out_ptr, unsigned* out_len, const void* u1 _U_, const void* u2 _U_) {\
467 *out_ptr = ep_strdup_printf("%d",((rec_t*)rec)->field_name); \
468 *out_len = (unsigned)strlen(*out_ptr); }
470 #define UAT_FLD_DEC(basename,field_name,title,desc) \
471 {#field_name, title, PT_TXTMOD_STRING,{uat_fld_chk_num_dec,basename ## _ ## field_name ## _set_cb,basename ## _ ## field_name ## _tostr_cb},{0,0,0},0,desc,FLDFILL}
476 * an hexadecimal number contained in
478 #define UAT_HEX_CB_DEF(basename,field_name,rec_t) \
479 static void basename ## _ ## field_name ## _set_cb(void* rec, const char* buf, guint len, const void* u1 _U_, const void* u2 _U_) {\
480 ((rec_t*)rec)->field_name = (guint)strtol(ep_strndup(buf,len),NULL,16); } \
481 static void basename ## _ ## field_name ## _tostr_cb(void* rec, const char** out_ptr, unsigned* out_len, const void* u1 _U_, const void* u2 _U_) {\
482 *out_ptr = ep_strdup_printf("%x",((rec_t*)rec)->field_name); \
483 *out_len = (unsigned)strlen(*out_ptr); }
485 #define UAT_FLD_HEX(basename,field_name,title,desc) \
486 {#field_name, title, PT_TXTMOD_STRING,{uat_fld_chk_num_hex,basename ## _ ## field_name ## _set_cb,basename ## _ ## field_name ## _tostr_cb},{0,0,0},0,desc,FLDFILL}
491 * enum_t: name = ((enum_t*)ptr)->strptr
492 * value = ((enum_t*)ptr)->value
496 #define UAT_VS_DEF(basename,field_name,rec_t,default_t,default_val,default_str) \
497 static void basename ## _ ## field_name ## _set_cb(void* rec, const char* buf, guint len, const void* vs, const void* u2 _U_) {\
499 char* str = ep_strndup(buf,len); \
500 const char* cstr; ((rec_t*)rec)->field_name = default_val; \
501 for(i=0; ( cstr = ((value_string*)vs)[i].strptr ) ;i++) { \
502 if (g_str_equal(cstr,str)) { \
503 ((rec_t*)rec)->field_name = (default_t)((value_string*)vs)[i].value; return; } } } \
504 static void basename ## _ ## field_name ## _tostr_cb(void* rec, const char** out_ptr, unsigned* out_len, const void* vs, const void* u2 _U_) {\
506 *out_ptr = ep_strdup(default_str); \
507 *out_len = (unsigned)strlen(default_str);\
508 for(i=0;((value_string*)vs)[i].strptr;i++) { \
509 if ( ((value_string*)vs)[i].value == ((rec_t*)rec)->field_name ) { \
510 *out_ptr = ep_strdup(((value_string*)vs)[i].strptr); \
511 *out_len = (unsigned)strlen(*out_ptr); return; } } }
513 #define UAT_VS_CSTRING_DEF(basename,field_name,rec_t,default_val,default_str) \
514 static void basename ## _ ## field_name ## _set_cb(void* rec, const char* buf, guint len, const void* vs, const void* u2 _U_) {\
516 char* str = ep_strndup(buf,len); \
517 const char* cstr; ((rec_t*)rec)->field_name = default_val; \
518 for(i=0; ( cstr = ((value_string*)vs)[i].strptr ) ;i++) { \
519 if (g_str_equal(cstr,str)) { \
520 ((rec_t*)rec)->field_name = g_strdup(((value_string*)vs)[i].strptr); return; } } } \
521 static void basename ## _ ## field_name ## _tostr_cb(void* rec, const char** out_ptr, unsigned* out_len, const void* vs _U_, const void* u2 _U_) {\
522 if (((rec_t*)rec)->field_name ) { \
523 *out_ptr = (((rec_t*)rec)->field_name); \
524 *out_len = (unsigned)strlen((((rec_t*)rec)->field_name)); \
526 *out_ptr = ""; *out_len = 0; } }
528 #define UAT_FLD_VS(basename,field_name,title,enum,desc) \
529 {#field_name, title, PT_TXTMOD_ENUM,{uat_fld_chk_enum,basename ## _ ## field_name ## _set_cb,basename ## _ ## field_name ## _tostr_cb},{&(enum),&(enum),&(enum)},&(enum),desc,FLDFILL}
536 #define UAT_PROTO_DEF(basename, field_name, dissector_field, name_field, rec_t) \
537 static void basename ## _ ## field_name ## _set_cb(void* rec, const char* buf, guint len, const void* u1 _U_, const void* u2 _U_) {\
539 gchar *tmp = g_strndup(buf,len); \
540 ((rec_t*)rec)->name_field = g_ascii_strdown(tmp, -1); \
542 g_strchug(((rec_t*)rec)->name_field); \
543 ((rec_t*)rec)->dissector_field = find_dissector(((rec_t*)rec)->name_field); \
545 ((rec_t*)rec)->dissector_field = find_dissector("data"); \
546 ((rec_t*)rec)->name_field = NULL; \
548 static void basename ## _ ## field_name ## _tostr_cb(void* rec, const char** out_ptr, unsigned* out_len, const void* u1 _U_, const void* u2 _U_) {\
549 if ( ((rec_t*)rec)->name_field ) { \
550 *out_ptr = (((rec_t*)rec)->name_field); \
551 *out_len = (unsigned)strlen(*out_ptr); \
553 *out_ptr = ""; *out_len = 0; } }
556 #define UAT_FLD_PROTO(basename,field_name,title,desc) \
557 {#field_name, title, PT_TXTMOD_STRING,{uat_fld_chk_proto,basename ## _ ## field_name ## _set_cb,basename ## _ ## field_name ## _tostr_cb},{0,0,0},0,desc,FLDFILL}
563 #define UAT_RANGE_CB_DEF(basename,field_name,rec_t) \
564 static void basename ## _ ## field_name ## _set_cb(void* rec, const char* buf, guint len, const void* u1 _U_, const void* u2) {\
565 char* rng = ep_strndup(buf,len);\
566 range_convert_str(&(((rec_t*)rec)->field_name), rng,GPOINTER_TO_UINT(u2)); \
568 static void basename ## _ ## field_name ## _tostr_cb(void* rec, const char** out_ptr, unsigned* out_len, const void* u1 _U_, const void* u2 _U_) {\
569 if ( ((rec_t*)rec)->field_name ) { \
570 *out_ptr = range_convert_range(((rec_t*)rec)->field_name); \
571 *out_len = (unsigned)strlen(*out_ptr); \
573 *out_ptr = ""; *out_len = 0; } }
576 #define UAT_FLD_RANGE(basename,field_name,title,max,desc) \
577 {#field_name, title, PT_TXTMOD_STRING,{uat_fld_chk_range,basename ## _ ## field_name ## _set_cb,basename ## _ ## field_name ## _tostr_cb},\
578 {0,0,0},GUINT_TO_POINTER(max),desc,FLDFILL}
582 #endif /* __cplusplus */
584 #endif /* __UAT_H__ */