Free allocated data in prefs_reset, removed need for uat_reload_all and
[obnox/wireshark/wip.git] / epan / uat.c
1 /*
2  *  uat.c
3  *
4  * $Id$
5  *
6  *  User Accessible Tables
7  *  Mantain an array of user accessible data strucures
8  *
9  * (c) 2007, Luis E. Garcia Ontanon <luis.ontanon@gmail.com>
10  *
11  * Wireshark - Network traffic analyzer
12  * By Gerald Combs <gerald@wireshark.org>
13  * Copyright 2001 Gerald Combs
14  *
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.
19  *
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.
24  *
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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
28  */
29 #ifdef HAVE_CONFIG_H
30 # include "config.h"
31 #endif
32
33 #include <stdlib.h>
34 #include <stdio.h>
35 #include <string.h>
36 #include <errno.h>
37 #include <ctype.h>
38 #include <stdarg.h>
39
40 #include <glib.h>
41 #include <epan/emem.h>
42 #include <epan/report_err.h>
43 #include <epan/filesystem.h>
44 #include <epan/packet.h>
45 #include <epan/range.h>
46 #include <wiretap/file_util.h>
47
48 #include "uat-int.h"
49
50 static GPtrArray* all_uats = NULL;
51
52 void uat_init(void) {
53         all_uats = g_ptr_array_new();
54 }
55
56 uat_t* uat_new(const char* name,
57                            size_t size,
58                            const char* filename,
59                            void** data_ptr,
60                            guint* numitems_ptr,
61                            const char* category,
62                            const char* help,
63                            uat_copy_cb_t copy_cb,
64                            uat_update_cb_t update_cb,
65                            uat_free_cb_t free_cb,
66                            uat_field_t* flds_array) {
67         uat_t* uat = g_malloc(sizeof(uat_t));
68         guint i;
69
70         if (!all_uats)
71                 all_uats = g_ptr_array_new();
72
73         g_ptr_array_add(all_uats,uat);
74
75         g_assert(name && size && filename && data_ptr && numitems_ptr);
76
77         uat->name = g_strdup(name);
78         uat->record_size = size;
79         uat->filename = g_strdup(filename);
80         uat->user_ptr = data_ptr;
81         uat->nrows_p = numitems_ptr;
82         uat->copy_cb = copy_cb;
83         uat->update_cb = update_cb;
84         uat->free_cb = free_cb;
85         uat->fields = flds_array;
86         uat->user_data = g_array_new(FALSE,FALSE,uat->record_size);
87         uat->changed = FALSE;
88         uat->loaded = FALSE;
89         uat->rep = NULL;
90         uat->free_rep = NULL;
91         uat->help = help;
92         uat->category = category;
93
94         for (i=0;flds_array[i].name;i++) {
95                 fld_data_t* f = g_malloc(sizeof(fld_data_t));
96
97                 f->colnum = i+1;
98                 f->rep = NULL;
99                 f->free_rep = NULL;
100
101                 flds_array[i].priv = f;
102         }
103
104         uat->ncols = i;
105
106
107         *data_ptr = NULL;
108         *numitems_ptr = 0;
109
110         return uat;
111 }
112
113 void* uat_add_record(uat_t* uat, const void* data) {
114         void* rec;
115
116         g_array_append_vals (uat->user_data, data, 1);
117
118         rec = uat->user_data->data + (uat->record_size * (uat->user_data->len-1));
119
120         if (uat->copy_cb) {
121                 uat->copy_cb(rec, data, uat->record_size);
122         }
123
124         UAT_UPDATE(uat);
125
126         return rec;
127 }
128
129 void uat_swap(uat_t* uat, guint a, guint b) {
130         guint s = uat->record_size;
131         void* tmp = ep_alloc(s);
132
133         g_assert( a < uat->user_data->len && b < uat->user_data->len );
134
135         if (a == b) return;
136
137         memcpy(tmp, UAT_INDEX_PTR(uat,a), s);
138         memcpy(UAT_INDEX_PTR(uat,a), UAT_INDEX_PTR(uat,b), s);
139         memcpy(UAT_INDEX_PTR(uat,b), tmp, s);
140
141 }
142
143 void uat_remove_record_idx(uat_t* uat, guint idx) {
144
145         g_assert( idx < uat->user_data->len );
146
147         if (uat->free_cb) {
148                 uat->free_cb(UAT_INDEX_PTR(uat,idx));
149         }
150
151         g_array_remove_index(uat->user_data, idx);
152
153         UAT_UPDATE(uat);
154
155 }
156
157 gchar* uat_get_actual_filename(uat_t* uat, gboolean for_writing) {
158         gchar* pers_fname =  get_persconffile_path(uat->filename, TRUE, for_writing);
159
160         if (! for_writing ) {
161                 gchar* data_fname = get_datafile_path(uat->filename);
162
163                 if ((! file_exists(pers_fname) ) && file_exists(data_fname)) {
164                         return data_fname;
165                 }
166         }
167
168         if ((! file_exists(pers_fname) ) && (! for_writing ) ) {
169                 return NULL;
170         }
171
172         return pers_fname;
173 }
174
175 static void putfld(FILE* fp, void* rec, uat_field_t* f) {
176         guint fld_len;
177         const char* fld_ptr;
178
179         f->cb.tostr(rec,&fld_ptr,&fld_len,f->cbdata.tostr,f->fld_data);
180
181         switch(f->mode){
182                 case  PT_TXTMOD_ENUM:
183                 case  PT_TXTMOD_STRING: {
184                         guint i;
185
186                         putc('"',fp);
187
188                         for(i=0;i<fld_len;i++) {
189                                 char c = fld_ptr[i];
190
191                                 if (c == '"' || c == '\\' || ! isprint((guchar)c) ) {
192                                         fprintf(fp,"\\x%.2x",c);
193                                 } else {
194                                         putc(c,fp);
195                                 }
196                         }
197
198                         putc('"',fp);
199                         return;
200                 }
201                 case PT_TXTMOD_HEXBYTES: {
202                         guint i;
203
204                         for(i=0;i<fld_len;i++) {
205                                 fprintf(fp,"%.2x",((guint8*)fld_ptr)[i]);
206                         }
207
208                         return;
209                 }
210                 default:
211                         g_assert_not_reached();
212         }
213 }
214
215 gboolean uat_save(uat_t* uat, char** error) {
216         guint i;
217         gchar* fname = uat_get_actual_filename(uat,TRUE);
218         FILE* fp;
219
220         if (! fname ) return FALSE;
221
222         fp = eth_fopen(fname,"w");
223
224         if (!fp) {
225                 *error = ep_strdup_printf("uat_save: error opening '%s': %s",fname,strerror(errno));
226                 return FALSE;
227         }
228
229         *error = NULL;
230
231         fprintf(fp,"# This file is automatically generated, DO NOT MODIFY.\n");
232
233         for ( i = 0 ; i < uat->user_data->len ; i++ ) {
234                 void* rec = uat->user_data->data + (uat->record_size * i);
235                 uat_field_t* f;
236                 guint j;
237
238                 f = uat->fields;
239
240
241                 for( j=0 ; j < uat->ncols ; j++ ) {
242                         putfld(fp, rec, &(f[j]));
243                         fputs((j == uat->ncols - 1) ? "\n" : "," ,fp);
244                 }
245
246         }
247
248         fclose(fp);
249
250         uat->changed = FALSE;
251
252         return TRUE;
253 }
254
255 void uat_destroy(uat_t* uat) {
256         /* XXX still missing a destructor */
257         g_ptr_array_remove(all_uats,uat);
258
259 }
260
261 void uat_clear(uat_t* uat) {
262         guint i;
263
264         for ( i = 0 ; i < uat->user_data->len ; i++ ) {
265                 if (uat->free_cb) {
266                         uat->free_cb(UAT_INDEX_PTR(uat,i));
267                 }
268         }
269
270         g_array_set_size(uat->user_data,0);
271
272         *((uat)->user_ptr) = NULL;
273         *((uat)->nrows_p) = 0;
274 }
275
276 void* uat_dup(uat_t* uat, guint* len_p) {
277         guint size = (uat->record_size * uat->user_data->len);
278         *len_p = size;
279         return size ? g_memdup(uat->user_data->data,size) : NULL ;
280 }
281
282 void* uat_se_dup(uat_t* uat, guint* len_p) {
283         guint size = (uat->record_size * uat->user_data->len);
284         *len_p = size;
285         return size ? se_memdup(uat->user_data->data,size) : NULL ;
286 }
287
288 void uat_unload_all(void) {
289         guint i;
290
291         for (i=0; i < all_uats->len; i++) {
292                 uat_t* u = g_ptr_array_index(all_uats,i);
293                 uat_clear(u);
294                 u->loaded = FALSE;
295         }
296 }
297
298 void uat_cleanup(void) {
299         while( all_uats->len ) {
300                 uat_destroy((uat_t*)all_uats->pdata);
301         }
302
303         g_ptr_array_free(all_uats,TRUE);
304 }
305
306
307 void uat_foreach_table(uat_cb_t cb,void* user_data) {
308         guint i;
309
310         for (i=0; i < all_uats->len; i++)
311                 cb(g_ptr_array_index(all_uats,i), user_data);
312
313 }
314
315
316 void uat_load_all(void) {
317         guint i;
318         gchar* err;
319
320         for (i=0; i < all_uats->len; i++) {
321                 uat_t* u = g_ptr_array_index(all_uats,i);
322                 err = NULL;
323
324                 if (!u->loaded)
325                         uat_load(u, &err);
326
327                 if (err) {
328                         report_failure("Error loading table '%s': %s",u->name,err);
329                 }
330         }
331 }
332
333
334 gboolean uat_fld_chk_str(void* u1 _U_, const char* strptr, unsigned len _U_, void* u2 _U_, void* u3 _U_, const char** err) {
335         if (strptr == NULL) {
336                 *err = "NULL pointer";
337                 return FALSE;
338         }
339
340         *err = NULL;
341         return TRUE;
342 }
343
344 gboolean uat_fld_chk_proto(void* u1 _U_, const char* strptr, unsigned len, void* u2 _U_, void* u3 _U_, const char** err) {
345         if (len) {
346                 char* name = ep_strndup(strptr,len);
347                 g_strdown(name);
348                 g_strchug(name);
349
350                 if (find_dissector(name)) {
351                         *err = NULL;
352                         return TRUE;
353                 } else {
354                         *err = "dissector not found";
355                         return FALSE;
356                 }
357         } else {
358                 *err = NULL;
359                 return TRUE;
360         }
361 }
362
363 gboolean uat_fld_chk_num_dec(void* u1 _U_, const char* strptr, unsigned len, void* u2 _U_, void* u3 _U_, const char** err) {
364         char* str = ep_strndup(strptr,len);
365         long i = strtol(str,&str,10);
366
367         if ( ( i == 0) && (errno == ERANGE || errno == EINVAL) ) {
368                 *err = strerror(errno);
369                 return FALSE;
370         }
371
372         *err = NULL;
373         return TRUE;
374 }
375
376 gboolean uat_fld_chk_num_hex(void* u1 _U_, const char* strptr, unsigned len, void* u2 _U_, void* u3 _U_, const char** err) {
377         char* str = ep_strndup(strptr,len);
378         long i = strtol(str,&str,16);
379
380         if ( ( i == 0) && (errno == ERANGE || errno == EINVAL) ) {
381                 *err = strerror(errno);
382                 return FALSE;
383         }
384
385         *err = NULL;
386         return TRUE;
387 }
388
389 gboolean uat_fld_chk_enum(void* u1 _U_, const char* strptr, unsigned len, void* v, void* u3 _U_, const char** err) {
390         char* str = ep_strndup(strptr,len);
391         guint i;
392         value_string* vs = v;
393
394         for(i=0;vs[i].strptr;i++) {
395                 if (g_str_equal(vs[i].strptr,str)) {
396                         *err = NULL;
397                         return TRUE;
398                 }
399         }
400
401         *err = ep_strdup_printf("invalid value: %s",str);
402         return FALSE;
403 }
404
405 gboolean uat_fld_chk_range(void* u1 _U_, const char* strptr, unsigned len, void* v _U_, void* u3, const char** err) {
406         char* str = ep_strndup(strptr,len);
407         range_t* r = NULL;
408         convert_ret_t ret = range_convert_str(&r, str,GPOINTER_TO_UINT(u3));
409
410         switch (  ret ) {
411                 case CVT_NO_ERROR:
412                         *err = NULL;
413                         return TRUE;
414                 case CVT_SYNTAX_ERROR:
415                         *err = ep_strdup_printf("syntax error in range: %s",str);
416                         return FALSE;
417                 case CVT_NUMBER_TOO_BIG:
418                         *err = ep_strdup_printf("value too large in range: '%s' (max = %u)",str,GPOINTER_TO_UINT(u3));
419                         return FALSE;
420                 default:
421                         *err = "This should not happen, it is a bug in wireshark! please report to wireshark-dev@wireshark.org";
422                         return FALSE;
423         }
424 }
425
426 static int xton(char d) {
427         switch(d) {
428                 case '0': return 0;
429                 case '1': return 1;
430                 case '2': return 2;
431                 case '3': return 3;
432                 case '4': return 4;
433                 case '5': return 5;
434                 case '6': return 6;
435                 case '7': return 7;
436                 case '8': return 8;
437                 case '9': return 9;
438                 case 'a':  case 'A': return 10;
439                 case 'b':  case 'B': return 11;
440                 case 'c':  case 'C': return 12;
441                 case 'd':  case 'D': return 13;
442                 case 'e':  case 'E': return 14;
443                 case 'f':  case 'F': return 15;
444                 default: return -1;
445         }
446 }
447
448 char* uat_unbinstring(const char* si, guint in_len, guint* len_p) {
449         guint8* buf;
450         guint len = in_len/2;
451         int i = 0;
452         int d0, d1;
453
454         if (in_len%2) {
455                 return NULL;
456         }
457
458         buf= g_malloc0(len+1);
459         if (len_p) *len_p = len;
460
461         while(in_len) {
462                 d1 = xton(*(si++));
463                 d0 = xton(*(si++));
464
465                 buf[i++] = (d1 * 16) + d0;
466
467                 in_len -= 2;
468         }
469
470         return (char*)buf;
471 }
472
473 char* uat_unesc(const char* si, guint in_len, guint* len_p) {
474         char* buf = g_malloc0(in_len+1);
475         char* p = buf;
476         guint len = 0;
477         const char* s;
478         const char* in_end = si+in_len;
479
480         for (s = (void*)si; s < in_end; s++) {
481                 switch(*s) {
482                         case '\\':
483                                 switch(*(++s)) {
484                                         case 'a': *(p++) = '\a'; len++; break;
485                                         case 'b': *(p++) = '\b'; len++; break;
486                                         case 'e': *(p++) = '\033' /* '\e' is non ANSI-C */; len++; printf("."); break;
487                                         case 'f': *(p++) = '\f'; len++; break;
488                                         case 'n': *(p++) = '\n'; len++; break;
489                                         case 'r': *(p++) = '\r'; len++; break;
490                                         case 't': *(p++) = '\t'; len++; break;
491                                         case 'v': *(p++) = '\v'; len++; break;
492
493                                         case '0':
494                                         case '1':
495                                         case '2':
496                                         case '3':
497                                         case '4':
498                                         case '5':
499                                         case '6':
500                                         case '7':
501                                         {
502                                                 int c0 = 0;
503                                                 int c1 = 0;
504                                                 int c2 = 0;
505                                                 int c = 0;
506
507                                                 c0 = (*s) - '0';
508
509                                                 if ( s[1] >= '0' && s[1] <= '7' ) {
510                                                         c1 = c0;
511                                                         c0 = (*++s) - '0';
512
513                                                         if ( s[1] >= '0' && s[1] <= '7' ) {
514                                                                 c2 = c1;
515                                                                 c1 = c0;
516                                                                 c0 = (*++s) - '0';
517                                                         }
518                                                 }
519                                                 c = (64 * c2) + (8 * c1) + c0;
520                                                 *(p++) = (char) (c > 255 ? 255 : c);
521                                                 len++;
522                                                 break;
523                                         }
524
525                                         case 'x':
526                                         {
527                                                 char c1 = *(s+1);
528                                                 char c0 = *(s+2);
529
530                                                 if (isxdigit((guchar)c1) && isxdigit((guchar)c0)) {
531                                                         *(p++) = (xton(c1) * 0x10) + xton(c0);
532                                                         s += 2;
533                                                 } else {
534                                                         *(p++) = *s;
535                                                 }
536                                                 len++;
537                                                 break;
538                                         }
539                                         default:
540                                                 *p++ = *s;
541                                                 break;
542                                 }
543                                 break;
544                         default:
545                                 *(p++) = *s;
546                                 len++;
547                                 break;
548                 }
549         }
550
551         if (len_p) *len_p = len;
552         return buf;
553 }
554
555 char* uat_undquote(const char* si, guint in_len, guint* len_p) {
556         return uat_unesc(si+1,in_len-2,len_p);
557 }
558
559
560 char* uat_esc(const char* buf, guint len) {
561         const guint8* end = ((guint8*)buf)+len;
562         char* out = ep_alloc0((4*len)+1);
563         const guint8* b;
564         char* s = out;
565
566         for (b = (void*)buf; b < end; b++) {
567                 if (isprint(*b) ) {
568                         *(s++) = (*b);
569                 } else {
570                         g_snprintf(s,5,"\\x%.2x",((guint)*b));
571                         s+=4;
572                 }
573         }
574
575         return out;
576
577 }
578
579 CHK_STR_IS_DEF(isprint)
580 CHK_STR_IS_DEF(isalpha)
581 CHK_STR_IS_DEF(isalnum)
582 CHK_STR_IS_DEF(isdigit)
583 CHK_STR_IS_DEF(isxdigit)
584