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.org>
  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
  42 #include <wsutil/file_util.h>
  43 #include <wsutil/str_util.h>
  44
  45 #include <epan/emem.h>
  46 #include <epan/report_err.h>
  47 #include <epan/filesystem.h>
  48 #include <epan/packet.h>
  49 #include <epan/range.h>
  50
  51 #include "uat-int.h"
  52
  53 static GPtrArray* all_uats = NULL;
  54
  55 void uat_init(void) {
  56         all_uats = g_ptr_array_new();
  57 }
  58
  59 uat_t* uat_new(const char* name,
  60                            size_t size,
  61                            const char* filename,
  62                            gboolean from_profile,
  63                            void** data_ptr,
  64                            guint* numitems_ptr,
  65                            const char* category,
  66                            const char* help,
  67                            uat_copy_cb_t copy_cb,
  68                            uat_update_cb_t update_cb,
  69                            uat_free_cb_t free_cb,
  70                            uat_post_update_cb_t post_update_cb,
  71                            uat_field_t* flds_array) {
  72         /* Create new uat */
  73         uat_t* uat = g_malloc(sizeof(uat_t));
  74         guint i;
  75
  76         /* Add to global array of uats */
  77         if (!all_uats)
  78                 all_uats = g_ptr_array_new();
  79
  80         g_ptr_array_add(all_uats,uat);
  81
  82         /* Check params */
  83         g_assert(name && size && filename && data_ptr && numitems_ptr);
  84
  85         /* Set uat values from inputs */
  86         uat->name = g_strdup(name);
  87         uat->record_size = size;
  88         uat->filename = g_strdup(filename);
  89         uat->from_profile = from_profile;
  90         uat->user_ptr = data_ptr;
  91         uat->nrows_p = numitems_ptr;
  92         uat->copy_cb = copy_cb;
  93         uat->update_cb = update_cb;
  94         uat->free_cb = free_cb;
  95         uat->post_update_cb = post_update_cb;
  96         uat->fields = flds_array;
  97         uat->user_data = g_array_new(FALSE,FALSE,(guint)uat->record_size);
  98         uat->changed = FALSE;
  99         uat->loaded = FALSE;
 100         uat->rep = NULL;
 101         uat->free_rep = NULL;
 102         uat->help = help;
 103         uat->category = category;
 104
 105         for (i=0;flds_array[i].title;i++) {
 106                 fld_data_t* f = g_malloc(sizeof(fld_data_t));
 107
 108                 f->colnum = i+1;
 109                 f->rep = NULL;
 110                 f->free_rep = NULL;
 111
 112                 flds_array[i].priv = f;
 113         }
 114
 115         uat->ncols = i;
 116
 117         *data_ptr = NULL;
 118         *numitems_ptr = 0;
 119
 120         return uat;
 121 }
 122
 123 void* uat_add_record(uat_t* uat, const void* data) {
 124         void* rec;
 125
 126         g_array_append_vals (uat->user_data, data, 1);
 127
 128         rec = uat->user_data->data + (uat->record_size * (uat->user_data->len-1));
 129
 130         if (uat->copy_cb) {
 131                 uat->copy_cb(rec, data, (unsigned int) uat->record_size);
 132         }
 133
 134         UAT_UPDATE(uat);
 135
 136         return rec;
 137 }
 138
 139 void uat_swap(uat_t* uat, guint a, guint b) {
 140         size_t s = uat->record_size;
 141         void* tmp = ep_alloc(s);
 142
 143         g_assert( a < uat->user_data->len && b < uat->user_data->len );
 144
 145         if (a == b) return;
 146
 147         memcpy(tmp, UAT_INDEX_PTR(uat,a), s);
 148         memcpy(UAT_INDEX_PTR(uat,a), UAT_INDEX_PTR(uat,b), s);
 149         memcpy(UAT_INDEX_PTR(uat,b), tmp, s);
 150
 151 }
 152
 153 void uat_remove_record_idx(uat_t* uat, guint idx) {
 154
 155         g_assert( idx < uat->user_data->len );
 156
 157         if (uat->free_cb) {
 158                 uat->free_cb(UAT_INDEX_PTR(uat,idx));
 159         }
 160
 161         g_array_remove_index(uat->user_data, idx);
 162
 163         UAT_UPDATE(uat);
 164
 165 }
 166
 167 /* The returned filename was g_malloc()'d so the caller must free it */
 168 gchar* uat_get_actual_filename(uat_t* uat, gboolean for_writing) {
 169
 170         gchar* pers_fname =  get_persconffile_path(uat->filename, uat->from_profile, for_writing);
 171
 172         if (! for_writing ) {
 173                 gchar* data_fname = get_datafile_path(uat->filename);
 174
 175                 if ((! file_exists(pers_fname) ) && file_exists(data_fname)) {
 176                         g_free(pers_fname);
 177                         return data_fname;
 178                 }
 179
 180                 g_free(data_fname);
 181         }
 182
 183         if ((! file_exists(pers_fname) ) && (! for_writing ) ) {
 184                 g_free(pers_fname);
 185                 return NULL;
 186         }
 187
 188         return pers_fname;
 189 }
 190
 191 uat_t* uat_get_table_by_name(const char* name) {
 192         guint i;
 193
 194         for (i=0; i < all_uats->len; i++) {
 195                 uat_t* u = g_ptr_array_index(all_uats,i);
 196                 if ( g_str_equal(u->name,name) ) {
 197                         return (u);
 198                 }
 199         }
 200
 201         return NULL;
 202 }
 203
 204 static void putfld(FILE* fp, void* rec, uat_field_t* f) {
 205         guint fld_len;
 206         const char* fld_ptr;
 207
 208         f->cb.tostr(rec,&fld_ptr,&fld_len,f->cbdata.tostr,f->fld_data);
 209
 210         switch(f->mode){
 211                 case  PT_TXTMOD_ENUM:
 212                 case  PT_TXTMOD_STRING: {
 213                         guint i;
 214
 215                         putc('"',fp);
 216
 217                         for(i=0;i<fld_len;i++) {
 218                                 char c = fld_ptr[i];
 219
 220                                 if (c == '"' || c == '\\' || ! isprint((guchar)c) ) {
 221                                         fprintf(fp,"\\x%.2x",c);
 222                                 } else {
 223                                         putc(c,fp);
 224                                 }
 225                         }
 226
 227                         putc('"',fp);
 228                         return;
 229                 }
 230                 case PT_TXTMOD_HEXBYTES: {
 231                         guint i;
 232
 233                         for(i=0;i<fld_len;i++) {
 234                                 fprintf(fp,"%.2x",((guint8*)fld_ptr)[i]);
 235                         }
 236
 237                         return;
 238                 }
 239                 default:
 240                         g_assert_not_reached();
 241         }
 242 }
 243
 244 gboolean uat_save(uat_t* uat, char** error) {
 245         guint i;
 246         gchar* fname = uat_get_actual_filename(uat,TRUE);
 247         FILE* fp;
 248
 249         if (! fname ) return FALSE;
 250
 251         fp = ws_fopen(fname,"w");
 252
 253     if (!fp && errno == ENOENT) {
 254         /* Parent directory does not exist, try creating first */
 255         gchar *pf_dir_path = NULL;
 256         if (create_persconffile_dir(&pf_dir_path) != 0) {
 257             *error = ep_strdup_printf("uat_save: error creating '%s'", pf_dir_path);
 258             g_free (pf_dir_path);
 259             return FALSE;
 260         }
 261         fp = ws_fopen(fname,"w");
 262     }
 263
 264         if (!fp) {
 265                 *error = ep_strdup_printf("uat_save: error opening '%s': %s",fname,strerror(errno));
 266                 return FALSE;
 267         }
 268
 269         *error = NULL;
 270         g_free (fname);
 271
 272         fprintf(fp,"# This file is automatically generated, DO NOT MODIFY.\n");
 273
 274         for ( i = 0 ; i < uat->user_data->len ; i++ ) {
 275                 void* rec = uat->user_data->data + (uat->record_size * i);
 276                 uat_field_t* f;
 277                 guint j;
 278
 279                 f = uat->fields;
 280
 281
 282                 for( j=0 ; j < uat->ncols ; j++ ) {
 283                         putfld(fp, rec, &(f[j]));
 284                         fputs((j == uat->ncols - 1) ? "\n" : "," ,fp);
 285                 }
 286
 287         }
 288
 289         fclose(fp);
 290
 291         uat->changed = FALSE;
 292
 293         return TRUE;
 294 }
 295
 296 void uat_destroy(uat_t* uat) {
 297         /* XXX still missing a destructor */
 298         g_ptr_array_remove(all_uats,uat);
 299
 300 }
 301
 302 uat_t *uat_find(gchar *name) {
 303     guint i;
 304
 305         for (i=0; i < all_uats->len; i++) {
 306                 uat_t* u = g_ptr_array_index(all_uats,i);
 307
 308         if (strcmp(u->name, name) == 0 || strcmp(u->filename, name) == 0) {
 309             return u;
 310         }
 311         }
 312     return NULL;
 313 }
 314
 315 void uat_clear(uat_t* uat) {
 316         guint i;
 317
 318         for ( i = 0 ; i < uat->user_data->len ; i++ ) {
 319                 if (uat->free_cb) {
 320                         uat->free_cb(UAT_INDEX_PTR(uat,i));
 321                 }
 322         }
 323
 324         g_array_set_size(uat->user_data,0);
 325
 326         *((uat)->user_ptr) = NULL;
 327         *((uat)->nrows_p) = 0;
 328 }
 329
 330 void* uat_dup(uat_t* uat, guint* len_p) {
 331         guint size = (guint) (uat->record_size * uat->user_data->len);
 332         *len_p = size;
 333         return size ? g_memdup(uat->user_data->data,size) : NULL ;
 334 }
 335
 336 void* uat_se_dup(uat_t* uat, guint* len_p) {
 337         guint size = (guint) (uat->record_size * uat->user_data->len);
 338         *len_p = (guint) size;
 339         return size ? se_memdup(uat->user_data->data,size) : NULL ;
 340 }
 341
 342 void uat_unload_all(void) {
 343         guint i;
 344
 345         for (i=0; i < all_uats->len; i++) {
 346                 uat_t* u = g_ptr_array_index(all_uats,i);
 347         /* Do not unload if not in profile */
 348         if (u->from_profile) {
 349             uat_clear(u);
 350             u->loaded = FALSE;
 351         }
 352         }
 353 }
 354
 355 void uat_cleanup(void) {
 356         while( all_uats->len ) {
 357                 uat_destroy((uat_t*)all_uats->pdata);
 358         }
 359
 360         g_ptr_array_free(all_uats,TRUE);
 361 }
 362
 363
 364 void uat_foreach_table(uat_cb_t cb,void* user_data) {
 365         guint i;
 366
 367         for (i=0; i < all_uats->len; i++)
 368                 cb(g_ptr_array_index(all_uats,i), user_data);
 369
 370 }
 371
 372
 373 void uat_load_all(void) {
 374         guint i;
 375         gchar* err;
 376
 377         for (i=0; i < all_uats->len; i++) {
 378                 uat_t* u = g_ptr_array_index(all_uats,i);
 379                 err = NULL;
 380
 381                 if (!u->loaded)
 382                         uat_load(u, &err);
 383
 384                 if (err) {
 385                         report_failure("Error loading table '%s': %s",u->name,err);
 386                 }
 387         }
 388 }
 389
 390
 391 gboolean uat_fld_chk_str(void* u1 _U_, const char* strptr, unsigned len _U_, const void* u2 _U_, const void* u3 _U_, const char** err) {
 392         if (strptr == NULL) {
 393                 *err = "NULL pointer";
 394                 return FALSE;
 395         }
 396
 397         *err = NULL;
 398         return TRUE;
 399 }
 400
 401 gboolean uat_fld_chk_proto(void* u1 _U_, const char* strptr, unsigned len, const void* u2 _U_, const void* u3 _U_, const char** err) {
 402         if (len) {
 403                 char* name = ep_strndup(strptr,len);
 404                 ascii_strdown_inplace(name);
 405                 g_strchug(name);
 406
 407                 if (find_dissector(name)) {
 408                         *err = NULL;
 409                         return TRUE;
 410                 } else {
 411                         *err = "dissector not found";
 412                         return FALSE;
 413                 }
 414         } else {
 415                 *err = NULL;
 416                 return TRUE;
 417         }
 418 }
 419
 420 gboolean uat_fld_chk_num_dec(void* u1 _U_, const char* strptr, unsigned len, const void* u2 _U_, const void* u3 _U_, const char** err) {
 421     if (len > 0) {
 422         char* str = ep_strndup(strptr,len);
 423         long i = strtol(str,&str,10);
 424
 425         if ( ( i == 0) && (errno == ERANGE || errno == EINVAL) ) {
 426             *err = strerror(errno);
 427             return FALSE;
 428         }
 429     }
 430
 431         *err = NULL;
 432         return TRUE;
 433 }
 434
 435 gboolean uat_fld_chk_num_hex(void* u1 _U_, const char* strptr, unsigned len, const void* u2 _U_, const void* u3 _U_, const char** err) {
 436     if (len > 0) {
 437         char* str = ep_strndup(strptr,len);
 438         long i = strtol(str,&str,16);
 439
 440         if ( ( i == 0) && (errno == ERANGE || errno == EINVAL) ) {
 441             *err = strerror(errno);
 442             return FALSE;
 443         }
 444     }
 445
 446         *err = NULL;
 447         return TRUE;
 448 }
 449
 450 gboolean uat_fld_chk_enum(void* u1 _U_, const char* strptr, unsigned len, const void* v, const void* u3 _U_, const char** err) {
 451         char* str = ep_strndup(strptr,len);
 452         guint i;
 453         const value_string* vs = v;
 454
 455         for(i=0;vs[i].strptr;i++) {
 456                 if (g_str_equal(vs[i].strptr,str)) {
 457                         *err = NULL;
 458                         return TRUE;
 459                 }
 460         }
 461
 462         *err = ep_strdup_printf("invalid value: %s",str);
 463         return FALSE;
 464 }
 465
 466 gboolean uat_fld_chk_range(void* u1 _U_, const char* strptr, unsigned len, const void* v _U_, const void* u3, const char** err) {
 467         char* str = ep_strndup(strptr,len);
 468         range_t* r = NULL;
 469         convert_ret_t ret = range_convert_str(&r, str,GPOINTER_TO_UINT(u3));
 470
 471         switch (  ret ) {
 472                 case CVT_NO_ERROR:
 473                         *err = NULL;
 474                         return TRUE;
 475                 case CVT_SYNTAX_ERROR:
 476                         *err = ep_strdup_printf("syntax error in range: %s",str);
 477                         return FALSE;
 478                 case CVT_NUMBER_TOO_BIG:
 479                         *err = ep_strdup_printf("value too large in range: '%s' (max = %u)",str,GPOINTER_TO_UINT(u3));
 480                         return FALSE;
 481                 default:
 482                         *err = "This should not happen, it is a bug in wireshark! please report to wireshark-dev@wireshark.org";
 483                         return FALSE;
 484         }
 485 }
 486
 487 static int xton(char d) {
 488         switch(d) {
 489                 case '0': return 0;
 490                 case '1': return 1;
 491                 case '2': return 2;
 492                 case '3': return 3;
 493                 case '4': return 4;
 494                 case '5': return 5;
 495                 case '6': return 6;
 496                 case '7': return 7;
 497                 case '8': return 8;
 498                 case '9': return 9;
 499                 case 'a':  case 'A': return 10;
 500                 case 'b':  case 'B': return 11;
 501                 case 'c':  case 'C': return 12;
 502                 case 'd':  case 'D': return 13;
 503                 case 'e':  case 'E': return 14;
 504                 case 'f':  case 'F': return 15;
 505                 default: return -1;
 506         }
 507 }
 508
 509 char* uat_unbinstring(const char* si, guint in_len, guint* len_p) {
 510         guint8* buf;
 511         guint len = in_len/2;
 512         int i = 0;
 513         int d0, d1;
 514
 515         if (in_len%2) {
 516                 return NULL;
 517         }
 518
 519         buf= g_malloc0(len+1);
 520         if (len_p) *len_p = len;
 521
 522         while(in_len) {
 523                 d1 = xton(*(si++));
 524                 d0 = xton(*(si++));
 525
 526                 buf[i++] = (d1 * 16) + d0;
 527
 528                 in_len -= 2;
 529         }
 530
 531         return (char*)buf;
 532 }
 533
 534 char* uat_unesc(const char* si, guint in_len, guint* len_p) {
 535         char* buf = g_malloc0(in_len+1);
 536         char* p = buf;
 537         guint len = 0;
 538         const char* s;
 539         const char* in_end = si+in_len;
 540
 541         for (s = (void*)si; s < in_end; s++) {
 542                 switch(*s) {
 543                         case '\\':
 544                                 switch(*(++s)) {
 545                                         case 'a': *(p++) = '\a'; len++; break;
 546                                         case 'b': *(p++) = '\b'; len++; break;
 547                                         case 'e': *(p++) = '\033' /* '\e' is non ANSI-C */; len++; break;
 548                                         case 'f': *(p++) = '\f'; len++; break;
 549                                         case 'n': *(p++) = '\n'; len++; break;
 550                                         case 'r': *(p++) = '\r'; len++; break;
 551                                         case 't': *(p++) = '\t'; len++; break;
 552                                         case 'v': *(p++) = '\v'; len++; break;
 553
 554                                         case '0':
 555                                         case '1':
 556                                         case '2':
 557                                         case '3':
 558                                         case '4':
 559                                         case '5':
 560                                         case '6':
 561                                         case '7':
 562                                         {
 563                                                 int c0 = 0;
 564                                                 int c1 = 0;
 565                                                 int c2 = 0;
 566                                                 int c = 0;
 567
 568                                                 c0 = (*s) - '0';
 569
 570                                                 if ( s[1] >= '0' && s[1] <= '7' ) {
 571                                                         c1 = c0;
 572                                                         c0 = (*++s) - '0';
 573
 574                                                         if ( s[1] >= '0' && s[1] <= '7' ) {
 575                                                                 c2 = c1;
 576                                                                 c1 = c0;
 577                                                                 c0 = (*++s) - '0';
 578                                                         }
 579                                                 }
 580                                                 c = (64 * c2) + (8 * c1) + c0;
 581                                                 *(p++) = (char) (c > 255 ? 255 : c);
 582                                                 len++;
 583                                                 break;
 584                                         }
 585
 586                                         case 'x':
 587                                         {
 588                                                 char c1 = *(s+1);
 589                                                 char c0 = *(s+2);
 590
 591                                                 if (isxdigit((guchar)c1) && isxdigit((guchar)c0)) {
 592                                                         *(p++) = (xton(c1) * 0x10) + xton(c0);
 593                                                         s += 2;
 594                                                 } else {
 595                                                         *(p++) = *s;
 596                                                 }
 597                                                 len++;
 598                                                 break;
 599                                         }
 600                                         default:
 601                                                 *p++ = *s;
 602                                                 break;
 603                                 }
 604                                 break;
 605                         default:
 606                                 *(p++) = *s;
 607                                 len++;
 608                                 break;
 609                 }
 610         }
 611
 612         if (len_p) *len_p = len;
 613         return buf;
 614 }
 615
 616 char* uat_undquote(const char* si, guint in_len, guint* len_p) {
 617         return uat_unesc(si+1,in_len-2,len_p);
 618 }
 619
 620
 621 char* uat_esc(const char* buf, guint len) {
 622         const guint8* end = ((guint8*)buf)+len;
 623         char* out = ep_alloc0((4*len)+1);
 624         const guint8* b;
 625         char* s = out;
 626
 627         for (b = (void*)buf; b < end; b++) {
 628                 if (isprint(*b) ) {
 629                         *(s++) = (*b);
 630                 } else {
 631                         g_snprintf(s,5,"\\x%.2x",((guint)*b));
 632                         s+=4;
 633                 }
 634         }
 635
 636         return out;
 637
 638 }
 639
 640 CHK_STR_IS_DEF(isprint)
 641 CHK_STR_IS_DEF(isalpha)
 642 CHK_STR_IS_DEF(isalnum)
 643 CHK_STR_IS_DEF(isdigit)
 644 CHK_STR_IS_DEF(isxdigit)
 645
 646 /*
 647  * Editor modelines
 648  *
 649  * Local Variables:
 650  * c-basic-offset: 4
 651  * tab-width: 4
 652  * indent-tabs-mode: nil
 653  * End:
 654  *
 655  * ex: set shiftwidth=4 tabstop=4 expandtab
 656  * :indentSize=4:tabSize=4:noTabs=true:
 657  */